From d1890d041eae5a4c389321053a1328a277726945 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 8 Dec 2017 11:47:49 -0500 Subject: [PATCH 001/148] doc: begin developer's manual * Move doc/code/ -> doc/developer/ * Move disparate code documentation to doc/developer/ * Convert Markdown docs to reStructuredText * Organize docs into Sphinx tree * Move build docs -> doc/developer/ * Change build doc titles to fit under Building subsection of manual Signed-off-by: Quentin Young --- doc/.gitignore | 1 + doc/cli.md | 557 -------------- doc/code/.gitignore | 3 - doc/code/Makefile | 216 ------ .../Building_FRR_on_CentOS6.rst} | 117 ++- .../Building_FRR_on_CentOS7.rst} | 85 ++- .../Building_FRR_on_Debian8.rst} | 75 +- .../Building_FRR_on_Debian9.rst} | 65 +- .../Building_FRR_on_Fedora24.rst} | 81 +- .../Building_FRR_on_FreeBSD10.rst} | 51 +- .../Building_FRR_on_FreeBSD11.rst} | 49 +- .../Building_FRR_on_FreeBSD9.rst} | 54 +- .../Building_FRR_on_LEDE-OpenWRT.rst} | 75 +- .../Building_FRR_on_NetBSD6.rst} | 60 +- .../Building_FRR_on_NetBSD7.rst} | 55 +- .../Building_FRR_on_OmniOS.rst} | 51 +- .../Building_FRR_on_OpenBSD6.rst} | 76 +- .../Building_FRR_on_Ubuntu1204.rst} | 82 +- .../Building_FRR_on_Ubuntu1404.rst} | 72 +- .../Building_FRR_on_Ubuntu1604.rst} | 90 ++- doc/developer/building.rst | 22 + doc/developer/cli.rst | 615 +++++++++++++++ doc/{code => developer}/conf.py | 6 +- doc/developer/dev-modules.rst | 125 +++ doc/developer/git_branches.svg | 720 ++++++++++++++++++ doc/{code => developer}/hooks.rst | 0 doc/{code => developer}/index.rst | 12 +- doc/{ => developer}/ldpd-basic-test-setup.md | 0 doc/{code => developer}/library.rst | 2 + doc/{code => developer}/memtypes.rst | 0 doc/{ => developer}/next-hop-tracking.txt | 0 doc/developer/workflow.rst | 544 +++++++++++++ 32 files changed, 2820 insertions(+), 1141 deletions(-) delete mode 100644 doc/cli.md delete mode 100644 doc/code/.gitignore delete mode 100644 doc/code/Makefile rename doc/{Building_FRR_on_CentOS6.md => developer/Building_FRR_on_CentOS6.rst} (65%) rename doc/{Building_FRR_on_CentOS7.md => developer/Building_FRR_on_CentOS7.rst} (71%) rename doc/{Building_FRR_on_Debian8.md => developer/Building_FRR_on_Debian8.rst} (74%) rename doc/{Building_FRR_on_Debian9.md => developer/Building_FRR_on_Debian9.rst} (77%) rename doc/{Building_FRR_on_Fedora24.md => developer/Building_FRR_on_Fedora24.rst} (73%) rename doc/{Building_FRR_on_FreeBSD10.md => developer/Building_FRR_on_FreeBSD10.rst} (75%) rename doc/{Building_FRR_on_FreeBSD11.md => developer/Building_FRR_on_FreeBSD11.rst} (75%) rename doc/{Building_FRR_on_FreeBSD9.md => developer/Building_FRR_on_FreeBSD9.rst} (73%) rename doc/{Building_FRR_for_LEDE-OpenWRT.md => developer/Building_FRR_on_LEDE-OpenWRT.rst} (59%) rename doc/{Building_FRR_on_NetBSD6.md => developer/Building_FRR_on_NetBSD6.rst} (79%) rename doc/{Building_FRR_on_NetBSD7.md => developer/Building_FRR_on_NetBSD7.rst} (79%) rename doc/{Building_FRR_on_OmniOS.md => developer/Building_FRR_on_OmniOS.rst} (81%) rename doc/{Building_FRR_on_OpenBSD6.md => developer/Building_FRR_on_OpenBSD6.rst} (82%) rename doc/{Building_FRR_on_Ubuntu1204.md => developer/Building_FRR_on_Ubuntu1204.rst} (79%) rename doc/{Building_FRR_on_Ubuntu1404.md => developer/Building_FRR_on_Ubuntu1404.rst} (74%) rename doc/{Building_FRR_on_Ubuntu1604.md => developer/Building_FRR_on_Ubuntu1604.rst} (68%) create mode 100644 doc/developer/building.rst create mode 100644 doc/developer/cli.rst rename doc/{code => developer}/conf.py (98%) create mode 100644 doc/developer/dev-modules.rst create mode 100644 doc/developer/git_branches.svg rename doc/{code => developer}/hooks.rst (100%) rename doc/{code => developer}/index.rst (50%) rename doc/{ => developer}/ldpd-basic-test-setup.md (100%) rename doc/{code => developer}/library.rst (82%) rename doc/{code => developer}/memtypes.rst (100%) rename doc/{ => developer}/next-hop-tracking.txt (100%) create mode 100644 doc/developer/workflow.rst diff --git a/doc/.gitignore b/doc/.gitignore index 57c66cb4ac..8dada02288 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -35,3 +35,4 @@ stamp-vti *~ *.loT refix +_build diff --git a/doc/cli.md b/doc/cli.md deleted file mode 100644 index 723237ebb8..0000000000 --- a/doc/cli.md +++ /dev/null @@ -1,557 +0,0 @@ -FRR Command Line Interface -========================== - -Definition Grammar ------------------- - -This is a reference for the syntax used when defining new CLI commands. An -example definition is: - -``` -DEFUN (command_name, - command_name_cmd, ---> "example DEFINITION...", - <..doc strings..>) -``` - -The arrowed part is the definition string. - -Explicit syntax rules in Flex and Bison may be found in lib/command_lex.l and -lib/command_parse.y, respectively. If you can read BNF and regex those will be -more useful than this document. - -If the parser is throwing syntax or other errors and you can't figure out why, -it's unlikely to be a bug in the parser. If the error message is not useful, -please file a bug for a better error message. If all else fails, read the token -definitions in the lexer source and the Bison BNF in the parser source. - -Characters allowed in each token type: - -Tokens ------- -* `WORD` -- A token that begins with +, -, or a lowercase letter. It is - an unchanging part of the command and will only match itself. - Example: "show ip bgp", every token is a WORD. -* `IPV4` -- 'A.B.C.D', matches an IPv4 address. -* `IPV6` -- 'X:X::X:X', matches an IPv6 address. -* `IPV4_PREFIX` -- 'A.B.C.D/M', matches an IPv4 prefix in CIDR notation. -* `IPV6_PREFIX` -- 'X:X::X:X/M', matches an IPv6 prefix in CIDR notation. -* `MAC` -- 'M:A:C', matches a 48-bit mac address -* `MAC_PREFIX` -- 'M:A:C/M', matches a 48-bit mac address with a mask -* `VARIABLE` -- Begins with a capital letter. Matches any input. -* `RANGE` -- Numeric range delimited by parentheses, e.g. (-100 - 100) or - (10-20). Will only match numbers in the range. - -Rules ------ -* `` -- Contain sequences of tokens separated by pipes and - provide mutual exclusion. Sequences may contain - `` but not as the first token. - Disallowed: `"example < c|d>"` - Allowed: `"example "` -* `[square brackets]` -- Contains sequences of tokens that are optional (can be - omitted). `[]` can be shortened to `[a|b]`. -* `{curly|braces}` -- similar to angle brackets, but instead of mutual - exclusion, curly braces indicate that one or more of the - pipe-separated sequences may be provided in any order. -* `VARIADICS...` -- Any token which accepts input (so anything except WORD) - and that occurs as the last token of a line may be - followed by an ellipsis, which indicates that input - matching the token may be repeated an unlimited number - of times. -* `$name` -- Specify a variable name for the preceding token. See - "Variable Names" below. - -Some general notes: - -* Options are allowed at the beginning of the command. The developer is - entreated to use these extremely sparingly. They are most useful for - implementing the 'no' form of configuration commands. Please think carefully - before using them for anything else. There is usually a better solution, even - if it is just separating out the command definition into separate ones. - -* The developer should judiciously apply separation of concerns when defining - CLI. CLI definitions for two unrelated or vaguely related commands or - configuration items should be defined in separate commands. Clarity is - preferred over LOC (within reason). - -* The maximum number of space-separated tokens that can be entered is presently - limited to 256. Please keep this limit in mind when implementing new CLI. - -Variable Names --------------- -The parser tries to fill the "varname" field on each token. This can happen -either manually or automatically. Manual specifications work by appending -`"$name"` after the input specifier: - -``` -foo bar$cmd WORD$name A.B.C.D$ip -``` - -Note that you can also assign variable names to fixed input tokens, this can -be useful if multiple commands share code. You can also use "$name" after a -multiple-choice option: - -``` -foo bar $addr [optionA|optionB]$mode -``` - -The variable name is in this case assigned to the last token in each of the -branches. - -Automatic assignment of variable names works by applying the following rules: - -- manual names always have priority -- a "[no]" at the beginning receives "no" as varname on the "no" token -- VARIABLE tokens whose text is not "WORD" or "NAME" receive a cleaned lowercase - version of the token text as varname, e.g. "ROUTE-MAP" becomes "route_map". -- other variable tokens (i.e. everything except "fixed") receive the text of - the preceding fixed token as varname, if one can be found. E.g.: - "ip route A.B.C.D/M INTERFACE" assigns "route" to the "A.B.C.D/M" token. - -These rules should make it possible to avoid manual varname assignment in 90% -of the cases. - -DEFPY ------ - -`DEFPY(...)` is an enhanced version of `DEFUN()` which is preprocessed by -` python/clidef.py`. The python script parses the command definition string, -extracts variable names and types, and generates a C wrapper function that -parses the variables and passes them on. This means that in the CLI function -body, you will receive additional parameters with appropriate types. - -This is best explained by an example: - -``` -DEFPY(func, func_cmd, "[no] foo bar A.B.C.D (0-99)$num", "...help...") - -=> - -func(self, vty, argc, argv, /* standard CLI arguments */ - - const char *no, /* unparsed "no" */ - struct in_addr bar, /* parsed IP address */ - const char *bar_str, /* unparsed IP address */ - long num, /* parsed num */ - const char *num_str) /* unparsed num */ -``` - -Note that as documented in the previous section, "bar" is automatically -applied as variable name for "A.B.C.D". The python code then detects this -is an IP address argument and generates code to parse it into a -`struct in_addr`, passing it in `bar`. The raw value is passed in `bar_str`. -The range/number argument works in the same way with the explicitly given -variable name. - -### Type rules - -| Token(s) | Type | Value if omitted by user | -|--------------------------|-------------|--------------------------| -| `A.B.C.D` | `struct in_addr` | 0.0.0.0 | -| `X:X::X:X` | `struct in6_addr` | :: | -| `A.B.C.D + X:X::X:X` | `const union sockunion *` | NULL | -| `A.B.C.D/M` | `const struct prefix_ipv4 *` | NULL | -| `X:X::X:X/M` | `const struct prefix_ipv6 *` | NULL | -| `A.B.C.D/M + X:X::X:X/M` | `const struct prefix *` | NULL | -| `(0-9)` | `long` | 0 | -| `VARIABLE` | `const char *` | NULL | -| `word` | `const char *` | NULL | -| _all other_ | `const char *` | NULL | - -Note the following details: - -* not all parameters are pointers, some are passed as values. -* when the type is not `const char *`, there will be an extra `_str` argument - with type `const char *`. -* you can give a variable name not only to `VARIABLE` tokens but also to - `word` tokens (e.g. constant words). This is useful if some parts of a - command are optional. The type will be `const char *`. -* `[no]` will be passed as `const char *no`. -* pointers will be NULL when the argument is optional and the user did not - use it. -* if a parameter is not a pointer, but is optional and the user didn't use it, - the default value will be passed. Check the `_str` argument if you need to - determine whether the parameter was omitted. -* if the definition contains multiple parameters with the same variable name, - they will be collapsed into a single function parameter. The python code - will detect if the types are compatible (i.e. IPv4 + IPv6 variantes) and - choose a corresponding C type. -* the standard DEFUN parameters (self, vty, argc, argv) are still present and - can be used. A DEFUN can simply be **edited into a DEFPY without further - changes and it will still work**; this allows easy forward migration. -* a file may contain both DEFUN and DEFPY statements. - -### Getting a parameter dump - -The clidef.py script can be called to get a list of DEFUNs/DEFPYs with -the parameter name/type list: - -``` -lib/clippy python/clidef.py --all-defun --show lib/plist.c > /dev/null -``` - -The generated code is printed to stdout, the info dump to stderr. The -`--all-defun` argument will make it process DEFUN blocks as well as DEFPYs, -which is useful prior to converting some DEFUNs. **The dump does not list -the `_str` arguments** to keep the output shorter. - -Note that the clidef.py script cannot be run with python directly, it needs -to be run with _clippy_ since the latter makes the CLI parser available. - -### Include & Makefile requirements - -A source file that uses DEFPY needs to include the `_clippy.c` file **before -all DEFPY statements**: - -``` -/* GPL header */ -#include ... - -... - -#include "daemon/filename_clippy.c" - -DEFPY(...) -DEFPY(...) - -install_element(...) -``` - -This dependency needs to be marked in Makefile.am: (there is no ordering -requirement) - -``` -include ../common.am - -# ... - -# if linked into a LTLIBRARY (.la/.so): -filename.lo: filename_clippy.c - -# if linked into an executable or static library (.a): -filename.o: filename_clippy.c -``` - -Doc Strings ------------ -Each token in a command definition should be documented with a brief doc -string that informs a user of the meaning and/or purpose of the subsequent -command tree. These strings are provided as the last parameter to DEFUN macros, -concatenated together and separated by an escaped newline ('\n'). These are -best explained by example. - -``` -DEFUN (config_terminal, - config_terminal_cmd, - "configure terminal", - "Configuration from vty interface\n" - "Configuration terminal\n") -``` - -The last parameter is split into two lines for readability. Two newline -delimited doc strings are present, one for each token in the command. The -second string documents the functionality of the 'terminal' command in the -'configure' tree. - -Note that the first string, for 'configure' does not contain documentation for -'terminal'. This is because the CLI is best envisioned as a tree, with tokens -defining branches. An imaginary 'start' token is the root of every command in a -CLI node. Each subsequent written token descends into a subtree, so the -documentation for that token ideally summarizes all the functionality contained -in the subtree. - -A consequence of this structure is that the developer must be careful to use -the same doc strings when defining multiple commands that are part of the same -tree. Commands which share prefixes must share the same doc strings for those -prefixes. On startup the parser will generate warnings if it notices -inconsistent doc strings. Behavior is undefined; the same token may show up -twice in completions, with different doc strings, or it may show up once with a -random doc string. Parser warnings should be heeded and fixed to avoid -confusing users. - -The number of doc strings provided must be equal to the amount of tokens -present in the command definition, read left to right, ignoring any special -constructs. - -In the examples below, each arrowed token needs a doc string. - -``` - "show ip bgp" - ^ ^ ^ - - "command [example]" - ^ ^ ^ ^ -``` - -Data Structures ---------------- -On startup, the CLI parser sequentially parses each command string definition -and constructs a directed graph with each token forming a node. This graph is -the basis of the entire CLI system. It is used to match user input in order to -generate command completions and match commands to functions. - -There is one graph per CLI node (not the same as a graph node in the CLI -graph). The CLI node struct keeps a reference to its graph (see lib/command.h). - -While most of the graph maintains the form of a tree, special constructs -outlined in the Rules section introduce some quirks. <>, [] and {} form -self-contained 'subgraphs'. Each subgraph is a tree except that all of the -'leaves' actually share a child node. This helps with minimizing graph size and -debugging. - -As an example, the subgraph generated by looks like this: - - . - . - | - +----+---+ - +--- -+ FORK +----+ - | +--------+ | - +--v---+ +--v---+ - | foo | | bar | - +--+---+ +--+---+ - | +------+ | - +------> JOIN <-----+ - +---+--+ - | - . - . - -FORK and JOIN nodes are plumbing nodes that don't correspond to user input. -They're necessary in order to deduplicate these constructs where applicable. - -Options follow the same form, except that there is an edge from the FORK node -to the JOIN node. - -Keywords follow the same form, except that there is an edge from JOIN to FORK. -Because of this the CLI graph cannot be called acyclic. There is special logic -in the input matching code that keeps a stack of paths already taken through -the node in order to disallow following the same path more than once. - -Variadics are a bit special; they have an edge back to themselves, which allows -repeating the same input indefinitely. - -The leaves of the graph are nodes that have no out edges. These nodes are -special; their data section does not contain a token, as most nodes do, or -NULL, as in FORK/JOIN nodes, but instead has a pointer to a cmd_element. All -paths through the graph that terminate on a leaf are guaranteed to be defined -by that command. When a user enters a complete command, the command matcher -tokenizes the input and executes a DFS on the CLI graph. If it is -simultaneously able to exhaust all input (one input token per graph node), and -then find exactly one leaf connected to the last node it reaches, then the -input has matched the corresponding command and the command is executed. If it -finds more than one node, then the command is ambiguous (more on this in -deduplication). If it cannot exhaust all input, the command is unknown. If it -exhausts all input but does not find an edge node, the command is incomplete. - -The parser uses an incremental strategy to build the CLI graph for a node. Each -command is parsed into its own graph, and then this graph is merged into the -overall graph. During this merge step, the parser makes a best-effort attempt -to remove duplicate nodes. If it finds a node in the overall graph that is -equal to a node in the corresponding position in the command graph, it will -intelligently merge the properties from the node in the command graph into the -already-existing node. Subgraphs are also checked for isomorphism and merged -where possible. The definition of whether two nodes are 'equal' is based on the -equality of some set of token properties; read the parser source for the most -up-to-date definition of equality. - -When the parser is unable to deduplicate some complicated constructs, this -can result in two identical paths through separate parts of the graph. If -this occurs and the user enters input that matches these paths, they will -receive an 'ambiguous command' error and will be unable to execute the command. -Most of the time the parser can detect and warn about duplicate commands, but -it will not always be able to do this. Hence care should be taken before -defining a new command to ensure it is not defined elsewhere. - - -Command handlers ----------------- -The block that follows a CLI definition is executed when a user enters input -that matches the definition. Its function signature looks like this: - -int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]); - -The first argument is the command definition struct. The last argument is an -ordered array of tokens that correspond to the path taken through the graph, -and the argument just prior to that is the length of the array. - -The arrangement of the token array has changed from the prior incarnation of -the CLI system. In the old system, missing arguments were padded with NULLs so -that the same parts of a command would show up at the same indices regardless -of what was entered. The new system does not perform such padding and therefore -it is generally _incorrect_ to assume consistent indices in this array. As a -simple example: - -Command definition: -``` - command [foo] -``` - -User enters: -``` - command foo bar -``` - -Array: -``` - [0] -> command - [1] -> foo - [2] -> bar -``` - -User enters: -``` - command baz -``` - -Array: -``` - [0] -> command - [1] -> baz -``` - - - -Command abbreviation & matching priority ----------------------------------------- -As in the prior implementation, it is possible for users to elide parts of -tokens when the CLI matcher does not need them to make an unambiguous match. -This is best explained by example. - -Command definitions: -``` - command dog cow - command dog crow -``` - -User input: -``` - c d c -> ambiguous command - c d co -> match "command dog cow" -``` - -In the new implementation, this functionality has improved. Where previously -the parser would stop at the first ambiguous token, it will now look ahead and -attempt to disambiguate based on tokens later on in the input string. - -Command definitions: -``` - show ip bgp A.B.C.D - show ipv6 bgp X:X::X:X -``` - -User enters: -``` - s i b 4.3.2.1 -> match "show ip bgp A.B.C.D" - s i b ::e0 -> match "show ipv6 bgp X:X::X:X" -``` - -Previously both of these commands would be ambiguous since 'i' does not -explicitly select either 'ip' or 'ipv6'. However, since the user later provides -a token that matches only one of the commands (an IPv4 or IPv6 address) the -parser is able to look ahead and select the appropriate command. This has some -implications for parsing the argv*[] that is passed to the command handler. - -Now consider a command definition such as: -``` - command -``` - -'foo' only matches the string 'foo', but 'VAR' matches any input, including -'foo'. Who wins? In situations like this the matcher will always choose the -'better' match, so 'foo' will win. - -Consider also: -``` - show foo -``` - -User input: -``` - show ip foo -``` - -'ip' partially matches 'ipv6' but exactly matches 'ip', so 'ip' will win. - - -struct cmd_token ----------------- - -``` -/* Command token struct. */ -struct cmd_token -{ - enum cmd_token_type type; // token type - u_char attr; // token attributes - bool allowrepeat; // matcher allowed to match token repetitively? - - char *text; // token text - char *desc; // token description - long long min, max; // for ranges - char *arg; // user input that matches this token - char *varname; // variable name -}; -``` - -This struct is used in the CLI graph to match input against. It is also used to -pass user input to command handler functions, as it is frequently useful for -handlers to have access to that information. When a command is matched, the -sequence of cmd_tokens that form the matching path are duplicated and placed in -order into argv*[]. Before this happens the ->arg field is set to point at the -snippet of user input that matched it. - -For most nontrivial commands the handler function will need to determine which -of the possible matching inputs was entered. Previously this was done by -looking at the first few characters of input. This is now considered an -anti-pattern and should be avoided. Instead, the ->type or ->text fields for -this logic. The ->type field can be used when the possible inputs differ in -type. When the possible types are the same, use the ->text field. This field -has the full text of the corresponding token in the definition string and using -it makes for much more readable code. An example is helpful. - -Command definition: -``` - command <(1-10)|foo|BAR> -``` - -In this example, the user may enter any one of: - * an integer between 1 and 10 - * "foo" - * anything at all - -If the user enters "command f", then: - -``` -argv[1]->type == WORD_TKN -argv[1]->arg == "f" -argv[1]->text == "foo" -``` - -Range tokens have some special treatment; a token with ->type == RANGE_TKN will -have the ->min and ->max fields set to the bounding values of the range. - - -Permutations ------------- -Finally, it is sometimes useful to check all the possible combinations of input -that would match an arbitrary definition string. There is a tool in tools/ -called 'permutations' that reads CLI definition strings on stdin and prints out -all matching input permutations. It also dumps a text representation of the -graph, which is more useful for debugging than anything else. It looks like -this: - -``` -$ ./permutations "show [ip] bgp [ WORD]" - -show ip bgp view WORD -show ip bgp vrf WORD -show ip bgp -show bgp view WORD -show bgp vrf WORD -show bgp -``` - -This functionality is also built into VTY/VTYSH; the 'list permutations' -command will list all possible matching input permutations in the current CLI -node. diff --git a/doc/code/.gitignore b/doc/code/.gitignore deleted file mode 100644 index 0505537159..0000000000 --- a/doc/code/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -/_templates -/_build -!/Makefile diff --git a/doc/code/Makefile b/doc/code/Makefile deleted file mode 100644 index 056b78e68e..0000000000 --- a/doc/code/Makefile +++ /dev/null @@ -1,216 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/Building_FRR_on_CentOS6.md b/doc/developer/Building_FRR_on_CentOS6.rst similarity index 65% rename from doc/Building_FRR_on_CentOS6.md rename to doc/developer/Building_FRR_on_CentOS6.rst index 10830e5016..e93ae603ef 100644 --- a/doc/Building_FRR_on_CentOS6.md +++ b/doc/developer/Building_FRR_on_CentOS6.rst @@ -1,46 +1,53 @@ -Building FRR on CentOS 6 from Git Source +CentOS 6 ======================================== (As an alternative to this installation, you may prefer to create a FRR -rpm package yourself and install that package instead. See instructions -in redhat/README.rpm_build.md on how to build a rpm package) +rpm package yourself and install that package instead. See instructions +in redhat/README.rpm\_build.md on how to build a rpm package) -Instructions are tested with `CentOS 6.8` on `x86_64` platform +Instructions are tested with ``CentOS 6.8`` on ``x86_64`` platform CentOS 6 restrictions: ---------------------- -- PIMd is not supported on `CentOS 6`. Upgrade to `CentOS 7` if PIMd is - needed -- MPLS is not supported on `CentOS 6`. MPLS requires Linux Kernel 4.5 or - higher (LDP can be built, but may have limited use without MPLS) -- Zebra is unable to detect what bridge/vrf an interface is associcated - with (IFLA_INFO_SLAVE_KIND does not exist in the kernel headers, you - can use a newer kernel + headers to get this functionality) -- frr_reload.py will not work, as this requires Python 2.7, and CentOS 6 - only has 2.6. You can install Python 2.7 via IUS, but it won't work - properly unless you compile and install the ipaddr package for it. +- PIMd is not supported on ``CentOS 6``. Upgrade to ``CentOS 7`` if + PIMd is needed +- MPLS is not supported on ``CentOS 6``. MPLS requires Linux Kernel 4.5 + or higher (LDP can be built, but may have limited use without MPLS) +- Zebra is unable to detect what bridge/vrf an interface is associcated + with (IFLA\_INFO\_SLAVE\_KIND does not exist in the kernel headers, + you can use a newer kernel + headers to get this functionality) +- frr\_reload.py will not work, as this requires Python 2.7, and CentOS + 6 only has 2.6. You can install Python 2.7 via IUS, but it won't work + properly unless you compile and install the ipaddr package for it. Install required packages ------------------------- Add packages: +:: + sudo yum install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel flex epel-release perl-XML-LibXML \ c-ares-devel -Install newer version of bison (CentOS 6 package source is too old) from +Install newer version of bison (CentOS 6 package source is too old) from CentOS 7 +:: + sudo yum install rpm-build curl -O http://vault.centos.org/7.0.1406/os/Source/SPackages/bison-2.7-4.el7.src.rpm rpmbuild --rebuild ./bison-2.7-4.el7.src.rpm sudo yum install ./rpmbuild/RPMS/x86_64/bison-2.7-4.el6.x86_64.rpm rm -rf rpmbuild -Install newer version of autoconf and automake (Package versions are too old) +Install newer version of autoconf and automake (Package versions are too +old) + +:: curl -O http://ftp.gnu.org/gnu/autoconf/autoconf-2.69.tar.gz tar xvf autoconf-2.69.tar.gz @@ -49,7 +56,7 @@ Install newer version of autoconf and automake (Package versions are too old) make sudo make install cd .. - + curl -O http://ftp.gnu.org/gnu/automake/automake-1.15.tar.gz tar xvf automake-1.15.tar.gz cd automake-1.15 @@ -58,35 +65,45 @@ Install newer version of autoconf and automake (Package versions are too old) sudo make install cd .. -Install `Python 2.7` in parallel to default 2.6. -Make sure you've install EPEL (`epel-release` as above). Then install current -`python27`, `python27-devel` and `pytest` +Install ``Python 2.7`` in parallel to default 2.6. Make sure you've +install EPEL (``epel-release`` as above). Then install current +``python27``, ``python27-devel`` and ``pytest`` + +:: sudo rpm -ivh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm sudo rpm -ivh https://centos6.iuscommunity.org/ius-release.rpm sudo yum install python27 python27-pip python27-devel sudo pip2.7 install pytest -Please note that `CentOS 6` needs to keep python pointing to version 2.6 -for `yum` to keep working, so don't create a symlink for python2.7 to python +Please note that ``CentOS 6`` needs to keep python pointing to version +2.6 for ``yum`` to keep working, so don't create a symlink for python2.7 +to python Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -r -g 85 frrvt sudo useradd -u 92 -g 92 -M -r -G frrvt -s /sbin/nologin \ -c "FRR FRRouting suite" -d /var/run/frr frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -120,7 +137,11 @@ an example.) make check PYTHON=/usr/bin/python2.7 sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /var/log/frr sudo mkdir /etc/frr sudo touch /etc/frr/zebra.conf @@ -138,20 +159,28 @@ an example.) sudo chown frr:frrvt /etc/frr/vtysh.conf sudo chmod 640 /etc/frr/*.conf -### Install daemon config file +Install daemon config file +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo install -p -m 644 redhat/daemons /etc/frr/ sudo chown frr:frr /etc/frr/daemons -### Edit /etc/frr/daemons as needed to select the required daemons +Edit /etc/frr/daemons as needed to select the required daemons +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Look for the section with `watchfrr_enable=...` and `zebra=...` etc. -Enable the daemons as required by changing the value to `yes` +Look for the section with ``watchfrr_enable=...`` and ``zebra=...`` etc. +Enable the daemons as required by changing the value to ``yes`` -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and set the following values (ignore the other +Edit ``/etc/sysctl.conf`` and set the following values (ignore the other settings) +:: + # Controls IP packet forwarding net.ipv4.ip_forward = 1 net.ipv6.conf.all.forwarding=1 @@ -161,14 +190,28 @@ settings) Load the modifed sysctl's on the system: +:: + sudo sysctl -p /etc/sysctl.d/90-routing-sysctl.conf -### Add init.d startup files +Add init.d startup files +~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo install -p -m 755 redhat/frr.init /etc/init.d/frr sudo chkconfig --add frr -### Enable frr daemon at startup +Enable frr daemon at startup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo chkconfig frr on -### Start FRR manually (or reboot) +Start FRR manually (or reboot) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo /etc/init.d/frr start diff --git a/doc/Building_FRR_on_CentOS7.md b/doc/developer/Building_FRR_on_CentOS7.rst similarity index 71% rename from doc/Building_FRR_on_CentOS7.md rename to doc/developer/Building_FRR_on_CentOS7.rst index 787b80fbf7..60c4266894 100644 --- a/doc/Building_FRR_on_CentOS7.md +++ b/doc/developer/Building_FRR_on_CentOS7.rst @@ -1,22 +1,24 @@ -Building FRR on CentOS 7 from Git Source +CentOS 7 ======================================== (As an alternative to this installation, you may prefer to create a FRR rpm package yourself and install that package instead. See instructions -in redhat/README.rpm_build.md on how to build a rpm package) +in redhat/README.rpm\_build.md on how to build a rpm package) CentOS 7 restrictions: ---------------------- -- MPLS is not supported on `CentOS 7` with default kernel. MPLS requires - Linux Kernel 4.5 or higher (LDP can be built, but may have limited use - without MPLS) - +- MPLS is not supported on ``CentOS 7`` with default kernel. MPLS + requires Linux Kernel 4.5 or higher (LDP can be built, but may have + limited use without MPLS) + Install required packages ------------------------- Add packages: +:: + sudo yum install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel bison flex pytest c-ares-devel \ @@ -25,20 +27,27 @@ Add packages: Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -r -g 85 frrvt sudo useradd -u 92 -g 92 -M -r -G frrvt -s /sbin/nologin \ -c "FRR FRRouting suite" -d /var/run/frr frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -72,7 +81,11 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /var/log/frr sudo mkdir /etc/frr sudo touch /etc/frr/zebra.conf @@ -91,20 +104,28 @@ an example.) sudo chown frr:frrvt /etc/frr/vtysh.conf sudo chmod 640 /etc/frr/*.conf -### Install daemon config file +Install daemon config file +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo install -p -m 644 redhat/daemons /etc/frr/ sudo chown frr:frr /etc/frr/daemons -### Edit /etc/frr/daemons as needed to select the required daemons +Edit /etc/frr/daemons as needed to select the required daemons +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Look for the section with `watchfrr_enable=...` and `zebra=...` etc. -Enable the daemons as required by changing the value to `yes` +Look for the section with ``watchfrr_enable=...`` and ``zebra=...`` etc. +Enable the daemons as required by changing the value to ``yes`` -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new file `/etc/sysctl.d/90-routing-sysctl.conf` with the +Create a new file ``/etc/sysctl.d/90-routing-sysctl.conf`` with the following content: +:: + # Sysctl for routing # # Routing: We need to forward packets @@ -113,17 +134,35 @@ following content: Load the modifed sysctl's on the system: +:: + sudo sysctl -p /etc/sysctl.d/90-routing-sysctl.conf -### Install frr Service and redhat init files +Install frr Service and redhat init files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo install -p -m 644 redhat/frr.service /usr/lib/systemd/system/frr.service sudo install -p -m 755 redhat/frr.init /usr/lib/frr/frr -### Register the systemd files +Register the systemd files +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo systemctl preset frr.service - -### Enable required frr at startup + +Enable required frr at startup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo systemctl enable frr -### Reboot or start FRR manually +Reboot or start FRR manually +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo systemctl start frr diff --git a/doc/Building_FRR_on_Debian8.md b/doc/developer/Building_FRR_on_Debian8.rst similarity index 74% rename from doc/Building_FRR_on_Debian8.md rename to doc/developer/Building_FRR_on_Debian8.rst index a2dbbdb30f..af24539cb6 100644 --- a/doc/Building_FRR_on_Debian8.md +++ b/doc/developer/Building_FRR_on_Debian8.rst @@ -1,33 +1,40 @@ -Building FRR on Debian 8 from Git Source +Debian 8 ======================================== Debian 8 restrictions: ---------------------- -- MPLS is not supported on `Debian 8` with default kernel. MPLS requires - Linux Kernel 4.5 or higher (LDP can be built, but may have limited use - without MPLS) +- MPLS is not supported on ``Debian 8`` with default kernel. MPLS + requires Linux Kernel 4.5 or higher (LDP can be built, but may have + limited use without MPLS) Install required packages ------------------------- Add packages: +:: + sudo apt-get install git autoconf automake libtool make gawk \ libreadline-dev texinfo libjson-c-dev pkg-config bison flex \ python-pip libc-ares-dev python3-dev -Install newer pytest (>3.0) from pip +Install newer pytest (>3.0) from pip + +:: sudo pip install pytest Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo addgroup --system --gid 92 frr sudo addgroup --system --gid 85 frrvty @@ -35,10 +42,14 @@ any packages** --gecos "FRR suite" --shell /bin/false frr sudo usermod -a -G frrvty frr -### Download Source, configure and compile it +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + (You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -68,7 +79,10 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo install -m 755 -o frr -g frr -d /var/log/frr sudo install -m 775 -o frr -g frrvty -d /etc/frr @@ -84,11 +98,14 @@ an example.) sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and uncomment the following values (ignore the +Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the other settings) +:: + # Uncomment the next line to enable packet forwarding for IPv4 net.ipv4.ip_forward=1 @@ -97,35 +114,43 @@ other settings) # based on Router Advertisements for this host net.ipv6.conf.all.forwarding=1 -**Reboot** or use `sysctl -p` to apply the same config to the running system +**Reboot** or use ``sysctl -p`` to apply the same config to the running +system -### Troubleshooting +Troubleshooting +~~~~~~~~~~~~~~~ **Local state directory** -The local state directory must exist and have the correct permissions applied -for the frrouting daemons to start. In the above ./configure example the -local state directory is set to /var/run/frr (--localstatedir=/var/run/frr) -Debian considers /var/run/frr to be temporary and this is removed after a -reboot. +The local state directory must exist and have the correct permissions +applied for the frrouting daemons to start. In the above ./configure +example the local state directory is set to /var/run/frr +(--localstatedir=/var/run/frr) Debian considers /var/run/frr to be +temporary and this is removed after a reboot. When using a different local state directory you need to create the new directory and change the ownership to the frr user, for example: +:: + mkdir /var/opt/frr chown frr /var/opt/frr **Shared library error** -If you try and start any of the frrouting daemons you may see the below error -due to the frrouting shared library directory not being found: +If you try and start any of the frrouting daemons you may see the below +error due to the frrouting shared library directory not being found: + +:: ./zebra: error while loading shared libraries: libfrr.so.0: cannot open shared object file: No such file or directory -The fix is to add the following line to /etc/ld.so.conf which will continue to -reference the library directory after the system reboots. To load the library -directory path immediately run the ldconfig command after adding the line to -the file eg: +The fix is to add the following line to /etc/ld.so.conf which will +continue to reference the library directory after the system reboots. To +load the library directory path immediately run the ldconfig command +after adding the line to the file eg: + +:: echo include /usr/local/lib >> /etc/ld.so.conf ldconfig diff --git a/doc/Building_FRR_on_Debian9.md b/doc/developer/Building_FRR_on_Debian9.rst similarity index 77% rename from doc/Building_FRR_on_Debian9.md rename to doc/developer/Building_FRR_on_Debian9.rst index 1536c25932..a3e3d7ff97 100644 --- a/doc/Building_FRR_on_Debian9.md +++ b/doc/developer/Building_FRR_on_Debian9.rst @@ -1,4 +1,4 @@ -Building FRR on Debian 9 from Git Source +Debian 9 ======================================== Install required packages @@ -6,6 +6,8 @@ Install required packages Add packages: +:: + sudo apt-get install git autoconf automake libtool make \ libreadline-dev texinfo libjson-c-dev pkg-config bison flex \ python-pip libc-ares-dev python3-dev python-pytest @@ -13,10 +15,13 @@ Add packages: Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo addgroup --system --gid 92 frr sudo addgroup --system --gid 85 frrvty @@ -24,10 +29,14 @@ any packages** --gecos "FRR suite" --shell /bin/false frr sudo usermod -a -G frrvty frr -### Download Source, configure and compile it +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + (You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr git checkout stable/3.0 @@ -58,7 +67,10 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo install -m 755 -o frr -g frr -d /var/log/frr sudo install -m 775 -o frr -g frrvty -d /etc/frr @@ -74,11 +86,14 @@ an example.) sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and uncomment the following values (ignore the +Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the other settings) +:: + # Uncomment the next line to enable packet forwarding for IPv4 net.ipv4.ip_forward=1 @@ -87,35 +102,43 @@ other settings) # based on Router Advertisements for this host net.ipv6.conf.all.forwarding=1 -**Reboot** or use `sysctl -p` to apply the same config to the running system +**Reboot** or use ``sysctl -p`` to apply the same config to the running +system -### Troubleshooting +Troubleshooting +~~~~~~~~~~~~~~~ **Local state directory** -The local state directory must exist and have the correct permissions applied -for the frrouting daemons to start. In the above ./configure example the -local state directory is set to /var/run/frr (--localstatedir=/var/run/frr) -Debian considers /var/run/frr to be temporary and this is removed after a -reboot. +The local state directory must exist and have the correct permissions +applied for the frrouting daemons to start. In the above ./configure +example the local state directory is set to /var/run/frr +(--localstatedir=/var/run/frr) Debian considers /var/run/frr to be +temporary and this is removed after a reboot. When using a different local state directory you need to create the new directory and change the ownership to the frr user, for example: +:: + mkdir /var/opt/frr chown frr /var/opt/frr **Shared library error** -If you try and start any of the frrouting daemons you may see the below error -due to the frrouting shared library directory not being found: +If you try and start any of the frrouting daemons you may see the below +error due to the frrouting shared library directory not being found: + +:: ./zebra: error while loading shared libraries: libfrr.so.0: cannot open shared object file: No such file or directory -The fix is to add the following line to /etc/ld.so.conf which will continue to -reference the library directory after the system reboots. To load the library -directory path immediately run the ldconfig command after adding the line to -the file eg: +The fix is to add the following line to /etc/ld.so.conf which will +continue to reference the library directory after the system reboots. To +load the library directory path immediately run the ldconfig command +after adding the line to the file eg: + +:: echo include /usr/local/lib >> /etc/ld.so.conf ldconfig diff --git a/doc/Building_FRR_on_Fedora24.md b/doc/developer/Building_FRR_on_Fedora24.rst similarity index 73% rename from doc/Building_FRR_on_Fedora24.md rename to doc/developer/Building_FRR_on_Fedora24.rst index 0070fd1534..5ba4dd0e5f 100644 --- a/doc/Building_FRR_on_Fedora24.md +++ b/doc/developer/Building_FRR_on_Fedora24.rst @@ -1,15 +1,17 @@ -Building FRR on Fedora 24 from Git Source +Fedora 24 ========================================= (As an alternative to this installation, you may prefer to create a FRR rpm package yourself and install that package instead. See instructions -in redhat/README.rpm_build.md on how to build a rpm package) +in redhat/README.rpm\_build.md on how to build a rpm package) Install required packages ------------------------- Add packages: +:: + sudo dnf install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel perl-XML-LibXML pytest bison flex \ @@ -18,20 +20,27 @@ Add packages: Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not +**This assumes you want to build and install FRR from source and not using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -r -g 85 frrvt sudo useradd -u 92 -g 92 -M -r -G frrvt -s /sbin/nologin \ -c "FRR FRRouting suite" -d /var/run/frr frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -65,7 +74,11 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /var/log/frr sudo mkdir /etc/frr sudo touch /etc/frr/zebra.conf @@ -85,21 +98,28 @@ an example.) sudo chown frr:frrvt /etc/frr/vtysh.conf sudo chmod 640 /etc/frr/*.conf -### Install daemon config file +Install daemon config file +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo install -p -m 644 redhat/daemons /etc/frr/ sudo chown frr:frr /etc/frr/daemons -### Edit /etc/frr/daemons as needed to select the required daemons +Edit /etc/frr/daemons as needed to select the required daemons +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Look for the section with `watchfrr_enable=...` and `zebra=...` etc. -Enable the daemons as required by changing the value to `yes` +Look for the section with ``watchfrr_enable=...`` and ``zebra=...`` etc. +Enable the daemons as required by changing the value to ``yes`` -### Enable IP & IPv6 forwarding (and MPLS) +Enable IP & IPv6 forwarding (and MPLS) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a new file `/etc/sysctl.d/90-routing-sysctl.conf` with the -following content: -(Please make sure to list all interfaces with required MPLS similar -to `net.mpls.conf.eth0.input=1`) +Create a new file ``/etc/sysctl.d/90-routing-sysctl.conf`` with the +following content: (Please make sure to list all interfaces with +required MPLS similar to ``net.mpls.conf.eth0.input=1``) + +:: # Sysctl for routing # @@ -115,9 +135,14 @@ to `net.mpls.conf.eth0.input=1`) Load the modifed sysctl's on the system: +:: + sudo sysctl -p /etc/sysctl.d/90-routing-sysctl.conf -Create a new file `/etc/modules-load.d/mpls.conf` with the following content: +Create a new file ``/etc/modules-load.d/mpls.conf`` with the following +content: + +:: # Load MPLS Kernel Modules mpls-router @@ -125,14 +150,28 @@ Create a new file `/etc/modules-load.d/mpls.conf` with the following content: And load the kernel modules on the running system: +:: + sudo modprobe mpls-router mpls-iptunnel -### Install frr Service and redhat init files +Install frr Service and redhat init files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo install -p -m 644 redhat/frr.service /usr/lib/systemd/system/frr.service sudo install -p -m 755 redhat/frr.init /usr/lib/frr/frr - -### Enable required frr at startup + +Enable required frr at startup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo systemctl enable frr -### Reboot or start FRR manually +Reboot or start FRR manually +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo systemctl start frr diff --git a/doc/Building_FRR_on_FreeBSD10.md b/doc/developer/Building_FRR_on_FreeBSD10.rst similarity index 75% rename from doc/Building_FRR_on_FreeBSD10.md rename to doc/developer/Building_FRR_on_FreeBSD10.rst index ccae83a667..94f2f27282 100644 --- a/doc/Building_FRR_on_FreeBSD10.md +++ b/doc/developer/Building_FRR_on_FreeBSD10.rst @@ -1,46 +1,53 @@ -Building FRR on FreeBSD 10 from Git Source +FreeBSD 10 ========================================== FreeBSD 10 restrictions: ------------------------ -- MPLS is not supported on `FreeBSD`. MPLS requires a Linux Kernel - (4.5 or higher). LDP can be built, but may have limited use - without MPLS +- MPLS is not supported on ``FreeBSD``. MPLS requires a Linux Kernel + (4.5 or higher). LDP can be built, but may have limited use without + MPLS Install required packages ------------------------- -Add packages: -(Allow the install of the package managment tool if this is first package -install and asked) +Add packages: (Allow the install of the package managment tool if this +is first package install and asked) + +:: pkg install git autoconf automake libtool gmake gawk json-c pkgconf \ bison flex py27-pytest c-ares python3 -Make sure there is no /usr/bin/flex preinstalled (and use the newly -installed in /usr/local/bin): -(FreeBSD frequently provides a older flex as part of the base OS which -takes preference in path) +Make sure there is no /usr/bin/flex preinstalled (and use the newly +installed in /usr/local/bin): (FreeBSD frequently provides a older flex +as part of the base OS which takes preference in path) + +:: rm -f /usr/bin/flex Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not +**This assumes you want to build and install FRR from source and not using any packages** -### Add frr group and user +Add frr group and user +~~~~~~~~~~~~~~~~~~~~~~ + +:: pw groupadd frr -g 101 pw groupadd frrvty -g 102 pw adduser frr -g 101 -u 101 -G 102 -c "FRR suite" \ -d /usr/local/etc/frr -s /usr/sbin/nologin -(You may prefer different options on configure statement. These are just +(You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -68,7 +75,11 @@ an example) gmake check sudo gmake install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /usr/local/etc/frr sudo touch /usr/local/etc/frr/zebra.conf sudo touch /usr/local/etc/frr/bgpd.conf @@ -83,12 +94,16 @@ an example) sudo chown frr:frrvty /usr/local/etc/frr/vtysh.conf sudo chmod 640 /usr/local/etc/frr/*.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to the end of `/etc/sysctl.conf`: +Add the following lines to the end of ``/etc/sysctl.conf``: + +:: # Routing: We need to forward packets net.inet.ip.forwarding=1 net.inet6.ip6.forwarding=1 -**Reboot** or use `sysctl` to apply the same config to the running system +**Reboot** or use ``sysctl`` to apply the same config to the running +system diff --git a/doc/Building_FRR_on_FreeBSD11.md b/doc/developer/Building_FRR_on_FreeBSD11.rst similarity index 75% rename from doc/Building_FRR_on_FreeBSD11.md rename to doc/developer/Building_FRR_on_FreeBSD11.rst index 71ccd149ff..de118093e6 100644 --- a/doc/Building_FRR_on_FreeBSD11.md +++ b/doc/developer/Building_FRR_on_FreeBSD11.rst @@ -1,37 +1,42 @@ -Building FRR on FreeBSD 11 from Git Source +FreeBSD 11 ========================================== FreeBSD 11 restrictions: ------------------------ -- MPLS is not supported on `FreeBSD`. MPLS requires a Linux Kernel - (4.5 or higher). LDP can be built, but may have limited use - without MPLS +- MPLS is not supported on ``FreeBSD``. MPLS requires a Linux Kernel + (4.5 or higher). LDP can be built, but may have limited use without + MPLS Install required packages ------------------------- -Add packages: -(Allow the install of the package managment tool if this is first package -install and asked) +Add packages: (Allow the install of the package managment tool if this +is first package install and asked) + +:: pkg install git autoconf automake libtool gmake gawk json-c pkgconf \ bison flex py27-pytest c-ares python3 -Make sure there is no /usr/bin/flex preinstalled (and use the newly -installed in /usr/local/bin): -(FreeBSD frequently provides a older flex as part of the base OS which -takes preference in path) +Make sure there is no /usr/bin/flex preinstalled (and use the newly +installed in /usr/local/bin): (FreeBSD frequently provides a older flex +as part of the base OS which takes preference in path) + +:: rm -f /usr/bin/flex Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not +**This assumes you want to build and install FRR from source and not using any packages** -### Add frr group and user +Add frr group and user +~~~~~~~~~~~~~~~~~~~~~~ + +:: pw groupadd frr -g 101 pw groupadd frrvty -g 102 @@ -41,6 +46,8 @@ using any packages** (You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -68,7 +75,11 @@ an example) gmake check sudo gmake install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /usr/local/etc/frr sudo touch /usr/local/etc/frr/zebra.conf sudo touch /usr/local/etc/frr/bgpd.conf @@ -83,12 +94,16 @@ an example) sudo chown frr:frrvty /usr/local/etc/frr/vtysh.conf sudo chmod 640 /usr/local/etc/frr/*.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to the end of `/etc/sysctl.conf`: +Add the following lines to the end of ``/etc/sysctl.conf``: + +:: # Routing: We need to forward packets net.inet.ip.forwarding=1 net.inet6.ip6.forwarding=1 -**Reboot** or use `sysctl` to apply the same config to the running system +**Reboot** or use ``sysctl`` to apply the same config to the running +system diff --git a/doc/Building_FRR_on_FreeBSD9.md b/doc/developer/Building_FRR_on_FreeBSD9.rst similarity index 73% rename from doc/Building_FRR_on_FreeBSD9.md rename to doc/developer/Building_FRR_on_FreeBSD9.rst index 8a09d8a4cc..2ccf56be13 100644 --- a/doc/Building_FRR_on_FreeBSD9.md +++ b/doc/developer/Building_FRR_on_FreeBSD9.rst @@ -1,32 +1,39 @@ -Building FRR on FreeBSD 9 from Git Source +FreeBSD 9 ========================================= FreeBSD 9 restrictions: ----------------------- -- MPLS is not supported on `FreeBSD`. MPLS requires a Linux Kernel - (4.5 or higher). LDP can be built, but may have limited use - without MPLS - +- MPLS is not supported on ``FreeBSD``. MPLS requires a Linux Kernel + (4.5 or higher). LDP can be built, but may have limited use without + MPLS + Install required packages ------------------------- -Add packages: -(Allow the install of the package managment tool if this is first package -install and asked) +Add packages: (Allow the install of the package managment tool if this +is first package install and asked) + +:: pkg install -y git autoconf automake libtool gmake gawk \ pkgconf texinfo json-c bison flex py27-pytest c-ares \ python3 Make sure there is no /usr/bin/flex preinstalled (and use the newly -installed in /usr/local/bin): -(FreeBSD frequently provides a older flex as part of the base OS which -takes preference in path) +installed in /usr/local/bin): (FreeBSD frequently provides a older flex +as part of the base OS which takes preference in path) + +:: rm -f /usr/bin/flex -For building with clang (instead of gcc), upgrade clang from 3.4 default to 3.6 *This is needed to build FreeBSD packages as well - for packages clang is default* (Clang 3.4 as shipped with FreeBSD 9 crashes during compile) +For building with clang (instead of gcc), upgrade clang from 3.4 default +to 3.6 *This is needed to build FreeBSD packages as well - for packages +clang is default* (Clang 3.4 as shipped with FreeBSD 9 crashes during +compile) + +:: pkg install clang36 pkg delete clang34 @@ -39,7 +46,10 @@ Get FRR, compile it and install it (from Git) **This assumes you want to build and install FRR from source and not using any packages** -### Add frr group and user +Add frr group and user +~~~~~~~~~~~~~~~~~~~~~~ + +:: pw groupadd frr -g 101 pw groupadd frrvty -g 102 @@ -49,6 +59,8 @@ using any packages** (You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -76,7 +88,11 @@ an example) gmake check sudo gmake install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /usr/local/etc/frr sudo touch /usr/local/etc/frr/zebra.conf sudo touch /usr/local/etc/frr/bgpd.conf @@ -91,12 +107,16 @@ an example) sudo chown frr:frrvty /usr/local/etc/frr/vtysh.conf sudo chmod 640 /usr/local/etc/frr/*.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to the end of `/etc/sysctl.conf`: +Add the following lines to the end of ``/etc/sysctl.conf``: + +:: # Routing: We need to forward packets net.inet.ip.forwarding=1 net.inet6.ip6.forwarding=1 -**Reboot** or use `sysctl` to apply the same config to the running system +**Reboot** or use ``sysctl`` to apply the same config to the running +system diff --git a/doc/Building_FRR_for_LEDE-OpenWRT.md b/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst similarity index 59% rename from doc/Building_FRR_for_LEDE-OpenWRT.md rename to doc/developer/Building_FRR_on_LEDE-OpenWRT.rst index cde68dbd0b..2ddd8bcc44 100644 --- a/doc/Building_FRR_for_LEDE-OpenWRT.md +++ b/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst @@ -1,9 +1,10 @@ -Building FRR for OpenWRT/LEDE from Git Source -=============================================== +OpenWRT/LEDE +============================================= -- for the moment because of cross compile problems, master is not supported, - only upto 3.0 -- LDP can't be built because of missing Perl-XML-LibXML in OpenWRT/LEDE tree +- for the moment because of cross compile problems, master is not + supported, only up to 3.0 +- LDP can't be built because of missing Perl-XML-LibXML in OpenWRT/LEDE + tree Prepare build environment ------------------------- @@ -14,27 +15,37 @@ for Ubuntu 12.04LTS: +:: + sudo apt-get install build-essential subversion git-core \ libncurses5-dev zlib1g-dev gawk flex quilt libssl-dev xsltproc \ libxml-parser-perl mercurial bzr ecj cvs unzip Ubuntu 64bit: +:: + sudo apt-get install build-essential subversion libncurses5-dev zlib1g-dev \ gawk gcc-multilib flex git-core gettext libssl-dev Debian 8 Jessie: +:: + sudo apt-get install build-essential libncurses5-dev gawk git subversion \ libssl-dev gettext unzip zlib1g-dev file python Debian 9 Stretch: +:: + sudo apt-get install build-essential libncurses5-dev gawk git subversion \ libssl-dev gettext zlib1g-dev Centos x86-64 (some packages require EPEL): +:: + yum install subversion binutils bzip2 gcc gcc-c++ gawk gettext flex \ ncurses-devel zlib-devel zlib-static make patch unzip glibc glibc-devel \ perl-ExtUtils-MakeMaker glibc-static quilt ncurses-libs sed sdcc bison \ @@ -42,35 +53,33 @@ Centos x86-64 (some packages require EPEL): Fedora 24 - 64Bit: +:: + dnf install -y subversion binutils bzip2 gcc gcc-c++ gawk gettext git-core \ unzip ncurses-devel ncurses-compat-libs zlib-devel zlib-static make \ flex patch perl-ExtUtils-MakeMaker perl-Thread-Queue glibc glibc-devel \ glibc-static quilt sed sdcc intltool sharutils bison wget openssl-devel - Get LEDE Sources (from Git) --------------------------- -LEDE and OpenWRT is planned to remerge and won't cover the similar OpenWRT build -As normal user: - git clone https://git.lede-project.org/source.git lede - cd lede - ./scripts/feeds update -a - ./scripts/feeds install -a - cd feeds/routing - git pull origin pull/319/head - ln -s ../../../feeds/routing/frr/ ../../package/feeds/routing/ - cd ../.. - make menuconfig +LEDE and OpenWRT is planned to remerge and won't cover the similar +OpenWRT build As normal user: git clone +https://git.lede-project.org/source.git lede cd lede ./scripts/feeds +update -a ./scripts/feeds install -a cd feeds/routing git pull origin +pull/319/head ln -s ../../../feeds/routing/frr/ +../../package/feeds/routing/ cd ../.. make menuconfig -Select the needed target then select needed packages in -Network -> Routing and Redirection -> frr, exit and save +Select the needed target then select needed packages in Network -> +Routing and Redirection -> frr, exit and save + +:: make or make package/frr/compile -It may be possible that on first build `make package/frr/compile` not to work -and it may be needed to run a `make` for the entire build envronment, add V=s -for debugging +It may be possible that on first build ``make package/frr/compile`` not +to work and it may be needed to run a ``make`` for the entire build +envronment, add V=s for debugging Work with sources ----------------- @@ -78,19 +87,21 @@ Work with sources To update the rc1 version or add other options, the Makefile is found in feeds/routing/frr -edit: - PKG_VERSION:= - PKG_SOURCE_VERSION:= +edit: PKG\_VERSION:= PKG\_SOURCE\_VERSION:= Usage ----- -Edit `/usr/sbin/frr.init` and add/remove the daemons name in section DAEMONS= -or don't install unneded packages -For example: zebra bgpd ldpd isisd nhrpd ospfd ospf6d pimd ripd ripngd +Edit ``/usr/sbin/frr.init`` and add/remove the daemons name in section +DAEMONS= or don't install unneded packages For example: zebra bgpd ldpd +isisd nhrpd ospfd ospf6d pimd ripd ripngd -### Enable the serivce - - service frr enable +Enable the serivce +~~~~~~~~~~~~~~~~~~ -### Start the service - - service frr start +- service frr enable + +Start the service +~~~~~~~~~~~~~~~~~ + +- service frr start diff --git a/doc/Building_FRR_on_NetBSD6.md b/doc/developer/Building_FRR_on_NetBSD6.rst similarity index 79% rename from doc/Building_FRR_on_NetBSD6.md rename to doc/developer/Building_FRR_on_NetBSD6.rst index 4fe7109bcd..b4476127e3 100644 --- a/doc/Building_FRR_on_NetBSD6.md +++ b/doc/developer/Building_FRR_on_NetBSD6.rst @@ -1,50 +1,66 @@ -Building FRR on NetBSD 6 from Git Source +NetBSD 6 ======================================== NetBSD 6 restrictions: ---------------------- -- MPLS is not supported on `NetBSD`. MPLS requires a Linux Kernel - (4.5 or higher). LDP can be built, but may have limited use - without MPLS +- MPLS is not supported on ``NetBSD``. MPLS requires a Linux Kernel + (4.5 or higher). LDP can be built, but may have limited use without + MPLS Install required packages ------------------------- + Configure Package location: +:: + PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/NetBSD/`uname -m`/`uname -r`/All" export PKG_PATH Add packages: +:: + sudo pkg_add git autoconf automake libtool gmake gawk openssl \ pkg-config json-c python27 py27-test python35 Install SSL Root Certificates (for git https access): +:: + sudo pkg_add mozilla-rootcerts sudo touch /etc/openssl/openssl.cnf sudo mozilla-rootcerts install Select default Python and py.test +:: + sudo ln -s /usr/pkg/bin/python2.7 /usr/bin/python sudo ln -s /usr/pkg/bin/py.test-2.7 /usr/bin/py.test Get FRR, compile it and install it (from Git) ------------------------------------------------- +--------------------------------------------- -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -g 93 frrvty sudo useradd -g 92 -u 92 -G frrvty -c "FRR suite" \ -d /nonexistent -s /sbin/nologin frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -72,7 +88,11 @@ an example) gmake check sudo gmake install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /var/log/frr sudo mkdir /usr/pkg/etc/frr sudo touch /usr/pkg/etc/frr/zebra.conf @@ -88,23 +108,35 @@ an example) sudo chown frr:frrvty /usr/pkg/etc/frr/*.conf sudo chmod 640 /usr/pkg/etc/frr/*.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to the end of `/etc/sysctl.conf`: +Add the following lines to the end of ``/etc/sysctl.conf``: + +:: # Routing: We need to forward packets net.inet.ip.forwarding=1 net.inet6.ip6.forwarding=1 -**Reboot** or use `sysctl` to apply the same config to the running system +**Reboot** or use ``sysctl`` to apply the same config to the running +system + +Install rc.d init files +~~~~~~~~~~~~~~~~~~~~~~~ + +:: -### Install rc.d init files cp pkgsrc/*.sh /etc/rc.d/ chmod 555 /etc/rc.d/*.sh -### Enable FRR processes +Enable FRR processes +~~~~~~~~~~~~~~~~~~~~ + (Enable the required processes only) +:: + echo "zebra=YES" >> /etc/rc.conf echo "bgpd=YES" >> /etc/rc.conf echo "ospfd=YES" >> /etc/rc.conf diff --git a/doc/Building_FRR_on_NetBSD7.md b/doc/developer/Building_FRR_on_NetBSD7.rst similarity index 79% rename from doc/Building_FRR_on_NetBSD7.md rename to doc/developer/Building_FRR_on_NetBSD7.rst index 7fe9ad20c9..e4ff1df8a5 100644 --- a/doc/Building_FRR_on_NetBSD7.md +++ b/doc/developer/Building_FRR_on_NetBSD7.rst @@ -1,44 +1,57 @@ -Building FRR on NetBSD 7 from Git Source +NetBSD 7 ======================================== NetBSD 7 restrictions: ---------------------- -- MPLS is not supported on `NetBSD`. MPLS requires a Linux Kernel - (4.5 or higher). LDP can be built, but may have limited use - without MPLS +- MPLS is not supported on ``NetBSD``. MPLS requires a Linux Kernel + (4.5 or higher). LDP can be built, but may have limited use without + MPLS Install required packages ------------------------- +:: + sudo pkgin install git autoconf automake libtool gmake gawk openssl \ pkg-config json-c python27 py27-test python35 Install SSL Root Certificates (for git https access): +:: + sudo pkgin install mozilla-rootcerts sudo touch /etc/openssl/openssl.cnf sudo mozilla-rootcerts install Select default Python and py.test +:: + sudo ln -s /usr/pkg/bin/python2.7 /usr/bin/python sudo ln -s /usr/pkg/bin/py.test-2.7 /usr/bin/py.test Get FRR, compile it and install it (from Git) ------------------------------------------------- +--------------------------------------------- -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -g 93 frrvty sudo useradd -g 92 -u 92 -G frrvty -c "FRR suite" \ -d /nonexistent -s /sbin/nologin frr -### Download Source, configure and compile it +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + (You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -66,7 +79,11 @@ an example) gmake check sudo gmake install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + sudo mkdir /usr/pkg/etc/frr sudo touch /usr/pkg/etc/frr/zebra.conf sudo touch /usr/pkg/etc/frr/bgpd.conf @@ -81,23 +98,35 @@ an example) sudo chown frr:frrvty /usr/pkg/etc/frr/*.conf sudo chmod 640 /usr/pkg/etc/frr/*.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to the end of `/etc/sysctl.conf`: +Add the following lines to the end of ``/etc/sysctl.conf``: + +:: # Routing: We need to forward packets net.inet.ip.forwarding=1 net.inet6.ip6.forwarding=1 -**Reboot** or use `sysctl` to apply the same config to the running system +**Reboot** or use ``sysctl`` to apply the same config to the running +system + +Install rc.d init files +~~~~~~~~~~~~~~~~~~~~~~~ + +:: -### Install rc.d init files cp pkgsrc/*.sh /etc/rc.d/ chmod 555 /etc/rc.d/*.sh -### Enable FRR processes +Enable FRR processes +~~~~~~~~~~~~~~~~~~~~ + (Enable the required processes only) +:: + echo "zebra=YES" >> /etc/rc.conf echo "bgpd=YES" >> /etc/rc.conf echo "ospfd=YES" >> /etc/rc.conf diff --git a/doc/Building_FRR_on_OmniOS.md b/doc/developer/Building_FRR_on_OmniOS.rst similarity index 81% rename from doc/Building_FRR_on_OmniOS.md rename to doc/developer/Building_FRR_on_OmniOS.rst index 6e4575f07b..bc4ff45715 100644 --- a/doc/Building_FRR_on_OmniOS.md +++ b/doc/developer/Building_FRR_on_OmniOS.rst @@ -1,14 +1,17 @@ -Building FRR on OmniOS (OpenSolaris) from Git Source +OmniOS (OpenSolaris) ==================================================== OmniOS restrictions: -------------------- -- MPLS is not supported on `OmniOS` or `Solaris`. MPLS requires a Linux - Kernel (4.5 or higher). LDP can be built, but may have limited use - without MPLS +- MPLS is not supported on ``OmniOS`` or ``Solaris``. MPLS requires a + Linux Kernel (4.5 or higher). LDP can be built, but may have limited + use without MPLS -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: routeadm -e ipv4-forwarding routeadm -e ipv6-forwarding @@ -18,6 +21,8 @@ Install required packages Add packages: +:: + pkg install \ developer/build/autoconf \ developer/build/automake \ @@ -36,6 +41,8 @@ Add packages: Add additional Solaris packages: +:: + pkgadd -d http://get.opencsw.org/now /opt/csw/bin/pkgutil -U /opt/csw/bin/pkgutil -y -i texinfo @@ -45,33 +52,46 @@ Add additional Solaris packages: Add libjson to Solaris equivalent of ld.so.conf +:: + crle -l /opt/csw/lib -u Add pytest: +:: + pip install pytest Select Python 2.7 as default (required for pytest) +:: + rm -f /usr/bin/python ln -s /opt/csw/bin/python2.7 /usr/bin/python -Fix PATH for all users and non-interactive sessions. Edit `/etc/default/login` -and add the following default PATH: +Fix PATH for all users and non-interactive sessions. Edit +``/etc/default/login`` and add the following default PATH: + +:: PATH=/usr/gnu/bin:/usr/bin:/usr/sbin:/sbin:/opt/csw/bin -Edit `~/.profile` and add the following default PATH: +Edit ``~/.profile`` and add the following default PATH: + +:: PATH=/usr/gnu/bin:/usr/bin:/usr/sbin:/sbin:/opt/csw/bin Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr group and user +Add frr group and user +~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 93 frr sudo groupadd -g 94 frrvty @@ -81,6 +101,8 @@ any packages** (You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -111,7 +133,10 @@ an example) gmake check sudo gmake install -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: routeadm -e ipv4-forwarding - routeadm -e ipv6-forwarding + routeadm -e ipv6-forwarding diff --git a/doc/Building_FRR_on_OpenBSD6.md b/doc/developer/Building_FRR_on_OpenBSD6.rst similarity index 82% rename from doc/Building_FRR_on_OpenBSD6.md rename to doc/developer/Building_FRR_on_OpenBSD6.rst index c1bfa5005e..0e51c8660c 100644 --- a/doc/Building_FRR_on_OpenBSD6.md +++ b/doc/developer/Building_FRR_on_OpenBSD6.rst @@ -1,39 +1,52 @@ -Building FRR on OpenBSD 6 from Git Source +OpenBSD 6 ========================================= Install required packages ------------------------- -Configure PKG_PATH +Configure PKG\_PATH + +:: export PKG_PATH=http://ftp5.usa.openbsd.org/pub/OpenBSD/$(uname -r)/packages/$(machine -a)/ Add packages: +:: + pkg_add git autoconf-2.69p2 automake-1.15p0 libtool bison pkg_add gmake gawk dejagnu openssl json-c py-test Select Python2.7 as default (required for pytest) +:: + ln -s /usr/local/bin/python2.7 /usr/local/bin/python Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr group and user +Add frr group and user +~~~~~~~~~~~~~~~~~~~~~~ + +:: groupadd -g 525 _frr groupadd -g 526 _frrvty useradd -g 525 -u 525 -c "FRR suite" -G _frrvty \ -d /nonexistent -s /sbin/nologin _frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example) +:: + git clone https://github.com/frrouting/frr.git frr cd frr export AUTOCONF_VERSION="2.69" @@ -61,7 +74,10 @@ an example) gmake check doas gmake install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: doas mkdir /var/frr doas chown _frr:_frr /var/frr @@ -83,9 +99,12 @@ an example) doas chmod 750 /etc/frr doas chmod 640 /etc/frr/*.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to the end of `/etc/rc.conf`: +Add the following lines to the end of ``/etc/rc.conf``: + +:: net.inet6.ip6.forwarding=1 # 1=Permit forwarding of IPv6 packets net.inet6.ip6.mforwarding=1 # 1=Permit forwarding of IPv6 multicast packets @@ -93,37 +112,52 @@ Add the following lines to the end of `/etc/rc.conf`: **Reboot** to apply the config to the system -### Enable MPLS Forwarding +Enable MPLS Forwarding +~~~~~~~~~~~~~~~~~~~~~~ -To enable MPLS forwarding on a given interface, use the following command: +To enable MPLS forwarding on a given interface, use the following +command: + +:: doas ifconfig em0 mpls -Alternatively, to make MPLS forwarding persistent across reboots, add the "mpls" -keyword in the hostname.* files of the desired interfaces. Example: +Alternatively, to make MPLS forwarding persistent across reboots, add +the "mpls" keyword in the hostname.\* files of the desired interfaces. +Example: + +:: cat /etc/hostname.em0 inet 10.0.1.1 255.255.255.0 mpls -### Install rc.d init files -(create them in /etc/rc.d - no example are included at this time with +Install rc.d init files +~~~~~~~~~~~~~~~~~~~~~~~ + +(create them in /etc/rc.d - no example are included at this time with FRR source) -Example (for zebra - store as `/etc/rc.d/frr_zebra.sh`) +Example (for zebra - store as ``/etc/rc.d/frr_zebra.sh``) + +:: #!/bin/sh # # $OpenBSD: frr_zebra.rc,v 1.1 2013/04/18 20:29:08 sthen Exp $ - + daemon="/usr/local/sbin/zebra -d" - + . /etc/rc.d/rc.subr - + rc_cmd $1 -### Enable FRR processes +Enable FRR processes +~~~~~~~~~~~~~~~~~~~~ + (Enable the required processes only) +:: + echo "frr_zebra=YES" >> /etc/rc.conf echo "frr_bgpd=YES" >> /etc/rc.conf echo "frr_ospfd=YES" >> /etc/rc.conf diff --git a/doc/Building_FRR_on_Ubuntu1204.md b/doc/developer/Building_FRR_on_Ubuntu1204.rst similarity index 79% rename from doc/Building_FRR_on_Ubuntu1204.md rename to doc/developer/Building_FRR_on_Ubuntu1204.rst index 58aa167d57..935d199842 100644 --- a/doc/Building_FRR_on_Ubuntu1204.md +++ b/doc/developer/Building_FRR_on_Ubuntu1204.rst @@ -1,22 +1,26 @@ -Building FRR on Ubuntu 12.04LTS from Git Source +Ubuntu 12.04LTS =============================================== -- MPLS is not supported on `Ubuntu 12.04` with default kernel. MPLS requires - Linux Kernel 4.5 or higher (LDP can be built, but may have limited use - without MPLS) - For an updated Ubuntu Kernel, see http://kernel.ubuntu.com/~kernel-ppa/mainline/ +- MPLS is not supported on ``Ubuntu 12.04`` with default kernel. MPLS + requires Linux Kernel 4.5 or higher (LDP can be built, but may have + limited use without MPLS) For an updated Ubuntu Kernel, see + http://kernel.ubuntu.com/~kernel-ppa/mainline/ Install required packages ------------------------- Add packages: +:: + apt-get install git autoconf automake libtool make gawk libreadline-dev \ texinfo libpam0g-dev dejagnu libjson0-dev pkg-config libpam0g-dev \ libjson0-dev flex python-pip libc-ares-dev python3-dev -Install newer bison from 14.04 package source (Ubuntu 12.04 package source -is too old) +Install newer bison from 14.04 package source (Ubuntu 12.04 package +source is too old) + +:: mkdir builddir cd builddir @@ -35,6 +39,8 @@ is too old) Install newer version of autoconf and automake: +:: + wget http://ftp.gnu.org/gnu/autoconf/autoconf-2.69.tar.gz tar xvf autoconf-2.69.tar.gz cd autoconf-2.69 @@ -42,7 +48,7 @@ Install newer version of autoconf and automake: make sudo make install cd .. - + wget http://ftp.gnu.org/gnu/automake/automake-1.15.tar.gz tar xvf automake-1.15.tar.gz cd automake-1.15 @@ -53,15 +59,20 @@ Install newer version of autoconf and automake: Install pytest: +:: + pip install pytest Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -r -g 85 frrvty @@ -69,10 +80,14 @@ any packages** --gecos "FRR suite" --shell /sbin/nologin frr sudo usermod -a -G frrvty frr -### Download Source, configure and compile it +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + (You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -100,7 +115,10 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo install -m 755 -o frr -g frr -d /var/log/frr sudo install -m 775 -o frr -g frrvty -d /etc/frr @@ -116,11 +134,14 @@ an example.) sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and uncomment the following values (ignore the +Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the other settings) +:: + # Uncomment the next line to enable packet forwarding for IPv4 net.ipv4.ip_forward=1 @@ -129,18 +150,27 @@ other settings) # based on Router Advertisements for this host net.ipv6.conf.all.forwarding=1 -**Reboot** or use `sysctl -p` to apply the same config to the running system +**Reboot** or use ``sysctl -p`` to apply the same config to the running +system -### Install the init.d service +Install the init.d service +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo install -m 755 tools/frr /etc/init.d/frr sudo install -m 644 tools/etc/frr/daemons /etc/frr/daemons sudo install -m 644 tools/etc/frr/daemons.conf /etc/frr/daemons.conf sudo install -m 644 -o frr -g frr tools/etc/frr/vtysh.conf /etc/frr/vtysh.conf - -### Enable daemons -Edit `/etc/frr/daemons` and change the value from "no" to "yes" for those daemons you want to start by systemd. -For example. + +Enable daemons +~~~~~~~~~~~~~~ + +| Edit ``/etc/frr/daemons`` and change the value from "no" to "yes" for + those daemons you want to start by systemd. +| For example. + +:: zebra=yes bgpd=yes @@ -149,7 +179,9 @@ For example. ripd=yes ripngd=yes isisd=yes - -### Start the init.d service -- /etc/init.d/frr start -- use `/etc/init.d/frr status` to check its status. + +Start the init.d service +~~~~~~~~~~~~~~~~~~~~~~~~ + +- /etc/init.d/frr start +- use ``/etc/init.d/frr status`` to check its status. diff --git a/doc/Building_FRR_on_Ubuntu1404.md b/doc/developer/Building_FRR_on_Ubuntu1404.rst similarity index 74% rename from doc/Building_FRR_on_Ubuntu1404.md rename to doc/developer/Building_FRR_on_Ubuntu1404.rst index 8e6b38cc2d..4a4e38ea30 100644 --- a/doc/Building_FRR_on_Ubuntu1404.md +++ b/doc/developer/Building_FRR_on_Ubuntu1404.rst @@ -1,16 +1,18 @@ -Building FRR on Ubuntu 14.04LTS from Git Source +Ubuntu 14.04LTS =============================================== -- MPLS is not supported on `Ubuntu 14.04` with default kernel. MPLS requires - Linux Kernel 4.5 or higher (LDP can be built, but may have limited use - without MPLS) - For an updated Ubuntu Kernel, see http://kernel.ubuntu.com/~kernel-ppa/mainline/ +- MPLS is not supported on ``Ubuntu 14.04`` with default kernel. MPLS + requires Linux Kernel 4.5 or higher (LDP can be built, but may have + limited use without MPLS) For an updated Ubuntu Kernel, see + http://kernel.ubuntu.com/~kernel-ppa/mainline/ Install required packages ------------------------- Add packages: +:: + apt-get install git autoconf automake libtool make gawk libreadline-dev \ texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \ python-pytest libc-ares-dev python3-dev @@ -18,10 +20,13 @@ Add packages: Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -r -g 85 frrvty @@ -29,10 +34,14 @@ any packages** --gecos "FRR suite" --shell /sbin/nologin frr sudo usermod -a -G frrvty frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -61,7 +70,10 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo install -m 755 -o frr -g frr -d /var/log/frr sudo install -m 775 -o frr -g frrvty -d /etc/frr @@ -77,11 +89,14 @@ an example.) sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf -### Enable IP & IPv6 forwarding +Enable IP & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and uncomment the following values (ignore the +Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the other settings) +:: + # Uncomment the next line to enable packet forwarding for IPv4 net.ipv4.ip_forward=1 @@ -90,19 +105,24 @@ other settings) # based on Router Advertisements for this host net.ipv6.conf.all.forwarding=1 -**Reboot** or use `sysctl -p` to apply the same config to the running system -### Install the init.d service +**Reboot** or use ``sysctl -p`` to apply the same config to the running +system ### Install the init.d service + +:: sudo install -m 755 tools/frr /etc/init.d/frr sudo install -m 644 tools/etc/frr/daemons /etc/frr/daemons sudo install -m 644 tools/etc/frr/daemons.conf /etc/frr/daemons.conf sudo install -m 644 -o frr -g frr tools/etc/frr/vtysh.conf /etc/frr/vtysh.conf - - -### Enable daemons -Edit `/etc/frr/daemons` and change the value from "no" to "yes" for those daemons you want to start by systemd. -For example. +Enable daemons +~~~~~~~~~~~~~~ + +| Edit ``/etc/frr/daemons`` and change the value from "no" to "yes" for + those daemons you want to start by systemd. +| For example. + +:: zebra=yes bgpd=yes @@ -111,9 +131,9 @@ For example. ripd=yes ripngd=yes isisd=yes - -### Start the init.d service -- /etc/init.d/frr start -- use `/etc/init.d/frr status` to check its status. - - + +Start the init.d service +~~~~~~~~~~~~~~~~~~~~~~~~ + +- /etc/init.d/frr start +- use ``/etc/init.d/frr status`` to check its status. diff --git a/doc/Building_FRR_on_Ubuntu1604.md b/doc/developer/Building_FRR_on_Ubuntu1604.rst similarity index 68% rename from doc/Building_FRR_on_Ubuntu1604.md rename to doc/developer/Building_FRR_on_Ubuntu1604.rst index bdd0a96249..dccc37adcc 100644 --- a/doc/Building_FRR_on_Ubuntu1604.md +++ b/doc/developer/Building_FRR_on_Ubuntu1604.rst @@ -1,17 +1,18 @@ -Building FRR on Ubuntu 16.04LTS from Git Source +Ubuntu 16.04LTS =============================================== -- MPLS is not supported on `Ubuntu 16.04` with default kernel. MPLS requires - Linux Kernel 4.5 or higher (LDP can be built, but may have limited use - without MPLS) - For an updated Ubuntu Kernel, see - http://kernel.ubuntu.com/~kernel-ppa/mainline/ +- MPLS is not supported on ``Ubuntu 16.04`` with default kernel. MPLS + requires Linux Kernel 4.5 or higher (LDP can be built, but may have + limited use without MPLS) For an updated Ubuntu Kernel, see + http://kernel.ubuntu.com/~kernel-ppa/mainline/ Install required packages ------------------------- Add packages: +:: + apt-get install git autoconf automake libtool make gawk libreadline-dev \ texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \ python-pytest libc-ares-dev python3-dev libsystemd-dev python-ipaddr @@ -19,10 +20,13 @@ Add packages: Get FRR, compile it and install it (from Git) --------------------------------------------- -**This assumes you want to build and install FRR from source and not using -any packages** +**This assumes you want to build and install FRR from source and not +using any packages** -### Add frr groups and user +Add frr groups and user +~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo groupadd -g 92 frr sudo groupadd -r -g 85 frrvty @@ -30,10 +34,14 @@ any packages** --gecos "FRR suite" --shell /sbin/nologin frr sudo usermod -a -G frrvty frr -### Download Source, configure and compile it -(You may prefer different options on configure statement. These are just +Download Source, configure and compile it +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(You may prefer different options on configure statement. These are just an example.) +:: + git clone https://github.com/frrouting/frr.git frr cd frr ./bootstrap.sh @@ -62,7 +70,10 @@ an example.) make check sudo make install -### Create empty FRR configuration files +Create empty FRR configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: sudo install -m 755 -o frr -g frr -d /var/log/frr sudo install -m 775 -o frr -g frrvty -d /etc/frr @@ -78,11 +89,14 @@ an example.) sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf -### Enable IPv4 & IPv6 forwarding +Enable IPv4 & IPv6 forwarding +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and uncomment the following values (ignore the +Edit ``/etc/sysctl.conf`` and uncomment the following values (ignore the other settings) +:: + # Uncomment the next line to enable packet forwarding for IPv4 net.ipv4.ip_forward=1 @@ -91,10 +105,14 @@ other settings) # based on Router Advertisements for this host net.ipv6.conf.all.forwarding=1 -### Enable MPLS Forwarding (with Linux Kernel >= 4.5) +Enable MPLS Forwarding (with Linux Kernel >= 4.5) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit `/etc/sysctl.conf` and the following lines. Make sure to add a line -equal to `net.mpls.conf.eth0.input` or each interface used with MPLS +Edit ``/etc/sysctl.conf`` and the following lines. Make sure to add a +line equal to ``net.mpls.conf.eth0.input`` or each interface used with +MPLS + +:: # Enable MPLS Label processing on all interfaces net.mpls.conf.eth0.input=1 @@ -102,18 +120,24 @@ equal to `net.mpls.conf.eth0.input` or each interface used with MPLS net.mpls.conf.eth2.input=1 net.mpls.platform_labels=100000 -### Add MPLS kernel modules +Add MPLS kernel modules +~~~~~~~~~~~~~~~~~~~~~~~ -Add the following lines to `/etc/modules-load.d/modules.conf`: +Add the following lines to ``/etc/modules-load.d/modules.conf``: + +:: # Load MPLS Kernel Modules mpls-router mpls-iptunnel -**Reboot** or use `sysctl -p` to apply the same config to the running system +**Reboot** or use ``sysctl -p`` to apply the same config to the running +system +Install the systemd service (if rebooted from last step, change directory back to frr directory) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -### Install the systemd service (if rebooted from last step, change directory back to frr directory) +:: sudo install -m 644 tools/frr.service /etc/systemd/system/frr.service sudo install -m 644 tools/etc/default/frr /etc/default/frr @@ -122,10 +146,14 @@ Add the following lines to `/etc/modules-load.d/modules.conf`: sudo install -m 644 tools/etc/frr/frr.conf /etc/frr/frr.conf sudo install -m 644 -o frr -g frr tools/etc/frr/vtysh.conf /etc/frr/vtysh.conf -### Enable daemons +Enable daemons +~~~~~~~~~~~~~~ -Edit `/etc/frr/daemons` and change the value from "no" to "yes" for those daemons you want to start by systemd. -For example. +| Edit ``/etc/frr/daemons`` and change the value from "no" to "yes" for + those daemons you want to start by systemd. +| For example. + +:: zebra=yes bgpd=yes @@ -135,9 +163,13 @@ For example. ripngd=yes isisd=yes -### Enable the systemd service - - systemctl enable frr +Enable the systemd service +~~~~~~~~~~~~~~~~~~~~~~~~~~ -### Start the systemd service -- systemctl start frr -- use `systemctl status frr` to check its status. +- systemctl enable frr + +Start the systemd service +~~~~~~~~~~~~~~~~~~~~~~~~~ + +- systemctl start frr +- use ``systemctl status frr`` to check its status. diff --git a/doc/developer/building.rst b/doc/developer/building.rst new file mode 100644 index 0000000000..4715bca532 --- /dev/null +++ b/doc/developer/building.rst @@ -0,0 +1,22 @@ +Building FRR +========================= + +.. toctree:: + :maxdepth: 2 + + Building_FRR_on_LEDE-OpenWRT + Building_FRR_on_CentOS6 + Building_FRR_on_CentOS7 + Building_FRR_on_Debian8 + Building_FRR_on_Debian9 + Building_FRR_on_Fedora24 + Building_FRR_on_FreeBSD10 + Building_FRR_on_FreeBSD11 + Building_FRR_on_FreeBSD9 + Building_FRR_on_NetBSD6 + Building_FRR_on_NetBSD7 + Building_FRR_on_OmniOS + Building_FRR_on_OpenBSD6 + Building_FRR_on_Ubuntu1204 + Building_FRR_on_Ubuntu1404 + Building_FRR_on_Ubuntu1604 diff --git a/doc/developer/cli.rst b/doc/developer/cli.rst new file mode 100644 index 0000000000..7462887410 --- /dev/null +++ b/doc/developer/cli.rst @@ -0,0 +1,615 @@ +FRR Command Line Interface +========================== + +Definition Grammar +------------------ + +This is a reference for the syntax used when defining new CLI commands. +An example definition is: + +:: + + DEFUN (command_name, + command_name_cmd, + --> "example DEFINITION...", + <..doc strings..>) + +The arrowed part is the definition string. + +Explicit syntax rules in Flex and Bison may be found in +lib/command\_lex.l and lib/command\_parse.y, respectively. If you can +read BNF and regex those will be more useful than this document. + +If the parser is throwing syntax or other errors and you can't figure +out why, it's unlikely to be a bug in the parser. If the error message +is not useful, please file a bug for a better error message. If all else +fails, read the token definitions in the lexer source and the Bison BNF +in the parser source. + +Characters allowed in each token type: + +Tokens +------ + +- ``WORD`` -- A token that begins with +, -, or a lowercase letter. It + is an unchanging part of the command and will only match itself. + Example: "show ip bgp", every token is a WORD. +- ``IPV4`` -- 'A.B.C.D', matches an IPv4 address. +- ``IPV6`` -- 'X:X::X:X', matches an IPv6 address. +- ``IPV4_PREFIX`` -- 'A.B.C.D/M', matches an IPv4 prefix in CIDR + notation. +- ``IPV6_PREFIX`` -- 'X:X::X:X/M', matches an IPv6 prefix in CIDR + notation. +- ``MAC`` -- 'M:A:C', matches a 48-bit mac address +- ``MAC_PREFIX`` -- 'M:A:C/M', matches a 48-bit mac address with a mask +- ``VARIABLE`` -- Begins with a capital letter. Matches any input. +- ``RANGE`` -- Numeric range delimited by parentheses, e.g. (-100 - + 100) or (10-20). Will only match numbers in the range. + +Rules +----- + +- ```` -- Contain sequences of tokens separated by + pipes and provide mutual exclusion. Sequences may contain + ```` but not as the first token. Disallowed: + ``"example < c|d>"`` Allowed: ``"example "`` +- ``[square brackets]`` -- Contains sequences of tokens that are + optional (can be omitted). ``[]`` can be shortened to ``[a|b]``. +- ``{curly|braces}`` -- similar to angle brackets, but instead of + mutual exclusion, curly braces indicate that one or more of the + pipe-separated sequences may be provided in any order. +- ``VARIADICS...`` -- Any token which accepts input (so anything except + WORD) and that occurs as the last token of a line may be followed by + an ellipsis, which indicates that input matching the token may be + repeated an unlimited number of times. +- ``$name`` -- Specify a variable name for the preceding token. See + "Variable Names" below. + +Some general notes: + +- Options are allowed at the beginning of the command. The developer is + entreated to use these extremely sparingly. They are most useful for + implementing the 'no' form of configuration commands. Please think + carefully before using them for anything else. There is usually a + better solution, even if it is just separating out the command + definition into separate ones. + +- The developer should judiciously apply separation of concerns when + defining + +CLI. CLI definitions for two unrelated or vaguely related commands or + configuration items should be defined in separate commands. Clarity + is preferred over LOC (within reason). + +- The maximum number of space-separated tokens that can be entered is + presently limited to 256. Please keep this limit in mind when + implementing new CLI. + +Variable Names +-------------- + +The parser tries to fill the "varname" field on each token. This can +happen either manually or automatically. Manual specifications work by +appending ``"$name"`` after the input specifier: + +:: + + foo bar$cmd WORD$name A.B.C.D$ip + +Note that you can also assign variable names to fixed input tokens, this +can be useful if multiple commands share code. You can also use "$name" +after a multiple-choice option: + +:: + + foo bar $addr [optionA|optionB]$mode + +The variable name is in this case assigned to the last token in each of +the branches. + +Automatic assignment of variable names works by applying the following +rules: + +- manual names always have priority +- a "[no]" at the beginning receives "no" as varname on the "no" token +- VARIABLE tokens whose text is not "WORD" or "NAME" receive a cleaned + lowercase version of the token text as varname, e.g. "ROUTE-MAP" + becomes "route\_map". +- other variable tokens (i.e. everything except "fixed") receive the + text of the preceding fixed token as varname, if one can be found. + E.g.: "ip route A.B.C.D/M INTERFACE" assigns "route" to the + "A.B.C.D/M" token. + +These rules should make it possible to avoid manual varname assignment +in 90% of the cases. + +DEFPY +----- + +``DEFPY(...)`` is an enhanced version of ``DEFUN()`` which is +preprocessed by ``python/clidef.py``. The python script parses the +command definition string, extracts variable names and types, and +generates a C wrapper function that parses the variables and passes them +on. This means that in the CLI function body, you will receive +additional parameters with appropriate types. + +This is best explained by an example: + +:: + + DEFPY(func, func_cmd, "[no] foo bar A.B.C.D (0-99)$num", "...help...") + + => + + func(self, vty, argc, argv, /* standard CLI arguments */ + + const char *no, /* unparsed "no" */ + struct in_addr bar, /* parsed IP address */ + const char *bar_str, /* unparsed IP address */ + long num, /* parsed num */ + const char *num_str) /* unparsed num */ + +Note that as documented in the previous section, "bar" is automatically +applied as variable name for "A.B.C.D". The python code then detects +this is an IP address argument and generates code to parse it into a +``struct in_addr``, passing it in ``bar``. The raw value is passed in +``bar_str``. The range/number argument works in the same way with the +explicitly given variable name. + +Type rules +~~~~~~~~~~ + ++------------------------------+----------------------------------+----------------------------+ +| Token(s) | Type | Value if omitted by user | ++==============================+==================================+============================+ +| ``A.B.C.D`` | ``struct in_addr`` | 0.0.0.0 | ++------------------------------+----------------------------------+----------------------------+ +| ``X:X::X:X`` | ``struct in6_addr`` | :: | ++------------------------------+----------------------------------+----------------------------+ +| ``A.B.C.D + X:X::X:X`` | ``const union sockunion *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ +| ``A.B.C.D/M`` | ``const struct prefix_ipv4 *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ +| ``X:X::X:X/M`` | ``const struct prefix_ipv6 *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ +| ``A.B.C.D/M + X:X::X:X/M`` | ``const struct prefix *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ +| ``(0-9)`` | ``long`` | 0 | ++------------------------------+----------------------------------+----------------------------+ +| ``VARIABLE`` | ``const char *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ +| ``word`` | ``const char *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ +| *all other* | ``const char *`` | NULL | ++------------------------------+----------------------------------+----------------------------+ + +Note the following details: + +- not all parameters are pointers, some are passed as values. +- when the type is not ``const char *``, there will be an extra + ``_str`` argument with type ``const char *``. +- you can give a variable name not only to ``VARIABLE`` tokens but also + to ``word`` tokens (e.g. constant words). This is useful if some + parts of a command are optional. The type will be ``const char *``. +- ``[no]`` will be passed as ``const char *no``. +- pointers will be NULL when the argument is optional and the user did + not use it. +- if a parameter is not a pointer, but is optional and the user didn't + use it, the default value will be passed. Check the ``_str`` argument + if you need to determine whether the parameter was omitted. +- if the definition contains multiple parameters with the same variable + name, they will be collapsed into a single function parameter. The + python code will detect if the types are compatible (i.e. IPv4 + IPv6 + variantes) and choose a corresponding C type. +- the standard DEFUN parameters (self, vty, argc, argv) are still + present and can be used. A DEFUN can simply be **edited into a DEFPY + without further changes and it will still work**; this allows easy + forward migration. +- a file may contain both DEFUN and DEFPY statements. + +Getting a parameter dump +~~~~~~~~~~~~~~~~~~~~~~~~ + +The clidef.py script can be called to get a list of DEFUNs/DEFPYs with +the parameter name/type list: + +:: + + lib/clippy python/clidef.py --all-defun --show lib/plist.c > /dev/null + +The generated code is printed to stdout, the info dump to stderr. The +``--all-defun`` argument will make it process DEFUN blocks as well as +DEFPYs, which is useful prior to converting some DEFUNs. **The dump does +not list the ``_str`` arguments** to keep the output shorter. + +Note that the clidef.py script cannot be run with python directly, it +needs to be run with *clippy* since the latter makes the CLI parser +available. + +Include & Makefile requirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A source file that uses DEFPY needs to include the ``_clippy.c`` file +**before all DEFPY statements**: + +:: + + /* GPL header */ + #include ... + + ... + + #include "daemon/filename_clippy.c" + + DEFPY(...) + DEFPY(...) + + install_element(...) + +This dependency needs to be marked in Makefile.am: (there is no ordering +requirement) + +:: + + include ../common.am + + # ... + + # if linked into a LTLIBRARY (.la/.so): + filename.lo: filename_clippy.c + + # if linked into an executable or static library (.a): + filename.o: filename_clippy.c + +Doc Strings +----------- + +Each token in a command definition should be documented with a brief doc +string that informs a user of the meaning and/or purpose of the +subsequent command tree. These strings are provided as the last +parameter to DEFUN macros, concatenated together and separated by an +escaped newline (':raw-latex:`\n`'). These are best explained by +example. + +:: + + DEFUN (config_terminal, + config_terminal_cmd, + "configure terminal", + "Configuration from vty interface\n" + "Configuration terminal\n") + +The last parameter is split into two lines for readability. Two newline +delimited doc strings are present, one for each token in the command. +The second string documents the functionality of the 'terminal' command +in the 'configure' tree. + +Note that the first string, for 'configure' does not contain +documentation for 'terminal'. This is because the CLI is best envisioned +as a tree, with tokens defining branches. An imaginary 'start' token is +the root of every command in a CLI node. Each subsequent written token +descends into a subtree, so the documentation for that token ideally +summarizes all the functionality contained in the subtree. + +A consequence of this structure is that the developer must be careful to +use the same doc strings when defining multiple commands that are part +of the same tree. Commands which share prefixes must share the same doc +strings for those prefixes. On startup the parser will generate warnings +if it notices inconsistent doc strings. Behavior is undefined; the same +token may show up twice in completions, with different doc strings, or +it may show up once with a random doc string. Parser warnings should be +heeded and fixed to avoid confusing users. + +The number of doc strings provided must be equal to the amount of tokens +present in the command definition, read left to right, ignoring any +special constructs. + +In the examples below, each arrowed token needs a doc string. + +:: + + "show ip bgp" + ^ ^ ^ + + "command [example]" + ^ ^ ^ ^ + +Data Structures +--------------- + +On startup, the CLI parser sequentially parses each command string +definition and constructs a directed graph with each token forming a +node. This graph is the basis of the entire CLI system. It is used to +match user input in order to generate command completions and match +commands to functions. + +There is one graph per CLI node (not the same as a graph node in the CLI +graph). The CLI node struct keeps a reference to its graph (see +lib/command.h). + +While most of the graph maintains the form of a tree, special constructs +outlined in the Rules section introduce some quirks. <>, [] and {} form +self-contained 'subgraphs'. Each subgraph is a tree except that all of +the 'leaves' actually share a child node. This helps with minimizing +graph size and debugging. + +As an example, the subgraph generated by looks like this: + +:: + + . + . + | + +----+---+ + +--- -+ FORK +----+ + | +--------+ | + +--v---+ +--v---+ + | foo | | bar | + +--+---+ +--+---+ + | +------+ | + +------> JOIN <-----+ + +---+--+ + | + . + . + +FORK and JOIN nodes are plumbing nodes that don't correspond to user +input. They're necessary in order to deduplicate these constructs where +applicable. + +Options follow the same form, except that there is an edge from the FORK +node to the JOIN node. + +Keywords follow the same form, except that there is an edge from JOIN to +FORK. Because of this the CLI graph cannot be called acyclic. There is +special logic in the input matching code that keeps a stack of paths +already taken through the node in order to disallow following the same +path more than once. + +Variadics are a bit special; they have an edge back to themselves, which +allows repeating the same input indefinitely. + +The leaves of the graph are nodes that have no out edges. These nodes +are special; their data section does not contain a token, as most nodes +do, or NULL, as in FORK/JOIN nodes, but instead has a pointer to a +cmd\_element. All paths through the graph that terminate on a leaf are +guaranteed to be defined by that command. When a user enters a complete +command, the command matcher tokenizes the input and executes a DFS on +the CLI graph. If it is simultaneously able to exhaust all input (one +input token per graph node), and then find exactly one leaf connected to +the last node it reaches, then the input has matched the corresponding +command and the command is executed. If it finds more than one node, +then the command is ambiguous (more on this in deduplication). If it +cannot exhaust all input, the command is unknown. If it exhausts all +input but does not find an edge node, the command is incomplete. + +The parser uses an incremental strategy to build the CLI graph for a +node. Each command is parsed into its own graph, and then this graph is +merged into the overall graph. During this merge step, the parser makes +a best-effort attempt to remove duplicate nodes. If it finds a node in +the overall graph that is equal to a node in the corresponding position +in the command graph, it will intelligently merge the properties from +the node in the command graph into the already-existing node. Subgraphs +are also checked for isomorphism and merged where possible. The +definition of whether two nodes are 'equal' is based on the equality of +some set of token properties; read the parser source for the most +up-to-date definition of equality. + +When the parser is unable to deduplicate some complicated constructs, +this can result in two identical paths through separate parts of the +graph. If this occurs and the user enters input that matches these +paths, they will receive an 'ambiguous command' error and will be unable +to execute the command. Most of the time the parser can detect and warn +about duplicate commands, but it will not always be able to do this. +Hence care should be taken before defining a new command to ensure it is +not defined elsewhere. + +Command handlers +---------------- + +The block that follows a CLI definition is executed when a user enters +input that matches the definition. Its function signature looks like +this: + +int (*func) (const struct cmd\_element *, struct vty *, int, struct +cmd\_token *\ []); + +The first argument is the command definition struct. The last argument +is an ordered array of tokens that correspond to the path taken through +the graph, and the argument just prior to that is the length of the +array. + +The arrangement of the token array has changed from the prior +incarnation of the CLI system. In the old system, missing arguments were +padded with NULLs so that the same parts of a command would show up at +the same indices regardless of what was entered. The new system does not +perform such padding and therefore it is generally *incorrect* to assume +consistent indices in this array. As a simple example: + +Command definition: + +:: + + command [foo] + +User enters: + +:: + + command foo bar + +Array: + +:: + + [0] -> command + [1] -> foo + [2] -> bar + +User enters: + +:: + + command baz + +Array: + +:: + + [0] -> command + [1] -> baz + +Command abbreviation & matching priority +---------------------------------------- + +As in the prior implementation, it is possible for users to elide parts +of tokens when the CLI matcher does not need them to make an unambiguous +match. This is best explained by example. + +Command definitions: + +:: + + command dog cow + command dog crow + +User input: + +:: + + c d c -> ambiguous command + c d co -> match "command dog cow" + +In the new implementation, this functionality has improved. Where +previously the parser would stop at the first ambiguous token, it will +now look ahead and attempt to disambiguate based on tokens later on in +the input string. + +Command definitions: + +:: + + show ip bgp A.B.C.D + show ipv6 bgp X:X::X:X + +User enters: + +:: + + s i b 4.3.2.1 -> match "show ip bgp A.B.C.D" + s i b ::e0 -> match "show ipv6 bgp X:X::X:X" + +Previously both of these commands would be ambiguous since 'i' does not +explicitly select either 'ip' or 'ipv6'. However, since the user later +provides a token that matches only one of the commands (an IPv4 or IPv6 +address) the parser is able to look ahead and select the appropriate +command. This has some implications for parsing the argv\*[] that is +passed to the command handler. + +Now consider a command definition such as: + +:: + + command + +'foo' only matches the string 'foo', but 'VAR' matches any input, +including 'foo'. Who wins? In situations like this the matcher will +always choose the 'better' match, so 'foo' will win. + +Consider also: + +:: + + show foo + +User input: + +:: + + show ip foo + +'ip' partially matches 'ipv6' but exactly matches 'ip', so 'ip' will +win. + +struct cmd\_token +----------------- + +:: + + /* Command token struct. */ + struct cmd_token + { + enum cmd_token_type type; // token type + u_char attr; // token attributes + bool allowrepeat; // matcher allowed to match token repetitively? + + char *text; // token text + char *desc; // token description + long long min, max; // for ranges + char *arg; // user input that matches this token + char *varname; // variable name + }; + +This struct is used in the CLI graph to match input against. It is also +used to pass user input to command handler functions, as it is +frequently useful for handlers to have access to that information. When +a command is matched, the sequence of cmd\_tokens that form the matching +path are duplicated and placed in order into argv\*[]. Before this +happens the ->arg field is set to point at the snippet of user input +that matched it. + +For most nontrivial commands the handler function will need to determine +which of the possible matching inputs was entered. Previously this was +done by looking at the first few characters of input. This is now +considered an anti-pattern and should be avoided. Instead, the ->type or +->text fields for this logic. The ->type field can be used when the +possible inputs differ in type. When the possible types are the same, +use the ->text field. This field has the full text of the corresponding +token in the definition string and using it makes for much more readable +code. An example is helpful. + +Command definition: + +:: + + command <(1-10)|foo|BAR> + +In this example, the user may enter any one of: \* an integer between 1 +and 10 \* "foo" \* anything at all + +If the user enters "command f", then: + +:: + + argv[1]->type == WORD_TKN + argv[1]->arg == "f" + argv[1]->text == "foo" + +Range tokens have some special treatment; a token with ->type == +RANGE\_TKN will have the ->min and ->max fields set to the bounding +values of the range. + +Permutations +------------ + +Finally, it is sometimes useful to check all the possible combinations +of input that would match an arbitrary definition string. There is a +tool in tools/ called 'permutations' that reads CLI definition strings +on stdin and prints out all matching input permutations. It also dumps a +text representation of the graph, which is more useful for debugging +than anything else. It looks like this: + +:: + + $ ./permutations "show [ip] bgp [ WORD]" + + show ip bgp view WORD + show ip bgp vrf WORD + show ip bgp + show bgp view WORD + show bgp vrf WORD + show bgp + +This functionality is also built into VTY/VTYSH; the 'list permutations' +command will list all possible matching input permutations in the +current CLI node. diff --git a/doc/code/conf.py b/doc/developer/conf.py similarity index 98% rename from doc/code/conf.py rename to doc/developer/conf.py index 38be7f2fca..6c39c6e26d 100644 --- a/doc/code/conf.py +++ b/doc/developer/conf.py @@ -231,7 +231,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'FRR.tex', u'FRR Documentation', + (master_doc, 'FRR.tex', u'FRR Developer\'s Documentation', u'FRR', 'manual'), ] @@ -261,7 +261,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'frr', u'FRR Documentation', + (master_doc, 'frr', u'FRR Developer\'s Documentation', [author], 1) ] @@ -275,7 +275,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FRR', u'FRR Documentation', + (master_doc, 'FRR', u'FRR Developer\'s Documentation', author, 'FRR', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/developer/dev-modules.rst b/doc/developer/dev-modules.rst new file mode 100644 index 0000000000..5cf1939ff3 --- /dev/null +++ b/doc/developer/dev-modules.rst @@ -0,0 +1,125 @@ +Module and Hook support (developer docs) +======================================== + +What it does +------------ + +It uses ``dlopen()`` to load DSOs at startup. + +Limitations +----------- + +- can't load, unload, or reload during runtime. This just needs some + work and can probably be done in the future. +- doesn't fix any of the "things need to be changed in the code in the + library" issues. Most prominently, you can't add a CLI node because + CLI nodes are listed in the library... +- if your module crashes, the daemon crashes. Should be obvious. +- **does not provide a stable API or ABI**. Your module must match a + version of FRR and you may have to update it frequently to match + changes. +- **does not create a license boundary**. Your module will need to link + libzebra and include header files from the daemons, meaning it will + be GPL-encumbered. + +Installation +------------ + +Look for ``moduledir`` in ``configure.ac``, default is normally +``/usr/lib64/frr/modules`` but depends on ``--libdir`` / ``--prefix``. + +The daemon's name is prepended when looking for a module, e.g. "snmp" +tries to find "zebra\_snmp" first when used in zebra. This is just to +make it nicer for the user, with the snmp module having the same name +everywhere. + +Modules can be packaged separately from FRR. The SNMP and FPM modules +are good candidates for this because they have dependencies (net-snmp / +protobuf) that are not FRR dependencies. However, any distro packages +should have an "exact-match" dependency onto the FRR package. Using a +module from a different FRR version will probably blow up nicely. + +For snapcraft (and during development), modules can be loaded with full +path (e.g. -M ``$SNAP/lib/frr/modules/zebra_snmp.so``). Note that +libtool puts output files in the .libs directory, so during development +you have to use ``./zebra -M .libs/zebra_snmp.so``. + +Creating a module +----------------- + +... best to look at the existing SNMP or FPM modules. + +Basic boilerplate: + +:: + + #include "hook.h" + #include "module.h" + + static int + module_init (void) + { + hook_register(frr_late_init, module_late_init); + return 0; + } + + FRR_MODULE_SETUP( + .name = "my module", + .version = "0.0", + .description = "my module", + .init = module_init, + ) + +The ``frr_late_init`` hook will be called after the daemon has finished +its other startup and is about to enter the main event loop; this is the +best place for most initialisation. + +Compiler & Linker magic +----------------------- + +There's a ``THIS_MODULE`` (like in the Linux kernel), which uses +``visibility`` attributes to restrict it to the current module. If you +get a linker error with ``_frrmod_this_module``, there is some linker +SNAFU. This shouldn't be possible, though one way to get it would be to +not include libzebra (which provides a fallback definition for the +symbol). + +libzebra and the daemons each have their own ``THIS_MODULE``, as do all +loadable modules. In any other libraries (e.g. ``libfrrsnmp``), +``THIS_MODULE`` will use the definition in libzebra; same applies if the +main executable doesn't use ``FRR_DAEMON_INFO`` (e.g. all testcases). + +The deciding factor here is "what dynamic linker unit are you using the +symbol from." If you're in a library function and want to know who +called you, you can't use ``THIS_MODULE`` (because that'll just tell you +you're in the library). Put a macro around your function that adds +``THIS_MODULE`` in the *caller's code calling your function*. + +The idea is to use this in the future for module unloading. Hooks +already remember which module they were installed by, as groundwork for +a function that removes all of a module's installed hooks. + +There's also the ``frr_module`` symbol in modules, pretty much a +standard entry point for loadable modules. + +Hooks +----- + +Hooks are just points in the code where you can register your callback +to be called. The parameter list is specific to the hook point. Since +there is no stable API, the hook code has some extra type safety checks +making sure you get a compiler warning when the hook parameter list +doesn't match your callback. Don't ignore these warnings. + +Relation to MTYPE macros +------------------------ + +The MTYPE macros, while primarily designed to decouple MTYPEs from the +library and beautify the code, also work very nicely with loadable +modules -- both constructors and destructors are executed when +loading/unloading modules. + +This means there is absolutely no change required to MTYPEs, you can +just use them in a module and they will even clean up themselves when we +implement module unloading and an unload happens. In fact, it's +impossible to create a bug where unloading fails to de-register a MTYPE. diff --git a/doc/developer/git_branches.svg b/doc/developer/git_branches.svg new file mode 100644 index 0000000000..0c2c96e39e --- /dev/null +++ b/doc/developer/git_branches.svg @@ -0,0 +1,720 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + 1.0ReleaseBranch + + + + + + + + + + Master(Stable) + + + + + + + + + 1.1ReleaseBranch + Version 1.0.a1 + Version 1.1.a1 + Version 1.1.a2 + + + + + Version 1.1.b1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Patch Email (Patchwork) + Github Pull Request + Github Pull Request + Patch Email (Patchwork) + Patch Email (Patchwork) + Github Pull Request + Github Pull Request + Github Pull Request + Patch Email (Patchwork) + Github Pull Request + Github Pull Request + Github Pull Request + Github Pull Request + Github Pull Request + Github Pull Request + + + + + + + + + Version 1.0.a2 + Version 1.0.b1 + Version 1.0.0 + Version 1.1.0 + Version 1.1.1 + Version 1.1.2 + + + + + + + + + + + + + + + + + + diff --git a/doc/code/hooks.rst b/doc/developer/hooks.rst similarity index 100% rename from doc/code/hooks.rst rename to doc/developer/hooks.rst diff --git a/doc/code/index.rst b/doc/developer/index.rst similarity index 50% rename from doc/code/index.rst rename to doc/developer/index.rst index 79647d0b92..6f0dbebdfd 100644 --- a/doc/code/index.rst +++ b/doc/developer/index.rst @@ -1,18 +1,10 @@ Welcome to FRR's documentation! =============================== -Contents: - .. toctree:: :maxdepth: 2 + workflow library - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + building diff --git a/doc/ldpd-basic-test-setup.md b/doc/developer/ldpd-basic-test-setup.md similarity index 100% rename from doc/ldpd-basic-test-setup.md rename to doc/developer/ldpd-basic-test-setup.md diff --git a/doc/code/library.rst b/doc/developer/library.rst similarity index 82% rename from doc/code/library.rst rename to doc/developer/library.rst index dd46021db8..a8837b1253 100644 --- a/doc/code/library.rst +++ b/doc/developer/library.rst @@ -6,5 +6,7 @@ libfrr library facilities memtypes hooks + cli + dev-modules diff --git a/doc/code/memtypes.rst b/doc/developer/memtypes.rst similarity index 100% rename from doc/code/memtypes.rst rename to doc/developer/memtypes.rst diff --git a/doc/next-hop-tracking.txt b/doc/developer/next-hop-tracking.txt similarity index 100% rename from doc/next-hop-tracking.txt rename to doc/developer/next-hop-tracking.txt diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst new file mode 100644 index 0000000000..38cf0b878d --- /dev/null +++ b/doc/developer/workflow.rst @@ -0,0 +1,544 @@ +Developing for FRRouting +======================== + +General note on this document +----------------------------- + +This document is "descriptive/post-factual" in that it documents +pratices that are in use; it is not "definitive/pre-factual" in +prescribing practices. + +This means that when a procedure changes, it is agreed upon, then put +into practice, and then documented here. If this document doesn't match +reality, it's the document that needs to be updated, not reality. + +Git Structure +------------- + +The master Git for FRRouting resides on Github at +`https://github.com/frrouting/frr `__ + +.. figure:: git_branches.svg + :alt: git branches continually merging to the left from 3 lanes; + float-right + + git branches continually merging to the left from 3 lanes; + float-right + +There is one main branch for development and a release branch for each +major release. + +New contributions are done against the head of the master branch. The CI +systems will pick up the Github Pull Requests or the new patch from +Patchwork, run some basic build and functional tests. + +For each major release (1.0, 1.1 etc) a new release branch is created +based on the master. + +There was an attempt to use a "develop" branch automatically maintained +by the CI system. This is not currently in active use, though the system +is operational. If the "develop" branch is in active use and this +paragraph is still here, this document obviously wasn't updated. + +Programming language, Tools and Libraries +----------------------------------------- + +The core of FRRouting is written in C (gcc or clang supported) and makes +use of GNU compiler extensions. A few non-essential scripts are +implemented in Perl and Python. FRRouting requires the following tools +to build distribution packages: automake, autoconf, texinfo, libtool and +gawk and various libraries (i.e. libpam and libjson-c). + +If your contribution requires a new library or other tool, then please +highlight this in your description of the change. Also make sure it’s +supported by all FRRouting platform OSes or provide a way to build +without the library (potentially without the new feature) on the other +platforms. + +Documentation should be written in Tex (.texi) or Markdown (.md) format +with a preference for Markdown. + +Mailing lists +------------- + +Italicized lists are private. + ++----------------------------------+--------------------------------+ +| Topic | List | ++==================================+================================+ +| Development | dev@lists.frrouting.org | ++----------------------------------+--------------------------------+ +| Users & Operators | frog@lists.frrouting.org | ++----------------------------------+--------------------------------+ +| Announcements | announce@lists.frrouting.org | ++----------------------------------+--------------------------------+ +| *Security* | security@lists.frrouting.org | ++----------------------------------+--------------------------------+ +| *Technical Steering Committee* | tsc@lists.frrouting.org | ++----------------------------------+--------------------------------+ + +Changelog +~~~~~~~~~ + +The changelog will be the base for the release notes. A changelog entry +for your changes is usually not required and will be added based on your +commit messages by the maintainers. However, you are free to include an +update to the changelog with some better description. The changelog will +be the base for the release notes. + +Submitting Patches and Enhancements +----------------------------------- + +Pre-submission Checklist +~~~~~~~~~~~~~~~~~~~~~~~~ + +- Format code (see `Developer's Guidelines <#developers-guidelines>`__) +- Verify and acknowledge license (see `License for + contributions <#license-for-contributions>`__) +- Ensure you have properly signed off (see `Signing + Off <#signing-off>`__) +- Test building with various configurations: + + - ``buildtest.sh`` + +- Verify building source distribution: + + - ``make dist`` (and try rebuilding from the resulting tar file) + +- Run unit tests: + + - ``make test`` + +- Document Regression Runs and plans for continued maintenance of the + feature + +License for contributions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +FRRouting is under a “GPLv2 or later” license. Any code submitted must +be released under the same license (preferred) or any license which +allows redistribution under this GPLv2 license (eg MIT License). + +Signing Off +~~~~~~~~~~~ + +Code submitted to FRRouting must be signed off. We have the same +requirements for using the signed-off-by process as the Linux kernel. In +short, you must include a signed-off-by tag in every patch. + +``Signed-off-by:`` this is a developer's certification that he or she +has the right to submit the patch for inclusion into the project. It is +an agreement to the Developer's Certificate of Origin (below). Code +without a proper signoff can not and will not be merged. + +If you are unfamiliar with this process, you should read the `official +policy at +kernel.org `__ +and you might find this article about `participating in the Linux +community on the Linux Foundation +website `__ +to be a helpful resource. + +In short, when you sign off on a commit, you assert your agreement to +all of the following: + + Developer's Certificate of Origin 1.1 + + By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part by + me, under the same open source license (unless I am permitted to + submit under a different license), as indicated in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + +What do I submit my changes against? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We've documented where we would like to have the different fixes applied +at +https://github.com/FRRouting/frr/wiki/Where-Do-I-create-a-Pull-Request-against%3F +If you are unsure where your submission goes, look at that document or +ask a project maintainer. + +Github pull requests +~~~~~~~~~~~~~~~~~~~~ + +The preferred method of submitting changes is a Github pull request. +Code submitted by pull request will be automatically tested by one or +more CI systems. Once the automated tests succeed, other developers will +review your code for quality and correctness. After any concerns are +resolved, your code will be merged into the branch it was submitted +against. + +Patch submission via mailing list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As an alternative submission method, a patch can be mailed to the +development mailing list. Patches received on the mailing list will be +picked up by Patchwork and tested against the latest development branch. + +The recommended way to send the patch (or series of NN patches) to the +list is by using ``git send-email`` as follows (assuming they are the N +most recent commit(s) in your git history: + +:: + + git send-email -NN --annotate --to=dev@lists.frrouting.org + +If your commits do not already contain a ``Signed-off-by`` line, then +use the following command to add it (after making sure you agree to the +Developer Certificate of Origin as outlined above): + +:: + + git send-email -NN --annotate --signoff --to=dev@lists.frrouting.org + +Submitting multi-commit patches as a Github pull request is **strongly +encouraged** and increases the probability of your patch getting +reviewed and merged in a timely manner. + +After submitting your changes +----------------------------- + +- Watch for Continuous Integration (CI) Test results + + - You should automatically receive an email with the test results + within less than 2 hrs of the submission. If you don’t get the + email, then check status on the github pull request (if submitted + by pull request) or on Patchwork at + https://patchwork.frrouting.org (if submitted as patch to mailing + list). + - Please notify the development mailing list if you think something + doesn’t work. + +- If the tests failed: + + - In general, expect the community to ignore the submission until + the tests pass. + - It is up to you to fix and resubmit. + + - This includes fixing existing unit (“make test”) tests if your + changes broke or changed them. + - It also includes fixing distribution packages for the failing + platforms (ie if new libraries are required). + - Feel free to ask for help on the development list. + + - Go back to the submission process and repeat until the tests pass. + +- If the tests pass: + + - Wait for reviewers. Someone will review your code or be assigned + to review your code. + - Respond to any comments or concerns the reviewer has. + - After all comments and concerns are addressed, expect your patch + to be merged. + +- Watch out for questions on the mailing list. At this time there will + be a manual code review and further (longer) tests by various + community members. +- Your submission is done once it is merged to the master branch. + +Developer's Guidelines +---------------------- + +Commit messages +~~~~~~~~~~~~~~~ + +Commit messages should be formatted in the same way as Linux kernel +commit messages. The format is roughly + +:: + + dir: short summary + + extended summary + +``dir`` should be the top level source directory under which the change +was made. For example, a change in bgpd/rfapi would be formatted as: + +``bgpd: short summary`` + +The first line should be no longer than 50 characters. Subsequent lines +should be wrapped to 72 characters. + +Source file header +~~~~~~~~~~~~~~~~~~ + +New files need to have a Copyright header (see `License for +contributions <#license-for-contributions>`__ above) added to the file. +Preferred form of the header is as follows: + +:: + + /* + * Title/Function of file + * Copyright (C) YEAR Author’s Name + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the Free + * Software Foundation; either version 2 of the License, or (at your option) + * any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; see the file COPYING; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + + #include + +Adding copyright claims to existing files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When adding copyright claims for modifications to an existing file, +please preface the claim with "Portions: " on a line before it and +indent the "Copyright ..." string. If such a case already exists, add +your indented claim immediately after. E.g.: + +:: + + Portions: + Copyright (C) 2010 Entity A .... + Copyright (C) 2016 Your name [optional brief change description] + +Code formatting +~~~~~~~~~~~~~~~ + +FRR uses Linux kernel style except where noted below. Code which does +not comply with these style guidelines will not be accepted. + +To assist with compliance, in the project root there is a .clang-format +configuration file which can be used with the ``clang-format`` tool from +the LLVM project. In the ``tools/`` directory there is a Python script +named ``indent.py`` that wraps clang-format and handles some edge cases +specific to FRR. If you are submitting a new file, it is recommended to +run that script over the new file after ensuring that the latest stable +release of ``clang-format`` is in your PATH. + +**Whitespace changes in untouched parts of the code are not acceptable +in patches that change actual code.** To change/fix formatting issues, +please create a separate patch that only does formatting changes and +nothing else. + +Style documentation +^^^^^^^^^^^^^^^^^^^ + +Kernel and BSD styles are documented externally: + +- https://www.kernel.org/doc/html/latest/process/coding-style.html +- http://man.openbsd.org/style + +For GNU coding style, use ``indent`` with the following invocation: + +:: + + indent -nut -nfc1 file_for_submission.c + +Exceptions +^^^^^^^^^^ + +FRR project code comes from a variety of sources, so there are some +stylistic exceptions in place. They are organized here by branch. + +**For ``master``:** + +BSD coding style applies to: + +- ``ldpd/`` + +``babeld`` uses, approximately, the following style: + +- K&R style braces +- Indents are 4 spaces +- Function return types are on their own line + +**For ``stable/3.0`` and ``stable/2.0``:** + +GNU coding style apply to the following parts: + +- ``lib/`` +- ``zebra/`` +- ``bgpd/`` +- ``ospfd/`` +- ``ospf6d/`` +- ``isisd/`` +- ``ripd/`` +- ``ripngd/`` +- ``vtysh/`` + +BSD coding style applies to: + +- ``ldpd/`` + +Documentation +~~~~~~~~~~~~~ + +FRRouting is a large and complex software project developed by many +different people over a long period of time. Without adequate +documentation, it can be exceedingly difficult to understand code +segments, APIs and other interfaces. In the interest of keeping the +project healthy and maintainable, you should make every effort to +document your code so that other people can understand what it does +without needing to closely read the code itself. + +Some specific guidelines that contributors should follow are: + +- Functions exposed in header files should have descriptive comments + above their signatures in the header file. At a minimum, a function + comment should contain information about the return value, + parameters, and a general summary of the function's purpose. + Documentation on parameter values can be omitted if it is (very) + obvious what they are used for. + +Function comments must follow the style for multiline comments laid out +in the kernel style guide. + +Example: + +:: + + /* + * Determines whether or not a string is cool. + * + * @param text - the string to check for coolness + * @param is_clccfc - whether capslock is cruise control for cool + * @return 7 if the text is cool, 0 otherwise + */ + int check_coolness(const char *text, bool is_clccfc); + +The Javadoc-style annotations are not required, but you should still +strive to make it equally clear what parameters and return values are +used for. + +- Static functions should have descriptive comments in the same form as + above if what they do is not immediately obvious. Use good + engineering judgement when deciding whether a comment is necessary. + If you are unsure, document your code. + +- Global variables, static or not, should have a comment describing + their use. + +- **For new code in ``lib/``, these guidelines are hard requirements.** + +If you are contributing code that adds significant user-visible +functionality or introduces a new API, please document it in ``doc/``. +Markdown and LaTeX are acceptable formats, although Markdown is +currently preferred for new documentation. This may change in the near +future. + +Finally, if you come across some code that is undocumented and feel like +going above and beyond, document it! We absolutely appreciate and accept +patches that document previously undocumented code. + +Compile-time conditional code +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Many users access FRR via binary packages from 3rd party sources; +compile-time code puts inclusion/exclusion in the hands of the package +maintainer. Please think very carefully before making code conditional +at compile time, as it increases regression testing, maintenance +burdens, and user confusion. In particular, please avoid gratuitous +``--enable-…`` switches to the configure script - in general, code +should be of high quality and in working condition, or it shouldn’t be +in FRR at all. + +When code must be compile-time conditional, try have the compiler make +it conditional rather than the C pre-processor so that it will still be +checked by the compiler, even if disabled. For example, + +:: + + if (SOME_SYMBOL) + frobnicate(); + +is preferred to + +:: + + #ifdef SOME_SYMBOL + frobnicate (); + #endif /* SOME_SYMBOL */ + +Note that the former approach requires ensuring that ``SOME_SYMBOL`` +will be defined (watch your ``AC_DEFINE``\ s). + +Debug-guards in code +~~~~~~~~~~~~~~~~~~~~ + +Debugging statements are an important methodology to allow developers to +fix issues found in the code after it has been released. The caveat here +is that the developer must remember that people will be using the code +at scale and in ways that can be unexpected for the original +implementor. As such debugs **MUST** be guarded in such a way that they +can be turned off. FRR has the ability to turn on/off debugs from the +CLI and it is expected that the developer will use this convention to +allow control of their debugs. + +CLI changes +~~~~~~~~~~~ + +CLI's are a complicated ugly beast. Additions or changes to the CLI +should use a DEFUN to encapsulate one setting as much as is possible. +Additionally as new DEFUN's are added to the system, documentation +should be provided for the new commands. + +Backwards Compatibility +~~~~~~~~~~~~~~~~~~~~~~~ + +As a general principle, changes to CLI and code in the lib/ directory +should be made in a backwards compatible fashion. This means that +changes that are purely stylistic in nature should be avoided, e.g., +renaming an existing macro or library function name without any +functional change. When adding new parameters to common functions, it is +also good to consider if this too should be done in a backward +compatible fashion, e.g., by preserving the old form in addition to +adding the new form. + +This is not to say that minor or even major functional changes to CLI +and common code should be avoided, but rather that the benefit gained +from a change should be weighed against the added cost/complexity to +existing code. Also, that when making such changes, it is good to +preserve compatibility when possible to do so without introducing +maintenance overhead/cost. It is also important to keep in mind, +existing code includes code that may reside in private repositories (and +is yet to be submitted) or code that has yet to be migrated from Quagga +to FRR. + +That said, compatibility measures can (and should) be removed when +either: + +- they become a significant burden, e.g. when data structures change + and the compatibility measure would need a complex adaptation layer + or becomes flat-out impossible +- some measure of time (dependent on the specific case) has passed, so + that the compatibility grace period is considered expired. + +In all cases, compatibility pieces should be marked with +compiler/preprocessor annotations to print warnings at compile time, +pointing to the appropriate update path. A ``-Werror`` build should fail +if compatibility bits are used. + +Miscellaneous +~~~~~~~~~~~~~ + +When in doubt, follow the guidelines in the Linux kernel style guide, or +ask on the development mailing list / public Slack instance. From a42f781889f85122b7529b330742308a528bf30f Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 8 Dec 2017 16:37:48 -0500 Subject: [PATCH 002/148] doc: clean up CLI docs Update, embellish, clarify. Signed-off-by: Quentin Young --- doc/developer/cli.rst | 275 ++++++++++++++++++++++++++---------------- 1 file changed, 172 insertions(+), 103 deletions(-) diff --git a/doc/developer/cli.rst b/doc/developer/cli.rst index 7462887410..2ecb70e932 100644 --- a/doc/developer/cli.rst +++ b/doc/developer/cli.rst @@ -1,67 +1,141 @@ -FRR Command Line Interface -========================== +Command Line Interface +====================== + +FRR features a flexible modal command line interface. Often when adding new +features or modifying existing code it is necessary to create or modify CLI +commands. FRR has a powerful internal CLI system that does most of the heavy +lifting for you. + +All definitions for the CLI system are exposed in ``lib/command.h``. In this +header there are a set of macros used to define commands. These macros are +collectively referred to as "DEFUNs", because of their syntax: + +:: + + DEFUN(command_name, + command_name_cmd, + "example command FOO...", + "Examples\n" + "CLI command\n" + "Argument\n") + { + // ...command handler... + } + +DEFUNs generally take four arguments which are expanded into the appropriate +constructs for hooking into the CLI. In order these are: + +- **Function name** - the name of the handler function for the command +- **Command name** - the identifier of the ``struct cmd_element`` for the + command. By convention this should be the function name with ``_cmd`` + appended. +- **Command definition** - an expression in FRR's CLI grammar that defines the + form of the command and its arguments, if any +- **Doc string** - a newline-delimited string that documents each element in + the command definition + +In the above example, ``command_name`` is the function name, +``command_name_cmd`` is the command name, ``"example..."`` is the definition +and the last argument is the doc string. The block following the macro is the +body of the handler function, details on which are presented later in this +section. + +In order to make the command show up to the user it must be installed into the +CLI graph. To do this, call: + +``install_element(NODE, &command_name_cmd);`` + +This will install the command into the specified CLI node. Usually these calls +are grouped together in a CLI initialization function for a set of commands, +and the DEFUNs themselves are grouped into the same source file to avoid +cluttering the codebase. The names of these files follow the form +``*_vty.[ch]`` by convention. Please do not scatter individual CLI commands in +the middle of source files; instead expose the necessary functions in a header +and place the command definition in a ``*_vty.[ch]`` file. Definition Grammar ------------------ -This is a reference for the syntax used when defining new CLI commands. -An example definition is: +FRR uses its own grammar for defining CLI commands. The grammar draws from +syntax commonly seen in \*nix manpages and should be fairly intuitive. The +parser is implemented in Bison and the lexer in Flex. These may be found in +``lib/command_lex.l`` and ``lib/command_parse.y``, respectively. + + **ProTip**: if you define a new command and find that the parser is + throwing syntax or other errors, the parser is the last place you want + to look. Bison is very stable and if it detects a syntax error, 99% of + the time it will be a syntax error in your definition. + +Tokens +~~~~~~ + +Each element in a command definition is assigned a type by the parser based on a set of regular expression rules. + ++-----------------+-----------------+-------------------------------------------------------------+ +| Token type | Syntax | Description | ++=================+=================+=============================================================+ +| ``WORD`` | ``show ip bgp`` | Matches itself. In the given example every token is a WORD. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``IPV4`` | ``A.B.C.D`` | Matches an IPv4 address. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``IPV6`` | ``X:X::X:X`` | Matches an IPv6 address. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``IPV4_PREFIX`` | ``A.B.C.D/M`` | Matches an IPv4 prefix in CIDR notation. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``IPV6_PREFIX`` | ``X:X::X:X/M`` | Matches an IPv6 prefix in CIDR notation. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``MAC`` | ``M:A:C`` | Matches a 48-bit mac address. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``MAC_PREFIX`` | ``M:A:C/M`` | Matches a 48-bit mac address with a mask. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``VARIABLE`` | ``FOOBAR`` | Matches anything. | ++-----------------+-----------------+-------------------------------------------------------------+ +| ``RANGE`` | ``(X-Y)`` | Matches numbers in the range X..Y inclusive. | ++-----------------+-----------------+-------------------------------------------------------------+ + +When presented with user input, the parser will search over all defined +commands in the current context to find a match. It is aware of the various +types of user input and has a ranking system to help disambiguate commands. For +instance, suppose the following commands are defined in the user's current +context: :: - DEFUN (command_name, - command_name_cmd, - --> "example DEFINITION...", - <..doc strings..>) + example command FOO + example command (22-49) + example command A.B.C.D/X -The arrowed part is the definition string. +The following table demonstrates the matcher's choice for a selection of +possible user input. -Explicit syntax rules in Flex and Bison may be found in -lib/command\_lex.l and lib/command\_parse.y, respectively. If you can -read BNF and regex those will be more useful than this document. - -If the parser is throwing syntax or other errors and you can't figure -out why, it's unlikely to be a bug in the parser. If the error message -is not useful, please file a bug for a better error message. If all else -fails, read the token definitions in the lexer source and the Bison BNF -in the parser source. - -Characters allowed in each token type: - -Tokens ------- - -- ``WORD`` -- A token that begins with +, -, or a lowercase letter. It - is an unchanging part of the command and will only match itself. - Example: "show ip bgp", every token is a WORD. -- ``IPV4`` -- 'A.B.C.D', matches an IPv4 address. -- ``IPV6`` -- 'X:X::X:X', matches an IPv6 address. -- ``IPV4_PREFIX`` -- 'A.B.C.D/M', matches an IPv4 prefix in CIDR - notation. -- ``IPV6_PREFIX`` -- 'X:X::X:X/M', matches an IPv6 prefix in CIDR - notation. -- ``MAC`` -- 'M:A:C', matches a 48-bit mac address -- ``MAC_PREFIX`` -- 'M:A:C/M', matches a 48-bit mac address with a mask -- ``VARIABLE`` -- Begins with a capital letter. Matches any input. -- ``RANGE`` -- Numeric range delimited by parentheses, e.g. (-100 - - 100) or (10-20). Will only match numbers in the range. ++-----------------------------+---------------------------+--------------------------------------------------------------------------------------------------------------+ +| Input | Matched command | Reason | ++=============================+===========================+==============================================================================================================+ +| example command eLi7eH4xx0r | example command FOO | ``eLi7eH4xx0r`` is not an integer or IPv4 prefix, | +| | | but FOO is a variable and matches all input. | ++-----------------------------+---------------------------+--------------------------------------------------------------------------------------------------------------+ +| example command 42 | example command (22-49) | ``42`` is not an IPv4 prefix. It does match both | +| | | ``(22-49)`` and ``FOO``, but RANGE tokens are more specific and have a higher priority than VARIABLE tokens. | ++-----------------------------+---------------------------+--------------------------------------------------------------------------------------------------------------+ +| example command 10.3.3.0/24 | example command A.B.C.D/X | The user entered an IPv4 prefix, which is best matched by the last command. | ++-----------------------------+---------------------------+--------------------------------------------------------------------------------------------------------------+ Rules ------ +~~~~~ -- ```` -- Contain sequences of tokens separated by - pipes and provide mutual exclusion. Sequences may contain - ```` but not as the first token. Disallowed: - ``"example < c|d>"`` Allowed: ``"example "`` -- ``[square brackets]`` -- Contains sequences of tokens that are - optional (can be omitted). ``[]`` can be shortened to ``[a|b]``. -- ``{curly|braces}`` -- similar to angle brackets, but instead of - mutual exclusion, curly braces indicate that one or more of the - pipe-separated sequences may be provided in any order. -- ``VARIADICS...`` -- Any token which accepts input (so anything except - WORD) and that occurs as the last token of a line may be followed by - an ellipsis, which indicates that input matching the token may be - repeated an unlimited number of times. +There are also constructs which allow optional tokens, mutual exclusion, one-or-more selection and repetition. + +- ```` -- Contain sequences of tokens separated by pipes and + provide mutual exclusion. User input matches at most one option. +- ``[square brackets]`` -- Contains sequences of tokens that can be omitted. + ``[]`` can be shortened to ``[a|b]``. +- ``{curly|braces}`` -- similar to angle brackets, but instead of mutual + exclusion, curly braces indicate that one or more of the pipe-separated + sequences may be provided in any order. +- ``VARIADICS...`` -- Any token which accepts input (anything except WORD) + which occurs as the last token of a line may be followed by an ellipsis, + which indicates that input matching the token may be repeated an unlimited + number of times. - ``$name`` -- Specify a variable name for the preceding token. See "Variable Names" below. @@ -69,18 +143,13 @@ Some general notes: - Options are allowed at the beginning of the command. The developer is entreated to use these extremely sparingly. They are most useful for - implementing the 'no' form of configuration commands. Please think - carefully before using them for anything else. There is usually a - better solution, even if it is just separating out the command - definition into separate ones. - -- The developer should judiciously apply separation of concerns when - defining - -CLI. CLI definitions for two unrelated or vaguely related commands or - configuration items should be defined in separate commands. Clarity - is preferred over LOC (within reason). - + implementing the 'no' form of configuration commands. Please think carefully + before using them for anything else. There is usually a better solution, even + if it is just separating out the command definition into separate ones. +- The developer should judiciously apply separation of concerns when defining + commands. CLI definitions for two unrelated or vaguely related commands or + configuration items should be defined in separate commands. Clarity is + preferred over LOC (within reason). - The maximum number of space-separated tokens that can be entered is presently limited to 256. Please keep this limit in mind when implementing new CLI. @@ -159,53 +228,53 @@ explicitly given variable name. Type rules ~~~~~~~~~~ -+------------------------------+----------------------------------+----------------------------+ -| Token(s) | Type | Value if omitted by user | -+==============================+==================================+============================+ -| ``A.B.C.D`` | ``struct in_addr`` | 0.0.0.0 | -+------------------------------+----------------------------------+----------------------------+ -| ``X:X::X:X`` | ``struct in6_addr`` | :: | -+------------------------------+----------------------------------+----------------------------+ -| ``A.B.C.D + X:X::X:X`` | ``const union sockunion *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ -| ``A.B.C.D/M`` | ``const struct prefix_ipv4 *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ -| ``X:X::X:X/M`` | ``const struct prefix_ipv6 *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ -| ``A.B.C.D/M + X:X::X:X/M`` | ``const struct prefix *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ -| ``(0-9)`` | ``long`` | 0 | -+------------------------------+----------------------------------+----------------------------+ -| ``VARIABLE`` | ``const char *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ -| ``word`` | ``const char *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ -| *all other* | ``const char *`` | NULL | -+------------------------------+----------------------------------+----------------------------+ ++-----------------------------+--------------------------------+--------------------------+ +| Token(s) | Type | Value if omitted by user | ++=============================+================================+==========================+ +| ``A.B.C.D`` | ``struct in_addr`` | 0.0.0.0 | ++-----------------------------+--------------------------------+--------------------------+ +| ``X:X::X:X`` | ``struct in6_addr`` | \:: | ++-----------------------------+--------------------------------+--------------------------+ +| ``A.B.C.D + X:X::X:X`` | ``const union sockunion *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ +| ``A.B.C.D/M`` | ``const struct prefix_ipv4 *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ +| ``X:X::X:X/M`` | ``const struct prefix_ipv6 *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ +| ``A.B.C.D/M + X:X::X:X/M`` | ``const struct prefix *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ +| ``(0-9)`` | ``long`` | 0 | ++-----------------------------+--------------------------------+--------------------------+ +| ``VARIABLE`` | ``const char *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ +| ``word`` | ``const char *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ +| *all other* | ``const char *`` | NULL | ++-----------------------------+--------------------------------+--------------------------+ Note the following details: -- not all parameters are pointers, some are passed as values. -- when the type is not ``const char *``, there will be an extra +- Not all parameters are pointers, some are passed as values. +- When the type is not ``const char *``, there will be an extra ``_str`` argument with type ``const char *``. -- you can give a variable name not only to ``VARIABLE`` tokens but also +- You can give a variable name not only to ``VARIABLE`` tokens but also to ``word`` tokens (e.g. constant words). This is useful if some parts of a command are optional. The type will be ``const char *``. - ``[no]`` will be passed as ``const char *no``. -- pointers will be NULL when the argument is optional and the user did +- Pointers will be NULL when the argument is optional and the user did not use it. -- if a parameter is not a pointer, but is optional and the user didn't +- If a parameter is not a pointer, but is optional and the user didn't use it, the default value will be passed. Check the ``_str`` argument if you need to determine whether the parameter was omitted. -- if the definition contains multiple parameters with the same variable +- If the definition contains multiple parameters with the same variable name, they will be collapsed into a single function parameter. The python code will detect if the types are compatible (i.e. IPv4 + IPv6 variantes) and choose a corresponding C type. -- the standard DEFUN parameters (self, vty, argc, argv) are still +- The standard DEFUN parameters (self, vty, argc, argv) are still present and can be used. A DEFUN can simply be **edited into a DEFPY without further changes and it will still work**; this allows easy forward migration. -- a file may contain both DEFUN and DEFPY statements. +- A file may contain both DEFUN and DEFPY statements. Getting a parameter dump ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -264,12 +333,11 @@ requirement) Doc Strings ----------- -Each token in a command definition should be documented with a brief doc -string that informs a user of the meaning and/or purpose of the -subsequent command tree. These strings are provided as the last -parameter to DEFUN macros, concatenated together and separated by an -escaped newline (':raw-latex:`\n`'). These are best explained by -example. +Each token in a command definition should be documented with a brief doc string +that informs a user of the meaning and/or purpose of the subsequent command +tree. These strings are provided as the last parameter to DEFUN macros, +concatenated together and separated by an escaped newline (\n). These are best +explained by example. :: @@ -411,8 +479,9 @@ The block that follows a CLI definition is executed when a user enters input that matches the definition. Its function signature looks like this: -int (*func) (const struct cmd\_element *, struct vty *, int, struct -cmd\_token *\ []); +:: + + int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]); The first argument is the command definition struct. The last argument is an ordered array of tokens that correspond to the path taken through From b30de70968346c7872e7bb67ebe757e72d733932 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 8 Dec 2017 16:39:06 -0500 Subject: [PATCH 003/148] doc: change section title for modules docs Signed-off-by: Quentin Young --- doc/developer/library.rst | 2 +- doc/developer/{dev-modules.rst => modules.rst} | 10 ++++------ 2 files changed, 5 insertions(+), 7 deletions(-) rename doc/developer/{dev-modules.rst => modules.rst} (96%) diff --git a/doc/developer/library.rst b/doc/developer/library.rst index a8837b1253..791aedb624 100644 --- a/doc/developer/library.rst +++ b/doc/developer/library.rst @@ -7,6 +7,6 @@ libfrr library facilities memtypes hooks cli - dev-modules + modules diff --git a/doc/developer/dev-modules.rst b/doc/developer/modules.rst similarity index 96% rename from doc/developer/dev-modules.rst rename to doc/developer/modules.rst index 5cf1939ff3..b832413a6c 100644 --- a/doc/developer/dev-modules.rst +++ b/doc/developer/modules.rst @@ -1,10 +1,8 @@ -Module and Hook support (developer docs) -======================================== +Modules +======= -What it does ------------- - -It uses ``dlopen()`` to load DSOs at startup. +FRR has facilities to load DSOs at startup via ``dlopen()``. These are used to +implement modules, such as SNMP and FPM. Limitations ----------- From b22ba015ef8c42e584876d9ac73df8e2b71b6eaf Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 8 Dec 2017 18:22:26 -0500 Subject: [PATCH 004/148] doc: more organizing & updating * Add chapter on BGPD * Add diagram for git workflow * Convert next-hop tracking documents to ReST * Update & organize workflow document * Move ldpd docs back up to the parent directory Signed-off-by: Quentin Young --- doc/developer/bgpd.rst | 8 + doc/developer/conf.py | 6 +- doc/developer/git_branches.png | Bin 0 -> 53216 bytes doc/developer/index.rst | 1 + doc/developer/next-hop-tracking.rst | 352 +++++++++++++++++++ doc/developer/next-hop-tracking.txt | 326 ----------------- doc/developer/workflow.rst | 128 ++++--- doc/{developer => }/ldpd-basic-test-setup.md | 0 8 files changed, 427 insertions(+), 394 deletions(-) create mode 100644 doc/developer/bgpd.rst create mode 100644 doc/developer/git_branches.png create mode 100644 doc/developer/next-hop-tracking.rst delete mode 100644 doc/developer/next-hop-tracking.txt rename doc/{developer => }/ldpd-basic-test-setup.md (100%) diff --git a/doc/developer/bgpd.rst b/doc/developer/bgpd.rst new file mode 100644 index 0000000000..053c0779de --- /dev/null +++ b/doc/developer/bgpd.rst @@ -0,0 +1,8 @@ +BGPD +========================= + +.. toctree:: + :maxdepth: 2 + + next-hop-tracking + diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 6c39c6e26d..233056666d 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -231,7 +231,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'FRR.tex', u'FRR Developer\'s Documentation', + (master_doc, 'FRR.tex', u'FRR Developer\'s Manual', u'FRR', 'manual'), ] @@ -261,7 +261,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'frr', u'FRR Developer\'s Documentation', + (master_doc, 'frr', u'FRR Developer\'s Manual', [author], 1) ] @@ -275,7 +275,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FRR', u'FRR Developer\'s Documentation', + (master_doc, 'FRR', u'FRR Developer\'s Manual', author, 'FRR', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/developer/git_branches.png b/doc/developer/git_branches.png new file mode 100644 index 0000000000000000000000000000000000000000..21001c30a114a1af04727c5fc3ddb20a3187039b GIT binary patch literal 53216 zcmd42XH-*B*EO1i7JBa;q*q0X^p1dZgh(#}DgvQ{v_wO1f)Ff76;LUL9zY<54oa8a zf>NXxA#}d@yw5wnG48lO?$65z15VD|>zwTDefFAj&7Ej&YCuiFK>+{&s15JxS^@w- zM*skn3??PKbDzwfjqry!P}|TNO!$ceKTIGTlSA)52m}CVI{*Cwvn6Oa32(9o=|O_5 z{5*p~T?0G-p`oGDkA1xZ-Cdy`(tZJ6?{-u<002IKp{|y7Snk&Q(8&9GXYu)=+TjeJSO}#MHCjQFeiMK!%(x#wf6`53@PdfHm5+5RC*Of_k5=tEYCXfT-BvE*}PvJ}gF6dZ}^ zPuTp#=Bsl8a0SLiz;4G>a>j|!vj}_#>7N|hE>--_!zji0@=}e_vAFe;DxVy7(0dYz z2z;g4a#s6co%Oq*sN9+w7nM6zN<;(?#x!3h#>svY+RcdI)c@AnIy~jzmnY6 z2_scv=p_La^zQCH-{V2`YTv1)YyF;h#k_+YcLp$Fe_=AZ zs^Uj4K(LbJUDgpUV|y1PT@Fscd_vD#2W5X|+~XPM?ImL|a5U*^VlnO5V;fw10t-TX z`Kr-K2K0`6P#)E$T_7=>4`bJaL1|^FT-CAS1tv!d_bix7cIbBG_f!fvu}`UJfiCDV zXJax`eaMSF#ywW5A-C5E#sxWgq`+^%rI?E2Y39*)C1m=bk+I zv8Q?#O#kn%PeUKZLrAhn;Q(&`+7zG4m1fbTqT8ZWSkTh5m`EUYs4H+C`Mrd0m1+46 z>m)QeU&r+eo9*oR9ZsIAf~;gZ&TQVNQ|n z^RO3m>PIVYz%>18%NiNEBs!73U&begI^-bO@6%!OZI5fOQ8u%8iTU<8ukH=57OA(c%ImHC&Y_ zjKKrp7&){U56Q{xPg1r_dY?#$ao+7key_EnP3oNK1L)OB2h-5ef>@h&=^5!ZFKrqu zCC2%}0eubVI8JQ`gJb#SW45Q>9vY&Am+`)?=j?jH$%z73ZYB{Im zeVaue*%2PU`;sAOp{eH3XSM6T)5m$s!&u zQl$P!m=HJKi~{S{O^BW(6^R-ODZ^M={|EB8lcL~1|CQK@O2A5i@`T&^U=;%RFS7Ik z@RoG^-!+W%fVclAQfe6J(SNRGNU={ke7k_q3ziC1FyeY1ME`C4x}WTS8fWs|r~IGBLj0dO{@Zx&hTy-(CBV@S4H5;n@7|(Q0E~sA z-5yhNS(z?SgZ;X`y8Zl8E}E1nN+gbYq*1X=A#N1x_N0ZdIEki`Gduq4UR^y~!o(r9 z7`adA7%l4{!Wa02?*I3vUJBO}*5gk-TyUJKBsYCD-;&spT8xhfRm_bg8H?~+vKQ}R z-i*z!aK0d4K!f$m16?W|!8AqsJ(fLBlG9PyIU~${485kUi>38j1vcMw<;FZ%4lG?l z)Or77Nx5kDFMY%s7!tR_4{FnX4NN(hq#o|y#dpa5+-<}hoFjHUn*fh^4El+xw~R3Y z?JIn$L@8B#&f-YQ%V=k+_@2A3;)HZD%gYCa_SZb!PKjNWk!3Jy;yK_4fLirmVr5{gdQ@P628#QH4yEax3-Q}~T$FAVnaAYf zult~c9_ijEt={mPFE`oa`IinEO?W$px+!8`6L4jwLyNEihb=mr;g7xpS@c%s$$E)d zKq^EU0Cpv*v!7*s#BcSv%7`vus?K>wYwrMLL{iWpS+aE)<6Itw!^Qr&Pk9Jo2nbnF ztpTj6yPk7;N+TDP__tGJX$RWCIiUHQ4*D21%|OH_aJ$PLE}Rso8@BWCd)~S9KrA?>Uyt-Z%NUZo|kz3b+QDzTBf#4{5%__%N4PZO|bXrrgSDT%4B> z3BSa$Anxy~FQ{=LGI`tZ3CI=PgB~TaM=Gn3cHTxk2WQL;g;u4IxqVQP#o}k!2mU|? zO+TitxP}o=s_)CZS%et?>2^8-r1rR8K9^-x;yj@rD1;n$oR$pj`=%ez?{o(c?NPbV ztpe75waHqdxYn$$=+~*{$Q^z=-v~B^YUwHdf#7-fz)R2OW>rfURTqMcxOGLfd;juI z0e;-917ZRckg=G_l`K?Z=Fkpx=k+zT`ML!>U`=%?xIx#a0E#|5UnIIFZc91jVP@2g zT;`l`Z(@5yR6#}x3WRB#j+3y_@D-3@lc$z7mk!PKw~b{nh3KV+=&#yT=Zt$4!!$T~ zNg1Ls=ng_TJ<0c=iApIhlh5e>nEdT$rDbJS5Xjwh9<}xHPlEOhPhGo`{HB_NB~I-R zRalsr>-pM-R%iHKZem|1$ni3sthYjKxP*T9gqL|*^vnt#CyQ2>8Vg3It)v+(2=W-6 z2gT~Z1mWyTg$_0jiUY-vwr^0xz&GokNB8OI!#%FW-YWra@Jo< zD4x!7jlav*Vd?X&`8tq;3q^qx%0Q?;VO7z=yaM25ah+1zU*@jF_Q(*!ASq(*w$7bQ ziHzN3DxcTGFgR#RIV`}{x9O-90YeN>dSuJZ5+_73OMOr_2fviy_Moq0OX_3Tgd4YRvk3WtAII8^GXpvWNRIQ}EJeR&=hw%C;QAmW8#w@}}FwEdXdKPzf&BU&2b!3d| z2{Wt1K`v0aVy zKXY;@zkm3RALjA8$>}1En#o^eT%*j}nYAf1AE^|!4oWucdz4+h(e!vsg*SB0pSdi} zWv{wtwN>SMo|A%tVn<5CJ-P8`^q~37)$X`(#rvRuWVX(?S z`%%~uG9@o(@r?w%vife!RQdF`gj=F7iA|-Y#%p82E#Xf^_EC{(o63wkELQ938lU(a zUkKFeZ6pc~s;gAq3MZrCx@%!EB8@h~1(QSStHT7CDDL0(gIgX-ep)?P{609?R`GT> zgHF8pCj#A;ah;+x*mauUZ!$T2*VuS-wk32otN*ur_i&|sBSfr^yN# zMdgFq=01rpUjt%7LXH=-=>C$`__q=?wZD4vsN1jYH16_v zF~;4=*U4T$-#J#h&_*Djp*}A4#)__3gx>V@^aD*1`aW!Mg>9CyaY<2s zQYKhWPmlNMiBCr&;bM;GjAlxOi8oi;H*;j12S<9iUgf-d6_HV|P<2YeB4uZd>fP@J zl5y>QPJnSf<4jvNv8#Jz@%N&UKxvpIE2>?J8}3g~uT_ZddN)W9W!_h*>wo(GPRwxO zi-yRnQ%i3jRELeV^`qKa-ugF{w+`Pb_$Yr~78np=qNwlh@24PikeN=QxjVSX}#;}YT-1vn%gn$PiL6TrXCqq`)907vD0-TX;gL(xkGEQ=5);B zClV8x7dy?u0zof43pJ@Lu{UkzVaaPiO<`3jb98^->CZV#jD5^PlY$Ouh<(7KUI%?q z>3ms9#s?wxPN{zU=W#=L@~T244X$IRs-Q@;9>zL<#Bz4JO-!i)IhlK24Mnmpl}W0) z@uT+q@*5#R#iMFm*}m{tY8IZq=Mz|0mKpo0<=x=;SZ0>!`j?)#+xfmVLyhy;sQS|i zhKHI6O!o{SEh)Ka8D|z+9NT(%bo~J0Q&<_Ru(08<`$aFwH>jD!>3bLUk>5y2HMFd~ zr;CN=_&iXG%g@!BvO}uwfMrLSayv5ou=1Vumo|dtA=;l7HgfqB>(ZWjWU~=?b%wvG zJ8k!fTc~-Zgwxx#GB%RZ`RuS*@&hF7JJu#fdI-zNVks5rs2|=kzQdTz`7c2Z>FhrK zw0Qmr*ub4FJH#kU)t`A*O=mgpCU zKNW~3PQA;c!lNoF3sO5P@9h<3)!!{7Fo-A&ww9$-|9wO+_T2*6>>O5&CAtRHhm~WQ zISsn5i$p@`NLU+S=FZqaesfwI1##q&ON2QmIQAV z*Av?mRdzN-oP{>q4yj#t1|cO+*MEu!m33ywPN zuvPyLs&vM@pw*LY14NJD#(kDg5b3|?Q8&4G1Wh=QbU?q;nl*-($$KoF_ncM0wNOE| z?6ZW%AVvN6=L^`J=xb|@%q?q5IVq}xL*aW3sBvry%hl3Y!|~%UN5$hT_F=c&2IGWT zt~S!%4P);p1`pg!!G~A%>GE_=rjo-da(2>+ zywU796X!wDQo*t}mJIXFS}!PenxImS^SUy}^|j^s0ZpRRgasqvt`t~p1TTzgDPWhB zT#m*{)!^?HSmLJY3lsnsgU-?Az*=5&m7UdukW}eRrO3YGc1{X@epa`v=`%_NKE1Tj zlt$eV|1l40e1KQrrL6$i;3|IVz~f7ERFNoLnZ&1Y9A-_u=X7{qbN7U!^J0shZ z`SeY)0zZb?kDbXStVq1T;1*>roxf^qCV7H_`za@OoA`qL5p5mzAXGAcnPn)Kdo9Wf z6bcjr2f{2m0|Fn=bV615AR!$AAfz0F_rp7EJm2cSkR#jBi$#o&aZZx9F5%>|3s@fD zMM8-N^0NAA*MsY7;RNwis3LL`b&ssGg(jLdk{Tjeb|w!Ll)RUVp2j+Kq zWs8P%CMoS&+yn+fizG03u)BX%dOpff6VWTmomx@(<;_0ILTfLwnN(yzLLIC|gan4B%G zCx8+8@{9d@{Ro*(gXY-SXnWFJ;;+&|EM7NE{DzDmMF^BLSADz#0aF#rxMhq{OKe~HVYHwD0Ek| z&+mzdOS(}O{SW=zY75vqml&c!^Veyvvcqp-L#SNcsdh>o(VJ)ePeSSU*a!K@b3$)O z_lBs(*~3`Dz1RT7IQPt9v|@G})f)&f;U5=${mGF}c0&LeKqwb$hTdG0hP>JgN-# z<-ZQiJRuNUuoc__d>!v$hRDYJW;?d$8T8AKji^R;sY=$${&xSP^>_e9=XwJRkev5- ze!$3B)pS^`4%<^jUS)N%i>G_zGay&VD^Cz*^iCb4^v2#x6mz?$w-B^+>fdT)gd{xM zlUEd|IN_#K;LX_pYHTf7uDY(Lh7!s>%rY>>rcBiCcIO4GHnK{J?MfHp4CgJMYrA3P zj105jpdor0AXS%+;&OQNoIs#dKA=#0`t)}aK7LX1-gYKrb20Yp4kM-n{3iY~e|^!hW@eov&WrpF?~3Gi z4lmYjZAi8azK1DZ?(65?pC*Y+r?l-R=tdp$OKqvji~Wm=b8)8V9mjUuGOw%RT`LF0 zrrS$Ch~4TSU;xxP?gbQiV2jS_|DwKFrG)Pic6Q3pSR8EZ0vw9bPc0}p?+xe%<0~i$ zNwvI*rJmyG=aL|^bW7`3>*Dvdrr7wKQ%QqmM2|92_wCKiQ7`V7k8`eCy45Ri5Z2!( zZ;kAm_wDMdQ4@Be#V@igU;R$LTLB0PzA2}oqVh&-T)Y@rWw~Y;cV9x_`LTBu{?Ci%?yP4?NxnycT*KUoU!EuVGQXB}#olnS6lI#Zue(z> zk*5_I_+3CCoz1<-Ytiz_>!P9}j-x+z-i_nqt;>3qu}`|2_YcZ`o%w_?Oomq9d^IlZ zzHit5FE^L?m|nqAT~&P1cZDK}25}07-y_5xJ=y<-Cst1Ey-_guKp}}Cv6=OAjzw0A zJlUFCSV2mi5p(b0;1#{%%Hr-%eEGP?_-LhYB)}(V{7+QHJA2zt`r~K!v-A^U`5XQ| zN8+{S?M z^w-;N)j1mkg#lG!Nuw}}5tCaU1U>jaCoQdmUYUgv+v$C*FBeUvW1j!b_~mup zd@n&C9u*}Z1(^RAsZBr{>jCQ?jdvA@rcyD_-=OybNO2IPU?V{tJ;m@&PR(TfN=LoN zx*ykt)BBUk2y$@=ePPi%Vg{-Ly<&o({GT)Nx4GqP9^;&rT?g-U+&8vxJ6E>+z4uh<^oye_UM{a$s@15dk_DYf zOT%VHzI9%yH6)8iaKxR%ikF|f014WjS=+? zw3IAeFWIVoR!&j`&ktCr|4@ixevI>6;OtwM+0WedLFM}Q|I_V->Mm^XJxQVGoU25V zKK^b~Kpb-c3D!IpmbWujB5v&l*`~f>0w~@dw z)D2Bt+>PHOkHdi#1-|zr`Y2;Xz{NLn;d>;*9IP* z>URU0jBZu`?L2Vmd;??~lvJm94S0HJa0jxZi{?II9i;G%T^WL?lN|$AJHr>*Av;7= zSjoBF-37KkG~f0_B85cG-i}<_ILM|DLiy#M@iX?*8>Ha3|$Z}16?aQ|Z2b-`fw&?i4_pp*X zaZ%v)q`f3U7BUHy&OVUEd}B)k&>XDPV^E5~G5Br7Da47?shiyYy@6h1CODGpVHdhC zW^tl2@2ao>79Fu;xaR99);r{NdazRAbWX(jU?BUHBtJB1?;#`df4u~npprQv5Bgcw7Qr6_O`dSDOcB)M8^k$wNM;E%m8!lQxyCeO(jXflzpZkSfymF0K z0&}ar16N(xfLlfw5r}E2uDMxJ=ek7s{4CrI>i-HF?ge@ex00Qs{Az?*f$VfZA2Q5X zZhtI!cVqO{sPFDV<*Y~TLhjER_ns-9=hBYNd&BPOfiu&BZ)rHyBW(zx!#DF!*Gfir zQn>Eis((=HSq3QN1Cu6$wdkz3G*a@NQB-=bDN?jgxCR!$`9QO7)M9}DxAFnF*h-cP z>wrBQW;A;=1Fwys2NP8Xb&!u*kx$Ou;>5Wka;mqeBQv1vBj81lf%~ZpvYakYD{SEW z)jQxWksd|}%qtj~RAQ@pzUtaUt)q^l(Y3=M%jrw`sd`3vjFtBc3aF7!5j6iw7>NZZ zn}Vzzsl*PcheDHL|1?fbwi@Gj$2|MyhlVqQD!W{^ac|_jZe3K=DiD<0V6uSE^&!E@ zKrnB1;H97>nQiG(MMZ_$3qG`_Zue3%yIw$KNJz*7^^^Y0r1J{jW>E2{O04qUP4ZY8jRHm2DEs6?gcp?bpEf zvQE%KLan|P^lIsDirJxkN<`_|*Cokycw63eap%vMAg-j%YFS=aDWtTzW2g%N#dX5q zMHjc*UMnLrl*4*V(g;f1J9@?o*&V`n#+okx6mkx^o{;Rvv?X{@lq_ONU4h5}!#H{2 z@7P-`5Q~)>0b}_&Q%rv5%N=t<4afu>Mja-!p!~3*|HAX&gQ1$K`kiX&mbLdW3lpqf zUxS8_QubGG&AZS3C(Y?1w|`(A|9`WbwXyoI>9V&rW;7j!qg*X_9=_2u?Ad!bOmQNC z#2MaI1ml81NJd#+ochwT(&k9J$vXuVA#pT7@!}|sMY!u>p)(ixtL*IhwbwV@ef=gX zrtMrfRw%1172hNWs@xXGs?U4DVwS##c@=TS0f$_Zd5!#*9H`i%KbSyL43@d(a_IL& zcNkrm;!KGniSJ>foF1Bw%9qN^lIj?MR*7Uz4#{v%#A>o!`WP<^@l>JvJyNVa+QMOl z-dVY07jA&MU#gTI**w`3jS=|L z_c0Ek7;WbHTc0qtoHEK^^aOQvH|E+S40lNe9wIUzJlH#RBo`k!JLHKk$daVKRf28Z z!e@EgVJp#d(DqhxHqyw{6~^2#)yy$CFZs!fp>rOrfMnz8rUd!PyY>c^xHgXFOu0`Dr9YU!&O6rCMuQocO;`(Y3^Ju^I}Z9azSQPUb}tkTWM*#$UCw# z%ArX~UqnWMU_jJ=m;dY?jdlXip=w$-`YJ#zVkh-3rY=Bml&V;{d} z2tM7}`_)0l??6Iz@V>}+=a;f#{NtqBxDNX7NpYk$WarOv`c^Q>i4P@bY;K2kC(Cuu zM;@9~ikmvVt@oa+*;&gM^yDoR5^wX!eE+oOF`;Ff@p&`QitJFSwz zYL5Zr#Y~mX?GiEr;(PjR>6`J5=##H2CcDqVn5WWk{vaEmqF(kSH;z(r9^P18rya6h zdc=ZkUjl`e!;LRnGk^L#r1Py=oAxi0bD+J~Q^S$8M*pMZsHGwyd@=fb`#6@8b+kR^ z8X#SP| zS2v=GAZsn5dItc49fU)}*2{j$G{#3t2)QGUAfrd}NA7rmn+Kikb;4d3tnh-9>1_B? zuncL^zBgQSI-`oyi>JHO0^u~>P&@5El0K;1Rf9G}qy0dW-;G#8dGSk2*mzes3CTXq zr+6V_q%00+fOa)*8jC6g+7d}f&3Vn|Ru~ZzgnQ>yUX80WpV@|B(m{a*_76;k=`T7fw$xm%rz$?R78)jT(;l}lROiyT6h0PYTC}4lXwV$8EQ1xA zH_8l3{O&E6|I?KJzAC5TGZ*#s9dCu|d>*jhC{e{a{;(M*+9!~u#3WyC?Jipj4t4S7 zU^-@Jy~pT}>l3clk<2By!XkTGa{?&tMUt=DKhTDTc=ORe(5H3+$o(Jas<3Dl@DFrG z01^EMM2JNFA5hE3bp@AypdA7TY`$-z+~P(cBPOI*q;;m2r#(v(G35!S7Dr&ebm31t zE@*aqi(!Xsb#B%#XYn7hs_#G4^cOS6MY!eeQma(ldqpU0rGl9k zKV-l?M1fV2kO0t8`aycy0_l}LY!hZ?!ku{2kT0OnvCOAhP z34pDzxdi)1xyWH#H1jET8bq)c6r&$p?g%by*utqKdwP_v<+T%jx4L9Me7QcJR<9>z zA~sD|8bUCj32it;5L0d~r_Ta(;DK=It2tA)yiTZ$(2zKz60;IdBNq#XjVc{552x3B zAdz>h)hkh!rviKrb3z~eYR0h?tMRb0_-jA~0zQB7o3!+ar7DoecHi0wyd4*xls?yv zLs^O;6rr1!O@c~XO1w(9m*=Lz1N;H-r=+LN@wRk+xY=CN+>~17cQ_>dra>RWL&wOL zj;-xkxZmOfj71h(9;sKQ*NN9K87?{DVjh+k9dl3Do|7E~w4H4$ zkS$FI&EQ&NHaRvKDjFw9r%rJGX@((^9Ejoq!D01tOvCgS$wsf?&~m@oFsf^SC0!hF zTQ+w)&_om6qtQWvadCEHM0m+^r9q{zw_RGUN7pxZ_dmw?0v>~Te?^yx2t+2}9wF=r zjPuAlPL`6O_l8>>U2|h+H3MTVD6mZ{>Wn3xpJb4}x8)z6Dli#0(sdL^N07P_m4?M` zx%}{Gz4zJoP$c!!jVgK$Cwe;J2S{ zSn>XGRsfvyMXus$wNI1<<{vEB&SPUNxPA}qK1cOUMhFZBzk0sMjTO(mAMtd5*XSe@ zwL4vM&gLamb{5bforNknS3xlAw&){vq0VCDV;^q4$x1q9KB0repCA9B;kwr+^HEx0 zFchB^>je*lal+;$EUXF77oW}RjV=#*x-7e$OKHjEi>s$DYA<7Pe3Bh7A(bo_cGwYU z%ZSR}%$-iXli}nSSO1mxj~@LdUdh<5bFA&uaxvFZdBP=AyM{qfau=5Qu ziyo;0B@eCKBUILPh1+7&ZFl-^*YKCHi2hH07kKaqK%`+LNbdxU69YLBE$nHbAKkNV z5>wLfEnIxg7Vb$z`;SHNB6)9ey(p0x44};sp%1^Yj0X3nqiql?cXyXh;$t4@t{QKN zi5VK$H9QSBo(=IKl!n-NpUyXX#0yQuT&wuP-+F?LWhG^oMty7U*=z(24r4C*_hfyfnAS``JP!h| zV?eONDU;F>ZxHj;CG(WDZfG@uMM;MxNv^w;uVQgHw$RU_FBK>{e$lVA>m@qZ5n;`) zE+{d*31@AlQ}cBB5jaW#N5g8+V<9S?FuCQE3viC*hX_|btfJ;;jW*2rQ+wU|CLwLp z&epY4vulE$xnYOcC8sP$F|jTYKib$0r5J3bJ1t74`Vg#pl6`lv0reJjt)?|TYQn(& zhCTFXeMIo~<_|^totgpZn`1%i!|({+XRoc|sr{bK{3&bCtG%-pw$%Ez^6~PGj)T^( zdg9lOL+U2T!Cb@H1|Rp*Kcgj-W~x_c_K?*#K11qWowMP0!sChZZ`dvV6Rdp+AVmGK zrArLJ{d<<~z^B_tTRLBTCAxtHn4S{Zz->?foxaN{0v5ynHFcQPYo!6?X)Z9eKMZo! zNm1T#C63@i#op4X0?r*uJsBebi{Roke@N_9vt@Ud2rPqbXRB+ zxG`k6`#e9|$kQ{jI-Xt5sjj_!3BP$5aM;XvOk#r}jDd4@cWq2K+HB-*+R)%&9`oc6 z31O1S`i~XT)=SS2L1gNn1L(xEYOejV(o*0OXD+2D-%jAEW3KsaJRWR6Hqw)EB)SRr z#a^n&@8f$W@9^Rouq$7c7*~hRyGM{L5~*$G-O*ehM=ol zB>ab53uN#TOLTLT>puA*&JMC$g1Nl+i#F(^=Em0+x6;R^M|@CnvH;eAQ{pvYI)}z4 zRJrihAUMbUB1!?6bM}`uYoslJ{yO}XsX5nAsztY3z+`xfxE0j;0iJP>{zlY|K4*CR z$EoX_t)Pt8-)-JVl$pL64eou(PcYXkJ*SkJJHw{1^7Ib$wMZAH1QW}&u`cD=r$Zi7 zz|}^_!k(<&qfyyHA^Lfr%{&e#=nuj6(a~2L14fJkpQT{Junu|QnWsmGv*)9*%*v?iL>(gFuy2GG(NgSoPW!4RX_H{YRy7$rJG%*CES&+IZAw#`HN({x@BDZh zF#5pj{^vO&T2;Ea-l{>&TjGit?oH8yNKq#7&(?ZbXWu0V*>&PcuY_CdqPPiT?yHzv z*gIYB4b&ZAFd2`XKqO2y78VYkbf4x%Gk2Iv60G!mOVm`?BzE+Bl5zByOJWBYj%wEl z^4#?nl7;wQH&hw<3dKbkq=V)pctlJ2Q@WtETK?Ac#G3|dcS%;GYR0}}(QZ_)$0Z82EtZw;L>ql^V*V{ztV-V;vfbm5#V`u;AZmnfIeTFiAcc)XpBO3-ZpiZJFV>jLeaLTm$`hbKhXJ_^zQLe|`9q(7845frmdWES@Bz>?C`d z7)`%XXPh%Zwym}jS40u9gmh)i7n(n=rJKVuut;|mhx(pgmX;QDjMWqEu$U59k~6x1 zNfd?=8}T2(a(~>BXmh@dsz{sh-=E+38ARUVu*6B3K9kv}wjmFSb@q{XjlaZ~OKg8} zs`WG(OV_vxb0e6rEGA~uCuUTj#bpE+mgT{Nr*9ClApUfiSMm_qQxFe{@4gq-(FBWS zpO*S9DA|H5eWXH*bA0+~AOCL3->6O@E9lMVy0D)t1RvDy*F7wy?Oed26nT1wQ%i`H zMx`_Fof1pA+>^9A*$h&bQ{TS%TM^yKG7iw~`pFv?k!>f-lm~~0ji7P>p*+{lg^r#> z`zsP^j=4z@Ha&C(lLqv6#@G%`i-OHJ6q}lwJc8}Z&6KB+IBoHF@()5L-)hKXo4Z4Q*&>#7cW; zTY2U?`<#T5O$q9v&Axj+)Xx4b&0R~3evwi#g>2^~cTe;rtEbF^nyeDzoSGr^^BYI&?)m}x zdmDM^@0;N8A?y|nOm%KcZ)KmnWS*{tKR3TKXx}`mUHFevn z>0hUt6Bh@WCCi>BXAL|p+zq}GQz0FCtj<}s5Vq@Lf)_6IjdJiz!`Ixe_5?>;^u@`_ zub%Yww(!GMM`+-O!9t$UcB`zrh!epcpXIw&pG1Qkg=+7w*71u_5mKswc~?{T`u5>a z&P!~2ecg1n?J1br_zd=(|v_~q;iTGUzBHJp%GeE?!Y)^e|0lo^ zJhd9}+Wec1zcS~93ErSLo&=RCf4Xwg_fFvI_cSqK5|Y#7yz7geo!mT@d!`Q1&6bmf z-ly+RE%V!=8ouXi$gCbt*9Z+QJlm|)8u*L6LmLP*{x5ybW`OD$Dk$T% z5AM`Pd3G09j*ZPy^V~wDsYO^qP^ljI(w@gEfp@GCn}Gpd+{>lP7i3iu)*jRPmlWv4 zo2zjwQucGB1j?R9m>kc7b_XXeDkCrUwO4<oaUNbo=8ngF8x2Rb8w)c%1scnReCALx??fn4+bhg=sE82CR> zGXX^O9}po@Du8+Mi583={Dn_aKa8EgI$PD^$lQN>$GS#hL*-QUBN?yr;jVU_$4s)B zN!MSzT*9!swB45~24m8nw;r?c^hiA_7p*ras!jQ+efcENrZ(>8z-t^of*AvL;az%4 zunFWxCN*G=qOV;Llb6vEh+y(Xvy<2pn}KBL&=}m zIQ02)wtAXo7;gtZ*qwfX%ntB;?-tgCEloR&6Q@@o1Xb>q3E5Pl?trvwfN?}r@d7DY zC*U>D$FY0tar|sF`VdeM5lvTtkM51Km@yuX@?zak|H(S9?+;#e@{JZGjnSt5&s$& zF>#%iv2&Md?BZ$=a^`x6KSLOq9Ow**8E3}1OQxTChq|(-dNgR{k>`?C5GkKFGXX_( z(GLABlkL?hT?cP9qRG9wu6SP>V7k;-1af=TiBklZcE?8+^OAh!t7#yxb6Y?1pspzI z(h1KJam_A8Q$!@b3t#EsPjs1GU4ArNj5w{EJMu`C56E^xira$x{q%fK>>djfk8YTiQL6YAdiI-%b48)+tbdRz)F0LPHcKIEKgo>N1L zS=&WsUf_-lZ~}T&?@-Mbmllm_a!k)Xs+kA3&n^mHD478iQJhN`bNTE0=($*cuI}D0ZLVmT@3cIjPMiO)(s} z+Y(szKD0mT>`&PXpIM3!h+E|4S^jpgt)uH~N&TFDV$7GpS1B-i`l$h{cdWtl^*Xrm zPgYMYEO0bKUh~bo+d?^>K4!*d=hSQO%5M?mNrQ(T9wr=w!eK_A=+GD`&R~hu2+`qk zBBBl8dU3wxwDN^JX|HNAeW!I8h$DzA)NuwEZG0EB9X?mw2RTtq%zZE?r*>Q3}p{umQN9s|F6AhoB}tjs!Q9!Y!P*m+zz&9=b2`p{!>zdF`jI zbFJVY`@T29M<2>3lc!p2kiO%ULjLW#HgsX%f_alSdZ8Af$zh^b5-aYaRq+vQc{D?h zVzs`D-WUovN}3PzacO;a^f|-(OM#nAkl1sk#~_wxjLc$&3WYbkqGP^44XBxZXv{E$ z2v^UKwOaiiKJ*YD;kgj*6*nOE$$~^lO+_UlQdcpZi}$Q+m>5D;VW5~wIr3xE+9lpF zLZErhvskAA)bqX|C?4PlUwOp)iB?q8K>TFHktiHPOE+3zj5rl&bK>v85@?D4g^rLmYkNHAF9rwTVy}Zjy73wLT|m}omv97 zrf8jdfAn1%ShIGM8(r(d8%F-u3m_|_r&z0kFskKzl%Lyq&L}cU*irHEfcJKo`4ww^ z%$+9$^Zm8B%#WA+Ivm2n!cHHvnt^I}3spbs1W9FUP3_RnUy{z>GmnHr^@f{v))hy$ z#G76%M=v#s_Zg3Y;tkAmok;%J3Em@!e$pCz_XG~;rRHgr_X@@zk+3ces_ay(HShc! zA7+Wy%vgU}W}3ygrb6;)y2@w#IVBYD7%K9!(l#{gW1vnvjhcd>;IESA;7wm^qgLIn z=iZ41b(DM##5$FN!|zU{Wf|t{MzHI$bZjq*dO!SebECKN59d6Y;Nk^ECU^J^ShDk zOv({~wE{HYzAD^+6*1)B2cn=~(9ZxyCPD?F)Y8A;TnIn^a5A>6cS%{9-??#%AY^Sk4BKkl2Rrr*KPN3Rd%BX!Sdei)-;KC`F6{1LPQRqN)u z@Bf0q`UVDMxRY^*HS9DR%Kl1neV9;;uikWUv}}Zxq6!qA1KxZ;_930L9|V)!SM{bu z`onR>iSh3UTb!gmPW^aWzkQdXgz-k7E#NGplQU&fZu=4Ip3vCR+g7{NY*Cd}gBZvC zmeaa%zGR+ohkC8xuwV7AeE_$}C#zxB`Q z4FKgAHGOZQY4dsE0reIj-@esSMR?yG z%Y%^4oNAirMv}!o2$6=Z?dosub=j87RRp6tQGUyl-I=fJRh@Th=u{;F=c9Jh?x3zt z9Ao7iPwBV$nR0i<-b|Lh*ZYl7OIeLfeuwjerOSeKOK1vXJ0_i|KN`hJ|I}?xLs@v7 zkJB3W7X~xy*5i^$bIS~~(V4I2>y^cobpn$cd?&+dIpOTR{l2iCua2oHGU9EKLw2au zf*VqW3u=`h8-9K!wng%E$2Ktft+PTi^+htsH3K|O%eTe^%^d~e5}c`YFqthF73j>u z-|xm(i|`J`BOC z#_0`KwVJ{!Yk}&MexenLeOVy8Vs^UaO z(jiNZi~5wsH;i>mnzCs7@tR_9afw0L&ymP-nbmdW?|1=Y-*s0`Q2_P+dlrc2Mj zgT>~y(;e4EBl5tDHWop@?kdr_{c4}{$|XON=D^r6fYt|FpX@iT{9Q#b9h_}lF_m*I z0eq)e+sULxafAE9j2ZVd*}g{duO<7M?+;}a$z+ICxujURsE%g7nPyI=J%VbQMb$N4 zpX{%Xjf@aT4g0PlaX$y7sqTopb>0%3vsCIenWX;|5_k}>^?PgUx+i07@7FiOs2GyJ z;Z`+^ZrkI9BO)Rq&=)UWe5vTO?V?F=U`l(FopI$dWX$K&d9il<#x6Dg(1eXCP>mrg zbuT&2%FDIog5#5@+QXlfA+0xYl$>zh{KZ9x@0iSa(=+a8&0WvmwXdSOqe6OONOp7H zz7^sS5&5P=EgjXX|I+2RTABFPp3BDTQWanOBUpc)xSHkDBzI!P59=|gp+J0LpfqCe93^vhev8q+lb>J4Q2 z_4^C6iTb_SxoGZn3`}LOqaTc_jcpwZaxiT5BWpzm#TH~QsVW6Jt(vxxq?Uo*9Jg2SPmN+X_K@2p*Uv+2aw z?*F`#(HQ26X&lU#ksU?7WCjO@vES7cnG@Blxz>CK4(lrPZ|6l%{6T0qG&rRv-qUCm z!{oh+X_zt{nT6^AtQ>zGZ5+Exzb44B(@MZpl$lA`?*O8d&adh6LRPV5#t4qO<>M|w zSVu4w0(81o-EDNgkJ;83;!lhUH<0c5eD*i~=KQ_!^|0`!ApI(*4aPWFoXHl~E9Kb) zT~m)+ex%@%8xy=*V&|H`JX{t0v8}%i<0^Y>1LPVGwykuHte$prT0`r{J{bX1jgO^; zaVRpP8$oUhQrqm`Nf%}vP0v`5_**c~-d@b$P3$LElZZ2K`_sbfw;jrMFqbBVa{*70K zX*9lJSpL2$H1^iGiyTHW*ZRl=tEI$O!i(99q6Kd`a+38y+sfo`F}kutiRJO%qEwc~ z1^0NnnpbLOctH%iR&yy}udfR%co006Hf%Qn$!{PP9vfOSixn&iFL6>na?UK+Gmt07 zAJ8mY+skC@#GdKA8-66WRUI{)%xgQ&O9C0pT5%bvgl~fwSeM(*4qzU0(%6TlL=}fzLoFnGkBO46u^6AF0{#D6uOW3xOq)=vyctKh< zTzVi~X4McPne*3~1VZxYy^50o&ymHn>Id{Q-g*X1+6&EYTIVpUFGC>Q@8@9Vs7#8p+|J~nv#P%PR^HO_ ztOfZ4oQv&@N^j%VT)*9eTWDHwe)O{c{Fs~MA=E~?7%`OALL)u1>wi#7k)|BSIEYXU=6m%p|v5@rQ6h& zE#M)gEezQzaE|G*ZE7P0QhJmws4`O`HjK^^r(*$Ac&XoR3`yRgpJkx$;b@`ze06C- zcuFSk>SS+1bJx~-{@smQM(K)^;kS#t-0bZ5b#d6?@`tDHW@$M&{cF7m&s$*JviVh7 z9dh^NYjqh|;X}Oeiip;6htqGD7va}zKWug2exI4@@=?Dkm7ck`JVDYMe!s=*K97Yz z(^Wsf$6OlsO=7jEEi|=IIO6moDcSeq3bS1d*CO=N3T>6SbjN(93n9u4FOow-xejpe zXnT%LUAQ{Z>(ZUbWPhXDgzT41qN9Tbd4)PcuAllIeqb|P|NT*>>;3gSO07Jev~j5* zX12;?szK!&Qb+dEl$x44gF7E^92$zPyh_W-O>M&#|62Rn$-zM)f_)A_#$@&9M*4~T zTx?G#S9!^mmp`N%_X>kgYYJm~JNkj6lz8B(4P49d+89zh(hwzxjethTL(Q0lSut0o zPKfxjbQxZc;+PBcMUU*)Zq=$iDnwStw)D5byPqi4s;T;esT(dIyp$ZT2_eh+^ou=jy&cS`I7_VPJ;{QA zq*8oEVI?-*o&^pXndm94muTf4UT@D^{SaT_mft1aFQ%~wZ#`%e88GP=mMDn}%55Q0Sh*qP_#9#Ch*5D0|>f2b>+G;|CaE1JWU zW_sbr7$3Sl!MVi%_1xK&(Kp5r4eAH=eK1hb(k+v~^QmY1t zzi|M>^yhCK;_xQ1r}!5XIU@$*d@mOYh=%%U3IV`;|ar!wbT>x#H-%ddnJ048xnxwoPVVrHdy8 zH8Ky2FOt?$zs^q8j9vGUe?Jz-)n;@SZvBZAEgMh6#jk+qZ+rH#0ZU8zI&OQeecv(6bIMi8yTGZH zdwzo=17OamD`vm&6Xpv)ah<6uZRT&}2`>TAsL9^Es1HCp2vr=!kUXTI;kUT(2E@{6 z;PqAcHz^lsZ>^~dq-6cZVp-LnjGnpf%9cG|yUWg^ zL*WNV{g@>Fdc1o`uCTN-M|)aXH2mPVhQjP3n+_+jh)3#I&^b#Y8&)|NFK_P21a#da z;P)z&HG%rL+Hr)w!E;G{D^;nRt%)%`9+B23gL@Zw#1wq7`UcFVnl8p;+|2vD7A_NX z_8Zd`(<)%&omN*Fz-IQ#tlDD7+Po;y-x+os$<~UU!P7``vNl>9WWN}a1e?aL-4?9> z0_}$zg)3fQ^%}@C-#sN~Y6Pp$1acHCbvaTgX|*_T5r$85c?fq;0eLo5vst@h>uX;{ z?~=`J3pWfTNy$;p5K>`=ptqmQqt=|@o)ZeQE2zIV-fWKvh;X}t&I(*R?o(6a^j(N$ z^F5tQM;Y#A{6-gl2c9anHx3GWuPKi*3EJd5fPkMSi#U5Jm(5ot{RB`AB{0KQ<;|~8 zwe2r7Ml)wt(<3W#@hfwf>5GR!^0!_YPS9SGj>|qVv5RVyONmf zM;*RD=|8pqdfaYwM{6BiY0+4wdFi&$V6=2Lwy^j+{Ws(!Rq&l18r9ta%=kXSA|i4_ z!^3+9xMMaohV&034NgxyC#t)7qQ}3Szbu_-vy^(hv30zg%08SWmf{0JEZkmNGY|+A zlwu~1PCU;JUnt}lF}Y5es+;1Zq@dXT^^Fs_6WGPXG65fWjZHUJuy1hK#@2>k;a(dy zO+qgPJubFMWFYpGn(jTGDCyMMf3W2Hde=~Pm-ZTd^5&{C64#HOnEaN_r`lbC=`P$TwcNe zAUP!42W+o{SM1AkFJ^iHv`Ik=U`9;Cw2O|9YcLY-gp#NB0GiZ`_CU1A<5f=rBWnEs z;D~)RYLY;+5^c-RP4@3NR={yc`q(-!8>9YV%h7+>vP|{J-Pq`<881x|fH{>xN0wCf z#+XNz4*#I3*_Z7ZMd`I5VlS4!=w#Ds0EZe1{llTE!TneWdtgW$(U@(oS=W{f^cmm zyyiNd7E2>5i(JY>Vy&<}zC@BmM07=cKVv7E3Py1GlgPZk`t(@jN$8)rH8-mLLenzi zVpIHJ0_k`wVqd(L#AIxGEKc3p;F}2N!dDSw;}y20#bId?zUatvg9s6TJ^*+R{v`Cn z__*HdcvVnlu|JMDcmNIae*Ay4z9X*qLJ^Z(qwZoy@;xQaVD``%W;l zk&JJolMX9%)}+tEfhpAd;T2~>CeH~!aR+rnxMS&!%U4x8>d{wpX?)uFklSa@=tbUt4_lZ>w}tjnSK*I|kv z7(oM~Wgb>&Re`{dKt0~h2s8<@)Y+RMyk|uwATOoI*Rhor`2u3L=GE~0r8J2%ycz?+ zziH(&Zt$LwNH|9LDAco$M$~_?9{>s-sH=LYAgyWKKHY08Sa{WjJ)llL(LMt znj`%3bOBen!`L=Xjk}|}5Ydk((1}WQZ#XZ&AKHsWGp_0_#@$tdTHc)y&zDq_ien*o zK(I>g?A38hahxn099opQy}8OoIKQ|B7P0VU{r5s_{(I~jP$zS6@{qXA^LH}#q5xsE zBhjwXgE!X1dLsLk6VdQ;=pYh{)Xgx8D{nCl_G-@Hv>}`#DR267h4~1kVil zvGge_id~M$Z%#Tua+;Qv6=MPopJR6ZbkRPb0z%pf1fk3VOKw|Q+Te_T<972)3INI?%rP019|Q=D#SLE+_(R|r~)o1)-8cp}xi zt_VuD5~t(#z+H^*asIZil;vws_+)~p zEj<$#_3TgHXTj~gelO-(=`z)%$9OelY9DJ9Y^j?GAla?6 z-HN||Ujfu>;)9Un;@Mt4?R5^$Li3ytp#-4%@P5jD_UVxBIFt7Iz4V;LK9^mGF`@O0MV4VLfHR^ao zbQX|Qv*Wd%Jy5^jW_>M{_!?3x#n4w5a9j?6J>~PPCod_s^8A(?g2O^3*;lnTQs2GX za9eDuX^ee=fz7omDfPdSYw~CpW|uxnpny@=S=NdanlQE|cq#hyWf66p zdVJ*2)Hy0y@IBF9yiiJf85txlISX{=-l&9t@u|#37U4?PeZllff5rsqw;21~7&W=- zPOwRjZyK3QACW4Yi#U7VPmKkM5~Nl!P$zbat$v^aRbM0IQF4MsxPOUk!!W~gVv}~g zbKW@BSIw@Ju2l5L=p_kHKttkNx%t{U0LnVaI`}T&Cr~3Qzq>pYv*_IY+PHjYJ(`@m zTU^J(uWL3}iE;2L_Z`9yYd~H5yJkQ_$kS7N#0Fd>|%;W%sOLB0t zKDQ`@;ruz{GiDYzj>*{@S!xN}H%5kWeM*Mwy&9&a!lN(AvxnSk`ZK&jNR-AdbF zlV+|7lVrvBxN{}Tn??_Doh)2o*~natWaBKxcu^r=SujFpUzin1UHE|cp>yz|9yo%`+l=rT4z&X9(!< zRJ|FpAITPlgnkGA<1AElwdG(WT?WS?bk2t|=eX$aHJ0y%JwvB1`GKO|pvCW=O^ma# z{M;X>eqK2C$4Z08k|c|TPA~CD7()Yv9RtjY#m$ocIm8$H>^&*y6U~B-7}K z2FcFF)`FC$I(+|xgxqoMFAf?P83Ov#w3w_UN7X)IcPm0VhAE{d9p^=jJm$h%_rl}% z32*MRKE>z1R{@khlK8X;M^FlDV)up~JjdIgFjHgDbe~3QpNG+%;&}@V$a?)1Lp69c zluD(mn9HM=XNnYxmD85gBI&zx(gFCf?c!C{baYCerE&beJ_eFx`%6X zQgzS?CfmHrM3q@L81IK&Fj4PUP$sJza@ApQG=7SHpNs7KV)Hg>Y*#93mn-g&=peR? zzoF=MKA$xhvDQ{_j18v245jKP|6Qc3PR&j28ipsXqC#NO(@CwV%ig2x`UEQoXBmUk zdi9v^v*u+}WkM{DaI6el0=qU>xu`R3Pp`8#_aClTmqZAYc-L=N*^cSNJ}2?(j#NPM zxvoW|AZD*Z-f@^hdB|{R!Fj0lg_SUPROM~NfzYTj5DoPKffkJard#M*6wn;NWBk?1 zNcl2inYz~T_NpuLMMy*kAqUnuNc2U+S3>f+w6>u0DWeKwre}%A!C$O9I}X-V68eGW z?fv(KN{FYYm%&Qu`aN8w>y^^!`h#rC8MipIz6r?E`Br}f(^Ey$6w)LY5;w8_R_5TC zA|^?Tby;|^9&y*Ighgn~TETClyye?b&`Pm52I8JB|KK5LNUL;dp-Tev%dz1T8#qtV zJGI$U>|59?+?lQSuGsZs+VY;LORmYK1SMCCN+Aa{CX(KwQdD%sbDS*@`$pkUb-uxT zz32HxRp$+bFLZwJ9gjr42JO>}VUOeV(M7SPpp~Qha+`$b-`@kantVeBDY8gv6_pJmOdU)P z9=fW6psDx$WNBdlzk~!VxXK}`Y$>wY)`q4huh2(dzVM!JWLoECefSVkxZA=9Fdio` zS{jW-%0J2vGvXhNKW^X1NucG^*49Y)f|Lrmg7M!hteEbMm3qH8&x*@yWu6o|^^O|b zYW-|^{d(+HFf3GEU;l;DZRgbv51zIEsx_cQN`i;u=oR*7XJC98^U5w!Q<>U(ukDs+ zzJ>v)`fABfWSWKK=hXMPO`)tp^}f+rx=H$v?F+3s0%6*t$<-So0e>I8%g)Hghb3%S z{nN2sVlb=9{;SNcKPr7Bw{(K~6mZynUip}J(Lhxb5Q#q@blm3e6#Ra4J~YUeR!lYg z#dgh{6M*a6jw3l6DG$%zK7Ra|*FZMx?h?_mdhg+tW{}#5EyEMk16&bKHn!q0pa#J= zl3q>fr4X5E*F8Pa^qfQahUw{5SS{%kK5u=!ceZu>69CrcweX1K9=T(pj_oqe{En!> zDn3!753^hPB8s0q)U-5iQ`SMHxsxA&FO`~>*7HwLX>faxJa+l5%i8M^`nu!klwHjf zIUv&F?^x>ULks-3Bz;uRDL@4Zf_d(Er)5)f+fse4?y2$PKk zRU^!w9a++Ct+}eq)>_-seoCaop^3MG)bg06+xt?(6a;9$sdc{_yi4NCXhPmGuMEbo!^7qzFLl`9DA6WLNE_%2H;srOQ z4kjF~Iv-iO0qFOaAAk{9K)j-BK~(Q3S4N$WZdDXwYIzjRd4s5VT11H>98`m)Fn)cP z#dUmm@@o2@eA^DFP(Y#lI70KWK*!gKwd;z=9I8jg?~-T|N_YWmEsj-@bkR`yYAuKK z=3#qV3-IA3+0{kn8sw(--y0dwyfp$}mk9YfI_Zv*+(uvk4*>?=^#IEi*F&+DAy1_$ zl97myo3G=vVo)`~Aq;^0d@44U)N!6fbr+R-g8vb#B>-Ii3TNiwkruuxCZK2gk_)C% z0Ec_}Dxp`Okf-IE0IM@0PhFUSuj7*1T94oAXhfg_NY&d+d3uDyxUaI$&e z#TAJAW~r;R%Q`Ozf}M+ZLl~^RJ&>ZlpqD)({}{*{Aq!5hnz&~5*|W4sc$Pz&YrFS> zbXcTcjAEJHmj;PtSPrX@em#OYigSe}SI`5-FJN;pF34{MZKs3=u*8$suq5}Vq$A@a zf2+pj=CQ*+ab;uTWAB4I`U^=&`?IF2axeOP@{*TggE1 zPaL=jco|t}|K?xrmP)54W``=Bh3$LOGk($Tc3nooY`Td><7bUZ$==pa2wPO#y#=UP zGzIftf-bw{hA%x(mwJ*nWJ}px`&M3bB#G#cK{S>N4`b3lw=cg4?(2r}mJ(xQ`ST$^ zu1z8Ry6PPT7;L}&k_F2YTXrR9M%;_cYO2mQ4EYIwD!RUv)uUyQtOidh!A~E^xydkt z5eV*b^r>Q&dqev{^v}peQ706d*vy%lT_Ca#B+++}8NLwS0)Vej)&8&fN$9UN?xJ3` z{WIlV?D8^co=iHw_?3tb1mwRJI9X}^I()5cdafv1L)`9o#c|@=!QSHT+tu;pF_!YI zYAuyC?hOMUVNGze{z&~S_k{pDt7}HMoa(5xPo)>YT7zz_+m6?G-{kO}BYQe^A&50) z&}xMtgrv=^?eJCcFZ!73@pa9)XO|`EDXh&FJkj-e!Gz)UEPsjTuET2@AEND>12Q(4 zZOq3*PW_OQ*9T6J`awAnut~*_J^I`O=5%P#|h)2v#IY7Ei%Yk zf=QJwXnK2^q~RV{a!jmCj0KfWowD=Lc6v+ILS7&e6YE4ph@_VTf>*E&&wJ$3So1CU z7oOU8zU1HBClLG}O5Tr2i^=o49AdXD6m`vpWSLn+`A+MNznX7^o=#^vWYC%n8eLw7 zp3W7gl=X2B1O>~kM6Z5JWTN_*b+OoK=PgDR-XdMzu`}86AzL~?|Ht2fkr6$huPHw# zJvE&u*XVf;J{jZQzpR}Vzyc}+lm+{ixV_{BQQn+z)oU_r*}0ZJ&obAV`F5|?U!jXn z;!g8C?#K$j8v{em)=vuo)1{>o?Dc(h&JvCqAqU%a7cRI-G>+@3p7TOvw8 z#|*usohW$o($ty_o&5D{GWiQ^ z+mfvtH}$)xoJYQD=qBr}&?36nDyb)I7;i+#og zxEPjs|I3uj|CcGLrkiK&{qVT331d|Z$k+sEk;+R>vfQ$iT6? z)4r7*I&(*ycS|)OSMVq1FCw9K<42u2GJocSf=4hiS%(#8Qx~YNW9{XKJ4N)`uuDE) z`jS5_7H9g*O!wS0*^W7#@|xzMuNR=#YE*Dps^lgnOWgRO34lwb(t74@ePMe?Ht_7( zTau}4DL;N09Vxyl=FS4Xc{#&k-8aO^jBHVk35nLkMlEE?O$PaGiJBq4 z{sA8;!?@P5^?6Z9H@xv(*<#%aSH;35z=2K4OY^FnNJ&=0 zXw7s1?@)L|(|lLTl1jot2bBfL-SeZ!G@qjDvt!WDLmV1i3bwYG)W4=$f3(}=k}Qqb zn+onp6XLYID9Hnh?W62j$Abbeka$!K;lA?BH+E7U-f9|TkV=)e@oQQzT_I=dX=TVk z|3;|KzMSq8B_Vv77cg4Mi#zv|1$G9+f*vH^PV%bXJeJh767T?xGuVRp$#h@WX1st{ zsZ5YNBZ{;n#%NzkVpevox>3b(b-?Yc%{?J8#elg?V^O#`PJ4H%`6uU427gkZO*i0V z-=1qW_{XY&YXmweX}K8Cq10YXdFbr1@Gzz@NZRHw_u=HLe-$|A>)kUaE01Lb;O?Dr z83LTV9PI4xW{(`oAKCXOy94EV!)t(N6%uQ$h$4CTlq!iqs^PIz+kCNoxf4RelrdsE zny<_MMD1NaCKKS>$h95yQ}SnM6gRzoPDRi~2WRQ(ZEC~3i4$bX)a&8_vFZKB)M2$q zSbJE2Vavg1NF`~QYM}X=V<=IfLxj?W^!mz=rs8=#A zO7>6Ut;4yyURVG(9R>?WKsn(5slvp@OJ}MzzyvJizq_zW4R>#LC9yT^2H32~Z|z2m zTLwgNnrNNx-0dv2nZyM@NlW=1XxiD?=>xqXlGTp?mK90Y&*UkoRD!OmBjy_+VT8qod$ZS3s z09H__Dczm06mVT=*e|c#J?lv>s+;m^vqp`LCr~rS^Z@)9b-rGmlK=RLWTi44ZV6T` z_6Pe`J&PnX7Qh}e5_*prr{}4yiPd$g`t_-CcOEXgyxLm#Vn7=HJPtJdNc-4?y4hpT z6SuUQ%a%^M7$s7|2`Z-s?a}z#t1_&l52owr>4BvHOZCTeGmX6pTT@=|C_gV{Oe7SP zSwt5u#zE3h(8LsvpnY0&!c`(K@5d_0&}%F23YQ|cf_j^kx5237!ymygLTrjscB*Fa zihES=l)W*lsS&emB&1_QBjz=)ravp%L7Zy?mn5@Y^Z)+pdQRAZQTy@cnWhUBkbc$q z#jO6y^Sh~%WoKx}(*8n&PA>4fRw%^~KX{v!h@X#& z-}Aj`hxIVD7zj6Eq&f}{hBxYJM(WqV3!-983bqM(dp7XlqzW%Pl#c{Z;x;U#=fzoS z)2G^b33+_GUt@oAPwHx_v>K8^ClHf8m_sGi)m}(^reLq#vbSu-2WsXucDQ#8Qrm{F z%4Xs`BRWyLWU`Q;{UyH@YTrv<)9P>_0(gIWoYg95zkYwaSL_>tlp*lTy7+^x4dthW zR}w)IFNW<1o_X!tKNbWVeOli!f)4i|65D73;jxY+2D=bivBMS8l>_;J6x( z=nJ(GjdumE=^VU>?X&-rVY5Yj?H$yu&8xS-n(2zYf2hcqfjL`1d@*Y6C7ky} zQ6)STzugEsnWFO)j3d3 z6?LEs5ln+C--2|01ULX~05WnwzOoO{7BHgxD9vn*vT-WZWz&%DsK0r{{7IP8z*_GB z$wSqr#jEMu22D4)J^)ja@`6-Zg{1QGD!5~4q0aqwjqEr~P5arixb1A9)!f4J)gN~A zn}9nQtHlPZ=DwdNS#q_hqFqpAMT}14;oP0eO6ctkz%&x%_+Op;v3PZN*+%&urT8b? zGile0=ken}*W=9IR2!zvLcc2>#K1`M;FP zr{K_Q_q4$u!(8gx&zA9W^>NSBfeG^z5N!N|=BjOFdN>{c7ZPtS+jC4P8DcddiP$hD8Ey z$V}@)2u61eDc_TLp3jL4&jkek|J1<9$~WG?qh%$#5%EtBJ$#}}5f9{1A8c9Xk2tqEPO?4{&n9nRT_VF>Na4Cm1qVQxZ>20pW16|Bk7d#*-oXby)LA&NB-TU#|j9-AsDB4&GjN)tlAK2B=O z=*5f?-yv>6NkAhrV*}wmz6k)sBYkFPhy?xSffJ^a@ z_5(VohGwZhs^Li%s*u88il1ONuvsMZ7=)w7A!^E1Q+%L&7GmYh)$6Waj!qo7n++L~ z8^na!3TA{R@PTv!^Qu^o_}iUhMjQfO+X;e1Wv+jNsaHuLV~=y^?7X?#N7{;jRIle7J%cqCcz7#E+)?>dHei}3kg=>IAW0+ZJjNb)ra#bHh zyD0wI{F%_zjn%4@>zU+X%s{lKFR0J#dT91MqkaE%nL#P3O0-JZ8@{b3N3wXm-i4N5 zcZgs4*trQkYE=CN;xwkF9QZ1+)Bng)zrVlt2>P=7j!RwM@Y0^1G0e~dAREu16WcmIaq z33fva-v{O|+r~obvtFaBV$l>lYFAh-oF|HDccHk}M7^H3A?m)dhm8IOdF#2)<;rEX zvY!-&-QU$|>y+9!VIFUdIqgh&9$f|_Ha0fv@k75N`w8as-whsMQ4UG?2`DmIsA7?= zqID(wmR0^7s`(U*yU}K7S-CGpjWcCJBM{#H%!8?qm9LdG++IId-2VFqE{Lf@!{3OF z&mzslYU%as5#}FfCNFT|eMVZutk*VTsF5qQ$Cf#MbepuhYlx@Y4STAeefAgXAZyAnY{PdKG+n=x zQqx9dCEJZA!fLHIf2Zm2r($H$&v_qK1FZCY>7hxt*N7{6&`%1T(1 zJUNF^#?wwXfMb=j67IgXC!ST2DGNXz#=CcsS{w*h#)RtbRlZbzR>AVv4QfWshR)ia z-yJ4QWeBHP)^e0XhYj0uO=~$wE?S@_e?JPoy*^&LVG1t9p)Cl#y;}6{XAr(!cscNr zWO7;g+!3nf=;(M2%$`YZz**wi5RaR18+mh?z^D|OR}BjMNq{^J9j&ctLilb(M$=8Q zAOv`ha8WTN-urNy)yYC<3;xPT;2j3-&&5^O4nq@c(7plbQ@<^+kY50^m_kZ>1vyaC z8~-kJ4gb98G!r`Ek;m2y_bPwz2?LRRt=V6QI}UDw@Kt_Ix(_6XzXw+86=YcDpgNDP zE~Y7xQM@Qi zeq*>nJF%wF-AYHRRIOv8U=E`jSBsE(=aIdSDNE&vP=!!xjhxFR_sms7MPAPEQczH^ z4&JvOb`)FR-~AKCVT#u`>Z@O;i>yhzSN4Ab%e(bMVaJ~f!B^~8L}n<-0@v1{aJF%Q z`A&d;-ewATB-*=!boB(!pVnvp$R3BHyvRJfVG80D;~O=Yd^d=q=v%V7{3pNWFeTw% zB<7b4^WH!c$QUNirNF_Bih@`dBn+=;MFHEGC+MaSTaO68P{nSjLx?j_+5;imb-PXP z^?)!Ox-)B!bgfe1ZNlKp4;H4ie&vn4KI{x@l$#AR5BLMvE*DxWgTBUEC^0WSmYq}m z!*rsPw~x~PJU#8HZTh%Y3?f$)-NOF1T^#V97GXXOXb{6ISyFgXnfil^wPou#HGG`X zL3O1!{OccM%5G6hgB%(9r5Dc$-0(7pP7KGfFKC*KP~{|5X{DlVHC+!b`ULGDE$3CMHPRkt)y&6j` zzJ5+lPKZ|{-_<2sjH;Puh~2dO4&UMpV{?E`Owjab9o&_IoSab9eu%Sm30GB*yP2Kk zl{L9JB%oCLLmA*gX$QR1FdJV7m-^)OVADpAr7R#>tu*XDYw>V8IW`fSzYNJco24@h z2t%^6D(4uq?{7bJaj7d79w@R(%89~_a&s;L0z?PR%Mc2U{X_v(|c!76Tz&Hi&J7!KAEPqBGM`6_%sMeD-g@kntOB{ zkaz4gm@DCvG2*upu=T+&>k%rnP{l+(LN?TriI#|t2c?WjOSsdk`K9_uMT$2$A!p+> zP-#V%fSsLvZ@E3_1Gyc0Hxx}06Bu0sBdH&ZDMCuP&Q{7qfI?9v>2C9NhAitFO$7Km>2!? z<=fcV-ZFzE_s^~Tuu;)j%k=@^@0aPKS^s3Fs#`bZt=C6*D5km1tM$Qy{l_5#=_ImW z07vl_DbT$Y2{gkF78NOSmsol%RNJ<uod+oZ{!KDfE z|Lpqh0!cLdtE%NVzO^03j(=jf8qJW833}Mu*r%`TXw|mA9A4@pODIC$s0W*?(UlA> zl^-6fU0ig9=uh{Vw#2Avh3w_cu>a}u?>~|?6sFaU8x&g~Q|p9?n;4&@;b&a;=pDS8 zQvc|#yDJtksMZPgZRdPk^+!(c`OYycWFefr?zkb6XL^DX3>^J52WDsiMNm1~S7*7eePRCE9t9ie}hoW+(V>;zg zVw&#b>D1i_*`15Lj5 z!Y&=*`HzS(W3c-RGkls&xEj9`mIrsw7FaNmVF=9h;oAuQ`$bcL8$OAiveXsW@{I*s zMs?eiDJ5>x17DrNPI(p>v_sC;f)~}Ti=dkziGcSwT;{eQ1|AECP3u48z1`FHy|hqz z_XvxO)imBlEOI40=m=rkpi(ByaFy$seXaod+!+~-lA2O}ue%s)(_xuh0_cx z3EK-zG(qI^GVvWllqt?}jlV)BTI(2ZI|aqrzCzL60Lp7jV}8CDi6)Os2_Fr77;eLD z{0sJX&^e;3@e7p3xH*?imQ;mV&tOdodnx?bcY&X1S7ryRo2e|9T`2B71kA`d^#WIy z5@Lmsr?R2QrSv&3iv2`?g(6j%dT2yVja--Fcd#^b^xzixSxAheJ+l{Y>VbTvtQhS8 zbyrT=BULNI$dAgrcq}hTEO3S=H>3*S>R6sYAjY}EY0>5%VJIfQO{J^{fki^?8b>k3 zzKQai|3lSRhDFst-2yYfz|cr{*H9weji8h$-2&3x-JJrWAe|y5(h@^RNp}xOcX!<5 z`#s;i&;85UbA~f@_F8N2wPN2_Na)3`qau9##lUH@?-e_oN00QFzW3x9SQCYe;8TWH z{MgDXZq5n4ZShuYr;x&Q;vXP*fLJv8#S!$qSi%WfE~VjIai&3t(b8CWUAx4&$@xdT z?AYo+d04c(y%*}OHAnkv1WD91HZr88xS*NCk}9!X1kk)`niB z?=I=5NHDIMI}-W~lxJpRL~uWZ2?7r+S@0+!Hg7QjW!iVvDI_f5LNniqQ2Y^Q?b8n3 zmGlXdP?hs9J49G9MKD*WJKKtzLs%;R+II= z;G|v^yJ9nWE?|-z#|RDlreW1|Rwsn~Q;Hz+y-D424ZGaujju>sNjxaW0&bWNBU zG2;ONi2ho&f=2k^36DLQA2K;m5ruCo^jr#1qKbwF;4$8vM-FIiyqxouAq zCnbnX*$*VTVoszXiYHByj8rv!J)2A>*debWZNDwqt3^b(by|R*5Zpv{Ya-;NV>ab` zW}yK)Bs`mry?3eZqKSxr20z2;^Z;W$kpY|K-Ewp0zEt{NmZ|iQ ztG>E;ZoTQGI{CCKECna~&KN`+KjL7PD?UjL00T1qXxSa>1Bu>tt#O$jNmRiGJdZky_^ zxtgf>4LN1CV-Mwd(R@2=wE->4<+fj|;;v7MMkrHlDY|hXkCH0jLssp&HC*yOk!FOq zm-0=Xl(RGM)5FnVSwU}HwswZGSHaBQLoPEeCBIE-d1>hfJj61f{Y+dN%JFZABdB4I zu|o%?@bULBBZc(v2vmaM>zDX8co-ew>oQ8D)u`YWxJC+8q29L9(XlBDy-^+MUO>Fab{C86sdy~BW@?OeV@pr^vm=tseD zEJn5M2NdXimJ56o0xuQ~N4vrK-sTNBuBfh~c^H9ho7%x3zw5xl>iJ z+&zNZ9zVXRP-MW zonNF**+GBRlCz>s&_X^#0=l_k18$%n!cE9RrXT^x#c0<0$Zs#g7@uT$kl})mY?Mb_ z3$g3Ah1_mQ9V&sx!pGrS6}+s=ovD>xSK`}n~<<~2V2J$Ue{j}YCG`pg}H)@pP$#)a$v~O>6Q%S0u@933Srpq zwVujHqXe}tY`wR#(hk&=`Jk7VuB;bZ3pGftFQr+=ew&Isb#NG`N7qfb?xQ$~>-$-e;}WXa4rlm2{c|u?_|BsLH(hrt9@Lsy^nw&&gI_nR52-PL=Pto{#y8d1n(N zXs&R&zEuR_tzlNp+?l&Cn3Rey1JNxlK>Yi4jx3IF;q-Tn!5^3alD-P(()G*;ej!_t zl9KN78zC*rPGRsZrP8ov{HL`hp;~qcVfD1t6fqG|_zxQn+9JP|AAj%^V9rbKGr=w^ zQ{*yHWu*oLyrK9@B2poEI4Tvq$=k~Ni){~i_*bR#4I`{OGgpobz#@t&sw!Tm+c4Gz z#o2_h;35mf4sKTJkH()bepOGJJR>5i@xQxd(i|WIQwR%^?vll8LUswnYgVbX&O1xc z8-?9f1Ee1Zrpjl$fIHi-)D+35`-wWoqqd#)$J@Qa)vm}y>+!<=a8~2P&r{!RtMKSI z6@FmX#il;L2B(0ccFL!oYjUPN5+8>LL2=xCagabhG|Rrb<0}E>ms0bKO|HUsS*`+y z3oTW$h&ljrblEMmy@RYW|4NNy_JIRv=St?_@AOl4xm7v8fF-bBLl+1rEmLhLIf)Xx zY+UTrB>VF~2xVXn5On#_)6-+G;XJxBUHuhJ_NxgDSRnkSwU=&1sXYU^)~>- zN_WD_MIF~cpY$`x{E{wGQ&|l@AQD*j0Jkkw7^SnYj7B3-t!mXf7bT}#xw9&F%Q4Z%A+OH_~u=s(i zG?x>M2_uz)c4L*2VZ{Tz^%&D6k{+$4)R4)C_rPNbOmT8i&Cn*XA`~L+?<|L{hsvCb35{*cWA272N?ut?+PwC9hi;31Sf$xWEyTASMm< zxq6pyW*8h<_ckCz!V_l{tIps}tWBHtR};Ag%SpHY`R{0|8}Z=iK`e*?5k{6gxocW* zqPC_idx%v~ozA)RaixSLUMyXL3#f)treYw?Y)qkrVm^FIFZNB)P;;4 zMJKMn`y-3t%>m{MCa|lgyT)Rg=1sf-B_@4C8~xP*Yqfu^+`Vxzp4S)_T$;1VevDn} zPd@dVJU{kdhfDdt9j?hI3HI*IH((Z&HyRLoHa3aV0oJm<+de>F))+|v_nF;6~)@Q}vRujh7ny6Ns~B`>2t zSy1|XSR*4bQfi39iiwTY{o%!{7I1>Pq^x{x<*W9~DP zQug>vwmkOtcNggG(1H8ro++=>{U73)pLMXDe!}~?m8i$=s7J1Cx_CQ=1C|~D-G1bvsEMQEzXU&}*cPIv0uq<=`IK{{q zI%rteD1TJM(1@Su_-)2c>Lyck_d!Bx1hUJTNQ-OH?-RV!!DE7}9)&!^3UJP)ZTk=rz4;JD5A=@P;%41ZEaKE7mZ^?Me^@2+ z@%nX@^cZH#{=U^VJ%fg9X}mLHtJe6mf<~Fp!@+7gk0>4VzUNK(i2n!pV!^FuEvEO` zY2|xStESC}|6H}BGs(e|Ur8Oahmb*j(|ge{T^gCRa@EnylC2+VrdsGzXEy2Fzn%%? z2%*5g&s(^qI>tUG42gyWC>}>9c=S#1`yo?Cn@EJrLE1W}56SxNArW*sl`FpWT#`hr z3f07LdPWkHPfhy*bQxio*0I87Y`INs;q&E9LJu{T(XL#pLx9FD|Lq&oP*P{A&Rf&B!A1h1s9&s-?2N{S9aJ zG%6)s0;k5BQ7B`9tg+V%!gw{u)en~OzL{Wu2t8#%ujfN0(rkdjjTjF!KqeTh9A4#n7`k+KCQLz^fCTb3Rtno28;dlMX5BaEM< zWC!-7FB zaq>0-)b&=|5YnhXM5f!qL0UpvzYjk8Q)7|Pr7R|_|@!v zFanja3WeK*7we@l*tSMDsHav*#GH=|t`7FECJXMFn*D>CZhk_Zk}&&9#)*wbDKgMa z`uKUs&Fm|A9u#R@yC3X77pGlY-De+DV)0Tbf|d;Y3Ya0Jd}Q+*sv*Pi3tHD;RGdT{=)I9p z@+TSiLX4jVm05oLmByi65u@WiQ)NtZ6j4K9socmj?nBNFIOhKA%`}KKUo@Oapl(5NQvoT8OfL3{t%F1BL&qMh~NMubV_aA;bvvP>Kh;MW#Ogu-PFe zTrWhg3rpL8RmYaG4bx z)(xw|m&@`_s3?hDbw~*5V`PC5@Zu5lfYl}I4$@!JaU#;@fRlpNdm+X?9P+YkL3S|aLG(`p9^%85hQK?(94kxYeP0rQ%EWH^7#7vFRy}*79GU)EjLMg?l?Ve} zb4jX8BOd+7;~y^#E%HgQYNQZIql_lBDNuD|hwvd!B`yVBV&5P-hy-H>6YDHy7S^Bc z&74y2ZB>qA!PGRr9}*Je8+sWe;aA9M&yQ?cpHP*%Crj&k>YA6P*hny&0#_cB55L1k zE)Q1Gt^7_;SnkiKv=?=oBxhOLB$b84_hTq9fcIvQG?$f-9~5@C^57q`*hlw8{9zajXoRx{%1BWkDSp7Cc&(#t%GlsN#Q9VDb070wqYaCMc=-TA6ETtSlS0 zq>SZ(Zm4kqQzz4r!=?A>sZQF?{hMz58#T;1f&O)Vwie`07ICD!`3-oToJIF0onaV~ ziseS3a6DP1#%|ClOVUy3J$Riy$*8^V3&W}t#z&@EegplAHr+OC)A$!aor+Q;W0?A; z(13uz34gxrhslh|1awklm2h%@Ndl(d$q5~I`Bb~H*W_671Psl*A@~4Bb2gC^{LQmw z%k#o6Zu>W@f**E7L^S>qX>U{&e6*S;UtjINgIICf(|mEjBQGcznlGL)w4up9bVoUe z|0`2(=gD7?`d2oI8@DaM^RKKX9)Aff26zHG0p9$D4qo73HxO@2fuZ16pv(fcrCh)S z=O9H!Iv+_()#6!j^{&a)#hKAN}B=54nUk z80x#S=BPD3FDi8>OM( z9RPCHG$-dhKJB@@2I7Xi$c0!CpT7q4>fA%?y5A9Y#6P);U_5Q%I1!C1ALW!tCbnpZ z19F4A43Pef&0UCvJ!^uzztGGf$JeL=?=F32aI4EB=MRX5M0Z?r~*xo)=U4B zC^7ugtle)*wh-qIvgS)s4a41mnnp;b_1jb-(z@L%W+?!1#^T&Asm`qF*Sv#!>YV@H z^aOJwF`U;iL$XoRQ6jg~T4M1RLHDm4?l8brdm~#W;40*sjum{d&>~+$?6hS7zv_Lht{w*o4c)BYYi^<@H zyu3z|Uy#i``?Ny|gMS{y{Ix3};^2AW|JebvBJih_q-%JI4B zR}tsmNpzHB^_+n4|6Q*>4l41OQICo$mXt|SI~WSJ5I10+${qcH(4^Owny|Wg*Bn&L z1WWnCtf8l;tf8S1Kktvks^IeZuNPFk^y*XIBD9KbC%TZLI#&j}iiz&#e`f(wx`LiW zhQ%tL4#E+*iaA|#_PB*eFFytOJV5G26JqmTefa8rJ1>g-l6z_S8`=0E>B8#|+z=QQ6RF7@(rl9ss&Qq+7nVg^xV~L>3Q=@)E zCCjV6?4-pKwH!=TBfkwI=2pSzKkX|%F&yp3mjFg1!I2W}$`|MsB+0f;PI9vGlMw@E zimi@wrGHvaMC9kw6Laf!0<$x(UcR(GT6}2oXM5VH`nRQJ4=h2yp=^FXd+k?7R6`oO z?qv5H30mz{Nl@~dI%!|%Fxa@URm0Yr6-F)ZlIn2e2g@!i{#ZuJA4UA9ghGi1d}My+ z3CK_KH!evo)U-X$S!m}n7?u_}Lv9Fh7@8R$)ochtgt0Y5&Hrv;liytoet(!ria1urR02 z4`v}>nyD^B#6+2Nvz^y4mVp3nvWnyYednFSV_~g0qrPvQt#~k> zJidY4X8hPE;rR=~Za-n}D4mR_&K{ydY~0THrF$0aunRo|7R#Lcj}7CLM^kK`dBLq!4~# z{3YksO)t7)eEFYvwg?RwvVC)n*qHCMKd9@zsegC$PaVqMe^sHh5C4XLhXJ8pB2IIf9T z`r6F+w8*C~INNAQ;WBnH!Id3KCg`I^y=YZ(r;w0v0B!PMWk#y6h;CVN57w!i(p97B zB)EA0k$c|n?9Uidj{jY*`dPn9M;7fxI#S@SKW>UX-eN*b%69ZFhQc~wY+=g>)FMT3<;~^6oTmk6UBz^1!oq6*wO8?#WH5Kz6Y?PDk!Qfk zT2GeKT6A{EeF)d}LsHtBN6SPw-X|3{N9M-9?2li+Qo&|h>pz5$`_1Jg;v#z#bXRg# zqqid!7szpDIM!BvKzY&oq$|2W5#s>KR!G+kSsf+6kkyRAB&*es`5Lj?d?(T1l{zA{ z?wR|AGURmZ-3E76+*qknL=;-Le;{&!JCFuDWv7+oI#lCDFn}#47mKcLoIaogqV8Uk zEOpT2shkeT{HFB1@J~=Skep@+M{T^A)+fY-Vxkwc9baHZZY+=xMUqXP4xwh-rgW%O zwNlq3P$=CeH2^j08X!z~-=>v=$^|rIPN3+lu@fvN`o~Z%*4TY1Os-U#_o1f;*gfpv zmLP{IuVsPz#|eY`^pk*rK!+kZV<+iWW5$roFoceYO(E{3E-MS&HR($VMcFU(*UHmwn{DkmN6nid0ul@Q{rQubDVeO?GVn*pOk%+z4j|JqI?Vp|M`nA>Tf6hh z3)&fQX)iZA|E-s=8Nkv4_rxf19Lsb6k$ITU!nSbs-$Ld%fjaP|nzxAyNCJ5C>_NlK zhwhl-n2^T+oxcjioU35{HC>(3iIZ5-td{bc27tiG{y`5q2Ejw`Oel9}s>FyL8Fu0v zcTJsCLF3hA7)p%9Aq&Ywax=X>I$2>u^a%Tc=@2o5>FKc0g*al2RuW;N0n=Ua<6buXu5W7+ zi_?2Q`rw`?V|TYx3nA)zHr7UEWjA=rvOEsv)3Tj9F&dhe4p(4T<&QNzE_< zvnq#LL?#(9EQqqv7Xd^aZGuscQim_-~imrQK<$3r{t4 zkWMeRDuBHqd5pLEi)lYRmYN&2O<_)LVZFg4^6PJ$&Czl;7MLU+TcqXX;l&*h@}{PA zO?R$=DVoHXbb9#;8^Ca3EC9Y~SUo#YSxasmuVs{BJ`6XRIP%C$dXc%Cuuwx{EA*5a z$ZwD*Lq>!lU0b#2K-FHXD-4;q0Hv!T7v-COvH4KQoV}RNM)46-UdRYX%oh{tAN%(T zse^?KHub6-iPZ;Ht}ex5*Y~a?ED#NGbNBufCY|u`wz0^+!D_+AlY_Yz_n?j3U>vJT1-eSj{3EwDe8<|D8Wi+ zNGG>s#y$LXqQvb;$J1HTpKS5W>+5U#(qxD8xF3|XEF2u=nf42Um~@paVtbxmRFQFH zSkf4jNIo<|`YpuwydMN6k_!E@jSQo#bt)<0dF)~UH7Jr9Cfi(jh-y zTrD^@RTPew66IV!!oK#u*`=xdw@-SsSJhs58J`&E-Tk-!4E&W{97yJTOUV4HF>oYX z{6Iru-Lb4!QZ?eYZ0@#$>@fyALn5Dm19OTXK5S;8qVI>6Yl{sT9!$=K z<(o=7p~Vm}Z4;WtyOmz0O2uezx`7@9!?6(Q9-AZ8l}u_6@sYx5P`341OM-`&gi_N3 zWLf@Lm|b+-u=%y>Y59jiH?{07W0tReKY$px0T%X~j1<0b{Ysi)#caQWoU)X^!A~D~ z^gF{ZoH~YD{*e}4Rqe~Qu2$7A-@E?(7OA%Zw1n zoF{2Y$lnO5h2|L%s(BeUfhWIbs$;n8X$sP(gbhHR#dzIECzQtzZZtCqGtHfK|4saK zxOk%-zK8-a>S@|WFLXSV9oPfo#VpKPpRKG;O-6vxxKzWH^tNwEwV;`)aT z{MEzw*H{9#)=1#%Z~Z^a!SjJ85neye7B`y5& z?MJ|g*==NC;MUX9a`R-YbmZTFEdduB(han)jJ6%=#@8GECwWw*Q$JqaFOs>0Sw%Zv z<#KyYHrsiV>@BQdi6BpZstu5faOW+};|6S-I z)&aSe?Wim5r*kCq?#tqv&y)DaAg}^z3Ipj0KPfr7f}1(kKi;70ca%e%S@(>|hYUdf zbpFQ{U_${?0sP;=4uDkX`j1rL1-OTQyuqXzz&*JB$2|aL*#DJ10A-+mWq1puWA?fK zp1_O{I7rFR<}ULQw1g!400)3A900b~p(YY2+#&Q2N8HylPonr5^${i<_bOcOit47O zzmgy^!8oR=_s@b4W@GSSOl|~ETo6B7#nuQD)1>E$=#%ygta3b|qfp{WrqH~_FOj_A z_)CC{yHbjmi14HZ^?w#&+d#@i&$p{+p8`~>I}*C<-2LS~Fnjj#qfsVGW|G_30+Ey= zI48Vuq_f@3l^*U&-U~u`iEHR7$k>4L5d5jjH(o@FhwS3v#S7wZAJwj;T#-(11j789 z)jpK-jD8Wpf#amsE#PE;DdSAaxFnH| z5JJ5-ht2-3L8cv&?O%P(_s~y*;>DC1A4pZr6 z_$XePTK--EPEW&QY$d`oQeK~|_Y+1f!HgN=W$LyvI8%MC6$ei3KcWq>6yCkojD6nB zk%Rjy+$5b?sRZc;@@%OXB0#TGwbzf@n_s?rjYdzhgj3F~5`O#=|1R$pfU!mwgX|(#fpg_UBubV zBYm2VAD5H}w7a+Wud*AR{Y&WpFbm*egw+~5xre>1aVvhNE2Tb-H)$RnMY@E%b7d3{()4%33=vdc`B)VM1``HH-!`j2@8IgHeUeDa z(38SqDMIjH4F^19eAj=<`QD z-FoY>UoY6$cG^bYQhViF-y8{j+Zk}(y1I&r*IJVT zXyUEgwtsi5-sA!6m*XuNC^ikqT`_++K z=Y>}l=eHocxrGrR94U{~A&WTgcdx|cjql)e&5n6!w8(n9Bhy<(*M!#^##>C(jYQ8Pg%J{{df6-ZJLlpdZ*wUn|=O`NXG zH{eLsv9HXJOU&-j%N6RY^XQOZWm%jmDyy`5i@ghxr_d5T0}TsKEvSM8QarAo0$V^7 z!JRgfGXzSx_gnK|i$C9gANeMbrEcp1!#6!#Bn%MZBeOG(<5%%H?@tH>Ts4qy#@3~^ zJgwE3W-`s4MMu#x*{)k8rdCm4TxiN}R1=gl!;+h`=F9&^Eq&ZMmTJt=sYE-{)fv zK8|DG8yqN*+Qh3#KAiVFKHN!;=F7)Q?eW_%GBWPd2s$hl&wrC7@N4@#*I|U9WXw=!NUq@;3qvjDaZxrwwL$nglo3NBsYJ~*{Nvk%=U%jgv0XK~(d0KU z8F%jl^v6y!Qh|ja68D7x1~0;GxhYdeP*C@CsL`6tvFCgBv4h~AIw@B>;(~kEB1onD zDYxG$Ysw2)WzW0(%#@VzCc_pF{1)ry&*y6`FTT`Ix{g)ACha`(V<*tDV@ii{s6>*| z(``0$Fi9>T3QeHOcv{#MPlII2wwksBfN|S)7U|#g*sajXMX?^ zaER{|esu6`S>gatD{f=id_2%jz6jtL+oS?R)m0s$*A4E^@~UL2k@O==m5AvxqSrB` zh6rk!bdC2y*NG4eb^*EheeRPlW#&Psv#+F4g=osESj_*T#U!uG=#D4tnvcbtwkRn`QSXFjTwOq#3mtgy%fX4<8qa2DM?_%$?@}wlh_+nYn)X zvV~uig_)cPr2V_CZaktB9Yq^Ux8s!d*jWFNw0Ioe<^y6LMNz6Ch-}QZ2(Er5)UwH; z!Kc6_*Mv-rJV0Uw5RGLP&Q8id^$@i}c8W7P&&lEC9j%aJ)3cQzD-U^qt0uN#t0v`l zX$n6rsArl4Q{WO0QCX#&yMpBHIg%23Y<=oq>kr_je@*y8#0TvkQzw2CWxrs&vHr?? zJABLd1HIfu+!Wx$nyjuPN8;`U<{`VTpo>1*yuSzRX)A@|A(nM>^+Uz+nFiiX*{FYe z6Q5jw1f&rl0cPKgE{tNz;=Afsin6(=_Pl@}CsKm6NvDtM{Vl){%CX5=z?^sH18e(U z!EIdl7xy*SAW_BTE!rI{$^-Hx)zZB$tp9_iYdgcEa0 zaH`tCDSwEq`biX$AOmIozTE2z3J46o$ut>q3kv?*88CG&Y|@C>(z18G;$mS zbh0DsIWy<;VWjcz#n?TnbC#QhXc_~L9=~TgHkFx76d$9% zT*-M6ZCs*erDa`Y8YXe_mD^NZ{PO1U7vPm7ZX9r9QRnFAb^aldWrT3DWTV>LcA!;sy}yPm(hIv8mN=Dx%Ls~?D=9$&z{m+xw4_=1YE z^0zpVe{YFu2G8mO5F$1R8{DN0Ys?|t*CfYEHbX8mO(iVFt5rwAS2Y~#koOw&6k-u# zd^42B4@gYUGnoZ1;=Hd{|K&kzWh^(F!2P^;ytf7_0SVkOnI%D2lcqoxxm;-WP{*0*TeK~2TKOg5FaSxx;I zo~;18q$w6=n)&;aO&`T})<3?_DY)wcOm_Pxe`;Cx=u+^M?~!9g?9!Ik7^nf|x9u)r zaCOihn+`xp-wRhpoyG2BKK-uL_960C1YybZ0uzwUA^&9a-@$-v{tuImRs*27;6KpI z41it$lLDX@&{@Ud{|@p1n)=9pV!0!LYv25bYXRtb@n6{kPzL%}rY;F+>K*^ex&;8) z{6AfO77*M)fL8l;^ju1?Lp>0vP;!cL^o+Y!2({F?CxJVF7x4GtYpC~wU7k|aI!7f4 zW1>3*&pX+&C=>owrnPpJhW>_%t~K`omTlbM(va!hhgBW0K69D9)KUxn_wKcq^g3QY ziFdFWskarhfLUdQh#+?bKijx)1Rvu;GG#a;Q9r(tkNL?ru3EzWP@gAOa8=q8g&tDq zSlqG1Uq?M{9}u#%7I$q3#R#(n-FedC1#@=&sy>trBmN_nttXTZmK1s>FGr`${p zGT^${fU|ewi(YoEI@-OKQA`g?`0c5+VDZ*Q50BDJ4wIR3gs{4H$ubV((Qv>^s{*@n3c2H~hVA z(utcOc4Fzhd8Z>5(-V8U+^-oS2P2$ojoY(+V=_8gY-!YUOhlz7H0eJ4*@}qx3_T zr?=F)*!7tfJjJSk1vzqo!Ron06XsFjxanrRtVEOe%D=!eSHW=RAeDAbx{_+gCc3{L zLkJ7NFH_)#_6gqa8=MGR4bx#_%+E#6-BuE{8VWf4iJl0U{0n5dbHG)Z@G6a^cb zolyu#(q7Zp;Lq4g)fn+KG@>27we6CF~2V@V^GsW3*3nc|m4v6+cBtpUN z5x;P;2ckNzSP}Gg77OPIRhD*Ex4tC6z)1GANa74H1u7LN5i+b)DO17KMv%GSPVq^^ zZ~3kG9*t6^RK+cJ2+qIxU=;6;-VQFt_JVgzE12sj#(D2Z6NP~fKMF-h9a6@IO=o?# z+!wD_HyCU!Yg{vdslJ88ovn@Q6I44N>R9%vvs31mk>l%3V?l@q-FB3rhb3_e%>RI& z7Q1~L&HU3clJd8c^>7Pc0oQ7w@)Vbeq{WIWSB(%7amJKOxl`WMn+bFBe}nuIyu2sN z46qZYr-D1D--y`lnacl^_Ui}FMd6R8TU>{OL$>a@6y!1Ucq{(L?=!o*k;e%rUH|Z6 zQNM@+vi8)qw7OGP0?Yxk^ZkW}qds7*;$v`5{skA1xApoINDMfLe&;{y7mEP!elF5% zS;LE5a~=M$(6^=?2ec-!%aR!b-C9Ypuvj^WJY%Sj?{Rw1AN5C~7Vn z0YxLIJd1*Xi0Rwgx-u}ZUxhjF4OK~oKG@670px(LDt%0vve{99|0^*sdmP3oZhyH0 zQoZRHA;w(1(WcXPNBdZ{3W2VC(?%!&w?4NYb|*(8Wm?GiAeu?MQ)VB;pTYz zGCi@OJ?71oTC{|4K~_(B_K=lx6AGPQi9LUB^+ZC7N~P-u@nM}LOe-RpzpPCD$vU)ivB8Bnr{_E%-O?Z$}eNMX@uw&Gye ze0I(MYrH9LL@22TQfyE-5~t_}4>9H%>)X1SuCxR|&KfCT;_C@6=7)+$%tUkR&kj(RrQ1nxM0ACpBWSN(3n6m;Y6IOd9wC0#~6 z3`t*2<|Q?{sJsIRPAev&E~rt36H|nJD)|=dLEhXj{1_L=w`G>}c>X1Imty81t#md29KEB>x zSI1vxT(qR)al|9!_t951Nd#YVj4%=Q!Y|FwU z?p|V0AqwX`^dvY{>2fF&y56$Ux`|L26Yh4RkqpvR|E`W1VcFh^Ghw<+)l!aI%?Jbw zz4{M&y}1|8ph|~iH!Pu%KYEJd>NZNFgQpixymu+&hO4( zJ<)|RR(`N3U^~Ld#Ppz{W1oWD003BBz>4(YwVs|{VcjYnzkootE|9*s8Y~jXxG0G; zh=$c*(mKlThdwCcm?MVuv^q6#&{a)9QzWz)k{DaF7;1rk%p74={VTX-U_%v4vgef3 z&kr@yW^viFpxy_@9&ogwMWiRcS(^hJ~TJc7X zFcI>^Ra4juaxafqLSj37RRSS|GZ-XktsOb1psY7={+ZA6{pDzaLp-(kmm2e40ZK6^ zC;Do>6xZ%piMOIK-9i$z>=+j(d=-5Z+*aTz;cr}?9jZk8jq}k0`x;gd;Xyk8t zRUv|b#`D!~@2skO7-4X7V_*hL5Q|fwZB9*DP zq=Pd-t&L1D_tpF5b15HbRaMpQ@+z+3A+k2`=G=9&sZzH{rIRgY9go=`Qdaie%U)De zRFA{OCdu-uDoM)<|CD2pHe=EsvNwHIlZ zgX0g_cc$cozu>)HA3nkHy5?PzahjI8h!)QKDHG_*o`R*lxYJS{&-YAKN5R%b%N&1? zd1?tiFT!f%?RGu=WK!z~6{kqjL$nZ`><`|HtECMn>(ocdSO|)r!=3fmHC4WY6z%AK z(5^sl4*4%sJ)AUWVU&En_O;w65gJ{~(7TGl_O*xf93$ymfoSJ$H9K#Ki6A1!)XgJV-xP;5{YZio+6I-b)zfvdAE+OZ;KM6 z&Af-CQK!G{3V2z>W`-Fi>a6{Bzq?lwX=-`l=@N^B#}7M_zp)`&^z|LV=hhCEYcHfo z_YTUVlZN2IyH%g!)xRx5&ycH-o+1_&0-#;bVNdft0bA8rz5l1RYyW0D+v4?1xrrto z<592mEiDpMG()|sp|pe1%MGd|v|3V+sOqI5rHjU65FP1g3}dS5HHzLzJX6F_)skKW zO-N`cQ5x-dw{gGx4fp)A*IDbFebzo_f6iLxoV`D1MI~GuXhEhrLJ=*j75icOhw?kC z@kW%7%>fnGol0zw>a~v|BM)@Yp>@(&`w1!IT1DE%{Ua_?H)X%Z?5h`|RfO;^ft`^2 z06a6Q3J52_NVSnUnUQ6zZD}$xuEg7Km=4~e1-Z|;^M9`4BtB$Cb*%i5szfiJyjN9XikRRg8z6P#QL!R6+r6LLzEXVyX6|YD8*BOx`WDCbY@1k~eB_+JcWdbjqjZ z^*AjopTyVGf7SKuXjigO;-e^24H*_DgLK;g_$`b}+-BU!L!aGCLk5ycOQU_hT5h$^ zNVc>7XZ&EIDlw*GmvnQB{bBk~WO@7)_W{eV%$`L4vhZg0wvv)m95dMg`3|+X)?KWH z%*2diT$d!*h`ffWU~tb-6zfIiF1Ek&Fjj3JJl`?@g=CO8lLbabL#Azk+O zs8c}b>s7o@{DA33QLD2sJ}hBYX>VJ$I=wVCb=flgVE#1Z5(S|H<7-Aw6a#WEUd$Vp@Aj{oN4_Qm-ZaFvnRN8o$%W#?9TjukPI~1 zR*fsufB;N22f>3BW4|uMTSk$8K)SGhr|;;vi4t3k}?g-Z3IzKS3^K2ZR^>9KJKpx(m3R5C zp^m7OU)*uoiWnwZ8??&e$Crcz{V$W zKW$p)tz+`2eW50^mzI@QKR>z94&yWVZy%R@zxQRkM=Ta^H?zYKv{tz97QM=Z&xn$h z-YTmO%WC|y;M?NkZ{HUg*2wku?}T_@=d!a%-<`KSm88}Bw5LFAD>h|&pi51#u)?0- z#9S$ONj}b-Fay+Yw=ZuuLhihWP24wV_%EAL9`FRfG!K6nH|W#hN*k~8O7 z$v0TeH?sg)?Kh#BW{{_Rh3SS)}x;H-r~;+8j5i*%R!^Qb1pr*$O2 zVQ{_D1S8QJ2pXIonXm(IeZ%+1yEj;SR=F-_+o2PnH!Pfh6jV^9M5X(`!6KOsu!(o zuf5z)#d4a0?A)>&a7_YefZTkL#mUaYp*ruAbD(DHNv1o{CqYpn<+$gprcjlSh5q#* zEXrmTpv*VC!zdVO%nZtR(7%@9_?R1kpegcPlJ0dkgc+9R7FHlZ<9grfwGZ6&CK$ms zBNO&b0=K-?UAJ_jVKn5d!M@FKvJ({g>Avk{m_Tsk10ttw4^nC~5a!_hZSxRVyghue Jjqdo&{{gTM17rXI literal 0 HcmV?d00001 diff --git a/doc/developer/index.rst b/doc/developer/index.rst index 6f0dbebdfd..f1a39d2828 100644 --- a/doc/developer/index.rst +++ b/doc/developer/index.rst @@ -6,5 +6,6 @@ Welcome to FRR's documentation! workflow library + bgpd building diff --git a/doc/developer/next-hop-tracking.rst b/doc/developer/next-hop-tracking.rst new file mode 100644 index 0000000000..1d65956f8c --- /dev/null +++ b/doc/developer/next-hop-tracking.rst @@ -0,0 +1,352 @@ +Next Hop Tracking +================== + +Next hop tracking is an optimization feature that reduces the processing time +involved in the BGP bestpath algorithm by monitoring changes to the routing +table. + +Background +----------- + +Recursive routes are of the form: + +:: + + p/m --> n + [Ex: 1.1.0.0/16 --> 2.2.2.2] + +where 'n' itself is resolved through another route as follows: + +:: + + p2/m --> h, interface + [Ex: 2.2.2.0/24 --> 3.3.3.3, eth0] + +Usually, BGP routes are recursive in nature and BGP nexthops get resolved +through an IGP route. IGP usually adds its routes pointing to an interface +(these are called non-recursive routes). + +When BGP receives a recursive route from a peer, it needs to validate the +nexthop. The path is marked valid or invalid based on the reachability status +of the nexthop. Nexthop validation is also important for BGP decision process +as the metric to reach the nexthop is a parameter to best path selection +process. + +As it goes with routing, this is a dynamic process. Route to the nexthop can +change. The nexthop can become unreachable or reachable. In the current BGP +implementation, the nexthop validation is done periodically in the scanner run. +The default scanner run interval is one minute. Every minute, the scanner task +walks the entire BGP table. It checks the validity of each nexthop with Zebra +(the routing table manager) through a request and response message exchange +between BGP and Zebra process. BGP process is blocked for that duration. The +mechanism has two major drawbacks: + +- The scanner task runs to completion. That can potentially starve the other + tasks for long periods of time, based on the BGP table size and number of + nexthops. + +- Convergence around routing changes that affect the nexthops can be long + (around a minute with the default intervals). The interval can be shortened + to achieve faster reaction time, but it makes the first problem worse, with + the scanner task consuming most of the CPU resources. + +The next-hop tracking feature makes this process event-driven. It eliminates +periodic nexthop validation and introduces an asynchronous communication path +between BGP and Zebra for route change notifications that can then be acted +upon. + +Goal +---- + +Stating the obvious, the main goal is to remove the two limitations we +discussed in the previous section. The goals, in a constructive tone, +are the following: + +- **Fairness**: the scanner run should not consume an unjustly high amount of + CPU time. This should give an overall good performance and response time to + other events (route changes, session events, IO/user interface). + +- **Convergence**: BGP must react to nexthop changes instantly and provide + sub-second convergence. This may involve diverting the routes from one + nexthop to another. + +Overview of changes +------------------------ + +The changes are in both BGP and Zebra modules. The short summary is +the following: + +- Zebra implements a registration mechanism by which clients can + register for next hop notification. Consequently, it maintains a + separate table, per (VRF, AF) pair, of next hops and interested + client-list per next hop. + +- When the main routing table changes in Zebra, it evaluates the next + hop table: for each next hop, it checks if the route table + modifications have changed its state. If so, it notifies the + interested clients. + +- BGP is one such client. It registers the next hops corresponding to + all of its received routes/paths. It also threads the paths against + each nexthop structure. + +- When BGP receives a next hop notification from Zebra, it walks the + corresponding path list. It makes them valid or invalid depending + on the next hop notification. It then re-computes best path for the + corresponding destination. This may result in re-announcing those + destinations to peers. + +Design +------ + +Modules +~~~~~~~ + +The core design introduces an "nht" (next hop tracking) module in BGP +and "rnh" (recursive nexthop) module in Zebra. The "nht" module +provides the following APIs: + ++----------------------------+--------------------------------------------------+ +| Function | Action | ++============================+==================================================+ +| bgp_find_or_add_nexthop() | find or add a nexthop in BGP nexthop table | ++----------------------------+--------------------------------------------------+ +| bgp_find_nexthop() | find a nexthop in BGP nexthop table | ++----------------------------+--------------------------------------------------+ +| bgp_parse_nexthop_update() | parse a nexthop update message coming from zebra | ++----------------------------+--------------------------------------------------+ + +The "rnh" module provides the following APIs: + ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| Function | Action | ++============================+==========================================================================================================+ +| zebra_add_rnh() | add a recursive nexthop | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| zebra_delete_rnh() | delete a recursive nexthop | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| zebra_lookup_rnh() | lookup a recursive nexthop | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| zebra_add_rnh_client() | register a client for nexthop notifications against a recursive nexthop | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| zebra_remove_rnh_client() | remove the client registration for a recursive nexthop | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| zebra_evaluate_rnh_table() | (re)evaluate the recursive nexthop table (most probably because the main routing table has changed). | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| zebra_cleanup_rnh_client() | Cleanup a client from the "rnh" module data structures (most probably because the client is going away). | ++----------------------------+----------------------------------------------------------------------------------------------------------+ + +4.2. Control flow + +The next hop registration control flow is the following: + +:: + + <==== BGP Process ====>|<==== Zebra Process ====> + | + receive module nht module | zserv module rnh module + ---------------------------------------------------------------------- + | | | + bgp_update_ | | | + main() | bgp_find_or_add_ | | + | nexthop() | | + | | | + | | zserv_nexthop_ | + | | register() | + | | | zebra_add_rnh() + | | | + + +The next hop notification control flow is the following: + +:: + + <==== Zebra Process ====>|<==== BGP Process ====> + | + rib module rnh module | zebra module nht module + ---------------------------------------------------------------------- + | | | + meta_queue_ | | | + process() | zebra_evaluate_ | | + | rnh_table() | | + | | | + | | bgp_read_nexthop_ | + | | update() | + | | | bgp_parse_ + | | | nexthop_update() + | | | + + +zclient message format +~~~~~~~~~~~~~~~~~~~~~~ + +ZEBRA_NEXTHOP_REGISTER and ZEBRA_NEXTHOP_UNREGISTER messages are +encoded in the following way: + +:: + + . 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | AF | prefix len | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . Nexthop prefix . + . . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . . + . . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | AF | prefix len | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . Nexthop prefix . + . . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + +``ZEBRA_NEXTHOP_UPDATE`` message is encoded as follows: + +:: + + . 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | AF | prefix len | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . Nexthop prefix getting resolved . + . . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | metric | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | #nexthops | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | nexthop type | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . resolving Nexthop details . + . . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | nexthop type | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + . resolving Nexthop details . + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + +BGP data structure +~~~~~~~~~~~~~~~~~~ +Legend: + +:: + + /\ struct bgp_node: a BGP destination/route/prefix + \/ + + [ ] struct bgp_info: a BGP path (e.g. route received from a peer) + + _ + (_) struct bgp_nexthop_cache: a BGP nexthop + + /\ NULL + \/--+ ^ + | : + +--[ ]--[ ]--[ ]--> NULL + /\ : + \/--+ : + | : + +--[ ]--[ ]--> NULL + : + _ : + (_)........... + + +Zebra data structure +~~~~~~~~~~~~~~~~~~~~ + +RNH table:: + + O + / \ + O O + / \ + O O + + struct rnh + { + u_char flags; + struct route_entry *state; + struct list *client_list; + struct route_node *node; + }; + +User interface changes +~~~~~~~~~~~~~~~~~~~~~~ + +:: + + frr# show ip nht + 3.3.3.3 + resolved via kernel + via 11.0.0.6, swp1 + Client list: bgp(fd 12) + 11.0.0.10 + resolved via connected + is directly connected, swp2 + Client list: bgp(fd 12) + 11.0.0.18 + resolved via connected + is directly connected, swp4 + Client list: bgp(fd 12) + 11.11.11.11 + resolved via kernel + via 10.0.1.2, eth0 + Client list: bgp(fd 12) + + frr# show ip bgp nexthop + Current BGP nexthop cache: + 3.3.3.3 valid [IGP metric 0], #paths 3 + Last update: Wed Oct 16 04:43:49 2013 + + 11.0.0.10 valid [IGP metric 1], #paths 1 + Last update: Wed Oct 16 04:43:51 2013 + + 11.0.0.18 valid [IGP metric 1], #paths 2 + Last update: Wed Oct 16 04:43:47 2013 + + 11.11.11.11 valid [IGP metric 0], #paths 1 + Last update: Wed Oct 16 04:43:47 2013 + + frr# show ipv6 nht + frr# show ip bgp nexthop detail + + frr# debug bgp nht + frr# debug zebra nht + + 6. Sample test cases + + r2----r3 + / \ / + r1----r4 + + - Verify that a change in IGP cost triggers NHT + + shutdown the r1-r4 and r2-r4 links + + no shut the r1-r4 and r2-r4 links and wait for OSPF to come back + up + + We should be back to the original nexthop via r4 now + - Verify that a NH becoming unreachable triggers NHT + + Shutdown all links to r4 + - Verify that a NH becoming reachable triggers NHT + + no shut all links to r4 + +Future work +~~~~~~~~~~~ + +- route-policy for next hop validation (e.g. ignore default route) +- damping for rapid next hop changes +- prioritized handling of nexthop changes ((un)reachability vs. metric + changes) +- handling recursion loop, e.g:: + + 11.11.11.11/32 -> 12.12.12.12 + 12.12.12.12/32 -> 11.11.11.11 + 11.0.0.0/8 -> +- better statistics diff --git a/doc/developer/next-hop-tracking.txt b/doc/developer/next-hop-tracking.txt deleted file mode 100644 index 12ed63947b..0000000000 --- a/doc/developer/next-hop-tracking.txt +++ /dev/null @@ -1,326 +0,0 @@ -0. Introduction - -This is the design specification for next hop tracking feature in -Frr. - -1. Background - -Recursive routes are of the form: - - p/m --> n - [Ex: 1.1.0.0/16 --> 2.2.2.2] - -where 'n' itself is resolved through another route as follows: - - p2/m --> h, interface - [Ex: 2.2.2.0/24 --> 3.3.3.3, eth0] - -Usually, BGP routes are recursive in nature and BGP nexthops get -resolved through an IGP route. IGP usually adds its routes pointing to -an interface (these are called non-recursive routes). - -When BGP receives a recursive route from a peer, it needs to validate -the nexthop. The path is marked valid or invalid based on the -reachability status of the nexthop. Nexthop validation is also -important for BGP decision process as the metric to reach the nexthop -is a parameter to best path selection process. - -As it goes with routing, this is a dynamic process. Route to the -nexthop can change. The nexthop can become unreachable or -reachable. In the current BGP implementation, the nexthop validation -is done periodically in the scanner run. The default scanner run -interval is one minute. Every minute, the scanner task walks the -entire BGP table. It checks the validity of each nexthop with Zebra -(the routing table manager) through a request and response message -exchange between BGP and Zebra process. BGP process is blocked for -that duration. The mechanism has two major drawbacks: - -(1) The scanner task runs to completion. That can potentially starve - the other tasks for long periods of time, based on the BGP table - size and number of nexthops. - -(2) Convergence around routing changes that affect the nexthops can be - long (around a minute with the default intervals). The interval - can be shortened to achieve faster reaction time, but it makes the - first problem worse, with the scanner task consuming most of the - CPU resources. - -"Next hop tracking" feature makes this process event-driven. It -eliminates periodic nexthop validation and introduces an asynchronous -communication path between BGP and Zebra for route change notifications -that can then be acted upon. - -2. Goal - -Stating the obvious, the main goal is to remove the two limitations we -discussed in the previous section. The goals, in a constructive tone, -are the following: - -- fairness: the scanner run should not consume an unjustly high amount - of CPU time. This should give an overall good performance and - response time to other events (route changes, session events, - IO/user interface). - -- convergence: BGP must react to nexthop changes instantly and provide - sub-second convergence. This may involve diverting the routes from - one nexthop to another. - -3. Overview of the changes - -The changes are in both BGP and Zebra modules. The short summary is -the following: - -- Zebra implements a registration mechanism by which clients can - register for next hop notification. Consequently, it maintains a - separate table, per (VRF, AF) pair, of next hops and interested - client-list per next hop. - -- When the main routing table changes in Zebra, it evaluates the next - hop table: for each next hop, it checks if the route table - modifications have changed its state. If so, it notifies the - interested clients. - -- BGP is one such client. It registers the next hops corresponding to - all of its received routes/paths. It also threads the paths against - each nexthop structure. - -- When BGP receives a next hop notification from Zebra, it walks the - corresponding path list. It makes them valid or invalid depending - on the next hop notification. It then re-computes best path for the - corresponding destination. This may result in re-announcing those - destinations to peers. - -4. Design - -4.1. Modules - -The core design introduces an "nht" (next hop tracking) module in BGP -and "rnh" (recursive nexthop) module in Zebra. The "nht" module -provides the following APIs: - -bgp_find_or_add_nexthop() : find or add a nexthop in BGP nexthop table -bgp_find_nexthop() : find a nexthop in BGP nexthop table -bgp_parse_nexthop_update() : parse a nexthop update message coming - from zebra - -The "rnh" module provides the following APIs: - -zebra_add_rnh() : add a recursive nexthop -zebra_delete_rnh() : delete a recursive nexthop -zebra_lookup_rnh() : lookup a recursive nexthop - -zebra_add_rnh_client() : register a client for nexthop notifications - against a recursive nexthop - -zebra_remove_rnh_client(): remove the client registration for a - recursive nexthop - -zebra_evaluate_rnh_table(): (re)evaluate the recursive nexthop table - (most probably because the main routing - table has changed). - -zebra_cleanup_rnh_client(): Cleanup a client from the "rnh" module - data structures (most probably because the - client is going away). - -4.2. Control flow - -The next hop registration control flow is the following: - -<==== BGP Process ====>|<==== Zebra Process ====> - | -receive module nht module | zserv module rnh module ----------------------------------------------------------------------- - | | | -bgp_update_ | | | - main() | bgp_find_or_add_ | | - | nexthop() | | - | | | - | | zserv_nexthop_ | - | | register() | - | | | zebra_add_rnh() - | | | - - -The next hop notification control flow is the following: - -<==== Zebra Process ====>|<==== BGP Process ====> - | -rib module rnh module | zebra module nht module ----------------------------------------------------------------------- - | | | -meta_queue_ | | | - process() | zebra_evaluate_ | | - | rnh_table() | | - | | | - | | bgp_read_nexthop_ | - | | update() | - | | | bgp_parse_ - | | | nexthop_update() - | | | - - -4.3. zclient message format - -ZEBRA_NEXTHOP_REGISTER and ZEBRA_NEXTHOP_UNREGISTER messages are -encoded in the following way: - -/* - * 0 1 2 3 - * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | AF | prefix len | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . Nexthop prefix . - * . . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . . - * . . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | AF | prefix len | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . Nexthop prefix . - * . . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - */ - -ZEBRA_NEXTHOP_UPDATE message is encoded as follows: - -/* - * 0 1 2 3 - * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | AF | prefix len | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . Nexthop prefix getting resolved . - * . . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | metric | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | #nexthops | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | nexthop type | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . resolving Nexthop details . - * . . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * | nexthop type | - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - * . resolving Nexthop details . - * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - */ - -4.4. BGP data structure - -Legend: - -/\ struct bgp_node: a BGP destination/route/prefix -\/ - -[ ] struct bgp_info: a BGP path (e.g. route received from a peer) - - _ -(_) struct bgp_nexthop_cache: a BGP nexthop - - - - /\ NULL - \/--+ ^ - | : - +--[ ]--[ ]--[ ]--> NULL - /\ : - \/--+ : - | : - +--[ ]--[ ]--> NULL - : - _ : - (_)............. - - -4.5. Zebra data structure - -rnh table: - - O - / \ - O O - / \ - O O - - struct rnh - { - u_char flags; - struct route_entry *state; - struct list *client_list; - struct route_node *node; - }; - -5. User interface changes - -frr# show ip nht -3.3.3.3 - resolved via kernel - via 11.0.0.6, swp1 - Client list: bgp(fd 12) -11.0.0.10 - resolved via connected - is directly connected, swp2 - Client list: bgp(fd 12) -11.0.0.18 - resolved via connected - is directly connected, swp4 - Client list: bgp(fd 12) -11.11.11.11 - resolved via kernel - via 10.0.1.2, eth0 - Client list: bgp(fd 12) - -frr# show ip bgp nexthop -Current BGP nexthop cache: - 3.3.3.3 valid [IGP metric 0], #paths 3 - Last update: Wed Oct 16 04:43:49 2013 - - 11.0.0.10 valid [IGP metric 1], #paths 1 - Last update: Wed Oct 16 04:43:51 2013 - - 11.0.0.18 valid [IGP metric 1], #paths 2 - Last update: Wed Oct 16 04:43:47 2013 - - 11.11.11.11 valid [IGP metric 0], #paths 1 - Last update: Wed Oct 16 04:43:47 2013 - -frr# show ipv6 nht -frr# show ip bgp nexthop detail - -frr# debug bgp nht -frr# debug zebra nht - -6. Sample test cases - - r2----r3 - / \ / - r1----r4 - -- Verify that a change in IGP cost triggers NHT - + shutdown the r1-r4 and r2-r4 links - + no shut the r1-r4 and r2-r4 links and wait for OSPF to come back - up - + We should be back to the original nexthop via r4 now -- Verify that a NH becoming unreachable triggers NHT - + Shutdown all links to r4 -- Verify that a NH becoming reachable triggers NHT - + no shut all links to r4 - -7. Future work - -- route-policy for next hop validation (e.g. ignore default route) -- damping for rapid next hop changes -- prioritized handling of nexthop changes ((un)reachability vs. metric - changes) -- handling recursion loop, e.g. - 11.11.11.11/32 -> 12.12.12.12 - 12.12.12.12/32 -> 11.11.11.11 - 11.0.0.0/8 -> -- better statistics diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 38cf0b878d..4ab70ac3c5 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -1,67 +1,52 @@ -Developing for FRRouting +Process & Workflow ======================== -General note on this document ------------------------------ +FRR is a large project developed by many different groups. This section +documents standards for code style & quality, commit messages, pull requests +and best practices that all contributors are asked to follow. -This document is "descriptive/post-factual" in that it documents -pratices that are in use; it is not "definitive/pre-factual" in -prescribing practices. - -This means that when a procedure changes, it is agreed upon, then put -into practice, and then documented here. If this document doesn't match -reality, it's the document that needs to be updated, not reality. +This section is "descriptive/post-factual" in that it documents pratices that +are in use; it is not "definitive/pre-factual" in prescribing practices. This +means that when a procedure changes, it is agreed upon, then put into practice, +and then documented here. If this document doesn't match reality, it's the +document that needs to be updated, not reality. Git Structure ------------- -The master Git for FRRouting resides on Github at -`https://github.com/frrouting/frr `__ +The master Git for FRR resides on `Github +`__. -.. figure:: git_branches.svg - :alt: git branches continually merging to the left from 3 lanes; - float-right +.. figure:: git_branches.png - git branches continually merging to the left from 3 lanes; - float-right - -There is one main branch for development and a release branch for each -major release. - -New contributions are done against the head of the master branch. The CI -systems will pick up the Github Pull Requests or the new patch from -Patchwork, run some basic build and functional tests. - -For each major release (1.0, 1.1 etc) a new release branch is created -based on the master. - -There was an attempt to use a "develop" branch automatically maintained -by the CI system. This is not currently in active use, though the system -is operational. If the "develop" branch is in active use and this -paragraph is still here, this document obviously wasn't updated. +There is one main branch for development, ``master``. For each major release +(2.0, 3.0 etc) a new release branch is created based on the master. Subsequent +point releases based on a major branch are marked by tagging. Programming language, Tools and Libraries ----------------------------------------- -The core of FRRouting is written in C (gcc or clang supported) and makes +The core of FRR is written in C (gcc or clang supported) and makes use of GNU compiler extensions. A few non-essential scripts are -implemented in Perl and Python. FRRouting requires the following tools +implemented in Perl and Python. FRR requires the following tools to build distribution packages: automake, autoconf, texinfo, libtool and gawk and various libraries (i.e. libpam and libjson-c). If your contribution requires a new library or other tool, then please highlight this in your description of the change. Also make sure it’s -supported by all FRRouting platform OSes or provide a way to build +supported by all FRR platform OSes or provide a way to build without the library (potentially without the new feature) on the other platforms. -Documentation should be written in Tex (.texi) or Markdown (.md) format -with a preference for Markdown. +Documentation should be written in reStructuredText. Sphinx extensions may be +utilized but pure ReST is preferred where possible. See `Documentation +<#documentation>`__. Mailing lists ------------- -Italicized lists are private. +The FRR development group maintains multiple mailing lists for use by the +community. Italicized lists are private. +----------------------------------+--------------------------------+ | Topic | List | @@ -80,19 +65,31 @@ Italicized lists are private. Changelog ~~~~~~~~~ -The changelog will be the base for the release notes. A changelog entry -for your changes is usually not required and will be added based on your -commit messages by the maintainers. However, you are free to include an -update to the changelog with some better description. The changelog will -be the base for the release notes. +The changelog will be the base for the release notes. A changelog entry for +your changes is usually not required and will be added based on your commit +messages by the maintainers. However, you are free to include an update to the +changelog with some better description. Submitting Patches and Enhancements ----------------------------------- +FRR accepts patches from two sources: + +- Email (git format-patch) +- Github pull request + +Contributors are highly encouraged to use Github's fork-and-pr workflow. It is +easier for us to review it, test it, try it and discuss it on Github than it is +via email, thus your patch will get more attention more quickly on Github. + +The base branch for new contributions and non-critical bug fixes should be +``master``. Please ensure your pull request is based on this branch when you +submit it. + Pre-submission Checklist ~~~~~~~~~~~~~~~~~~~~~~~~ -- Format code (see `Developer's Guidelines <#developers-guidelines>`__) +- Format code (see `Code Formatting <#developers-guidelines>`__) - Verify and acknowledge license (see `License for contributions <#license-for-contributions>`__) - Ensure you have properly signed off (see `Signing @@ -115,14 +112,14 @@ Pre-submission Checklist License for contributions ~~~~~~~~~~~~~~~~~~~~~~~~~ -FRRouting is under a “GPLv2 or later” license. Any code submitted must +FRR is under a “GPLv2 or later” license. Any code submitted must be released under the same license (preferred) or any license which allows redistribution under this GPLv2 license (eg MIT License). Signing Off ~~~~~~~~~~~ -Code submitted to FRRouting must be signed off. We have the same +Code submitted to FRR must be signed off. We have the same requirements for using the signed-off-by process as the Linux kernel. In short, you must include a signed-off-by tag in every patch. @@ -142,6 +139,8 @@ to be a helpful resource. In short, when you sign off on a commit, you assert your agreement to all of the following: +:: + Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: @@ -171,7 +170,7 @@ What do I submit my changes against? We've documented where we would like to have the different fixes applied at -https://github.com/FRRouting/frr/wiki/Where-Do-I-create-a-Pull-Request-against%3F +https://github.com/FRR/frr/wiki/Where-Do-I-create-a-Pull-Request-against%3F If you are unsure where your submission goes, look at that document or ask a project maintainer. @@ -219,12 +218,9 @@ After submitting your changes - You should automatically receive an email with the test results within less than 2 hrs of the submission. If you don’t get the - email, then check status on the github pull request (if submitted - by pull request) or on Patchwork at - https://patchwork.frrouting.org (if submitted as patch to mailing - list). + email, then check status on the Github pull request. - Please notify the development mailing list if you think something - doesn’t work. + doesn't work. - If the tests failed: @@ -253,8 +249,8 @@ After submitting your changes community members. - Your submission is done once it is merged to the master branch. -Developer's Guidelines ----------------------- +Coding Practices & Style +------------------------ Commit messages ~~~~~~~~~~~~~~~ @@ -392,13 +388,12 @@ BSD coding style applies to: Documentation ~~~~~~~~~~~~~ -FRRouting is a large and complex software project developed by many -different people over a long period of time. Without adequate -documentation, it can be exceedingly difficult to understand code -segments, APIs and other interfaces. In the interest of keeping the -project healthy and maintainable, you should make every effort to -document your code so that other people can understand what it does -without needing to closely read the code itself. +FRR is a large and complex software project developed by many different people +over a long period of time. Without adequate documentation, it can be +exceedingly difficult to understand code segments, APIs and other interfaces. +In the interest of keeping the project healthy and maintainable, you should +make every effort to document your code so that other people can understand +what it does without needing to closely read the code itself. Some specific guidelines that contributors should follow are: @@ -440,10 +435,13 @@ used for. - **For new code in ``lib/``, these guidelines are hard requirements.** If you are contributing code that adds significant user-visible -functionality or introduces a new API, please document it in ``doc/``. -Markdown and LaTeX are acceptable formats, although Markdown is -currently preferred for new documentation. This may change in the near -future. +functionality please document it in ``doc/``. If you make significant changes +to portions of the codebase covered in the Developer's Manual, please +update the relevant sections. If you add a major feature or introduce a new +API, please document the architecture and API to the best of your abilities in +the Developer's Manual. + +Documentation should be in reStructuredText. Finally, if you come across some code that is undocumented and feel like going above and beyond, document it! We absolutely appreciate and accept diff --git a/doc/developer/ldpd-basic-test-setup.md b/doc/ldpd-basic-test-setup.md similarity index 100% rename from doc/developer/ldpd-basic-test-setup.md rename to doc/ldpd-basic-test-setup.md From 558669e970a6c8d787c3dee27cce5dd518cb257e Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 11 Dec 2017 16:12:07 -0500 Subject: [PATCH 005/148] doc: add note to document practice changes in docs Signed-off-by: Quentin Young --- doc/developer/workflow.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 4ab70ac3c5..7c5262a738 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -11,6 +11,8 @@ means that when a procedure changes, it is agreed upon, then put into practice, and then documented here. If this document doesn't match reality, it's the document that needs to be updated, not reality. +In short - decisions to change practices should be documented in this document. + Git Structure ------------- From 8ce7861f45ecb9b1bfc3cd2d9f892cf0cbc890a9 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 14 Dec 2017 16:12:26 -0500 Subject: [PATCH 006/148] doc: add clause for documenting Signed-off-by: Quentin Young --- doc/developer/workflow.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 7c5262a738..965d8a1cdd 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -64,6 +64,17 @@ community. Italicized lists are private. | *Technical Steering Committee* | tsc@lists.frrouting.org | +----------------------------------+--------------------------------+ +The Development list is used to discuss and document general issues +related to project development and governance. The public Slack +instance, frrouting.slack.com, and weekly technical meetings provide a +higher bandwidth channel for discussions. The results of such +discussions must be reflected in updates, as appropriate, to code (i.e., +merges), `Github <#https://github.com/FRRouting/frr/issues`__ tracked +issues, and for governance or process changes, updates to the +Development list and either this file or information posted at +`https://frrouting.org/ <#https://frrouting.org/>`__. + + Changelog ~~~~~~~~~ From ab51ead08e1b0211173530f0f8282d758e6db6cb Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 14 Dec 2017 16:12:52 -0500 Subject: [PATCH 007/148] Revert "doc: add note to document practice changes in docs" Lou wrote his own clause so we're using that one This reverts commit 558669e970a6c8d787c3dee27cce5dd518cb257e. --- doc/developer/workflow.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 965d8a1cdd..b5844d073b 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -11,8 +11,6 @@ means that when a procedure changes, it is agreed upon, then put into practice, and then documented here. If this document doesn't match reality, it's the document that needs to be updated, not reality. -In short - decisions to change practices should be documented in this document. - Git Structure ------------- From 863006575665ce2f1ebdaaae972d108886fe4b7f Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 14 Dec 2017 16:15:23 -0500 Subject: [PATCH 008/148] doc: re-add .gitignore, Makefile for dev docs Missed hidden files when shuffling things around. Restore David's makefiles & gitignore. Signed-off-by: Quentin Young --- doc/developer/.gitignore | 3 + doc/developer/Makefile | 216 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 219 insertions(+) create mode 100644 doc/developer/.gitignore create mode 100644 doc/developer/Makefile diff --git a/doc/developer/.gitignore b/doc/developer/.gitignore new file mode 100644 index 0000000000..0505537159 --- /dev/null +++ b/doc/developer/.gitignore @@ -0,0 +1,3 @@ +/_templates +/_build +!/Makefile diff --git a/doc/developer/Makefile b/doc/developer/Makefile new file mode 100644 index 0000000000..056b78e68e --- /dev/null +++ b/doc/developer/Makefile @@ -0,0 +1,216 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." From 42fc5d26696cfa646edd21883d32a520816f5cc3 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 15 Dec 2017 13:16:24 -0500 Subject: [PATCH 009/148] doc: start translating user manual to rst Automatically translated all Texinfo files to RST using a script found on the GCC mailing list[0]. Some formatting manually corrected. Also created index.rst for building as well as boilerplate Sphinx conf.py and Makefile. [0] https://gcc.gnu.org/ml/gcc-patches/2015-11/msg01095.html Signed-off-by: Quentin Young --- doc/appendix.texi | 257 --- doc/babeld.texi | 212 -- doc/basic.texi | 642 ------ doc/bgpd.texi | 2149 ------------------- doc/defines.texi.in | 21 - doc/eigrpd.texi | 216 -- doc/filter.texi | 182 -- doc/index.rst | 0 doc/install.texi | 287 --- doc/ipv6.texi | 186 -- doc/isisd.texi | 432 ---- doc/kernel.texi | 47 - doc/main.texi | 525 ----- doc/ospf6d.texi | 172 -- doc/ospf_fundamentals.texi | 582 ------ doc/ospfd.texi | 929 --------- doc/overview.texi | 337 --- doc/ripd.texi | 623 ------ doc/ripngd.texi | 84 - doc/routemap.texi | 272 --- doc/routeserver.texi | 561 ----- doc/rpki.texi | 256 --- doc/snmp.texi | 189 -- doc/snmptrap.texi | 205 -- doc/user/.gitignore | 3 + doc/user/Makefile | 216 ++ doc/user/appendix.rst | 223 ++ doc/user/babeld.rst | 265 +++ doc/user/basic.rst | 706 +++++++ doc/user/bgp.rst | 2392 ++++++++++++++++++++++ doc/user/conf.py | 293 +++ doc/user/defines.rst | 24 + doc/user/eigrpd.rst | 257 +++ doc/user/filter.rst | 197 ++ doc/user/index.rst | 28 + doc/user/installation.rst | 329 +++ doc/user/ipv6.rst | 229 +++ doc/user/isisd.rst | 641 ++++++ doc/user/kernel.rst | 51 + doc/user/main.rst | 619 ++++++ doc/{nhrpd.texi => user/nhrpd.rst} | 130 +- doc/user/ospf6d.rst | 206 ++ doc/user/ospf_fundamentals.rst | 600 ++++++ doc/user/ospfd.rst | 1280 ++++++++++++ doc/user/overview.rst | 367 ++++ doc/{protocol.texi => user/protocol.rst} | 69 +- doc/user/ripd.rst | 738 +++++++ doc/user/ripngd.rst | 93 + doc/user/routemap.rst | 310 +++ doc/user/routeserver.rst | 18 + doc/user/rpki.rst | 277 +++ doc/user/snmp.rst | 207 ++ doc/user/snmptrap.rst | 200 ++ doc/user/vnc.rst | 1023 +++++++++ doc/user/vtysh.rst | 171 ++ doc/vnc.texi | 1596 --------------- doc/vtysh.texi | 161 -- 57 files changed, 12073 insertions(+), 11212 deletions(-) delete mode 100644 doc/appendix.texi delete mode 100644 doc/babeld.texi delete mode 100644 doc/basic.texi delete mode 100644 doc/bgpd.texi delete mode 100644 doc/defines.texi.in delete mode 100644 doc/eigrpd.texi delete mode 100644 doc/filter.texi create mode 100644 doc/index.rst delete mode 100644 doc/install.texi delete mode 100644 doc/ipv6.texi delete mode 100644 doc/isisd.texi delete mode 100644 doc/kernel.texi delete mode 100644 doc/main.texi delete mode 100644 doc/ospf6d.texi delete mode 100644 doc/ospf_fundamentals.texi delete mode 100644 doc/ospfd.texi delete mode 100644 doc/overview.texi delete mode 100644 doc/ripd.texi delete mode 100644 doc/ripngd.texi delete mode 100644 doc/routemap.texi delete mode 100644 doc/routeserver.texi delete mode 100644 doc/rpki.texi delete mode 100644 doc/snmp.texi delete mode 100644 doc/snmptrap.texi create mode 100644 doc/user/.gitignore create mode 100644 doc/user/Makefile create mode 100644 doc/user/appendix.rst create mode 100644 doc/user/babeld.rst create mode 100644 doc/user/basic.rst create mode 100644 doc/user/bgp.rst create mode 100644 doc/user/conf.py create mode 100644 doc/user/defines.rst create mode 100644 doc/user/eigrpd.rst create mode 100644 doc/user/filter.rst create mode 100644 doc/user/index.rst create mode 100644 doc/user/installation.rst create mode 100644 doc/user/ipv6.rst create mode 100644 doc/user/isisd.rst create mode 100644 doc/user/kernel.rst create mode 100644 doc/user/main.rst rename doc/{nhrpd.texi => user/nhrpd.rst} (67%) create mode 100644 doc/user/ospf6d.rst create mode 100644 doc/user/ospf_fundamentals.rst create mode 100644 doc/user/ospfd.rst create mode 100644 doc/user/overview.rst rename doc/{protocol.texi => user/protocol.rst} (70%) create mode 100644 doc/user/ripd.rst create mode 100644 doc/user/ripngd.rst create mode 100644 doc/user/routemap.rst create mode 100644 doc/user/routeserver.rst create mode 100644 doc/user/rpki.rst create mode 100644 doc/user/snmp.rst create mode 100644 doc/user/snmptrap.rst create mode 100644 doc/user/vnc.rst create mode 100644 doc/user/vtysh.rst delete mode 100644 doc/vnc.texi delete mode 100644 doc/vtysh.texi diff --git a/doc/appendix.texi b/doc/appendix.texi deleted file mode 100644 index 2e1c9deb1b..0000000000 --- a/doc/appendix.texi +++ /dev/null @@ -1,257 +0,0 @@ -@node Packet Binary Dump Format -@appendix Packet Binary Dump Format - - FRR can dump routing protocol packet into file with a binary format -(@pxref{Dump BGP packets and table}). - - It seems to be better that we share the MRT's header format for -backward compatibility with MRT's dump logs. We should also define the -binary format excluding the header, because we must support both IP -v4 and v6 addresses as socket addresses and / or routing entries. - - In the last meeting, we discussed to have a version field in the -header. But Masaki told us that we can define new `type' value rather -than having a `version' field, and it seems to be better because we -don't need to change header format. - - Here is the common header format. This is same as that of MRT. - -@example -@group -0 1 2 3 -0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Time | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Type | Subtype | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Length | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - - If `type' is PROTOCOL_BGP4MP_ET, the common header format will -contain an additional microsecond field (RFC6396 2011). - -@example -@group -0 1 2 3 -0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Time | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Type | Subtype | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Length | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Microsecond | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - - If `type' is PROTOCOL_BGP4MP, `subtype' is BGP4MP_STATE_CHANGE, and -Address Family == IP (version 4) - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source AS number | Destination AS number | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Interface Index | Address Family | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Old State | New State | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - -Where State is the value defined in RFC1771. - -If `type' is PROTOCOL_BGP4MP, `subtype' is BGP4MP_STATE_CHANGE, -and Address Family == IP version 6 - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source AS number | Destination AS number | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Interface Index | Address Family | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Old State | New State | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - -If `type' is PROTOCOL_BGP4MP, `subtype' is BGP4MP_MESSAGE, -and Address Family == IP (version 4) - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source AS number | Destination AS number | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Interface Index | Address Family | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| BGP Message Packet | -| | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - -Where BGP Message Packet is the whole contents of the -BGP4 message including header portion. - -If `type' is PROTOCOL_BGP4MP, `subtype' is BGP4MP_MESSAGE, -and Address Family == IP version 6 - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source AS number | Destination AS number | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Interface Index | Address Family | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Source IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Destination IP address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| BGP Message Packet | -| | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - -If `type' is PROTOCOL_BGP4MP, `subtype' is BGP4MP_ENTRY, -and Address Family == IP (version 4) - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| View # | Status | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Time Last Change | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Address Family | SAFI | Next-Hop-Len | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Next Hop Address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Prefix Length | Address Prefix [variable] | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Attribute Length | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| BGP Attribute [variable length] | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - -If `type' is PROTOCOL_BGP4MP, `subtype' is BGP4MP_ENTRY, -and Address Family == IP version 6 - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| View # | Status | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Time Last Change | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Address Family | SAFI | Next-Hop-Len | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Next Hop Address | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Next Hop Address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Next Hop Address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Next Hop Address (Cont'd) | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Prefix Length | Address Prefix [variable] | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Address Prefix (cont'd) [variable] | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Attribute Length | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| BGP Attribute [variable length] | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - - BGP4 Attribute must not contain MP_UNREACH_NLRI. - If BGP Attribute has MP_REACH_NLRI field, it must has - zero length NLRI, e.g., MP_REACH_NLRI has only Address - Family, SAFI and next-hop values. - -If `type' is PROTOCOL_BGP4MP and `subtype' is BGP4MP_SNAPSHOT, - -@example -@group - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| View # | File Name [variable] | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -@end group -@end example - - The file specified in "File Name" contains all routing entries, - which are in the format of ``subtype == BGP4MP_ENTRY''. - -@example -@group -Constants: - /* type value */ - #define MSG_PROTOCOL_BGP4MP 16 - #define MSG_PROTOCOL_BGP4MP_ET 17 - /* subtype value */ - #define BGP4MP_STATE_CHANGE 0 - #define BGP4MP_MESSAGE 1 - #define BGP4MP_ENTRY 2 - #define BGP4MP_SNAPSHOT 3 -@end group -@end example diff --git a/doc/babeld.texi b/doc/babeld.texi deleted file mode 100644 index 341f692869..0000000000 --- a/doc/babeld.texi +++ /dev/null @@ -1,212 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the FRR Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@node Babel -@chapter Babel - -Babel is an interior gateway protocol that is suitable both for wired -networks and for wireless mesh networks. Babel has been described as -``RIP on speed'' --- it is based on the same principles as RIP, but -includes a number of refinements that make it react much faster to -topology changes without ever counting to infinity, and allow it to -perform reliable link quality estimation on wireless links. Babel is -a double-stack routing protocol, meaning that a single Babel instance -is able to perform routing for both IPv4 and IPv6. - -FRR implements Babel as described in RFC6126. - -@menu -* Configuring babeld:: -* Babel configuration:: -* Babel redistribution:: -* Show Babel information:: -* Babel debugging commands:: -@end menu - -@node Configuring babeld, Babel configuration, Babel, Babel -@section Configuring babeld - -The @command{babeld} daemon can be invoked with any of the common -options (@pxref{Common Invocation Options}). - -The @command{zebra} daemon must be running before @command{babeld} is -invoked. Also, if @command{zebra} is restarted then @command{babeld} -must be too. - -Configuration of @command{babeld} is done in its configuration file -@file{babeld.conf}. - -@node Babel configuration, Babel redistribution, Configuring babeld, Babel -@section Babel configuration - -@deffn Command {router babel} {} -@deffnx Command {no router babel} {} -Enable or disable Babel routing. -@end deffn - -@deffn Command {babel resend-delay <20-655340>} {} -Specifies the time after which important messages are resent when -avoiding a black-hole. The default is 2000@dmn{ms}. -@end deffn - -@deffn Command {babel diversity} {} -@deffnx Command {no babel diversity} {} -Enable or disable routing using radio frequency diversity. This is -highly recommended in networks with many wireless nodes. - -If you enable this, you will probably want to set @code{babel -diversity-factor} and @code{babel channel} below. -@end deffn - -@deffn Command {babel diversity-factor <1-256>} {} -Sets the multiplicative factor used for diversity routing, in units of -1/256; lower values cause diversity to play a more important role in -route selection. The default it 256, which means that diversity plays -no role in route selection; you will probably want to set that to 128 -or less on nodes with multiple independent radios. -@end deffn - -@deffn {Babel Command} {network @var{ifname}} {} -@deffnx {Babel Command} {no network @var{ifname}} {} -Enable or disable Babel on the given interface. -@end deffn - -@deffn {Interface Command} {babel wired} {} -@deffnx {Interface Command} {babel wireless} {} -Specifies whether this interface is wireless, which disables a number -of optimisations that are only correct on wired interfaces. -Specifying @code{wireless} (the default) is always correct, but may -cause slower convergence and extra routing traffic. -@end deffn - -@deffn {Interface Command} {babel split-horizon} -@deffnx {Interface Command} {no babel split-horizon} -Specifies whether to perform split-horizon on the interface. -Specifying @code{no babel split-horizon} is always correct, while -@code{babel split-horizon} is an optimisation that should only be used -on symmetric and transitive (wired) networks. The default is -@code{babel split-horizon} on wired interfaces, and @code{no babel -split-horizon} on wireless interfaces. This flag is reset when the -wired/wireless status of an interface is changed. -@end deffn - -@deffn {Interface Command} {babel hello-interval <20-655340>} -Specifies the time in milliseconds between two scheduled hellos. On -wired links, Babel notices a link failure within two hello intervals; -on wireless links, the link quality value is reestimated at every -hello interval. The default is 4000@dmn{ms}. -@end deffn - -@deffn {Interface Command} {babel update-interval <20-655340>} -Specifies the time in milliseconds between two scheduled updates. -Since Babel makes extensive use of triggered updates, this can be set -to fairly high values on links with little packet loss. The default -is 20000@dmn{ms}. -@end deffn - -@deffn {Interface Command} {babel channel <1-254>} -@deffnx {Interface Command} {babel channel interfering} -@deffnx {Interface Command} {babel channel noninterfering} -Set the channel number that diversity routing uses for this interface -(see @code{babel diversity} above). Noninterfering interfaces are -assumed to only interfere with themselves, interfering interfaces are -assumed to interfere with all other channels except noninterfering -channels, and interfaces with a channel number interfere with -interfering interfaces and interfaces with the same channel number. -The default is @samp{babel channel interfering} for wireless -interfaces, and @samp{babel channel noninterfering} for wired -interfaces. This is reset when the wired/wireless status of an -interface is changed. -@end deffn - -@deffn {Interface Command} {babel rxcost <1-65534>} -Specifies the base receive cost for this interface. For wireless -interfaces, it specifies the multiplier used for computing the ETX -reception cost (default 256); for wired interfaces, it specifies the -cost that will be advertised to neighbours. This value is reset when -the wired/wireless attribute of the interface is changed. - -Do not use this command unless you know what you are doing; in most -networks, acting directly on the cost using route maps is a better -technique. -@end deffn - -@deffn {Interface Command} {babel rtt-decay <1-256>} -This specifies the decay factor for the exponential moving average of -RTT samples, in units of 1/256. Higher values discard old samples -faster. The default is 42. -@end deffn - -@deffn {Interface Command} {babel rtt-min <1-65535>} -This specifies the minimum RTT, in milliseconds, starting from which we -increase the cost to a neighbour. The additional cost is linear in (rtt -- rtt-min ). The default is 10@dmn{ms}. -@end deffn - -@deffn {Interface Command} {babel rtt-max <1-65535>} -This specifies the maximum RTT, in milliseconds, above which we don't -increase the cost to a neighbour. The default is 120@dmn{ms}. -@end deffn - -@deffn {Interface Command} {babel max-rtt-penalty <0-65535>} -This specifies the maximum cost added to a neighbour because of RTT, -i.e. when the RTT is higher or equal than rtt-max. The default is 0, -which effectively disables the use of a RTT-based cost. -@end deffn - -@deffn {Interface Command} {babel enable-timestamps} -@deffnx {Interface Command} {no babel enable-timestamps} -Enable or disable sending timestamps with each Hello and IHU message in -order to compute RTT values. The default is @code{no babel -enable-timestamps}. -@end deffn - -@deffn {Babel Command} {babel resend-delay <20-655340>} -Specifies the time in milliseconds after which an ``important'' -request or update will be resent. The default is 2000@dmn{ms}. You -probably don't want to tweak this value. -@end deffn - -@deffn {Babel Command} {babel smoothing-half-life <0-65534>} -Specifies the time constant, in seconds, of the smoothing algorithm -used for implementing hysteresis. Larger values reduce route -oscillation at the cost of very slightly increasing convergence time. -The value 0 disables hysteresis, and is suitable for wired networks. -The default is 4@dmn{s}. -@end deffn - -@node Babel redistribution, Show Babel information, Babel configuration, Babel -@section Babel redistribution - -@deffn {Babel command} {redistribute @var{} @var{kind}} -@deffnx {Babel command} {no redistribute @var{} @var{kind}} -Specify which kind of routes should be redistributed into Babel. -@end deffn - -@node Show Babel information, Babel debugging commands, Babel redistribution, Babel -@section Show Babel information - -@deffn {Command} {show babel route} {} -@deffnx {Command} {show babel route A.B.C.D} -@deffnx {Command} {show babel route X:X::X:X} -@deffnx {Command} {show babel route A.B.C.D/M} -@deffnx {Command} {show babel route X:X::X:X/M} -@deffnx {Command} {show babel interface} {} -@deffnx {Command} {show babel interface @var{ifname}} {} -@deffnx {Command} {show babel neighbor} {} -@deffnx {Command} {show babel parameters} {} -These commands dump various parts of @command{babeld}'s internal state. -@end deffn - -@node Babel debugging commands, , Show Babel information, Babel -@section Babel debugging commands - -@deffn {Babel Command} {debug babel @var{kind}} {} -@deffnx {Babel Command} {no debug babel @var{kind}} {} -Enable or disable debugging messages of a given kind. @var{kind} can -be one of @samp{common}, @samp{kernel}, @samp{filter}, @samp{timeout}, -@samp{interface}, @samp{route} or @samp{all}. Note that if you have -compiled with the NO_DEBUG flag, then these commands aren't available. -@end deffn - diff --git a/doc/basic.texi b/doc/basic.texi deleted file mode 100644 index 6e43210bb8..0000000000 --- a/doc/basic.texi +++ /dev/null @@ -1,642 +0,0 @@ -@node Basic commands -@chapter Basic commands - -There are five routing daemons in use, and there is one manager daemon. -These daemons may be located on separate machines from the manager -daemon. Each of these daemons will listen on a particular port for -incoming VTY connections. The routing daemons are: - -@itemize @bullet -@item @command{ripd}, @command{ripngd}, @command{ospfd}, @command{ospf6d}, @command{bgpd} -@item @command{zebra} -@end itemize - -The following sections discuss commands common to all the routing -daemons. - -@menu -* Config Commands:: Commands used in config files -* Terminal Mode Commands:: Common commands used in a VTY -* Common Invocation Options:: Starting the daemons -* Loadable Module Support:: Using extension modules -* Virtual Terminal Interfaces:: Interacting with the daemons -@end menu - - - -@node Config Commands -@section Config Commands - -@cindex Configuration files for running the software -@c A -not configuration files for installing the software -@cindex Files for running configurations -@cindex Modifying the herd's behavior -@cindex Getting the herd running - - -@menu -* Basic Config Commands:: Some of the generic config commands -* Sample Config File:: An example config file -@end menu - - -In a config file, you can write the debugging options, a vty's password, -routing daemon configurations, a log file name, and so forth. This -information forms the initial command set for a routing beast as it is -starting. - -Config files are generally found in: - -@itemize @w{} -@item @file{@value{INSTALL_PREFIX_ETC}/*.conf} -@end itemize - -Each of the daemons has its own -config file. For example, zebra's default config file name is: - -@itemize @w{} -@item @file{@value{INSTALL_PREFIX_ETC}/zebra.conf} -@end itemize - -The daemon name plus @file{.conf} is the default config file name. You -can specify a config file using the @kbd{-f} or @kbd{--config-file} -options when starting the daemon. - - - -@node Basic Config Commands -@subsection Basic Config Commands - -@deffn Command {hostname @var{hostname}} {} -Set hostname of the router. -@end deffn - -@deffn Command {password @var{password}} {} -Set password for vty interface. If there is no password, a vty won't -accept connections. -@end deffn - -@deffn Command {enable password @var{password}} {} -Set enable password. -@end deffn - -@deffn Command {log trap @var{level}} {} -@deffnx Command {no log trap} {} -These commands are deprecated and are present only for historical compatibility. -The log trap command sets the current logging level for all enabled -logging destinations, and it sets the default for all future logging commands -that do not specify a level. The normal default -logging level is debugging. The @code{no} form of the command resets -the default level for future logging commands to debugging, but it does -not change the logging level of existing logging destinations. -@end deffn - - -@deffn Command {log stdout} {} -@deffnx Command {log stdout @var{level}} {} -@deffnx Command {no log stdout} {} -Enable logging output to stdout. -If the optional second argument specifying the -logging level is not present, the default logging level (typically debugging, -but can be changed using the deprecated @code{log trap} command) will be used. -The @code{no} form of the command disables logging to stdout. -The @code{level} argument must have one of these values: -emergencies, alerts, critical, errors, warnings, notifications, informational, or debugging. Note that the existing code logs its most important messages -with severity @code{errors}. -@end deffn - -@deffn Command {log file @var{filename}} {} -@deffnx Command {log file @var{filename} @var{level}} {} -@deffnx Command {no log file} {} -If you want to log into a file, please specify @code{filename} as -in this example: -@example -log file /var/log/frr/bgpd.log informational -@end example -If the optional second argument specifying the -logging level is not present, the default logging level (typically debugging, -but can be changed using the deprecated @code{log trap} command) will be used. -The @code{no} form of the command disables logging to a file. - -Note: if you do not configure any file logging, and a daemon crashes due -to a signal or an assertion failure, it will attempt to save the crash -information in a file named /var/tmp/frr..crashlog. -For security reasons, this will not happen if the file exists already, so -it is important to delete the file after reporting the crash information. -@end deffn - -@deffn Command {log syslog} {} -@deffnx Command {log syslog @var{level}} {} -@deffnx Command {no log syslog} {} -Enable logging output to syslog. -If the optional second argument specifying the -logging level is not present, the default logging level (typically debugging, -but can be changed using the deprecated @code{log trap} command) will be used. -The @code{no} form of the command disables logging to syslog. -@end deffn - -@deffn Command {log monitor} {} -@deffnx Command {log monitor @var{level}} {} -@deffnx Command {no log monitor} {} -Enable logging output to vty terminals that have enabled logging -using the @code{terminal monitor} command. -By default, monitor logging is enabled at the debugging level, but this -command (or the deprecated @code{log trap} command) can be used to change -the monitor logging level. -If the optional second argument specifying the -logging level is not present, the default logging level (typically debugging, -but can be changed using the deprecated @code{log trap} command) will be used. -The @code{no} form of the command disables logging to terminal monitors. -@end deffn - -@deffn Command {log facility @var{facility}} {} -@deffnx Command {no log facility} {} -This command changes the facility used in syslog messages. The default -facility is @code{daemon}. The @code{no} form of the command resets -the facility to the default @code{daemon} facility. -@end deffn - -@deffn Command {log record-priority} {} -@deffnx Command {no log record-priority} {} -To include the severity in all messages logged to a file, to stdout, or to -a terminal monitor (i.e. anything except syslog), -use the @code{log record-priority} global configuration command. -To disable this option, use the @code{no} form of the command. By default, -the severity level is not included in logged messages. Note: some -versions of syslogd (including Solaris) can be configured to include -the facility and level in the messages emitted. -@end deffn - -@deffn Command {log timestamp precision @var{<0-6>}} {} -@deffnx Command {no log timestamp precision} {} -This command sets the precision of log message timestamps to the -given number of digits after the decimal point. Currently, -the value must be in the range 0 to 6 (i.e. the maximum precision -is microseconds). -To restore the default behavior (1-second accuracy), use the -@code{no} form of the command, or set the precision explicitly to 0. - -@example -@group -log timestamp precision 3 -@end group -@end example - -In this example, the precision is set to provide timestamps with -millisecond accuracy. -@end deffn - -@deffn Command {log commands} {} -This command enables the logging of all commands typed by a user to -all enabled log destinations. The note that logging includes full -command lines, including passwords. Once set, command logging can only -be turned off by restarting the daemon. -@end deffn - -@deffn Command {service password-encryption} {} -Encrypt password. -@end deffn - -@deffn Command {service advanced-vty} {} -Enable advanced mode VTY. -@end deffn - -@deffn Command {service terminal-length @var{<0-512>}} {} -Set system wide line configuration. This configuration command applies -to all VTY interfaces. -@end deffn - -@deffn Command {line vty} {} -Enter vty configuration mode. -@end deffn - -@deffn Command {banner motd default} {} -Set default motd string. -@end deffn - -@deffn Command {no banner motd} {} -No motd banner string will be printed. -@end deffn - -@deffn {Line Command} {exec-timeout @var{minute}} {} -@deffnx {Line Command} {exec-timeout @var{minute} @var{second}} {} -Set VTY connection timeout value. When only one argument is specified -it is used for timeout value in minutes. Optional second argument is -used for timeout value in seconds. Default timeout value is 10 minutes. -When timeout value is zero, it means no timeout. -@end deffn - -@deffn {Line Command} {no exec-timeout} {} -Do not perform timeout at all. This command is as same as -@command{exec-timeout 0 0}. -@end deffn - -@deffn {Line Command} {access-class @var{access-list}} {} -Restrict vty connections with an access list. -@end deffn - -@node Sample Config File -@subsection Sample Config File - - -Below is a sample configuration file for the zebra daemon. - -@example -@group -! -! Zebra configuration file -! -hostname Router -password zebra -enable password zebra -! -log stdout -! -! -@end group -@end example - -'!' and '#' are comment characters. If the first character of the word -is one of the comment characters then from the rest of the line forward -will be ignored as a comment. - -@example -password zebra!password -@end example - -If a comment character is not the first character of the word, it's a -normal character. So in the above example '!' will not be regarded as a -comment and the password is set to 'zebra!password'. - - - -@node Terminal Mode Commands -@section Terminal Mode Commands - -@deffn Command {write terminal} {} -Displays the current configuration to the vty interface. -@end deffn - -@deffn Command {write file} {} -Write current configuration to configuration file. -@end deffn - -@deffn Command {configure terminal} {} -Change to configuration mode. This command is the first step to -configuration. -@end deffn - -@deffn Command {terminal length @var{<0-512>}} {} -Set terminal display length to @var{<0-512>}. If length is 0, no -display control is performed. -@end deffn - -@deffn Command {who} {} -Show a list of currently connected vty sessions. -@end deffn - -@deffn Command {list} {} -List all available commands. -@end deffn - -@deffn Command {show version} {} -Show the current version of @value{PACKAGE_NAME} and its build host information. -@end deffn - -@deffn Command {show logging} {} -Shows the current configuration of the logging system. This includes -the status of all logging destinations. -@end deffn - -@deffn Command {logmsg @var{level} @var{message}} {} -Send a message to all logging destinations that are enabled for messages -of the given severity. -@end deffn - - - - -@node Common Invocation Options -@section Common Invocation Options -@c COMMON_OPTIONS -@c OPTIONS section of the man page - -These options apply to all @value{PACKAGE_NAME} daemons. - -@table @samp - -@item -d -@itemx --daemon -Runs in daemon mode. - -@item -f @var{file} -@itemx --config_file=@var{file} -Set configuration file name. - -@item -h -@itemx --help -Display this help and exit. - -@item -i @var{file} -@itemx --pid_file=@var{file} - -Upon startup the process identifier of the daemon is written to a file, -typically in @file{/var/run}. This file can be used by the init system -to implement commands such as @command{@dots{}/init.d/zebra status}, -@command{@dots{}/init.d/zebra restart} or @command{@dots{}/init.d/zebra -stop}. - -The file name is an run-time option rather than a configure-time option -so that multiple routing daemons can be run simultaneously. This is -useful when using @value{PACKAGE_NAME} to implement a routing looking glass. One -machine can be used to collect differing routing views from differing -points in the network. - -@item -A @var{address} -@itemx --vty_addr=@var{address} -Set the VTY local address to bind to. If set, the VTY socket will only -be bound to this address. - -@item -P @var{port} -@itemx --vty_port=@var{port} -Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not -be opened. - -@item -u @var{user} -@itemx --vty_addr=@var{user} -Set the user and group to run as. - -@item -v -@itemx --version -Print program version. - -@end table - - -@node Loadable Module Support -@section Loadable Module Support - -FRR supports loading extension modules at startup. Loading, reloading or -unloading modules at runtime is not supported (yet). To load a module, use -the following command line option at daemon startup: - -@table @samp -@item -M @var{module:options} -@itemx --module @var{module:options} - -Load the specified module, optionally passing options to it. If the module -name contains a slash (/), it is assumed to be a full pathname to a file to -be loaded. If it does not contain a slash, the -@code{@value{INSTALL_PREFIX_MODULES}} directory is searched for a module of -the given name; first with the daemon name prepended (e.g. @code{zebra_mod} -for @code{mod}), then without the daemon name prepended. - -This option is available on all daemons, though some daemons may not have -any modules available to be loaded. -@end table - - -@subsection The SNMP Module - -If SNMP is enabled during compile-time and installed as part of the package, -the @code{snmp} module can be loaded for the @command{zebra}, -@command{bgpd}, @command{ospfd}, @command{ospf6d} and @command{ripd} daemons. - -The module ignores any options passed to it. Refer to @ref{SNMP Support} -for information on its usage. - - -@subsection The FPM Module - -If FPM is enabled during compile-time and installed as part of the package, -the @code{fpm} module can be loaded for the @command{zebra} daemon. This -provides the Forwarding Plane Manager ("FPM") API. - -The module expects its argument to be either @code{netlink} or -@code{protobuf}, specifying the encapsulation to use. @code{netlink} is the -default, and @code{protobuf} may not be available if the module was built -without protobuf support. Refer to @ref{zebra FIB push interface} for more -information. - - -@node Virtual Terminal Interfaces -@section Virtual Terminal Interfaces - -VTY -- Virtual Terminal [aka TeletYpe] Interface is a command line -interface (CLI) for user interaction with the routing daemon. - -@menu -* VTY Overview:: Basics about VTYs -* VTY Modes:: View, Enable, and Other VTY modes -* VTY CLI Commands:: Commands for movement, edition, and management -@end menu - - - -@node VTY Overview -@subsection VTY Overview - - -VTY stands for Virtual TeletYpe interface. It means you can connect to -the daemon via the telnet protocol. - -To enable a VTY interface, you have to setup a VTY password. If there -is no VTY password, one cannot connect to the VTY interface at all. - -@example -@group -% telnet localhost 2601 -Trying 127.0.0.1... -Connected to localhost. -Escape character is '^]'. - -Hello, this is @value{PACKAGE_NAME} (version @value{PACKAGE_VERSION}) -@value{COPYRIGHT_STR} - -User Access Verification - -Password: XXXXX -Router> ? - enable Turn on privileged commands - exit Exit current mode and down to previous mode - help Description of the interactive help system - list Print command list - show Show running system information - who Display who is on a vty -Router> enable -Password: XXXXX -Router# configure terminal -Router(config)# interface eth0 -Router(config-if)# ip address 10.0.0.1/8 -Router(config-if)# ^Z -Router# -@end group -@end example - -'?' is very useful for looking up commands. - -@node VTY Modes -@subsection VTY Modes - -There are three basic VTY modes: - -@menu -* VTY View Mode:: Mode for read-only interaction -* VTY Enable Mode:: Mode for read-write interaction -* VTY Other Modes:: Special modes (tftp, etc) -@end menu - -There are commands that may be restricted to specific VTY modes. - -@node VTY View Mode -@subsubsection VTY View Mode -@c to be written (gpoul) - - -This mode is for read-only access to the CLI. One may exit the mode by -leaving the system, or by entering @code{enable} mode. - -@node VTY Enable Mode -@subsubsection VTY Enable Mode - -@c to be written (gpoul) -This mode is for read-write access to the CLI. One may exit the mode by -leaving the system, or by escaping to view mode. - -@node VTY Other Modes -@subsubsection VTY Other Modes - - -@c to be written (gpoul) -This page is for describing other modes. - -@node VTY CLI Commands -@subsection VTY CLI Commands - -Commands that you may use at the command-line are described in the following -three subsubsections. - -@menu -* CLI Movement Commands:: Commands for moving the cursor about -* CLI Editing Commands:: Commands for changing text -* CLI Advanced Commands:: Other commands, session management and so on -@end menu - -@node CLI Movement Commands -@subsubsection CLI Movement Commands - -These commands are used for moving the CLI cursor. The @key{C} character -means press the Control Key. - -@table @kbd - -@item C-f -@itemx @key{RIGHT} -@kindex C-f -@kindex @key{RIGHT} -Move forward one character. - -@item C-b -@itemx @key{LEFT} -@kindex C-b -@kindex @key{LEFT} -Move backward one character. - -@item M-f -@kindex M-f -Move forward one word. - -@item M-b -@kindex M-b -Move backward one word. - -@item C-a -@kindex C-a -Move to the beginning of the line. - -@item C-e -@kindex C-e -Move to the end of the line. - -@end table - -@node CLI Editing Commands -@subsubsection CLI Editing Commands - -These commands are used for editing text on a line. The @key{C} -character means press the Control Key. - -@table @kbd - -@item C-h -@itemx @key{DEL} -@kindex C-h -@kindex @key{DEL} -Delete the character before point. - -@item C-d -@kindex C-d -Delete the character after point. - -@item M-d -@kindex M-d -Forward kill word. - -@item C-w -@kindex C-w -Backward kill word. - -@item C-k -@kindex C-k -Kill to the end of the line. - -@item C-u -@kindex C-u -Kill line from the beginning, erasing input. - -@item C-t -@kindex C-t -Transpose character. - -@end table - -@node CLI Advanced Commands -@subsubsection CLI Advanced Commands - -There are several additional CLI commands for command line completions, -insta-help, and VTY session management. - -@table @kbd - -@item C-c -@kindex C-c -Interrupt current input and moves to the next line. - -@item C-z -@kindex C-z -End current configuration session and move to top node. - - -@item C-n -@itemx @key{DOWN} -@kindex C-n -@kindex @key{DOWN} -Move down to next line in the history buffer. - -@item C-p -@itemx @key{UP} -@kindex C-p -@kindex @key{UP} -Move up to previous line in the history buffer. - -@item TAB -@kindex @key{TAB} -Use command line completion by typing @key{TAB}. - -@item ? -@kindex @key{?} -You can use command line help by typing @code{help} at the beginning of -the line. Typing @kbd{?} at any point in the line will show possible -completions. - -@end table diff --git a/doc/bgpd.texi b/doc/bgpd.texi deleted file mode 100644 index d62c3a7516..0000000000 --- a/doc/bgpd.texi +++ /dev/null @@ -1,2149 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c Portions: -@c Copyright @copyright{} 2015 Hewlett Packard Enterprise Development LP -@c See file frr.texi for copying conditions. -@node BGP -@chapter BGP - -@acronym{BGP} stands for a Border Gateway Protocol. The lastest BGP version -is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway -Protocols and de-fact standard of Inter Domain routing protocol. -BGP-4 is described in @cite{RFC1771, A Border Gateway Protocol -4 (BGP-4)}. - -Many extensions have been added to @cite{RFC1771}. @cite{RFC2858, -Multiprotocol Extensions for BGP-4} provides multiprotocol support to -BGP-4. - -@menu -* Starting BGP:: -* BGP router:: -* BGP MED:: -* BGP network:: -* BGP Peer:: -* BGP Peer Group:: -* BGP Address Family:: -* Autonomous System:: -* BGP Communities Attribute:: -* BGP Extended Communities Attribute:: -* BGP Large Communities Attribute:: -* Displaying BGP information:: -* Capability Negotiation:: -* Route Reflector:: -* Route Server:: -* BGP Regular Expressions:: -* How to set up a 6-Bone connection:: -* Dump BGP packets and table:: -* BGP Configuration Examples:: -* Prefix Origin Validation Using RPKI:: -@end menu - -@node Starting BGP -@section Starting BGP - -Default configuration file of @command{bgpd} is @file{bgpd.conf}. -@command{bgpd} searches the current directory first then -@value{INSTALL_PREFIX_ETC}/bgpd.conf. All of bgpd's command must be -configured in @file{bgpd.conf}. - -@command{bgpd} specific invocation options are described below. Common -options may also be specified (@pxref{Common Invocation Options}). - -@table @samp -@item -p @var{PORT} -@itemx --bgp_port=@var{PORT} -Set the bgp protocol's port number. - -@item -r -@itemx --retain -When program terminates, retain BGP routes added by zebra. - -@item -l -@itemx --listenon -Specify a specific IP address for bgpd to listen on, rather than its -default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd -to an internal address, or to run multiple bgpd processes on one host. - -@end table - -@node BGP router -@section BGP router - - First of all you must configure BGP router with @command{router bgp} -command. To configure BGP router, you need AS number. AS number is an -identification of autonomous system. BGP protocol uses the AS number -for detecting whether the BGP connection is internal one or external one. - -@deffn Command {router bgp @var{asn}} {} -Enable a BGP protocol process with the specified @var{asn}. After -this statement you can input any @code{BGP Commands}. You can not -create different BGP process under different @var{asn} without -specifying @code{multiple-instance} (@pxref{Multiple instance}). -@end deffn - -@deffn Command {no router bgp @var{asn}} {} -Destroy a BGP protocol process with the specified @var{asn}. -@end deffn - -@deffn {BGP} {bgp router-id @var{A.B.C.D}} {} -This command specifies the router-ID. If @command{bgpd} connects to @command{zebra} it gets -interface and address information. In that case default router ID value -is selected as the largest IP Address of the interfaces. When -@code{router zebra} is not enabled @command{bgpd} can't get interface information -so @code{router-id} is set to 0.0.0.0. So please set router-id by hand. -@end deffn - -@menu -* BGP distance:: -* BGP decision process:: -* BGP route flap dampening:: -@end menu - -@node BGP distance -@subsection BGP distance - -@deffn {BGP} {distance bgp <1-255> <1-255> <1-255>} {} -This command change distance value of BGP. Each argument is distance -value for external routes, internal routes and local routes. -@end deffn - -@deffn {BGP} {distance <1-255> @var{A.B.C.D/M}} {} -@deffnx {BGP} {distance <1-255> @var{A.B.C.D/M} @var{word}} {} -This command set distance value to -@end deffn - -@node BGP decision process -@subsection BGP decision process - -The decision process Frr BGP uses to select routes is as follows: - -@table @asis -@item 1. Weight check -prefer higher local weight routes to lower routes. - -@item 2. Local preference check -prefer higher local preference routes to lower. - -@item 3. Local route check -Prefer local routes (statics, aggregates, redistributed) to received routes. - -@item 4. AS path length check -Prefer shortest hop-count AS_PATHs. - -@item 5. Origin check -Prefer the lowest origin type route. That is, prefer IGP origin routes to -EGP, to Incomplete routes. - -@item 6. MED check -Where routes with a MED were received from the same AS, -prefer the route with the lowest MED. @xref{BGP MED}. - -@item 7. External check -Prefer the route received from an external, eBGP peer -over routes received from other types of peers. - -@item 8. IGP cost check -Prefer the route with the lower IGP cost. - -@item 9. Multi-path check -If multi-pathing is enabled, then check whether -the routes not yet distinguished in preference may be considered equal. If -@ref{bgp bestpath as-path multipath-relax} is set, all such routes are -considered equal, otherwise routes received via iBGP with identical AS_PATHs -or routes received from eBGP neighbours in the same AS are considered equal. - -@item 10 Already-selected external check - -Where both routes were received from eBGP peers, then prefer the route which -is already selected. Note that this check is not applied if @ref{bgp -bestpath compare-routerid} is configured. This check can prevent some cases -of oscillation. - -@item 11. Router-ID check -Prefer the route with the lowest @w{router-ID}. If the -route has an @w{ORIGINATOR_ID} attribute, through iBGP reflection, then that -router ID is used, otherwise the @w{router-ID} of the peer the route was -received from is used. - -@item 12. Cluster-List length check -The route with the shortest cluster-list -length is used. The cluster-list reflects the iBGP reflection path the -route has taken. - -@item 13. Peer address -Prefer the route received from the peer with the higher -transport layer address, as a last-resort tie-breaker. - -@end table - -@deffn {BGP} {bgp bestpath as-path confed} {} -This command specifies that the length of confederation path sets and -sequences should should be taken into account during the BGP best path -decision process. -@end deffn - -@deffn {BGP} {bgp bestpath as-path multipath-relax} {} -@anchor{bgp bestpath as-path multipath-relax} -This command specifies that BGP decision process should consider paths -of equal AS_PATH length candidates for multipath computation. Without -the knob, the entire AS_PATH must match for multipath computation. -@end deffn - -@deffn {BGP} {bgp bestpath compare-routerid} {} -@anchor{bgp bestpath compare-routerid} - -Ensure that when comparing routes where both are equal on most metrics, -including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken -based on router-ID. - -If this option is enabled, then the already-selected check, where -already selected eBGP routes are preferred, is skipped. - -If a route has an @w{ORIGINATOR_ID} attribute because it has been reflected, -that @w{ORIGINATOR_ID} will be used. Otherwise, the router-ID of the peer the -route was received from will be used. - -The advantage of this is that the route-selection (at this point) will be -more deterministic. The disadvantage is that a few or even one lowest-ID -router may attract all trafic to otherwise-equal paths because of this -check. It may increase the possibility of MED or IGP oscillation, unless -other measures were taken to avoid these. The exact behaviour will be -sensitive to the iBGP and reflection topology. - -@end deffn - - -@node BGP route flap dampening -@subsection BGP route flap dampening - -@deffn {BGP} {bgp dampening @var{<1-45>} @var{<1-20000>} @var{<1-20000>} @var{<1-255>}} {} -This command enables BGP route-flap dampening and specifies dampening parameters. - -@table @asis -@item @asis{half-life} -Half-life time for the penalty -@item @asis{reuse-threshold} -Value to start reusing a route -@item @asis{suppress-threshold} -Value to start suppressing a route -@item @asis{max-suppress} -Maximum duration to suppress a stable route -@end table - -The route-flap damping algorithm is compatible with @cite{RFC2439}. The use of this command -is not recommended nowadays, see @uref{http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378}. -@end deffn - -@node BGP MED -@section BGP MED - -The BGP MED (Multi_Exit_Discriminator) attribute has properties which can -cause subtle convergence problems in BGP. These properties and problems -have proven to be hard to understand, at least historically, and may still -not be widely understood. The following attempts to collect together and -present what is known about MED, to help operators and Frr users in -designing and configuring their networks. - -The BGP @acronym{MED, Multi_Exit_Discriminator} attribute is intended to -allow one AS to indicate its preferences for its ingress points to another -AS. The MED attribute will not be propagated on to another AS by the -receiving AS - it is `non-transitive' in the BGP sense. - -E.g., if AS X and AS Y have 2 different BGP peering points, then AS X -might set a MED of 100 on routes advertised at one and a MED of 200 at the -other. When AS Y selects between otherwise equal routes to or via -AS X, AS Y should prefer to take the path via the lower MED peering of 100 with -AS X. Setting the MED allows an AS to influence the routing taken to it -within another, neighbouring AS. - -In this use of MED it is not really meaningful to compare the MED value on -routes where the next AS on the paths differs. E.g., if AS Y also had a -route for some destination via AS Z in addition to the routes from AS X, and -AS Z had also set a MED, it wouldn't make sense for AS Y to compare AS Z's -MED values to those of AS X. The MED values have been set by different -administrators, with different frames of reference. - -The default behaviour of BGP therefore is to not compare MED values across -routes received from different neighbouring ASes. In Frr this is done by -comparing the neighbouring, left-most AS in the received AS_PATHs of the -routes and only comparing MED if those are the same. - -@c TeXInfo uses the old, non-UTF-8 capable, pdftex, and so -@c doesn't render TeX the unicode precedes character correctly in PDF, etc. -@c Using a TeX code on the other hand doesn't work for non-TeX outputs -@c (plaintext, e.g.). So, use an output-conditional macro. - -@iftex -@macro mprec{} -@math{\\prec} -@end macro -@end iftex - -@ifnottex -@macro mprec{} -@math{≺} -@end macro -@end ifnottex - -Unfortunately, this behaviour of MED, of sometimes being compared across -routes and sometimes not, depending on the properties of those other routes, -means MED can cause the order of preference over all the routes to be -undefined. That is, given routes A, B, and C, if A is preferred to B, and B -is preferred to C, then a well-defined order should mean the preference is -transitive (in the sense of orders @footnote{For some set of objects to have -an order, there @emph{must} be some binary ordering relation that is defined -for @emph{every} combination of those objects, and that relation @emph{must} -be transitive. I.e.@:, if the relation operator is @mprec{}, and if -a @mprec{} b and b @mprec{} c then that relation must carry over -and it @emph{must} be that a @mprec{} c for the objects to have an -order. The ordering relation may allow for equality, i.e. -a @mprec{} b and b @mprec{} a may both be true amd imply that -a and b are equal in the order and not distinguished by it, in -which case the set has a partial order. Otherwise, if there is an order, -all the objects have a distinct place in the order and the set has a total -order.}) and that A would be preferred to C. - -However, when MED is involved this need not be the case. With MED it is -possible that C is actually preferred over A. So A is preferred to B, B is -preferred to C, but C is preferred to A. This can be true even where BGP -defines a deterministic ``most preferred'' route out of the full set of -A,B,C. With MED, for any given set of routes there may be a -deterministically preferred route, but there need not be any way to arrange -them into any order of preference. With unmodified MED, the order of -preference of routes literally becomes undefined. - -That MED can induce non-transitive preferences over routes can cause issues. -Firstly, it may be perceived to cause routing table churn locally at -speakers; secondly, and more seriously, it may cause routing instability in -iBGP topologies, where sets of speakers continually oscillate between -different paths. - -The first issue arises from how speakers often implement routing decisions. -Though BGP defines a selection process that will deterministically select -the same route as best at any given speaker, even with MED, that process -requires evaluating all routes together. For performance and ease of -implementation reasons, many implementations evaluate route preferences in a -pair-wise fashion instead. Given there is no well-defined order when MED is -involved, the best route that will be chosen becomes subject to -implementation details, such as the order the routes are stored in. That -may be (locally) non-deterministic, e.g.@: it may be the order the routes -were received in. - -This indeterminism may be considered undesirable, though it need not cause -problems. It may mean additional routing churn is perceived, as sometimes -more updates may be produced than at other times in reaction to some event . - -This first issue can be fixed with a more deterministic route selection that -ensures routes are ordered by the neighbouring AS during selection. -@xref{bgp deterministic-med}. This may reduce the number of updates as -routes are received, and may in some cases reduce routing churn. Though, it -could equally deterministically produce the largest possible set of updates -in response to the most common sequence of received updates. - -A deterministic order of evaluation tends to imply an additional overhead of -sorting over any set of n routes to a destination. The implementation of -deterministic MED in Frr scales significantly worse than most sorting -algorithms at present, with the number of paths to a given destination. -That number is often low enough to not cause any issues, but where there are -many paths, the deterministic comparison may quickly become increasingly -expensive in terms of CPU. - -Deterministic local evaluation can @emph{not} fix the second, more major, -issue of MED however. Which is that the non-transitive preference of routes -MED can cause may lead to routing instability or oscillation across multiple -speakers in iBGP topologies. This can occur with full-mesh iBGP, but is -particularly problematic in non-full-mesh iBGP topologies that further -reduce the routing information known to each speaker. This has primarily -been documented with iBGP route-reflection topologies. However, any -route-hiding technologies potentially could also exacerbate oscillation with -MED. - -This second issue occurs where speakers each have only a subset of routes, -and there are cycles in the preferences between different combinations of -routes - as the undefined order of preference of MED allows - and the routes -are distributed in a way that causes the BGP speakers to 'chase' those -cycles. This can occur even if all speakers use a deterministic order of -evaluation in route selection. - -E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and -from speaker 3 in AS Y; while speaker 5 in AS A might receive that route -from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 -at speaker 3. I.e, using ASN:ID:MED to label the speakers: - -@example - - /---------------\ - X:2------|--A:4-------A:5--|-Y:1:200 - Y:3:100--|-/ | - \---------------/ - -@end example - -Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then -based on the RFC4271 decision process speaker 4 will choose X:2 over -Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. -Speaker 5 will continue to prefer Y:1:200 based on the ID, and advertise -this to speaker 4. Speaker 4 will now have the full set of routes, and the -Y:1:200 it receives from 5 will beat X:2, but when speaker 4 compares -Y:1:200 to Y:3:100 the MED check now becomes active as the ASes match, and -now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5, -which will also agrees that Y:3:100 is preferred to Y:1:200, and so -withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100, -and X:2 beats Y:3:100, and so speaker 4 implicitly updates its route to -speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID, -and advertises Y:1:200 to speaker 4, and the cycle continues. - -The root cause is the lack of a clear order of preference caused by how MED -sometimes is and sometimes is not compared, leading to this cycle in the -preferences between the routes: - -@example - - /---> X:2 ---beats---> Y:3:100 --\ - | | - | | - \---beats--- Y:1:200 <---beats---/ - -@end example - -This particular type of oscillation in full-mesh iBGP topologies can be -avoided by speakers preferring already selected, external routes rather than -choosing to update to new a route based on a post-MED metric (e.g. -router-ID), at the cost of a non-deterministic selection process. Frr -implements this, as do many other implementations, so long as it is not -overridden by setting @ref{bgp bestpath compare-routerid}, and see also -@ref{BGP decision process}, . - -However, more complex and insidious cycles of oscillation are possible with -iBGP route-reflection, which are not so easily avoided. These have been -documented in various places. See, e.g., @cite{McPherson, D. and Gill, V. -and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation -Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable -and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong, -"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete -examples and further references. - -There is as of this writing @emph{no} known way to use MED for its original -purpose; @emph{and} reduce routing information in iBGP topologies; -@emph{and} be sure to avoid the instability problems of MED due the -non-transitive routing preferences it can induce; in general on arbitrary -networks. - -There may be iBGP topology specific ways to reduce the instability risks, -even while using MED, e.g.@: by constraining the reflection topology and by -tuning IGP costs between route-reflector clusters, see RFC3345 for details. -In the near future, the Add-Path extension to BGP may also solve MED -oscillation while still allowing MED to be used as intended, by distributing -"best-paths per neighbour AS". This would be at the cost of distributing at -least as many routes to all speakers as a full-mesh iBGP would, if not more, -while also imposing similar CPU overheads as the "Deterministic MED" feature -at each Add-Path reflector. - -More generally, the instability problems that MED can introduce on more -complex, non-full-mesh, iBGP topologies may be avoided either by: - -@itemize - -@item -Setting @ref{bgp always-compare-med}, however this allows MED to be compared -across values set by different neighbour ASes, which may not produce -coherent desirable results, of itself. - -@item -Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using -@ref{routemap set metric} on all received routes, in combination with -setting @ref{bgp always-compare-med} on all speakers. This is the simplest -and most performant way to avoid MED oscillation issues, where an AS is happy -not to allow neighbours to inject this problematic metric. - -@end itemize - -As MED is evaluated after the AS_PATH length check, another possible use for -MED is for intra-AS steering of routes with equal AS_PATH length, as an -extension of the last case above. As MED is evaluated before IGP metric, -this can allow cold-potato routing to be implemented to send traffic to -preferred hand-offs with neighbours, rather than the closest hand-off -according to the IGP metric. - -Note that even if action is taken to address the MED non-transitivity -issues, other oscillations may still be possible. E.g., on IGP cost if -iBGP and IGP topologies are at cross-purposes with each other - see the -Flavel and Roughan paper above for an example. Hence the guideline that the -iBGP topology should follow the IGP topology. - -@deffn {BGP} {bgp deterministic-med} {} -@anchor{bgp deterministic-med} - -Carry out route-selection in way that produces deterministic answers -locally, even in the face of MED and the lack of a well-defined order of -preference it can induce on routes. Without this option the preferred route -with MED may be determined largely by the order that routes were received -in. - -Setting this option will have a performance cost that may be noticeable when -there are many routes for each destination. Currently in Frr it is -implemented in a way that scales poorly as the number of routes per -destination increases. - -The default is that this option is not set. -@end deffn - -Note that there are other sources of indeterminism in the route selection -process, specifically, the preference for older and already selected routes -from eBGP peers, @xref{BGP decision process}. - -@deffn {BGP} {bgp always-compare-med} {} -@anchor{bgp always-compare-med} - -Always compare the MED on routes, even when they were received from -different neighbouring ASes. Setting this option makes the order of -preference of routes more defined, and should eliminate MED induced -oscillations. - -If using this option, it may also be desirable to use @ref{routemap set -metric} to set MED to 0 on routes received from external neighbours. - -This option can be used, together with @ref{routemap set metric} to use MED -as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired -exit points. -@end deffn - - - -@node BGP network -@section BGP network - -@menu -* BGP route:: -* Route Aggregation:: -* Redistribute to BGP:: -@end menu - -@node BGP route -@subsection BGP route - -@deffn {BGP} {network @var{A.B.C.D/M}} {} -This command adds the announcement network. -@example -@group -router bgp 1 - address-family ipv4 unicast - network 10.0.0.0/8 - exit-address-family -@end group -@end example -This configuration example says that network 10.0.0.0/8 will be -announced to all neighbors. Some vendors' routers don't advertise -routes if they aren't present in their IGP routing tables; @code{bgpd} -doesn't care about IGP routes when announcing its routes. -@end deffn - -@deffn {BGP} {no network @var{A.B.C.D/M}} {} -@end deffn - -@node Route Aggregation -@subsection Route Aggregation - -@deffn {BGP} {aggregate-address @var{A.B.C.D/M}} {} -This command specifies an aggregate address. -@end deffn - -@deffn {BGP} {aggregate-address @var{A.B.C.D/M} as-set} {} -This command specifies an aggregate address. Resulting routes include -AS set. -@end deffn - -@deffn {BGP} {aggregate-address @var{A.B.C.D/M} summary-only} {} -This command specifies an aggregate address. Aggreated routes will -not be announce. -@end deffn - -@deffn {BGP} {no aggregate-address @var{A.B.C.D/M}} {} -@end deffn - -@node Redistribute to BGP -@subsection Redistribute to BGP - -@deffn {BGP} {redistribute kernel} {} -Redistribute kernel route to BGP process. -@end deffn - -@deffn {BGP} {redistribute static} {} -Redistribute static route to BGP process. -@end deffn - -@deffn {BGP} {redistribute connected} {} -Redistribute connected route to BGP process. -@end deffn - -@deffn {BGP} {redistribute rip} {} -Redistribute RIP route to BGP process. -@end deffn - -@deffn {BGP} {redistribute ospf} {} -Redistribute OSPF route to BGP process. -@end deffn - -@deffn {BGP} {redistribute vpn} {} -Redistribute VNC routes to BGP process. -@end deffn - -@deffn {BGP} {update-delay @var{max-delay}} {} -@deffnx {BGP} {update-delay @var{max-delay} @var{establish-wait}} {} -This feature is used to enable read-only mode on BGP process restart or when -BGP process is cleared using 'clear ip bgp *'. When applicable, read-only mode -would begin as soon as the first peer reaches Established status and a timer -for max-delay seconds is started. - -During this mode BGP doesn't run any best-path or generate any updates to its -peers. This mode continues until: -1. All the configured peers, except the shutdown peers, have sent explicit EOR -(End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached -Established is considered an implicit-EOR. - If the establish-wait optional value is given, then BGP will wait for - peers to reach established from the begining of the update-delay till the - establish-wait period is over, i.e. the minimum set of established peers for - which EOR is expected would be peers established during the establish-wait - window, not necessarily all the configured neighbors. -2. max-delay period is over. -On hitting any of the above two conditions, BGP resumes the decision process -and generates updates to its peers. - -Default max-delay is 0, i.e. the feature is off by default. -@end deffn - -@deffn {BGP} {table-map @var{route-map-name}} {} -This feature is used to apply a route-map on route updates from BGP to Zebra. -All the applicable match operations are allowed, such as match on prefix, -next-hop, communities, etc. Set operations for this attach-point are limited -to metric and next-hop only. Any operation of this feature does not affect -BGPs internal RIB. - -Supported for ipv4 and ipv6 address families. It works on multi-paths as well, -however, metric setting is based on the best-path only. -@end deffn - -@node BGP Peer -@section BGP Peer - -@menu -* Defining Peer:: -* BGP Peer commands:: -* Peer filtering:: -@end menu - -@node Defining Peer -@subsection Defining Peer - -@deffn {BGP} {neighbor @var{peer} remote-as @var{asn}} {} -Creates a new neighbor whose remote-as is @var{asn}. @var{peer} -can be an IPv4 address or an IPv6 address. -@example -@group -router bgp 1 - neighbor 10.0.0.1 remote-as 2 -@end group -@end example -In this case my router, in AS-1, is trying to peer with AS-2 at -10.0.0.1. - -This command must be the first command used when configuring a neighbor. -If the remote-as is not specified, @command{bgpd} will complain like this: -@example -can't find neighbor 10.0.0.1 -@end example -@end deffn - -@node BGP Peer commands -@subsection BGP Peer commands - -In a @code{router bgp} clause there are neighbor specific configurations -required. - -@deffn {BGP} {neighbor @var{peer} shutdown} {} -@deffnx {BGP} {no neighbor @var{peer} shutdown} {} -Shutdown the peer. We can delete the neighbor's configuration by -@code{no neighbor @var{peer} remote-as @var{as-number}} but all -configuration of the neighbor will be deleted. When you want to -preserve the configuration, but want to drop the BGP peer, use this -syntax. -@end deffn - -@deffn {BGP} {neighbor @var{peer} ebgp-multihop} {} -@deffnx {BGP} {no neighbor @var{peer} ebgp-multihop} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} description ...} {} -@deffnx {BGP} {no neighbor @var{peer} description ...} {} -Set description of the peer. -@end deffn - -@deffn {BGP} {neighbor @var{peer} version @var{version}} {} -Set up the neighbor's BGP version. @var{version} can be @var{4}, -@var{4+} or @var{4-}. BGP version @var{4} is the default value used for -BGP peering. BGP version @var{4+} means that the neighbor supports -Multiprotocol Extensions for BGP-4. BGP version @var{4-} is similar but -the neighbor speaks the old Internet-Draft revision 00's Multiprotocol -Extensions for BGP-4. Some routing software is still using this -version. -@end deffn - -@deffn {BGP} {neighbor @var{peer} interface @var{ifname}} {} -@deffnx {BGP} {no neighbor @var{peer} interface @var{ifname}} {} -When you connect to a BGP peer over an IPv6 link-local address, you -have to specify the @var{ifname} of the interface used for the -connection. To specify IPv4 session addresses, see the -@code{neighbor @var{peer} update-source} command below. - -This command is deprecated and may be removed in a future release. Its -use should be avoided. -@end deffn - -@deffn {BGP} {neighbor @var{peer} next-hop-self [all]} {} -@deffnx {BGP} {no neighbor @var{peer} next-hop-self [all]} {} -This command specifies an announced route's nexthop as being equivalent -to the address of the bgp router if it is learned via eBGP. -If the optional keyword @code{all} is specified the modifiation is done -also for routes learned via iBGP. -@end deffn - -@deffn {BGP} {neighbor @var{peer} update-source @var{}} {} -@deffnx {BGP} {no neighbor @var{peer} update-source} {} -Specify the IPv4 source address to use for the @acronym{BGP} session to this -neighbour, may be specified as either an IPv4 address directly or -as an interface name (in which case the @command{zebra} daemon MUST be running -in order for @command{bgpd} to be able to retrieve interface state). -@example -@group -router bgp 64555 - neighbor foo update-source 192.168.0.1 - neighbor bar update-source lo0 -@end group -@end example -@end deffn - -@deffn {BGP} {neighbor @var{peer} default-originate} {} -@deffnx {BGP} {no neighbor @var{peer} default-originate} {} -@command{bgpd}'s default is to not announce the default route (0.0.0.0/0) even it -is in routing table. When you want to announce default routes to the -peer, use this command. -@end deffn - -@deffn {BGP} {neighbor @var{peer} port @var{port}} {} -@deffnx {BGP} {neighbor @var{peer} port @var{port}} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} send-community} {} -@deffnx {BGP} {neighbor @var{peer} send-community} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} weight @var{weight}} {} -@deffnx {BGP} {no neighbor @var{peer} weight @var{weight}} {} -This command specifies a default @var{weight} value for the neighbor's -routes. -@end deffn - -@deffn {BGP} {neighbor @var{peer} maximum-prefix @var{number}} {} -@deffnx {BGP} {no neighbor @var{peer} maximum-prefix @var{number}} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} local-as @var{as-number}} {} -@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend} {} -@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend replace-as} {} -@deffnx {BGP} {no neighbor @var{peer} local-as} {} -Specify an alternate AS for this BGP process when interacting with the -specified peer. With no modifiers, the specified local-as is prepended to -the received AS_PATH when receiving routing updates from the peer, and -prepended to the outgoing AS_PATH (after the process local AS) when -transmitting local routes to the peer. - -If the no-prepend attribute is specified, then the supplied local-as is not -prepended to the received AS_PATH. - -If the replace-as attribute is specified, then only the supplied local-as is -prepended to the AS_PATH when transmitting local-route updates to this peer. - -Note that replace-as can only be specified if no-prepend is. - -This command is only allowed for eBGP peers. -@end deffn - -@deffn {BGP} {neighbor @var{peer} ttl-security hops @var{number}} {} -@deffnx {BGP} {no neighbor @var{peer} ttl-security hops @var{number}} {} -This command enforces Generalized TTL Security Mechanism (GTSM), as -specified in RFC 5082. With this command, only neighbors that are the -specified number of hops away will be allowed to become neighbors. This -command is mututally exclusive with @command{ebgp-multihop}. -@end deffn - -@node Peer filtering -@subsection Peer filtering - -@deffn {BGP} {neighbor @var{peer} distribute-list @var{name} [in|out]} {} -This command specifies a distribute-list for the peer. @var{direct} is -@samp{in} or @samp{out}. -@end deffn - -@deffn {BGP command} {neighbor @var{peer} prefix-list @var{name} [in|out]} {} -@end deffn - -@deffn {BGP command} {neighbor @var{peer} filter-list @var{name} [in|out]} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} route-map @var{name} [in|out]} {} -Apply a route-map on the neighbor. @var{direct} must be @code{in} or -@code{out}. -@end deffn - -@deffn {BGP} {bgp route-reflector allow-outbound-policy} {} -By default, attribute modification via route-map policy out is not reflected -on reflected routes. This option allows the modifications to be reflected as -well. Once enabled, it affects all reflected routes. -@end deffn - -@c ----------------------------------------------------------------------- -@node BGP Peer Group -@section BGP Peer Group - -@deffn {BGP} {neighbor @var{word} peer-group} {} -This command defines a new peer group. -@end deffn - -@deffn {BGP} {neighbor @var{peer} peer-group @var{word}} {} -This command bind specific peer to peer group @var{word}. -@end deffn - -@node BGP Address Family -@section BGP Address Family - -Multiprotocol BGP enables BGP to carry routing information for multiple -Network Layer protocols. BGP supports multiple Address Family -Identifier (AFI), namely IPv4 and IPv6. Support is also provided for -multiple sets of per-AFI information via Subsequent Address Family -Identifiers (SAFI). In addition to unicast information, VPN information -@cite{RFC4364} and @cite{RFC4659}, and Encapsulation information -@cite{RFC5512} is supported. - -@deffn {Command} {show ip bgp vpnv4 all} {} -@deffnx {Command} {show ipv6 bgp vpn all} {} -Print active IPV4 or IPV6 routes advertised via the VPN SAFI. -@end deffn - -@deffn {Command} {show ip bgp encap all} {} -@deffnx {Command} {show ipv6 bgp encap all} {} -Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI. -@end deffn - -@deffn {Command} {show bgp ipv4 encap summary} {} -@deffnx {Command} {show bgp ipv4 vpn summary} {} -@deffnx {Command} {show bgp ipv6 encap summary} {} -@deffnx {Command} {show bgp ipv6 vpn summary} {} -Print a summary of neighbor connections for the specified AFI/SAFI combination. -@end deffn - -@c ----------------------------------------------------------------------- -@node Autonomous System -@section Autonomous System - -The @acronym{AS,Autonomous System} number is one of the essential -element of BGP. BGP is a distance vector routing protocol, and the -AS-Path framework provides distance vector metric and loop detection to -BGP. @cite{RFC1930, Guidelines for creation, selection, and -registration of an Autonomous System (AS)} provides some background on -the concepts of an AS. - -The AS number is a two octet value, ranging in value from 1 to 65535. -The AS numbers 64512 through 65535 are defined as private AS numbers. -Private AS numbers must not to be advertised in the global Internet. - -@menu -* Display BGP Routes by AS Path:: -* AS Path Access List:: -* Using AS Path in Route Map:: -* Private AS Numbers:: -@end menu - -@node Display BGP Routes by AS Path -@subsection Display BGP Routes by AS Path - -To show BGP routes which has specific AS path information @code{show -ip bgp} command can be used. - -@deffn Command {show bgp @{ipv4|ipv6@} regexp @var{line}} {} -This commands displays BGP routes that matches a regular -expression @var{line} (@pxref{BGP Regular Expressions}). -@end deffn - -@node AS Path Access List -@subsection AS Path Access List - -AS path access list is user defined AS path. - -@deffn {Command} {ip as-path access-list @var{word} @{permit|deny@} @var{line}} {} -This command defines a new AS path access list. -@end deffn - -@deffn {Command} {no ip as-path access-list @var{word}} {} -@deffnx {Command} {no ip as-path access-list @var{word} @{permit|deny@} @var{line}} {} -@end deffn - -@node Using AS Path in Route Map -@subsection Using AS Path in Route Map - -@deffn {Route Map} {match as-path @var{word}} {} -@end deffn - -@deffn {Route Map} {set as-path prepend @var{as-path}} {} -Prepend the given string of AS numbers to the AS_PATH. -@end deffn - -@deffn {Route Map} {set as-path prepend last-as @var{num}} {} -Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. -@end deffn - -@node Private AS Numbers -@subsection Private AS Numbers - -@c ----------------------------------------------------------------------- -@node BGP Communities Attribute -@section BGP Communities Attribute - -BGP communities attribute is widely used for implementing policy -routing. Network operators can manipulate BGP communities attribute -based on their network policy. BGP communities attribute is defined -in @cite{RFC1997, BGP Communities Attribute} and -@cite{RFC1998, An Application of the BGP Community Attribute -in Multi-home Routing}. It is an optional transitive attribute, -therefore local policy can travel through different autonomous system. - -Communities attribute is a set of communities values. Each -communities value is 4 octet long. The following format is used to -define communities value. - -@table @code -@item AS:VAL -This format represents 4 octet communities value. @code{AS} is high -order 2 octet in digit format. @code{VAL} is low order 2 octet in -digit format. This format is useful to define AS oriented policy -value. For example, @code{7675:80} can be used when AS 7675 wants to -pass local policy value 80 to neighboring peer. -@item internet -@code{internet} represents well-known communities value 0. -@item no-export -@code{no-export} represents well-known communities value @code{NO_EXPORT}@* -@r{(0xFFFFFF01)}. All routes carry this value must not be advertised -to outside a BGP confederation boundary. If neighboring BGP peer is -part of BGP confederation, the peer is considered as inside a BGP -confederation boundary, so the route will be announced to the peer. -@item no-advertise -@code{no-advertise} represents well-known communities value -@code{NO_ADVERTISE}@*@r{(0xFFFFFF02)}. All routes carry this value -must not be advertise to other BGP peers. -@item local-AS -@code{local-AS} represents well-known communities value -@code{NO_EXPORT_SUBCONFED} @r{(0xFFFFFF03)}. All routes carry this -value must not be advertised to external BGP peers. Even if the -neighboring router is part of confederation, it is considered as -external BGP peer, so the route will not be announced to the peer. -@end table - - When BGP communities attribute is received, duplicated communities -value in the communities attribute is ignored and each communities -values are sorted in numerical order. - -@menu -* BGP Community Lists:: -* Numbered BGP Community Lists:: -* BGP Community in Route Map:: -* Display BGP Routes by Community:: -* Using BGP Communities Attribute:: -@end menu - -@node BGP Community Lists -@subsection BGP Community Lists - - BGP community list is a user defined BGP communites attribute list. -BGP community list can be used for matching or manipulating BGP -communities attribute in updates. - -There are two types of community list. One is standard community -list and another is expanded community list. Standard community list -defines communities attribute. Expanded community list defines -communities attribute string with regular expression. Standard -community list is compiled into binary format when user define it. -Standard community list will be directly compared to BGP communities -attribute in BGP updates. Therefore the comparison is faster than -expanded community list. - -@deffn Command {ip community-list standard @var{name} @{permit|deny@} @var{community}} {} -This command defines a new standard community list. @var{community} -is communities value. The @var{community} is compiled into community -structure. We can define multiple community list under same name. In -that case match will happen user defined order. Once the -community list matches to communities attribute in BGP updates it -return permit or deny by the community list definition. When there is -no matched entry, deny will be returned. When @var{community} is -empty it matches to any routes. -@end deffn - -@deffn Command {ip community-list expanded @var{name} @{permit|deny@} @var{line}} {} -This command defines a new expanded community list. @var{line} is a -string expression of communities attribute. @var{line} can be a -regular expression (@pxref{BGP Regular Expressions}) to match -the communities attribute in BGP updates. -@end deffn - -@deffn Command {no ip community-list @var{name}} {} -@deffnx Command {no ip community-list standard @var{name}} {} -@deffnx Command {no ip community-list expanded @var{name}} {} -These commands delete community lists specified by @var{name}. All of -community lists shares a single name space. So community lists can be -removed simpley specifying community lists name. -@end deffn - -@deffn {Command} {show ip community-list} {} -@deffnx {Command} {show ip community-list @var{name}} {} -This command displays current community list information. When -@var{name} is specified the specified community list's information is -shown. - -@example -# show ip community-list -Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet -Named Community expanded list EXPAND - permit : - -# show ip community-list CLIST -Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet -@end example -@end deffn - -@node Numbered BGP Community Lists -@subsection Numbered BGP Community Lists - -When number is used for BGP community list name, the number has -special meanings. Community list number in the range from 1 and 99 is -standard community list. Community list number in the range from 100 -to 199 is expanded community list. These community lists are called -as numbered community lists. On the other hand normal community lists -is called as named community lists. - -@deffn Command {ip community-list <1-99> @{permit|deny@} @var{community}} {} -This command defines a new community list. <1-99> is standard -community list number. Community list name within this range defines -standard community list. When @var{community} is empty it matches to -any routes. -@end deffn - -@deffn Command {ip community-list <100-199> @{permit|deny@} @var{community}} {} -This command defines a new community list. <100-199> is expanded -community list number. Community list name within this range defines -expanded community list. -@end deffn - -@deffn Command {ip community-list @var{name} @{permit|deny@} @var{community}} {} -When community list type is not specifed, the community list type is -automatically detected. If @var{community} can be compiled into -communities attribute, the community list is defined as a standard -community list. Otherwise it is defined as an expanded community -list. This feature is left for backward compability. Use of this -feature is not recommended. -@end deffn - -@node BGP Community in Route Map -@subsection BGP Community in Route Map - -In Route Map (@pxref{Route Map}), we can match or set BGP -communities attribute. Using this feature network operator can -implement their network policy based on BGP communities attribute. - -Following commands can be used in Route Map. - -@deffn {Route Map} {match community @var{word}} {} -@deffnx {Route Map} {match community @var{word} exact-match} {} -This command perform match to BGP updates using community list -@var{word}. When the one of BGP communities value match to the one of -communities value in community list, it is match. When -@code{exact-match} keyword is spcified, match happen only when BGP -updates have completely same communities value specified in the -community list. -@end deffn - -@deffn {Route Map} {set community none} {} -@deffnx {Route Map} {set community @var{community}} {} -@deffnx {Route Map} {set community @var{community} additive} {} -This command manipulate communities value in BGP updates. When -@code{none} is specified as communities value, it removes entire -communities attribute from BGP updates. When @var{community} is not -@code{none}, specified communities value is set to BGP updates. If -BGP updates already has BGP communities value, the existing BGP -communities value is replaced with specified @var{community} value. -When @code{additive} keyword is specified, @var{community} is appended -to the existing communities value. -@end deffn - -@deffn {Route Map} {set comm-list @var{word} delete} {} -This command remove communities value from BGP communities attribute. -The @var{word} is community list name. When BGP route's communities -value matches to the community list @var{word}, the communities value -is removed. When all of communities value is removed eventually, the -BGP update's communities attribute is completely removed. -@end deffn - -@node Display BGP Routes by Community -@subsection Display BGP Routes by Community - -To show BGP routes which has specific BGP communities attribute, -@code{show bgp @{ipv4|ipv6@}} command can be used. The -@var{community} and @var{community-list} subcommand can be used. - -@deffn Command {show bgp @{ipv4|ipv6@} community} {} -@deffnx Command {show bgp @{ipv4|ipv6@} community @var{community}} {} -@deffnx Command {show bgp @{ipv4|ipv6@} community @var{community} exact-match} {} -@code{show bgp @{ipv4|ipv6@} community} displays BGP routes which has communities -attribute. Where the address family can be IPv4 or IPv6 among others. When -@var{community} is specified, BGP routes that matches @var{community} value is -displayed. For this command, @code{internet} keyword can't be used for -@var{community} value. When @code{exact-match} is specified, it display only -routes that have an exact match. -@end deffn - -@deffn Command {show bgp @{ipv4|ipv6@} community-list @var{word}} {} -@deffnx Command {show bgp @{ipv4|ipv6@} community-list @var{word} exact-match} {} -This commands display BGP routes for the address family specified that matches -community list @var{word}. When @code{exact-match} is specified, display only -routes that have an exact match. -@end deffn - -@node Using BGP Communities Attribute -@subsection Using BGP Communities Attribute - -Following configuration is the most typical usage of BGP communities -attribute. AS 7675 provides upstream Internet connection to AS 100. -When following configuration exists in AS 7675, AS 100 networks -operator can set local preference in AS 7675 network by setting BGP -communities attribute to the updates. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list 70 permit 7675:70 -ip community-list 70 deny -ip community-list 80 permit 7675:80 -ip community-list 80 deny -ip community-list 90 permit 7675:90 -ip community-list 90 deny -! -route-map RMAP permit 10 - match community 70 - set local-preference 70 -! -route-map RMAP permit 20 - match community 80 - set local-preference 80 -! -route-map RMAP permit 30 - match community 90 - set local-preference 90 -@end example - -Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675. -The route has communities value 7675:80 so when above configuration -exists in AS 7675, announced route's local preference will be set to -value 80. - -@example -router bgp 100 - network 10.0.0.0/8 - neighbor 192.168.0.2 remote-as 7675 - address-family ipv4 unicast - neighbor 192.168.0.2 route-map RMAP out - exit-address-family -! -ip prefix-list PLIST permit 10.0.0.0/8 -! -route-map RMAP permit 10 - match ip address prefix-list PLIST - set community 7675:80 -@end example - -Following configuration is an example of BGP route filtering using -communities attribute. This configuration only permit BGP routes -which has BGP communities value 0:80 or 0:90. Network operator can -put special internal communities value at BGP border router, then -limit the BGP routes announcement into the internal network. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list 1 permit 0:80 0:90 -! -route-map RMAP permit in - match community 1 -@end example - -Following exmaple filter BGP routes which has communities value 1:1. -When there is no match community-list returns deny. To avoid -filtering all of routes, we need to define permit any at last. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list standard FILTER deny 1:1 -ip community-list standard FILTER permit -! -route-map RMAP permit 10 - match community FILTER -@end example - -Communities value keyword @code{internet} has special meanings in -standard community lists. In below example @code{internet} act as -match any. It matches all of BGP routes even if the route does not -have communities attribute at all. So community list @code{INTERNET} -is same as above example's @code{FILTER}. - -@example -ip community-list standard INTERNET deny 1:1 -ip community-list standard INTERNET permit internet -@end example - -Following configuration is an example of communities value deletion. -With this configuration communities value 100:1 and 100:2 is removed -from BGP updates. For communities value deletion, only @code{permit} -community-list is used. @code{deny} community-list is ignored. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list standard DEL permit 100:1 100:2 -! -route-map RMAP permit 10 - set comm-list DEL delete -@end example - -@c ----------------------------------------------------------------------- -@node BGP Extended Communities Attribute -@section BGP Extended Communities Attribute - -BGP extended communities attribute is introduced with MPLS VPN/BGP -technology. MPLS VPN/BGP expands capability of network infrastructure -to provide VPN functionality. At the same time it requires a new -framework for policy routing. With BGP Extended Communities Attribute -we can use Route Target or Site of Origin for implementing network -policy for MPLS VPN/BGP. - -BGP Extended Communities Attribute is similar to BGP Communities -Attribute. It is an optional transitive attribute. BGP Extended -Communities Attribute can carry multiple Extended Community value. -Each Extended Community value is eight octet length. - -BGP Extended Communities Attribute provides an extended range -compared with BGP Communities Attribute. Adding to that there is a -type field in each value to provides community space structure. - -There are two format to define Extended Community value. One is AS -based format the other is IP address based format. - -@table @code -@item AS:VAL -This is a format to define AS based Extended Community value. -@code{AS} part is 2 octets Global Administrator subfield in Extended -Community value. @code{VAL} part is 4 octets Local Administrator -subfield. @code{7675:100} represents AS 7675 policy value 100. -@item IP-Address:VAL -This is a format to define IP address based Extended Community value. -@code{IP-Address} part is 4 octets Global Administrator subfield. -@code{VAL} part is 2 octets Local Administrator subfield. -@code{10.0.0.1:100} represents -@end table - -@menu -* BGP Extended Community Lists:: -* BGP Extended Communities in Route Map:: -@end menu - -@node BGP Extended Community Lists -@subsection BGP Extended Community Lists - -Expanded Community Lists is a user defined BGP Expanded Community -Lists. - -@deffn Command {ip extcommunity-list standard @var{name} @{permit|deny@} @var{extcommunity}} {} -This command defines a new standard extcommunity-list. -@var{extcommunity} is extended communities value. The -@var{extcommunity} is compiled into extended community structure. We -can define multiple extcommunity-list under same name. In that case -match will happen user defined order. Once the extcommunity-list -matches to extended communities attribute in BGP updates it return -permit or deny based upon the extcommunity-list definition. When -there is no matched entry, deny will be returned. When -@var{extcommunity} is empty it matches to any routes. -@end deffn - -@deffn Command {ip extcommunity-list expanded @var{name} @{permit|deny@} @var{line}} {} -This command defines a new expanded extcommunity-list. @var{line} is -a string expression of extended communities attribute. @var{line} can -be a regular expression (@pxref{BGP Regular Expressions}) to match an -extended communities attribute in BGP updates. -@end deffn - -@deffn Command {no ip extcommunity-list @var{name}} {} -@deffnx Command {no ip extcommunity-list standard @var{name}} {} -@deffnx Command {no ip extcommunity-list expanded @var{name}} {} -These commands delete extended community lists specified by -@var{name}. All of extended community lists shares a single name -space. So extended community lists can be removed simpley specifying -the name. -@end deffn - -@deffn {Command} {show ip extcommunity-list} {} -@deffnx {Command} {show ip extcommunity-list @var{name}} {} -This command displays current extcommunity-list information. When -@var{name} is specified the community list's information is shown. - -@example -# show ip extcommunity-list -@end example -@end deffn - -@node BGP Extended Communities in Route Map -@subsection BGP Extended Communities in Route Map - -@deffn {Route Map} {match extcommunity @var{word}} {} -@end deffn - -@deffn {Route Map} {set extcommunity rt @var{extcommunity}} {} -This command set Route Target value. -@end deffn - -@deffn {Route Map} {set extcommunity soo @var{extcommunity}} {} -This command set Site of Origin value. -@end deffn - -@c ----------------------------------------------------------------------- -@node BGP Large Communities Attribute -@section BGP Large Communities Attribute - -The BGP Large Communities attribute was introduced in Feb 2017 with -@cite{RFC8092, BGP Large Communities Attribute}. - -The BGP Large Communities Attribute is similar to the BGP Communities -Attribute except that it has 3 components instead of two and each of -which are 4 octets in length. Large Communities bring additional -functionality and convenience over traditional communities, specifically -the fact that the @code{GLOBAL} part below is now 4 octets wide allowing -AS4 operators seamless use. - -@table @code -@item GLOBAL:LOCAL1:LOCAL2 -This is the format to define Large Community values. Referencing -@cite{RFC8195, Use of BGP Large Communities} the values are commonly -referred to as follows. -The @code{GLOBAL} part is a 4 octet Global Administrator field, common -use of this field is the operators AS number. -The @code{LOCAL1} part is a 4 octet Local Data Part 1 subfield referred -to as a function. -The @code{LOCAL2} part is a 4 octet Local Data Part 2 field and referred -to as the parameter subfield. @code{65551:1:10} represents AS 65551 -function 1 and parameter 10. -The referenced RFC above gives some guidelines on recommended usage. -@end table - -@menu -* BGP Large Community Lists:: -* BGP Large Communities in Route Map:: -@end menu - -@node BGP Large Community Lists -@subsection BGP Large Community Lists - -Two types of large community lists are supported, namely @code{standard} and -@code{expanded}. - -@deffn Command {ip large-community-list standard @var{name} @{permit|deny@} @var{large-community}} {} -This command defines a new standard large-community-list. -@var{large-community} is the Large Community value. We -can add multiple large communities under same name. In that case -the match will happen in the user defined order. Once the large-community-list -matches the Large Communities attribute in BGP updates it will return -permit or deny based upon the large-community-list definition. When -there is no matched entry, a deny will be returned. When @var{large-community} -is empty it matches any routes. -@end deffn - -@deffn Command {ip large-community-list expanded @var{name} @{permit|deny@} @var{line}} {} -This command defines a new expanded large-community-list. Where @var{line} is -a string matching expression, it will be compared to the entire Large Communities -attribute as a string, with each large-community in order from lowest to highest. -@var{line} can also be a regular expression which matches this Large -Community attribute. -@end deffn - -@deffn Command {no ip large-community-list @var{name}} {} -@deffnx Command {no ip large-community-list standard @var{name}} {} -@deffnx Command {no ip large-community-list expanded @var{name}} {} -These commands delete Large Community lists specified by -@var{name}. All Large Community lists share a single namespace. -This means Large Community lists can be removed by simply specifying the name. -@end deffn - -@deffn {Command} {show ip large-community-list} {} -@deffnx {Command} {show ip large-community-list @var{name}} {} -This command display current large-community-list information. When -@var{name} is specified the community list information is shown. -@end deffn - -@deffn {Command} {show ip bgp large-community-info} {} -This command displays the current large communities in use. -@end deffn - -@node BGP Large Communities in Route Map -@subsection BGP Large Communities in Route Map - -@deffn {Route Map} {match large-community @var{line}} {} -Where @var{line} can be a simple string to match, or a regular expression. -It is very important to note that this match occurs on the entire -large-community string as a whole, where each large-community is ordered -from lowest to highest. -@end deffn - -@deffn {Route Map} {set large-community @var{large-community}} {} -@deffnx {Route Map} {set large-community @var{large-community} @var{large-community}} {} -@deffnx {Route Map} {set large-community @var{large-community} additive} {} -These commands are used for setting large-community values. The first -command will overwrite any large-communities currently present. -The second specifies two large-communities, which overwrites the current -large-community list. The third will add a large-community value without -overwriting other values. Multiple large-community values can be specified. -@end deffn - -@c ----------------------------------------------------------------------- - -@node Displaying BGP information -@section Displaying BGP information - -@menu -* Showing BGP information:: -* Other BGP commands:: -@end menu - -@node Showing BGP information -@subsection Showing BGP information - -@deffn {Command} {show ip bgp} {} -@deffnx {Command} {show ip bgp @var{A.B.C.D}} {} -@deffnx {Command} {show ip bgp @var{X:X::X:X}} {} -This command displays BGP routes. When no route is specified it -display all of IPv4 BGP routes. -@end deffn - -@example -BGP table version is 0, local router ID is 10.1.1.1 -Status codes: s suppressed, d damped, h history, * valid, > best, i - internal -Origin codes: i - IGP, e - EGP, ? - incomplete - - Network Next Hop Metric LocPrf Weight Path -*> 1.1.1.1/32 0.0.0.0 0 32768 i - -Total number of prefixes 1 -@end example - -@deffn {Command} {show ip bgp regexp @var{line}} {} -This command displays BGP routes using AS path regular expression -(@pxref{BGP Regular Expressions}). -@end deffn - -@deffn Command {show ip bgp community @var{community}} {} -@deffnx Command {show ip bgp community @var{community} exact-match} {} -This command displays BGP routes using @var{community} (@pxref{Display -BGP Routes by Community}). -@end deffn - -@deffn Command {show ip bgp community-list @var{word}} {} -@deffnx Command {show ip bgp community-list @var{word} exact-match} {} -This command displays BGP routes using community list (@pxref{Display -BGP Routes by Community}). -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} summary} {} -Show a bgp peer summary for the specified address family. -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} neighbor [@var{peer}]} {} -This command shows information on a specific BGP @var{peer}. -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} dampening dampened-paths} {} -Display paths suppressed due to dampening. -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} dampening flap-statistics} {} -Display flap statistics of routes. -@end deffn - -@node Other BGP commands -@subsection Other BGP commands - -@deffn {Command} {clear bgp @{ipv4|ipv6@} *} {} -Clear all address family peers. -@end deffn - -@deffn {Command} {clear bgp @{ipv4|ipv6@} @var{peer}} {} -Clear peers which have addresses of X.X.X.X -@end deffn - -@deffn {Command} {clear bgp @{ipv4|ipv6@} @var{peer} soft in} {} -Clear peer using soft reconfiguration. -@end deffn - -@deffn {Command} {show debug} {} -@end deffn - -@deffn {Command} {debug event} {} -@end deffn - -@deffn {Command} {debug update} {} -@end deffn - -@deffn {Command} {debug keepalive} {} -@end deffn - -@deffn {Command} {no debug event} {} -@end deffn - -@deffn {Command} {no debug update} {} -@end deffn - -@deffn {Command} {no debug keepalive} {} -@end deffn - -@node Capability Negotiation -@section Capability Negotiation - -When adding IPv6 routing information exchange feature to BGP. There -were some proposals. @acronym{IETF,Internet Engineering Task Force} -@acronym{IDR, Inter Domain Routing} @acronym{WG, Working group} adopted -a proposal called Multiprotocol Extension for BGP. The specification -is described in @cite{RFC2283}. The protocol does not define new protocols. -It defines new attributes to existing BGP. When it is used exchanging -IPv6 routing information it is called BGP-4+. When it is used for -exchanging multicast routing information it is called MBGP. - -@command{bgpd} supports Multiprotocol Extension for BGP. So if remote -peer supports the protocol, @command{bgpd} can exchange IPv6 and/or -multicast routing information. - -Traditional BGP did not have the feature to detect remote peer's -capabilities, e.g. whether it can handle prefix types other than IPv4 -unicast routes. This was a big problem using Multiprotocol Extension -for BGP to operational network. @cite{RFC2842, Capabilities -Advertisement with BGP-4} adopted a feature called Capability -Negotiation. @command{bgpd} use this Capability Negotiation to detect -the remote peer's capabilities. If the peer is only configured as IPv4 -unicast neighbor, @command{bgpd} does not send these Capability -Negotiation packets (at least not unless other optional BGP features -require capability negotation). - -By default, Frr will bring up peering with minimal common capability -for the both sides. For example, local router has unicast and -multicast capabilitie and remote router has unicast capability. In -this case, the local router will establish the connection with unicast -only capability. When there are no common capabilities, Frr sends -Unsupported Capability error and then resets the connection. - -If you want to completely match capabilities with remote peer. Please -use @command{strict-capability-match} command. - -@deffn {BGP} {neighbor @var{peer} strict-capability-match} {} -@deffnx {BGP} {no neighbor @var{peer} strict-capability-match} {} -Strictly compares remote capabilities and local capabilities. If capabilities -are different, send Unsupported Capability error then reset connection. -@end deffn - -You may want to disable sending Capability Negotiation OPEN message -optional parameter to the peer when remote peer does not implement -Capability Negotiation. Please use @command{dont-capability-negotiate} -command to disable the feature. - -@deffn {BGP} {neighbor @var{peer} dont-capability-negotiate} {} -@deffnx {BGP} {no neighbor @var{peer} dont-capability-negotiate} {} -Suppress sending Capability Negotiation as OPEN message optional -parameter to the peer. This command only affects the peer is configured -other than IPv4 unicast configuration. -@end deffn - -When remote peer does not have capability negotiation feature, remote -peer will not send any capabilities at all. In that case, bgp -configures the peer with configured capabilities. - -You may prefer locally configured capabilities more than the negotiated -capabilities even though remote peer sends capabilities. If the peer -is configured by @command{override-capability}, @command{bgpd} ignores -received capabilities then override negotiated capabilities with -configured values. - -@deffn {BGP} {neighbor @var{peer} override-capability} {} -@deffnx {BGP} {no neighbor @var{peer} override-capability} {} -Override the result of Capability Negotiation with local configuration. -Ignore remote peer's capability value. -@end deffn - -@node Route Reflector -@section Route Reflector - -@deffn {BGP} {bgp cluster-id @var{a.b.c.d}} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} route-reflector-client} {} -@deffnx {BGP} {no neighbor @var{peer} route-reflector-client} {} -@end deffn - -@node Route Server -@section Route Server - -At an Internet Exchange point, many ISPs are connected to each other by -external BGP peering. Normally these external BGP connection are done by -@samp{full mesh} method. As with internal BGP full mesh formation, -this method has a scaling problem. - -This scaling problem is well known. Route Server is a method to resolve -the problem. Each ISP's BGP router only peers to Route Server. Route -Server serves as BGP information exchange to other BGP routers. By -applying this method, numbers of BGP connections is reduced from -O(n*(n-1)/2) to O(n). - -Unlike normal BGP router, Route Server must have several routing tables -for managing different routing policies for each BGP speaker. We call the -routing tables as different @code{view}s. @command{bgpd} can work as -normal BGP router or Route Server or both at the same time. - -@menu -* Multiple instance:: -* BGP instance and view:: -* Routing policy:: -* Viewing the view:: -@end menu - -@node Multiple instance -@subsection Multiple instance - -To enable multiple view function of @code{bgpd}, you must turn on -multiple instance feature beforehand. - -@deffn {Command} {bgp multiple-instance} {} -Enable BGP multiple instance feature. After this feature is enabled, -you can make multiple BGP instances or multiple BGP views. -@end deffn - -@deffn {Command} {no bgp multiple-instance} {} -Disable BGP multiple instance feature. You can not disable this feature -when BGP multiple instances or views exist. -@end deffn - -When you want to make configuration more Cisco like one, - -@deffn {Command} {bgp config-type cisco} {} -Cisco compatible BGP configuration output. -@end deffn - -When bgp config-type cisco is specified, - -``no synchronization'' is displayed. -``no auto-summary'' is displayed. - -``network'' and ``aggregate-address'' argument is displayed as -``A.B.C.D M.M.M.M'' - -Frr: network 10.0.0.0/8 -Cisco: network 10.0.0.0 - -Frr: aggregate-address 192.168.0.0/24 -Cisco: aggregate-address 192.168.0.0 255.255.255.0 - -Community attribute handling is also different. If there is no -configuration is specified community attribute and extended community -attribute are sent to neighbor. When user manually disable the -feature community attribute is not sent to the neighbor. In case of -@command{bgp config-type cisco} is specified, community attribute is not -sent to the neighbor by default. To send community attribute user has -to specify @command{neighbor A.B.C.D send-community} command. - -@example -! -router bgp 1 - neighbor 10.0.0.1 remote-as 1 - address-family ipv4 unicast - no neighbor 10.0.0.1 send-community - exit-address-family -! -router bgp 1 - neighbor 10.0.0.1 remote-as 1 - address-family ipv4 unicast - neighbor 10.0.0.1 send-community - exit-address-family -! -@end example - -@deffn {Command} {bgp config-type zebra} {} -Frr style BGP configuration. This is default. -@end deffn - -@node BGP instance and view -@subsection BGP instance and view - -BGP instance is a normal BGP process. The result of route selection -goes to the kernel routing table. You can setup different AS at the -same time when BGP multiple instance feature is enabled. - -@deffn {Command} {router bgp @var{as-number}} {} -Make a new BGP instance. You can use arbitrary word for the @var{name}. -@end deffn - -@example -@group -bgp multiple-instance -! -router bgp 1 - neighbor 10.0.0.1 remote-as 2 - neighbor 10.0.0.2 remote-as 3 -! -router bgp 2 - neighbor 10.0.0.3 remote-as 4 - neighbor 10.0.0.4 remote-as 5 -@end group -@end example - -BGP view is almost same as normal BGP process. The result of -route selection does not go to the kernel routing table. BGP view is -only for exchanging BGP routing information. - -@deffn {Command} {router bgp @var{as-number} view @var{name}} {} -Make a new BGP view. You can use arbitrary word for the @var{name}. This -view's route selection result does not go to the kernel routing table. -@end deffn - -With this command, you can setup Route Server like below. - -@example -@group -bgp multiple-instance -! -router bgp 1 view 1 - neighbor 10.0.0.1 remote-as 2 - neighbor 10.0.0.2 remote-as 3 -! -router bgp 2 view 2 - neighbor 10.0.0.3 remote-as 4 - neighbor 10.0.0.4 remote-as 5 -@end group -@end example - -@node Routing policy -@subsection Routing policy - -You can set different routing policy for a peer. For example, you can -set different filter for a peer. - -@example -@group -bgp multiple-instance -! -router bgp 1 view 1 - neighbor 10.0.0.1 remote-as 2 - address-family ipv4 unicast - neighbor 10.0.0.1 distribute-list 1 in - exit-address-family -! -router bgp 1 view 2 - neighbor 10.0.0.1 remote-as 2 - address-family ipv4 unicast - neighbor 10.0.0.1 distribute-list 2 in - exit-address-family -@end group -@end example - -This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view -2. When the update is inserted into view 1, distribute-list 1 is -applied. On the other hand, when the update is inserted into view 2, -distribute-list 2 is applied. - -@node Viewing the view -@subsection Viewing the view - -To display routing table of BGP view, you must specify view name. - -@deffn {Command} {show ip bgp view @var{name}} {} -Display routing table of BGP view @var{name}. -@end deffn - -@node BGP Regular Expressions -@section BGP Regular Expressions - -BGP regular expressions are based on @code{POSIX 1003.2} regular -expressions. The following description is just a quick subset of the -@code{POSIX} regular expressions. Adding to that, the special character -'_' is added. - -@table @code -@item . -Matches any single character. -@item * -Matches 0 or more occurrences of pattern. -@item + -Matches 1 or more occurrences of pattern. -@item ? -Match 0 or 1 occurrences of pattern. -@item ^ -Matches the beginning of the line. -@item $ -Matches the end of the line. -@item _ -Character @code{_} has special meanings in BGP regular expressions. -It matches to space and comma , and AS set delimiter @{ and @} and AS -confederation delimiter @code{(} and @code{)}. And it also matches to -the beginning of the line and the end of the line. So @code{_} can be -used for AS value boundaries match. This character technically evaluates -to @code{(^|[,@{@}() ]|$)}. -@end table - -@node How to set up a 6-Bone connection -@section How to set up a 6-Bone connection - - -@example -@group -zebra configuration -=================== -! -! Actually there is no need to configure zebra -! - -bgpd configuration -================== -! -! This means that routes go through zebra and into the kernel. -! -router zebra -! -! MP-BGP configuration -! -router bgp 7675 - bgp router-id 10.0.0.1 - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as @var{as-number} -! - address-family ipv6 - network 3ffe:506::/32 - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out - neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as @var{as-number} - neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out - exit-address-family -! -ipv6 access-list all permit any -! -! Set output nexthop address. -! -route-map set-nexthop permit 10 - match ipv6 address all - set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 - set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 -! -! logfile FILENAME is obsolete. Please use log file FILENAME - -log file bgpd.log -! -@end group -@end example - -@node Dump BGP packets and table -@section Dump BGP packets and table - -@deffn Command {dump bgp all @var{path} [@var{interval}]} {} -@deffnx Command {dump bgp all-et @var{path} [@var{interval}]} {} -@deffnx Command {no dump bgp all [@var{path}] [@var{interval}]} {} -Dump all BGP packet and events to @var{path} file. -If @var{interval} is set, a new file will be created for echo @var{interval} of seconds. -The path @var{path} can be set with date and time formatting (strftime). -The type ‘all-et’ enables support for Extended Timestamp Header (@pxref{Packet Binary Dump Format}). -(@pxref{Packet Binary Dump Format}) -@end deffn - -@deffn Command {dump bgp updates @var{path} [@var{interval}]} {} -@deffnx Command {dump bgp updates-et @var{path} [@var{interval}]} {} -@deffnx Command {no dump bgp updates [@var{path}] [@var{interval}]} {} -Dump only BGP updates messages to @var{path} file. -If @var{interval} is set, a new file will be created for echo @var{interval} of seconds. -The path @var{path} can be set with date and time formatting (strftime). -The type ‘updates-et’ enables support for Extended Timestamp Header (@pxref{Packet Binary Dump Format}). -@end deffn - -@deffn Command {dump bgp routes-mrt @var{path}} {} -@deffnx Command {dump bgp routes-mrt @var{path} @var{interval}} {} -@deffnx Command {no dump bgp route-mrt [@var{path}] [@var{interval}]} {} -Dump whole BGP routing table to @var{path}. This is heavy process. -The path @var{path} can be set with date and time formatting (strftime). -If @var{interval} is set, a new file will be created for echo @var{interval} of seconds. -@end deffn - -Note: the interval variable can also be set using hours and minutes: 04h20m00. - - -@node BGP Configuration Examples -@section BGP Configuration Examples - -Example of a session to an upstream, advertising only one prefix to it. - -@example -router bgp 64512 - bgp router-id 10.236.87.1 - neighbor upstream peer-group - neighbor upstream remote-as 64515 - neighbor upstream capability dynamic - neighbor 10.1.1.1 peer-group upstream - neighbor 10.1.1.1 description ACME ISP - - address-family ipv4 unicast - network 10.236.87.0/24 - neighbor upstream prefix-list pl-allowed-adv out - exit-address-family -! -ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 -ip prefix-list pl-allowed-adv seq 10 deny any - -@end example - -A more complex example. With upstream, peer and customer sessions. -Advertising global prefixes and NO_EXPORT prefixes and providing -actions for customer routes based on community values. Extensive use of -route-maps and the 'call' feature to support selective advertising of -prefixes. This example is intended as guidance only, it has NOT been -tested and almost certainly containts silly mistakes, if not serious -flaws. - -@example -router bgp 64512 - bgp router-id 10.236.87.1 - neighbor upstream capability dynamic - neighbor cust capability dynamic - neighbor peer capability dynamic - neighbor 10.1.1.1 remote-as 64515 - neighbor 10.1.1.1 peer-group upstream - neighbor 10.2.1.1 remote-as 64516 - neighbor 10.2.1.1 peer-group upstream - neighbor 10.3.1.1 remote-as 64517 - neighbor 10.3.1.1 peer-group cust-default - neighbor 10.3.1.1 description customer1 - neighbor 10.4.1.1 remote-as 64518 - neighbor 10.4.1.1 peer-group cust - neighbor 10.4.1.1 description customer2 - neighbor 10.5.1.1 remote-as 64519 - neighbor 10.5.1.1 peer-group peer - neighbor 10.5.1.1 description peer AS 1 - neighbor 10.6.1.1 remote-as 64520 - neighbor 10.6.1.1 peer-group peer - neighbor 10.6.1.1 description peer AS 2 - - address-family ipv4 unicast - network 10.123.456.0/24 - network 10.123.456.128/25 route-map rm-no-export - neighbor upstream route-map rm-upstream-out out - neighbor cust route-map rm-cust-in in - neighbor cust route-map rm-cust-out out - neighbor cust send-community both - neighbor peer route-map rm-peer-in in - neighbor peer route-map rm-peer-out out - neighbor peer send-community both - neighbor 10.3.1.1 prefix-list pl-cust1-network in - neighbor 10.4.1.1 prefix-list pl-cust2-network in - neighbor 10.5.1.1 prefix-list pl-peer1-network in - neighbor 10.6.1.1 prefix-list pl-peer2-network in - exit-address-family -! -ip prefix-list pl-default permit 0.0.0.0/0 -! -ip prefix-list pl-upstream-peers permit 10.1.1.1/32 -ip prefix-list pl-upstream-peers permit 10.2.1.1/32 -! -ip prefix-list pl-cust1-network permit 10.3.1.0/24 -ip prefix-list pl-cust1-network permit 10.3.2.0/24 -! -ip prefix-list pl-cust2-network permit 10.4.1.0/24 -! -ip prefix-list pl-peer1-network permit 10.5.1.0/24 -ip prefix-list pl-peer1-network permit 10.5.2.0/24 -ip prefix-list pl-peer1-network permit 192.168.0.0/24 -! -ip prefix-list pl-peer2-network permit 10.6.1.0/24 -ip prefix-list pl-peer2-network permit 10.6.2.0/24 -ip prefix-list pl-peer2-network permit 192.168.1.0/24 -ip prefix-list pl-peer2-network permit 192.168.2.0/24 -ip prefix-list pl-peer2-network permit 172.16.1/24 -! -ip as-path access-list asp-own-as permit ^$ -ip as-path access-list asp-own-as permit _64512_ -! -! ################################################################# -! Match communities we provide actions for, on routes receives from -! customers. Communities values of :X, with X, have actions: -! -! 100 - blackhole the prefix -! 200 - set no_export -! 300 - advertise only to other customers -! 400 - advertise only to upstreams -! 500 - set no_export when advertising to upstreams -! 2X00 - set local_preference to X00 -! -! blackhole the prefix of the route -ip community-list standard cm-blackhole permit 64512:100 -! -! set no-export community before advertising -ip community-list standard cm-set-no-export permit 64512:200 -! -! advertise only to other customers -ip community-list standard cm-cust-only permit 64512:300 -! -! advertise only to upstreams -ip community-list standard cm-upstream-only permit 64512:400 -! -! advertise to upstreams with no-export -ip community-list standard cm-upstream-noexport permit 64512:500 -! -! set local-pref to least significant 3 digits of the community -ip community-list standard cm-prefmod-100 permit 64512:2100 -ip community-list standard cm-prefmod-200 permit 64512:2200 -ip community-list standard cm-prefmod-300 permit 64512:2300 -ip community-list standard cm-prefmod-400 permit 64512:2400 -ip community-list expanded cme-prefmod-range permit 64512:2... -! -! Informational communities -! -! 3000 - learned from upstream -! 3100 - learned from customer -! 3200 - learned from peer -! -ip community-list standard cm-learnt-upstream permit 64512:3000 -ip community-list standard cm-learnt-cust permit 64512:3100 -ip community-list standard cm-learnt-peer permit 64512:3200 -! -! ################################################################### -! Utility route-maps -! -! These utility route-maps generally should not used to permit/deny -! routes, i.e. they do not have meaning as filters, and hence probably -! should be used with 'on-match next'. These all finish with an empty -! permit entry so as not interfere with processing in the caller. -! -route-map rm-no-export permit 10 - set community additive no-export -route-map rm-no-export permit 20 -! -route-map rm-blackhole permit 10 - description blackhole, up-pref and ensure it cant escape this AS - set ip next-hop 127.0.0.1 - set local-preference 10 - set community additive no-export -route-map rm-blackhole permit 20 -! -! Set local-pref as requested -route-map rm-prefmod permit 10 - match community cm-prefmod-100 - set local-preference 100 -route-map rm-prefmod permit 20 - match community cm-prefmod-200 - set local-preference 200 -route-map rm-prefmod permit 30 - match community cm-prefmod-300 - set local-preference 300 -route-map rm-prefmod permit 40 - match community cm-prefmod-400 - set local-preference 400 -route-map rm-prefmod permit 50 -! -! Community actions to take on receipt of route. -route-map rm-community-in permit 10 - description check for blackholing, no point continuing if it matches. - match community cm-blackhole - call rm-blackhole -route-map rm-community-in permit 20 - match community cm-set-no-export - call rm-no-export - on-match next -route-map rm-community-in permit 30 - match community cme-prefmod-range - call rm-prefmod -route-map rm-community-in permit 40 -! -! ##################################################################### -! Community actions to take when advertising a route. -! These are filtering route-maps, -! -! Deny customer routes to upstream with cust-only set. -route-map rm-community-filt-to-upstream deny 10 - match community cm-learnt-cust - match community cm-cust-only -route-map rm-community-filt-to-upstream permit 20 -! -! Deny customer routes to other customers with upstream-only set. -route-map rm-community-filt-to-cust deny 10 - match community cm-learnt-cust - match community cm-upstream-only -route-map rm-community-filt-to-cust permit 20 -! -! ################################################################### -! The top-level route-maps applied to sessions. Further entries could -! be added obviously.. -! -! Customers -route-map rm-cust-in permit 10 - call rm-community-in - on-match next -route-map rm-cust-in permit 20 - set community additive 64512:3100 -route-map rm-cust-in permit 30 -! -route-map rm-cust-out permit 10 - call rm-community-filt-to-cust - on-match next -route-map rm-cust-out permit 20 -! -! Upstream transit ASes -route-map rm-upstream-out permit 10 - description filter customer prefixes which are marked cust-only - call rm-community-filt-to-upstream - on-match next -route-map rm-upstream-out permit 20 - description only customer routes are provided to upstreams/peers - match community cm-learnt-cust -! -! Peer ASes -! outbound policy is same as for upstream -route-map rm-peer-out permit 10 - call rm-upstream-out -! -route-map rm-peer-in permit 10 - set community additive 64512:3200 -@end example - -@include rpki.texi diff --git a/doc/defines.texi.in b/doc/defines.texi.in deleted file mode 100644 index b2af89e40a..0000000000 --- a/doc/defines.texi.in +++ /dev/null @@ -1,21 +0,0 @@ -@c -*- texinfo -*- -@c @configure_input@ - -@c Set variables -@set PACKAGE_NAME @PACKAGE_NAME@ -@set PACKAGE_TARNAME @PACKAGE_TARNAME@ -@set PACKAGE_STRING @PACKAGE_STRING@ -@set PACKAGE_URL @PACKAGE_URL@ -@set PACKAGE_VERSION @PACKAGE_VERSION@ -@set AUTHORS Kunihiro Ishiguro, et al. -@set COPYRIGHT_YEAR 1999-2005 -@set COPYRIGHT_STR Copyright @copyright{} @value{COPYRIGHT_YEAR} @value{AUTHORS} - -@c These may vary with installation environment. -@set INSTALL_PREFIX_ETC @CFG_SYSCONF@ -@set INSTALL_PREFIX_SBIN @CFG_SBIN@ -@set INSTALL_PREFIX_STATE @CFG_STATE@ -@set INSTALL_PREFIX_MODULES @CFG_MODULE@ -@set INSTALL_USER @enable_user@ -@set INSTALL_GROUP @enable_group@ -@set INSTALL_VTY_GROUP @enable_vty_group@ diff --git a/doc/eigrpd.texi b/doc/eigrpd.texi deleted file mode 100644 index a3a82bbefb..0000000000 --- a/doc/eigrpd.texi +++ /dev/null @@ -1,216 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@node EIGRP -@chapter EIGRP - -EIGRP -- Routing Information Protocol is widely deployed interior gateway -routing protocol. EIGRP was developed in the 1990's. EIGRP is a -@dfn{distance-vector} protocol and is based on the @dfn{dual} algorithms. -As a distance-vector protocol, the EIGRP router send updates to its -neighbors as networks change, thus allowing the convergence to a -known topology. - -@command{eigrpd} supports EIGRP as described in RFC7868 - -@menu -* Starting and Stopping eigrpd:: -* EIGRP Configuration:: -* How to Announce EIGRP routes:: -* Show EIGRP Information:: -* EIGRP Debug Commands:: -@end menu - -@node Starting and Stopping eigrpd -@section Starting and Stopping eigrpd - -The default configuration file name of @command{eigrpd}'s is -@file{eigrpd.conf}. When invocation @command{eigrpd} searches directory -@value{INSTALL_PREFIX_ETC}. If @file{eigrpd.conf} is not there next -search current directory. If an integrated config is specified -configuration is written into frr.conf - -The EIGRP protocol requires interface information -maintained by @command{zebra} daemon. So running @command{zebra} -is mandatory to run @command{eigrpd}. Thus minimum sequence for running -EIGRP is like below: - -@example -@group -# zebra -d -# eigrpd -d -@end group -@end example - -Please note that @command{zebra} must be invoked before @command{eigrpd}. - -To stop @command{eigrpd}. Please use @command{kill `cat -/var/run/eigrpd.pid`}. Certain signals have special meanings to @command{eigrpd}. - -@table @samp -@item SIGHUP -@item SIGUSR1 -Rotate @command{eigrpd} Rotate the logfile. -@item SIGINT -@itemx SIGTERM -@command{eigrpd} sweeps all installed EIGRP routes then terminates properly. -@end table - -@command{eigrpd} invocation options. Common options that can be specified -(@pxref{Common Invocation Options}). - -@table @samp -@item -r -@itemx --retain -When the program terminates, retain routes added by @command{eigrpd}. -@end table - -@node EIGRP Configuration -@section EIGRP Configuration - -@deffn Command {router eigrp (1-65535)} {} -The @code{router eigrp} command is necessary to enable EIGRP. To disable -EIGRP, use the @code{no router eigrp (1-65535)} command. EIGRP must be enabled before carrying out any of the EIGRP commands. -@end deffn - -@deffn Command {no router eigrp (1-65535)} {} -Disable EIGRP. -@end deffn - -@deffn {EIGRP Command} {network @var{network}} {} -@deffnx {EIGRP Command} {no network @var{network}} {} -Set the EIGRP enable interface by @var{network}. The interfaces which -have addresses matching with @var{network} are enabled. - -This group of commands either enables or disables EIGRP interfaces between -certain numbers of a specified network address. For example, if the -network for 10.0.0.0/24 is EIGRP enabled, this would result in all the -addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The @code{no -network} command will disable EIGRP for the specified network. -@end deffn - -Below is very simple EIGRP configuration. Interface @code{eth0} and -interface which address match to @code{10.0.0.0/8} are EIGRP enabled. - -@example -@group -! -router eigrp 1 - network 10.0.0.0/8 -! -@end group -@end example - -Passive interface - -@deffn {EIGRP command} {passive-interface (@var{IFNAME}|default)} {} -@deffnx {EIGRP command} {no passive-interface @var{IFNAME}} {} -This command sets the specified interface to passive mode. On passive mode -interface, all receiving packets are ignored and eigrpd does -not send either multicast or unicast EIGRP packets except to EIGRP neighbors -specified with @code{neighbor} command. The interface may be specified -as @var{default} to make eigrpd default to passive on all interfaces. - -The default is to be passive on all interfaces. -@end deffn - -@node How to Announce EIGRP route -@section How to Announce EIGRP route - -@deffn {EIGRP command} {redistribute kernel} {} -@deffnx {EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -@deffnx {EIGRP command} {no redistribute kernel} {} -@code{redistribute kernel} redistributes routing information from -kernel route entries into the EIGRP tables. @code{no redistribute kernel} -disables the routes. -@end deffn - -@deffn {EIGRP command} {redistribute static} {} -@deffnx {EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -@deffnx {EIGRP command} {no redistribute static} {} -@code{redistribute static} redistributes routing information from -static route entries into the EIGRP tables. @code{no redistribute static} -disables the routes. -@end deffn - -@deffn {EIGRP command} {redistribute connected} {} -@deffnx {EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -@deffnx {EIGRP command} {no redistribute connected} {} -Redistribute connected routes into the EIGRP tables. @code{no -redistribute connected} disables the connected routes in the EIGRP tables. -This command redistribute connected of the interface which EIGRP disabled. -The connected route on EIGRP enabled interface is announced by default. -@end deffn - -@deffn {EIGRP command} {redistribute ospf} {} -@deffnx {EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -@deffnx {EIGRP command} {no redistribute ospf} {} -@code{redistribute ospf} redistributes routing information from -ospf route entries into the EIGRP tables. @code{no redistribute ospf} -disables the routes. -@end deffn - -@deffn {EIGRP command} {redistribute bgp} {} -@deffnx {EIGRP command} {redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -@deffnx {EIGRP command} {no redistribute bgp} {} -@code{redistribute bgp} redistributes routing information from -bgp route entries into the EIGRP tables. @code{no redistribute bgp} -disables the routes. -@end deffn - -@node Show EIGRP Information -@section Show EIGRP Information - -To display EIGRP routes. - -@deffn Command {show ip eigrp topology} {} -Show EIGRP routes. -@end deffn - -The command displays all EIGRP routes. - -@c Exmaple here. - -@deffn Command {show ip eigrp topology} {} -The command displays current EIGRP status -@end deffn - -@example -@group -eigrpd> @b{show ip eigrp topology} -# show ip eigrp topo - -EIGRP Topology Table for AS(4)/ID(0.0.0.0) - -Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply - r - reply Status, s - sia Status - -P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 - via Connected, enp0s3 -@end group -@end example - -@node EIGRP Debug Commands -@section EIGRP Debug Commands - -Debug for EIGRP protocol. - -@deffn Command {debug eigrp packets} {} -Debug eigrp packets -@end deffn - -@code{debug eigrp} will show EIGRP packets that are sent and recevied. - -@deffn Command {debug eigrp transmit} {} -Debug eigrp transmit events -@end deffn - -@code{debug eigrp transmit} will display detailed information about the EIGRP transmit events. - -@deffn Command {show debugging eigrp} {} -Display @command{eigrpd}'s debugging option. -@end deffn - -@code{show debugging eigrp} will show all information currently set for eigrpd -debug. diff --git a/doc/filter.texi b/doc/filter.texi deleted file mode 100644 index a494043659..0000000000 --- a/doc/filter.texi +++ /dev/null @@ -1,182 +0,0 @@ -@node Filtering -@comment node-name, next, previous, up -@chapter Filtering - -Frr provides many very flexible filtering features. Filtering is used -for both input and output of the routing information. Once filtering is -defined, it can be applied in any direction. - -@menu -* IP Access List:: -* IP Prefix List:: -@end menu - -@node IP Access List -@comment node-name, next, previous, up -@section IP Access List - -@deffn {Command} {access-list @var{name} permit @var{ipv4-network}} {} -@deffnx {Command} {access-list @var{name} deny @var{ipv4-network}} {} -@end deffn - -Basic filtering is done by @code{access-list} as shown in the -following example. - -@example -access-list filter deny 10.0.0.0/9 -access-list filter permit 10.0.0.0/8 -@end example - -@node IP Prefix List -@comment node-name, next, previous, up -@section IP Prefix List - -@command{ip prefix-list} provides the most powerful prefix based -filtering mechanism. In addition to @command{access-list} functionality, -@command{ip prefix-list} has prefix length range specification and -sequential number specification. You can add or delete prefix based -filters to arbitrary points of prefix-list using sequential number specification. - -If no ip prefix-list is specified, it acts as permit. If @command{ip prefix-list} -is defined, and no match is found, default deny is applied. - -@c @deffn {Command} {ip prefix-list @var{name} [seq @var{number}] permit|deny [le @var{prefixlen}] [ge @var{prefixlen}]} {} -@deffn {Command} {ip prefix-list @var{name} (permit|deny) @var{prefix} [le @var{len}] [ge @var{len}]} {} -@deffnx {Command} {ip prefix-list @var{name} seq @var{number} (permit|deny) @var{prefix} [le @var{len}] [ge @var{len}]} {} - -You can create @command{ip prefix-list} using above commands. - -@table @asis - -@item @asis{seq} -seq @var{number} can be set either automatically or manually. In the -case that sequential numbers are set manually, the user may pick any -number less than 4294967295. In the case that sequential number are set -automatically, the sequential number will increase by a unit of five (5) -per list. If a list with no specified sequential number is created -after a list with a specified sequential number, the list will -automatically pick the next multiple of five (5) as the list number. -For example, if a list with number 2 already exists and a new list with -no specified number is created, the next list will be numbered 5. If -lists 2 and 7 already exist and a new list with no specified number is -created, the new list will be numbered 10. - -@item @asis{le} -@command{le} command specifies prefix length. The prefix list will be -applied if the prefix length is less than or equal to the le prefix length. - -@item @asis{ge} -@command{ge} command specifies prefix length. The prefix list will be -applied if the prefix length is greater than or equal to the ge prefix length. - -@end table - -@end deffn - -Less than or equal to prefix numbers and greater than or equal to -prefix numbers can be used together. The order of the le and ge -commands does not matter. - -If a prefix list with a different sequential number but with the exact -same rules as a previous list is created, an error will result. -However, in the case that the sequential number and the rules are -exactly similar, no error will result. - -If a list with the same sequential number as a previous list is created, -the new list will overwrite the old list. - -Matching of IP Prefix is performed from the smaller sequential number to the -larger. The matching will stop once any rule has been applied. - -In the case of no le or ge command, the prefix length must match exactly the -length specified in the prefix list. - -@deffn {Command} {no ip prefix-list @var{name}} {} -@end deffn - -@menu -* ip prefix-list description:: -* ip prefix-list sequential number control:: -* Showing ip prefix-list:: -* Clear counter of ip prefix-list:: -@end menu - -@node ip prefix-list description -@subsection ip prefix-list description - -@deffn {Command} {ip prefix-list @var{name} description @var{desc}} {} -Descriptions may be added to prefix lists. This command adds a -description to the prefix list. -@end deffn - -@deffn {Command} {no ip prefix-list @var{name} description [@var{desc}]} {} -Deletes the description from a prefix list. It is possible to use the -command without the full description. -@end deffn - -@node ip prefix-list sequential number control -@subsection ip prefix-list sequential number control - -@deffn {Command} {ip prefix-list sequence-number} {} -With this command, the IP prefix list sequential number is displayed. -This is the default behavior. -@end deffn - -@deffn {Command} {no ip prefix-list sequence-number} {} -With this command, the IP prefix list sequential number is not -displayed. -@end deffn - -@node Showing ip prefix-list -@subsection Showing ip prefix-list - -@deffn {Command} {show ip prefix-list} {} -Display all IP prefix lists. -@end deffn - -@deffn {Command} {show ip prefix-list @var{name}} {} -Show IP prefix list can be used with a prefix list name. -@end deffn - -@deffn {Command} {show ip prefix-list @var{name} seq @var{num}} {} -Show IP prefix list can be used with a prefix list name and sequential -number. -@end deffn - -@deffn {Command} {show ip prefix-list @var{name} @var{a.b.c.d/m}} {} -If the command longer is used, all prefix lists with prefix lengths equal to -or longer than the specified length will be displayed. -If the command first match is used, the first prefix length match will be -displayed. -@end deffn - -@deffn {Command} {show ip prefix-list @var{name} @var{a.b.c.d/m} longer} {} -@end deffn - -@deffn {Command} {show ip prefix-list @var{name} @var{a.b.c.d/m} first-match} {} -@end deffn - -@deffn {Command} {show ip prefix-list summary} {} -@end deffn -@deffn {Command} {show ip prefix-list summary @var{name}} {} -@end deffn - -@deffn {Command} {show ip prefix-list detail} {} -@end deffn -@deffn {Command} {show ip prefix-list detail @var{name}} {} -@end deffn - -@node Clear counter of ip prefix-list -@subsection Clear counter of ip prefix-list - -@deffn {Command} {clear ip prefix-list} {} -Clears the counters of all IP prefix lists. Clear IP Prefix List can be -used with a specified name and prefix. -@end deffn - -@deffn {Command} {clear ip prefix-list @var{name}} {} -@end deffn - -@deffn {Command} {clear ip prefix-list @var{name} @var{a.b.c.d/m}} {} -@end deffn - diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/install.texi b/doc/install.texi deleted file mode 100644 index 19d9614420..0000000000 --- a/doc/install.texi +++ /dev/null @@ -1,287 +0,0 @@ -@node Installation -@chapter Installation - -@cindex How to install Frr -@cindex Installation -@cindex Installing Frr -@cindex Building the system -@cindex Making Frr - -There are three steps for installing the software: configuration, -compilation, and installation. - -@menu -* Configure the Software:: -* Build the Software:: -* Install the Software:: -@end menu - -The easiest way to get Frr running is to issue the following -commands: - -@example -% configure -% make -% make install -@end example - -@node Configure the Software -@section Configure the Software - -@menu -* The Configure script and its options:: -* Least-Privilege support:: -* Linux notes:: -@end menu - -@node The Configure script and its options -@subsection The Configure script and its options - -@cindex Configuration options -@cindex Options for configuring -@cindex Build options -@cindex Distribution configuration -@cindex Options to @code{./configure} - -Frr has an excellent configure script which automatically detects most -host configurations. There are several additional configure options to -customize the build to include or exclude specific features and dependencies. - -@table @option -@item --disable-zebra -Do not build zebra daemon. -@item --disable-ripd -Do not build ripd. -@item --disable-ripngd -Do not build ripngd. -@item --disable-ospfd -Do not build ospfd. -@item --disable-ospf6d -Do not build ospf6d. -@item --disable-bgpd -Do not build bgpd. -@item --disable-bgp-announce -Make @command{bgpd} which does not make bgp announcements at all. This -feature is good for using @command{bgpd} as a BGP announcement listener. -@item --enable-datacenter -Enable system defaults to work as if in a Data Center. See defaults.h -for what is changed by this configure option. -@item --enable-snmp -Enable SNMP support. By default, SNMP support is disabled. -@item --disable-ospfapi -Disable support for OSPF-API, an API to interface directly with ospfd. -OSPF-API is enabled if --enable-opaque-lsa is set. -@item --disable-ospfclient -Disable building of the example OSPF-API client. -@item --disable-ospf-ri -Disable support for OSPF Router Information (RFC4970 & RFC5088) this -requires support for Opaque LSAs and Traffic Engineering. -@item --disable-isisd -Do not build isisd. -@item --enable-isis-topology -Enable IS-IS topology generator. -@item --enable-isis-te -Enable Traffic Engineering Extension for ISIS (RFC5305) -@item --enable-multipath=@var{ARG} -Enable support for Equal Cost Multipath. @var{ARG} is the maximum number -of ECMP paths to allow, set to 0 to allow unlimited number of paths. -@item --disable-rtadv -Disable support IPV6 router advertisement in zebra. -@item --enable-gcc-rdynamic -Pass the @command{-rdynamic} option to the linker driver. This is in most -cases neccessary for getting usable backtraces. This option defaults to on -if the compiler is detected as gcc, but giving an explicit enable/disable is -suggested. -@item --disable-backtrace -Controls backtrace support for the crash handlers. This is autodetected by -default. Using the switch will enforce the requested behaviour, failing with -an error if support is requested but not available. On BSD systems, this -needs libexecinfo, while on glibc support for this is part of libc itself. -@item --enable-dev-build -Turn on some options for compiling FRR within a development environment in -mind. Specifically turn on -g3 -O0 for compiling options and add inclusion -of grammar sandbox. -@item --enable-fuzzing -Turn on some compile options to allow you to run fuzzing tools -against the system. This tools is intended as a developer -only tool and should not be used for normal operations -@end table - -You may specify any combination of the above options to the configure -script. By default, the executables are placed in @file{/usr/local/sbin} -and the configuration files in @file{/usr/local/etc}. The @file{/usr/local/} -installation prefix and other directories may be changed using the following -options to the configuration script. - -@table @option -@item --prefix=@var{prefix} -Install architecture-independent files in @var{prefix} [/usr/local]. -@item --sysconfdir=@var{dir} -Look for configuration files in @var{dir} [@var{prefix}/etc]. Note -that sample configuration files will be installed here. -@item --localstatedir=@var{dir} -Configure zebra to use @var{dir} for local state files, such -as pid files and unix sockets. -@end table - -@example -% ./configure --disable-snmp -@end example - -This command will configure zebra and the routing daemons. - -@node Least-Privilege support -@subsection Least-Privilege support - -@cindex Frr Least-Privileges -@cindex Frr Privileges - -Additionally, you may configure zebra to drop its elevated privileges -shortly after startup and switch to another user. The configure script will -automatically try to configure this support. There are three configure -options to control the behaviour of Frr daemons. - -@table @option -@item --enable-user=@var{user} -Switch to user @var{ARG} shortly after startup, and run as user @var{ARG} -in normal operation. -@item --enable-group=@var{group} -Switch real and effective group to @var{group} shortly after -startup. -@item --enable-vty-group=@var{group} -Create Unix Vty sockets (for use with vtysh) with group owndership set to -@var{group}. This allows one to create a seperate group which is -restricted to accessing only the Vty sockets, hence allowing one to -delegate this group to individual users, or to run vtysh setgid to -this group. -@end table - -The default user and group which will be configured is 'frr' if no user -or group is specified. Note that this user or group requires write access to -the local state directory (see --localstatedir) and requires at least read -access, and write access if you wish to allow daemons to write out their -configuration, to the configuration directory (see --sysconfdir). - -On systems which have the 'libcap' capabilities manipulation library -(currently only linux), the frr system will retain only minimal -capabilities required, further it will only raise these capabilities for -brief periods. On systems without libcap, frr will run as the user -specified and only raise its uid back to uid 0 for brief periods. - -@node Linux notes -@subsection Linux Notes - -@cindex Configuring Frr -@cindex Building on Linux boxes -@cindex Linux configurations - -There are several options available only to @sc{gnu}/Linux systems: -@footnote{@sc{gnu}/Linux has very flexible kernel configuration features}. If -you use @sc{gnu}/Linux, make sure that the current kernel configuration is -what you want. Frr will run with any kernel configuration but some -recommendations do exist. - -@table @var - -@item CONFIG_NETLINK -Kernel/User netlink socket. This is a brand new feature which enables an -advanced interface between the Linux kernel and zebra (@pxref{Kernel Interface}). - -@item CONFIG_RTNETLINK -Routing messages. -This makes it possible to receive netlink routing messages. If you -specify this option, @command{zebra} can detect routing information -updates directly from the kernel (@pxref{Kernel Interface}). - -@item CONFIG_IP_MULTICAST -IP: multicasting. -This option should be specified when you use @command{ripd} (@pxref{RIP}) or -@command{ospfd} (@pxref{OSPFv2}) because these protocols use multicast. - -@end table - -IPv6 support has been added in @sc{gnu}/Linux kernel version 2.2. If you -try to use the Frr IPv6 feature on a @sc{gnu}/Linux kernel, please -make sure the following libraries have been installed. Please note that -these libraries will not be needed when you uses @sc{gnu} C library 2.1 -or upper. - -@table @code - -@item inet6-apps -The @code{inet6-apps} package includes basic IPv6 related libraries such -as @code{inet_ntop} and @code{inet_pton}. Some basic IPv6 programs such -as @command{ping}, @command{ftp}, and @command{inetd} are also -included. The @code{inet-apps} can be found at -@uref{ftp://ftp.inner.net/pub/ipv6/}. - -@item net-tools -The @code{net-tools} package provides an IPv6 enabled interface and -routing utility. It contains @command{ifconfig}, @command{route}, -@command{netstat}, and other tools. @code{net-tools} may be found at -@uref{http://www.tazenda.demon.co.uk/phil/net-tools/}. - -@end table -@c A - end of footnote - -@node Build the Software -@section Build the Software - -After configuring the software, you will need to compile it for your -system. Simply issue the command @command{make} in the root of the source -directory and the software will be compiled. Cliff Note versions of -different compilation examples can be found in the doc/Building_FRR_on_XXX.md -files. If you have *any* problems at this stage, be certain to send a -bug report @xref{Bug Reports}. - -@example -% ./bootstrap.sh -% ./configure -% make -@end example -@c A - End of node, Building the Software - - -@node Install the Software -@comment node-name, next, previous, up -@section Install the Software - -Installing the software to your system consists of copying the compiled -programs and supporting files to a standard location. After the -installation process has completed, these files have been copied -from your work directory to @file{/usr/local/bin}, and @file{/usr/local/etc}. - -To install the Frr suite, issue the following command at your shell -prompt: @command{make install}. - -@example -% -% make install -% -@end example - -Frr daemons have their own terminal interface or VTY. After -installation, you have to setup each beast's port number to connect to -them. Please add the following entries to @file{/etc/services}. - -@example -zebrasrv 2600/tcp # zebra service -zebra 2601/tcp # zebra vty -ripd 2602/tcp # RIPd vty -ripngd 2603/tcp # RIPngd vty -ospfd 2604/tcp # OSPFd vty -bgpd 2605/tcp # BGPd vty -ospf6d 2606/tcp # OSPF6d vty -ospfapi 2607/tcp # ospfapi -isisd 2608/tcp # ISISd vty -nhrpd 2610/tcp # nhrpd vty -pimd 2611/tcp # PIMd vty -@end example - -If you use a FreeBSD newer than 2.2.8, the above entries are already -added to @file{/etc/services} so there is no need to add it. If you -specify a port number when starting the daemon, these entries may not be -needed. - -You may need to make changes to the config files in -@file{@value{INSTALL_PREFIX_ETC}/*.conf}. @xref{Config Commands}. diff --git a/doc/ipv6.texi b/doc/ipv6.texi deleted file mode 100644 index 859f6a960e..0000000000 --- a/doc/ipv6.texi +++ /dev/null @@ -1,186 +0,0 @@ -@node IPv6 Support -@chapter IPv6 Support - -Frr fully supports IPv6 routing. As described so far, Frr supports -RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface -and configure static IPv6 routing information. Frr IPv6 also provides -automatic address configuration via a feature called @code{address -auto configuration}. To do it, the router must send router advertisement -messages to the all nodes that exist on the network. - -Previous versions of Frr could be built without IPv6 support. This is -no longer possible. - -@menu -* Router Advertisement:: -@end menu - -@node Router Advertisement -@section Router Advertisement - -@deffn {Interface Command} {no ipv6 nd suppress-ra} {} -Send router advertisment messages. -@end deffn - -@deffn {Interface Command} {ipv6 nd suppress-ra} {} -Don't send router advertisment messages. -@end deffn - -@deffn {Interface Command} {ipv6 nd prefix @var{ipv6prefix} [@var{valid-lifetime}] [@var{preferred-lifetime}] [off-link] [no-autoconfig] [router-address]} {} -Configuring the IPv6 prefix to include in router advertisements. Several prefix -specific optional parameters and flags may follow: -@itemize @bullet -@item -@var{valid-lifetime} - the length of time in seconds during what the prefix is -valid for the purpose of on-link determination. Value @var{infinite} represents -infinity (i.e. a value of all one bits (@code{0xffffffff})). - -Range: @code{<0-4294967295>} Default: @code{2592000} - -@item -@var{preferred-lifetime} - the length of time in seconds during what addresses -generated from the prefix remain preferred. Value @var{infinite} represents -infinity. - -Range: @code{<0-4294967295>} Default: @code{604800} - -@item -@var{off-link} - indicates that advertisement makes no statement about on-link or -off-link properties of the prefix. - -Default: not set, i.e. this prefix can be used for on-link determination. - -@item -@var{no-autoconfig} - indicates to hosts on the local link that the specified prefix -cannot be used for IPv6 autoconfiguration. - -Default: not set, i.e. prefix can be used for autoconfiguration. - -@item -@var{router-address} - indicates to hosts on the local link that the specified -prefix -contains a complete IP address by setting R flag. - -Default: not set, i.e. hosts do not assume a complete IP address is placed. -@end itemize -@end deffn - -@deffn {Interface Command} {ipv6 nd ra-interval <1-1800>} {} -@deffnx {Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} -The maximum time allowed between sending unsolicited multicast router -advertisements from the interface, in seconds. - -Default: @code{600} -@end deffn - -@deffn {Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} -@deffnx {Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} -The maximum time allowed between sending unsolicited multicast router -advertisements from the interface, in milliseconds. - -Default: @code{600000} -@end deffn - -@deffn {Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} -@deffnx {Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} -The value to be placed in the Router Lifetime field of router advertisements -sent from the interface, in seconds. Indicates the usefulness of the router -as a default router on this interface. Setting the value to zero indicates -that the router should not be considered a default router on this interface. -Must be either zero or between value specified with @var{ipv6 nd ra-interval} -(or default) and 9000 seconds. - -Default: @code{1800} -@end deffn - -@deffn {Interface Command} {ipv6 nd reachable-time <1-3600000>} {} -@deffnx {Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} -The value to be placed in the Reachable Time field in the Router Advertisement -messages sent by the router, in milliseconds. The configured time enables the -router to detect unavailable neighbors. The value zero means unspecified (by -this router). - -Default: @code{0} -@end deffn - -@deffn {Interface Command} {ipv6 nd managed-config-flag} {} -@deffnx {Interface Command} {no ipv6 nd managed-config-flag} {} -Set/unset flag in IPv6 router advertisements which indicates to hosts that they -should use managed (stateful) protocol for addresses autoconfiguration in -addition to any addresses autoconfigured using stateless address -autoconfiguration. - -Default: not set -@end deffn - -@deffn {Interface Command} {ipv6 nd other-config-flag} {} -@deffnx {Interface Command} {no ipv6 nd other-config-flag} {} -Set/unset flag in IPv6 router advertisements which indicates to hosts that -they should use administered (stateful) protocol to obtain autoconfiguration -information other than addresses. - -Default: not set -@end deffn - -@deffn {Interface Command} {ipv6 nd home-agent-config-flag} {} -@deffnx {Interface Command} {no ipv6 nd home-agent-config-flag} {} -Set/unset flag in IPv6 router advertisements which indicates to hosts that -the router acts as a Home Agent and includes a Home Agent Option. - -Default: not set -@end deffn - -@deffn {Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} -@deffnx {Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} -The value to be placed in Home Agent Option, when Home Agent config flag is set, -which indicates to hosts Home Agent preference. The default value of 0 stands -for the lowest preference possible. - -Default: 0 -@end deffn - -@deffn {Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} -@deffnx {Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} -The value to be placed in Home Agent Option, when Home Agent config flag is set, -which indicates to hosts Home Agent Lifetime. The default value of 0 means to -place the current Router Lifetime value. - -Default: 0 -@end deffn - -@deffn {Interface Command} {ipv6 nd adv-interval-option} {} -@deffnx {Interface Command} {no ipv6 nd adv-interval-option} {} -Include an Advertisement Interval option which indicates to hosts the maximum time, -in milliseconds, between successive unsolicited Router Advertisements. - -Default: not set -@end deffn - -@deffn {Interface Command} {ipv6 nd router-preference (high|medium|low)} {} -@deffnx {Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} -Set default router preference in IPv6 router advertisements per RFC4191. - -Default: medium -@end deffn - -@deffn {Interface Command} {ipv6 nd mtu <1-65535>} {} -@deffnx {Interface Command} {no ipv6 nd mtu [<1-65535>]} {} -Include an MTU (type 5) option in each RA packet to assist the attached hosts -in proper interface configuration. The announced value is not verified to be -consistent with router interface MTU. - -Default: don't advertise any MTU option -@end deffn - -@example -@group -interface eth0 - no ipv6 nd suppress-ra - ipv6 nd prefix 2001:0DB8:5009::/64 -@end group -@end example - -For more information see @cite{RFC2462 (IPv6 Stateless Address Autoconfiguration)} -, @cite{RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))} -, @cite{RFC6275 (Mobility Support in IPv6)} -and @cite{RFC4191 (Default Router Preferences and More-Specific Routes)}. diff --git a/doc/isisd.texi b/doc/isisd.texi deleted file mode 100644 index bbc2896755..0000000000 --- a/doc/isisd.texi +++ /dev/null @@ -1,432 +0,0 @@ -@cindex ISIS -@node ISIS -@chapter ISIS - -@acronym{ISIS,Intermediate System to Intermediate System} is a routing protocol -which is described in @cite{ISO10589, RFC1195, RFC5308}. ISIS is an -@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, -@acronym{ISIS} can provide scalable network support and faster -convergence times like @acronym{OSPF}. ISIS is widely used in large networks such as -@acronym{ISP,Internet Service Provider} and carrier backbone networks. - -@menu -* Configuring isisd:: -* ISIS router:: -* ISIS Timer:: -* ISIS region:: -* ISIS interface:: -* Showing ISIS information:: -* ISIS Traffic Engineering:: -* Debugging ISIS:: -* ISIS Configuration Examples:: -@end menu - -@node Configuring isisd -@section Configuring isisd - -There are no @command{isisd} specific options. Common options can be -specified (@pxref{Common Invocation Options}) to @command{isisd}. -@command{isisd} needs to acquire interface information from -@command{zebra} in order to function. Therefore @command{zebra} must be -running before invoking @command{isisd}. Also, if @command{zebra} is -restarted then @command{isisd} must be too. - -Like other daemons, @command{isisd} configuration is done in @acronym{ISIS} -specific configuration file @file{isisd.conf}. - -@node ISIS router -@section ISIS router - -To start ISIS process you have to specify the ISIS router. As of this -writing, @command{isisd} does not support multiple ISIS processes. - -@deffn Command {router isis WORD} {} -@deffnx Command {no router isis WORD} {} -@anchor{router isis WORD}Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'. -@command{isisd} does not yet support multiple ISIS processes but you must specify -the name of ISIS process. The ISIS process name 'WORD' is then used for interface -(see command @ref{ip router isis WORD}). -@end deffn - -@deffn {ISIS Command} {net XX.XXXX. ... .XXX.XX} {} -@deffnx {ISIS Command} {no net XX.XXXX. ... .XXX.XX} {} -Set/Unset network entity title (NET) provided in ISO format. -@end deffn - -@deffn {ISIS Command} {hostname dynamic} {} -@deffnx {ISIS Command} {no hostname dynamic} {} -Enable support for dynamic hostname. -@end deffn - -@deffn {ISIS Command} {area-password [clear | md5] } {} -@deffnx {ISIS Command} {domain-password [clear | md5] } {} -@deffnx {ISIS Command} {no area-password} {} -@deffnx {ISIS Command} {no domain-password} {} -Configure the authentication password for an area, respectively a domain, -as clear text or md5 one. -@end deffn - -@deffn {ISIS Command} {log-adjacency-changes} {} -@deffnx {ISIS Command} {no log-adjacency-changes} {} -Log changes in adjacency state. -@end deffn - -@deffn {ISIS Command} {metric-style [narrow | transition | wide]} {} -@deffnx {ISIS Command} {no metric-style} {} -@anchor{metric-style}Set old-style (ISO 10589) or new-style packet formats: - - narrow Use old style of TLVs with narrow metric - - transition Send and accept both styles of TLVs during transition - - wide Use new style of TLVs to carry wider metric -@end deffn - -@deffn {ISIS Command} {set-overload-bit} {} -@deffnx {ISIS Command} {no set-overload-bit} {} -Set overload bit to avoid any transit traffic. -@end deffn - -@node ISIS Timer -@section ISIS Timer - -@deffn {ISIS Command} {lsp-gen-interval <1-120>} {} -@deffnx {ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {} -@deffnx {ISIS Command} {no lsp-gen-interval} {} -@deffnx {ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {} -Set minimum interval in seconds between regenerating same LSP, -globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {lsp-refresh-interval <1-65235>} {} -@deffnx {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} -@deffnx {ISIS Command} {no lsp-refresh-interval} {} -@deffnx {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} -Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {lsp-refresh-interval <1-65235>} {} -@deffnx {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} -@deffnx {ISIS Command} {no lsp-refresh-interval} {} -@deffnx {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} -Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {max-lsp-lifetime <360-65535>} {} -@deffnx {ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {} -@deffnx {ISIS Command} {no max-lsp-lifetime} {} -@deffnx {ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} -Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {spf-interval <1-120>} {} -@deffnx {ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {} -@deffnx {ISIS Command} {no spf-interval} {} -@deffnx {ISIS Command} {no spf-interval [level-1 | level-2]} {} -Set minimum interval between consecutive SPF calculations in seconds. -@end deffn - -@node ISIS region -@section ISIS region - -@deffn {ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {} -@deffnx {ISIS Command} {no is-type} {} -Define the ISIS router behavior: - - level-1 Act as a station router only - - level-1-2 Act as both a station router and an area router - - level-2-only Act as an area router only -@end deffn - -@node ISIS interface -@section ISIS interface - -@deffn {Interface Command} {ip router isis WORD} {} -@deffnx {Interface Command} {no ip router isis WORD} {} -@anchor{ip router isis WORD}Activate ISIS adjacency on this interface. Note that the name -of ISIS instance must be the same as the one used to configure the ISIS process -(see command @ref{router isis WORD}). -@end deffn - -@deffn {Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {} -@deffnx {Interface Command} {no isis circuit-type} {} -Configure circuit type for interface: - - level-1 Level-1 only adjacencies are formed - - level-1-2 Level-1-2 adjacencies are formed - - level-2-only Level-2 only adjacencies are formed -@end deffn - -@deffn {Interface Command} {isis csnp-interval <1-600>} {} -@deffnx {Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis csnp-interval} {} -@deffnx {Interface Command} {no isis csnp-interval [level-1 | level-2]} {} -Set CSNP interval in seconds globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {Interface Command} {isis hello padding} {} -Add padding to IS-IS hello packets. -@end deffn - -@deffn {Interface Command} {isis hello-interval <1-600>} {} -@deffnx {Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis hello-interval} {} -@deffnx {Interface Command} {no isis hello-interval [level-1 | level-2]} {} -Set Hello interval in seconds globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {Interface Command} {isis hello-multiplier <2-100>} {} -@deffnx {Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis hello-multiplier} {} -@deffnx {Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} -Set multiplier for Hello holding time globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {Interface Command} {isis metric [<0-255> | <0-16777215>]} {} -@deffnx {Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis metric} {} -@deffnx {Interface Command} {no isis metric [level-1 | level-2]} {} -Set default metric value globally, for an area (level-1) or a domain (level-2). -Max value depend if metric support narrow or wide value (see command @ref{metric-style}). -@end deffn - -@deffn {Interface Command} {isis network point-to-point} {} -@deffnx {Interface Command} {no isis network point-to-point} {} -Set network type to 'Point-to-Point' (broadcast by default). -@end deffn - -@deffn {Interface Command} {isis passive} {} -@deffnx {Interface Command} {no isis passive} {} -Configure the passive mode for this interface. -@end deffn - -@deffn {Interface Command} {isis password [clear | md5] } {} -@deffnx {Interface Command} {no isis password} {} -Configure the authentication password (clear or encoded text) for the interface. -@end deffn - -@deffn {Interface Command} {isis priority <0-127>} {} -@deffnx {Interface Command} {isis priority <0-127> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis priority} {} -@deffnx {Interface Command} {no isis priority [level-1 | level-2]} {} -Set priority for Designated Router election, globally, for the area (level-1) -or the domain (level-2). -@end deffn - -@deffn {Interface Command} {isis psnp-interval <1-120>} {} -@deffnx {Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis psnp-interval} {} -@deffnx {Interface Command} {no isis psnp-interval [level-1 | level-2]} {} -Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2). -@end deffn - -@node Showing ISIS information -@section Showing ISIS information - -@deffn {Command} {show isis summary} {} -Show summary information about ISIS. -@end deffn - -@deffn {Command} {show isis hostname} {} -Show information about ISIS node. -@end deffn - -@deffn {Command} {show isis interface} {} -@deffnx {Command} {show isis interface detail} {} -@deffnx {Command} {show isis interface } {} -Show state and configuration of ISIS specified interface, or all -interfaces if no interface is given with or without details. -@end deffn - -@deffn {Command} {show isis neighbor} {} -@deffnx {Command} {show isis neighbor } {} -@deffnx {Command} {show isis neighbor detail} {} -Show state and information of ISIS specified neighbor, or all -neighbors if no system id is given with or without details. -@end deffn - -@deffn {Command} {show isis database} {} -@deffnx {Command} {show isis database [detail]} {} -@deffnx {Command} {show isis database [detail]} {} -@deffnx {Command} {show isis database detail } {} -Show the ISIS database globally, for a specific LSP id without or with details. -@end deffn - -@deffn {Command} {show isis topology} {} -@deffnx {Command} {show isis topology [level-1|level-2]} {} -Show topology IS-IS paths to Intermediate Systems, globally, -in area (level-1) or domain (level-2). -@end deffn - -@deffn {Command} {show ip route isis} {} -Show the ISIS routing table, as determined by the most recent SPF calculation. -@end deffn - -@node ISIS Traffic Engineering -@section Traffic Engineering - -@deffn {ISIS Command} {mpls-te on} {} -@deffnx {ISIS Command} {no mpls-te} {} -Enable Traffic Engineering LSP flooding. -@end deffn - -@deffn {ISIS Command} {mpls-te router-address } {} -@deffnx {ISIS Command} {no mpls-te router-address} {} -Configure stable IP address for MPLS-TE. -@end deffn - -@deffn {Command} {show isis mpls-te interface} {} -@deffnx {Command} {show isis mpls-te interface @var{interface}} {} -Show MPLS Traffic Engineering parameters for all or specified interface. -@end deffn - -@deffn {Command} {show isis mpls-te router} {} -Show Traffic Engineering router parameters. -@end deffn - -@node Debugging ISIS -@section Debugging ISIS - -@deffn {Command} {debug isis adj-packets} {} -@deffnx {Command} {no debug isis adj-packets} {} -IS-IS Adjacency related packets. -@end deffn - -@deffn {Command} {debug isis checksum-errors} {} -@deffnx {Command} {no debug isis checksum-errors} {} -IS-IS LSP checksum errors. -@end deffn - -@deffn {Command} {debug isis events} {} -@deffnx {Command} {no debug isis events} {} -IS-IS Events. -@end deffn - -@deffn {Command} {debug isis local-updates} {} -@deffnx {Command} {no debug isis local-updates} {} -IS-IS local update packets. -@end deffn - -@deffn {Command} {debug isis packet-dump} {} -@deffnx {Command} {no debug isis packet-dump} {} -IS-IS packet dump. -@end deffn - -@deffn {Command} {debug isis protocol-errors} {} -@deffnx {Command} {no debug isis protocol-errors} {} -IS-IS LSP protocol errors. -@end deffn - -@deffn {Command} {debug isis route-events} {} -@deffnx {Command} {no debug isis route-events} {} -IS-IS Route related events. -@end deffn - -@deffn {Command} {debug isis snp-packets} {} -@deffnx {Command} {no debug isis snp-packets} {} -IS-IS CSNP/PSNP packets. -@end deffn - -@deffn {Command} {debug isis spf-events} {} -@deffnx {Command} {debug isis spf-statistics} {} -@deffnx {Command} {debug isis spf-triggers} {} -@deffnx {Command} {no debug isis spf-events} {} -@deffnx {Command} {no debug isis spf-statistics} {} -@deffnx {Command} {no debug isis spf-triggers} {} -IS-IS Shortest Path First Events, Timing and Statistic Data -and triggering events. -@end deffn - -@deffn {Command} {debug isis update-packets} {} -@deffnx {Command} {no debug isis update-packets} {} -Update related packets. -@end deffn - -@deffn {Command} {show debugging isis} {} -Print which ISIS debug level is activate. -@end deffn - -@node ISIS Configuration Examples -@section ISIS Configuration Examples -A simple example, with MD5 authentication enabled: - -@example -@group -! -interface eth0 - ip router isis FOO - isis network point-to-point - isis circuit-type level-2-only -! -router isis FOO -net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 - metric-style wide - is-type level-2-only -@end group -@end example - - -A Traffic Engineering configuration, with Inter-ASv2 support. - - - First, the 'zebra.conf' part: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/zebra.log -! -interface eth0 - ip address 10.2.2.2/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab -! -interface eth1 - ip address 10.1.1.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - mpls-te neighbor 10.1.1.2 as 65000 -@end group -@end example - - - Then the 'isisd.conf' itself: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/isisd.log -! -! -interface eth0 - ip router isis FOO -! -interface eth1 - ip router isis FOO -! -! -router isis FOO - isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 - mpls-te on - mpls-te router-address 10.1.1.1 -! -line vty -@end group -@end example diff --git a/doc/kernel.texi b/doc/kernel.texi deleted file mode 100644 index e58ade5a85..0000000000 --- a/doc/kernel.texi +++ /dev/null @@ -1,47 +0,0 @@ -@node Kernel Interface -@chapter Kernel Interface - -There are several different methods for reading kernel routing table -information, updating kernel routing tables, and for looking up -interfaces. - -@table @samp - -@item ioctl -The @samp{ioctl} method is a very traditional way for reading or writing -kernel information. @samp{ioctl} can be used for looking up interfaces -and for modifying interface addresses, flags, mtu settings and other -types of information. Also, @samp{ioctl} can insert and delete kernel -routing table entries. It will soon be available on almost any platform -which zebra supports, but it is a little bit ugly thus far, so if a -better method is supported by the kernel, zebra will use that. - -@item sysctl -@samp{sysctl} can lookup kernel information using MIB (Management -Information Base) syntax. Normally, it only provides a way of getting -information from the kernel. So one would usually want to change kernel -information using another method such as @samp{ioctl}. - -@item proc filesystem -@samp{proc filesystem} provides an easy way of getting kernel -information. - -@item routing socket - -@item netlink -On recent Linux kernels (2.0.x and 2.2.x), there is a kernel/user -communication support called @code{netlink}. It makes asynchronous -communication between kernel and Frr possible, similar to a routing -socket on BSD systems. - -Before you use this feature, be sure to select (in kernel configuration) -the kernel/netlink support option 'Kernel/User network link driver' and -'Routing messages'. - -Today, the /dev/route special device file is obsolete. Netlink -communication is done by reading/writing over netlink socket. - -After the kernel configuration, please reconfigure and rebuild Frr. -You can use netlink as a dynamic routing update channel between Frr -and the kernel. -@end table diff --git a/doc/main.texi b/doc/main.texi deleted file mode 100644 index 9e2ca5e506..0000000000 --- a/doc/main.texi +++ /dev/null @@ -1,525 +0,0 @@ -@node Zebra -@chapter Zebra - -@c SYNOPSIS -@command{zebra} is an IP routing manager. It provides kernel routing -table updates, interface lookups, and redistribution of routes between -different routing protocols. - -@menu -* Invoking zebra:: Running the program -* Interface Commands:: Commands for zebra interfaces -* Static Route Commands:: Commands for adding static routes -* Multicast RIB Commands:: Commands for controlling MRIB behavior -* zebra Route Filtering:: Commands for zebra route filtering -* zebra FIB push interface:: Interface to optional FPM component -* zebra Terminal Mode Commands:: Commands for zebra's VTY -@end menu - - -@node Invoking zebra -@section Invoking zebra - -Besides the common invocation options (@pxref{Common Invocation Options}), the -@command{zebra} specific invocation options are listed below. - -@table @samp -@item -b -@itemx --batch -Runs in batch mode. @command{zebra} parses configuration file and terminates -immediately. - -@item -k -@itemx --keep_kernel -When zebra starts up, don't delete old self inserted routes. - -@item -r -@itemx --retain -When program terminates, retain routes added by zebra. - -@end table - -@node Interface Commands -@section Interface Commands - -@menu -* Standard Commands:: -* Link Parameters Commands:: -@end menu - -@node Standard Commands -@subsection Standard Commands - -@deffn Command {interface @var{ifname}} {} -@end deffn - -@deffn {Interface Command} {shutdown} {} -@deffnx {Interface Command} {no shutdown} {} -Up or down the current interface. -@end deffn - -@deffn {Interface Command} {ip address @var{address/prefix}} {} -@deffnx {Interface Command} {ipv6 address @var{address/prefix}} {} -@deffnx {Interface Command} {no ip address @var{address/prefix}} {} -@deffnx {Interface Command} {no ipv6 address @var{address/prefix}} {} -Set the IPv4 or IPv6 address/prefix for the interface. -@end deffn - -@deffn {Interface Command} {ip address @var{local-addr} peer @var{peer-addr/prefix}} {} -@deffnx {Interface Command} {no ip address @var{local-addr} peer @var{peer-addr/prefix}} {} -Configure an IPv4 Pointopoint address on the interface. -(The concept of PtP addressing does not exist for IPv6.) - -@var{local-addr} has no subnet mask since the local side in PtP -addressing is always a single (/32) address. @var{peer-addr/prefix} -can be an arbitrary subnet behind the other end of the link (or even on the -link in Point-to-Multipoint setups), though generally /32s are used. -@end deffn - -@deffn {Interface Command} {ip address @var{address/prefix} secondary} {} -@deffnx {Interface Command} {no ip address @var{address/prefix} secondary} {} -Set the secondary flag for this address. This causes ospfd to not treat the -address as a distinct subnet. -@end deffn - -@deffn {Interface Command} {description @var{description} ...} {} -Set description for the interface. -@end deffn - -@deffn {Interface Command} {multicast} {} -@deffnx {Interface Command} {no multicast} {} -Enable or disables multicast flag for the interface. -@end deffn - -@deffn {Interface Command} {bandwidth <1-10000000>} {} -@deffnx {Interface Command} {no bandwidth <1-10000000>} {} -Set bandwidth value of the interface in kilobits/sec. This is for -calculating OSPF cost. This command does not affect the actual device -configuration. -@end deffn - -@deffn {Interface Command} {link-detect} {} -@deffnx {Interface Command} {no link-detect} {} -Enable/disable link-detect on platforms which support this. Currently -only Linux and Solaris, and only where network interface drivers support reporting -link-state via the IFF_RUNNING flag. -@end deffn - -@node Link Parameters Commands -@subsection Link Parameters Commands - -@deffn {Interface Command} {link-params} {} -@deffnx {Interface Command} {no link-param} {} -Enter into the link parameters sub node. At least 'enable' must be set to activate the link parameters, -and consequently Traffic Engineering on this interface. MPLS-TE must be enable at the OSPF (@ref{OSPF Traffic Engineering}) -or ISIS (@ref{ISIS Traffic Engineering}) router level in complement to this. -Disable link parameters for this interface. -@end deffn - -Under link parameter statement, the following commands set the different TE values: - -@deffn link-params {enable} -Enable link parameters for this interface. -@end deffn - -@deffn link-params {metric <0-4294967295>} {} -@deffnx link-params {max-bw @var{bandwidth}} {} -@deffnx link-params {max-rsv-bw @var{bandwidth}} {} -@deffnx link-params {unrsv-bw <0-7> @var{bandwidth}} {} -@deffnx link-params {admin-grp @var{bandwidth}} {} -These commands specifies the Traffic Engineering parameters of the interface in conformity to RFC3630 (OSPF) -or RFC5305 (ISIS). -There are respectively the TE Metric (different from the OSPF or ISIS metric), Maximum Bandwidth (interface speed -by default), Maximum Reservable Bandwidth, Unreserved Bandwidth for each 0-7 priority and Admin Group (ISIS) or -Resource Class/Color (OSPF). - -Note that @var{bandwidth} are specified in IEEE floating point format and express in Bytes/second. -@end deffn - -@deffn link-param {delay <0-16777215> [min <0-16777215> | max <0-16777215>]} {} -@deffnx link-param {delay-variation <0-16777215>} {} -@deffnx link-param {packet-loss @var{percentage}} {} -@deffnx link-param {res-bw @var{bandwidth}} {} -@deffnx link-param {ava-bw @var{bandwidth}} {} -@deffnx link-param {use-bw @var{bandwidth}} {} -These command specifies additionnal Traffic Engineering parameters of the interface in conformity to -draft-ietf-ospf-te-metrics-extension-05.txt and draft-ietf-isis-te-metrics-extension-03.txt. There are -respectively the delay, jitter, loss, available bandwidth, reservable bandwidth and utilized bandwidth. - -Note that @var{bandwidth} are specified in IEEE floating point format and express in Bytes/second. -Delays and delay variation are express in micro-second (µs). Loss is specified in @var{percentage} ranging -from 0 to 50.331642% by step of 0.000003. -@end deffn - -@deffn link-param {neighbor as <0-65535>} {} -@deffnx link-param {no neighbor} {} -Specifies the remote ASBR IP address and Autonomous System (AS) number for InterASv2 link in OSPF (RFC5392). -Note that this option is not yet supported for ISIS (RFC5316). -@end deffn - - -@node Static Route Commands -@section Static Route Commands - -Static routing is a very fundamental feature of routing technology. It -defines static prefix and gateway. - -@deffn Command {ip route @var{network} @var{gateway}} {} -@var{network} is destination prefix with format of A.B.C.D/M. -@var{gateway} is gateway for the prefix. When @var{gateway} is -A.B.C.D format. It is taken as a IPv4 address gateway. Otherwise it -is treated as an interface name. If the interface name is @var{null0} then -zebra installs a blackhole route. - -@example -ip route 10.0.0.0/8 10.0.0.2 -ip route 10.0.0.0/8 ppp0 -ip route 10.0.0.0/8 null0 -@end example - -First example defines 10.0.0.0/8 static route with gateway 10.0.0.2. -Second one defines the same prefix but with gateway to interface ppp0. The -third install a blackhole route. -@end deffn - -@deffn Command {ip route @var{network} @var{netmask} @var{gateway}} {} -This is alternate version of above command. When @var{network} is -A.B.C.D format, user must define @var{netmask} value with A.B.C.D -format. @var{gateway} is same option as above command - -@example -ip route 10.0.0.0 255.255.255.0 10.0.0.2 -ip route 10.0.0.0 255.255.255.0 ppp0 -ip route 10.0.0.0 255.255.255.0 null0 -@end example - -These statements are equivalent to those in the previous example. -@end deffn - -@deffn Command {ip route @var{network} @var{gateway} @var{distance}} {} -Installs the route with the specified distance. -@end deffn - -Multiple nexthop static route - -@example -ip route 10.0.0.1/32 10.0.0.2 -ip route 10.0.0.1/32 10.0.0.3 -ip route 10.0.0.1/32 eth0 -@end example - -If there is no route to 10.0.0.2 and 10.0.0.3, and interface eth0 -is reachable, then the last route is installed into the kernel. - -If zebra has been compiled with multipath support, and both 10.0.0.2 and -10.0.0.3 are reachable, zebra will install a multipath route via both -nexthops, if the platform supports this. - -@example -zebra> show ip route -S> 10.0.0.1/32 [1/0] via 10.0.0.2 inactive - via 10.0.0.3 inactive - * is directly connected, eth0 -@end example - -@example -ip route 10.0.0.0/8 10.0.0.2 -ip route 10.0.0.0/8 10.0.0.3 -ip route 10.0.0.0/8 null0 255 -@end example - -This will install a multihop route via the specified next-hops if they are -reachable, as well as a high-metric blackhole route, which can be useful to -prevent traffic destined for a prefix to match less-specific routes (eg -default) should the specified gateways not be reachable. Eg: - -@example -zebra> show ip route 10.0.0.0/8 -Routing entry for 10.0.0.0/8 - Known via "static", distance 1, metric 0 - 10.0.0.2 inactive - 10.0.0.3 inactive - -Routing entry for 10.0.0.0/8 - Known via "static", distance 255, metric 0 - directly connected, Null0 -@end example - -@deffn Command {ipv6 route @var{network} @var{gateway}} {} -@deffnx Command {ipv6 route @var{network} @var{gateway} @var{distance}} {} -These behave similarly to their ipv4 counterparts. -@end deffn - -@deffn Command {ipv6 route @var{network} from @var{srcprefix} @var{gateway}} {} -@deffnx Command {ipv6 route @var{network} from @var{srcprefix} @var{gateway} @var{distance}} {} -Install a static source-specific route. These routes are currently supported -on Linux operating systems only, and perform AND matching on packet's -destination and source addresses in the kernel's forwarding path. Note that -destination longest-prefix match is "more important" than source LPM, e.g. -@command{"2001:db8:1::/64 from 2001:db8::/48"} will win over -@command{"2001:db8::/48 from 2001:db8:1::/64"} if both match. -@end deffn - - -@deffn Command {table @var{tableno}} {} -Select the primary kernel routing table to be used. This only works -for kernels supporting multiple routing tables (like GNU/Linux 2.2.x -and later). After setting @var{tableno} with this command, -static routes defined after this are added to the specified table. -@end deffn - -@node Multicast RIB Commands -@section Multicast RIB Commands - -The Multicast RIB provides a separate table of unicast destinations which -is used for Multicast Reverse Path Forwarding decisions. It is used with -a multicast source's IP address, hence contains not multicast group -addresses but unicast addresses. - -This table is fully separate from the default unicast table. However, -RPF lookup can include the unicast table. - -WARNING: RPF lookup results are non-responsive in this version of Frr, -i.e. multicast routing does not actively react to changes in underlying -unicast topology! - -@deffn Command {ip multicast rpf-lookup-mode @var{mode}} {} -@deffnx Command {no ip multicast rpf-lookup-mode [@var{mode}]} {} - -@var{mode} sets the method used to perform RPF lookups. Supported modes: - -@table @samp -@item urib-only -Performs the lookup on the Unicast RIB. The Multicast RIB is never used. -@item mrib-only -Performs the lookup on the Multicast RIB. The Unicast RIB is never used. -@item mrib-then-urib -Tries to perform the lookup on the Multicast RIB. If any route is found, -that route is used. Otherwise, the Unicast RIB is tried. -@item lower-distance -Performs a lookup on the Multicast RIB and Unicast RIB each. The result -with the lower administrative distance is used; if they're equal, the -Multicast RIB takes precedence. -@item longer-prefix -Performs a lookup on the Multicast RIB and Unicast RIB each. The result -with the longer prefix length is used; if they're equal, the -Multicast RIB takes precedence. -@end table - -The @code{mrib-then-urib} setting is the default behavior if nothing is -configured. If this is the desired behavior, it should be explicitly -configured to make the configuration immune against possible changes in -what the default behavior is. - -WARNING: Unreachable routes do not receive special treatment and do not -cause fallback to a second lookup. -@end deffn - -@deffn Command {show ip rpf @var{addr}} {} - -Performs a Multicast RPF lookup, as configured with -@command{ip multicast rpf-lookup-mode @var{mode}}. @var{addr} specifies -the multicast source address to look up. - -@example -> show ip rpf 192.0.2.1 -Routing entry for 192.0.2.0/24 using Unicast RIB - Known via "kernel", distance 0, metric 0, best - * 198.51.100.1, via eth0 -@end example - -Indicates that a multicast source lookup for 192.0.2.1 would use an -Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1. -@end deffn - -@deffn Command {show ip rpf} {} - -Prints the entire Multicast RIB. Note that this is independent of the -configured RPF lookup mode, the Multicast RIB may be printed yet not -used at all. -@end deffn - -@deffn Command {ip mroute @var{prefix} @var{nexthop} [@var{distance}]} {} -@deffnx Command {no ip mroute @var{prefix} @var{nexthop} [@var{distance}]} {} - -Adds a static route entry to the Multicast RIB. This performs exactly as -the @command{ip route} command, except that it inserts the route in the -Multicast RIB instead of the Unicast RIB. -@end deffn - - -@node zebra Route Filtering -@section zebra Route Filtering -Zebra supports @command{prefix-list} and @command{route-map} to match -routes received from other frr components. The -@command{permit}/@command{deny} facilities provided by these commands -can be used to filter which routes zebra will install in the kernel. - -@deffn Command {ip protocol @var{protocol} route-map @var{routemap}} {} -Apply a route-map filter to routes for the specified protocol. @var{protocol} -can be @b{any} or one of -@b{system}, -@b{kernel}, -@b{connected}, -@b{static}, -@b{rip}, -@b{ripng}, -@b{ospf}, -@b{ospf6}, -@b{isis}, -@b{bgp}, -@b{hsls}. -@end deffn - -@deffn {Route Map} {set src @var{address}} -Within a route-map, set the preferred source address for matching routes -when installing in the kernel. -@end deffn - -@example -The following creates a prefix-list that matches all addresses, a route-map -that sets the preferred source address, and applies the route-map to all -@command{rip} routes. - -@group -ip prefix-list ANY permit 0.0.0.0/0 le 32 -route-map RM1 permit 10 - match ip address prefix-list ANY - set src 10.0.0.1 - -ip protocol rip route-map RM1 -@end group -@end example - -@node zebra FIB push interface -@section zebra FIB push interface - -Zebra supports a 'FIB push' interface that allows an external -component to learn the forwarding information computed by the Frr -routing suite. This is a loadable module that needs to be enabled -at startup as described in @ref{Loadable Module Support}. - -In Frr, the Routing Information Base (RIB) resides inside -zebra. Routing protocols communicate their best routes to zebra, and -zebra computes the best route across protocols for each prefix. This -latter information makes up the Forwarding Information Base -(FIB). Zebra feeds the FIB to the kernel, which allows the IP stack in -the kernel to forward packets according to the routes computed by -Frr. The kernel FIB is updated in an OS-specific way. For example, -the @code{netlink} interface is used on Linux, and route sockets are -used on FreeBSD. - -The FIB push interface aims to provide a cross-platform mechanism to -support scenarios where the router has a forwarding path that is -distinct from the kernel, commonly a hardware-based fast path. In -these cases, the FIB needs to be maintained reliably in the fast path -as well. We refer to the component that programs the forwarding plane -(directly or indirectly) as the Forwarding Plane Manager or FPM. - -The FIB push interface comprises of a TCP connection between zebra and -the FPM. The connection is initiated by zebra -- that is, the FPM acts -as the TCP server. - -The relevant zebra code kicks in when zebra is configured with the -@code{--enable-fpm} flag. Zebra periodically attempts to connect to -the well-known FPM port. Once the connection is up, zebra starts -sending messages containing routes over the socket to the FPM. Zebra -sends a complete copy of the forwarding table to the FPM, including -routes that it may have picked up from the kernel. The existing -interaction of zebra with the kernel remains unchanged -- that is, the -kernel continues to receive FIB updates as before. - -The encapsulation header for the messages exchanged with the FPM is -defined by the file @file{fpm/fpm.h} in the frr tree. The routes -themselves are encoded in netlink or protobuf format, with netlink -being the default. - -Protobuf is one of a number of new serialization formats wherein the -message schema is expressed in a purpose-built language. Code for -encoding/decoding to/from the wire format is generated from the -schema. Protobuf messages can be extended easily while maintaining -backward-compatibility with older code. Protobuf has the following -advantages over netlink: - -@itemize -@item -Code for serialization/deserialization is generated -automatically. This reduces the likelihood of bugs, allows third-party -programs to be integrated quickly, and makes it easy to add fields. -@item -The message format is not tied to an OS (Linux), and can be evolved -independently. -@end itemize - -As mentioned before, zebra encodes routes sent to the FPM in netlink -format by default. The format can be controlled via the FPM module's -load-time option to zebra, which currently takes the values @code{netlink} -and @code{protobuf}. - -The zebra FPM interface uses replace semantics. That is, if a 'route -add' message for a prefix is followed by another 'route add' message, -the information in the second message is complete by itself, and -replaces the information sent in the first message. - -If the connection to the FPM goes down for some reason, zebra sends -the FPM a complete copy of the forwarding table(s) when it reconnects. - -@node zebra Terminal Mode Commands -@section zebra Terminal Mode Commands - -@deffn Command {show ip route} {} -Display current routes which zebra holds in its database. - -@example -@group -Router# show ip route -Codes: K - kernel route, C - connected, S - static, R - RIP, - B - BGP * - FIB route. - -K* 0.0.0.0/0 203.181.89.241 -S 0.0.0.0/0 203.181.89.1 -C* 127.0.0.0/8 lo -C* 203.181.89.240/28 eth0 -@end group -@end example -@end deffn - -@deffn Command {show ipv6 route} {} -@end deffn - -@deffn Command {show interface} {} -@end deffn - -@deffn Command {show ip prefix-list [@var{name}]} {} -@end deffn - -@deffn Command {show route-map [@var{name}]} {} -@end deffn - -@deffn Command {show ip protocol} {} -@end deffn - -@deffn Command {show ipforward} {} -Display whether the host's IP forwarding function is enabled or not. -Almost any UNIX kernel can be configured with IP forwarding disabled. -If so, the box can't work as a router. -@end deffn - -@deffn Command {show ipv6forward} {} -Display whether the host's IP v6 forwarding is enabled or not. -@end deffn - -@deffn Command {show zebra} {} -Display various statistics related to the installation and deletion -of routes, neighbor updates, and LSP's into the kernel. -@end deffn - -@deffn Command {show zebra fpm stats} {} -Display statistics related to the zebra code that interacts with the -optional Forwarding Plane Manager (FPM) component. -@end deffn - -@deffn Command {clear zebra fpm stats} {} -Reset statistics related to the zebra code that interacts with the -optional Forwarding Plane Manager (FPM) component. -@end deffn diff --git a/doc/ospf6d.texi b/doc/ospf6d.texi deleted file mode 100644 index 3ea71fbd20..0000000000 --- a/doc/ospf6d.texi +++ /dev/null @@ -1,172 +0,0 @@ -@node OSPFv3 -@chapter OSPFv3 - -@command{ospf6d} is a daemon support OSPF version 3 for IPv6 network. -OSPF for IPv6 is described in RFC2740. - -@menu -* OSPF6 router:: -* OSPF6 area:: -* OSPF6 interface:: -* Redistribute routes to OSPF6:: -* Showing OSPF6 information:: -* OSPF6 Configuration Examples:: -@end menu - -@node OSPF6 router -@section OSPF6 router - -@deffn {Command} {router ospf6} {} -@end deffn - -@deffn {OSPF6 Command} {router-id @var{a.b.c.d}} {} -Set router's Router-ID. -@end deffn - -@deffn {OSPF6 Command} {interface @var{ifname} area @var{area}} {} -Bind interface to specified area, and start sending OSPF packets. @var{area} can -be specified as 0. -@end deffn - -@deffn {OSPF6 Command} {timers throttle spf @var{delay} @var{initial-holdtime} @var{max-holdtime}} {} -@deffnx {OSPF6 Command} {no timers throttle spf} {} -This command sets the initial @var{delay}, the @var{initial-holdtime} -and the @var{maximum-holdtime} between when SPF is calculated and the -event which triggered the calculation. The times are specified in -milliseconds and must be in the range of 0 to 600000 milliseconds. - -The @var{delay} specifies the minimum amount of time to delay SPF -calculation (hence it affects how long SPF calculation is delayed after -an event which occurs outside of the holdtime of any previous SPF -calculation, and also serves as a minimum holdtime). - -Consecutive SPF calculations will always be seperated by at least -'hold-time' milliseconds. The hold-time is adaptive and initially is -set to the @var{initial-holdtime} configured with the above command. -Events which occur within the holdtime of the previous SPF calculation -will cause the holdtime to be increased by @var{initial-holdtime}, bounded -by the @var{maximum-holdtime} configured with this command. If the adaptive -hold-time elapses without any SPF-triggering event occuring then -the current holdtime is reset to the @var{initial-holdtime}. - -@example -@group -router ospf6 - timers throttle spf 200 400 10000 -@end group -@end example - -In this example, the @var{delay} is set to 200ms, the @var{initial -holdtime} is set to 400ms and the @var{maximum holdtime} to 10s. Hence -there will always be at least 200ms between an event which requires SPF -calculation and the actual SPF calculation. Further consecutive SPF -calculations will always be seperated by between 400ms to 10s, the -hold-time increasing by 400ms each time an SPF-triggering event occurs -within the hold-time of the previous SPF calculation. - -@end deffn - -@deffn {OSPF6 Command} {auto-cost reference-bandwidth @var{cost}} {} -@deffnx {OSPF6 Command} {no auto-cost reference-bandwidth} {} -This sets the reference bandwidth for cost calculations, where this -bandwidth is considered equivalent to an OSPF cost of 1, specified in -Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s -or higher will have a cost of 1. Cost of lower bandwidth links will be -scaled with reference to this cost). - -This configuration setting MUST be consistent across all routers -within the OSPF domain. -@end deffn - -@node OSPF6 area -@section OSPF6 area - -Area support for OSPFv3 is not yet implemented. - -@node OSPF6 interface -@section OSPF6 interface - -@deffn {Interface Command} {ipv6 ospf6 cost COST} {} -Sets interface's output cost. Default value depends on the interface -bandwidth and on the auto-cost reference bandwidth. -@end deffn - -@deffn {Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {} -Sets interface's Hello Interval. Default 40 -@end deffn - -@deffn {Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {} -Sets interface's Router Dead Interval. Default value is 40. -@end deffn - -@deffn {Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {} -Sets interface's Rxmt Interval. Default value is 5. -@end deffn - -@deffn {Interface Command} {ipv6 ospf6 priority PRIORITY} {} -Sets interface's Router Priority. Default value is 1. -@end deffn - -@deffn {Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {} -Sets interface's Inf-Trans-Delay. Default value is 1. -@end deffn - -@deffn {Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {} -Set explicitly network type for specifed interface. -@end deffn - -@node Redistribute routes to OSPF6 -@section Redistribute routes to OSPF6 - -@deffn {OSPF6 Command} {redistribute static} {} -@deffnx {OSPF6 Command} {redistribute connected} {} -@deffnx {OSPF6 Command} {redistribute ripng} {} -@end deffn - -@node Showing OSPF6 information -@section Showing OSPF6 information - -@deffn {Command} {show ipv6 ospf6 [INSTANCE_ID]} {} -INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF -instance ID, simply type "show ipv6 ospf6 ". -@end deffn - -@deffn {Command} {show ipv6 ospf6 database} {} -This command shows LSA database summary. You can specify the type of LSA. -@end deffn - -@deffn {Command} {show ipv6 ospf6 interface} {} -To see OSPF interface configuration like costs. -@end deffn - -@deffn {Command} {show ipv6 ospf6 neighbor} {} -Shows state and chosen (Backup) DR of neighbor. -@end deffn - -@deffn {Command} {show ipv6 ospf6 request-list A.B.C.D} {} -Shows requestlist of neighbor. -@end deffn - -@deffn {Command} {show ipv6 route ospf6} {} -This command shows internal routing table. -@end deffn - -@deffn {Command} {show ipv6 ospf6 zebra} {} -Shows state about what is being redistributed between zebra and OSPF6 -@end deffn - -@node OSPF6 Configuration Examples -@section OSPF6 Configuration Examples - -Example of ospf6d configured on one interface and area: - -@example -interface eth0 - ipv6 ospf6 instance-id 0 -! -router ospf6 - router-id 212.17.55.53 - area 0.0.0.0 range 2001:770:105:2::/64 - interface eth0 area 0.0.0.0 -! -@end example diff --git a/doc/ospf_fundamentals.texi b/doc/ospf_fundamentals.texi deleted file mode 100644 index 82218e6015..0000000000 --- a/doc/ospf_fundamentals.texi +++ /dev/null @@ -1,582 +0,0 @@ -@c Copyright 2006 Sun Microsystems, Inc. All Rights Reserved. -@cindex OSPF Fundamentals -@node OSPF Fundamentals -@section OSPF Fundamentals - -@cindex Link-state routing protocol -@cindex Distance-vector routing protocol -@acronym{OSPF} is, mostly, a link-state routing protocol. In contrast -to @dfn{distance-vector} protocols, such as @acronym{RIP} or -@acronym{BGP}, where routers describe available @dfn{paths} (i.e@. routes) -to each other, in @dfn{link-state} protocols routers instead -describe the state of their links to their immediate neighbouring -routers. - -@cindex Link State Announcement -@cindex Link State Advertisement -@cindex LSA flooding -@cindex Link State DataBase -Each router describes their link-state information in a message known -as an @acronym{LSA,Link State Advertisement}, which is then propogated -through to all other routers in a link-state routing domain, by a -process called @dfn{flooding}. Each router thus builds up an -@acronym{LSDB,Link State Database} of all the link-state messages. From -this collection of LSAs in the LSDB, each router can then calculate the -shortest path to any other router, based on some common metric, by -using an algorithm such as @url{http://www.cs.utexas.edu/users/EWD/, -Edgser Dijkstra}'s @acronym{SPF,Shortest Path First}. - -@cindex Link-state routing protocol advantages -By describing connectivity of a network in this way, in terms of -routers and links rather than in terms of the paths through a network, -a link-state protocol can use less bandwidth and converge more quickly -than other protocols. A link-state protocol need distribute only one -link-state message throughout the link-state domain when a link on any -single given router changes state, in order for all routers to -reconverge on the best paths through the network. In contrast, distance -vector protocols can require a progression of different path update -messages from a series of different routers in order to converge. - -@cindex Link-state routing protocol disadvantages -The disadvantage to a link-state protocol is that the process of -computing the best paths can be relatively intensive when compared to -distance-vector protocols, in which near to no computation need be done -other than (potentially) select between multiple routes. This overhead -is mostly negligible for modern embedded CPUs, even for networks with -thousands of nodes. The primary scaling overhead lies more in coping -with the ever greater frequency of LSA updates as the size of a -link-state area increases, in managing the @acronym{LSDB} and required -flooding. - -This section aims to give a distilled, but accurate, description of the -more important workings of @acronym{OSPF}@ which an administrator may need -to know to be able best configure and trouble-shoot @acronym{OSPF}@. - -@subsection OSPF Mechanisms - -@acronym{OSPF} defines a range of mechanisms, concerned with detecting, -describing and propogating state through a network. These mechanisms -will nearly all be covered in greater detail further on. They may be -broadly classed as: - -@table @dfn -@cindex OSPF Hello Protocol overview -@item The Hello Protocol - -@cindex OSPF Hello Protocol -The OSPF Hello protocol allows OSPF to quickly detect changes in -two-way reachability between routers on a link. OSPF can additionally -avail of other sources of reachability information, such as link-state -information provided by hardware, or through dedicated reachability -protocols such as @acronym{BFD,Bi-directional Forwarding Detection}. - -OSPF also uses the Hello protocol to propagate certain state between -routers sharing a link, for example: - -@itemize @bullet -@item Hello protocol configured state, such as the dead-interval. -@item Router priority, for DR/BDR election. -@item DR/BDR election results. -@item Any optional capabilities supported by each router. -@end itemize - -The Hello protocol is comparatively trivial and will not be explored in -greater detail than here. - -@cindex OSPF LSA overview -@item LSAs - -At the heart of @acronym{OSPF} are @acronym{LSA,Link State -Advertisement} messages. Despite the name, some @acronym{LSA}s do not, -strictly speaking, describe link-state information. Common -@acronym{LSA}s describe information such as: - -@itemize @bullet -@item -Routers, in terms of their links. -@item -Networks, in terms of attached routers. -@item -Routes, external to a link-state domain: - -@itemize @bullet -@item External Routes - -Routes entirely external to @acronym{OSPF}@. Routers originating such -routes are known as @acronym{ASBR,Autonomous-System Border Router} -routers. - -@item Summary Routes - -Routes which summarise routing information relating to OSPF areas -external to the OSPF link-state area at hand, originated by -@acronym{ABR,Area Boundary Router} routers. -@end itemize -@end itemize - -@item LSA Flooding -OSPF defines several related mechanisms, used to manage synchronisation of -@acronym{LSDB}s between neighbours as neighbours form adjacencies and -the propogation, or @dfn{flooding} of new or updated @acronym{LSA}s. - -@xref{OSPF Flooding}. - -@cindex OSPF Areas overview -@item Areas -OSPF provides for the protocol to be broken up into multiple smaller -and independent link-state areas. Each area must be connected to a -common backbone area by an @acronym{ABR,Area Boundary Router}. These -@acronym{ABR} routers are responsible for summarising the link-state -routing information of an area into @dfn{Summary LSAs}, possibly in a -condensed (i.e. aggregated) form, and then originating these summaries -into all other areas the @acronym{ABR} is connected to. - -Note that only summaries and external routes are passed between areas. -As these describe @emph{paths}, rather than any router link-states, -routing between areas hence is by @dfn{distance-vector}, @strong{not} -link-state. - -@xref{OSPF Areas}. -@end table - -@subsection OSPF LSAs - -@acronym{LSA}s are the core object in OSPF@. Everything else in OSPF -revolves around detecting what to describe in LSAs, when to update -them, how to flood them throughout a network and how to calculate -routes from them. - -There are a variety of different @acronym{LSA}s, for purposes such -as describing actual link-state information, describing paths (i.e. -routes), describing bandwidth usage of links for -@acronym{TE,Traffic Engineering} purposes, and even arbitrary data -by way of @emph{Opaque} @acronym{LSA}s. - -@subsubsection LSA Header -All LSAs share a common header with the following information: - -@itemize @bullet -@item Type - -Different types of @acronym{LSA}s describe different things in -@acronym{OSPF}@. Types include: - -@itemize @bullet -@item Router LSA -@item Network LSA -@item Network Summary LSA -@item Router Summary LSA -@item AS-External LSA -@end itemize - -The specifics of the different types of LSA are examined below. - -@item Advertising Router - -The Router ID of the router originating the LSA, see @ref{ospf router-id}. - -@item LSA ID - -The ID of the LSA, which is typically derived in some way from the -information the LSA describes, e.g. a Router LSA uses the Router ID as -the LSA ID, a Network LSA will have the IP address of the @acronym{DR} -as its LSA ID@. - -The combination of the Type, ID and Advertising Router ID must uniquely -identify the @acronym{LSA}@. There can however be multiple instances of -an LSA with the same Type, LSA ID and Advertising Router ID, see -@ref{OSPF LSA sequence number,,LSA Sequence Number}. - -@item Age - -A number to allow stale @acronym{LSA}s to, eventually, be purged by routers -from their @acronym{LSDB}s. - -The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is -called the @dfn{MaxAge}. MaxAge LSAs are ignored in routing -calculations. LSAs must be periodically refreshed by their Advertising -Router before reaching MaxAge if they are to remain valid. - -Routers may deliberately flood LSAs with the age artificially set to -3600 to indicate an LSA is no longer valid. This is called -@dfn{flushing} of an LSA@. - -It is not abnormal to see stale LSAs in the LSDB, this can occur where -a router has shutdown without flushing its LSA(s), e.g. where it has -become disconnected from the network. Such LSAs do little harm. - -@anchor{OSPF LSA sequence number} -@item Sequence Number - -A number used to distinguish newer instances of an LSA from older instances. -@end itemize - -@subsubsection Link-State LSAs -Of all the various kinds of @acronym{LSA}s, just two types comprise the -actual link-state part of @acronym{OSPF}, Router @acronym{LSA}s and -Network @acronym{LSA}s. These LSA types are absolutely core to the -protocol. - -Instances of these LSAs are specific to the link-state area in which -they are originated. Routes calculated from these two LSA types are -called @dfn{intra-area routes}. - -@itemize @bullet -@item Router LSA - -Each OSPF Router must originate a router @acronym{LSA} to describe -itself. In it, the router lists each of its @acronym{OSPF} enabled -interfaces, for the given link-state area, in terms of: - -@itemize @bullet -@item Cost - -The output cost of that interface, scaled inversely to some commonly known -reference value, @xref{OSPF auto-cost reference-bandwidth,,auto-cost -reference-bandwidth}. - -@item Link Type -@itemize @bullet -@item Transit Network - -A link to a multi-access network, on which the router has at least one -Full adjacency with another router. - -@item @acronym{PtP,Point-to-Point} - -A link to a single remote router, with a Full adjacency. No -@acronym{DR, Designated Router} is elected on such links; no network -LSA is originated for such a link. - -@item Stub - -A link with no adjacent neighbours, or a host route. -@end itemize - -@item Link ID and Data - -These values depend on the Link Type: - -@multitable @columnfractions .18 .32 .32 -@headitem Link Type @tab Link ID @tab Link Data - -@item Transit -@tab Link IP address of the @acronym{DR} -@tab Interface IP address - -@item Point-to-Point -@tab Router ID of the remote router -@tab Local interface IP address, -or the @acronym{ifindex,MIB-II interface index} -for unnumbered links - -@item Stub -@tab IP address -@tab Subnet Mask - -@end multitable -@end itemize - -Links on a router may be listed multiple times in the Router LSA, e.g. -a @acronym{PtP} interface on which OSPF is enabled must @emph{always} -be described by a Stub link in the Router @acronym{LSA}, in addition to -being listed as PtP link in the Router @acronym{LSA} if the adjacency -with the remote router is Full. - -Stub links may also be used as a way to describe links on which OSPF is -@emph{not} spoken, known as @dfn{passive interfaces}, see @ref{OSPF -passive-interface,,passive-interface}. - -@item Network LSA - -On multi-access links (e.g. ethernets, certain kinds of ATM and X@.25 -configurations), routers elect a @acronym{DR}@. The @acronym{DR} is -responsible for originating a Network @acronym{LSA}, which helps reduce -the information needed to describe multi-access networks with multiple -routers attached. The @acronym{DR} also acts as a hub for the flooding of -@acronym{LSA}s on that link, thus reducing flooding overheads. - -The contents of the Network LSA describes the: - -@itemize @bullet -@item Subnet Mask - -As the @acronym{LSA} ID of a Network LSA must be the IP address of the -@acronym{DR}, the Subnet Mask together with the @acronym{LSA} ID gives -you the network address. - -@item Attached Routers - -Each router fully-adjacent with the @acronym{DR} is listed in the LSA, -by their Router-ID. This allows the corresponding Router @acronym{LSA}s to be -easily retrieved from the @acronym{LSDB}@. -@end itemize -@end itemize - -Summary of Link State LSAs: - -@multitable @columnfractions .18 .32 .40 -@headitem LSA Type @tab LSA ID Describes @tab LSA Data Describes - -@item Router LSA -@tab The Router ID -@tab The @acronym{OSPF} enabled links of the router, within - a specific link-state area. - -@item Network LSA -@tab The IP address of the @acronym{DR} for the network -@tab The Subnet Mask of the network, and the Router IDs of all routers - on the network. -@end multitable - -With an LSDB composed of just these two types of @acronym{LSA}, it is -possible to construct a directed graph of the connectivity between all -routers and networks in a given OSPF link-state area. So, not -surprisingly, when OSPF routers build updated routing tables, the first -stage of @acronym{SPF} calculation concerns itself only with these two -LSA types. - -@subsubsection Link-State LSA Examples - -The example below (@pxref{OSPF Link-State LSA Example}) shows two -@acronym{LSA}s, both originated by the same router (Router ID -192.168.0.49) and with the same @acronym{LSA} ID (192.168.0.49), but of -different LSA types. - -The first LSA being the router LSA describing 192.168.0.49's links: 2 links -to multi-access networks with fully-adjacent neighbours (i.e. Transit -links) and 1 being a Stub link (no adjacent neighbours). - -The second LSA being a Network LSA, for which 192.168.0.49 is the -@acronym{DR}, listing the Router IDs of 4 routers on that network which -are fully adjacent with 192.168.0.49. - -@anchor{OSPF Link-State LSA Example} -@example -# show ip ospf database router 192.168.0.49 - - OSPF Router with ID (192.168.0.53) - - - Router Link States (Area 0.0.0.0) - - LS age: 38 - Options: 0x2 : *|-|-|-|-|-|E|* - LS Flags: 0x6 - Flags: 0x2 : ASBR - LS Type: router-LSA - Link State ID: 192.168.0.49 - Advertising Router: 192.168.0.49 - LS Seq Number: 80000f90 - Checksum: 0x518b - Length: 60 - Number of Links: 3 - - Link connected to: a Transit Network - (Link ID) Designated Router address: 192.168.1.3 - (Link Data) Router Interface address: 192.168.1.3 - Number of TOS metrics: 0 - TOS 0 Metric: 10 - - Link connected to: a Transit Network - (Link ID) Designated Router address: 192.168.0.49 - (Link Data) Router Interface address: 192.168.0.49 - Number of TOS metrics: 0 - TOS 0 Metric: 10 - - Link connected to: Stub Network - (Link ID) Net: 192.168.3.190 - (Link Data) Network Mask: 255.255.255.255 - Number of TOS metrics: 0 - TOS 0 Metric: 39063 -# show ip ospf database network 192.168.0.49 - - OSPF Router with ID (192.168.0.53) - - - Net Link States (Area 0.0.0.0) - - LS age: 285 - Options: 0x2 : *|-|-|-|-|-|E|* - LS Flags: 0x6 - LS Type: network-LSA - Link State ID: 192.168.0.49 (address of Designated Router) - Advertising Router: 192.168.0.49 - LS Seq Number: 80000074 - Checksum: 0x0103 - Length: 40 - Network Mask: /29 - Attached Router: 192.168.0.49 - Attached Router: 192.168.0.52 - Attached Router: 192.168.0.53 - Attached Router: 192.168.0.54 -@end example - -Note that from one LSA, you can find the other. E.g. Given the -Network-LSA you have a list of Router IDs on that network, from which -you can then look up, in the local @acronym{LSDB}, the matching Router -LSA@. From that Router-LSA you may (potentially) find links to other -Transit networks and Routers IDs which can be used to lookup the -corresponding Router or Network LSA@. And in that fashion, one can find -all the Routers and Networks reachable from that starting @acronym{LSA}@. - -Given the Router LSA instead, you have the IP address of the -@acronym{DR} of any attached transit links. Network LSAs will have that IP -as their LSA ID, so you can then look up that Network LSA and from that -find all the attached routers on that link, leading potentially to more -links and Network and Router LSAs, etc. etc. - -From just the above two @acronym{LSA}s, one can already see the -following partial topology: -@example -@group - - - --------------------- Network: ...... - | Designated Router IP: 192.168.1.3 - | - IP: 192.168.1.3 - (transit link) - (cost: 10) - Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32 - (cost: 10) (cost: 39063) - (transit link) - IP: 192.168.0.49 - | - | ------------------------------- Network: 192.168.0.48/29 - | | | Designated Router IP: 192.168.0.49 - | | | - | | Router ID: 192.168.0.54 - | | - | Router ID: 192.168.0.53 - | -Router ID: 192.168.0.52 -@end group -@end example - -Note the Router IDs, though they look like IP addresses and often are -IP addresses, are not strictly speaking IP addresses, nor need they be -reachable addresses (though, OSPF will calculate routes to Router IDs). - -@subsubsection External LSAs - -External, or "Type 5", @acronym{LSA}s describe routing information which is -entirely external to @acronym{OSPF}, and is "injected" into -@acronym{OSPF}@. Such routing information may have come from another -routing protocol, such as RIP or BGP, they may represent static routes -or they may represent a default route. - -An @acronym{OSPF} router which originates External @acronym{LSA}s is known as an -@acronym{ASBR,AS Boundary Router}. Unlike the link-state @acronym{LSA}s, and -most other @acronym{LSA}s, which are flooded only within the area in -which they originate, External @acronym{LSA}s are flooded through-out -the @acronym{OSPF} network to all areas capable of carrying External -@acronym{LSA}s (@pxref{OSPF Areas}). - -Routes internal to OSPF (intra-area or inter-area) are always preferred -over external routes. - -The External @acronym{LSA} describes the following: - -@itemize @bullet -@item IP Network number - -The IP Network number of the route is described by the @acronym{LSA} ID -field. - -@item IP Network Mask - -The body of the External LSA describes the IP Network Mask of the -route. This, together with the @acronym{LSA} ID, describes the prefix -of the IP route concerned. - -@item Metric - -The cost of the External Route. This cost may be an OSPF cost (also -known as a "Type 1" metric), i.e. equivalent to the normal OSPF costs, -or an externally derived cost ("Type 2" metric) which is not comparable -to OSPF costs and always considered larger than any OSPF cost. Where -there are both Type 1 and 2 External routes for a route, the Type 1 is -always preferred. - -@item Forwarding Address - -The address of the router to forward packets to for the route. This may -be, and usually is, left as 0 to specify that the ASBR originating the -External @acronym{LSA} should be used. There must be an internal OSPF -route to the forwarding address, for the forwarding address to be -useable. - -@item Tag - -An arbitrary 4-bytes of data, not interpreted by OSPF, which may -carry whatever information about the route which OSPF speakers desire. -@end itemize - -@subsubsection AS External LSA Example - -To illustrate, below is an example of an External @acronym{LSA} in the -@acronym{LSDB} of an OSPF router. It describes a route to the IP prefix -of 192.168.165.0/24, originated by the ASBR with Router-ID -192.168.0.49. The metric of 20 is external to OSPF. The forwarding -address is 0, so the route should forward to the originating ASBR if -selected. - -@example -@group -# show ip ospf database external 192.168.165.0 - LS age: 995 - Options: 0x2 : *|-|-|-|-|-|E|* - LS Flags: 0x9 - LS Type: AS-external-LSA - Link State ID: 192.168.165.0 (External Network Number) - Advertising Router: 192.168.0.49 - LS Seq Number: 800001d8 - Checksum: 0xea27 - Length: 36 - Network Mask: /24 - Metric Type: 2 (Larger than any link state path) - TOS: 0 - Metric: 20 - Forward Address: 0.0.0.0 - External Route Tag: 0 -@end group -@end example - -We can add this to our partial topology from above, which now looks -like: -@example -@group - --------------------- Network: ...... - | Designated Router IP: 192.168.1.3 - | - IP: 192.168.1.3 /---- External route: 192.168.165.0/24 - (transit link) / Cost: 20 (External metric) - (cost: 10) / - Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32 - (cost: 10) (cost: 39063) - (transit link) - IP: 192.168.0.49 - | - | ------------------------------- Network: 192.168.0.48/29 - | | | Designated Router IP: 192.168.0.49 - | | | - | | Router ID: 192.168.0.54 - | | - | Router ID: 192.168.0.53 - | -Router ID: 192.168.0.52 -@end group -@end example - -@subsubsection Summary LSAs - -Summary LSAs are created by @acronym{ABR}s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or @acronym{ASBR} routers. - -@anchor{OSPF Flooding} -@subsection OSPF Flooding - -@anchor{OSPF Areas} -@subsection OSPF Areas diff --git a/doc/ospfd.texi b/doc/ospfd.texi deleted file mode 100644 index cc33211510..0000000000 --- a/doc/ospfd.texi +++ /dev/null @@ -1,929 +0,0 @@ - -@cindex OSPFv2 -@node OSPFv2 -@chapter OSPFv2 - -@acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol -which is described in @cite{RFC2328, OSPF Version 2}. OSPF is an -@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, -@acronym{OSPF} can provide scalable network support and faster -convergence times. OSPF is widely used in large networks such as -@acronym{ISP,Internet Service Provider} backbone and enterprise -networks. - -@menu -* OSPF Fundamentals:: -* Configuring ospfd:: -* OSPF router:: -* OSPF area:: -* OSPF interface:: -* Redistribute routes to OSPF:: -* Showing OSPF information:: -* Opaque LSA:: -* OSPF Traffic Engineering:: -* Router Information:: -* Debugging OSPF:: -* OSPF Configuration Examples:: -@end menu - -@include ospf_fundamentals.texi - -@node Configuring ospfd -@section Configuring ospfd - -There are no @command{ospfd} specific options. Common options can be -specified (@pxref{Common Invocation Options}) to @command{ospfd}. -@command{ospfd} needs to acquire interface information from -@command{zebra} in order to function. Therefore @command{zebra} must be -running before invoking @command{ospfd}. Also, if @command{zebra} is -restarted then @command{ospfd} must be too. - -Like other daemons, @command{ospfd} configuration is done in @acronym{OSPF} -specific configuration file @file{ospfd.conf}. - -@node OSPF router -@section OSPF router - -To start OSPF process you have to specify the OSPF router. As of this -writing, @command{ospfd} does not support multiple OSPF processes. - -@deffn Command {router ospf} {} -@deffnx Command {no router ospf} {} -Enable or disable the OSPF process. @command{ospfd} does not yet -support multiple OSPF processes. So you can not specify an OSPF process -number. -@end deffn - -@deffn {OSPF Command} {ospf router-id @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no ospf router-id} {} -@anchor{ospf router-id}This sets the router-ID of the OSPF process. The -router-ID may be an IP address of the router, but need not be - it can -be any arbitrary 32bit number. However it MUST be unique within the -entire OSPF domain to the OSPF speaker - bad things will happen if -multiple OSPF speakers are configured with the same router-ID! If one -is not specified then @command{ospfd} will obtain a router-ID -automatically from @command{zebra}. -@end deffn - -@deffn {OSPF Command} {ospf abr-type @var{type}} {} -@deffnx {OSPF Command} {no ospf abr-type @var{type}} {} -@var{type} can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types -are equivalent. - -The OSPF standard for ABR behaviour does not allow an ABR to consider -routes through non-backbone areas when its links to the backbone are -down, even when there are other ABRs in attached non-backbone areas -which still can reach the backbone - this restriction exists primarily -to ensure routing-loops are avoided. - -With the "Cisco" or "IBM" ABR type, the default in this release of -Frr, this restriction is lifted, allowing an ABR to consider -summaries learnt from other ABRs through non-backbone areas, and hence -route via non-backbone areas as a last resort when, and only when, -backbone links are down. - -Note that areas with fully-adjacent virtual-links are considered to be -"transit capable" and can always be used to route backbone traffic, and -hence are unaffected by this setting (@pxref{OSPF virtual-link}). - -More information regarding the behaviour controlled by this command can -be found in @cite{RFC 3509, Alternative Implementations of OSPF Area -Border Routers}, and @cite{draft-ietf-ospf-shortcut-abr-02.txt}. - -Quote: "Though the definition of the @acronym{ABR,Area Border Router} -in the OSPF specification does not require a router with multiple -attached areas to have a backbone connection, it is actually -necessary to provide successful routing to the inter-area and -external destinations. If this requirement is not met, all traffic -destined for the areas not connected to such an ABR or out of the -OSPF domain, is dropped. This document describes alternative ABR -behaviors implemented in Cisco and IBM routers." -@end deffn - -@deffn {OSPF Command} {ospf rfc1583compatibility} {} -@deffnx {OSPF Command} {no ospf rfc1583compatibility} {} -@cite{RFC2328}, the sucessor to @cite{RFC1583}, suggests according -to section G.2 (changes) in section 16.4 a change to the path -preference algorithm that prevents possible routing loops that were -possible in the old version of OSPFv2. More specifically it demands -that inter-area paths and intra-area backbone path are now of equal preference -but still both preferred to external paths. - -This command should NOT be set normally. -@end deffn - -@deffn {OSPF Command} {log-adjacency-changes [detail]} {} -@deffnx {OSPF Command} {no log-adjacency-changes [detail]} {} -Configures ospfd to log changes in adjacency. With the optional -detail argument, all changes in adjacency status are shown. Without detail, -only changes to full or regressions are shown. -@end deffn - -@deffn {OSPF Command} {passive-interface @var{interface}} {} -@deffnx {OSPF Command} {no passive-interface @var{interface}} {} -@anchor{OSPF passive-interface} Do not speak OSPF interface on the -given interface, but do advertise the interface as a stub link in the -router-@acronym{LSA,Link State Advertisement} for this router. This -allows one to advertise addresses on such connected interfaces without -having to originate AS-External/Type-5 LSAs (which have global flooding -scope) - as would occur if connected addresses were redistributed into -OSPF (@pxref{Redistribute routes to OSPF})@. This is the only way to -advertise non-OSPF links into stub areas. -@end deffn - -@deffn {OSPF Command} {timers throttle spf @var{delay} @var{initial-holdtime} @var{max-holdtime}} {} -@deffnx {OSPF Command} {no timers throttle spf} {} -This command sets the initial @var{delay}, the @var{initial-holdtime} -and the @var{maximum-holdtime} between when SPF is calculated and the -event which triggered the calculation. The times are specified in -milliseconds and must be in the range of 0 to 600000 milliseconds. - -The @var{delay} specifies the minimum amount of time to delay SPF -calculation (hence it affects how long SPF calculation is delayed after -an event which occurs outside of the holdtime of any previous SPF -calculation, and also serves as a minimum holdtime). - -Consecutive SPF calculations will always be seperated by at least -'hold-time' milliseconds. The hold-time is adaptive and initially is -set to the @var{initial-holdtime} configured with the above command. -Events which occur within the holdtime of the previous SPF calculation -will cause the holdtime to be increased by @var{initial-holdtime}, bounded -by the @var{maximum-holdtime} configured with this command. If the adaptive -hold-time elapses without any SPF-triggering event occuring then -the current holdtime is reset to the @var{initial-holdtime}. The current -holdtime can be viewed with @ref{show ip ospf}, where it is expressed as -a multiplier of the @var{initial-holdtime}. - -@example -@group -router ospf - timers throttle spf 200 400 10000 -@end group -@end example - -In this example, the @var{delay} is set to 200ms, the @var{initial -holdtime} is set to 400ms and the @var{maximum holdtime} to 10s. Hence -there will always be at least 200ms between an event which requires SPF -calculation and the actual SPF calculation. Further consecutive SPF -calculations will always be seperated by between 400ms to 10s, the -hold-time increasing by 400ms each time an SPF-triggering event occurs -within the hold-time of the previous SPF calculation. - -This command supercedes the @command{timers spf} command in previous Frr -releases. -@end deffn - -@deffn {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} -@deffnx {OSPF Command} {max-metric router-lsa administrative} {} -@deffnx {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} -This enables @cite{RFC3137, OSPF Stub Router Advertisement} support, -where the OSPF process describes its transit links in its router-LSA as -having infinite distance so that other routers will avoid calculating -transit paths through the router while still being able to reach -networks through the router. - -This support may be enabled administratively (and indefinitely) or -conditionally. Conditional enabling of max-metric router-lsas can be -for a period of seconds after startup and/or for a period of seconds -prior to shutdown. - -Enabling this for a period after startup allows OSPF to converge fully -first without affecting any existing routes used by other routers, -while still allowing any connected stub links and/or redistributed -routes to be reachable. Enabling this for a period of time in advance -of shutdown allows the router to gracefully excuse itself from the OSPF -domain. - -Enabling this feature administratively allows for administrative -intervention for whatever reason, for an indefinite period of time. -Note that if the configuration is written to file, this administrative -form of the stub-router command will also be written to file. If -@command{ospfd} is restarted later, the command will then take effect -until manually deconfigured. - -Configured state of this feature as well as current status, such as the -number of second remaining till on-startup or on-shutdown ends, can be -viewed with the @ref{show ip ospf} command. -@end deffn - -@deffn {OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {} -@deffnx {OSPF Command} {no auto-cost reference-bandwidth} {} -@anchor{OSPF auto-cost reference-bandwidth}This sets the reference -bandwidth for cost calculations, where this bandwidth is considered -equivalent to an OSPF cost of 1, specified in Mbits/s. The default is -100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a -cost of 1. Cost of lower bandwidth links will be scaled with reference -to this cost). - -This configuration setting MUST be consistent across all routers within the -OSPF domain. -@end deffn - -@deffn {OSPF Command} {network @var{a.b.c.d/m} area @var{a.b.c.d}} {} -@deffnx {OSPF Command} {network @var{a.b.c.d/m} area @var{<0-4294967295>}} {} -@deffnx {OSPF Command} {no network @var{a.b.c.d/m} area @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no network @var{a.b.c.d/m} area @var{<0-4294967295>}} {} -@anchor{OSPF network command} -This command specifies the OSPF enabled interface(s). If the interface has -an address from range 192.168.1.0/24 then the command below enables ospf -on this interface so router can provide network information to the other -ospf routers via this interface. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 -@end group -@end example - -Prefix length in interface must be equal or bigger (ie. smaller network) than -prefix length in network statement. For example statement above doesn't enable -ospf on interface with address 192.168.1.1/23, but it does on interface with -address 192.168.1.129/25. - -Note that the behavior when there is a peer address -defined on an interface changed after release 0.99.7. -Currently, if a peer prefix has been configured, -then we test whether the prefix in the network command contains -the destination prefix. Otherwise, we test whether the network command prefix -contains the local address prefix of the interface. - -In some cases it may be more convenient to enable OSPF on a per -interface/subnet basis (@pxref{OSPF ip ospf area command}). - -@end deffn - -@node OSPF area -@section OSPF area - -@deffn {OSPF Command} {area @var{a.b.c.d} range @var{a.b.c.d/m}} {} -@deffnx {OSPF Command} {area <0-4294967295> range @var{a.b.c.d/m}} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} range @var{a.b.c.d/m}} {} -@deffnx {OSPF Command} {no area <0-4294967295> range @var{a.b.c.d/m}} {} -Summarize intra area paths from specified area into one Type-3 summary-LSA -announced to other areas. This command can be used only in ABR and ONLY -router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can -be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. -Summarizing Type-7 AS-external-LSAs isn't supported yet by Frr. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 range 10.0.0.0/8 -@end group -@end example - -With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is -announced into backbone area if area 0.0.0.10 contains at least one intra-area -network (ie. described with router or network LSA) from this range. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} range IPV4_PREFIX not-advertise} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} range IPV4_PREFIX not-advertise} {} -Instead of summarizing intra area paths filter them - ie. intra area paths from this -range are not advertised into other areas. -This command makes sense in ABR only. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} range IPV4_PREFIX substitute IPV4_PREFIX} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} range IPV4_PREFIX substitute IPV4_PREFIX} {} -Substitute summarized prefix with another prefix. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 -@end group -@end example - -One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if -area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or -network-LSA) from range 10.0.0.0/8. -This command makes sense in ABR only. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} virtual-link @var{a.b.c.d}} {} -@deffnx {OSPF Command} {area <0-4294967295> virtual-link @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} virtual-link @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no area <0-4294967295> virtual-link @var{a.b.c.d}} {} -@anchor{OSPF virtual-link} -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} shortcut} {} -@deffnx {OSPF Command} {area <0-4294967295> shortcut} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} shortcut} {} -@deffnx {OSPF Command} {no area <0-4294967295> shortcut} {} -Configure the area as Shortcut capable. See @cite{RFC3509}. This requires -that the 'abr-type' be set to 'shortcut'. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} stub} {} -@deffnx {OSPF Command} {area <0-4294967295> stub} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} stub} {} -@deffnx {OSPF Command} {no area <0-4294967295> stub} {} -Configure the area to be a stub area. That is, an area where no router -originates routes external to OSPF and hence an area where all external -routes are via the ABR(s). Hence, ABRs for such an area do not need -to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the -area. They need only pass Network-Summary (type-3) LSAs into such an area, -along with a default-route summary. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} stub no-summary} {} -@deffnx {OSPF Command} {area <0-4294967295> stub no-summary} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} stub no-summary} {} -@deffnx {OSPF Command} {no area <0-4294967295> stub no-summary} {} -Prevents an @command{ospfd} ABR from injecting inter-area -summaries into the specified stub area. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} default-cost <0-16777215>} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} default-cost <0-16777215>} {} -Set the cost of default-summary LSAs announced to stubby areas. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} export-list NAME} {} -@deffnx {OSPF Command} {area <0-4294967295> export-list NAME} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} export-list NAME} {} -@deffnx {OSPF Command} {no area <0-4294967295> export-list NAME} {} -Filter Type-3 summary-LSAs announced to other areas originated from intra- -area paths from specified area. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 export-list foo -! -access-list foo permit 10.10.0.0/16 -access-list foo deny any -@end group -@end example - -With example above any intra-area paths from area 0.0.0.10 and from range -10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into -other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16 -or 10.128.30.16/30) aren't. - -This command is only relevant if the router is an ABR for the specified -area. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} import-list NAME} {} -@deffnx {OSPF Command} {area <0-4294967295> import-list NAME} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} import-list NAME} {} -@deffnx {OSPF Command} {no area <0-4294967295> import-list NAME} {} -Same as export-list, but it applies to paths announced into specified area as -Type-3 summary-LSAs. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} filter-list prefix NAME in} {} -@deffnx {OSPF Command} {area @var{a.b.c.d} filter-list prefix NAME out} {} -@deffnx {OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {} -@deffnx {OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} filter-list prefix NAME in} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} filter-list prefix NAME out} {} -@deffnx {OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {} -@deffnx {OSPF Command} {no area <0-4294967295> filter-list prefix NAME out} {} -Filtering Type-3 summary-LSAs to/from area using prefix lists. This command -makes sense in ABR only. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} authentication} {} -@deffnx {OSPF Command} {area <0-4294967295> authentication} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} authentication} {} -@deffnx {OSPF Command} {no area <0-4294967295> authentication} {} -Specify that simple password authentication should be used for the given -area. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} authentication message-digest} {} -@deffnx {OSPF Command} {area <0-4294967295> authentication message-digest} {} - -@anchor{area authentication message-digest}Specify that OSPF packets -must be authenticated with MD5 HMACs within the given area. Keying -material must also be configured on a per-interface basis (@pxref{ip -ospf message-digest-key}). - -MD5 authentication may also be configured on a per-interface basis -(@pxref{ip ospf authentication message-digest}). Such per-interface -settings will override any per-area authentication setting. -@end deffn - -@node OSPF interface -@section OSPF interface - -@deffn {Interface Command} {ip ospf area @var{AREA} [@var{ADDR}]} {} -@deffnx {Interface Command} {no ip ospf area [@var{ADDR}]} {} -@anchor{OSPF ip ospf area command} - -Enable OSPF on the interface, optionally restricted to just the IP address -given by @var{ADDR}, putting it in the @var{AREA} area. Per interface area -settings take precedence to network commands (@pxref{OSPF network command}). - -If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF -via this command may result in a slight performance improvement. - -@end deffn - -@deffn {Interface Command} {ip ospf authentication-key @var{AUTH_KEY}} {} -@deffnx {Interface Command} {no ip ospf authentication-key} {} -Set OSPF authentication key to a simple password. After setting @var{AUTH_KEY}, -all OSPF packets are authenticated. @var{AUTH_KEY} has length up to 8 chars. - -Simple text password authentication is insecure and deprecated in favour of -MD5 HMAC authentication (@pxref{ip ospf authentication message-digest}). -@end deffn - -@deffn {Interface Command} {ip ospf authentication message-digest} {} -@anchor{ip ospf authentication message-digest}Specify that MD5 HMAC -authentication must be used on this interface. MD5 keying material must -also be configured (@pxref{ip ospf message-digest-key}). Overrides any -authentication enabled on a per-area basis (@pxref{area -authentication message-digest}). - -Note that OSPF MD5 authentication requires that time never go backwards -(correct time is NOT important, only that it never goes backwards), even -across resets, if ospfd is to be able to promptly reestabish adjacencies -with its neighbours after restarts/reboots. The host should have system -time be set at boot from an external or non-volatile source (eg battery backed clock, NTP, -etc.) or else the system clock should be periodically saved to non-volative -storage and restored at boot if MD5 authentication is to be expected to work -reliably. -@end deffn - -@deffn {Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {} -@deffnx {Interface Command} {no ip ospf message-digest-key} {} -@anchor{ip ospf message-digest-key}Set OSPF authentication key to a -cryptographic password. The cryptographic algorithm is MD5. - -KEYID identifies secret key used to create the message digest. This ID -is part of the protocol and must be consistent across routers on a -link. - -KEY is the actual message digest key, of up to 16 chars (larger strings -will be truncated), and is associated with the given KEYID. -@end deffn - -@deffn {Interface Command} {ip ospf cost <1-65535>} {} -@deffnx {Interface Command} {no ip ospf cost} {} -Set link cost for the specified interface. The cost value is set to router-LSA's -metric field and used for SPF calculation. -@end deffn - -@deffn {Interface Command} {ip ospf dead-interval <1-65535>} {} -@deffnx {Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {} -@deffnx {Interface Command} {no ip ospf dead-interval} {} -@anchor{ip ospf dead-interval minimal} Set number of seconds for -RouterDeadInterval timer value used for Wait Timer and Inactivity -Timer. This value must be the same for all routers attached to a -common network. The default value is 40 seconds. - -If 'minimal' is specified instead, then the dead-interval is set to 1 -second and one must specify a hello-multiplier. The hello-multiplier -specifies how many Hellos to send per second, from 2 (every 500ms) to -20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form -is specified, then the hello-interval advertised in Hello packets is set to -0 and the hello-interval on received Hello packets is not checked, thus -the hello-multiplier need NOT be the same across multiple routers on a common -link. -@end deffn - -@deffn {Interface Command} {ip ospf hello-interval <1-65535>} {} -@deffnx {Interface Command} {no ip ospf hello-interval} {} -Set number of seconds for HelloInterval timer value. Setting this value, -Hello packet will be sent every timer value seconds on the specified interface. -This value must be the same for all routers attached to a common network. -The default value is 10 seconds. - -This command has no effect if @ref{ip ospf dead-interval minimal} is also -specified for the interface. -@end deffn - -@deffn {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} -@deffnx {Interface Command} {no ip ospf network} {} -Set explicitly network type for specifed interface. -@end deffn - -@deffn {Interface Command} {ip ospf priority <0-255>} {} -@deffnx {Interface Command} {no ip ospf priority} {} -Set RouterPriority integer value. The router with the highest priority -will be more eligible to become Designated Router. Setting the value -to 0, makes the router ineligible to become Designated Router. The -default value is 1. -@end deffn - -@deffn {Interface Command} {ip ospf retransmit-interval <1-65535>} {} -@deffnx {Interface Command} {no ip ospf retransmit interval} {} -Set number of seconds for RxmtInterval timer value. This value is used -when retransmitting Database Description and Link State Request packets. -The default value is 5 seconds. -@end deffn - -@deffn {Interface Command} {ip ospf transmit-delay} {} -@deffnx {Interface Command} {no ip ospf transmit-delay} {} -Set number of seconds for InfTransDelay value. LSAs' age should be -incremented by this value when transmitting. -The default value is 1 seconds. -@end deffn - -@deffn {Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {} -@deffnx {Interface Command} {no ip ospf area} {} -Enable ospf on an interface and set associated area. -@end deffn - -@node Redistribute routes to OSPF -@section Redistribute routes to OSPF - -@deffn {OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) @var{route-map}} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map @var{word}} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map @var{word}} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map @var{word}} {} -@deffnx {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} -@anchor{OSPF redistribute}Redistribute routes of the specified protocol -or kind into OSPF, with the metric type and metric set if specified, -filtering the routes using the given route-map if specified. -Redistributed routes may also be filtered with distribute-lists, see -@ref{ospf distribute-list}. - -Redistributed routes are distributed as into OSPF as Type-5 External -LSAs into links to areas that accept external routes, Type-7 External LSAs -for NSSA areas and are not redistributed at all into Stub areas, where -external routes are not permitted. - -Note that for connected routes, one may instead use -@dfn{passive-interface}, see @ref{OSPF passive-interface}. -@end deffn - -@deffn {OSPF Command} {default-information originate} {} -@deffnx {OSPF Command} {default-information originate metric <0-16777214>} {} -@deffnx {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {} -@deffnx {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map @var{word}} {} -@deffnx {OSPF Command} {default-information originate always} {} -@deffnx {OSPF Command} {default-information originate always metric <0-16777214>} {} -@deffnx {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {} -@deffnx {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map @var{word}} {} -@deffnx {OSPF Command} {no default-information originate} {} -Originate an AS-External (type-5) LSA describing a default route into -all external-routing capable areas, of the specified metric and metric -type. If the 'always' keyword is given then the default is always -advertised, even when there is no default present in the routing table. -@end deffn - -@deffn {OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {} -@deffnx {OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {} -@anchor{ospf distribute-list}Apply the access-list filter, NAME, to -redistributed routes of the given type before allowing the routes to -redistributed into OSPF (@pxref{OSPF redistribute}). -@end deffn - -@deffn {OSPF Command} {default-metric <0-16777214>} {} -@deffnx {OSPF Command} {no default-metric} {} -@end deffn - -@deffn {OSPF Command} {distance <1-255>} {} -@deffnx {OSPF Command} {no distance <1-255>} {} -@end deffn - -@deffn {OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {} -@deffnx {OSPF Command} {no distance ospf} {} -@end deffn - -@deffn {Command} {router zebra} {} -@deffnx {Command} {no router zebra} {} -@end deffn - -@node Showing OSPF information -@section Showing OSPF information - -@deffn {Command} {show ip ospf} {} -@anchor{show ip ospf}Show information on a variety of general OSPF and -area state and configuration information. -@end deffn - -@deffn {Command} {show ip ospf interface [INTERFACE]} {} -Show state and configuration of OSPF the specified interface, or all -interfaces if no interface is given. -@end deffn - -@deffn {Command} {show ip ospf neighbor} {} -@deffnx {Command} {show ip ospf neighbor INTERFACE} {} -@deffnx {Command} {show ip ospf neighbor detail} {} -@deffnx {Command} {show ip ospf neighbor INTERFACE detail} {} -@end deffn - -@deffn {Command} {show ip ospf database} {} -@end deffn - -@deffn {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id}} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} self-originate} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {} -@end deffn - -@deffn {Command} {show ip ospf database max-age} {} -@end deffn - -@deffn {Command} {show ip ospf database self-originate} {} -@end deffn - -@deffn {Command} {show ip ospf route} {} -Show the OSPF routing table, as determined by the most recent SPF calculation. -@end deffn - -@node Opaque LSA -@section Opaque LSA - -@deffn {OSPF Command} {ospf opaque-lsa} {} -@deffnx {OSPF Command} {capability opaque} {} -@deffnx {OSPF Command} {no ospf opaque-lsa} {} -@deffnx {OSPF Command} {no capability opaque} {} -@command{ospfd} support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration file. Alternate command could be "mpls-te on" (@ref{OSPF Traffic Engineering}). -@end deffn - -@deffn {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id}} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id} adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id} self-originate} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {} -Show Opaque LSA from the database. -@end deffn - -@node OSPF Traffic Engineering -@section Traffic Engineering - -@deffn {OSPF Command} {mpls-te on} {} -@deffnx {OSPF Command} {no mpls-te} {} -Enable Traffic Engineering LSA flooding. -@end deffn - -@deffn {OSPF Command} {mpls-te router-address } {} -@deffnx {OSPF Command} {no mpls-te} {} -Configure stable IP address for MPLS-TE. This IP address is then advertise in Opaque LSA Type-10 TLV=1 (TE) -option 1 (Router-Address). -@end deffn - -@deffn {OSPF Command} {mpls-te inter-as area |as} {} -@deffnx {OSPF Command} {no mpls-te inter-as} {} -Enable RFC5392 suuport - Inter-AS TE v2 - to flood Traffic Engineering parameters of Inter-AS link. -2 modes are supported: AREA and AS; LSA are flood in AREA with Opaque Type-10, -respectively in AS with Opaque Type-11. In all case, Opaque-LSA TLV=6. -@end deffn - -@deffn {Command} {show ip ospf mpls-te interface} {} -@deffnx {Command} {show ip ospf mpls-te interface @var{interface}} {} -Show MPLS Traffic Engineering parameters for all or specified interface. -@end deffn - -@deffn {Command} {show ip ospf mpls-te router} {} -Show Traffic Engineering router parameters. -@end deffn - -@node Router Information -@section Router Information - -@deffn {OSPF Command} {router-info [as | area ]} {} -@deffnx {OSPF Command} {no router-info} {} -Enable Router Information (RFC4970) LSA advertisement with AS scope (default) or Area scope flooding -when area is specified. -@end deffn - -@deffn {OSPF Command} {pce address } {} -@deffnx {OSPF Command} {no pce address} {} -@deffnx {OSPF Command} {pce domain as <0-65535>} {} -@deffnx {OSPF Command} {no pce domain as <0-65535>} {} -@deffnx {OSPF Command} {pce neighbor as <0-65535>} {} -@deffnx {OSPF Command} {no pce neighbor as <0-65535>} {} -@deffnx {OSPF Command} {pce flag BITPATTERN} {} -@deffnx {OSPF Command} {no pce flag} {} -@deffnx {OSPF Command} {pce scope BITPATTERN} {} -@deffnx {OSPF Command} {no pce scope} {} -The commands are conform to RFC 5088 and allow OSPF router announce Path Compuatation Elemenent (PCE) capabilities -through the Router Information (RI) LSA. Router Information must be enable prior to this. The command set/unset -respectively the PCE IP adress, Autonomous System (AS) numbers of controlled domains, neighbor ASs, flag and scope. -For flag and scope, please refer to RFC5088 for the BITPATTERN recognition. Multiple 'pce neighbor' command could -be specified in order to specify all PCE neighbours. -@end deffn - -@deffn {Command} {show ip ospf router-info} {} -Show Router Capabilities flag. -@end deffn -@deffn {Command} {show ip ospf router-info pce} {} -Show Router Capabilities PCE parameters. -@end deffn - -@node Debugging OSPF -@section Debugging OSPF - -@deffn {Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} -@deffnx {Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} -Dump Packet for debugging -@end deffn - -@deffn {Command} {debug ospf ism} {} -@deffnx {Command} {debug ospf ism (status|events|timers)} {} -@deffnx {Command} {no debug ospf ism} {} -@deffnx {Command} {no debug ospf ism (status|events|timers)} {} -Show debug information of Interface State Machine -@end deffn - -@deffn {Command} {debug ospf nsm} {} -@deffnx {Command} {debug ospf nsm (status|events|timers)} {} -@deffnx {Command} {no debug ospf nsm} {} -@deffnx {Command} {no debug ospf nsm (status|events|timers)} {} -Show debug information of Network State Machine -@end deffn - -@deffn {Command} {debug ospf event} {} -@deffnx {Command} {no debug ospf event} {} -Show debug information of OSPF event -@end deffn - -@deffn {Command} {debug ospf nssa} {} -@deffnx {Command} {no debug ospf nssa} {} -Show debug information about Not So Stub Area -@end deffn - -@deffn {Command} {debug ospf lsa} {} -@deffnx {Command} {debug ospf lsa (generate|flooding|refresh)} {} -@deffnx {Command} {no debug ospf lsa} {} -@deffnx {Command} {no debug ospf lsa (generate|flooding|refresh)} {} -Show debug detail of Link State messages -@end deffn - -@deffn {Command} {debug ospf te} {} -@deffnx {Command} {no debug ospf te} {} -Show debug information about Traffic Engineering LSA -@end deffn - -@deffn {Command} {debug ospf zebra} {} -@deffnx {Command} {debug ospf zebra (interface|redistribute)} {} -@deffnx {Command} {no debug ospf zebra} {} -@deffnx {Command} {no debug ospf zebra (interface|redistribute)} {} -Show debug information of ZEBRA API -@end deffn - -@deffn {Command} {show debugging ospf} {} -@end deffn - -@node OSPF Configuration Examples -@section OSPF Configuration Examples -A simple example, with MD5 authentication enabled: - -@example -@group -! -interface bge0 - ip ospf authentication message-digest - ip ospf message-digest-key 1 md5 ABCDEFGHIJK -! -router ospf - network 192.168.0.0/16 area 0.0.0.1 - area 0.0.0.1 authentication message-digest -@end group -@end example - -An @acronym{ABR} router, with MD5 authentication and performing summarisation -of networks between the areas: - -@example -@group -! -password ABCDEF -log file /var/log/frr/ospfd.log -service advanced-vty -! -interface eth0 - ip ospf authentication message-digest - ip ospf message-digest-key 1 md5 ABCDEFGHIJK -! -interface ppp0 -! -interface br0 - ip ospf authentication message-digest - ip ospf message-digest-key 2 md5 XYZ12345 -! -router ospf - ospf router-id 192.168.0.1 - redistribute connected - passive interface ppp0 - network 192.168.0.0/24 area 0.0.0.0 - network 10.0.0.0/16 area 0.0.0.0 - network 192.168.1.0/24 area 0.0.0.1 - area 0.0.0.0 authentication message-digest - area 0.0.0.0 range 10.0.0.0/16 - area 0.0.0.0 range 192.168.0.0/24 - area 0.0.0.1 authentication message-digest - area 0.0.0.1 range 10.2.0.0/16 -! -@end group -@end example - -A Traffic Engineering configuration, with Inter-ASv2 support. - - - First, the 'zebra.conf' part: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/zebra.log -! -interface eth0 - ip address 198.168.1.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab -! -interface eth1 - ip address 192.168.2.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - mpls-te neighbor 192.168.2.2 as 65000 -@end group -@end example - - - Then the 'ospfd.conf' itself: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/ospfd.log -! -! -interface eth0 - ip ospf hello-interval 60 - ip ospf dead-interval 240 -! -interface eth1 - ip ospf hello-interval 60 - ip ospf dead-interval 240 -! -! -router ospf - ospf router-id 192.168.1.1 - network 192.168.0.0/16 area 1 - ospf opaque-lsa - mpls-te - mpls-te router-address 192.168.1.1 - mpls-te inter-as area 1 -! -line vty -@end group -@end example - -A router information example with PCE advsertisement: - -@example -@group -! -router ospf - ospf router-id 192.168.1.1 - network 192.168.0.0/16 area 1 - capability opaque - mpls-te - mpls-te router-address 192.168.1.1 - router-info area 0.0.0.1 - pce address 192.168.1.1 - pce flag 0x80 - pce domain as 65400 - pce neighbor as 65500 - pce neighbor as 65200 - pce scope 0x80 -! -@end group -@end example diff --git a/doc/overview.texi b/doc/overview.texi deleted file mode 100644 index c988e219b7..0000000000 --- a/doc/overview.texi +++ /dev/null @@ -1,337 +0,0 @@ -@node Overview -@chapter Overview -@cindex Overview - - @uref{@value{PACKAGE_URL},,Frr} is a routing software package that -provides TCP/IP based routing services with routing protocols support such -as RIPv1, RIPv2, RIPng, OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (@pxref{Supported -RFCs}). Frr also supports special BGP Route Reflector and Route Server -behavior. In addition to traditional IPv4 routing protocols, Frr also -supports IPv6 routing protocols. With SNMP daemon which supports SMUX and AgentX -protocol, Frr provides routing protocol MIBs (@pxref{SNMP Support}). - - Frr uses an advanced software architecture to provide you with a high -quality, multi server routing engine. Frr has an interactive user -interface for each routing protocol and supports common client commands. -Due to this design, you can add new protocol daemons to Frr easily. You -can use Frr library as your program's client user interface. - - Frr is distributed under the @sc{gnu} General Public License. - -@menu -* About Frr:: Basic information about Frr -* System Architecture:: The Frr system architecture -* Supported Platforms:: Supported platforms and future plans -* Supported RFCs:: Supported RFCs -* How to get Frr:: -* Mailing List:: Mailing list information -* Bug Reports:: Mail address for bug data -@end menu - -@node About Frr -@comment node-name, next, previous, up -@section About Frr -@cindex About Frr - - Today, TCP/IP networks are covering all of the world. The Internet has -been deployed in many countries, companies, and to the home. When you -connect to the Internet your packet will pass many routers which have TCP/IP -routing functionality. - - A system with Frr installed acts as a dedicated router. With Frr, -your machine exchanges routing information with other routers using routing -protocols. Frr uses this information to update the kernel routing table -so that the right data goes to the right place. You can dynamically change -the configuration and you may view routing table information from the Frr -terminal interface. - - Adding to routing protocol support, Frr can setup interface's flags, -interface's address, static routes and so on. If you have a small network, -or a stub network, or xDSL connection, configuring the Frr routing -software is very easy. The only thing you have to do is to set up the -interfaces and put a few commands about static routes and/or default routes. -If the network is rather large, or if the network structure changes -frequently, you will want to take advantage of Frr's dynamic routing -protocol support for protocols such as RIP, OSPF, IS-IS or BGP. - - Traditionally, UNIX based router configuration is done by -@command{ifconfig} and @command{route} commands. Status of routing -table is displayed by @command{netstat} utility. Almost of these commands -work only if the user has root privileges. Frr has a different system -administration method. There are two user modes in Frr. One is normal -mode, the other is enable mode. Normal mode user can only view system -status, enable mode user can change system configuration. This UNIX account -independent feature will be great help to the router administrator. - - Currently, Frr supports common unicast routing protocols, that is BGP, -OSPF, RIP and IS-IS. Upcoming for MPLS support, an implementation of LDP is -currently being prepared for merging. Implementations of BFD and PIM-SSM -(IPv4) also exist, but are not actively being worked on. - - The ultimate goal of the Frr project is making a productive, quality, free -TCP/IP routing software package. - -@node System Architecture -@comment node-name, next, previous, up -@section System Architecture -@cindex System architecture -@cindex Software architecture -@cindex Software internals - - Traditional routing software is made as a one process program which -provides all of the routing protocol functionalities. Frr takes a -different approach. It is made from a collection of several daemons that -work together to build the routing table. There may be several -protocol-specific routing daemons and zebra the kernel routing manager. - - The @command{ripd} daemon handles the RIP protocol, while -@command{ospfd} is a daemon which supports OSPF version 2. -@command{bgpd} supports the BGP-4 protocol. For changing the kernel -routing table and for redistribution of routes between different routing -protocols, there is a kernel routing table manager @command{zebra} daemon. -It is easy to add a new routing protocol daemons to the entire routing -system without affecting any other software. You need to run only the -protocol daemon associated with routing protocols in use. Thus, user may -run a specific daemon and send routing reports to a central routing console. - - There is no need for these daemons to be running on the same machine. You -can even run several same protocol daemons on the same machine. This -architecture creates new possibilities for the routing system. - -@example -@group -+----+ +----+ +-----+ +-----+ -|bgpd| |ripd| |ospfd| |zebra| -+----+ +----+ +-----+ +-----+ - | -+---------------------------|--+ -| v | -| UNIX Kernel routing table | -| | -+------------------------------+ - - Frr System Architecture -@end group -@end example - -Multi-process architecture brings extensibility, modularity and -maintainability. At the same time it also brings many configuration files -and terminal interfaces. Each daemon has it's own configuration file and -terminal interface. When you configure a static route, it must be done in -@command{zebra} configuration file. When you configure BGP network it must -be done in @command{bgpd} configuration file. This can be a very annoying -thing. To resolve the problem, Frr provides integrated user interface -shell called @command{vtysh}. @command{vtysh} connects to each daemon with -UNIX domain socket and then works as a proxy for user input. - -Frr was planned to use multi-threaded mechanism when it runs with a -kernel that supports multi-threads. But at the moment, the thread library -which comes with @sc{gnu}/Linux or FreeBSD has some problems with running -reliable services such as routing software, so we don't use threads at all. -Instead we use the @command{select(2)} system call for multiplexing the -events. - -@node Supported Platforms -@comment node-name, next, previous, up -@section Supported Platforms - -@cindex Supported platforms -@cindex Frr on other systems -@cindex Compatibility with other systems -@cindex Operating systems that support Frr - -Currently Frr supports @sc{gnu}/Linux and BSD. Porting Frr -to other platforms is not too difficult as platform dependent code should -most be limited to the @command{zebra} daemon. Protocol daemons are mostly -platform independent. Please let us know when you find out Frr runs on a -platform which is not listed below. - -The list of officially supported platforms are listed below. Note that -Frr may run correctly on other platforms, and may run with partial -functionality on further platforms. - -@sp 1 -@itemize @bullet -@item -@sc{gnu}/Linux -@item -FreeBSD -@item -NetBSD -@item -OpenBSD -@end itemize - -Versions of these platforms that are older than around 2 years from the point -of their original release (in case of @sc{gnu}/Linux, this is since the kernel's -release on kernel.org) may need some work. Similarly, the following platforms -may work with some effort: - -@sp 1 -@itemize @bullet -@item -Solaris -@item -Mac OSX -@end itemize - -Also note that, in particular regarding proprietary platforms, compiler -and C library choice will affect Frr. Only recent versions of the -following C compilers are well-tested: - -@sp 1 -@itemize @bullet -@item -@sc{gnu}'s GCC -@item -LLVM's clang -@item -Intel's ICC -@end itemize - -@node Supported RFCs -@comment node-name, next, previous, up -@section Supported RFCs - - Below is the list of currently supported RFC's. - -@table @asis -@item @asis{RFC1058} -@cite{Routing Information Protocol. C.L. Hedrick. Jun-01-1988.} - -@item @asis{RF2082} -@cite{RIP-2 MD5 Authentication. F. Baker, R. Atkinson. January 1997.} - -@item @asis{RFC2453} -@cite{RIP Version 2. G. Malkin. November 1998.} - -@item @asis{RFC2080} -@cite{RIPng for IPv6. G. Malkin, R. Minnear. January 1997.} - -@item @asis{RFC2328} -@cite{OSPF Version 2. J. Moy. April 1998.} - -@item @asis{RFC2370} -@cite{The OSPF Opaque LSA Option R. Coltun. July 1998.} - -@item @asis{RFC3101} -@cite{The OSPF Not-So-Stubby Area (NSSA) Option P. Murphy. January 2003.} - -@item @asis{RFC2740} -@cite{OSPF for IPv6. R. Coltun, D. Ferguson, J. Moy. December 1999.} - -@item @asis{RFC1771} -@cite{A Border Gateway Protocol 4 (BGP-4). Y. Rekhter & T. Li. March 1995.} - -@item @asis{RFC1965} -@cite{Autonomous System Confederations for BGP. P. Traina. June 1996.} - -@item @asis{RFC1997} -@cite{BGP Communities Attribute. R. Chandra, P. Traina & T. Li. August 1996.} - -@item @asis{RFC2545} -@cite{Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing. P. Marques, F. Dupont. March 1999.} - -@item @asis{RFC2796} -@cite{BGP Route Reflection An alternative to full mesh IBGP. T. Bates & R. Chandrasekeran. June 1996.} - -@item @asis{RFC2858} -@cite{Multiprotocol Extensions for BGP-4. T. Bates, Y. Rekhter, R. Chandra, D. Katz. June 2000.} - -@item @asis{RFC2842} -@cite{Capabilities Advertisement with BGP-4. R. Chandra, J. Scudder. May 2000.} - -@item @asis{RFC3137} -@cite{OSPF Stub Router Advertisement, A. Retana, L. Nguyen, R. White, A. Zinin, D. McPherson. June 2001} -@end table - - When SNMP support is enabled, below RFC is also supported. - -@table @asis - -@item @asis{RFC1227} -@cite{SNMP MUX protocol and MIB. M.T. Rose. May-01-1991.} - -@item @asis{RFC1657} -@cite{Definitions of Managed Objects for the Fourth Version of the -Border Gateway Protocol (BGP-4) using SMIv2. S. Willis, J. Burruss, -J. Chu, Editor. July 1994.} - -@item @asis{RFC1724} -@cite{RIP Version 2 MIB Extension. G. Malkin & F. Baker. November 1994.} - -@item @asis{RFC1850} -@cite{OSPF Version 2 Management Information Base. F. Baker, R. Coltun. -November 1995.} - -@item @asis{RFC2741} -@cite{Agent Extensibility (AgentX) Protocol. M. Daniele, B. Wijnen. January 2000.} - -@end table - -@node How to get Frr -@comment node-name, next, previous, up -@section How to get Frr - -The official Frr web-site is located at: - -@uref{@value{PACKAGE_URL}} - -and contains further information, as well as links to additional -resources. - -@uref{@value{PACKAGE_URL},Frr} is a fork of Quagga, whose -web-site is located at: - -@uref{http://www.quagga.net/}. - -@node Mailing List -@comment node-name, next, previous, up -@section Mailing List -@cindex How to get in touch with Frr -@cindex Mailing Frr -@cindex Contact information -@cindex Mailing lists - -There is a mailing list for discussions about Frr. If you have any -comments or suggestions to Frr, please subscribe to: - -@uref{https://lists.frrouting.org/listinfo/frog}. - -The @uref{@value{PACKAGE_URL},,Frr} site has further information on -the available mailing lists, see: - - @uref{https://lists.frrouting.org/} - -@node Bug Reports -@section Bug Reports - -@cindex Bug Reports -@cindex Bug hunting -@cindex Found a bug? -@cindex Reporting bugs -@cindex Reporting software errors -@cindex Errors in the software - -If you think you have found a bug, please send a bug report to: - -@uref{http://github.com/frrouting/frr/issues} - -When you send a bug report, please be careful about the points below. - -@itemize @bullet -@item -Please note what kind of OS you are using. If you use the IPv6 stack -please note that as well. -@item -Please show us the results of @code{netstat -rn} and @code{ifconfig -a}. -Information from zebra's VTY command @code{show ip route} will also be -helpful. -@item -Please send your configuration file with the report. If you specify -arguments to the configure script please note that too. -@end itemize - - Bug reports are very important for us to improve the quality of Frr. -Frr is still in the development stage, but please don't hesitate to -send a bug report to @uref{http://github.com/frrouting/frr/issues}. diff --git a/doc/ripd.texi b/doc/ripd.texi deleted file mode 100644 index da0f596afd..0000000000 --- a/doc/ripd.texi +++ /dev/null @@ -1,623 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@node RIP -@chapter RIP - -RIP -- Routing Information Protocol is widely deployed interior gateway -protocol. RIP was developed in the 1970s at Xerox Labs as part of the -XNS routing protocol. RIP is a @dfn{distance-vector} protocol and is -based on the @dfn{Bellman-Ford} algorithms. As a distance-vector -protocol, RIP router send updates to its neighbors periodically, thus -allowing the convergence to a known topology. In each update, the -distance to any given network will be broadcasted to its neighboring -router. - -@command{ripd} supports RIP version 2 as described in RFC2453 and RIP -version 1 as described in RFC1058. - -@menu -* 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:: -@end menu - -@node Starting and Stopping ripd -@section Starting and Stopping ripd - -The default configuration file name of @command{ripd}'s is -@file{ripd.conf}. When invocation @command{ripd} searches directory -@value{INSTALL_PREFIX_ETC}. If @file{ripd.conf} is not there next -search current directory. - -RIP uses UDP port 520 to send and receive RIP packets. So the user must have -the capability to bind the port, generally this means that the user must -have superuser privileges. RIP protocol requires interface information -maintained by @command{zebra} daemon. So running @command{zebra} -is mandatory to run @command{ripd}. Thus minimum sequence for running -RIP is like below: - -@example -@group -# zebra -d -# ripd -d -@end group -@end example - -Please note that @command{zebra} must be invoked before @command{ripd}. - -To stop @command{ripd}. Please use @command{kill `cat -/var/run/ripd.pid`}. Certain signals have special meaningss to @command{ripd}. - -@table @samp -@item SIGHUP -Reload configuration file @file{ripd.conf}. All configurations are -reseted. All routes learned so far are cleared and removed from routing -table. -@item SIGUSR1 -Rotate @command{ripd} logfile. -@item SIGINT -@itemx SIGTERM -@command{ripd} sweeps all installed RIP routes then terminates properly. -@end table - -@command{ripd} invocation options. Common options that can be specified -(@pxref{Common Invocation Options}). - -@table @samp -@item -r -@itemx --retain -When the program terminates, retain routes added by @command{ripd}. -@end table - -@menu -* RIP netmask:: -@end menu - -@node RIP netmask -@subsection RIP netmask - -The netmask features of @command{ripd} support both version 1 and version 2 of -RIP. Version 1 of RIP originally contained no netmask information. In -RIP version 1, network classes were originally used to determine the -size of the netmask. Class A networks use 8 bits of mask, Class B -networks use 16 bits of masks, while Class C networks use 24 bits of -mask. Today, the most widely used method of a network mask is assigned -to the packet on the basis of the interface that received the packet. -Version 2 of RIP supports a variable length subnet mask (VLSM). By -extending the subnet mask, the mask can be divided and reused. Each -subnet can be used for different purposes such as large to middle size -LANs and WAN links. Frr @command{ripd} does not support the non-sequential -netmasks that are included in RIP Version 2. - -In a case of similar information with the same prefix and metric, the -old information will be suppressed. Ripd does not currently support -equal cost multipath routing. - - -@node RIP Configuration -@section RIP Configuration - -@deffn Command {router rip} {} -The @code{router rip} command is necessary to enable RIP. To disable -RIP, use the @code{no router rip} command. RIP must be enabled before -carrying out any of the RIP commands. -@end deffn - -@deffn Command {no router rip} {} -Disable RIP. -@end deffn - -@deffn {RIP Command} {network @var{network}} {} -@deffnx {RIP Command} {no network @var{network}} {} -Set the RIP enable interface by @var{network}. The interfaces which -have addresses matching with @var{network} are enabled. - -This group of commands either enables or disables RIP interfaces between -certain numbers of a specified network address. For example, if the -network for 10.0.0.0/24 is RIP enabled, this would result in all the -addresses from 10.0.0.0 to 10.0.0.255 being enabled for RIP. The @code{no -network} command will disable RIP for the specified network. -@end deffn - -@deffn {RIP Command} {network @var{ifname}} {} -@deffnx {RIP Command} {no network @var{ifname}} {} -Set a RIP enabled interface by @var{ifname}. Both the sending and -receiving of RIP packets will be enabled on the port specified in the -@code{network ifname} command. The @code{no network ifname} command will disable -RIP on the specified interface. -@end deffn - -@deffn {RIP Command} {neighbor @var{a.b.c.d}} {} -@deffnx {RIP Command} {no neighbor @var{a.b.c.d}} {} -Specify RIP neighbor. When a neighbor doesn't understand multicast, -this command is used to specify neighbors. In some cases, not all -routers will be able to understand multicasting, where packets are sent -to a network or a group of addresses. In a situation where a neighbor -cannot process multicast packets, it is necessary to establish a direct -link between routers. The neighbor command allows the network -administrator to specify a router as a RIP neighbor. The @code{no -neighbor a.b.c.d} command will disable the RIP neighbor. -@end deffn - -Below is very simple RIP configuration. Interface @code{eth0} and -interface which address match to @code{10.0.0.0/8} are RIP enabled. - -@example -@group -! -router rip - network 10.0.0.0/8 - network eth0 -! -@end group -@end example - -Passive interface - -@deffn {RIP command} {passive-interface (@var{IFNAME}|default)} {} -@deffnx {RIP command} {no passive-interface @var{IFNAME}} {} -This command sets the specified interface to passive mode. On passive mode -interface, all receiving packets are processed as normal and ripd does -not send either multicast or unicast RIP packets except to RIP neighbors -specified with @code{neighbor} command. The interface may be specified -as @var{default} to make ripd default to passive on all interfaces. - -The default is to be passive on all interfaces. -@end deffn - -RIP split-horizon - -@deffn {Interface command} {ip split-horizon} {} -@deffnx {Interface command} {no ip split-horizon} {} -Control split-horizon on the interface. Default is @code{ip -split-horizon}. If you don't perform split-horizon on the interface, -please specify @code{no ip split-horizon}. -@end deffn - -@node RIP Version Control -@section RIP Version Control - -RIP can be configured to send either Version 1 or Version 2 packets. -The default is to send RIPv2 while accepting both RIPv1 and RIPv2 (and -replying with packets of the appropriate version for REQUESTS / -triggered updates). The version to receive and send can be specified -globally, and further overriden on a per-interface basis if needs be -for send and receive seperately (see below). - -It is important to note that RIPv1 can not be authenticated. Further, -if RIPv1 is enabled then RIP will reply to REQUEST packets, sending the -state of its RIP routing table to any remote routers that ask on -demand. For a more detailed discussion on the security implications of -RIPv1 see @ref{RIP Authentication}. - -@deffn {RIP Command} {version @var{version}} {} -Set RIP version to accept for reads and send. @var{version} -can be either `1'' or `2''. - -Disabling RIPv1 by specifying version 2 is STRONGLY encouraged, -@xref{RIP Authentication}. This may become the default in a future -release. - -Default: Send Version 2, and accept either version. -@end deffn - -@deffn {RIP Command} {no version} {} -Reset the global version setting back to the default. -@end deffn - -@deffn {Interface command} {ip rip send version @var{version}} {} -@var{version} can be `1', `2' or `1 2'. - -This interface command overrides the global rip version setting, and -selects which version of RIP to send packets with, for this interface -specifically. Choice of RIP Version 1, RIP Version 2, or both versions. -In the latter case, where `1 2' is specified, packets will be both -broadcast and multicast. - -Default: Send packets according to the global version (version 2) -@end deffn - -@deffn {Interface command} {ip rip receive version @var{version}} {} -@var{version} can be `1', `2' or `1 2'. - -This interface command overrides the global rip version setting, and -selects which versions of RIP packets will be accepted on this -interface. Choice of RIP Version 1, RIP Version 2, or both. - -Default: Accept packets according to the global setting (both 1 and 2). -@end deffn - -@node How to Announce RIP route -@section How to Announce RIP route - -@deffn {RIP command} {redistribute kernel} {} -@deffnx {RIP command} {redistribute kernel metric <0-16>} {} -@deffnx {RIP command} {redistribute kernel route-map @var{route-map}} {} -@deffnx {RIP command} {no redistribute kernel} {} -@code{redistribute kernel} redistributes routing information from -kernel route entries into the RIP tables. @code{no redistribute kernel} -disables the routes. -@end deffn - -@deffn {RIP command} {redistribute static} {} -@deffnx {RIP command} {redistribute static metric <0-16>} {} -@deffnx {RIP command} {redistribute static route-map @var{route-map}} {} -@deffnx {RIP command} {no redistribute static} {} -@code{redistribute static} redistributes routing information from -static route entries into the RIP tables. @code{no redistribute static} -disables the routes. -@end deffn - -@deffn {RIP command} {redistribute connected} {} -@deffnx {RIP command} {redistribute connected metric <0-16>} {} -@deffnx {RIP command} {redistribute connected route-map @var{route-map}} {} -@deffnx {RIP command} {no redistribute connected} {} -Redistribute connected routes into the RIP tables. @code{no -redistribute connected} disables the connected routes in the RIP tables. -This command redistribute connected of the interface which RIP disabled. -The connected route on RIP enabled interface is announced by default. -@end deffn - -@deffn {RIP command} {redistribute ospf} {} -@deffnx {RIP command} {redistribute ospf metric <0-16>} {} -@deffnx {RIP command} {redistribute ospf route-map @var{route-map}} {} -@deffnx {RIP command} {no redistribute ospf} {} -@code{redistribute ospf} redistributes routing information from -ospf route entries into the RIP tables. @code{no redistribute ospf} -disables the routes. -@end deffn - -@deffn {RIP command} {redistribute bgp} {} -@deffnx {RIP command} {redistribute bgp metric <0-16>} {} -@deffnx {RIP command} {redistribute bgp route-map @var{route-map}} {} -@deffnx {RIP command} {no redistribute bgp} {} -@code{redistribute bgp} redistributes routing information from -bgp route entries into the RIP tables. @code{no redistribute bgp} -disables the routes. -@end deffn - -If you want to specify RIP only static routes: - -@deffn {RIP command} {default-information originate} {} -@end deffn - -@deffn {RIP command} {route @var{a.b.c.d/m}} {} -@deffnx {RIP command} {no route @var{a.b.c.d/m}} {} -This command is specific to Frr. The @code{route} command makes a static -route only inside RIP. This command should be used only by advanced -users who are particularly knowledgeable about the RIP protocol. In -most cases, we recommend creating a static route in Frr and -redistributing it in RIP using @code{redistribute static}. -@end deffn - -@node Filtering RIP Routes -@section Filtering RIP Routes - -RIP routes can be filtered by a distribute-list. - -@deffn Command {distribute-list @var{access_list} @var{direct} @var{ifname}} {} -You can apply access lists to the interface with a @code{distribute-list} -command. @var{access_list} is the access list name. @var{direct} is -@samp{in} or @samp{out}. If @var{direct} is @samp{in} the access list -is applied to input packets. - -The @code{distribute-list} command can be used to filter the RIP path. -@code{distribute-list} can apply access-lists to a chosen interface. -First, one should specify the access-list. Next, the name of the -access-list is used in the distribute-list command. For example, in the -following configuration @samp{eth0} will permit only the paths that -match the route 10.0.0.0/8 - -@example -@group -! -router rip - distribute-list private in eth0 -! -access-list private permit 10 10.0.0.0/8 -access-list private deny any -! -@end group -@end example -@end deffn - -@code{distribute-list} can be applied to both incoming and outgoing data. - -@deffn Command {distribute-list prefix @var{prefix_list} (in|out) @var{ifname}} {} -You can apply prefix lists to the interface with a -@code{distribute-list} command. @var{prefix_list} is the prefix list -name. Next is the direction of @samp{in} or @samp{out}. If -@var{direct} is @samp{in} the access list is applied to input packets. -@end deffn - -@node RIP Metric Manipulation -@section RIP Metric Manipulation - -RIP metric is a value for distance for the network. Usually -@command{ripd} increment the metric when the network information is -received. Redistributed routes' metric is set to 1. - -@deffn {RIP command} {default-metric <1-16>} {} -@deffnx {RIP command} {no default-metric <1-16>} {} -This command modifies the default metric value for redistributed routes. The -default value is 1. This command does not affect connected route -even if it is redistributed by @command{redistribute connected}. To modify -connected route's metric value, please use @command{redistribute -connected metric} or @command{route-map}. @command{offset-list} also -affects connected routes. -@end deffn - -@deffn {RIP command} {offset-list @var{access-list} (in|out)} {} -@deffnx {RIP command} {offset-list @var{access-list} (in|out) @var{ifname}} {} -@end deffn - -@node RIP distance -@section RIP distance - -Distance value is used in zebra daemon. Default RIP distance is 120. - -@deffn {RIP command} {distance <1-255>} {} -@deffnx {RIP command} {no distance <1-255>} {} -Set default RIP distance to specified value. -@end deffn - -@deffn {RIP command} {distance <1-255> @var{A.B.C.D/M}} {} -@deffnx {RIP command} {no distance <1-255> @var{A.B.C.D/M}} {} -Set default RIP distance to specified value when the route's source IP -address matches the specified prefix. -@end deffn - -@deffn {RIP command} {distance <1-255> @var{A.B.C.D/M} @var{access-list}} {} -@deffnx {RIP command} {no distance <1-255> @var{A.B.C.D/M} @var{access-list}} {} -Set default RIP distance to specified value when the route's source IP -address matches the specified prefix and the specified access-list. -@end deffn - -@node RIP route-map -@section RIP route-map - -Usage of @command{ripd}'s route-map support. - -Optional argument route-map MAP_NAME can be added to each @code{redistribute} -statement. - -@example -redistribute static [route-map MAP_NAME] -redistribute connected [route-map MAP_NAME] -..... -@end example - -Cisco applies route-map _before_ routes will exported to rip route table. -In current Frr's test implementation, @command{ripd} applies route-map -after routes are listed in the route table and before routes will be -announced to an interface (something like output filter). I think it is not -so clear, but it is draft and it may be changed at future. - -Route-map statement (@pxref{Route Map}) is needed to use route-map -functionality. - -@deffn {Route Map} {match interface @var{word}} {} -This command match to incoming interface. Notation of this match is -different from Cisco. Cisco uses a list of interfaces - NAME1 NAME2 -... NAMEN. Ripd allows only one name (maybe will change in the -future). Next - Cisco means interface which includes next-hop of -routes (it is somewhat similar to "ip next-hop" statement). Ripd -means interface where this route will be sent. This difference is -because "next-hop" of same routes which sends to different interfaces -must be different. Maybe it'd be better to made new matches - say -"match interface-out NAME" or something like that. -@end deffn - -@deffn {Route Map} {match ip address @var{word}} {} -@deffnx {Route Map} {match ip address prefix-list @var{word}} {} -Match if route destination is permitted by access-list. -@end deffn - -@deffn {Route Map} {match ip next-hop @var{word}} {} -@deffnx {Route Map} {match ip next-hop prefix-list @var{word}} {} -Match if route next-hop (meaning next-hop listed in the rip route-table -as displayed by "show ip rip") is permitted by access-list. -@end deffn - -@deffn {Route Map} {match metric <0-4294967295>} {} -This command match to the metric value of RIP updates. For other -protocol compatibility metric range is shown as <0-4294967295>. But -for RIP protocol only the value range <0-16> make sense. -@end deffn - -@deffn {Route Map} {set ip next-hop A.B.C.D} {} -This command set next hop value in RIPv2 protocol. This command does -not affect RIPv1 because there is no next hop field in the packet. -@end deffn - -@deffn {Route Map} {set metric <0-4294967295>} {} -Set a metric for matched route when sending announcement. The metric -value range is very large for compatibility with other protocols. For -RIP, valid metric values are from 1 to 16. -@end deffn - -@node RIP Authentication -@section RIP Authentication - -RIPv2 allows packets to be authenticated via either an insecure plain -text password, included with the packet, or via a more secure MD5 based -@acronym{HMAC, keyed-Hashing for Message AuthentiCation}, -RIPv1 can not be authenticated at all, thus when authentication is -configured @code{ripd} will discard routing updates received via RIPv1 -packets. - -However, unless RIPv1 reception is disabled entirely, -@xref{RIP Version Control}, RIPv1 REQUEST packets which are received, -which query the router for routing information, will still be honoured -by @code{ripd}, and @code{ripd} WILL reply to such packets. This allows -@code{ripd} to honour such REQUESTs (which sometimes is used by old -equipment and very simple devices to bootstrap their default route), -while still providing security for route updates which are received. - -In short: Enabling authentication prevents routes being updated by -unauthenticated remote routers, but still can allow routes (I.e. the -entire RIP routing table) to be queried remotely, potentially by anyone -on the internet, via RIPv1. - -To prevent such unauthenticated querying of routes disable RIPv1, -@xref{RIP Version Control}. - -@deffn {Interface command} {ip rip authentication mode md5} {} -@deffnx {Interface command} {no ip rip authentication mode md5} {} -Set the interface with RIPv2 MD5 authentication. -@end deffn - -@deffn {Interface command} {ip rip authentication mode text} {} -@deffnx {Interface command} {no ip rip authentication mode text} {} -Set the interface with RIPv2 simple password authentication. -@end deffn - -@deffn {Interface command} {ip rip authentication string @var{string}} {} -@deffnx {Interface command} {no ip rip authentication string @var{string}} {} -RIP version 2 has simple text authentication. This command sets -authentication string. The string must be shorter than 16 characters. -@end deffn - -@deffn {Interface command} {ip rip authentication key-chain @var{key-chain}} {} -@deffnx {Interface command} {no ip rip authentication key-chain @var{key-chain}} {} -Specifiy Keyed MD5 chain. -@end deffn - -@example -! -key chain test - key 1 - key-string test -! -interface eth1 - ip rip authentication mode md5 - ip rip authentication key-chain test -! -@end example - -@node RIP Timers -@section RIP Timers - -@deffn {RIP command} {timers basic @var{update} @var{timeout} @var{garbage}} {} - -RIP protocol has several timers. User can configure those timers' values -by @code{timers basic} command. - -The default settings for the timers are as follows: - -@itemize @bullet -@item -The update timer is 30 seconds. Every update timer seconds, the RIP -process is awakened to send an unsolicited Response message containing -the complete routing table to all neighboring RIP routers. - -@item -The timeout timer is 180 seconds. Upon expiration of the timeout, the -route is no longer valid; however, it is retained in the routing table -for a short time so that neighbors can be notified that the route has -been dropped. - -@item -The garbage collect timer is 120 seconds. Upon expiration of the -garbage-collection timer, the route is finally removed from the routing -table. - -@end itemize - -The @code{timers basic} command allows the the default values of the timers -listed above to be changed. -@end deffn - -@deffn {RIP command} {no timers basic} {} -The @code{no timers basic} command will reset the timers to the default -settings listed above. -@end deffn - -@node Show RIP Information -@section Show RIP Information - -To display RIP routes. - -@deffn Command {show ip rip} {} -Show RIP routes. -@end deffn - -The command displays all RIP routes. For routes that are received -through RIP, this command will display the time the packet was sent and -the tag information. This command will also display this information -for routes redistributed into RIP. - -@c Exmaple here. - -@deffn Command {show ip rip status} {} -The command displays current RIP status. It includes RIP timer, -filtering, version, RIP enabled interface and RIP peer inforation. -@end deffn - -@example -@group -ripd> @b{show ip rip status} -Routing Protocol is "rip" - Sending updates every 30 seconds with +/-50%, next due in 35 seconds - Timeout after 180 seconds, garbage collect after 120 seconds - Outgoing update filter list for all interface is not set - Incoming update filter list for all interface is not set - Default redistribution metric is 1 - Redistributing: kernel connected - Default version control: send version 2, receive version 2 - Interface Send Recv - Routing for Networks: - eth0 - eth1 - 1.1.1.1 - 203.181.89.241 - Routing Information Sources: - Gateway BadPackets BadRoutes Distance Last Update -@end group -@end example - -@node RIP Debug Commands -@section RIP Debug Commands - -Debug for RIP protocol. - -@deffn Command {debug rip events} {} -Debug rip events. -@end deffn - -@code{debug rip} will show RIP events. Sending and receiving -packets, timers, and changes in interfaces are events shown with @command{ripd}. - -@deffn Command {debug rip packet} {} -Debug rip packet. -@end deffn - -@code{debug rip packet} will display detailed information about the RIP -packets. The origin and port number of the packet as well as a packet -dump is shown. - -@deffn Command {debug rip zebra} {} -Debug rip between zebra communication. -@end deffn - -This command will show the communication between @command{ripd} and -@command{zebra}. The main information will include addition and deletion of -paths to the kernel and the sending and receiving of interface information. - -@deffn Command {show debugging rip} {} -Display @command{ripd}'s debugging option. -@end deffn - -@code{show debugging rip} will show all information currently set for ripd -debug. diff --git a/doc/ripngd.texi b/doc/ripngd.texi deleted file mode 100644 index 1adda69433..0000000000 --- a/doc/ripngd.texi +++ /dev/null @@ -1,84 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@node RIPng -@chapter RIPng - -@command{ripngd} supports the RIPng protocol as described in RFC2080. It's an -IPv6 reincarnation of the RIP protocol. - -@menu -* Invoking ripngd:: -* ripngd Configuration:: -* ripngd Terminal Mode Commands:: -* ripngd Filtering Commands:: -@end menu - -@node Invoking ripngd -@section Invoking ripngd - -There are no @code{ripngd} specific invocation options. Common options -can be specified (@pxref{Common Invocation Options}). - -@node ripngd Configuration -@section ripngd Configuration - -Currently ripngd supports the following commands: - -@deffn Command {router ripng} {} -Enable RIPng. -@end deffn - -@deffn {RIPng Command} {flush_timer @var{time}} {} -Set flush timer. -@end deffn - -@deffn {RIPng Command} {network @var{network}} {} -Set RIPng enabled interface by @var{network} -@end deffn - -@deffn {RIPng Command} {network @var{ifname}} {} -Set RIPng enabled interface by @var{ifname} -@end deffn - -@deffn {RIPng Command} {route @var{network}} {} -Set RIPng static routing announcement of @var{network}. -@end deffn - -@deffn Command {router zebra} {} -This command is the default and does not appear in the configuration. -With this statement, RIPng routes go to the @command{zebra} daemon. -@end deffn - -@node ripngd Terminal Mode Commands -@section ripngd Terminal Mode Commands - -@deffn Command {show ip ripng} {} -@end deffn - -@deffn Command {show debugging ripng} {} -@end deffn - -@deffn Command {debug ripng events} {} -@end deffn - -@deffn Command {debug ripng packet} {} -@end deffn - -@deffn Command {debug ripng zebra} {} -@end deffn - -@node ripngd Filtering Commands -@section ripngd Filtering Commands - -@deffn Command {distribute-list @var{access_list} (in|out) @var{ifname}} {} -You can apply an access-list to the interface using the -@code{distribute-list} command. @var{access_list} is an access-list -name. @var{direct} is @samp{in} or @samp{out}. If @var{direct} is -@samp{in}, the access-list is applied only to incoming packets. - -@example -distribute-list local-only out sit1 -@end example -@end deffn diff --git a/doc/routemap.texi b/doc/routemap.texi deleted file mode 100644 index b72f539c46..0000000000 --- a/doc/routemap.texi +++ /dev/null @@ -1,272 +0,0 @@ -@node Route Map -@chapter Route Map - -Route maps provide a means to both filter and/or apply actions to -route, hence allowing policy to be applied to routes. - -@menu -* Route Map Command:: -* Route Map Match Command:: -* Route Map Set Command:: -* Route Map Call Command:: -* Route Map Exit Action Command:: -* Route Map Examples:: -@end menu - -Route-maps are an ordered list of route-map entries. Each entry may -specify up to four distincts sets of clauses: - -@table @samp -@item Matching Policy - -This specifies the policy implied if the @samp{Matching Conditions} are -met or not met, and which actions of the route-map are to be taken, if -any. The two possibilities are: - -@itemize @minus -@item -@samp{permit}: If the entry matches, then carry out the @samp{Set -Actions}. Then finish processing the route-map, permitting the route, -unless an @samp{Exit Action} indicates otherwise. - -@item -@samp{deny}: If the entry matches, then finish processing the route-map and -deny the route (return @samp{deny}). -@end itemize - -The @samp{Matching Policy} is specified as part of the command which -defines the ordered entry in the route-map. See below. - -@item Matching Conditions - -A route-map entry may, optionally, specify one or more conditions which -must be matched if the entry is to be considered further, as governed -by the Match Policy. If a route-map entry does not explicitely specify -any matching conditions, then it always matches. - -@item Set Actions - -A route-map entry may, optionally, specify one or more @samp{Set -Actions} to set or modify attributes of the route. - -@item Call Action - -Call to another route-map, after any @samp{Set Actions} have been -carried out. If the route-map called returns @samp{deny} then -processing of the route-map finishes and the route is denied, -regardless of the @samp{Matching Policy} or the @samp{Exit Policy}. If -the called route-map returns @samp{permit}, then @samp{Matching Policy} -and @samp{Exit Policy} govern further behaviour, as normal. - -@item Exit Policy - -An entry may, optionally, specify an alternative @samp{Exit Policy} to -take if the entry matched, rather than the normal policy of exiting the -route-map and permitting the route. The two possibilities are: - -@itemize @minus -@item -@samp{next}: Continue on with processing of the route-map entries. - -@item -@samp{goto N}: Jump ahead to the first route-map entry whose order in -the route-map is >= N. Jumping to a previous entry is not permitted. -@end itemize -@end table - -The default action of a route-map, if no entries match, is to deny. -I.e. a route-map essentially has as its last entry an empty @samp{deny} -entry, which matches all routes. To change this behaviour, one must -specify an empty @samp{permit} entry as the last entry in the route-map. - -To summarise the above: - -@multitable {permit} {action} {No Match} -@headitem @tab Match @tab No Match -@item @emph{Permit} @tab action @tab cont -@item @emph{Deny} @tab deny @tab cont -@end multitable - -@table @samp - -@item action -@itemize @minus -@item -Apply @emph{set} statements - -@item -If @emph{call} is present, call given route-map. If that returns a @samp{deny}, finish -processing and return @samp{deny}. - -@item -If @samp{Exit Policy} is @emph{next}, goto next route-map entry - -@item -If @samp{Exit Policy} is @emph{goto}, goto first entry whose order in the list -is >= the given order. - -@item -Finish processing the route-map and permit the route. -@end itemize - -@item deny -@itemize @minus -@item -The route is denied by the route-map (return @samp{deny}). -@end itemize - -@item cont -@itemize @minus -@item -goto next route-map entry -@end itemize -@end table - -@node Route Map Command -@section Route Map Command - -@deffn {Command} {route-map @var{route-map-name} (permit|deny) @var{order}} {} - -Configure the @var{order}'th entry in @var{route-map-name} with -@samp{Match Policy} of either @emph{permit} or @emph{deny}. - -@end deffn - -@node Route Map Match Command -@section Route Map Match Command - -@deffn {Route-map Command} {match ip address @var{access_list}} {} -Matches the specified @var{access_list} -@end deffn - -@deffn {Route-map Command} {match ip address @var{prefix-list}} {} -Matches the specified @var{prefix-list} -@end deffn - -@deffn {Route-map Command} {match ip address prefix-len @var{0-32}} {} -Matches the specified @var{prefix-len}. This is a Zebra specific command. -@end deffn - -@deffn {Route-map Command} {match ipv6 address @var{access_list}} {} -Matches the specified @var{access_list} -@end deffn - -@deffn {Route-map Command} {match ipv6 address @var{prefix-list}} {} -Matches the specified @var{prefix-list} -@end deffn - -@deffn {Route-map Command} {match ipv6 address prefix-len @var{0-128}} {} -Matches the specified @var{prefix-len}. This is a Zebra specific command. -@end deffn - -@deffn {Route-map Command} {match ip next-hop @var{ipv4_addr}} {} -Matches the specified @var{ipv4_addr}. -@end deffn - -@deffn {Route-map Command} {match aspath @var{as_path}} {} -Matches the specified @var{as_path}. -@end deffn - -@deffn {Route-map Command} {match metric @var{metric}} {} -Matches the specified @var{metric}. -@end deffn - -@deffn {Route-map Command} {match local-preference @var{metric}} {} -Matches the specified @var{local-preference}. -@end deffn - -@deffn {Route-map Command} {match community @var{community_list}} {} -Matches the specified @var{community_list} -@end deffn - -@deffn {Route-map Command} {match peer @var{ipv4_addr}} {} -This is a BGP specific match command. Matches the peer ip address -if the neighbor was specified in this manner. -@end deffn - -@deffn {Route-map Command} {match peer @var{ipv6_addr}} {} -This is a BGP specific match command. Matches the peer ipv6 -address if the neighbor was specified in this manner. -@end deffn - -@deffn {Route-map Command} {match peer @var{interface_name}} {} -This is a BGP specific match command. Matches the peer -interface name specified if the neighbor was specified -in this manner. -@end deffn - -@node Route Map Set Command -@section Route Map Set Command - -@deffn {Route-map Command} {set ip next-hop @var{ipv4_address}} {} -Set the BGP nexthop address. -@end deffn - -@deffn {Route-map Command} {set local-preference @var{local_pref}} {} -Set the BGP local preference to @var{local_pref}. -@end deffn - -@deffn {Route-map Command} {set weight @var{weight}} {} -Set the route's weight. -@end deffn - -@deffn {Route-map Command} {set metric @var{metric}} {} -@anchor{routemap set metric} -Set the BGP attribute MED. -@end deffn - -@deffn {Route-map Command} {set as-path prepend @var{as_path}} {} -Set the BGP AS path to prepend. -@end deffn - -@deffn {Route-map Command} {set community @var{community}} {} -Set the BGP community attribute. -@end deffn - -@deffn {Route-map Command} {set ipv6 next-hop global @var{ipv6_address}} {} -Set the BGP-4+ global IPv6 nexthop address. -@end deffn - -@deffn {Route-map Command} {set ipv6 next-hop local @var{ipv6_address}} {} -Set the BGP-4+ link local IPv6 nexthop address. -@end deffn - -@node Route Map Call Command -@section Route Map Call Command - -@deffn {Route-map Command} {call @var{name}} {} -Call route-map @var{name}. If it returns deny, deny the route and -finish processing the route-map. -@end deffn - -@node Route Map Exit Action Command -@section Route Map Exit Action Command - -@deffn {Route-map Command} {on-match next} {} -@deffnx {Route-map Command} {continue} {} -Proceed on to the next entry in the route-map. -@end deffn - -@deffn {Route-map Command} {on-match goto @var{N}} {} -@deffnx {Route-map Command} {continue @var{N}} {} -Proceed processing the route-map at the first entry whose order is >= N -@end deffn - -@node Route Map Examples -@section Route Map Examples - -A simple example of a route-map: - -@example -@group -route-map test permit 10 - match ip address 10 - set local-preference 200 -@end group -@end example - -This means that if a route matches ip access-list number 10 it's -local-preference value is set to 200. - -See @ref{BGP Configuration Examples} for examples of more sophisticated -useage of route-maps, including of the @samp{call} action. diff --git a/doc/routeserver.texi b/doc/routeserver.texi deleted file mode 100644 index b25800107d..0000000000 --- a/doc/routeserver.texi +++ /dev/null @@ -1,561 +0,0 @@ -@c -*-texinfo-*- -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@c -@c This file is a modified version of Jose Luis Rubio's TeX sources -@c of his RS-Manual document - -@node Configuring Frr as a Route Server -@chapter Configuring Frr as a Route Server - -The purpose of a Route Server is to centralize the peerings between BGP -speakers. For example if we have an exchange point scenario with four BGP -speakers, each of which maintaining a BGP peering with the other three -(@pxref{fig:full-mesh}), we can convert it into a centralized scenario where -each of the four establishes a single BGP peering against the Route Server -(@pxref{fig:route-server}). - -We will first describe briefly the Route Server model implemented by Frr. -We will explain the commands that have been added for configuring that -model. And finally we will show a full example of Frr configured as Route -Server. - -@menu -* Description of the Route Server model:: -* Commands for configuring a Route Server:: -* Example of Route Server Configuration:: -@end menu - -@node Description of the Route Server model -@section Description of the Route Server model - -First we are going to describe the normal processing that BGP announcements -suffer inside a standard BGP speaker, as shown in @ref{fig:normal-processing}, -it consists of three steps: - -@itemize @bullet -@item -When an announcement is received from some peer, the `In' filters -configured for that peer are applied to the announcement. These filters can -reject the announcement, accept it unmodified, or accept it with some of its -attributes modified. - -@item -The announcements that pass the `In' filters go into the -Best Path Selection process, where they are compared to other -announcements referred to the same destination that have been -received from different peers (in case such other -announcements exist). For each different destination, the announcement -which is selected as the best is inserted into the BGP speaker's Loc-RIB. - -@item -The routes which are inserted in the Loc-RIB are -considered for announcement to all the peers (except the one -from which the route came). This is done by passing the routes -in the Loc-RIB through the `Out' filters corresponding to each -peer. These filters can reject the route, -accept it unmodified, or accept it with some of its attributes -modified. Those routes which are accepted by the `Out' filters -of a peer are announced to that peer. -@end itemize - -@float Figure,fig:normal-processing -@image{fig-normal-processing,400pt,,Normal announcement processing} -@caption{Announcement processing inside a ``normal'' BGP speaker} -@end float - -@float Figure,fig:full-mesh -@image{fig_topologies_full,120pt,,Full Mesh BGP Topology} -@caption{Full Mesh} -@end float - -@float Figure,fig:route-server -@image{fig_topologies_rs,120pt,,Route Server BGP Topology} -@caption{Route Server and clients} -@end float - -Of course we want that the routing tables obtained in each of the routers -are the same when using the route server than when not. But as a consequence -of having a single BGP peering (against the route server), the BGP speakers -can no longer distinguish from/to which peer each announce comes/goes. -@anchor{filter-delegation}This means that the routers connected to the route -server are not able to apply by themselves the same input/output filters -as in the full mesh scenario, so they have to delegate those functions to -the route server. - -Even more, the ``best path'' selection must be also performed inside -the route server on behalf of its clients. The reason is that if, after -applying the filters of the announcer and the (potential) receiver, the -route server decides to send to some client two or more different -announcements referred to the same destination, the client will only -retain the last one, considering it as an implicit withdrawal of the -previous announcements for the same destination. This is the expected -behavior of a BGP speaker as defined in @cite{RFC1771}, and even though -there are some proposals of mechanisms that permit multiple paths for -the same destination to be sent through a single BGP peering, none are -currently supported by most existing BGP implementations. - -As a consequence a route server must maintain additional information and -perform additional tasks for a RS-client that those necessary for common BGP -peerings. Essentially a route server must: - -@anchor{Route Server tasks} -@itemize @bullet -@item -Maintain a separated Routing Information Base (Loc-RIB) -for each peer configured as RS-client, containing the routes -selected as a result of the ``Best Path Selection'' process -that is performed on behalf of that RS-client. - -@item -Whenever it receives an announcement from a RS-client, -it must consider it for the Loc-RIBs of the other RS-clients. - -@anchor{Route-server path filter process} -@itemize @bullet -@item -This means that for each of them the route server must pass the -announcement through the appropriate `Out' filter of the -announcer. - -@item -Then through the appropriate `In' filter of -the potential receiver. - -@item -Only if the announcement is accepted by both filters it will be passed -to the ``Best Path Selection'' process. - -@item -Finally, it might go into the Loc-RIB of the receiver. -@end itemize -@end itemize - -When we talk about the ``appropriate'' filter, both the announcer and the -receiver of the route must be taken into account. Suppose that the route -server receives an announcement from client A, and the route server is -considering it for the Loc-RIB of client B. The filters that should be -applied are the same that would be used in the full mesh scenario, i.e., -first the `Out' filter of router A for announcements going to router B, and -then the `In' filter of router B for announcements coming from router A. - -We call ``Export Policy'' of a RS-client to the set of `Out' filters that -the client would use if there was no route server. The same applies for the -``Import Policy'' of a RS-client and the set of `In' filters of the client -if there was no route server. - -It is also common to demand from a route server that it does not -modify some BGP attributes (next-hop, as-path and MED) that are usually -modified by standard BGP speakers before announcing a route. - -The announcement processing model implemented by Frr is shown in -@ref{fig:rs-processing}. The figure shows a mixture of RS-clients (B, C and D) -with normal BGP peers (A). There are some details that worth additional -comments: - -@itemize @bullet -@item -Announcements coming from a normal BGP peer are also -considered for the Loc-RIBs of all the RS-clients. But -logically they do not pass through any export policy. - -@item -Those peers that are configured as RS-clients do not -receive any announce from the `Main' Loc-RIB. - -@item -Apart from import and export policies, -`In' and `Out' filters can also be set for RS-clients. `In' -filters might be useful when the route server has also normal -BGP peers. On the other hand, `Out' filters for RS-clients are -probably unnecessary, but we decided not to remove them as -they do not hurt anybody (they can always be left empty). -@end itemize - -@float Figure,fig:rs-processing -@image{fig-rs-processing,450pt,,Route Server Processing Model} -@caption{Announcement processing model implemented by the Route Server} -@end float - -@node Commands for configuring a Route Server -@section Commands for configuring a Route Server - -Now we will describe the commands that have been added to frr -in order to support the route server features. - -@deffn {Route-Server} {neighbor @var{peer-group} route-server-client} {} -@deffnx {Route-Server} {neighbor @var{A.B.C.D} route-server-client} {} -@deffnx {Route-Server} {neighbor @var{X:X::X:X} route-server-client} {} -This command configures the peer given by @var{peer}, @var{A.B.C.D} or -@var{X:X::X:X} as an RS-client. - -Actually this command is not new, it already existed in standard Frr. It -enables the transparent mode for the specified peer. This means that some -BGP attributes (as-path, next-hop and MED) of the routes announced to that -peer are not modified. - -With the route server patch, this command, apart from setting the -transparent mode, creates a new Loc-RIB dedicated to the specified peer -(those named `Loc-RIB for X' in @ref{fig:rs-processing}.). Starting from -that moment, every announcement received by the route server will be also -considered for the new Loc-RIB. -@end deffn - -@deffn {Route-Server} {neigbor @{A.B.C.D|X.X::X.X|peer-group@} route-map WORD @{import|export@}} {} -This set of commands can be used to specify the route-map that -represents the Import or Export policy of a peer which is -configured as a RS-client (with the previous command). -@end deffn - -@deffn {Route-Server} {match peer @{A.B.C.D|X:X::X:X@}} {} -This is a new @emph{match} statement for use in route-maps, enabling them to -describe import/export policies. As we said before, an import/export policy -represents a set of input/output filters of the RS-client. This statement -makes possible that a single route-map represents the full set of filters -that a BGP speaker would use for its different peers in a non-RS scenario. - -The @emph{match peer} statement has different semantics whether it is used -inside an import or an export route-map. In the first case the statement -matches if the address of the peer who sends the announce is the same that -the address specified by @{A.B.C.D|X:X::X:X@}. For export route-maps it -matches when @{A.B.C.D|X:X::X:X@} is the address of the RS-Client into whose -Loc-RIB the announce is going to be inserted (how the same export policy is -applied before different Loc-RIBs is shown in @ref{fig:rs-processing}.). -@end deffn - -@deffn {Route-map Command} {call @var{WORD}} {} -This command (also used inside a route-map) jumps into a different -route-map, whose name is specified by @var{WORD}. When the called -route-map finishes, depending on its result the original route-map -continues or not. Apart from being useful for making import/export -route-maps easier to write, this command can also be used inside -any normal (in or out) route-map. -@end deffn - -@node Example of Route Server Configuration -@section Example of Route Server Configuration - -Finally we are going to show how to configure a Frr daemon to act as a -Route Server. For this purpose we are going to present a scenario without -route server, and then we will show how to use the configurations of the BGP -routers to generate the configuration of the route server. - -All the configuration files shown in this section have been taken -from scenarios which were tested using the VNUML tool -@uref{http://www.dit.upm.es/vnuml,VNUML}. - -@menu -* Configuration of the BGP routers without Route Server:: -* Configuration of the BGP routers with Route Server:: -* Configuration of the Route Server itself:: -* Further considerations about Import and Export route-maps:: -@end menu - -@node Configuration of the BGP routers without Route Server -@subsection Configuration of the BGP routers without Route Server - -We will suppose that our initial scenario is an exchange point with three -BGP capable routers, named RA, RB and RC. Each of the BGP speakers generates -some routes (with the @var{network} command), and establishes BGP peerings -against the other two routers. These peerings have In and Out route-maps -configured, named like ``PEER-X-IN'' or ``PEER-X-OUT''. For example the -configuration file for router RA could be the following: - -@exampleindent 0 -@example -#Configuration for router 'RA' -! -hostname RA -password **** -! -router bgp 65001 - no bgp default ipv4-unicast - neighbor 2001:0DB8::B remote-as 65002 - neighbor 2001:0DB8::C remote-as 65003 -! - address-family ipv6 - network 2001:0DB8:AAAA:1::/64 - network 2001:0DB8:AAAA:2::/64 - network 2001:0DB8:0000:1::/64 - network 2001:0DB8:0000:2::/64 - - neighbor 2001:0DB8::B activate - neighbor 2001:0DB8::B soft-reconfiguration inbound - neighbor 2001:0DB8::B route-map PEER-B-IN in - neighbor 2001:0DB8::B route-map PEER-B-OUT out - - neighbor 2001:0DB8::C activate - neighbor 2001:0DB8::C soft-reconfiguration inbound - neighbor 2001:0DB8::C route-map PEER-C-IN in - neighbor 2001:0DB8::C route-map PEER-C-OUT out - exit-address-family -! -ipv6 prefix-list COMMON-PREFIXES seq 5 permit 2001:0DB8:0000::/48 ge 64 le 64 -ipv6 prefix-list COMMON-PREFIXES seq 10 deny any -! -ipv6 prefix-list PEER-A-PREFIXES seq 5 permit 2001:0DB8:AAAA::/48 ge 64 le 64 -ipv6 prefix-list PEER-A-PREFIXES seq 10 deny any -! -ipv6 prefix-list PEER-B-PREFIXES seq 5 permit 2001:0DB8:BBBB::/48 ge 64 le 64 -ipv6 prefix-list PEER-B-PREFIXES seq 10 deny any -! -ipv6 prefix-list PEER-C-PREFIXES seq 5 permit 2001:0DB8:CCCC::/48 ge 64 le 64 -ipv6 prefix-list PEER-C-PREFIXES seq 10 deny any -! -route-map PEER-B-IN permit 10 - match ipv6 address prefix-list COMMON-PREFIXES - set metric 100 -route-map PEER-B-IN permit 20 - match ipv6 address prefix-list PEER-B-PREFIXES - set community 65001:11111 -! -route-map PEER-C-IN permit 10 - match ipv6 address prefix-list COMMON-PREFIXES - set metric 200 -route-map PEER-C-IN permit 20 - match ipv6 address prefix-list PEER-C-PREFIXES - set community 65001:22222 -! -route-map PEER-B-OUT permit 10 - match ipv6 address prefix-list PEER-A-PREFIXES -! -route-map PEER-C-OUT permit 10 - match ipv6 address prefix-list PEER-A-PREFIXES -! -line vty -! -@end example - -@node Configuration of the BGP routers with Route Server -@subsection Configuration of the BGP routers with Route Server - -To convert the initial scenario into one with route server, first we must -modify the configuration of routers RA, RB and RC. Now they must not peer -between them, but only with the route server. For example, RA's -configuration would turn into: - -@example -# Configuration for router 'RA' -! -hostname RA -password **** -! -router bgp 65001 - no bgp default ipv4-unicast - neighbor 2001:0DB8::FFFF remote-as 65000 -! - address-family ipv6 - network 2001:0DB8:AAAA:1::/64 - network 2001:0DB8:AAAA:2::/64 - network 2001:0DB8:0000:1::/64 - network 2001:0DB8:0000:2::/64 - - neighbor 2001:0DB8::FFFF activate - neighbor 2001:0DB8::FFFF soft-reconfiguration inbound - exit-address-family -! -line vty -! -@end example - -Which is logically much simpler than its initial configuration, as it now -maintains only one BGP peering and all the filters (route-maps) have -disappeared. - -@node Configuration of the Route Server itself -@subsection Configuration of the Route Server itself - -As we said when we described the functions of a route server -(@pxref{Description of the Route Server model}), it is in charge of all the -route filtering. To achieve that, the In and Out filters from the RA, RB and -RC configurations must be converted into Import and Export policies in the -route server. - -This is a fragment of the route server configuration (we only show -the policies for client RA): - -@example -# Configuration for Route Server ('RS') -! -hostname RS -password ix -! -bgp multiple-instance -! -router bgp 65000 view RS - no bgp default ipv4-unicast - neighbor 2001:0DB8::A remote-as 65001 - neighbor 2001:0DB8::B remote-as 65002 - neighbor 2001:0DB8::C remote-as 65003 -! - address-family ipv6 - neighbor 2001:0DB8::A activate - neighbor 2001:0DB8::A route-server-client - neighbor 2001:0DB8::A route-map RSCLIENT-A-IMPORT import - neighbor 2001:0DB8::A route-map RSCLIENT-A-EXPORT export - neighbor 2001:0DB8::A soft-reconfiguration inbound - - neighbor 2001:0DB8::B activate - neighbor 2001:0DB8::B route-server-client - neighbor 2001:0DB8::B route-map RSCLIENT-B-IMPORT import - neighbor 2001:0DB8::B route-map RSCLIENT-B-EXPORT export - neighbor 2001:0DB8::B soft-reconfiguration inbound - - neighbor 2001:0DB8::C activate - neighbor 2001:0DB8::C route-server-client - neighbor 2001:0DB8::C route-map RSCLIENT-C-IMPORT import - neighbor 2001:0DB8::C route-map RSCLIENT-C-EXPORT export - neighbor 2001:0DB8::C soft-reconfiguration inbound - exit-address-family -! -ipv6 prefix-list COMMON-PREFIXES seq 5 permit 2001:0DB8:0000::/48 ge 64 le 64 -ipv6 prefix-list COMMON-PREFIXES seq 10 deny any -! -ipv6 prefix-list PEER-A-PREFIXES seq 5 permit 2001:0DB8:AAAA::/48 ge 64 le 64 -ipv6 prefix-list PEER-A-PREFIXES seq 10 deny any -! -ipv6 prefix-list PEER-B-PREFIXES seq 5 permit 2001:0DB8:BBBB::/48 ge 64 le 64 -ipv6 prefix-list PEER-B-PREFIXES seq 10 deny any -! -ipv6 prefix-list PEER-C-PREFIXES seq 5 permit 2001:0DB8:CCCC::/48 ge 64 le 64 -ipv6 prefix-list PEER-C-PREFIXES seq 10 deny any -! -route-map RSCLIENT-A-IMPORT permit 10 - match peer 2001:0DB8::B - call A-IMPORT-FROM-B -route-map RSCLIENT-A-IMPORT permit 20 - match peer 2001:0DB8::C - call A-IMPORT-FROM-C -! -route-map A-IMPORT-FROM-B permit 10 - match ipv6 address prefix-list COMMON-PREFIXES - set metric 100 -route-map A-IMPORT-FROM-B permit 20 - match ipv6 address prefix-list PEER-B-PREFIXES - set community 65001:11111 -! -route-map A-IMPORT-FROM-C permit 10 - match ipv6 address prefix-list COMMON-PREFIXES - set metric 200 -route-map A-IMPORT-FROM-C permit 20 - match ipv6 address prefix-list PEER-C-PREFIXES - set community 65001:22222 -! -route-map RSCLIENT-A-EXPORT permit 10 - match peer 2001:0DB8::B - match ipv6 address prefix-list PEER-A-PREFIXES -route-map RSCLIENT-A-EXPORT permit 20 - match peer 2001:0DB8::C - match ipv6 address prefix-list PEER-A-PREFIXES -! -... -... -... -@end example - -If you compare the initial configuration of RA with the route server -configuration above, you can see how easy it is to generate the Import and -Export policies for RA from the In and Out route-maps of RA's original -configuration. - -When there was no route server, RA maintained two peerings, one with RB and -another with RC. Each of this peerings had an In route-map configured. To -build the Import route-map for client RA in the route server, simply add -route-map entries following this scheme: - -@example -route-map permit 10 - match peer - call -route-map permit 20 - match peer - call -@end example - -This is exactly the process that has been followed to generate the route-map -RSCLIENT-A-IMPORT. The route-maps that are called inside it (A-IMPORT-FROM-B -and A-IMPORT-FROM-C) are exactly the same than the In route-maps from the -original configuration of RA (PEER-B-IN and PEER-C-IN), only the name is -different. - -The same could have been done to create the Export policy for RA (route-map -RSCLIENT-A-EXPORT), but in this case the original Out route-maps where so -simple that we decided not to use the @var{call WORD} commands, and we -integrated all in a single route-map (RSCLIENT-A-EXPORT). - -The Import and Export policies for RB and RC are not shown, but -the process would be identical. - -@node Further considerations about Import and Export route-maps -@subsection Further considerations about Import and Export route-maps - -The current version of the route server patch only allows to specify a -route-map for import and export policies, while in a standard BGP speaker -apart from route-maps there are other tools for performing input and output -filtering (access-lists, community-lists, ...). But this does not represent -any limitation, as all kinds of filters can be included in import/export -route-maps. For example suppose that in the non-route-server scenario peer -RA had the following filters configured for input from peer B: - -@example - neighbor 2001:0DB8::B prefix-list LIST-1 in - neighbor 2001:0DB8::B filter-list LIST-2 in - neighbor 2001:0DB8::B route-map PEER-B-IN in - ... - ... -route-map PEER-B-IN permit 10 - match ipv6 address prefix-list COMMON-PREFIXES - set local-preference 100 -route-map PEER-B-IN permit 20 - match ipv6 address prefix-list PEER-B-PREFIXES - set community 65001:11111 -@end example - -It is posible to write a single route-map which is equivalent to -the three filters (the community-list, the prefix-list and the -route-map). That route-map can then be used inside the Import -policy in the route server. Lets see how to do it: - -@example - neighbor 2001:0DB8::A route-map RSCLIENT-A-IMPORT import - ... -! -... -route-map RSCLIENT-A-IMPORT permit 10 - match peer 2001:0DB8::B - call A-IMPORT-FROM-B -... -... -! -route-map A-IMPORT-FROM-B permit 1 - match ipv6 address prefix-list LIST-1 - match as-path LIST-2 - on-match goto 10 -route-map A-IMPORT-FROM-B deny 2 -route-map A-IMPORT-FROM-B permit 10 - match ipv6 address prefix-list COMMON-PREFIXES - set local-preference 100 -route-map A-IMPORT-FROM-B permit 20 - match ipv6 address prefix-list PEER-B-PREFIXES - set community 65001:11111 -! -... -... -@end example - -The route-map A-IMPORT-FROM-B is equivalent to the three filters -(LIST-1, LIST-2 and PEER-B-IN). The first entry of route-map -A-IMPORT-FROM-B (sequence number 1) matches if and only if both -the prefix-list LIST-1 and the filter-list LIST-2 match. If that -happens, due to the ``on-match goto 10'' statement the next -route-map entry to be processed will be number 10, and as of that -point route-map A-IMPORT-FROM-B is identical to PEER-B-IN. If -the first entry does not match, `on-match goto 10'' will be -ignored and the next processed entry will be number 2, which will -deny the route. - -Thus, the result is the same that with the three original filters, -i.e., if either LIST-1 or LIST-2 rejects the route, it does not -reach the route-map PEER-B-IN. In case both LIST-1 and LIST-2 -accept the route, it passes to PEER-B-IN, which can reject, accept -or modify the route. diff --git a/doc/rpki.texi b/doc/rpki.texi deleted file mode 100644 index c1c8a8aa54..0000000000 --- a/doc/rpki.texi +++ /dev/null @@ -1,256 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the FRR Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@node Prefix Origin Validation Using RPKI -@section Prefix Origin Validation Using RPKI - -Prefix Origin Validation allows BGP routers to verify if the origin AS of -an IP prefix is legitimate to announce this IP prefix. The required -attestation objects are stored in the Resource Public Key Infrastructure -(@acronym{RPKI}). However, RPKI-enabled routers do not store cryptographic -data itself but only validation information. The validation of the -cryptographic data (so called Route Origin Authorization, or short -@acronym{ROA}, objects) will be performed by trusted cache servers. The -RPKI/RTR protocol defines a standard mechanism to maintain the exchange of -the prefix/origin AS mapping between the cache server and routers. -In combination with a BGP Prefix Origin Validation scheme a router is able -to verify received BGP updates without suffering from cryptographic -complexity. - - -The RPKI/RTR protocol is defined in @cite{RFC6810, The Resource Public Key -Infrastructure (RPKI) to Router Protocol}, and the validation scheme in -@cite{RFC6811, BGP Prefix Origin Validation}. The current version of Prefix -Origin Validation in FRR implements both RFCs. - -For a more detailed but still easy-to-read background, we suggest the -following two articles: -@enumerate -@item @cite{Geoff Huston, Randy Bush: Securing BGP, In: The Internet -Protocol Journal, Volume 14, No. 2, 2011.} -@uref{http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_14-2/142_bgp.html} - -@item @cite{Geoff Huston: Resource Certification, In: The Internet Protocol -Journal, Volume 12, No.1, 2009.} -@uref{http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_12-1/121_resource.html} -@end enumerate - -@menu -* Features of the Current Implementation:: -* Enabling RPKI:: -* Configuring RPKI/RTR Cache Servers:: -* Validating BGP Updates:: -* Debugging:: -* Displaying RPKI:: -* RPKI Configuration Example:: -@end menu - -@node Features of the Current Implementation -@subsection Features of the Current Implementation - -In a nutshell, the current implementation provides the following features -@itemize @bullet -@item The BGP router can connect to one or more RPKI cache servers to -receive validated prefix to origin AS mappings. -Advanced failover can be implemented by server sockets with different -preference values. - -@item If no connection to an RPKI cache server can be established after a -pre-defined timeout, the router will process routes without prefix origin -validation. It still will try to establish a connection to an RPKI cache -server in the background. - -@item By default, enabling RPKI does not change best path selection. In -particular, invalid prefixes will still be considered during best path -selection. However, the router can be configured to ignore all invalid -prefixes. - -@item Route maps can be configured to match a specific RPKI validation -state. This allows the creation of local policies, which handle BGP routes -based on the outcome of the Prefix Origin Validation. - -@c @item When the router receives updated validation information from the RPKI -@c cache server, all routes in the local routing table will be re-evaluated. - -@end itemize - - -@node Enabling RPKI -@subsection Enabling RPKI -@deffn {Command} {rpki} {} -This command enables the RPKI configuration mode. Most commands that start -with @command{rpki} can only be used in this mode. - -When it is used in a telnet session, leaving of this mode cause rpki to be initialized. - -Executing this command alone does not activate prefix -validation. You need to configure at least one reachable cache server. See section -@ref{Configuring RPKI/RTR Cache Servers} for configuring a cache server. -@end deffn - -@node Configuring RPKI/RTR Cache Servers -@subsection Configuring RPKI/RTR Cache Servers - -The following commands are independent of a specific cache server. - -@deffn {RPKI Command} {rpki polling_period <1-3600>} {} -@deffnx {RPKI Command} {no rpki polling_period} {} -Set the number of seconds the router waits until the router asks the cache again -for updated data. - -The default value is 300 seconds. -@end deffn - -@deffn {RPKI Command} {rpki timeout <1-4,294,967,296>} {} -@deffnx {RPKI Command} {no rpki timeout} {} -Set the number of seconds the router waits for the cache reply. If the -cache server is not replying within this time period, the router deletes -all received prefix records from the prefix table. - -The default value is 600 seconds. -@end deffn - -@deffn {RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {} -@deffnx {RPKI Command} {no rpki initial-synchronisation-timeout} {} -Set the number of seconds until the first synchronization with the cache -server needs to be completed. If the timeout expires, BGP routing is -started without RPKI. The router will try to establish the cache server -connection in the background. - -The default value is 30 seconds. -@end deffn - -@noindent The following commands configure one or multiple cache servers. - -@deffn {RPKI Socket Command} {rpki cache (@var{A.B.C.D}|@var{WORD}) @var{PORT} [@var{SSH_USERNAME}] [@var{SSH_PRIVKEY_PATH}] [@var{SSH_PUBKEY_PATH}] [@var{KNOWN_HOSTS_PATH}] @var{PREFERENCE}} {} -@deffnx {RPKI Socket Command} {no rpki cache (@var{A.B.C.D}|@var{WORD}) [@var{PORT}] @var{PREFERENCE}} {} -Add a cache server to the socket. By default, the connection between -router and cache server is based on plain TCP. Protecting the connection -between router and cache server by SSH is optional. -Deleting a socket removes the associated cache server and -terminates the existing connection. -@end deffn - -@table @code -@item @var{A.B.C.D}|@var{WORD} -Address of the cache server. - -@item @var{PORT} -Port number to connect to the cache server - -@item @var{SSH_USERNAME} -SSH username to establish an SSH connection to the cache server. - -@item @var{SSH_PRIVKEY_PATH} -Local path that includes the private key file of the router. - -@item @var{SSH_PUBKEY_PATH} -Local path that includes the public key file of the router. - -@item @var{KNOWN_HOSTS_PATH} -Local path that includes the known hosts file. The default value depends on the -configuration of the operating system environment, usually -@file{~/.ssh/known_hosts}. - -@end table - -@node Validating BGP Updates -@subsection Validating BGP Updates - -@deffn {Route Map Command} {match rpki @{notfound|invalid|valid@}} {} -@deffnx {Route Map Command} {no match rpki @{notfound|invalid|valid@}} {} -Create a clause for a route map to match prefixes with the specified RPKI state. - -@strong{Note} that the matching of invalid prefixes requires that invalid -prefixes are considered for best path selection, i.e., @command{bgp -bestpath prefix-validate disallow-invalid} is not enabled. - -In the following example, the router prefers valid routes over invalid -prefixes because invalid routes have a lower local preference. -@example - ! Allow for invalid routes in route selection process - route bgp 60001 - ! - ! Set local preference of invalid prefixes to 10 - route-map rpki permit 10 - match rpki invalid - set local-preference 10 - ! - ! Set local preference of valid prefixes to 500 - route-map rpki permit 500 - match rpki valid - set local-preference 500 -@end example - -@end deffn - -@node Debugging -@subsection Debugging - -@deffn {Command} {debug rpki} {} -@deffnx {Command} {no debug rpki} {} -Enable or disable debugging output for RPKI. -@end deffn - - -@node Displaying RPKI -@subsection Displaying RPKI - -@deffn {Command} {show rpki prefix-table} {} -Display all validated prefix to origin AS mappings/records which have been -received from the cache servers and stored in the router. Based on this data, -the router validates BGP Updates. -@end deffn - -@deffn {Command} {show rpki cache-connection} {} -Display all configured cache servers, whether active or not. -@end deffn - -@node RPKI Configuration Example -@subsection RPKI Configuration Example - - -@example -hostname bgpd1 -password zebra -! log stdout -debug bgp updates -debug bgp keepalives -debug rpki -! -rpki - rpki polling_period 1000 - rpki timeout 10 - ! SSH Example: - rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1 - ! TCP Example: - rpki cache rpki-validator.realmv6.org 8282 preference 2 - exit -! -router bgp 60001 - bgp router-id 141.22.28.223 - network 192.168.0.0/16 - neighbor 123.123.123.0 remote-as 60002 - neighbor 123.123.123.0 route-map rpki in -! - address-family ipv6 - neighbor 123.123.123.0 activate - neighbor 123.123.123.0 route-map rpki in - exit-address-family -! -route-map rpki permit 10 - match rpki invalid - set local-preference 10 -! -route-map rpki permit 20 - match rpki notfound - set local-preference 20 -! -route-map rpki permit 30 - match rpki valid - set local-preference 30 -! -route-map rpki permit 40 -! -@end example diff --git a/doc/snmp.texi b/doc/snmp.texi deleted file mode 100644 index d9656941d0..0000000000 --- a/doc/snmp.texi +++ /dev/null @@ -1,189 +0,0 @@ -@node SNMP Support -@chapter SNMP Support - -@acronym{SNMP,Simple Network Managing Protocol} is a widely implemented -feature for collecting network information from router and/or host. -Frr itself does not support SNMP agent (server daemon) functionality -but is able to connect to a SNMP agent using the SMUX protocol -(@cite{RFC1227}) or the AgentX protocol (@cite{RFC2741}) and make the -routing protocol MIBs available through it. - -Note that SNMP Support needs to be enabled at compile-time and loaded as -module on daemon startup. Refer to @ref{Loadable Module Support} on -the latter. - -@menu -* Getting and installing an SNMP agent:: -* AgentX configuration:: -* SMUX configuration:: -* MIB and command reference:: -* Handling SNMP Traps:: -@end menu - -@node Getting and installing an SNMP agent -@section Getting and installing an SNMP agent - -There are several SNMP agent which support SMUX or AgentX. We recommend to use the latest -version of @code{net-snmp} which was formerly known as @code{ucd-snmp}. -It is free and open software and available at @uref{http://www.net-snmp.org/} -and as binary package for most Linux distributions. -@code{net-snmp} has to be compiled with @code{--with-mib-modules=agentx} to -be able to accept connections from Frr using AgentX protocol or with -@code{--with-mib-modules=smux} to use SMUX protocol. - -Nowadays, SMUX is a legacy protocol. The AgentX protocol should be -preferred for any new deployment. Both protocols have the same coverage. - -@node AgentX configuration -@section AgentX configuration - -To enable AgentX protocol support, Frr must have been build with the -@code{--enable-snmp} or @code{--enable-snmp=agentx} option. Both the -master SNMP agent (snmpd) and each of the Frr daemons must be -configured. In @code{/etc/snmp/snmpd.conf}, @code{master agentx} -directive should be added. In each of the Frr daemons, @code{agentx} -command will enable AgentX support. - -@example -/etc/snmp/snmpd.conf: - # - # example access restrictions setup - # - com2sec readonly default public - group MyROGroup v1 readonly - view all included .1 80 - access MyROGroup "" any noauth exact all none none - # - # enable master agent for AgentX subagents - # - master agentx - -/etc/frr/ospfd.conf: - ! ... the rest of ospfd.conf has been omitted for clarity ... - ! - agentx - ! -@end example - -Upon successful connection, you should get something like this in the -log of each Frr daemons: - -@example -2012/05/25 11:39:08 ZEBRA: snmp[info]: NET-SNMP version 5.4.3 AgentX subagent connected -@end example - -Then, you can use the following command to check everything works as expected: - -@example -# snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 -OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 -[...] -@end example - -The AgentX protocol can be transported over a Unix socket or using TCP -or UDP. It usually defaults to a Unix socket and depends on how NetSNMP -was built. If need to configure Frr to use another transport, you can -configure it through @code{/etc/snmp/frr.conf}: - -@example -/etc/snmp/frr.conf: - [snmpd] - # Use a remote master agent - agentXSocket tcp:192.168.15.12:705 -@end example - -@node SMUX configuration -@section SMUX configuration - -To enable SMUX protocol support, Frr must have been build with the -@code{--enable-snmp=smux} option. - -A separate connection has then to be established between the -SNMP agent (snmpd) and each of the Frr daemons. This connections -each use different OID numbers and passwords. Be aware that this OID -number is not the one that is used in queries by clients, it is solely -used for the intercommunication of the daemons. - -In the following example the ospfd daemon will be connected to the -snmpd daemon using the password "frr_ospfd". For testing it is -recommending to take exactly the below snmpd.conf as wrong access -restrictions can be hard to debug. - -@example -/etc/snmp/snmpd.conf: - # - # example access restrictions setup - # - com2sec readonly default public - group MyROGroup v1 readonly - view all included .1 80 - access MyROGroup "" any noauth exact all none none - # - # the following line is relevant for Frr - # - smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd - -/etc/frr/ospf: - ! ... the rest of ospfd.conf has been omitted for clarity ... - ! - smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd - ! -@end example - -After restarting snmpd and frr, a successful connection can be verified in -the syslog and by querying the SNMP daemon: - -@example -snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255 -snmpd[12300]: accepted smux peer: \ - oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5 - -# snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 -OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 -@end example - -Be warned that the current version (5.1.1) of the Net-SNMP daemon writes a line -for every SNMP connect to the syslog which can lead to enormous log file sizes. -If that is a problem you should consider to patch snmpd and comment out the -troublesome @code{snmp_log()} line in the function -@code{netsnmp_agent_check_packet()} in @code{agent/snmp_agent.c}. - -@node MIB and command reference -@section MIB and command reference - -The following OID numbers are used for the interprocess communication of snmpd and -the Frr daemons with SMUX only. -@example - (OIDs below .iso.org.dod.internet.private.enterprises) -zebra .1.3.6.1.4.1.3317.1.2.1 .gnome.gnomeProducts.zebra.zserv -bgpd .1.3.6.1.4.1.3317.1.2.2 .gnome.gnomeProducts.zebra.bgpd -ripd .1.3.6.1.4.1.3317.1.2.3 .gnome.gnomeProducts.zebra.ripd -ospfd .1.3.6.1.4.1.3317.1.2.5 .gnome.gnomeProducts.zebra.ospfd -ospf6d .1.3.6.1.4.1.3317.1.2.6 .gnome.gnomeProducts.zebra.ospf6d -@end example - -Sadly, SNMP has not been implemented in all daemons yet. The following -OID numbers are used for querying the SNMP daemon by a client: -@example -zebra .1.3.6.1.2.1.4.24 .iso.org.dot.internet.mgmt.mib-2.ip.ipForward -ospfd .1.3.6.1.2.1.14 .iso.org.dot.internet.mgmt.mib-2.ospf -bgpd .1.3.6.1.2.1.15 .iso.org.dot.internet.mgmt.mib-2.bgp -ripd .1.3.6.1.2.1.23 .iso.org.dot.internet.mgmt.mib-2.rip2 -ospf6d .1.3.6.1.3.102 .iso.org.dod.internet.experimental.ospfv3 -@end example - -The following syntax is understood by the Frr daemons for configuring SNMP using SMUX: -@deffn {Command} {smux peer @var{oid}} {} -@deffnx {Command} {no smux peer @var{oid}} {} -@end deffn - -@deffn {Command} {smux peer @var{oid} @var{password}} {} -@deffnx {Command} {no smux peer @var{oid} @var{password}} {} -@end deffn - -Here is the syntax for using AgentX: -@deffn {Command} {agentx} {} -@deffnx {Command} {no agentx} {} -@end deffn - -@include snmptrap.texi diff --git a/doc/snmptrap.texi b/doc/snmptrap.texi deleted file mode 100644 index 0dd3a703af..0000000000 --- a/doc/snmptrap.texi +++ /dev/null @@ -1,205 +0,0 @@ -@c Documentation on configuring Frr and snmpd for SNMP traps -@c contributed by Jeroen Simonetti, jsimonetti@denit.net - -@node Handling SNMP Traps -@section Handling SNMP Traps - -To handle snmp traps make sure your snmp setup of frr works -correctly as described in the frr documentation in @xref{SNMP Support}. - -The BGP4 mib will send traps on peer up/down events. These should be -visible in your snmp logs with a message similar to: - -@samp{snmpd[13733]: Got trap from peer on fd 14} - -To react on these traps they should be handled by a trapsink. Configure -your trapsink by adding the following lines to @file{/etc/snmpd/snmpd.conf}: - -@example - # send traps to the snmptrapd on localhost - trapsink localhost -@end example - -This will send all traps to an snmptrapd running on localhost. You can -of course also use a dedicated management station to catch traps. -Configure the snmptrapd daemon by adding the following line to -@file{/etc/snmpd/snmptrapd.conf}: - -@c Documentation contributed by Jeroen Simonetti, jsimonetti@denit.net - -@example - traphandle .1.3.6.1.4.1.3317.1.2.2 /etc/snmp/snmptrap_handle.sh -@end example - -This will use the bash script @file{/etc/snmp/snmptrap_handle.sh} to handle -the BGP4 traps. To add traps for other protocol daemons, lookup their -appropriate OID from their mib. (For additional information about which -traps are supported by your mib, lookup the mib on -@uref{http://www.oidview.com/mibs/detail.html}). - -Make sure snmptrapd is started. - -The snmptrap_handle.sh script I personally use for handling BGP4 traps -is below. You can of course do all sorts of things when handling traps, -like sound a siren, have your display flash, etc., be creative ;). - -@verbatim - #!/bin/bash - - # routers name - ROUTER=`hostname -s` - - #email address use to sent out notification - EMAILADDR="john@doe.com" - #email address used (allongside above) where warnings should be sent - EMAILADDR_WARN="sms-john@doe.com" - - # type of notification - TYPE="Notice" - - # local snmp community for getting AS belonging to peer - COMMUNITY="" - - # if a peer address is in $WARN_PEERS a warning should be sent - WARN_PEERS="192.0.2.1" - - - # get stdin - INPUT=`cat -` - - # get some vars from stdin - uptime=`echo $INPUT | cut -d' ' -f5` - peer=`echo $INPUT | cut -d' ' -f8 | sed -e 's/SNMPv2-SMI::mib-2.15.3.1.14.//g'` - peerstate=`echo $INPUT | cut -d' ' -f13` - errorcode=`echo $INPUT | cut -d' ' -f9 | sed -e 's/\"//g'` - suberrorcode=`echo $INPUT | cut -d' ' -f10 | sed -e 's/\"//g'` - remoteas=`snmpget -v2c -c $COMMUNITY localhost SNMPv2-SMI::mib-2.15.3.1.9.$peer | cut -d' ' -f4` - - WHOISINFO=`whois -h whois.ripe.net " -r AS$remoteas" | egrep '(as-name|descr)'` - asname=`echo "$WHOISINFO" | grep "^as-name:" | sed -e 's/^as-name://g' -e 's/ //g' -e 's/^ //g' | uniq` - asdescr=`echo "$WHOISINFO" | grep "^descr:" | sed -e 's/^descr://g' -e 's/ //g' -e 's/^ //g' | uniq` - - # if peer address is in $WARN_PEER, the email should also - # be sent to $EMAILADDR_WARN - for ip in $WARN_PEERS; do - if [ "x$ip" == "x$peer" ]; then - EMAILADDR="$EMAILADDR,$EMAILADDR_WARN" - TYPE="WARNING" - break - fi - done - - - # convert peer state - case "$peerstate" in - 1) peerstate="Idle" ;; - 2) peerstate="Connect" ;; - 3) peerstate="Active" ;; - 4) peerstate="Opensent" ;; - 5) peerstate="Openconfirm" ;; - 6) peerstate="Established" ;; - *) peerstate="Unknown" ;; - esac - - # get textual messages for errors - case "$errorcode" in - 00) - error="No error" - suberror="" - ;; - 01) - error="Message Header Error" - case "$suberrorcode" in - 01) suberror="Connection Not Synchronized" ;; - 02) suberror="Bad Message Length" ;; - 03) suberror="Bad Message Type" ;; - *) suberror="Unknown" ;; - esac - ;; - 02) - error="OPEN Message Error" - case "$suberrorcode" in - 01) suberror="Unsupported Version Number" ;; - 02) suberror="Bad Peer AS" ;; - 03) suberror="Bad BGP Identifier" ;; - 04) suberror="Unsupported Optional Parameter" ;; - 05) suberror="Authentication Failure" ;; - 06) suberror="Unacceptable Hold Time" ;; - *) suberror="Unknown" ;; - esac - ;; - 03) - error="UPDATE Message Error" - case "$suberrorcode" in - 01) suberror="Malformed Attribute List" ;; - 02) suberror="Unrecognized Well-known Attribute" ;; - 03) suberror="Missing Well-known Attribute" ;; - 04) suberror="Attribute Flags Error" ;; - 05) suberror="Attribute Length Error" ;; - 06) suberror="Invalid ORIGIN Attribute" ;; - 07) suberror="AS Routing Loop" ;; - 08) suberror="Invalid NEXT_HOP Attribute" ;; - 09) suberror="Optional Attribute Error" ;; - 10) suberror="Invalid Network Field" ;; - 11) suberror="Malformed AS_PATH" ;; - *) suberror="Unknown" ;; - esac - ;; - 04) - error="Hold Timer Expired" - suberror="" - ;; - 05) - error="Finite State Machine Error" - suberror="" - ;; - 06) - error="Cease" - case "$suberrorcode" in - 01) suberror="Maximum Number of Prefixes Reached" ;; - 02) suberror="Administratively Shutdown" ;; - 03) suberror="Peer Unconfigured" ;; - 04) suberror="Administratively Reset" ;; - 05) suberror="Connection Rejected" ;; - 06) suberror="Other Configuration Change" ;; - 07) suberror="Connection collision resolution" ;; - 08) suberror="Out of Resource" ;; - 09) suberror="MAX" ;; - *) suberror="Unknown" ;; - esac - ;; - *) - error="Unknown" - suberror="" - ;; - esac - - # create textual message from errorcodes - if [ "x$suberror" == "x" ]; then - NOTIFY="$errorcode ($error)" - else - NOTIFY="$errorcode/$suberrorcode ($error/$suberror)" - fi - - - # form a decent subject - SUBJECT="$TYPE: $ROUTER [bgp] $peer is $peerstate: $NOTIFY" - # create the email body - MAIL=`cat << EOF - BGP notification on router $ROUTER. - - Peer: $peer - AS: $remoteas - New state: $peerstate - Notification: $NOTIFY - - Info: - $asname - $asdescr - - Snmpd uptime: $uptime - EOF` - - # mail the notification - echo "$MAIL" | mail -s "$SUBJECT" $EMAILADDR -@end verbatim diff --git a/doc/user/.gitignore b/doc/user/.gitignore new file mode 100644 index 0000000000..0505537159 --- /dev/null +++ b/doc/user/.gitignore @@ -0,0 +1,3 @@ +/_templates +/_build +!/Makefile diff --git a/doc/user/Makefile b/doc/user/Makefile new file mode 100644 index 0000000000..056b78e68e --- /dev/null +++ b/doc/user/Makefile @@ -0,0 +1,216 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/user/appendix.rst b/doc/user/appendix.rst new file mode 100644 index 0000000000..334d162c91 --- /dev/null +++ b/doc/user/appendix.rst @@ -0,0 +1,223 @@ +Packet Binary Dump Format +========================= + +Packet Binary Dump Format +------------------------- + +FRR can dump routing protocol packet into file with a binary format +(@pxref{Dump BGP packets and table}). + +It seems to be better that we share the MRT's header format for +backward compatibility with MRT's dump logs. We should also define the +binary format excluding the header, because we must support both IP +v4 and v6 addresses as socket addresses and / or routing entries. + +In the last meeting, we discussed to have a version field in the +header. But Masaki told us that we can define new 'type' value rather +than having a 'version' field, and it seems to be better because we +don't need to change header format. + +Here is the common header format. This is same as that of MRT.:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Time | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Type | Subtype | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + +If 'type' is PROTOCOL_BGP4MP_ET, the common header format will +contain an additional microsecond field (RFC6396 2011).:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Time | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Type | Subtype | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Microsecond | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +If 'type' is PROTOCOL_BGP4MP, 'subtype' is BGP4MP_STATE_CHANGE, and +Address Family == IP (version 4):: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source AS number | Destination AS number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Interface Index | Address Family | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Old State | New State | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +Where State is the value defined in RFC1771. + +If 'type' is PROTOCOL_BGP4MP, 'subtype' is BGP4MP_STATE_CHANGE, +and Address Family == IP version 6:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source AS number | Destination AS number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Interface Index | Address Family | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Old State | New State | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +If 'type' is PROTOCOL_BGP4MP, 'subtype' is BGP4MP_MESSAGE, +and Address Family == IP (version 4):: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source AS number | Destination AS number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Interface Index | Address Family | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | BGP Message Packet | + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +Where BGP Message Packet is the whole contents of the +BGP4 message including header portion. + +If 'type' is PROTOCOL_BGP4MP, 'subtype' is BGP4MP_MESSAGE, +and Address Family == IP version 6:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source AS number | Destination AS number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Interface Index | Address Family | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination IP address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | BGP Message Packet | + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +If 'type' is PROTOCOL_BGP4MP, 'subtype' is BGP4MP_ENTRY, +and Address Family == IP (version 4):: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | View # | Status | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Time Last Change | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Address Family | SAFI | Next-Hop-Len | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Next Hop Address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Prefix Length | Address Prefix [variable] | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Attribute Length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | BGP Attribute [variable length] | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +If 'type' is PROTOCOL_BGP4MP, 'subtype' is BGP4MP_ENTRY, +and Address Family == IP version 6:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | View # | Status | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Time Last Change | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Address Family | SAFI | Next-Hop-Len | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Next Hop Address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Next Hop Address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Next Hop Address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Next Hop Address (Cont'd) | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Prefix Length | Address Prefix [variable] | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Address Prefix (cont'd) [variable] | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Attribute Length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | BGP Attribute [variable length] | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +BGP4 Attribute must not contain MP_UNREACH_NLRI. If BGP Attribute has +MP_REACH_NLRI field, it must has zero length NLRI, e.g., MP_REACH_NLRI has only +Address Family, SAFI and next-hop values. + +If 'type' is PROTOCOL_BGP4MP and 'subtype' is BGP4MP_SNAPSHOT:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | View # | File Name [variable] | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +The file specified in "File Name" contains all routing entries, +which are in the format of ``subtype == BGP4MP_ENTRY``. + +@example +@group +Constants::: + + /* type value */ + #define MSG_PROTOCOL_BGP4MP 16 + #define MSG_PROTOCOL_BGP4MP_ET 17 + /* subtype value */ + #define BGP4MP_STATE_CHANGE 0 + #define BGP4MP_MESSAGE 1 + #define BGP4MP_ENTRY 2 + #define BGP4MP_SNAPSHOT 3 diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst new file mode 100644 index 0000000000..926b453e53 --- /dev/null +++ b/doc/user/babeld.rst @@ -0,0 +1,265 @@ +.. _Babel: + +***** +Babel +***** + +Babel is an interior gateway protocol that is suitable both for wired +networks and for wireless mesh networks. Babel has been described as +'RIP on speed' --- it is based on the same principles as RIP, but +includes a number of refinements that make it react much faster to +topology changes without ever counting to infinity, and allow it to +perform reliable link quality estimation on wireless links. Babel is +a double-stack routing protocol, meaning that a single Babel instance +is able to perform routing for both IPv4 and IPv6. + +FRR implements Babel as described in RFC6126. + +.. _Configuring_babeld: + +Configuring babeld +================== + +The *babeld* daemon can be invoked with any of the common +options (:ref:`Common_Invocation_Options`). + +The *zebra* daemon must be running before *babeld* is +invoked. Also, if *zebra* is restarted then *babeld* +must be too. + +Configuration of *babeld* is done in its configuration file +:file:`babeld.conf`. + +.. _Babel_configuration: + +Babel configuration +=================== + +.. index:: Command {router babel} {} + +Command {router babel} {} +.. index:: Command {no router babel} {} + +Command {no router babel} {} + Enable or disable Babel routing. + +.. index:: Command {babel resend-delay <20-655340>} {} + +Command {babel resend-delay <20-655340>} {} + Specifies the time after which important messages are resent when + avoiding a black-hole. The default is 2000@dmn{ms}. + +.. index:: Command {babel diversity} {} + +Command {babel diversity} {} +.. index:: Command {no babel diversity} {} + +Command {no babel diversity} {} + Enable or disable routing using radio frequency diversity. This is + highly recommended in networks with many wireless nodes. + + If you enable this, you will probably want to set `babel diversity-factor` and `babel channel` below. + +.. index:: Command {babel diversity-factor <1-256>} {} + +Command {babel diversity-factor <1-256>} {} + Sets the multiplicative factor used for diversity routing, in units of + 1/256; lower values cause diversity to play a more important role in + route selection. The default it 256, which means that diversity plays + no role in route selection; you will probably want to set that to 128 + or less on nodes with multiple independent radios. + +.. index:: {Babel Command} {network `ifname`} {} + +{Babel Command} {network `ifname`} {} +.. index:: {Babel Command} {no network `ifname`} {} + +{Babel Command} {no network `ifname`} {} + Enable or disable Babel on the given interface. + +.. index:: {Interface Command} {babel wired} {} + +{Interface Command} {babel wired} {} +.. index:: {Interface Command} {babel wireless} {} + +{Interface Command} {babel wireless} {} + Specifies whether this interface is wireless, which disables a number + of optimisations that are only correct on wired interfaces. + Specifying `wireless` (the default) is always correct, but may + cause slower convergence and extra routing traffic. + +.. index:: {Interface Command} {babel split-horizon} + +{Interface Command} {babel split-horizon} +.. index:: {Interface Command} {no babel split-horizon} + +{Interface Command} {no babel split-horizon} + Specifies whether to perform split-horizon on the interface. + Specifying `no babel split-horizon` is always correct, while + `babel split-horizon` is an optimisation that should only be used + on symmetric and transitive (wired) networks. The default is + `babel split-horizon` on wired interfaces, and `no babel split-horizon` on wireless interfaces. This flag is reset when the + wired/wireless status of an interface is changed. + +.. index:: {Interface Command} {babel hello-interval <20-655340>} + +{Interface Command} {babel hello-interval <20-655340>} + Specifies the time in milliseconds between two scheduled hellos. On + wired links, Babel notices a link failure within two hello intervals; + on wireless links, the link quality value is reestimated at every + hello interval. The default is 4000@dmn{ms}. + +.. index:: {Interface Command} {babel update-interval <20-655340>} + +{Interface Command} {babel update-interval <20-655340>} + Specifies the time in milliseconds between two scheduled updates. + Since Babel makes extensive use of triggered updates, this can be set + to fairly high values on links with little packet loss. The default + is 20000@dmn{ms}. + +.. index:: {Interface Command} {babel channel <1-254>} + +{Interface Command} {babel channel <1-254>} +.. index:: {Interface Command} {babel channel interfering} + +{Interface Command} {babel channel interfering} +.. index:: {Interface Command} {babel channel noninterfering} + +{Interface Command} {babel channel noninterfering} + Set the channel number that diversity routing uses for this interface + (see `babel diversity` above). Noninterfering interfaces are + assumed to only interfere with themselves, interfering interfaces are + assumed to interfere with all other channels except noninterfering + channels, and interfaces with a channel number interfere with + interfering interfaces and interfaces with the same channel number. + The default is @samp{babel channel interfering} for wireless + interfaces, and @samp{babel channel noninterfering} for wired + interfaces. This is reset when the wired/wireless status of an + interface is changed. + +.. index:: {Interface Command} {babel rxcost <1-65534>} + +{Interface Command} {babel rxcost <1-65534>} + Specifies the base receive cost for this interface. For wireless + interfaces, it specifies the multiplier used for computing the ETX + reception cost (default 256); for wired interfaces, it specifies the + cost that will be advertised to neighbours. This value is reset when + the wired/wireless attribute of the interface is changed. + + Do not use this command unless you know what you are doing; in most + networks, acting directly on the cost using route maps is a better + technique. + +.. index:: {Interface Command} {babel rtt-decay <1-256>} + +{Interface Command} {babel rtt-decay <1-256>} + This specifies the decay factor for the exponential moving average of + RTT samples, in units of 1/256. Higher values discard old samples + faster. The default is 42. + +.. index:: {Interface Command} {babel rtt-min <1-65535>} + +{Interface Command} {babel rtt-min <1-65535>} + This specifies the minimum RTT, in milliseconds, starting from which we + increase the cost to a neighbour. The additional cost is linear in (rtt + - rtt-min ). The default is 10@dmn{ms}. + +.. index:: {Interface Command} {babel rtt-max <1-65535>} + +{Interface Command} {babel rtt-max <1-65535>} + This specifies the maximum RTT, in milliseconds, above which we don't + increase the cost to a neighbour. The default is 120@dmn{ms}. + +.. index:: {Interface Command} {babel max-rtt-penalty <0-65535>} + +{Interface Command} {babel max-rtt-penalty <0-65535>} + This specifies the maximum cost added to a neighbour because of RTT, + i.e. when the RTT is higher or equal than rtt-max. The default is 0, + which effectively disables the use of a RTT-based cost. + +.. index:: {Interface Command} {babel enable-timestamps} + +{Interface Command} {babel enable-timestamps} +.. index:: {Interface Command} {no babel enable-timestamps} + +{Interface Command} {no babel enable-timestamps} + Enable or disable sending timestamps with each Hello and IHU message in + order to compute RTT values. The default is `no babel enable-timestamps`. + +.. index:: {Babel Command} {babel resend-delay <20-655340>} + +{Babel Command} {babel resend-delay <20-655340>} + Specifies the time in milliseconds after which an 'important' + request or update will be resent. The default is 2000@dmn{ms}. You + probably don't want to tweak this value. + +.. index:: {Babel Command} {babel smoothing-half-life <0-65534>} + +{Babel Command} {babel smoothing-half-life <0-65534>} + Specifies the time constant, in seconds, of the smoothing algorithm + used for implementing hysteresis. Larger values reduce route + oscillation at the cost of very slightly increasing convergence time. + The value 0 disables hysteresis, and is suitable for wired networks. + The default is 4@dmn{s}. + +.. _Babel_redistribution: + +Babel redistribution +==================== + +.. index:: {Babel command} {redistribute `` `kind`} + +{Babel command} {redistribute `` `kind`} +.. index:: {Babel command} {no redistribute `` `kind`} + +{Babel command} {no redistribute `` `kind`} + Specify which kind of routes should be redistributed into Babel. + +.. _Show_Babel_information: + +Show Babel information +====================== + +.. index:: {Command} {show babel route} {} + +{Command} {show babel route} {} +.. index:: {Command} {show babel route A.B.C.D} + +{Command} {show babel route A.B.C.D} +.. index:: {Command} {show babel route X:X::X:X} + +{Command} {show babel route X:X::X:X} +.. index:: {Command} {show babel route A.B.C.D/M} + +{Command} {show babel route A.B.C.D/M} +.. index:: {Command} {show babel route X:X::X:X/M} + +{Command} {show babel route X:X::X:X/M} +.. index:: {Command} {show babel interface} {} + +{Command} {show babel interface} {} +.. index:: {Command} {show babel interface `ifname`} {} + +{Command} {show babel interface `ifname`} {} +.. index:: {Command} {show babel neighbor} {} + +{Command} {show babel neighbor} {} +.. index:: {Command} {show babel parameters} {} + +{Command} {show babel parameters} {} + These commands dump various parts of *babeld*'s internal state. + +Babel debugging commands +======================== + +.. index:: {Babel Command} {debug babel `kind`} {} + +{Babel Command} {debug babel `kind`} {} +.. index:: {Babel Command} {no debug babel `kind`} {} + +{Babel Command} {no debug babel `kind`} {} + Enable or disable debugging messages of a given kind. `kind` can + be one of @samp{common}, @samp{kernel}, @samp{filter}, @samp{timeout}, + @samp{interface}, @samp{route} or @samp{all}. Note that if you have + compiled with the NO_DEBUG flag, then these commands aren't available. + diff --git a/doc/user/basic.rst b/doc/user/basic.rst new file mode 100644 index 0000000000..505de59547 --- /dev/null +++ b/doc/user/basic.rst @@ -0,0 +1,706 @@ +.. _Basic_commands: + +************** +Basic commands +************** + +There are five routing daemons in use, and there is one manager daemon. +These daemons may be located on separate machines from the manager +daemon. Each of these daemons will listen on a particular port for +incoming VTY connections. The routing daemons are: + +* *ripd*, *ripngd*, *ospfd*, *ospf6d*, *bgpd* +* *zebra* + +The following sections discuss commands common to all the routing +daemons. + +.. _Config_Commands: + +Config Commands +=============== + +.. index:: Configuration files for running the software + +.. index:: Files for running configurations + +.. index:: Modifying the herd's behavior + +.. index:: Getting the herd running + +In a config file, you can write the debugging options, a vty's password, +routing daemon configurations, a log file name, and so forth. This +information forms the initial command set for a routing beast as it is +starting. + +Config files are generally found in: + +* :file:`@value{INSTALL_PREFIX_ETC}`/\*.conf + +Each of the daemons has its own +config file. For example, zebra's default config file name is: + +* :file:`@value{INSTALL_PREFIX_ETC`/zebra.conf} + +The daemon name plus :file:`.conf` is the default config file name. You +can specify a config file using the @kbd{-f} or @kbd{--config-file} +options when starting the daemon. + +.. _Basic_Config_Commands: + +Basic Config Commands +--------------------- + +.. index:: Command {hostname `hostname`} {} + +Command {hostname `hostname`} {} + Set hostname of the router. + +.. index:: Command {password `password`} {} + +Command {password `password`} {} + Set password for vty interface. If there is no password, a vty won't + accept connections. + +.. index:: Command {enable password `password`} {} + +Command {enable password `password`} {} + Set enable password. + +.. index:: Command {log trap `level`} {} + +Command {log trap `level`} {} +.. index:: Command {no log trap} {} + +Command {no log trap} {} + These commands are deprecated and are present only for historical compatibility. + The log trap command sets the current logging level for all enabled + logging destinations, and it sets the default for all future logging commands + that do not specify a level. The normal default + logging level is debugging. The `no` form of the command resets + the default level for future logging commands to debugging, but it does + not change the logging level of existing logging destinations. + +.. index:: Command {log stdout} {} + +Command {log stdout} {} +.. index:: Command {log stdout `level`} {} + +Command {log stdout `level`} {} +.. index:: Command {no log stdout} {} + +Command {no log stdout} {} + Enable logging output to stdout. + If the optional second argument specifying the + logging level is not present, the default logging level (typically debugging, + but can be changed using the deprecated `log trap` command) will be used. + The `no` form of the command disables logging to stdout. + The `level` argument must have one of these values: + emergencies, alerts, critical, errors, warnings, notifications, informational, or debugging. Note that the existing code logs its most important messages + with severity `errors`. + +.. index:: Command {log file `filename`} {} + +Command {log file `filename`} {} +.. index:: Command {log file `filename` `level`} {} + +Command {log file `filename` `level`} {} +.. index:: Command {no log file} {} + +Command {no log file} {} + If you want to log into a file, please specify `filename` as + in this example:: + + log file /var/log/frr/bgpd.log informational + + If the optional second argument specifying the + logging level is not present, the default logging level (typically debugging, + but can be changed using the deprecated `log trap` command) will be used. + The `no` form of the command disables logging to a file. + + Note: if you do not configure any file logging, and a daemon crashes due + to a signal or an assertion failure, it will attempt to save the crash + information in a file named /var/tmp/frr..crashlog. + For security reasons, this will not happen if the file exists already, so + it is important to delete the file after reporting the crash information. + +.. index:: Command {log syslog} {} + +Command {log syslog} {} +.. index:: Command {log syslog `level`} {} + +Command {log syslog `level`} {} +.. index:: Command {no log syslog} {} + +Command {no log syslog} {} + Enable logging output to syslog. + If the optional second argument specifying the + logging level is not present, the default logging level (typically debugging, + but can be changed using the deprecated `log trap` command) will be used. + The `no` form of the command disables logging to syslog. + +.. index:: Command {log monitor} {} + +Command {log monitor} {} +.. index:: Command {log monitor `level`} {} + +Command {log monitor `level`} {} +.. index:: Command {no log monitor} {} + +Command {no log monitor} {} + Enable logging output to vty terminals that have enabled logging + using the `terminal monitor` command. + By default, monitor logging is enabled at the debugging level, but this + command (or the deprecated `log trap` command) can be used to change + the monitor logging level. + If the optional second argument specifying the + logging level is not present, the default logging level (typically debugging, + but can be changed using the deprecated `log trap` command) will be used. + The `no` form of the command disables logging to terminal monitors. + +.. index:: Command {log facility `facility`} {} + +Command {log facility `facility`} {} +.. index:: Command {no log facility} {} + +Command {no log facility} {} + This command changes the facility used in syslog messages. The default + facility is `daemon`. The `no` form of the command resets + the facility to the default `daemon` facility. + +.. index:: Command {log record-priority} {} + +Command {log record-priority} {} +.. index:: Command {no log record-priority} {} + +Command {no log record-priority} {} + To include the severity in all messages logged to a file, to stdout, or to + a terminal monitor (i.e. anything except syslog), + use the `log record-priority` global configuration command. + To disable this option, use the `no` form of the command. By default, + the severity level is not included in logged messages. Note: some + versions of syslogd (including Solaris) can be configured to include + the facility and level in the messages emitted. + +.. index:: Command {log timestamp precision `<0-6>`} {} + +Command {log timestamp precision `<0-6>`} {} +.. index:: Command {no log timestamp precision} {} + +Command {no log timestamp precision} {} + This command sets the precision of log message timestamps to the + given number of digits after the decimal point. Currently, + the value must be in the range 0 to 6 (i.e. the maximum precision + is microseconds). + To restore the default behavior (1-second accuracy), use the + `no` form of the command, or set the precision explicitly to 0. + +:: + + @group + log timestamp precision 3 + @end group + + + In this example, the precision is set to provide timestamps with + millisecond accuracy. + +.. index:: Command {log commands} {} + +Command {log commands} {} + This command enables the logging of all commands typed by a user to + all enabled log destinations. The note that logging includes full + command lines, including passwords. Once set, command logging can only + be turned off by restarting the daemon. + +.. index:: Command {service password-encryption} {} + +Command {service password-encryption} {} + Encrypt password. + +.. index:: Command {service advanced-vty} {} + +Command {service advanced-vty} {} + Enable advanced mode VTY. + +.. index:: Command {service terminal-length `<0-512>`} {} + +Command {service terminal-length `<0-512>`} {} + Set system wide line configuration. This configuration command applies + to all VTY interfaces. + +.. index:: Command {line vty} {} + +Command {line vty} {} + Enter vty configuration mode. + +.. index:: Command {banner motd default} {} + +Command {banner motd default} {} + Set default motd string. + +.. index:: Command {no banner motd} {} + +Command {no banner motd} {} + No motd banner string will be printed. + +.. index:: {Line Command} {exec-timeout `minute`} {} + +{Line Command} {exec-timeout `minute`} {} +.. index:: {Line Command} {exec-timeout `minute` `second`} {} + +{Line Command} {exec-timeout `minute` `second`} {} + Set VTY connection timeout value. When only one argument is specified + it is used for timeout value in minutes. Optional second argument is + used for timeout value in seconds. Default timeout value is 10 minutes. + When timeout value is zero, it means no timeout. + +.. index:: {Line Command} {no exec-timeout} {} + +{Line Command} {no exec-timeout} {} + Do not perform timeout at all. This command is as same as + *exec-timeout 0 0*. + +.. index:: {Line Command} {access-class `access-list`} {} + +{Line Command} {access-class `access-list`} {} + Restrict vty connections with an access list. + +.. _Sample_Config_File: + +Sample Config File +------------------ + +Below is a sample configuration file for the zebra daemon. + +:: + + @group + ! + ! Zebra configuration file + ! + hostname Router + password zebra + enable password zebra + ! + log stdout + ! + ! + @end group + + +'!' and '#' are comment characters. If the first character of the word +is one of the comment characters then from the rest of the line forward +will be ignored as a comment. + +:: + + password zebra!password + + +If a comment character is not the first character of the word, it's a +normal character. So in the above example '!' will not be regarded as a +comment and the password is set to 'zebra!password'. + +.. _Terminal_Mode_Commands: + +Terminal Mode Commands +====================== + +.. index:: Command {write terminal} {} + +Command {write terminal} {} + Displays the current configuration to the vty interface. + +.. index:: Command {write file} {} + +Command {write file} {} + Write current configuration to configuration file. + +.. index:: Command {configure terminal} {} + +Command {configure terminal} {} + Change to configuration mode. This command is the first step to + configuration. + +.. index:: Command {terminal length `<0-512>`} {} + +Command {terminal length `<0-512>`} {} + Set terminal display length to `<0-512>`. If length is 0, no + display control is performed. + +.. index:: Command {who} {} + +Command {who} {} + Show a list of currently connected vty sessions. + +.. index:: Command {list} {} + +Command {list} {} + List all available commands. + +.. index:: Command {show version} {} + +Command {show version} {} + Show the current version of @value{PACKAGE_NAME} and its build host information. + +.. index:: Command {show logging} {} + +Command {show logging} {} + Shows the current configuration of the logging system. This includes + the status of all logging destinations. + +.. index:: Command {logmsg `level` `message`} {} + +Command {logmsg `level` `message`} {} + Send a message to all logging destinations that are enabled for messages + of the given severity. + +.. _Common_Invocation_Options: + +Common Invocation Options +========================= + +These options apply to all @value{PACKAGE_NAME} daemons. + + + +*-d* + +*--daemon* + Runs in daemon mode. + + +*-f `file`* + +*--config_file=`file`* + Set configuration file name. + + +*-h* + +*--help* + Display this help and exit. + + +*-i `file`* + +*--pid_file=`file`* + Upon startup the process identifier of the daemon is written to a file, + typically in :file:`/var/run`. This file can be used by the init system + to implement commands such as *.../init.d/zebra status*, + *.../init.d/zebra restart* or @command{.../init.d/zebra + stop}. + + The file name is an run-time option rather than a configure-time option + so that multiple routing daemons can be run simultaneously. This is + useful when using @value{PACKAGE_NAME} to implement a routing looking glass. One + machine can be used to collect differing routing views from differing + points in the network. + + +*-A `address`* + +*--vty_addr=`address`* + Set the VTY local address to bind to. If set, the VTY socket will only + be bound to this address. + + +*-P `port`* + +*--vty_port=`port`* + Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not + be opened. + + +*-u `user`* + +*--vty_addr=`user`* + Set the user and group to run as. + + +*-v* + +*--version* + Print program version. + + +.. _Loadable_Module_Support: + +Loadable Module Support +======================= + +FRR supports loading extension modules at startup. Loading, reloading or +unloading modules at runtime is not supported (yet). To load a module, use +the following command line option at daemon startup: + + + +*-M `module:options`* + +*--module `module:options`* + Load the specified module, optionally passing options to it. If the module + name contains a slash (/), it is assumed to be a full pathname to a file to + be loaded. If it does not contain a slash, the + `@value{INSTALL_PREFIX_MODULES`} directory is searched for a module of + the given name; first with the daemon name prepended (e.g. `zebra_mod` + for `mod`), then without the daemon name prepended. + + This option is available on all daemons, though some daemons may not have + any modules available to be loaded. + +The SNMP Module +--------------- + +If SNMP is enabled during compile-time and installed as part of the package, +the `snmp` module can be loaded for the *zebra*, +*bgpd*, *ospfd*, *ospf6d* and *ripd* daemons. + +The module ignores any options passed to it. Refer to :ref:`SNMP_Support` +for information on its usage. + +The FPM Module +-------------- + +If FPM is enabled during compile-time and installed as part of the package, +the `fpm` module can be loaded for the *zebra* daemon. This +provides the Forwarding Plane Manager ("FPM") API. + +The module expects its argument to be either `netlink` or +`protobuf`, specifying the encapsulation to use. `netlink` is the +default, and `protobuf` may not be available if the module was built +without protobuf support. Refer to :ref:`zebra_FIB_push_interface` for more +information. + +.. _Virtual_Terminal_Interfaces: + +Virtual Terminal Interfaces +=========================== + +VTY -- Virtual Terminal [aka TeletYpe] Interface is a command line +interface (CLI) for user interaction with the routing daemon. + +.. _VTY_Overview: + +VTY Overview +------------ + +VTY stands for Virtual TeletYpe interface. It means you can connect to +the daemon via the telnet protocol. + +To enable a VTY interface, you have to setup a VTY password. If there +is no VTY password, one cannot connect to the VTY interface at all. + +:: + + @group + % telnet localhost 2601 + Trying 127.0.0.1... + Connected to localhost. + Escape character is '^]'. + + Hello, this is @value{PACKAGE_NAME} (version @value{PACKAGE_VERSION}) + @value{COPYRIGHT_STR} + + User Access Verification + + Password: XXXXX + Router> ? + enable Turn on privileged commands + exit Exit current mode and down to previous mode + help Description of the interactive help system + list Print command list + show Show running system information + who Display who is on a vty + Router> enable + Password: XXXXX + Router# configure terminal + Router(config)# interface eth0 + Router(config-if)# ip address 10.0.0.1/8 + Router(config-if)# ^Z + Router# + @end group + + +'?' is very useful for looking up commands. + +.. _VTY_Modes: + +VTY Modes +--------- + +There are three basic VTY modes: + +There are commands that may be restricted to specific VTY modes. + +.. _VTY_View_Mode: + +VTY View Mode +^^^^^^^^^^^^^ + +This mode is for read-only access to the CLI. One may exit the mode by +leaving the system, or by entering `enable` mode. + +.. _VTY_Enable_Mode: + +VTY Enable Mode +^^^^^^^^^^^^^^^ + +This mode is for read-write access to the CLI. One may exit the mode by +leaving the system, or by escaping to view mode. + +.. _VTY_Other_Modes: + +VTY Other Modes +^^^^^^^^^^^^^^^ + +This page is for describing other modes. + +.. _VTY_CLI_Commands: + +VTY CLI Commands +---------------- + +Commands that you may use at the command-line are described in the following +three subsubsections. + +.. _CLI_Movement_Commands: + +CLI Movement Commands +^^^^^^^^^^^^^^^^^^^^^ + +These commands are used for moving the CLI cursor. The :kbd:`C` character +means press the Control Key. + + + +*C-f* + +*:kbd:`RIGHT`* + @kindex C-f + @kindex :kbd:`RIGHT` + Move forward one character. + + +*C-b* + +*:kbd:`LEFT`* + @kindex C-b + @kindex :kbd:`LEFT` + Move backward one character. + + +*M-f* + @kindex M-f + Move forward one word. + + +*M-b* + @kindex M-b + Move backward one word. + + +*C-a* + @kindex C-a + Move to the beginning of the line. + + +*C-e* + @kindex C-e + Move to the end of the line. + + +.. _CLI_Editing_Commands: + +CLI Editing Commands +^^^^^^^^^^^^^^^^^^^^ + +These commands are used for editing text on a line. The :kbd:`C` +character means press the Control Key. + + + +*C-h* + +*:kbd:`DEL`* + @kindex C-h + @kindex :kbd:`DEL` + Delete the character before point. + + +*C-d* + @kindex C-d + Delete the character after point. + + +*M-d* + @kindex M-d + Forward kill word. + + +*C-w* + @kindex C-w + Backward kill word. + + +*C-k* + @kindex C-k + Kill to the end of the line. + + +*C-u* + @kindex C-u + Kill line from the beginning, erasing input. + + +*C-t* + @kindex C-t + Transpose character. + + +CLI Advanced Commands +^^^^^^^^^^^^^^^^^^^^^ + +There are several additional CLI commands for command line completions, +insta-help, and VTY session management. + + + +*C-c* + @kindex C-c + Interrupt current input and moves to the next line. + + +*C-z* + @kindex C-z + End current configuration session and move to top node. + + +*C-n* + +*:kbd:`DOWN`* + @kindex C-n + @kindex :kbd:`DOWN` + Move down to next line in the history buffer. + + +*C-p* + +*:kbd:`UP`* + @kindex C-p + @kindex :kbd:`UP` + Move up to previous line in the history buffer. + + +*TAB* + @kindex :kbd:`TAB` + Use command line completion by typing :kbd:`TAB`. + + +*?* + @kindex :kbd:`?` + You can use command line help by typing `help` at the beginning of + the line. Typing @kbd{?} at any point in the line will show possible + completions. + + diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst new file mode 100644 index 0000000000..81c55805be --- /dev/null +++ b/doc/user/bgp.rst @@ -0,0 +1,2392 @@ +.. _BGP: + +*** +BGP +*** + +@acronym{BGP} stands for a Border Gateway Protocol. The lastest BGP version +is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway +Protocols and de-fact standard of Inter Domain routing protocol. +BGP-4 is described in @cite{RFC1771, A Border Gateway Protocol +4 (BGP-4)}. + +Many extensions have been added to @cite{RFC1771}. @cite{RFC2858, +Multiprotocol Extensions for BGP-4} provides multiprotocol support to +BGP-4. + +.. _Starting_BGP: + +Starting BGP +============ + +Default configuration file of *bgpd* is :file:`bgpd.conf`. +*bgpd* searches the current directory first then +@value{INSTALL_PREFIX_ETC}/bgpd.conf. All of bgpd's command must be +configured in :file:`bgpd.conf`. + +*bgpd* specific invocation options are described below. Common +options may also be specified (:ref:`Common_Invocation_Options`). + + + +*-p `PORT`* + +*--bgp_port=`PORT`* + Set the bgp protocol's port number. + + +*-r* + +*--retain* + When program terminates, retain BGP routes added by zebra. + + +*-l* + +*--listenon* + Specify a specific IP address for bgpd to listen on, rather than its + default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd + to an internal address, or to run multiple bgpd processes on one host. + + +.. _BGP_router: + +BGP router +========== + +First of all you must configure BGP router with *router bgp* +command. To configure BGP router, you need AS number. AS number is an +identification of autonomous system. BGP protocol uses the AS number +for detecting whether the BGP connection is internal one or external one. + +.. index:: Command {router bgp `asn`} {} + +Command {router bgp `asn`} {} + Enable a BGP protocol process with the specified `asn`. After + this statement you can input any `BGP Commands`. You can not + create different BGP process under different `asn` without + specifying `multiple-instance` (:ref:`Multiple_instance`). + +.. index:: Command {no router bgp `asn`} {} + +Command {no router bgp `asn`} {} + Destroy a BGP protocol process with the specified `asn`. + +.. index:: {BGP} {bgp router-id `A.B.C.D`} {} + +{BGP} {bgp router-id `A.B.C.D`} {} + This command specifies the router-ID. If *bgpd* connects to *zebra* it gets + interface and address information. In that case default router ID value + is selected as the largest IP Address of the interfaces. When + `router zebra` is not enabled *bgpd* can't get interface information + so `router-id` is set to 0.0.0.0. So please set router-id by hand. + +.. _BGP_distance: + +BGP distance +------------ + +.. index:: {BGP} {distance bgp <1-255> <1-255> <1-255>} {} + +{BGP} {distance bgp <1-255> <1-255> <1-255>} {} + This command change distance value of BGP. Each argument is distance + value for external routes, internal routes and local routes. + +.. index:: {BGP} {distance <1-255> `A.B.C.D/M`} {} + +{BGP} {distance <1-255> `A.B.C.D/M`} {} +.. index:: {BGP} {distance <1-255> `A.B.C.D/M` `word`} {} + +{BGP} {distance <1-255> `A.B.C.D/M` `word`} {} + This command set distance value to + +.. _BGP_decision_process: + +BGP decision process +-------------------- + +The decision process Frr BGP uses to select routes is as follows: + + + +*1. Weight check* + prefer higher local weight routes to lower routes. + + +*2. Local preference check* + prefer higher local preference routes to lower. + + +*3. Local route check* + Prefer local routes (statics, aggregates, redistributed) to received routes. + + +*4. AS path length check* + Prefer shortest hop-count AS_PATHs. + + +*5. Origin check* + Prefer the lowest origin type route. That is, prefer IGP origin routes to + EGP, to Incomplete routes. + + +*6. MED check* + Where routes with a MED were received from the same AS, + prefer the route with the lowest MED. :ref:`BGP_MED`. + + +*7. External check* + Prefer the route received from an external, eBGP peer + over routes received from other types of peers. + + +*8. IGP cost check* + Prefer the route with the lower IGP cost. + + +*9. Multi-path check* + If multi-pathing is enabled, then check whether + the routes not yet distinguished in preference may be considered equal. If + :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are + considered equal, otherwise routes received via iBGP with identical AS_PATHs + or routes received from eBGP neighbours in the same AS are considered equal. + + +*10 Already-selected external check* + Where both routes were received from eBGP peers, then prefer the route which + is already selected. Note that this check is not applied if :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent some cases + of oscillation. + + +*11. Router-ID check* + Prefer the route with the lowest @w{router-ID}. If the + route has an @w{ORIGINATOR_ID} attribute, through iBGP reflection, then that + router ID is used, otherwise the @w{router-ID} of the peer the route was + received from is used. + + +*12. Cluster-List length check* + The route with the shortest cluster-list + length is used. The cluster-list reflects the iBGP reflection path the + route has taken. + + +*13. Peer address* + Prefer the route received from the peer with the higher + transport layer address, as a last-resort tie-breaker. + + +.. index:: {BGP} {bgp bestpath as-path confed} {} + +{BGP} {bgp bestpath as-path confed} {} + This command specifies that the length of confederation path sets and + sequences should should be taken into account during the BGP best path + decision process. + +.. index:: {BGP} {bgp bestpath as-path multipath-relax} {} + +{BGP} {bgp bestpath as-path multipath-relax} {} + .. _bgp_bestpath_as-path_multipath-relax: + + This command specifies that BGP decision process should consider paths + of equal AS_PATH length candidates for multipath computation. Without + the knob, the entire AS_PATH must match for multipath computation. + +.. index:: {BGP} {bgp bestpath compare-routerid} {} + +{BGP} {bgp bestpath compare-routerid} {} + .. _bgp_bestpath_compare-routerid: + + Ensure that when comparing routes where both are equal on most metrics, + including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken + based on router-ID. + + If this option is enabled, then the already-selected check, where + already selected eBGP routes are preferred, is skipped. + + If a route has an @w{ORIGINATOR_ID} attribute because it has been reflected, + that @w{ORIGINATOR_ID} will be used. Otherwise, the router-ID of the peer the + route was received from will be used. + + The advantage of this is that the route-selection (at this point) will be + more deterministic. The disadvantage is that a few or even one lowest-ID + router may attract all trafic to otherwise-equal paths because of this + check. It may increase the possibility of MED or IGP oscillation, unless + other measures were taken to avoid these. The exact behaviour will be + sensitive to the iBGP and reflection topology. + + +.. _BGP_route_flap_dampening: + +BGP route flap dampening +------------------------ + +.. index:: {BGP} {bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>`} {} + +{BGP} {bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>`} {} + This command enables BGP route-flap dampening and specifies dampening parameters. + + + +*@asis{half-life}* + Half-life time for the penalty + +*@asis{reuse-threshold}* + Value to start reusing a route + +*@asis{suppress-threshold}* + Value to start suppressing a route + +*@asis{max-suppress}* + Maximum duration to suppress a stable route + + The route-flap damping algorithm is compatible with @cite{RFC2439}. The use of this command + is not recommended nowadays, see `http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 `_. + +.. _BGP_MED: + +BGP MED +======= + +The BGP MED (Multi_Exit_Discriminator) attribute has properties which can +cause subtle convergence problems in BGP. These properties and problems +have proven to be hard to understand, at least historically, and may still +not be widely understood. The following attempts to collect together and +present what is known about MED, to help operators and Frr users in +designing and configuring their networks. + +The BGP @acronym{MED, Multi_Exit_Discriminator} attribute is intended to +allow one AS to indicate its preferences for its ingress points to another +AS. The MED attribute will not be propagated on to another AS by the +receiving AS - it is 'non-transitive' in the BGP sense. + +E.g., if AS X and AS Y have 2 different BGP peering points, then AS X +might set a MED of 100 on routes advertised at one and a MED of 200 at the +other. When AS Y selects between otherwise equal routes to or via +AS X, AS Y should prefer to take the path via the lower MED peering of 100 with +AS X. Setting the MED allows an AS to influence the routing taken to it +within another, neighbouring AS. + +In this use of MED it is not really meaningful to compare the MED value on +routes where the next AS on the paths differs. E.g., if AS Y also had a +route for some destination via AS Z in addition to the routes from AS X, and +AS Z had also set a MED, it wouldn't make sense for AS Y to compare AS Z's +MED values to those of AS X. The MED values have been set by different +administrators, with different frames of reference. + +The default behaviour of BGP therefore is to not compare MED values across +routes received from different neighbouring ASes. In Frr this is done by +comparing the neighbouring, left-most AS in the received AS_PATHs of the +routes and only comparing MED if those are the same. + +@ifnottex +@macro mprec{} +@math{<} +@end macro +@end ifnottex + +Unfortunately, this behaviour of MED, of sometimes being compared across +routes and sometimes not, depending on the properties of those other routes, +means MED can cause the order of preference over all the routes to be +undefined. That is, given routes A, B, and C, if A is preferred to B, and B +is preferred to C, then a well-defined order should mean the preference is +transitive (in the sense of orders @footnote{For some set of objects to have +an order, there *must* be some binary ordering relation that is defined +for *every* combination of those objects, and that relation *must* +be transitive. I.e.@:, if the relation operator is @mprec{}, and if +a @mprec{} b and b @mprec{} c then that relation must carry over +and it *must* be that a @mprec{} c for the objects to have an +order. The ordering relation may allow for equality, i.e. +a @mprec{} b and b @mprec{} a may both be true amd imply that +a and b are equal in the order and not distinguished by it, in +which case the set has a partial order. Otherwise, if there is an order, +all the objects have a distinct place in the order and the set has a total +order.}) and that A would be preferred to C. + +However, when MED is involved this need not be the case. With MED it is +possible that C is actually preferred over A. So A is preferred to B, B is +preferred to C, but C is preferred to A. This can be true even where BGP +defines a deterministic 'most preferred' route out of the full set of +A,B,C. With MED, for any given set of routes there may be a +deterministically preferred route, but there need not be any way to arrange +them into any order of preference. With unmodified MED, the order of +preference of routes literally becomes undefined. + +That MED can induce non-transitive preferences over routes can cause issues. +Firstly, it may be perceived to cause routing table churn locally at +speakers; secondly, and more seriously, it may cause routing instability in +iBGP topologies, where sets of speakers continually oscillate between +different paths. + +The first issue arises from how speakers often implement routing decisions. +Though BGP defines a selection process that will deterministically select +the same route as best at any given speaker, even with MED, that process +requires evaluating all routes together. For performance and ease of +implementation reasons, many implementations evaluate route preferences in a +pair-wise fashion instead. Given there is no well-defined order when MED is +involved, the best route that will be chosen becomes subject to +implementation details, such as the order the routes are stored in. That +may be (locally) non-deterministic, e.g.@: it may be the order the routes +were received in. + +This indeterminism may be considered undesirable, though it need not cause +problems. It may mean additional routing churn is perceived, as sometimes +more updates may be produced than at other times in reaction to some event . + +This first issue can be fixed with a more deterministic route selection that +ensures routes are ordered by the neighbouring AS during selection. +:ref:`bgp_deterministic-med`. This may reduce the number of updates as +routes are received, and may in some cases reduce routing churn. Though, it +could equally deterministically produce the largest possible set of updates +in response to the most common sequence of received updates. + +A deterministic order of evaluation tends to imply an additional overhead of +sorting over any set of n routes to a destination. The implementation of +deterministic MED in Frr scales significantly worse than most sorting +algorithms at present, with the number of paths to a given destination. +That number is often low enough to not cause any issues, but where there are +many paths, the deterministic comparison may quickly become increasingly +expensive in terms of CPU. + +Deterministic local evaluation can *not* fix the second, more major, +issue of MED however. Which is that the non-transitive preference of routes +MED can cause may lead to routing instability or oscillation across multiple +speakers in iBGP topologies. This can occur with full-mesh iBGP, but is +particularly problematic in non-full-mesh iBGP topologies that further +reduce the routing information known to each speaker. This has primarily +been documented with iBGP route-reflection topologies. However, any +route-hiding technologies potentially could also exacerbate oscillation with +MED. + +This second issue occurs where speakers each have only a subset of routes, +and there are cycles in the preferences between different combinations of +routes - as the undefined order of preference of MED allows - and the routes +are distributed in a way that causes the BGP speakers to 'chase' those +cycles. This can occur even if all speakers use a deterministic order of +evaluation in route selection. + +E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and +from speaker 3 in AS Y; while speaker 5 in AS A might receive that route +from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 +at speaker 3. I.e, using ASN:ID:MED to label the speakers: + +:: + + /---------------\\ + X:2------|--A:4-------A:5--|-Y:1:200 + Y:3:100--|-/ | + \\---------------/ + + + +Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then +based on the RFC4271 decision process speaker 4 will choose X:2 over +Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. +Speaker 5 will continue to prefer Y:1:200 based on the ID, and advertise +this to speaker 4. Speaker 4 will now have the full set of routes, and the +Y:1:200 it receives from 5 will beat X:2, but when speaker 4 compares +Y:1:200 to Y:3:100 the MED check now becomes active as the ASes match, and +now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5, +which will also agrees that Y:3:100 is preferred to Y:1:200, and so +withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100, +and X:2 beats Y:3:100, and so speaker 4 implicitly updates its route to +speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID, +and advertises Y:1:200 to speaker 4, and the cycle continues. + +The root cause is the lack of a clear order of preference caused by how MED +sometimes is and sometimes is not compared, leading to this cycle in the +preferences between the routes: + +:: + + /---> X:2 ---beats---> Y:3:100 --\\ + | | + | | + \\---beats--- Y:1:200 <---beats---/ + + + +This particular type of oscillation in full-mesh iBGP topologies can be +avoided by speakers preferring already selected, external routes rather than +choosing to update to new a route based on a post-MED metric (e.g. +router-ID), at the cost of a non-deterministic selection process. Frr +implements this, as do many other implementations, so long as it is not +overridden by setting :ref:`bgp_bestpath_compare-routerid`, and see also +:ref:`BGP_decision_process`, . + +However, more complex and insidious cycles of oscillation are possible with +iBGP route-reflection, which are not so easily avoided. These have been +documented in various places. See, e.g., @cite{McPherson, D. and Gill, V. +and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation +Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable +and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong, +"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete +examples and further references. + +There is as of this writing *no* known way to use MED for its original +purpose; *and* reduce routing information in iBGP topologies; +*and* be sure to avoid the instability problems of MED due the +non-transitive routing preferences it can induce; in general on arbitrary +networks. + +There may be iBGP topology specific ways to reduce the instability risks, +even while using MED, e.g.@: by constraining the reflection topology and by +tuning IGP costs between route-reflector clusters, see RFC3345 for details. +In the near future, the Add-Path extension to BGP may also solve MED +oscillation while still allowing MED to be used as intended, by distributing +"best-paths per neighbour AS". This would be at the cost of distributing at +least as many routes to all speakers as a full-mesh iBGP would, if not more, +while also imposing similar CPU overheads as the "Deterministic MED" feature +at each Add-Path reflector. + +More generally, the instability problems that MED can introduce on more +complex, non-full-mesh, iBGP topologies may be avoided either by: + + +* + Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared + across values set by different neighbour ASes, which may not produce + coherent desirable results, of itself. + +* + Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using + :ref:`routemap_set_metric` on all received routes, in combination with + setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest + and most performant way to avoid MED oscillation issues, where an AS is happy + not to allow neighbours to inject this problematic metric. + + +As MED is evaluated after the AS_PATH length check, another possible use for +MED is for intra-AS steering of routes with equal AS_PATH length, as an +extension of the last case above. As MED is evaluated before IGP metric, +this can allow cold-potato routing to be implemented to send traffic to +preferred hand-offs with neighbours, rather than the closest hand-off +according to the IGP metric. + +Note that even if action is taken to address the MED non-transitivity +issues, other oscillations may still be possible. E.g., on IGP cost if +iBGP and IGP topologies are at cross-purposes with each other - see the +Flavel and Roughan paper above for an example. Hence the guideline that the +iBGP topology should follow the IGP topology. + +.. index:: {BGP} {bgp deterministic-med} {} + +{BGP} {bgp deterministic-med} {} + .. _bgp_deterministic-med: + + Carry out route-selection in way that produces deterministic answers + locally, even in the face of MED and the lack of a well-defined order of + preference it can induce on routes. Without this option the preferred route + with MED may be determined largely by the order that routes were received + in. + + Setting this option will have a performance cost that may be noticeable when + there are many routes for each destination. Currently in Frr it is + implemented in a way that scales poorly as the number of routes per + destination increases. + + The default is that this option is not set. + +Note that there are other sources of indeterminism in the route selection +process, specifically, the preference for older and already selected routes +from eBGP peers, :ref:`BGP_decision_process`. + +.. index:: {BGP} {bgp always-compare-med} {} + +{BGP} {bgp always-compare-med} {} + .. _bgp_always-compare-med: + + Always compare the MED on routes, even when they were received from + different neighbouring ASes. Setting this option makes the order of + preference of routes more defined, and should eliminate MED induced + oscillations. + + If using this option, it may also be desirable to use :ref:`routemap_set_metric` to set MED to 0 on routes received from external neighbours. + + This option can be used, together with :ref:`routemap_set_metric` to use MED + as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired + exit points. + +.. _BGP_network: + +BGP network +=========== + + +.. _BGP_route: + +BGP route +--------- + +.. index:: {BGP} {network `A.B.C.D/M`} {} + +{BGP} {network `A.B.C.D/M`} {} + This command adds the announcement network.:: + + @group + router bgp 1 + address-family ipv4 unicast + network 10.0.0.0/8 + exit-address-family + @end group + + This configuration example says that network 10.0.0.0/8 will be + announced to all neighbors. Some vendors' routers don't advertise + routes if they aren't present in their IGP routing tables; `bgpd` + doesn't care about IGP routes when announcing its routes. + +.. index:: {BGP} {no network `A.B.C.D/M`} {} + +{BGP} {no network `A.B.C.D/M`} {} + +.. _Route_Aggregation: + +Route Aggregation +----------------- + +.. index:: {BGP} {aggregate-address `A.B.C.D/M`} {} + +{BGP} {aggregate-address `A.B.C.D/M`} {} + This command specifies an aggregate address. + +.. index:: {BGP} {aggregate-address `A.B.C.D/M` as-set} {} + +{BGP} {aggregate-address `A.B.C.D/M` as-set} {} + This command specifies an aggregate address. Resulting routes include + AS set. + +.. index:: {BGP} {aggregate-address `A.B.C.D/M` summary-only} {} + +{BGP} {aggregate-address `A.B.C.D/M` summary-only} {} + This command specifies an aggregate address. Aggreated routes will + not be announce. + +.. index:: {BGP} {no aggregate-address `A.B.C.D/M`} {} + +{BGP} {no aggregate-address `A.B.C.D/M`} {} + +.. _Redistribute_to_BGP: + +Redistribute to BGP +------------------- + +.. index:: {BGP} {redistribute kernel} {} + +{BGP} {redistribute kernel} {} + Redistribute kernel route to BGP process. + +.. index:: {BGP} {redistribute static} {} + +{BGP} {redistribute static} {} + Redistribute static route to BGP process. + +.. index:: {BGP} {redistribute connected} {} + +{BGP} {redistribute connected} {} + Redistribute connected route to BGP process. + +.. index:: {BGP} {redistribute rip} {} + +{BGP} {redistribute rip} {} + Redistribute RIP route to BGP process. + +.. index:: {BGP} {redistribute ospf} {} + +{BGP} {redistribute ospf} {} + Redistribute OSPF route to BGP process. + +.. index:: {BGP} {redistribute vpn} {} + +{BGP} {redistribute vpn} {} + Redistribute VNC routes to BGP process. + +.. index:: {BGP} {update-delay `max-delay`} {} + +{BGP} {update-delay `max-delay`} {} +.. index:: {BGP} {update-delay `max-delay` `establish-wait`} {} + +{BGP} {update-delay `max-delay` `establish-wait`} {} + This feature is used to enable read-only mode on BGP process restart or when + BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only mode + would begin as soon as the first peer reaches Established status and a timer + for max-delay seconds is started. + + During this mode BGP doesn't run any best-path or generate any updates to its + peers. This mode continues until: + 1. All the configured peers, except the shutdown peers, have sent explicit EOR + (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached + Established is considered an implicit-EOR. + If the establish-wait optional value is given, then BGP will wait for + peers to reach established from the begining of the update-delay till the + establish-wait period is over, i.e. the minimum set of established peers for + which EOR is expected would be peers established during the establish-wait + window, not necessarily all the configured neighbors. + 2. max-delay period is over. + On hitting any of the above two conditions, BGP resumes the decision process + and generates updates to its peers. + + Default max-delay is 0, i.e. the feature is off by default. + +.. index:: {BGP} {table-map `route-map-name`} {} + +{BGP} {table-map `route-map-name`} {} + This feature is used to apply a route-map on route updates from BGP to Zebra. + All the applicable match operations are allowed, such as match on prefix, + next-hop, communities, etc. Set operations for this attach-point are limited + to metric and next-hop only. Any operation of this feature does not affect + BGPs internal RIB. + + Supported for ipv4 and ipv6 address families. It works on multi-paths as well, + however, metric setting is based on the best-path only. + +.. _BGP_Peer: + +BGP Peer +======== + + +.. _Defining_Peer: + +Defining Peer +------------- + +.. index:: {BGP} {neighbor `peer` remote-as `asn`} {} + +{BGP} {neighbor `peer` remote-as `asn`} {} + Creates a new neighbor whose remote-as is `asn`. `peer` + can be an IPv4 address or an IPv6 address.:: + + @group + router bgp 1 + neighbor 10.0.0.1 remote-as 2 + @end group + + In this case my router, in AS-1, is trying to peer with AS-2 at + 10.0.0.1. + + This command must be the first command used when configuring a neighbor. + If the remote-as is not specified, *bgpd* will complain like this::: + + can't find neighbor 10.0.0.1 + + +.. _BGP_Peer_commands: + +BGP Peer commands +----------------- + +In a `router bgp` clause there are neighbor specific configurations +required. + +.. index:: {BGP} {neighbor `peer` shutdown} {} + +{BGP} {neighbor `peer` shutdown} {} +.. index:: {BGP} {no neighbor `peer` shutdown} {} + +{BGP} {no neighbor `peer` shutdown} {} + Shutdown the peer. We can delete the neighbor's configuration by + `no neighbor `peer` remote-as @var{as-number`} but all + configuration of the neighbor will be deleted. When you want to + preserve the configuration, but want to drop the BGP peer, use this + syntax. + +.. index:: {BGP} {neighbor `peer` ebgp-multihop} {} + +{BGP} {neighbor `peer` ebgp-multihop} {} +.. index:: {BGP} {no neighbor `peer` ebgp-multihop} {} + +{BGP} {no neighbor `peer` ebgp-multihop} {} +.. index:: {BGP} {neighbor `peer` description ...} {} + +{BGP} {neighbor `peer` description ...} {} +.. index:: {BGP} {no neighbor `peer` description ...} {} + +{BGP} {no neighbor `peer` description ...} {} + Set description of the peer. + +.. index:: {BGP} {neighbor `peer` version `version`} {} + +{BGP} {neighbor `peer` version `version`} {} + Set up the neighbor's BGP version. `version` can be `4`, + `4+` or `4-`. BGP version `4` is the default value used for + BGP peering. BGP version `4+` means that the neighbor supports + Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but + the neighbor speaks the old Internet-Draft revision 00's Multiprotocol + Extensions for BGP-4. Some routing software is still using this + version. + +.. index:: {BGP} {neighbor `peer` interface `ifname`} {} + +{BGP} {neighbor `peer` interface `ifname`} {} +.. index:: {BGP} {no neighbor `peer` interface `ifname`} {} + +{BGP} {no neighbor `peer` interface `ifname`} {} + When you connect to a BGP peer over an IPv6 link-local address, you + have to specify the `ifname` of the interface used for the + connection. To specify IPv4 session addresses, see the + `neighbor `peer` update-source` command below. + + This command is deprecated and may be removed in a future release. Its + use should be avoided. + +.. index:: {BGP} {neighbor `peer` next-hop-self [all]} {} + +{BGP} {neighbor `peer` next-hop-self [all]} {} +.. index:: {BGP} {no neighbor `peer` next-hop-self [all]} {} + +{BGP} {no neighbor `peer` next-hop-self [all]} {} + This command specifies an announced route's nexthop as being equivalent + to the address of the bgp router if it is learned via eBGP. + If the optional keyword `all` is specified the modifiation is done + also for routes learned via iBGP. + +.. index:: {BGP} {neighbor `peer` update-source ``} {} + +{BGP} {neighbor `peer` update-source ``} {} +.. index:: {BGP} {no neighbor `peer` update-source} {} + +{BGP} {no neighbor `peer` update-source} {} + Specify the IPv4 source address to use for the @acronym{BGP} session to this + neighbour, may be specified as either an IPv4 address directly or + as an interface name (in which case the *zebra* daemon MUST be running + in order for *bgpd* to be able to retrieve interface state).:: + + @group + router bgp 64555 + neighbor foo update-source 192.168.0.1 + neighbor bar update-source lo0 + @end group + + +.. index:: {BGP} {neighbor `peer` default-originate} {} + +{BGP} {neighbor `peer` default-originate} {} +.. index:: {BGP} {no neighbor `peer` default-originate} {} + +{BGP} {no neighbor `peer` default-originate} {} + *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it + is in routing table. When you want to announce default routes to the + peer, use this command. + +.. index:: {BGP} {neighbor `peer` port `port`} {} + +{BGP} {neighbor `peer` port `port`} {} +.. index:: {BGP} {neighbor `peer` port `port`} {} + +{BGP} {neighbor `peer` port `port`} {} +.. index:: {BGP} {neighbor `peer` send-community} {} + +{BGP} {neighbor `peer` send-community} {} +.. index:: {BGP} {neighbor `peer` send-community} {} + +{BGP} {neighbor `peer` send-community} {} +.. index:: {BGP} {neighbor `peer` weight `weight`} {} + +{BGP} {neighbor `peer` weight `weight`} {} +.. index:: {BGP} {no neighbor `peer` weight `weight`} {} + +{BGP} {no neighbor `peer` weight `weight`} {} + This command specifies a default `weight` value for the neighbor's + routes. + +.. index:: {BGP} {neighbor `peer` maximum-prefix `number`} {} + +{BGP} {neighbor `peer` maximum-prefix `number`} {} +.. index:: {BGP} {no neighbor `peer` maximum-prefix `number`} {} + +{BGP} {no neighbor `peer` maximum-prefix `number`} {} +.. index:: {BGP} {neighbor `peer` local-as `as-number`} {} + +{BGP} {neighbor `peer` local-as `as-number`} {} +.. index:: {BGP} {neighbor `peer` local-as `as-number` no-prepend} {} + +{BGP} {neighbor `peer` local-as `as-number` no-prepend} {} +.. index:: {BGP} {neighbor `peer` local-as `as-number` no-prepend replace-as} {} + +{BGP} {neighbor `peer` local-as `as-number` no-prepend replace-as} {} +.. index:: {BGP} {no neighbor `peer` local-as} {} + +{BGP} {no neighbor `peer` local-as} {} + Specify an alternate AS for this BGP process when interacting with the + specified peer. With no modifiers, the specified local-as is prepended to + the received AS_PATH when receiving routing updates from the peer, and + prepended to the outgoing AS_PATH (after the process local AS) when + transmitting local routes to the peer. + + If the no-prepend attribute is specified, then the supplied local-as is not + prepended to the received AS_PATH. + + If the replace-as attribute is specified, then only the supplied local-as is + prepended to the AS_PATH when transmitting local-route updates to this peer. + + Note that replace-as can only be specified if no-prepend is. + + This command is only allowed for eBGP peers. + +.. index:: {BGP} {neighbor `peer` ttl-security hops `number`} {} + +{BGP} {neighbor `peer` ttl-security hops `number`} {} +.. index:: {BGP} {no neighbor `peer` ttl-security hops `number`} {} + +{BGP} {no neighbor `peer` ttl-security hops `number`} {} + This command enforces Generalized TTL Security Mechanism (GTSM), as + specified in RFC 5082. With this command, only neighbors that are the + specified number of hops away will be allowed to become neighbors. This + command is mututally exclusive with *ebgp-multihop*. + +.. _Peer_filtering: + +Peer filtering +-------------- + +.. index:: {BGP} {neighbor `peer` distribute-list `name` [in|out]} {} + +{BGP} {neighbor `peer` distribute-list `name` [in|out]} {} + This command specifies a distribute-list for the peer. `direct` is + @samp{in} or @samp{out}. + +.. index:: {BGP command} {neighbor `peer` prefix-list `name` [in|out]} {} + +{BGP command} {neighbor `peer` prefix-list `name` [in|out]} {} +.. index:: {BGP command} {neighbor `peer` filter-list `name` [in|out]} {} + +{BGP command} {neighbor `peer` filter-list `name` [in|out]} {} +.. index:: {BGP} {neighbor `peer` route-map `name` [in|out]} {} + +{BGP} {neighbor `peer` route-map `name` [in|out]} {} + Apply a route-map on the neighbor. `direct` must be `in` or + `out`. + +.. index:: {BGP} {bgp route-reflector allow-outbound-policy} {} + +{BGP} {bgp route-reflector allow-outbound-policy} {} + By default, attribute modification via route-map policy out is not reflected + on reflected routes. This option allows the modifications to be reflected as + well. Once enabled, it affects all reflected routes. + +.. _BGP_Peer_Group: + +BGP Peer Group +============== + +.. index:: {BGP} {neighbor `word` peer-group} {} + +{BGP} {neighbor `word` peer-group} {} + This command defines a new peer group. + +.. index:: {BGP} {neighbor `peer` peer-group `word`} {} + +{BGP} {neighbor `peer` peer-group `word`} {} + This command bind specific peer to peer group `word`. + +.. _BGP_Address_Family: + +BGP Address Family +================== + +Multiprotocol BGP enables BGP to carry routing information for multiple +Network Layer protocols. BGP supports multiple Address Family +Identifier (AFI), namely IPv4 and IPv6. Support is also provided for +multiple sets of per-AFI information via Subsequent Address Family +Identifiers (SAFI). In addition to unicast information, VPN information +@cite{RFC4364} and @cite{RFC4659}, and Encapsulation information +@cite{RFC5512} is supported. + +.. index:: {Command} {show ip bgp vpnv4 all} {} + +{Command} {show ip bgp vpnv4 all} {} +.. index:: {Command} {show ipv6 bgp vpn all} {} + +{Command} {show ipv6 bgp vpn all} {} + Print active IPV4 or IPV6 routes advertised via the VPN SAFI. + +.. index:: {Command} {show ip bgp encap all} {} + +{Command} {show ip bgp encap all} {} +.. index:: {Command} {show ipv6 bgp encap all} {} + +{Command} {show ipv6 bgp encap all} {} + Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI. + +.. index:: {Command} {show bgp ipv4 encap summary} {} + +{Command} {show bgp ipv4 encap summary} {} +.. index:: {Command} {show bgp ipv4 vpn summary} {} + +{Command} {show bgp ipv4 vpn summary} {} +.. index:: {Command} {show bgp ipv6 encap summary} {} + +{Command} {show bgp ipv6 encap summary} {} +.. index:: {Command} {show bgp ipv6 vpn summary} {} + +{Command} {show bgp ipv6 vpn summary} {} + Print a summary of neighbor connections for the specified AFI/SAFI combination. + +.. _Autonomous_System: + +Autonomous System +================= + +The @acronym{AS,Autonomous System} number is one of the essential +element of BGP. BGP is a distance vector routing protocol, and the +AS-Path framework provides distance vector metric and loop detection to +BGP. @cite{RFC1930, Guidelines for creation, selection, and +registration of an Autonomous System (AS)} provides some background on +the concepts of an AS. + +The AS number is a two octet value, ranging in value from 1 to 65535. +The AS numbers 64512 through 65535 are defined as private AS numbers. +Private AS numbers must not to be advertised in the global Internet. + +.. _Display_BGP_Routes_by_AS_Path: + +Display BGP Routes by AS Path +----------------------------- + +To show BGP routes which has specific AS path information `show ip bgp` command can be used. + +.. index:: Command {show bgp {ipv4|ipv6} regexp `line`} {} + +Command {show bgp {ipv4|ipv6} regexp `line`} {} + This commands displays BGP routes that matches a regular + expression `line` (:ref:`BGP_Regular_Expressions`). + +.. _AS_Path_Access_List: + +AS Path Access List +------------------- + +AS path access list is user defined AS path. + +.. index:: {Command} {ip as-path access-list `word` {permit|deny} `line`} {} + +{Command} {ip as-path access-list `word` {permit|deny} `line`} {} + This command defines a new AS path access list. + +.. index:: {Command} {no ip as-path access-list `word`} {} + +{Command} {no ip as-path access-list `word`} {} +.. index:: {Command} {no ip as-path access-list `word` {permit|deny} `line`} {} + +{Command} {no ip as-path access-list `word` {permit|deny} `line`} {} + +.. _Using_AS_Path_in_Route_Map: + +Using AS Path in Route Map +-------------------------- + +.. index:: {Route Map} {match as-path `word`} {} + +{Route Map} {match as-path `word`} {} + +.. index:: {Route Map} {set as-path prepend `as-path`} {} + +{Route Map} {set as-path prepend `as-path`} {} + Prepend the given string of AS numbers to the AS_PATH. + +.. index:: {Route Map} {set as-path prepend last-as `num`} {} + +{Route Map} {set as-path prepend last-as `num`} {} + Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. + +.. _Private_AS_Numbers: + +Private AS Numbers +------------------ + + +.. _BGP_Communities_Attribute: + +BGP Communities Attribute +========================= + +BGP communities attribute is widely used for implementing policy +routing. Network operators can manipulate BGP communities attribute +based on their network policy. BGP communities attribute is defined +in @cite{RFC1997, BGP Communities Attribute} and +@cite{RFC1998, An Application of the BGP Community Attribute +in Multi-home Routing}. It is an optional transitive attribute, +therefore local policy can travel through different autonomous system. + +Communities attribute is a set of communities values. Each +communities value is 4 octet long. The following format is used to +define communities value. + + + +*AS:VAL* + This format represents 4 octet communities value. `AS` is high + order 2 octet in digit format. `VAL` is low order 2 octet in + digit format. This format is useful to define AS oriented policy + value. For example, `7675:80` can be used when AS 7675 wants to + pass local policy value 80 to neighboring peer. + +*internet* + `internet` represents well-known communities value 0. + +*no-export* + ``no-export`` represents well-known communities value ``NO_EXPORT`` @\* + @r{(0xFFFFFF01)}. All routes carry this value must not be advertised + to outside a BGP confederation boundary. If neighboring BGP peer is + part of BGP confederation, the peer is considered as inside a BGP + confederation boundary, so the route will be announced to the peer. + +*no-advertise* + ``no-advertise`` represents well-known communities value + ``NO_ADVERTISE`` @*@r{(0xFFFFFF02)}. All routes carry this value + must not be advertise to other BGP peers. + +*local-AS* + ``local-AS`` represents well-known communities value + ``NO_EXPORT_SUBCONFED`` @r{(0xFFFFFF03)}. All routes carry this + value must not be advertised to external BGP peers. Even if the + neighboring router is part of confederation, it is considered as + external BGP peer, so the route will not be announced to the peer. + +When BGP communities attribute is received, duplicated communities +value in the communities attribute is ignored and each communities +values are sorted in numerical order. + +.. _BGP_Community_Lists: + +BGP Community Lists +------------------- + +BGP community list is a user defined BGP communites attribute list. +BGP community list can be used for matching or manipulating BGP +communities attribute in updates. + +There are two types of community list. One is standard community +list and another is expanded community list. Standard community list +defines communities attribute. Expanded community list defines +communities attribute string with regular expression. Standard +community list is compiled into binary format when user define it. +Standard community list will be directly compared to BGP communities +attribute in BGP updates. Therefore the comparison is faster than +expanded community list. + +.. index:: Command {ip community-list standard `name` {permit|deny} `community`} {} + +Command {ip community-list standard `name` {permit|deny} `community`} {} + This command defines a new standard community list. `community` + is communities value. The `community` is compiled into community + structure. We can define multiple community list under same name. In + that case match will happen user defined order. Once the + community list matches to communities attribute in BGP updates it + return permit or deny by the community list definition. When there is + no matched entry, deny will be returned. When `community` is + empty it matches to any routes. + +.. index:: Command {ip community-list expanded `name` {permit|deny} `line`} {} + +Command {ip community-list expanded `name` {permit|deny} `line`} {} + This command defines a new expanded community list. `line` is a + string expression of communities attribute. `line` can be a + regular expression (:ref:`BGP_Regular_Expressions`) to match + the communities attribute in BGP updates. + +.. index:: Command {no ip community-list `name`} {} + +Command {no ip community-list `name`} {} +.. index:: Command {no ip community-list standard `name`} {} + +Command {no ip community-list standard `name`} {} +.. index:: Command {no ip community-list expanded `name`} {} + +Command {no ip community-list expanded `name`} {} + These commands delete community lists specified by `name`. All of + community lists shares a single name space. So community lists can be + removed simpley specifying community lists name. + +.. index:: {Command} {show ip community-list} {} + +{Command} {show ip community-list} {} +.. index:: {Command} {show ip community-list `name`} {} + +{Command} {show ip community-list `name`} {} + This command displays current community list information. When + `name` is specified the specified community list's information is + shown. + +:: + + # show ip community-list + Named Community standard list CLIST + permit 7675:80 7675:100 no-export + deny internet + Named Community expanded list EXPAND + permit : + + # show ip community-list CLIST + Named Community standard list CLIST + permit 7675:80 7675:100 no-export + deny internet + + +.. _Numbered_BGP_Community_Lists: + +Numbered BGP Community Lists +---------------------------- + +When number is used for BGP community list name, the number has +special meanings. Community list number in the range from 1 and 99 is +standard community list. Community list number in the range from 100 +to 199 is expanded community list. These community lists are called +as numbered community lists. On the other hand normal community lists +is called as named community lists. + +.. index:: Command {ip community-list <1-99> {permit|deny} `community`} {} + +Command {ip community-list <1-99> {permit|deny} `community`} {} + This command defines a new community list. <1-99> is standard + community list number. Community list name within this range defines + standard community list. When `community` is empty it matches to + any routes. + +.. index:: Command {ip community-list <100-199> {permit|deny} `community`} {} + +Command {ip community-list <100-199> {permit|deny} `community`} {} + This command defines a new community list. <100-199> is expanded + community list number. Community list name within this range defines + expanded community list. + +.. index:: Command {ip community-list `name` {permit|deny} `community`} {} + +Command {ip community-list `name` {permit|deny} `community`} {} + When community list type is not specifed, the community list type is + automatically detected. If `community` can be compiled into + communities attribute, the community list is defined as a standard + community list. Otherwise it is defined as an expanded community + list. This feature is left for backward compability. Use of this + feature is not recommended. + +.. _BGP_Community_in_Route_Map: + +BGP Community in Route Map +-------------------------- + +In Route Map (:ref:`Route_Map`), we can match or set BGP +communities attribute. Using this feature network operator can +implement their network policy based on BGP communities attribute. + +Following commands can be used in Route Map. + +.. index:: {Route Map} {match community `word`} {} + +{Route Map} {match community `word`} {} +.. index:: {Route Map} {match community `word` exact-match} {} + +{Route Map} {match community `word` exact-match} {} + This command perform match to BGP updates using community list + `word`. When the one of BGP communities value match to the one of + communities value in community list, it is match. When + `exact-match` keyword is spcified, match happen only when BGP + updates have completely same communities value specified in the + community list. + +.. index:: {Route Map} {set community none} {} + +{Route Map} {set community none} {} +.. index:: {Route Map} {set community `community`} {} + +{Route Map} {set community `community`} {} +.. index:: {Route Map} {set community `community` additive} {} + +{Route Map} {set community `community` additive} {} + This command manipulate communities value in BGP updates. When + `none` is specified as communities value, it removes entire + communities attribute from BGP updates. When `community` is not + `none`, specified communities value is set to BGP updates. If + BGP updates already has BGP communities value, the existing BGP + communities value is replaced with specified `community` value. + When `additive` keyword is specified, `community` is appended + to the existing communities value. + +.. index:: {Route Map} {set comm-list `word` delete} {} + +{Route Map} {set comm-list `word` delete} {} + This command remove communities value from BGP communities attribute. + The `word` is community list name. When BGP route's communities + value matches to the community list `word`, the communities value + is removed. When all of communities value is removed eventually, the + BGP update's communities attribute is completely removed. + +.. _Display_BGP_Routes_by_Community: + +Display BGP Routes by Community +------------------------------- + +To show BGP routes which has specific BGP communities attribute, +`show bgp {ipv4|ipv6}` command can be used. The +`community` and `community-list` subcommand can be used. + +.. index:: Command {show bgp {ipv4|ipv6} community} {} + +Command {show bgp {ipv4|ipv6} community} {} +.. index:: Command {show bgp {ipv4|ipv6} community `community`} {} + +Command {show bgp {ipv4|ipv6} community `community`} {} +.. index:: Command {show bgp {ipv4|ipv6} community `community` exact-match} {} + +Command {show bgp {ipv4|ipv6} community `community` exact-match} {} + `show bgp {ipv4|ipv6} community` displays BGP routes which has communities + attribute. Where the address family can be IPv4 or IPv6 among others. When + `community` is specified, BGP routes that matches `community` value is + displayed. For this command, `internet` keyword can't be used for + `community` value. When `exact-match` is specified, it display only + routes that have an exact match. + +.. index:: Command {show bgp {ipv4|ipv6} community-list `word`} {} + +Command {show bgp {ipv4|ipv6} community-list `word`} {} +.. index:: Command {show bgp {ipv4|ipv6} community-list `word` exact-match} {} + +Command {show bgp {ipv4|ipv6} community-list `word` exact-match} {} + This commands display BGP routes for the address family specified that matches + community list `word`. When `exact-match` is specified, display only + routes that have an exact match. + +.. _Using_BGP_Communities_Attribute: + +Using BGP Communities Attribute +------------------------------- + +Following configuration is the most typical usage of BGP communities +attribute. AS 7675 provides upstream Internet connection to AS 100. +When following configuration exists in AS 7675, AS 100 networks +operator can set local preference in AS 7675 network by setting BGP +communities attribute to the updates. + +:: + + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list 70 permit 7675:70 + ip community-list 70 deny + ip community-list 80 permit 7675:80 + ip community-list 80 deny + ip community-list 90 permit 7675:90 + ip community-list 90 deny + ! + route-map RMAP permit 10 + match community 70 + set local-preference 70 + ! + route-map RMAP permit 20 + match community 80 + set local-preference 80 + ! + route-map RMAP permit 30 + match community 90 + set local-preference 90 + + +Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675. +The route has communities value 7675:80 so when above configuration +exists in AS 7675, announced route's local preference will be set to +value 80. + +:: + + router bgp 100 + network 10.0.0.0/8 + neighbor 192.168.0.2 remote-as 7675 + address-family ipv4 unicast + neighbor 192.168.0.2 route-map RMAP out + exit-address-family + ! + ip prefix-list PLIST permit 10.0.0.0/8 + ! + route-map RMAP permit 10 + match ip address prefix-list PLIST + set community 7675:80 + + +Following configuration is an example of BGP route filtering using +communities attribute. This configuration only permit BGP routes +which has BGP communities value 0:80 or 0:90. Network operator can +put special internal communities value at BGP border router, then +limit the BGP routes announcement into the internal network. + +:: + + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list 1 permit 0:80 0:90 + ! + route-map RMAP permit in + match community 1 + + +Following exmaple filter BGP routes which has communities value 1:1. +When there is no match community-list returns deny. To avoid +filtering all of routes, we need to define permit any at last. + +:: + + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list standard FILTER deny 1:1 + ip community-list standard FILTER permit + ! + route-map RMAP permit 10 + match community FILTER + + +Communities value keyword `internet` has special meanings in +standard community lists. In below example `internet` act as +match any. It matches all of BGP routes even if the route does not +have communities attribute at all. So community list `INTERNET` +is same as above example's `FILTER`. + +:: + + ip community-list standard INTERNET deny 1:1 + ip community-list standard INTERNET permit internet + + +Following configuration is an example of communities value deletion. +With this configuration communities value 100:1 and 100:2 is removed +from BGP updates. For communities value deletion, only `permit` +community-list is used. `deny` community-list is ignored. + +:: + + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list standard DEL permit 100:1 100:2 + ! + route-map RMAP permit 10 + set comm-list DEL delete + + +.. _BGP_Extended_Communities_Attribute: + +BGP Extended Communities Attribute +================================== + +BGP extended communities attribute is introduced with MPLS VPN/BGP +technology. MPLS VPN/BGP expands capability of network infrastructure +to provide VPN functionality. At the same time it requires a new +framework for policy routing. With BGP Extended Communities Attribute +we can use Route Target or Site of Origin for implementing network +policy for MPLS VPN/BGP. + +BGP Extended Communities Attribute is similar to BGP Communities +Attribute. It is an optional transitive attribute. BGP Extended +Communities Attribute can carry multiple Extended Community value. +Each Extended Community value is eight octet length. + +BGP Extended Communities Attribute provides an extended range +compared with BGP Communities Attribute. Adding to that there is a +type field in each value to provides community space structure. + +There are two format to define Extended Community value. One is AS +based format the other is IP address based format. + + + +*AS:VAL* + This is a format to define AS based Extended Community value. + `AS` part is 2 octets Global Administrator subfield in Extended + Community value. `VAL` part is 4 octets Local Administrator + subfield. `7675:100` represents AS 7675 policy value 100. + +*IP-Address:VAL* + This is a format to define IP address based Extended Community value. + `IP-Address` part is 4 octets Global Administrator subfield. + `VAL` part is 2 octets Local Administrator subfield. + `10.0.0.1:100` represents + +.. _BGP_Extended_Community_Lists: + +BGP Extended Community Lists +---------------------------- + +Expanded Community Lists is a user defined BGP Expanded Community +Lists. + +.. index:: Command {ip extcommunity-list standard `name` {permit|deny} `extcommunity`} {} + +Command {ip extcommunity-list standard `name` {permit|deny} `extcommunity`} {} + This command defines a new standard extcommunity-list. + `extcommunity` is extended communities value. The + `extcommunity` is compiled into extended community structure. We + can define multiple extcommunity-list under same name. In that case + match will happen user defined order. Once the extcommunity-list + matches to extended communities attribute in BGP updates it return + permit or deny based upon the extcommunity-list definition. When + there is no matched entry, deny will be returned. When + `extcommunity` is empty it matches to any routes. + +.. index:: Command {ip extcommunity-list expanded `name` {permit|deny} `line`} {} + +Command {ip extcommunity-list expanded `name` {permit|deny} `line`} {} + This command defines a new expanded extcommunity-list. `line` is + a string expression of extended communities attribute. `line` can + be a regular expression (:ref:`BGP_Regular_Expressions`) to match an + extended communities attribute in BGP updates. + +.. index:: Command {no ip extcommunity-list `name`} {} + +Command {no ip extcommunity-list `name`} {} +.. index:: Command {no ip extcommunity-list standard `name`} {} + +Command {no ip extcommunity-list standard `name`} {} +.. index:: Command {no ip extcommunity-list expanded `name`} {} + +Command {no ip extcommunity-list expanded `name`} {} + These commands delete extended community lists specified by + `name`. All of extended community lists shares a single name + space. So extended community lists can be removed simpley specifying + the name. + +.. index:: {Command} {show ip extcommunity-list} {} + +{Command} {show ip extcommunity-list} {} +.. index:: {Command} {show ip extcommunity-list `name`} {} + +{Command} {show ip extcommunity-list `name`} {} + This command displays current extcommunity-list information. When + `name` is specified the community list's information is shown. + +:: + + # show ip extcommunity-list + + +.. _BGP_Extended_Communities_in_Route_Map: + +BGP Extended Communities in Route Map +------------------------------------- + +.. index:: {Route Map} {match extcommunity `word`} {} + +{Route Map} {match extcommunity `word`} {} + +.. index:: {Route Map} {set extcommunity rt `extcommunity`} {} + +{Route Map} {set extcommunity rt `extcommunity`} {} + This command set Route Target value. + +.. index:: {Route Map} {set extcommunity soo `extcommunity`} {} + +{Route Map} {set extcommunity soo `extcommunity`} {} + This command set Site of Origin value. + +.. _BGP_Large_Communities_Attribute: + +BGP Large Communities Attribute +=============================== + +The BGP Large Communities attribute was introduced in Feb 2017 with +@cite{RFC8092, BGP Large Communities Attribute}. + +The BGP Large Communities Attribute is similar to the BGP Communities +Attribute except that it has 3 components instead of two and each of +which are 4 octets in length. Large Communities bring additional +functionality and convenience over traditional communities, specifically +the fact that the `GLOBAL` part below is now 4 octets wide allowing +AS4 operators seamless use. + + + +*GLOBAL:LOCAL1:LOCAL2* + This is the format to define Large Community values. Referencing + @cite{RFC8195, Use of BGP Large Communities} the values are commonly + referred to as follows. + The `GLOBAL` part is a 4 octet Global Administrator field, common + use of this field is the operators AS number. + The `LOCAL1` part is a 4 octet Local Data Part 1 subfield referred + to as a function. + The `LOCAL2` part is a 4 octet Local Data Part 2 field and referred + to as the parameter subfield. `65551:1:10` represents AS 65551 + function 1 and parameter 10. + The referenced RFC above gives some guidelines on recommended usage. + +.. _BGP_Large_Community_Lists: + +BGP Large Community Lists +------------------------- + +Two types of large community lists are supported, namely `standard` and +`expanded`. + +.. index:: Command {ip large-community-list standard `name` {permit|deny} `large-community`} {} + +Command {ip large-community-list standard `name` {permit|deny} `large-community`} {} + This command defines a new standard large-community-list. + `large-community` is the Large Community value. We + can add multiple large communities under same name. In that case + the match will happen in the user defined order. Once the large-community-list + matches the Large Communities attribute in BGP updates it will return + permit or deny based upon the large-community-list definition. When + there is no matched entry, a deny will be returned. When `large-community` + is empty it matches any routes. + +.. index:: Command {ip large-community-list expanded `name` {permit|deny} `line`} {} + +Command {ip large-community-list expanded `name` {permit|deny} `line`} {} + This command defines a new expanded large-community-list. Where `line` is + a string matching expression, it will be compared to the entire Large Communities + attribute as a string, with each large-community in order from lowest to highest. + `line` can also be a regular expression which matches this Large + Community attribute. + +.. index:: Command {no ip large-community-list `name`} {} + +Command {no ip large-community-list `name`} {} +.. index:: Command {no ip large-community-list standard `name`} {} + +Command {no ip large-community-list standard `name`} {} +.. index:: Command {no ip large-community-list expanded `name`} {} + +Command {no ip large-community-list expanded `name`} {} + These commands delete Large Community lists specified by + `name`. All Large Community lists share a single namespace. + This means Large Community lists can be removed by simply specifying the name. + +.. index:: {Command} {show ip large-community-list} {} + +{Command} {show ip large-community-list} {} +.. index:: {Command} {show ip large-community-list `name`} {} + +{Command} {show ip large-community-list `name`} {} + This command display current large-community-list information. When + `name` is specified the community list information is shown. + +.. index:: {Command} {show ip bgp large-community-info} {} + +{Command} {show ip bgp large-community-info} {} + This command displays the current large communities in use. + +.. _BGP_Large_Communities_in_Route_Map: + +BGP Large Communities in Route Map +---------------------------------- + +.. index:: {Route Map} {match large-community `line`} {} + +{Route Map} {match large-community `line`} {} + Where `line` can be a simple string to match, or a regular expression. + It is very important to note that this match occurs on the entire + large-community string as a whole, where each large-community is ordered + from lowest to highest. + +.. index:: {Route Map} {set large-community `large-community`} {} + +{Route Map} {set large-community `large-community`} {} +.. index:: {Route Map} {set large-community `large-community` `large-community`} {} + +{Route Map} {set large-community `large-community` `large-community`} {} +.. index:: {Route Map} {set large-community `large-community` additive} {} + +{Route Map} {set large-community `large-community` additive} {} + These commands are used for setting large-community values. The first + command will overwrite any large-communities currently present. + The second specifies two large-communities, which overwrites the current + large-community list. The third will add a large-community value without + overwriting other values. Multiple large-community values can be specified. + +.. _Displaying_BGP_information: + +Displaying BGP information +========================== + + +.. _Showing_BGP_information: + +Showing BGP information +----------------------- + +.. index:: {Command} {show ip bgp} {} + +{Command} {show ip bgp} {} +.. index:: {Command} {show ip bgp `A.B.C.D`} {} + +{Command} {show ip bgp `A.B.C.D`} {} +.. index:: {Command} {show ip bgp `X:X::X:X`} {} + +{Command} {show ip bgp `X:X::X:X`} {} + This command displays BGP routes. When no route is specified it + display all of IPv4 BGP routes. + +:: + + BGP table version is 0, local router ID is 10.1.1.1 + Status codes: s suppressed, d damped, h history, * valid, > best, i - internal + Origin codes: i - IGP, e - EGP, ? - incomplete + + Network Next Hop Metric LocPrf Weight Path + *> 1.1.1.1/32 0.0.0.0 0 32768 i + + Total number of prefixes 1 + + +.. index:: {Command} {show ip bgp regexp `line`} {} + +{Command} {show ip bgp regexp `line`} {} + This command displays BGP routes using AS path regular expression + (:ref:`BGP_Regular_Expressions`). + +.. index:: Command {show ip bgp community `community`} {} + +Command {show ip bgp community `community`} {} +.. index:: Command {show ip bgp community `community` exact-match} {} + +Command {show ip bgp community `community` exact-match} {} + This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). + +.. index:: Command {show ip bgp community-list `word`} {} + +Command {show ip bgp community-list `word`} {} +.. index:: Command {show ip bgp community-list `word` exact-match} {} + +Command {show ip bgp community-list `word` exact-match} {} + This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). + +.. index:: {Command} {show bgp {ipv4|ipv6} summary} {} + +{Command} {show bgp {ipv4|ipv6} summary} {} + Show a bgp peer summary for the specified address family. + +.. index:: {Command} {show bgp {ipv4|ipv6} neighbor [`peer`]} {} + +{Command} {show bgp {ipv4|ipv6} neighbor [`peer`]} {} + This command shows information on a specific BGP `peer`. + +.. index:: {Command} {show bgp {ipv4|ipv6} dampening dampened-paths} {} + +{Command} {show bgp {ipv4|ipv6} dampening dampened-paths} {} + Display paths suppressed due to dampening. + +.. index:: {Command} {show bgp {ipv4|ipv6} dampening flap-statistics} {} + +{Command} {show bgp {ipv4|ipv6} dampening flap-statistics} {} + Display flap statistics of routes. + +.. _Other_BGP_commands: + +Other BGP commands +------------------ + +.. index:: {Command} {clear bgp {ipv4|ipv6} \*} {} + +{Command} {clear bgp {ipv4|ipv6} \*} {} + Clear all address family peers. + +.. index:: {Command} {clear bgp {ipv4|ipv6} `peer`} {} + +{Command} {clear bgp {ipv4|ipv6} `peer`} {} + Clear peers which have addresses of X.X.X.X + +.. index:: {Command} {clear bgp {ipv4|ipv6} `peer` soft in} {} + +{Command} {clear bgp {ipv4|ipv6} `peer` soft in} {} + Clear peer using soft reconfiguration. + +.. index:: {Command} {show debug} {} + +{Command} {show debug} {} +.. index:: {Command} {debug event} {} + +{Command} {debug event} {} +.. index:: {Command} {debug update} {} + +{Command} {debug update} {} +.. index:: {Command} {debug keepalive} {} + +{Command} {debug keepalive} {} +.. index:: {Command} {no debug event} {} + +{Command} {no debug event} {} +.. index:: {Command} {no debug update} {} + +{Command} {no debug update} {} +.. index:: {Command} {no debug keepalive} {} + +{Command} {no debug keepalive} {} + +.. _Capability_Negotiation: + +Capability Negotiation +====================== + +When adding IPv6 routing information exchange feature to BGP. There +were some proposals. @acronym{IETF,Internet Engineering Task Force} +@acronym{IDR, Inter Domain Routing} @acronym{WG, Working group} adopted +a proposal called Multiprotocol Extension for BGP. The specification +is described in @cite{RFC2283}. The protocol does not define new protocols. +It defines new attributes to existing BGP. When it is used exchanging +IPv6 routing information it is called BGP-4+. When it is used for +exchanging multicast routing information it is called MBGP. + +*bgpd* supports Multiprotocol Extension for BGP. So if remote +peer supports the protocol, *bgpd* can exchange IPv6 and/or +multicast routing information. + +Traditional BGP did not have the feature to detect remote peer's +capabilities, e.g. whether it can handle prefix types other than IPv4 +unicast routes. This was a big problem using Multiprotocol Extension +for BGP to operational network. @cite{RFC2842, Capabilities +Advertisement with BGP-4} adopted a feature called Capability +Negotiation. *bgpd* use this Capability Negotiation to detect +the remote peer's capabilities. If the peer is only configured as IPv4 +unicast neighbor, *bgpd* does not send these Capability +Negotiation packets (at least not unless other optional BGP features +require capability negotation). + +By default, Frr will bring up peering with minimal common capability +for the both sides. For example, local router has unicast and +multicast capabilitie and remote router has unicast capability. In +this case, the local router will establish the connection with unicast +only capability. When there are no common capabilities, Frr sends +Unsupported Capability error and then resets the connection. + +If you want to completely match capabilities with remote peer. Please +use *strict-capability-match* command. + +.. index:: {BGP} {neighbor `peer` strict-capability-match} {} + +{BGP} {neighbor `peer` strict-capability-match} {} +.. index:: {BGP} {no neighbor `peer` strict-capability-match} {} + +{BGP} {no neighbor `peer` strict-capability-match} {} + Strictly compares remote capabilities and local capabilities. If capabilities + are different, send Unsupported Capability error then reset connection. + + You may want to disable sending Capability Negotiation OPEN message + optional parameter to the peer when remote peer does not implement + Capability Negotiation. Please use *dont-capability-negotiate* + command to disable the feature. + +.. index:: {BGP} {neighbor `peer` dont-capability-negotiate} {} + +{BGP} {neighbor `peer` dont-capability-negotiate} {} +.. index:: {BGP} {no neighbor `peer` dont-capability-negotiate} {} + +{BGP} {no neighbor `peer` dont-capability-negotiate} {} + Suppress sending Capability Negotiation as OPEN message optional + parameter to the peer. This command only affects the peer is configured + other than IPv4 unicast configuration. + + When remote peer does not have capability negotiation feature, remote + peer will not send any capabilities at all. In that case, bgp + configures the peer with configured capabilities. + + You may prefer locally configured capabilities more than the negotiated + capabilities even though remote peer sends capabilities. If the peer + is configured by *override-capability*, *bgpd* ignores + received capabilities then override negotiated capabilities with + configured values. + +.. index:: {BGP} {neighbor `peer` override-capability} {} + +{BGP} {neighbor `peer` override-capability} {} +.. index:: {BGP} {no neighbor `peer` override-capability} {} + +{BGP} {no neighbor `peer` override-capability} {} + Override the result of Capability Negotiation with local configuration. + Ignore remote peer's capability value. + +.. _Route_Reflector: + +Route Reflector +=============== + +.. index:: {BGP} {bgp cluster-id `a.b.c.d`} {} + +{BGP} {bgp cluster-id `a.b.c.d`} {} + +.. index:: {BGP} {neighbor `peer` route-reflector-client} {} + +{BGP} {neighbor `peer` route-reflector-client} {} +.. index:: {BGP} {no neighbor `peer` route-reflector-client} {} + +{BGP} {no neighbor `peer` route-reflector-client} {} + +.. _Route_Server: + +Route Server +============ + +At an Internet Exchange point, many ISPs are connected to each other by +external BGP peering. Normally these external BGP connection are done by +@samp{full mesh} method. As with internal BGP full mesh formation, +this method has a scaling problem. + +This scaling problem is well known. Route Server is a method to resolve +the problem. Each ISP's BGP router only peers to Route Server. Route +Server serves as BGP information exchange to other BGP routers. By +applying this method, numbers of BGP connections is reduced from +O(n*(n-1)/2) to O(n). + +Unlike normal BGP router, Route Server must have several routing tables +for managing different routing policies for each BGP speaker. We call the +routing tables as different ``view`` s. *bgpd* can work as +normal BGP router or Route Server or both at the same time. + +.. _Multiple_instance: + +Multiple instance +----------------- + +To enable multiple view function of `bgpd`, you must turn on +multiple instance feature beforehand. + +.. index:: {Command} {bgp multiple-instance} {} + +{Command} {bgp multiple-instance} {} + Enable BGP multiple instance feature. After this feature is enabled, + you can make multiple BGP instances or multiple BGP views. + +.. index:: {Command} {no bgp multiple-instance} {} + +{Command} {no bgp multiple-instance} {} + Disable BGP multiple instance feature. You can not disable this feature + when BGP multiple instances or views exist. + +When you want to make configuration more Cisco like one, + +.. index:: {Command} {bgp config-type cisco} {} + +{Command} {bgp config-type cisco} {} + Cisco compatible BGP configuration output. + +When bgp config-type cisco is specified, + +'no synchronization' is displayed. +'no auto-summary' is displayed. + +'network' and 'aggregate-address' argument is displayed as +'A.B.C.D M.M.M.M' + +Frr: network 10.0.0.0/8 +Cisco: network 10.0.0.0 + +Frr: aggregate-address 192.168.0.0/24 +Cisco: aggregate-address 192.168.0.0 255.255.255.0 + +Community attribute handling is also different. If there is no +configuration is specified community attribute and extended community +attribute are sent to neighbor. When user manually disable the +feature community attribute is not sent to the neighbor. In case of +*bgp config-type cisco* is specified, community attribute is not +sent to the neighbor by default. To send community attribute user has +to specify *neighbor A.B.C.D send-community* command. + +:: + + ! + router bgp 1 + neighbor 10.0.0.1 remote-as 1 + address-family ipv4 unicast + no neighbor 10.0.0.1 send-community + exit-address-family + ! + router bgp 1 + neighbor 10.0.0.1 remote-as 1 + address-family ipv4 unicast + neighbor 10.0.0.1 send-community + exit-address-family + ! + + +.. index:: {Command} {bgp config-type zebra} {} + +{Command} {bgp config-type zebra} {} + Frr style BGP configuration. This is default. + +.. _BGP_instance_and_view: + +BGP instance and view +--------------------- + +BGP instance is a normal BGP process. The result of route selection +goes to the kernel routing table. You can setup different AS at the +same time when BGP multiple instance feature is enabled. + +.. index:: {Command} {router bgp `as-number`} {} + +{Command} {router bgp `as-number`} {} + Make a new BGP instance. You can use arbitrary word for the `name`. + +:: + + @group + bgp multiple-instance + ! + router bgp 1 + neighbor 10.0.0.1 remote-as 2 + neighbor 10.0.0.2 remote-as 3 + ! + router bgp 2 + neighbor 10.0.0.3 remote-as 4 + neighbor 10.0.0.4 remote-as 5 + @end group + + +BGP view is almost same as normal BGP process. The result of +route selection does not go to the kernel routing table. BGP view is +only for exchanging BGP routing information. + +.. index:: {Command} {router bgp `as-number` view `name`} {} + +{Command} {router bgp `as-number` view `name`} {} + Make a new BGP view. You can use arbitrary word for the `name`. This + view's route selection result does not go to the kernel routing table. + +With this command, you can setup Route Server like below. + +:: + + @group + bgp multiple-instance + ! + router bgp 1 view 1 + neighbor 10.0.0.1 remote-as 2 + neighbor 10.0.0.2 remote-as 3 + ! + router bgp 2 view 2 + neighbor 10.0.0.3 remote-as 4 + neighbor 10.0.0.4 remote-as 5 + @end group + + +.. _Routing_policy: + +Routing policy +-------------- + +You can set different routing policy for a peer. For example, you can +set different filter for a peer. + +:: + + @group + bgp multiple-instance + ! + router bgp 1 view 1 + neighbor 10.0.0.1 remote-as 2 + address-family ipv4 unicast + neighbor 10.0.0.1 distribute-list 1 in + exit-address-family + ! + router bgp 1 view 2 + neighbor 10.0.0.1 remote-as 2 + address-family ipv4 unicast + neighbor 10.0.0.1 distribute-list 2 in + exit-address-family + @end group + + +This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view +2. When the update is inserted into view 1, distribute-list 1 is +applied. On the other hand, when the update is inserted into view 2, +distribute-list 2 is applied. + +.. _Viewing_the_view: + +Viewing the view +---------------- + +To display routing table of BGP view, you must specify view name. + +.. index:: {Command} {show ip bgp view `name`} {} + +{Command} {show ip bgp view `name`} {} + Display routing table of BGP view `name`. + +.. _BGP_Regular_Expressions: + +BGP Regular Expressions +======================= + +BGP regular expressions are based on `POSIX 1003.2` regular +expressions. The following description is just a quick subset of the +`POSIX` regular expressions. Adding to that, the special character +'_' is added. + + + +*.* + Matches any single character. + +* + Matches 0 or more occurrences of pattern. + ++ + Matches 1 or more occurrences of pattern. + +? + Match 0 or 1 occurrences of pattern. + +^ + Matches the beginning of the line. + +$ + Matches the end of the line. + +_ + Character `_` has special meanings in BGP regular expressions. + It matches to space and comma , and AS set delimiter { and } and AS + confederation delimiter `(` and `)`. And it also matches to + the beginning of the line and the end of the line. So `_` can be + used for AS value boundaries match. This character technically evaluates + to `(^|[,{}() ]|$)`. + +.. _How_to_set_up_a_6-Bone_connection: + +How to set up a 6-Bone connection +================================= + +:: + + @group + zebra configuration + =================== + ! + ! Actually there is no need to configure zebra + ! + + bgpd configuration + ================== + ! + ! This means that routes go through zebra and into the kernel. + ! + router zebra + ! + ! MP-BGP configuration + ! + router bgp 7675 + bgp router-id 10.0.0.1 + neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number` + ! + address-family ipv6 + network 3ffe:506::/32 + neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate + neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out + neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number` + neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out + exit-address-family + ! + ipv6 access-list all permit any + ! + ! Set output nexthop address. + ! + route-map set-nexthop permit 10 + match ipv6 address all + set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 + set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 + ! + ! logfile FILENAME is obsolete. Please use log file FILENAME + + log file bgpd.log + ! + @end group + + +.. _Dump_BGP_packets_and_table: + +Dump BGP packets and table +========================== + +.. index:: Command {dump bgp all `path` [`interval`]} {} + +Command {dump bgp all `path` [`interval`]} {} +.. index:: Command {dump bgp all-et `path` [`interval`]} {} + +Command {dump bgp all-et `path` [`interval`]} {} +.. index:: Command {no dump bgp all [`path`] [`interval`]} {} + +Command {no dump bgp all [`path`] [`interval`]} {} + Dump all BGP packet and events to `path` file. + If `interval` is set, a new file will be created for echo `interval` of seconds. + The path `path` can be set with date and time formatting (strftime). + The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). + (:ref:`Packet_Binary_Dump_Format`) + +.. index:: Command {dump bgp updates `path` [`interval`]} {} + +Command {dump bgp updates `path` [`interval`]} {} +.. index:: Command {dump bgp updates-et `path` [`interval`]} {} + +Command {dump bgp updates-et `path` [`interval`]} {} +.. index:: Command {no dump bgp updates [`path`] [`interval`]} {} + +Command {no dump bgp updates [`path`] [`interval`]} {} + Dump only BGP updates messages to `path` file. + If `interval` is set, a new file will be created for echo `interval` of seconds. + The path `path` can be set with date and time formatting (strftime). + The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). + +.. index:: Command {dump bgp routes-mrt `path`} {} + +Command {dump bgp routes-mrt `path`} {} +.. index:: Command {dump bgp routes-mrt `path` `interval`} {} + +Command {dump bgp routes-mrt `path` `interval`} {} +.. index:: Command {no dump bgp route-mrt [`path`] [`interval`]} {} + +Command {no dump bgp route-mrt [`path`] [`interval`]} {} + Dump whole BGP routing table to `path`. This is heavy process. + The path `path` can be set with date and time formatting (strftime). + If `interval` is set, a new file will be created for echo `interval` of seconds. + + Note: the interval variable can also be set using hours and minutes: 04h20m00. + +BGP Configuration Examples +========================== + +Example of a session to an upstream, advertising only one prefix to it. + +:: + + router bgp 64512 + bgp router-id 10.236.87.1 + neighbor upstream peer-group + neighbor upstream remote-as 64515 + neighbor upstream capability dynamic + neighbor 10.1.1.1 peer-group upstream + neighbor 10.1.1.1 description ACME ISP + + address-family ipv4 unicast + network 10.236.87.0/24 + neighbor upstream prefix-list pl-allowed-adv out + exit-address-family + ! + ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 + ip prefix-list pl-allowed-adv seq 10 deny any + + + +A more complex example. With upstream, peer and customer sessions. +Advertising global prefixes and NO_EXPORT prefixes and providing +actions for customer routes based on community values. Extensive use of +route-maps and the 'call' feature to support selective advertising of +prefixes. This example is intended as guidance only, it has NOT been +tested and almost certainly containts silly mistakes, if not serious +flaws. + +:: + + router bgp 64512 + bgp router-id 10.236.87.1 + neighbor upstream capability dynamic + neighbor cust capability dynamic + neighbor peer capability dynamic + neighbor 10.1.1.1 remote-as 64515 + neighbor 10.1.1.1 peer-group upstream + neighbor 10.2.1.1 remote-as 64516 + neighbor 10.2.1.1 peer-group upstream + neighbor 10.3.1.1 remote-as 64517 + neighbor 10.3.1.1 peer-group cust-default + neighbor 10.3.1.1 description customer1 + neighbor 10.4.1.1 remote-as 64518 + neighbor 10.4.1.1 peer-group cust + neighbor 10.4.1.1 description customer2 + neighbor 10.5.1.1 remote-as 64519 + neighbor 10.5.1.1 peer-group peer + neighbor 10.5.1.1 description peer AS 1 + neighbor 10.6.1.1 remote-as 64520 + neighbor 10.6.1.1 peer-group peer + neighbor 10.6.1.1 description peer AS 2 + + address-family ipv4 unicast + network 10.123.456.0/24 + network 10.123.456.128/25 route-map rm-no-export + neighbor upstream route-map rm-upstream-out out + neighbor cust route-map rm-cust-in in + neighbor cust route-map rm-cust-out out + neighbor cust send-community both + neighbor peer route-map rm-peer-in in + neighbor peer route-map rm-peer-out out + neighbor peer send-community both + neighbor 10.3.1.1 prefix-list pl-cust1-network in + neighbor 10.4.1.1 prefix-list pl-cust2-network in + neighbor 10.5.1.1 prefix-list pl-peer1-network in + neighbor 10.6.1.1 prefix-list pl-peer2-network in + exit-address-family + ! + ip prefix-list pl-default permit 0.0.0.0/0 + ! + ip prefix-list pl-upstream-peers permit 10.1.1.1/32 + ip prefix-list pl-upstream-peers permit 10.2.1.1/32 + ! + ip prefix-list pl-cust1-network permit 10.3.1.0/24 + ip prefix-list pl-cust1-network permit 10.3.2.0/24 + ! + ip prefix-list pl-cust2-network permit 10.4.1.0/24 + ! + ip prefix-list pl-peer1-network permit 10.5.1.0/24 + ip prefix-list pl-peer1-network permit 10.5.2.0/24 + ip prefix-list pl-peer1-network permit 192.168.0.0/24 + ! + ip prefix-list pl-peer2-network permit 10.6.1.0/24 + ip prefix-list pl-peer2-network permit 10.6.2.0/24 + ip prefix-list pl-peer2-network permit 192.168.1.0/24 + ip prefix-list pl-peer2-network permit 192.168.2.0/24 + ip prefix-list pl-peer2-network permit 172.16.1/24 + ! + ip as-path access-list asp-own-as permit ^$ + ip as-path access-list asp-own-as permit _64512_ + ! + ! ################################################################# + ! Match communities we provide actions for, on routes receives from + ! customers. Communities values of :X, with X, have actions: + ! + ! 100 - blackhole the prefix + ! 200 - set no_export + ! 300 - advertise only to other customers + ! 400 - advertise only to upstreams + ! 500 - set no_export when advertising to upstreams + ! 2X00 - set local_preference to X00 + ! + ! blackhole the prefix of the route + ip community-list standard cm-blackhole permit 64512:100 + ! + ! set no-export community before advertising + ip community-list standard cm-set-no-export permit 64512:200 + ! + ! advertise only to other customers + ip community-list standard cm-cust-only permit 64512:300 + ! + ! advertise only to upstreams + ip community-list standard cm-upstream-only permit 64512:400 + ! + ! advertise to upstreams with no-export + ip community-list standard cm-upstream-noexport permit 64512:500 + ! + ! set local-pref to least significant 3 digits of the community + ip community-list standard cm-prefmod-100 permit 64512:2100 + ip community-list standard cm-prefmod-200 permit 64512:2200 + ip community-list standard cm-prefmod-300 permit 64512:2300 + ip community-list standard cm-prefmod-400 permit 64512:2400 + ip community-list expanded cme-prefmod-range permit 64512:2... + ! + ! Informational communities + ! + ! 3000 - learned from upstream + ! 3100 - learned from customer + ! 3200 - learned from peer + ! + ip community-list standard cm-learnt-upstream permit 64512:3000 + ip community-list standard cm-learnt-cust permit 64512:3100 + ip community-list standard cm-learnt-peer permit 64512:3200 + ! + ! ################################################################### + ! Utility route-maps + ! + ! These utility route-maps generally should not used to permit/deny + ! routes, i.e. they do not have meaning as filters, and hence probably + ! should be used with 'on-match next'. These all finish with an empty + ! permit entry so as not interfere with processing in the caller. + ! + route-map rm-no-export permit 10 + set community additive no-export + route-map rm-no-export permit 20 + ! + route-map rm-blackhole permit 10 + description blackhole, up-pref and ensure it cant escape this AS + set ip next-hop 127.0.0.1 + set local-preference 10 + set community additive no-export + route-map rm-blackhole permit 20 + ! + ! Set local-pref as requested + route-map rm-prefmod permit 10 + match community cm-prefmod-100 + set local-preference 100 + route-map rm-prefmod permit 20 + match community cm-prefmod-200 + set local-preference 200 + route-map rm-prefmod permit 30 + match community cm-prefmod-300 + set local-preference 300 + route-map rm-prefmod permit 40 + match community cm-prefmod-400 + set local-preference 400 + route-map rm-prefmod permit 50 + ! + ! Community actions to take on receipt of route. + route-map rm-community-in permit 10 + description check for blackholing, no point continuing if it matches. + match community cm-blackhole + call rm-blackhole + route-map rm-community-in permit 20 + match community cm-set-no-export + call rm-no-export + on-match next + route-map rm-community-in permit 30 + match community cme-prefmod-range + call rm-prefmod + route-map rm-community-in permit 40 + ! + ! ##################################################################### + ! Community actions to take when advertising a route. + ! These are filtering route-maps, + ! + ! Deny customer routes to upstream with cust-only set. + route-map rm-community-filt-to-upstream deny 10 + match community cm-learnt-cust + match community cm-cust-only + route-map rm-community-filt-to-upstream permit 20 + ! + ! Deny customer routes to other customers with upstream-only set. + route-map rm-community-filt-to-cust deny 10 + match community cm-learnt-cust + match community cm-upstream-only + route-map rm-community-filt-to-cust permit 20 + ! + ! ################################################################### + ! The top-level route-maps applied to sessions. Further entries could + ! be added obviously.. + ! + ! Customers + route-map rm-cust-in permit 10 + call rm-community-in + on-match next + route-map rm-cust-in permit 20 + set community additive 64512:3100 + route-map rm-cust-in permit 30 + ! + route-map rm-cust-out permit 10 + call rm-community-filt-to-cust + on-match next + route-map rm-cust-out permit 20 + ! + ! Upstream transit ASes + route-map rm-upstream-out permit 10 + description filter customer prefixes which are marked cust-only + call rm-community-filt-to-upstream + on-match next + route-map rm-upstream-out permit 20 + description only customer routes are provided to upstreams/peers + match community cm-learnt-cust + ! + ! Peer ASes + ! outbound policy is same as for upstream + route-map rm-peer-out permit 10 + call rm-upstream-out + ! + route-map rm-peer-in permit 10 + set community additive 64512:3200 + + +@include rpki.texi diff --git a/doc/user/conf.py b/doc/user/conf.py new file mode 100644 index 0000000000..ebb8b828a1 --- /dev/null +++ b/doc/user/conf.py @@ -0,0 +1,293 @@ +# -*- coding: utf-8 -*- +# +# FRR documentation build configuration file, created by +# sphinx-quickstart on Tue Jan 31 16:00:52 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import re + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.todo'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'FRR' +copyright = u'2017, FRR' +author = u'FRR' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. + +# The short X.Y version. +version = u'?.?' +# The full version, including alpha/beta/rc tags. +release = u'?.?-?' + +val = re.compile('^S\["([^"]+)"\]="(.*)"$') +with open('../../config.status', 'r') as cfgstatus: + for ln in cfgstatus.readlines(): + m = val.match(ln) + if m is None: continue + if m.group(1) == 'PACKAGE_VERSION': + release = m.group(2) + version = release.split('-')[0] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'FRRdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'FRR.tex', u'FRR User Manual', + u'FRR', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'frr', u'FRR User Manual', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'FRR', u'FRR User Manual', + author, 'FRR', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/user/defines.rst b/doc/user/defines.rst new file mode 100644 index 0000000000..014d66d0e8 --- /dev/null +++ b/doc/user/defines.rst @@ -0,0 +1,24 @@ +.. These are substitutions that were used in the original Texinfo docs. + They need to be recreated in RST by way of rst_prolog or a common include. + That, in turn, needs to be generated by make at compile time. + @c -*- texinfo -*- + @c doc/defines.texi. Generated from defines.texi.in by configure. + + @c Set variables + @set PACKAGE_NAME frr + @set PACKAGE_TARNAME frr + @set PACKAGE_STRING frr 3.1-dev + @set PACKAGE_URL https://frrouting.org/ + @set PACKAGE_VERSION 3.1-dev + @set AUTHORS Kunihiro Ishiguro, et al. + @set COPYRIGHT_YEAR 1999-2005 + @set COPYRIGHT_STR Copyright @copyright{} @value{COPYRIGHT_YEAR} @value{AUTHORS} + + @c These may vary with installation environment. + @set INSTALL_PREFIX_ETC /etc/frr + @set INSTALL_PREFIX_SBIN /usr/lib/frr + @set INSTALL_PREFIX_STATE /var/run/frr + @set INSTALL_PREFIX_MODULES /usr/lib/frr/modules + @set INSTALL_USER frr + @set INSTALL_GROUP frr + @set INSTALL_VTY_GROUP frrvty diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst new file mode 100644 index 0000000000..effec5dc1e --- /dev/null +++ b/doc/user/eigrpd.rst @@ -0,0 +1,257 @@ +.. _EIGRP: + +***** +EIGRP +***** + +EIGRP -- Routing Information Protocol is widely deployed interior gateway +routing protocol. EIGRP was developed in the 1990's. EIGRP is a +@dfn{distance-vector} protocol and is based on the @dfn{dual} algorithms. +As a distance-vector protocol, the EIGRP router send updates to its +neighbors as networks change, thus allowing the convergence to a +known topology. + +*eigrpd* supports EIGRP as described in RFC7868 + +.. _Starting_and_Stopping_eigrpd: + +Starting and Stopping eigrpd +============================ + +The default configuration file name of *eigrpd*'s is +:file:`eigrpd.conf`. When invocation *eigrpd* searches directory +@value{INSTALL_PREFIX_ETC}. If :file:`eigrpd.conf` is not there next +search current directory. If an integrated config is specified +configuration is written into frr.conf + +The EIGRP protocol requires interface information +maintained by *zebra* daemon. So running *zebra* +is mandatory to run *eigrpd*. Thus minimum sequence for running +EIGRP is like below: + +:: + + @group + # zebra -d + # eigrpd -d + @end group + + +Please note that *zebra* must be invoked before *eigrpd*. + +To stop *eigrpd*. Please use @command{kill `cat +/var/run/eigrpd.pid`}. Certain signals have special meanings to *eigrpd*. + + + +*SIGHUP* + +*SIGUSR1* + Rotate *eigrpd* Rotate the logfile. + +*SIGINT* + +*SIGTERM* + *eigrpd* sweeps all installed EIGRP routes then terminates properly. + +*eigrpd* invocation options. Common options that can be specified +(:ref:`Common_Invocation_Options`). + + + +*-r* + +*--retain* + When the program terminates, retain routes added by *eigrpd*. + +.. _EIGRP_Configuration: + +EIGRP Configuration +=================== + +.. index:: Command {router eigrp (1-65535)} {} + +Command {router eigrp (1-65535)} {} + The `router eigrp` command is necessary to enable EIGRP. To disable + EIGRP, use the `no router eigrp (1-65535)` command. EIGRP must be enabled before carrying out any of the EIGRP commands. + +.. index:: Command {no router eigrp (1-65535)} {} + +Command {no router eigrp (1-65535)} {} + Disable EIGRP. + +.. index:: {EIGRP Command} {network `network`} {} + +{EIGRP Command} {network `network`} {} +.. index:: {EIGRP Command} {no network `network`} {} + +{EIGRP Command} {no network `network`} {} + Set the EIGRP enable interface by `network`. The interfaces which + have addresses matching with `network` are enabled. + + This group of commands either enables or disables EIGRP interfaces between + certain numbers of a specified network address. For example, if the + network for 10.0.0.0/24 is EIGRP enabled, this would result in all the + addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The `no network` command will disable EIGRP for the specified network. + + Below is very simple EIGRP configuration. Interface `eth0` and + interface which address match to `10.0.0.0/8` are EIGRP enabled. + +:: + + @group + ! + router eigrp 1 + network 10.0.0.0/8 + ! + @end group + + + Passive interface + +.. index:: {EIGRP command} {passive-interface (`IFNAME`|default)} {} + +{EIGRP command} {passive-interface (`IFNAME`|default)} {} +.. index:: {EIGRP command} {no passive-interface `IFNAME`} {} + +{EIGRP command} {no passive-interface `IFNAME`} {} + This command sets the specified interface to passive mode. On passive mode + interface, all receiving packets are ignored and eigrpd does + not send either multicast or unicast EIGRP packets except to EIGRP neighbors + specified with `neighbor` command. The interface may be specified + as `default` to make eigrpd default to passive on all interfaces. + + The default is to be passive on all interfaces. + +.. _How_to_Announce_EIGRP_route: + +How to Announce EIGRP route +=========================== + +.. index:: {EIGRP command} {redistribute kernel} {} + +{EIGRP command} {redistribute kernel} {} +.. index:: {EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} + +{EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +.. index:: {EIGRP command} {no redistribute kernel} {} + +{EIGRP command} {no redistribute kernel} {} + `redistribute kernel` redistributes routing information from + kernel route entries into the EIGRP tables. `no redistribute kernel` + disables the routes. + +.. index:: {EIGRP command} {redistribute static} {} + +{EIGRP command} {redistribute static} {} +.. index:: {EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} + +{EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +.. index:: {EIGRP command} {no redistribute static} {} + +{EIGRP command} {no redistribute static} {} + `redistribute static` redistributes routing information from + static route entries into the EIGRP tables. `no redistribute static` + disables the routes. + +.. index:: {EIGRP command} {redistribute connected} {} + +{EIGRP command} {redistribute connected} {} +.. index:: {EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} + +{EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +.. index:: {EIGRP command} {no redistribute connected} {} + +{EIGRP command} {no redistribute connected} {} + Redistribute connected routes into the EIGRP tables. `no redistribute connected` disables the connected routes in the EIGRP tables. + This command redistribute connected of the interface which EIGRP disabled. + The connected route on EIGRP enabled interface is announced by default. + +.. index:: {EIGRP command} {redistribute ospf} {} + +{EIGRP command} {redistribute ospf} {} +.. index:: {EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} + +{EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +.. index:: {EIGRP command} {no redistribute ospf} {} + +{EIGRP command} {no redistribute ospf} {} + `redistribute ospf` redistributes routing information from + ospf route entries into the EIGRP tables. `no redistribute ospf` + disables the routes. + +.. index:: {EIGRP command} {redistribute bgp} {} + +{EIGRP command} {redistribute bgp} {} +.. index:: {EIGRP command} {redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} + +{EIGRP command} {redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +.. index:: {EIGRP command} {no redistribute bgp} {} + +{EIGRP command} {no redistribute bgp} {} + `redistribute bgp` redistributes routing information from + bgp route entries into the EIGRP tables. `no redistribute bgp` + disables the routes. + +.. _Show_EIGRP_Information: + +Show EIGRP Information +====================== + +To display EIGRP routes. + +.. index:: Command {show ip eigrp topology} {} + +Command {show ip eigrp topology} {} + Show EIGRP routes. + +The command displays all EIGRP routes. + +.. index:: Command {show ip eigrp topology} {} + +Command {show ip eigrp topology} {} + The command displays current EIGRP status + +:: + + @group + eigrpd> **show ip eigrp topology** + # show ip eigrp topo + + EIGRP Topology Table for AS(4)/ID(0.0.0.0) + + Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply + r - reply Status, s - sia Status + + P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 + via Connected, enp0s3 + @end group + + +EIGRP Debug Commands +==================== + +Debug for EIGRP protocol. + +.. index:: Command {debug eigrp packets} {} + +Command {debug eigrp packets} {} + Debug eigrp packets + +`debug eigrp` will show EIGRP packets that are sent and recevied. + +.. index:: Command {debug eigrp transmit} {} + +Command {debug eigrp transmit} {} + Debug eigrp transmit events + +`debug eigrp transmit` will display detailed information about the EIGRP transmit events. + +.. index:: Command {show debugging eigrp} {} + +Command {show debugging eigrp} {} + Display *eigrpd*'s debugging option. + +`show debugging eigrp` will show all information currently set for eigrpd +debug. + diff --git a/doc/user/filter.rst b/doc/user/filter.rst new file mode 100644 index 0000000000..75f5933e7b --- /dev/null +++ b/doc/user/filter.rst @@ -0,0 +1,197 @@ +********* +Filtering +********* + +Frr provides many very flexible filtering features. Filtering is used +for both input and output of the routing information. Once filtering is +defined, it can be applied in any direction. + +@comment node-name, next, previous, up + +IP Access List +============== + +.. index:: {Command} {access-list `name` permit `ipv4-network`} {} + +{Command} {access-list `name` permit `ipv4-network`} {} +.. index:: {Command} {access-list `name` deny `ipv4-network`} {} + +{Command} {access-list `name` deny `ipv4-network`} {} + + Basic filtering is done by `access-list` as shown in the + following example. + +:: + + access-list filter deny 10.0.0.0/9 + access-list filter permit 10.0.0.0/8 + + + @comment node-name, next, previous, up + +IP Prefix List +============== + +*ip prefix-list* provides the most powerful prefix based +filtering mechanism. In addition to *access-list* functionality, +*ip prefix-list* has prefix length range specification and +sequential number specification. You can add or delete prefix based +filters to arbitrary points of prefix-list using sequential number specification. + +If no ip prefix-list is specified, it acts as permit. If *ip prefix-list* +is defined, and no match is found, default deny is applied. + +.. index:: {Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {} + +{Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {} +.. index:: {Command} {ip prefix-list `name` seq `number` (permit|deny) `prefix` [le `len`] [ge `len`]} {} + +{Command} {ip prefix-list `name` seq `number` (permit|deny) `prefix` [le `len`] [ge `len`]} {} + You can create *ip prefix-list* using above commands. + + + +*@asis{seq}* + seq `number` can be set either automatically or manually. In the + case that sequential numbers are set manually, the user may pick any + number less than 4294967295. In the case that sequential number are set + automatically, the sequential number will increase by a unit of five (5) + per list. If a list with no specified sequential number is created + after a list with a specified sequential number, the list will + automatically pick the next multiple of five (5) as the list number. + For example, if a list with number 2 already exists and a new list with + no specified number is created, the next list will be numbered 5. If + lists 2 and 7 already exist and a new list with no specified number is + created, the new list will be numbered 10. + + +*@asis{le}* + *le* command specifies prefix length. The prefix list will be + applied if the prefix length is less than or equal to the le prefix length. + + +*@asis{ge}* + *ge* command specifies prefix length. The prefix list will be + applied if the prefix length is greater than or equal to the ge prefix length. + + + Less than or equal to prefix numbers and greater than or equal to + prefix numbers can be used together. The order of the le and ge + commands does not matter. + + If a prefix list with a different sequential number but with the exact + same rules as a previous list is created, an error will result. + However, in the case that the sequential number and the rules are + exactly similar, no error will result. + + If a list with the same sequential number as a previous list is created, + the new list will overwrite the old list. + + Matching of IP Prefix is performed from the smaller sequential number to the + larger. The matching will stop once any rule has been applied. + + In the case of no le or ge command, the prefix length must match exactly the + length specified in the prefix list. + +.. index:: {Command} {no ip prefix-list `name`} {} + +{Command} {no ip prefix-list `name`} {} + +.. _ip_prefix-list_description: + +ip prefix-list description +-------------------------- + +.. index:: {Command} {ip prefix-list `name` description `desc`} {} + +{Command} {ip prefix-list `name` description `desc`} {} + Descriptions may be added to prefix lists. This command adds a + description to the prefix list. + +.. index:: {Command} {no ip prefix-list `name` description [`desc`]} {} + +{Command} {no ip prefix-list `name` description [`desc`]} {} + Deletes the description from a prefix list. It is possible to use the + command without the full description. + +.. _ip_prefix-list_sequential_number_control: + +ip prefix-list sequential number control +---------------------------------------- + +.. index:: {Command} {ip prefix-list sequence-number} {} + +{Command} {ip prefix-list sequence-number} {} + With this command, the IP prefix list sequential number is displayed. + This is the default behavior. + +.. index:: {Command} {no ip prefix-list sequence-number} {} + +{Command} {no ip prefix-list sequence-number} {} + With this command, the IP prefix list sequential number is not + displayed. + +.. _Showing_ip_prefix-list: + +Showing ip prefix-list +---------------------- + +.. index:: {Command} {show ip prefix-list} {} + +{Command} {show ip prefix-list} {} + Display all IP prefix lists. + +.. index:: {Command} {show ip prefix-list `name`} {} + +{Command} {show ip prefix-list `name`} {} + Show IP prefix list can be used with a prefix list name. + +.. index:: {Command} {show ip prefix-list `name` seq `num`} {} + +{Command} {show ip prefix-list `name` seq `num`} {} + Show IP prefix list can be used with a prefix list name and sequential + number. + +.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m`} {} + +{Command} {show ip prefix-list `name` `a.b.c.d/m`} {} + If the command longer is used, all prefix lists with prefix lengths equal to + or longer than the specified length will be displayed. + If the command first match is used, the first prefix length match will be + displayed. + +.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m` longer} {} + +{Command} {show ip prefix-list `name` `a.b.c.d/m` longer} {} +.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m` first-match} {} + +{Command} {show ip prefix-list `name` `a.b.c.d/m` first-match} {} +.. index:: {Command} {show ip prefix-list summary} {} + +{Command} {show ip prefix-list summary} {} +.. index:: {Command} {show ip prefix-list summary `name`} {} + +{Command} {show ip prefix-list summary `name`} {} +.. index:: {Command} {show ip prefix-list detail} {} + +{Command} {show ip prefix-list detail} {} +.. index:: {Command} {show ip prefix-list detail `name`} {} + +{Command} {show ip prefix-list detail `name`} {} + +Clear counter of ip prefix-list +------------------------------- + +.. index:: {Command} {clear ip prefix-list} {} + +{Command} {clear ip prefix-list} {} + Clears the counters of all IP prefix lists. Clear IP Prefix List can be + used with a specified name and prefix. + +.. index:: {Command} {clear ip prefix-list `name`} {} + +{Command} {clear ip prefix-list `name`} {} +.. index:: {Command} {clear ip prefix-list `name` `a.b.c.d/m`} {} + +{Command} {clear ip prefix-list `name` `a.b.c.d/m`} {} + diff --git a/doc/user/index.rst b/doc/user/index.rst new file mode 100644 index 0000000000..57225fc250 --- /dev/null +++ b/doc/user/index.rst @@ -0,0 +1,28 @@ +Welcome to FRR's documentation! +=============================== + +.. toctree:: + :maxdepth: 2 + + overview + installation + basic + main + ripd + ripngd + ospfd + ospf6d + isisd + nhrpd + bgp + babeld + routeserver + vnc + vtysh + filter + routemap + ipv6 + kernel + snmp + protocol + diff --git a/doc/user/installation.rst b/doc/user/installation.rst new file mode 100644 index 0000000000..8ede815f7e --- /dev/null +++ b/doc/user/installation.rst @@ -0,0 +1,329 @@ +.. _Installation: + +************ +Installation +************ + +.. index:: How to install FRR + +.. index:: Installation + +.. index:: Installing FRR + +.. index:: Building the system + +.. index:: Making FRR + +There are three steps for installing the software: configuration, +compilation, and installation. + +The easiest way to get FRR running is to issue the following +commands: + +:: + + % configure + % make + % make install + + +.. _Configure_the_Software: + +Configure the Software +====================== + + +.. _The_Configure_script_and_its_options: + +The Configure script and its options +------------------------------------ + +.. index:: Configuration options + +.. index:: Options for configuring + +.. index:: Build options + +.. index:: Distribution configuration + +.. index:: Options to `./configure` + +FRR has an excellent configure script which automatically detects most +host configurations. There are several additional configure options to +customize the build to include or exclude specific features and dependencies. + + + +*--disable-zebra* + Do not build zebra daemon. + +*--disable-ripd* + Do not build ripd. + +*--disable-ripngd* + Do not build ripngd. + +*--disable-ospfd* + Do not build ospfd. + +*--disable-ospf6d* + Do not build ospf6d. + +*--disable-bgpd* + Do not build bgpd. + +*--disable-bgp-announce* + Make *bgpd* which does not make bgp announcements at all. This + feature is good for using *bgpd* as a BGP announcement listener. + +*--enable-datacenter* + Enable system defaults to work as if in a Data Center. See defaults.h + for what is changed by this configure option. + +*--enable-snmp* + Enable SNMP support. By default, SNMP support is disabled. + +*--disable-ospfapi* + Disable support for OSPF-API, an API to interface directly with ospfd. + OSPF-API is enabled if --enable-opaque-lsa is set. + +*--disable-ospfclient* + Disable building of the example OSPF-API client. + +*--disable-ospf-ri* + Disable support for OSPF Router Information (RFC4970 & RFC5088) this + requires support for Opaque LSAs and Traffic Engineering. + +*--disable-isisd* + Do not build isisd. + +*--enable-isis-topology* + Enable IS-IS topology generator. + +*--enable-isis-te* + Enable Traffic Engineering Extension for ISIS (RFC5305) + +*--enable-multipath=`ARG`* + Enable support for Equal Cost Multipath. `ARG` is the maximum number + of ECMP paths to allow, set to 0 to allow unlimited number of paths. + +*--disable-rtadv* + Disable support IPV6 router advertisement in zebra. + +*--enable-gcc-rdynamic* + Pass the *-rdynamic* option to the linker driver. This is in most + cases neccessary for getting usable backtraces. This option defaults to on + if the compiler is detected as gcc, but giving an explicit enable/disable is + suggested. + +*--disable-backtrace* + Controls backtrace support for the crash handlers. This is autodetected by + default. Using the switch will enforce the requested behaviour, failing with + an error if support is requested but not available. On BSD systems, this + needs libexecinfo, while on glibc support for this is part of libc itself. + +*--enable-dev-build* + Turn on some options for compiling FRR within a development environment in + mind. Specifically turn on -g3 -O0 for compiling options and add inclusion + of grammar sandbox. + +*--enable-fuzzing* + Turn on some compile options to allow you to run fuzzing tools + against the system. This tools is intended as a developer + only tool and should not be used for normal operations + +You may specify any combination of the above options to the configure +script. By default, the executables are placed in :file:`/usr/local/sbin` +and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/` +installation prefix and other directories may be changed using the following +options to the configuration script. + + + +*--prefix=`prefix`* + Install architecture-independent files in `prefix` [/usr/local]. + +*--sysconfdir=`dir`* + Look for configuration files in `dir` [`prefix`/etc]. Note + that sample configuration files will be installed here. + +*--localstatedir=`dir`* + Configure zebra to use `dir` for local state files, such + as pid files and unix sockets. + +:: + + % ./configure --disable-snmp + + +This command will configure zebra and the routing daemons. + +.. _Least-Privilege_support: + +Least-Privilege support +----------------------- + +.. index:: FRR Least-Privileges + +.. index:: FRR Privileges + +Additionally, you may configure zebra to drop its elevated privileges +shortly after startup and switch to another user. The configure script will +automatically try to configure this support. There are three configure +options to control the behaviour of FRR daemons. + + + +*--enable-user=`user`* + Switch to user `ARG` shortly after startup, and run as user `ARG` + in normal operation. + +*--enable-group=`group`* + Switch real and effective group to `group` shortly after + startup. + +*--enable-vty-group=`group`* + Create Unix Vty sockets (for use with vtysh) with group owndership set to + `group`. This allows one to create a seperate group which is + restricted to accessing only the Vty sockets, hence allowing one to + delegate this group to individual users, or to run vtysh setgid to + this group. + +The default user and group which will be configured is 'frr' if no user +or group is specified. Note that this user or group requires write access to +the local state directory (see --localstatedir) and requires at least read +access, and write access if you wish to allow daemons to write out their +configuration, to the configuration directory (see --sysconfdir). + +On systems which have the 'libcap' capabilities manipulation library +(currently only linux), the frr system will retain only minimal +capabilities required, further it will only raise these capabilities for +brief periods. On systems without libcap, frr will run as the user +specified and only raise its uid back to uid 0 for brief periods. + +.. _Linux_Notes: + +Linux Notes +----------- + +.. index:: Configuring FRR + +.. index:: Building on Linux boxes + +.. index:: Linux configurations + +There are several options available only to GNU/Linux systems: +@footnote{GNU/Linux has very flexible kernel configuration features}. If +you use GNU/Linux, make sure that the current kernel configuration is +what you want. FRR will run with any kernel configuration but some +recommendations do exist. + + + +*CONFIG_NETLINK* + Kernel/User netlink socket. This is a brand new feature which enables an + advanced interface between the Linux kernel and zebra (:ref:`Kernel_Interface`). + + +*CONFIG_RTNETLINK* + Routing messages. + This makes it possible to receive netlink routing messages. If you + specify this option, *zebra* can detect routing information + updates directly from the kernel (:ref:`Kernel_Interface`). + + +*CONFIG_IP_MULTICAST* + IP: multicasting. + This option should be specified when you use *ripd* (:ref:`RIP`) or + *ospfd* (:ref:`OSPFv2`) because these protocols use multicast. + + +IPv6 support has been added in GNU/Linux kernel version 2.2. If you +try to use the FRR IPv6 feature on a GNU/Linux kernel, please +make sure the following libraries have been installed. Please note that +these libraries will not be needed when you uses GNU C library 2.1 +or upper. + + + +*inet6-apps* + The `inet6-apps` package includes basic IPv6 related libraries such + as `inet_ntop` and `inet_pton`. Some basic IPv6 programs such + as *ping*, *ftp*, and *inetd* are also + included. The `inet-apps` can be found at + `ftp://ftp.inner.net/pub/ipv6/ `_. + + +*net-tools* + The `net-tools` package provides an IPv6 enabled interface and + routing utility. It contains *ifconfig*, *route*, + *netstat*, and other tools. `net-tools` may be found at + `http://www.tazenda.demon.co.uk/phil/net-tools/ `_. + + +.. _Build_the_Software: + +Build the Software +================== + +After configuring the software, you will need to compile it for your +system. Simply issue the command *make* in the root of the source +directory and the software will be compiled. Cliff Note versions of +different compilation examples can be found in the doc/Building_FRR_on_XXX.md +files. If you have *any* problems at this stage, be certain to send a +bug report :ref:`Bug_Reports`. + +:: + + % ./bootstrap.sh + % ./configure + % make + + +@comment node-name, next, previous, up + +Install the Software +==================== + +Installing the software to your system consists of copying the compiled +programs and supporting files to a standard location. After the +installation process has completed, these files have been copied +from your work directory to :file:`/usr/local/bin`, and :file:`/usr/local/etc`. + +To install the FRR suite, issue the following command at your shell +prompt: *make install*. + +:: + + % + % make install + % + + +FRR daemons have their own terminal interface or VTY. After +installation, you have to setup each beast's port number to connect to +them. Please add the following entries to :file:`/etc/services`. + +:: + + zebrasrv 2600/tcp # zebra service + zebra 2601/tcp # zebra vty + ripd 2602/tcp # RIPd vty + ripngd 2603/tcp # RIPngd vty + ospfd 2604/tcp # OSPFd vty + bgpd 2605/tcp # BGPd vty + ospf6d 2606/tcp # OSPF6d vty + ospfapi 2607/tcp # ospfapi + isisd 2608/tcp # ISISd vty + nhrpd 2610/tcp # nhrpd vty + pimd 2611/tcp # PIMd vty + + +If you use a FreeBSD newer than 2.2.8, the above entries are already +added to :file:`/etc/services` so there is no need to add it. If you +specify a port number when starting the daemon, these entries may not be +needed. + +You may need to make changes to the config files in +:file:`@value{INSTALL_PREFIX_ETC`/\*.conf}. :ref:`Config_Commands`. + diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst new file mode 100644 index 0000000000..5c002467b7 --- /dev/null +++ b/doc/user/ipv6.rst @@ -0,0 +1,229 @@ +.. _IPv6_Support: + +************ +IPv6 Support +************ + +Frr fully supports IPv6 routing. As described so far, Frr supports +RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface +and configure static IPv6 routing information. Frr IPv6 also provides +automatic address configuration via a feature called `address auto configuration`. To do it, the router must send router advertisement +messages to the all nodes that exist on the network. + +Previous versions of Frr could be built without IPv6 support. This is +no longer possible. + +Router Advertisement +==================== + +.. index:: {Interface Command} {no ipv6 nd suppress-ra} {} + +{Interface Command} {no ipv6 nd suppress-ra} {} + Send router advertisment messages. + +.. index:: {Interface Command} {ipv6 nd suppress-ra} {} + +{Interface Command} {ipv6 nd suppress-ra} {} + Don't send router advertisment messages. + +.. index:: {Interface Command} {ipv6 nd prefix `ipv6prefix` [`valid-lifetime`] [`preferred-lifetime`] [off-link] [no-autoconfig] [router-address]} {} + +{Interface Command} {ipv6 nd prefix `ipv6prefix` [`valid-lifetime`] [`preferred-lifetime`] [off-link] [no-autoconfig] [router-address]} {} + Configuring the IPv6 prefix to include in router advertisements. Several prefix + specific optional parameters and flags may follow: + + +`` + `valid-lifetime` - the length of time in seconds during what the prefix is + valid for the purpose of on-link determination. Value `infinite` represents + infinity (i.e. a value of all one bits (`0xffffffff`)). + + Range: `<0-4294967295>` Default: `2592000` + + +`` + `preferred-lifetime` - the length of time in seconds during what addresses + generated from the prefix remain preferred. Value `infinite` represents + infinity. + + Range: `<0-4294967295>` Default: `604800` + + +`` + `off-link` - indicates that advertisement makes no statement about on-link or + off-link properties of the prefix. + + Default: not set, i.e. this prefix can be used for on-link determination. + + +`` + `no-autoconfig` - indicates to hosts on the local link that the specified prefix + cannot be used for IPv6 autoconfiguration. + + Default: not set, i.e. prefix can be used for autoconfiguration. + + +`` + `router-address` - indicates to hosts on the local link that the specified + prefix + contains a complete IP address by setting R flag. + + Default: not set, i.e. hosts do not assume a complete IP address is placed. + +.. index:: {Interface Command} {ipv6 nd ra-interval <1-1800>} {} + +{Interface Command} {ipv6 nd ra-interval <1-1800>} {} +.. index:: {Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} + +{Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in seconds. + + Default: `600` + +.. index:: {Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} + +{Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} +.. index:: {Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} + +{Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in milliseconds. + + Default: `600000` + +.. index:: {Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} + +{Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} +.. index:: {Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} + +{Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} + The value to be placed in the Router Lifetime field of router advertisements + sent from the interface, in seconds. Indicates the usefulness of the router + as a default router on this interface. Setting the value to zero indicates + that the router should not be considered a default router on this interface. + Must be either zero or between value specified with `ipv6 nd ra-interval` + (or default) and 9000 seconds. + + Default: `1800` + +.. index:: {Interface Command} {ipv6 nd reachable-time <1-3600000>} {} + +{Interface Command} {ipv6 nd reachable-time <1-3600000>} {} +.. index:: {Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} + +{Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} + The value to be placed in the Reachable Time field in the Router Advertisement + messages sent by the router, in milliseconds. The configured time enables the + router to detect unavailable neighbors. The value zero means unspecified (by + this router). + + Default: `0` + +.. index:: {Interface Command} {ipv6 nd managed-config-flag} {} + +{Interface Command} {ipv6 nd managed-config-flag} {} +.. index:: {Interface Command} {no ipv6 nd managed-config-flag} {} + +{Interface Command} {no ipv6 nd managed-config-flag} {} + Set/unset flag in IPv6 router advertisements which indicates to hosts that they + should use managed (stateful) protocol for addresses autoconfiguration in + addition to any addresses autoconfigured using stateless address + autoconfiguration. + + Default: not set + +.. index:: {Interface Command} {ipv6 nd other-config-flag} {} + +{Interface Command} {ipv6 nd other-config-flag} {} +.. index:: {Interface Command} {no ipv6 nd other-config-flag} {} + +{Interface Command} {no ipv6 nd other-config-flag} {} + Set/unset flag in IPv6 router advertisements which indicates to hosts that + they should use administered (stateful) protocol to obtain autoconfiguration + information other than addresses. + + Default: not set + +.. index:: {Interface Command} {ipv6 nd home-agent-config-flag} {} + +{Interface Command} {ipv6 nd home-agent-config-flag} {} +.. index:: {Interface Command} {no ipv6 nd home-agent-config-flag} {} + +{Interface Command} {no ipv6 nd home-agent-config-flag} {} + Set/unset flag in IPv6 router advertisements which indicates to hosts that + the router acts as a Home Agent and includes a Home Agent Option. + + Default: not set + +.. index:: {Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} + +{Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} +.. index:: {Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} + +{Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent preference. The default value of 0 stands + for the lowest preference possible. + + Default: 0 + +.. index:: {Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} + +{Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} +.. index:: {Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} + +{Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent Lifetime. The default value of 0 means to + place the current Router Lifetime value. + + Default: 0 + +.. index:: {Interface Command} {ipv6 nd adv-interval-option} {} + +{Interface Command} {ipv6 nd adv-interval-option} {} +.. index:: {Interface Command} {no ipv6 nd adv-interval-option} {} + +{Interface Command} {no ipv6 nd adv-interval-option} {} + Include an Advertisement Interval option which indicates to hosts the maximum time, + in milliseconds, between successive unsolicited Router Advertisements. + + Default: not set + +.. index:: {Interface Command} {ipv6 nd router-preference (high|medium|low)} {} + +{Interface Command} {ipv6 nd router-preference (high|medium|low)} {} +.. index:: {Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} + +{Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} + Set default router preference in IPv6 router advertisements per RFC4191. + + Default: medium + +.. index:: {Interface Command} {ipv6 nd mtu <1-65535>} {} + +{Interface Command} {ipv6 nd mtu <1-65535>} {} +.. index:: {Interface Command} {no ipv6 nd mtu [<1-65535>]} {} + +{Interface Command} {no ipv6 nd mtu [<1-65535>]} {} + Include an MTU (type 5) option in each RA packet to assist the attached hosts + in proper interface configuration. The announced value is not verified to be + consistent with router interface MTU. + + Default: don't advertise any MTU option + +:: + + @group + interface eth0 + no ipv6 nd suppress-ra + ipv6 nd prefix 2001:0DB8:5009::/64 + @end group + + + For more information see @cite{RFC2462 (IPv6 Stateless Address Autoconfiguration)} + , @cite{RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))} + , @cite{RFC6275 (Mobility Support in IPv6)} + and @cite{RFC4191 (Default Router Preferences and More-Specific Routes)}. + diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst new file mode 100644 index 0000000000..667af96057 --- /dev/null +++ b/doc/user/isisd.rst @@ -0,0 +1,641 @@ +.. _ISIS: + +**** +ISIS +**** + +@acronym{ISIS,Intermediate System to Intermediate System} is a routing protocol +which is described in @cite{ISO10589, RFC1195, RFC5308}. ISIS is an +@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, +@acronym{ISIS} can provide scalable network support and faster +convergence times like @acronym{OSPF}. ISIS is widely used in large networks such as +@acronym{ISP,Internet Service Provider} and carrier backbone networks. + +.. _Configuring_isisd: + +Configuring isisd +================= + +There are no *isisd* specific options. Common options can be +specified (:ref:`Common_Invocation_Options`) to *isisd*. +*isisd* needs to acquire interface information from +*zebra* in order to function. Therefore *zebra* must be +running before invoking *isisd*. Also, if *zebra* is +restarted then *isisd* must be too. + +Like other daemons, *isisd* configuration is done in @acronym{ISIS} +specific configuration file :file:`isisd.conf`. + +.. _ISIS_router: + +ISIS router +=========== + +To start ISIS process you have to specify the ISIS router. As of this +writing, *isisd* does not support multiple ISIS processes. + +.. index:: Command {router isis WORD} {} + +Command {router isis WORD} {} +.. index:: Command {no router isis WORD} {} + +Command {no router isis WORD} {} + .. _router_isis_WORD: + + Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'. + *isisd* does not yet support multiple ISIS processes but you must specify + the name of ISIS process. The ISIS process name 'WORD' is then used for interface + (see command :ref:`ip_router_isis_WORD`). + +.. index:: {ISIS Command} {net XX.XXXX. ... .XXX.XX} {} + +{ISIS Command} {net XX.XXXX. ... .XXX.XX} {} +.. index:: {ISIS Command} {no net XX.XXXX. ... .XXX.XX} {} + +{ISIS Command} {no net XX.XXXX. ... .XXX.XX} {} + Set/Unset network entity title (NET) provided in ISO format. + +.. index:: {ISIS Command} {hostname dynamic} {} + +{ISIS Command} {hostname dynamic} {} +.. index:: {ISIS Command} {no hostname dynamic} {} + +{ISIS Command} {no hostname dynamic} {} + Enable support for dynamic hostname. + +.. index:: {ISIS Command} {area-password [clear | md5] } {} + +{ISIS Command} {area-password [clear | md5] } {} +.. index:: {ISIS Command} {domain-password [clear | md5] } {} + +{ISIS Command} {domain-password [clear | md5] } {} +.. index:: {ISIS Command} {no area-password} {} + +{ISIS Command} {no area-password} {} +.. index:: {ISIS Command} {no domain-password} {} + +{ISIS Command} {no domain-password} {} + Configure the authentication password for an area, respectively a domain, + as clear text or md5 one. + +.. index:: {ISIS Command} {log-adjacency-changes} {} + +{ISIS Command} {log-adjacency-changes} {} +.. index:: {ISIS Command} {no log-adjacency-changes} {} + +{ISIS Command} {no log-adjacency-changes} {} + Log changes in adjacency state. + +.. index:: {ISIS Command} {metric-style [narrow | transition | wide]} {} + +{ISIS Command} {metric-style [narrow | transition | wide]} {} +.. index:: {ISIS Command} {no metric-style} {} + +{ISIS Command} {no metric-style} {} + .. _metric-style: + + Set old-style (ISO 10589) or new-style packet formats: + - narrow Use old style of TLVs with narrow metric + - transition Send and accept both styles of TLVs during transition + - wide Use new style of TLVs to carry wider metric + +.. index:: {ISIS Command} {set-overload-bit} {} + +{ISIS Command} {set-overload-bit} {} +.. index:: {ISIS Command} {no set-overload-bit} {} + +{ISIS Command} {no set-overload-bit} {} + Set overload bit to avoid any transit traffic. + +.. _ISIS_Timer: + +ISIS Timer +========== + +.. index:: {ISIS Command} {lsp-gen-interval <1-120>} {} + +{ISIS Command} {lsp-gen-interval <1-120>} {} +.. index:: {ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {} + +{ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {} +.. index:: {ISIS Command} {no lsp-gen-interval} {} + +{ISIS Command} {no lsp-gen-interval} {} +.. index:: {ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {} + +{ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {} + Set minimum interval in seconds between regenerating same LSP, + globally, for an area (level-1) or a domain (level-2). + +.. index:: {ISIS Command} {lsp-refresh-interval <1-65235>} {} + +{ISIS Command} {lsp-refresh-interval <1-65235>} {} +.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} + +{ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} +.. index:: {ISIS Command} {no lsp-refresh-interval} {} + +{ISIS Command} {no lsp-refresh-interval} {} +.. index:: {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} + +{ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} + Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). + +.. index:: {ISIS Command} {lsp-refresh-interval <1-65235>} {} + +{ISIS Command} {lsp-refresh-interval <1-65235>} {} +.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} + +{ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} +.. index:: {ISIS Command} {no lsp-refresh-interval} {} + +{ISIS Command} {no lsp-refresh-interval} {} +.. index:: {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} + +{ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} + Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). + +.. index:: {ISIS Command} {max-lsp-lifetime <360-65535>} {} + +{ISIS Command} {max-lsp-lifetime <360-65535>} {} +.. index:: {ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {} + +{ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {} +.. index:: {ISIS Command} {no max-lsp-lifetime} {} + +{ISIS Command} {no max-lsp-lifetime} {} +.. index:: {ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} + +{ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} + Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or a domain (level-2). + +.. index:: {ISIS Command} {spf-interval <1-120>} {} + +{ISIS Command} {spf-interval <1-120>} {} +.. index:: {ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {} + +{ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {} +.. index:: {ISIS Command} {no spf-interval} {} + +{ISIS Command} {no spf-interval} {} +.. index:: {ISIS Command} {no spf-interval [level-1 | level-2]} {} + +{ISIS Command} {no spf-interval [level-1 | level-2]} {} + Set minimum interval between consecutive SPF calculations in seconds. + +.. _ISIS_region: + +ISIS region +=========== + +.. index:: {ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {} + +{ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {} +.. index:: {ISIS Command} {no is-type} {} + +{ISIS Command} {no is-type} {} + Define the ISIS router behavior: + - level-1 Act as a station router only + - level-1-2 Act as both a station router and an area router + - level-2-only Act as an area router only + +.. _ISIS_interface: + +ISIS interface +============== + +.. index:: {Interface Command} {ip router isis WORD} {} + +{Interface Command} {ip router isis WORD} {} +.. index:: {Interface Command} {no ip router isis WORD} {} + +{Interface Command} {no ip router isis WORD} {} + .. _ip_router_isis_WORD: + + Activate ISIS adjacency on this interface. Note that the name + of ISIS instance must be the same as the one used to configure the ISIS process + (see command :ref:`router_isis_WORD`). + +.. index:: {Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {} + +{Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {} +.. index:: {Interface Command} {no isis circuit-type} {} + +{Interface Command} {no isis circuit-type} {} + Configure circuit type for interface: + - level-1 Level-1 only adjacencies are formed + - level-1-2 Level-1-2 adjacencies are formed + - level-2-only Level-2 only adjacencies are formed + +.. index:: {Interface Command} {isis csnp-interval <1-600>} {} + +{Interface Command} {isis csnp-interval <1-600>} {} +.. index:: {Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {} + +{Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {} +.. index:: {Interface Command} {no isis csnp-interval} {} + +{Interface Command} {no isis csnp-interval} {} +.. index:: {Interface Command} {no isis csnp-interval [level-1 | level-2]} {} + +{Interface Command} {no isis csnp-interval [level-1 | level-2]} {} + Set CSNP interval in seconds globally, for an area (level-1) or a domain (level-2). + +.. index:: {Interface Command} {isis hello padding} {} + +{Interface Command} {isis hello padding} {} + Add padding to IS-IS hello packets. + +.. index:: {Interface Command} {isis hello-interval <1-600>} {} + +{Interface Command} {isis hello-interval <1-600>} {} +.. index:: {Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {} + +{Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {} +.. index:: {Interface Command} {no isis hello-interval} {} + +{Interface Command} {no isis hello-interval} {} +.. index:: {Interface Command} {no isis hello-interval [level-1 | level-2]} {} + +{Interface Command} {no isis hello-interval [level-1 | level-2]} {} + Set Hello interval in seconds globally, for an area (level-1) or a domain (level-2). + +.. index:: {Interface Command} {isis hello-multiplier <2-100>} {} + +{Interface Command} {isis hello-multiplier <2-100>} {} +.. index:: {Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {} + +{Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {} +.. index:: {Interface Command} {no isis hello-multiplier} {} + +{Interface Command} {no isis hello-multiplier} {} +.. index:: {Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} + +{Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} + Set multiplier for Hello holding time globally, for an area (level-1) or a domain (level-2). + +.. index:: {Interface Command} {isis metric [<0-255> | <0-16777215>]} {} + +{Interface Command} {isis metric [<0-255> | <0-16777215>]} {} +.. index:: {Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {} + +{Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {} +.. index:: {Interface Command} {no isis metric} {} + +{Interface Command} {no isis metric} {} +.. index:: {Interface Command} {no isis metric [level-1 | level-2]} {} + +{Interface Command} {no isis metric [level-1 | level-2]} {} + Set default metric value globally, for an area (level-1) or a domain (level-2). + Max value depend if metric support narrow or wide value (see command :ref:`metric-style`). + +.. index:: {Interface Command} {isis network point-to-point} {} + +{Interface Command} {isis network point-to-point} {} +.. index:: {Interface Command} {no isis network point-to-point} {} + +{Interface Command} {no isis network point-to-point} {} + Set network type to 'Point-to-Point' (broadcast by default). + +.. index:: {Interface Command} {isis passive} {} + +{Interface Command} {isis passive} {} +.. index:: {Interface Command} {no isis passive} {} + +{Interface Command} {no isis passive} {} + Configure the passive mode for this interface. + +.. index:: {Interface Command} {isis password [clear | md5] } {} + +{Interface Command} {isis password [clear | md5] } {} +.. index:: {Interface Command} {no isis password} {} + +{Interface Command} {no isis password} {} + Configure the authentication password (clear or encoded text) for the interface. + +.. index:: {Interface Command} {isis priority <0-127>} {} + +{Interface Command} {isis priority <0-127>} {} +.. index:: {Interface Command} {isis priority <0-127> [level-1 | level-2]} {} + +{Interface Command} {isis priority <0-127> [level-1 | level-2]} {} +.. index:: {Interface Command} {no isis priority} {} + +{Interface Command} {no isis priority} {} +.. index:: {Interface Command} {no isis priority [level-1 | level-2]} {} + +{Interface Command} {no isis priority [level-1 | level-2]} {} + Set priority for Designated Router election, globally, for the area (level-1) + or the domain (level-2). + +.. index:: {Interface Command} {isis psnp-interval <1-120>} {} + +{Interface Command} {isis psnp-interval <1-120>} {} +.. index:: {Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {} + +{Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {} +.. index:: {Interface Command} {no isis psnp-interval} {} + +{Interface Command} {no isis psnp-interval} {} +.. index:: {Interface Command} {no isis psnp-interval [level-1 | level-2]} {} + +{Interface Command} {no isis psnp-interval [level-1 | level-2]} {} + Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2). + +.. _Showing_ISIS_information: + +Showing ISIS information +======================== + +.. index:: {Command} {show isis summary} {} + +{Command} {show isis summary} {} + Show summary information about ISIS. + +.. index:: {Command} {show isis hostname} {} + +{Command} {show isis hostname} {} + Show information about ISIS node. + +.. index:: {Command} {show isis interface} {} + +{Command} {show isis interface} {} +.. index:: {Command} {show isis interface detail} {} + +{Command} {show isis interface detail} {} +.. index:: {Command} {show isis interface } {} + +{Command} {show isis interface } {} + Show state and configuration of ISIS specified interface, or all + interfaces if no interface is given with or without details. + +.. index:: {Command} {show isis neighbor} {} + +{Command} {show isis neighbor} {} +.. index:: {Command} {show isis neighbor } {} + +{Command} {show isis neighbor } {} +.. index:: {Command} {show isis neighbor detail} {} + +{Command} {show isis neighbor detail} {} + Show state and information of ISIS specified neighbor, or all + neighbors if no system id is given with or without details. + +.. index:: {Command} {show isis database} {} + +{Command} {show isis database} {} +.. index:: {Command} {show isis database [detail]} {} + +{Command} {show isis database [detail]} {} +.. index:: {Command} {show isis database [detail]} {} + +{Command} {show isis database [detail]} {} +.. index:: {Command} {show isis database detail } {} + +{Command} {show isis database detail } {} + Show the ISIS database globally, for a specific LSP id without or with details. + +.. index:: {Command} {show isis topology} {} + +{Command} {show isis topology} {} +.. index:: {Command} {show isis topology [level-1|level-2]} {} + +{Command} {show isis topology [level-1|level-2]} {} + Show topology IS-IS paths to Intermediate Systems, globally, + in area (level-1) or domain (level-2). + +.. index:: {Command} {show ip route isis} {} + +{Command} {show ip route isis} {} + Show the ISIS routing table, as determined by the most recent SPF calculation. + +.. _Traffic_Engineering: + +Traffic Engineering +=================== + +.. index:: {ISIS Command} {mpls-te on} {} + +{ISIS Command} {mpls-te on} {} +.. index:: {ISIS Command} {no mpls-te} {} + +{ISIS Command} {no mpls-te} {} + Enable Traffic Engineering LSP flooding. + +.. index:: {ISIS Command} {mpls-te router-address } {} + +{ISIS Command} {mpls-te router-address } {} +.. index:: {ISIS Command} {no mpls-te router-address} {} + +{ISIS Command} {no mpls-te router-address} {} + Configure stable IP address for MPLS-TE. + +.. index:: {Command} {show isis mpls-te interface} {} + +{Command} {show isis mpls-te interface} {} +.. index:: {Command} {show isis mpls-te interface `interface`} {} + +{Command} {show isis mpls-te interface `interface`} {} + Show MPLS Traffic Engineering parameters for all or specified interface. + +.. index:: {Command} {show isis mpls-te router} {} + +{Command} {show isis mpls-te router} {} + Show Traffic Engineering router parameters. + +.. _Debugging_ISIS: + +Debugging ISIS +============== + +.. index:: {Command} {debug isis adj-packets} {} + +{Command} {debug isis adj-packets} {} +.. index:: {Command} {no debug isis adj-packets} {} + +{Command} {no debug isis adj-packets} {} + IS-IS Adjacency related packets. + +.. index:: {Command} {debug isis checksum-errors} {} + +{Command} {debug isis checksum-errors} {} +.. index:: {Command} {no debug isis checksum-errors} {} + +{Command} {no debug isis checksum-errors} {} + IS-IS LSP checksum errors. + +.. index:: {Command} {debug isis events} {} + +{Command} {debug isis events} {} +.. index:: {Command} {no debug isis events} {} + +{Command} {no debug isis events} {} + IS-IS Events. + +.. index:: {Command} {debug isis local-updates} {} + +{Command} {debug isis local-updates} {} +.. index:: {Command} {no debug isis local-updates} {} + +{Command} {no debug isis local-updates} {} + IS-IS local update packets. + +.. index:: {Command} {debug isis packet-dump} {} + +{Command} {debug isis packet-dump} {} +.. index:: {Command} {no debug isis packet-dump} {} + +{Command} {no debug isis packet-dump} {} + IS-IS packet dump. + +.. index:: {Command} {debug isis protocol-errors} {} + +{Command} {debug isis protocol-errors} {} +.. index:: {Command} {no debug isis protocol-errors} {} + +{Command} {no debug isis protocol-errors} {} + IS-IS LSP protocol errors. + +.. index:: {Command} {debug isis route-events} {} + +{Command} {debug isis route-events} {} +.. index:: {Command} {no debug isis route-events} {} + +{Command} {no debug isis route-events} {} + IS-IS Route related events. + +.. index:: {Command} {debug isis snp-packets} {} + +{Command} {debug isis snp-packets} {} +.. index:: {Command} {no debug isis snp-packets} {} + +{Command} {no debug isis snp-packets} {} + IS-IS CSNP/PSNP packets. + +.. index:: {Command} {debug isis spf-events} {} + +{Command} {debug isis spf-events} {} +.. index:: {Command} {debug isis spf-statistics} {} + +{Command} {debug isis spf-statistics} {} +.. index:: {Command} {debug isis spf-triggers} {} + +{Command} {debug isis spf-triggers} {} +.. index:: {Command} {no debug isis spf-events} {} + +{Command} {no debug isis spf-events} {} +.. index:: {Command} {no debug isis spf-statistics} {} + +{Command} {no debug isis spf-statistics} {} +.. index:: {Command} {no debug isis spf-triggers} {} + +{Command} {no debug isis spf-triggers} {} + IS-IS Shortest Path First Events, Timing and Statistic Data + and triggering events. + +.. index:: {Command} {debug isis update-packets} {} + +{Command} {debug isis update-packets} {} +.. index:: {Command} {no debug isis update-packets} {} + +{Command} {no debug isis update-packets} {} + Update related packets. + +.. index:: {Command} {show debugging isis} {} + +{Command} {show debugging isis} {} + Print which ISIS debug level is activate. + +ISIS Configuration Examples +=========================== + +A simple example, with MD5 authentication enabled: + +:: + + @group + ! + interface eth0 + ip router isis FOO + isis network point-to-point + isis circuit-type level-2-only + ! + router isis FOO + net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 + metric-style wide + is-type level-2-only + @end group + + +A Traffic Engineering configuration, with Inter-ASv2 support. + +- First, the 'zebra.conf' part: + +:: + + @group + hostname HOSTNAME + password PASSWORD + log file /var/log/zebra.log + ! + interface eth0 + ip address 10.2.2.2/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + ! + interface eth1 + ip address 10.1.1.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + mpls-te neighbor 10.1.1.2 as 65000 + @end group + + +- Then the 'isisd.conf' itself: + +:: + + @group + hostname HOSTNAME + password PASSWORD + log file /var/log/isisd.log + ! + ! + interface eth0 + ip router isis FOO + ! + interface eth1 + ip router isis FOO + ! + ! + router isis FOO + isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 + mpls-te on + mpls-te router-address 10.1.1.1 + ! + line vty + @end group + + diff --git a/doc/user/kernel.rst b/doc/user/kernel.rst new file mode 100644 index 0000000000..04559ffa9a --- /dev/null +++ b/doc/user/kernel.rst @@ -0,0 +1,51 @@ +**************** +Kernel Interface +**************** + +There are several different methods for reading kernel routing table +information, updating kernel routing tables, and for looking up +interfaces. + + + +*ioctl* + The @samp{ioctl} method is a very traditional way for reading or writing + kernel information. @samp{ioctl} can be used for looking up interfaces + and for modifying interface addresses, flags, mtu settings and other + types of information. Also, @samp{ioctl} can insert and delete kernel + routing table entries. It will soon be available on almost any platform + which zebra supports, but it is a little bit ugly thus far, so if a + better method is supported by the kernel, zebra will use that. + + +*sysctl* + @samp{sysctl} can lookup kernel information using MIB (Management + Information Base) syntax. Normally, it only provides a way of getting + information from the kernel. So one would usually want to change kernel + information using another method such as @samp{ioctl}. + + +*proc filesystem* + @samp{proc filesystem} provides an easy way of getting kernel + information. + + +*routing socket* + +*netlink* + On recent Linux kernels (2.0.x and 2.2.x), there is a kernel/user + communication support called `netlink`. It makes asynchronous + communication between kernel and Frr possible, similar to a routing + socket on BSD systems. + + Before you use this feature, be sure to select (in kernel configuration) + the kernel/netlink support option 'Kernel/User network link driver' and + 'Routing messages'. + + Today, the /dev/route special device file is obsolete. Netlink + communication is done by reading/writing over netlink socket. + + After the kernel configuration, please reconfigure and rebuild Frr. + You can use netlink as a dynamic routing update channel between Frr + and the kernel. + diff --git a/doc/user/main.rst b/doc/user/main.rst new file mode 100644 index 0000000000..a48a27d9c1 --- /dev/null +++ b/doc/user/main.rst @@ -0,0 +1,619 @@ +.. _Zebra: + +***** +Zebra +***** + +*zebra* is an IP routing manager. It provides kernel routing +table updates, interface lookups, and redistribution of routes between +different routing protocols. + +.. _Invoking_zebra: + +Invoking zebra +============== + +Besides the common invocation options (:ref:`Common_Invocation_Options`), the +*zebra* specific invocation options are listed below. + + + +*-b* + +*--batch* + Runs in batch mode. *zebra* parses configuration file and terminates + immediately. + + +*-k* + +*--keep_kernel* + When zebra starts up, don't delete old self inserted routes. + + +*-r* + +*--retain* + When program terminates, retain routes added by zebra. + + +.. _Interface_Commands: + +Interface Commands +================== + + +.. _Standard_Commands: + +Standard Commands +----------------- + +.. index:: Command {interface `ifname`} {} + +Command {interface `ifname`} {} + +.. index:: {Interface Command} {shutdown} {} + +{Interface Command} {shutdown} {} +.. index:: {Interface Command} {no shutdown} {} + +{Interface Command} {no shutdown} {} + Up or down the current interface. + +.. index:: {Interface Command} {ip address `address/prefix`} {} + +{Interface Command} {ip address `address/prefix`} {} +.. index:: {Interface Command} {ipv6 address `address/prefix`} {} + +{Interface Command} {ipv6 address `address/prefix`} {} +.. index:: {Interface Command} {no ip address `address/prefix`} {} + +{Interface Command} {no ip address `address/prefix`} {} +.. index:: {Interface Command} {no ipv6 address `address/prefix`} {} + +{Interface Command} {no ipv6 address `address/prefix`} {} + Set the IPv4 or IPv6 address/prefix for the interface. + +.. index:: {Interface Command} {ip address `local-addr` peer `peer-addr/prefix`} {} + +{Interface Command} {ip address `local-addr` peer `peer-addr/prefix`} {} +.. index:: {Interface Command} {no ip address `local-addr` peer `peer-addr/prefix`} {} + +{Interface Command} {no ip address `local-addr` peer `peer-addr/prefix`} {} + Configure an IPv4 Pointopoint address on the interface. + (The concept of PtP addressing does not exist for IPv6.) + + `local-addr` has no subnet mask since the local side in PtP + addressing is always a single (/32) address. `peer-addr/prefix` + can be an arbitrary subnet behind the other end of the link (or even on the + link in Point-to-Multipoint setups), though generally /32s are used. + +.. index:: {Interface Command} {ip address `address/prefix` secondary} {} + +{Interface Command} {ip address `address/prefix` secondary} {} +.. index:: {Interface Command} {no ip address `address/prefix` secondary} {} + +{Interface Command} {no ip address `address/prefix` secondary} {} + Set the secondary flag for this address. This causes ospfd to not treat the + address as a distinct subnet. + +.. index:: {Interface Command} {description `description` ...} {} + +{Interface Command} {description `description` ...} {} + Set description for the interface. + +.. index:: {Interface Command} {multicast} {} + +{Interface Command} {multicast} {} +.. index:: {Interface Command} {no multicast} {} + +{Interface Command} {no multicast} {} + Enable or disables multicast flag for the interface. + +.. index:: {Interface Command} {bandwidth <1-10000000>} {} + +{Interface Command} {bandwidth <1-10000000>} {} +.. index:: {Interface Command} {no bandwidth <1-10000000>} {} + +{Interface Command} {no bandwidth <1-10000000>} {} + Set bandwidth value of the interface in kilobits/sec. This is for + calculating OSPF cost. This command does not affect the actual device + configuration. + +.. index:: {Interface Command} {link-detect} {} + +{Interface Command} {link-detect} {} +.. index:: {Interface Command} {no link-detect} {} + +{Interface Command} {no link-detect} {} + Enable/disable link-detect on platforms which support this. Currently + only Linux and Solaris, and only where network interface drivers support reporting + link-state via the IFF_RUNNING flag. + +.. _Link_Parameters_Commands: + +Link Parameters Commands +------------------------ + +.. index:: {Interface Command} {link-params} {} + +{Interface Command} {link-params} {} +.. index:: {Interface Command} {no link-param} {} + +{Interface Command} {no link-param} {} + Enter into the link parameters sub node. At least 'enable' must be set to activate the link parameters, + and consequently Traffic Engineering on this interface. MPLS-TE must be enable at the OSPF (:ref:`OSPF_Traffic_Engineering`) + or ISIS (:ref:`ISIS_Traffic_Engineering`) router level in complement to this. + Disable link parameters for this interface. + + Under link parameter statement, the following commands set the different TE values: + +.. index:: link-params {enable} + +link-params {enable} + Enable link parameters for this interface. + +.. index:: link-params {metric <0-4294967295>} {} + +link-params {metric <0-4294967295>} {} +.. index:: link-params {max-bw `bandwidth`} {} + +link-params {max-bw `bandwidth`} {} +.. index:: link-params {max-rsv-bw `bandwidth`} {} + +link-params {max-rsv-bw `bandwidth`} {} +.. index:: link-params {unrsv-bw <0-7> `bandwidth`} {} + +link-params {unrsv-bw <0-7> `bandwidth`} {} +.. index:: link-params {admin-grp `bandwidth`} {} + +link-params {admin-grp `bandwidth`} {} + These commands specifies the Traffic Engineering parameters of the interface in conformity to RFC3630 (OSPF) + or RFC5305 (ISIS). + There are respectively the TE Metric (different from the OSPF or ISIS metric), Maximum Bandwidth (interface speed + by default), Maximum Reservable Bandwidth, Unreserved Bandwidth for each 0-7 priority and Admin Group (ISIS) or + Resource Class/Color (OSPF). + + Note that `bandwidth` are specified in IEEE floating point format and express in Bytes/second. + +.. index:: link-param {delay <0-16777215> [min <0-16777215> | max <0-16777215>]} {} + +link-param {delay <0-16777215> [min <0-16777215> | max <0-16777215>]} {} +.. index:: link-param {delay-variation <0-16777215>} {} + +link-param {delay-variation <0-16777215>} {} +.. index:: link-param {packet-loss `percentage`} {} + +link-param {packet-loss `percentage`} {} +.. index:: link-param {res-bw `bandwidth`} {} + +link-param {res-bw `bandwidth`} {} +.. index:: link-param {ava-bw `bandwidth`} {} + +link-param {ava-bw `bandwidth`} {} +.. index:: link-param {use-bw `bandwidth`} {} + +link-param {use-bw `bandwidth`} {} + These command specifies additionnal Traffic Engineering parameters of the interface in conformity to + draft-ietf-ospf-te-metrics-extension-05.txt and draft-ietf-isis-te-metrics-extension-03.txt. There are + respectively the delay, jitter, loss, available bandwidth, reservable bandwidth and utilized bandwidth. + + Note that `bandwidth` are specified in IEEE floating point format and express in Bytes/second. + Delays and delay variation are express in micro-second (µs). Loss is specified in `percentage` ranging + from 0 to 50.331642% by step of 0.000003. + +.. index:: link-param {neighbor as <0-65535>} {} + +link-param {neighbor as <0-65535>} {} +.. index:: link-param {no neighbor} {} + +link-param {no neighbor} {} + Specifies the remote ASBR IP address and Autonomous System (AS) number for InterASv2 link in OSPF (RFC5392). + Note that this option is not yet supported for ISIS (RFC5316). + +.. _Static_Route_Commands: + +Static Route Commands +===================== + +Static routing is a very fundamental feature of routing technology. It +defines static prefix and gateway. + +.. index:: Command {ip route `network` `gateway`} {} + +Command {ip route `network` `gateway`} {} + `network` is destination prefix with format of A.B.C.D/M. + `gateway` is gateway for the prefix. When `gateway` is + A.B.C.D format. It is taken as a IPv4 address gateway. Otherwise it + is treated as an interface name. If the interface name is `null0` then + zebra installs a blackhole route. + +:: + + ip route 10.0.0.0/8 10.0.0.2 + ip route 10.0.0.0/8 ppp0 + ip route 10.0.0.0/8 null0 + + + First example defines 10.0.0.0/8 static route with gateway 10.0.0.2. + Second one defines the same prefix but with gateway to interface ppp0. The + third install a blackhole route. + +.. index:: Command {ip route `network` `netmask` `gateway`} {} + +Command {ip route `network` `netmask` `gateway`} {} + This is alternate version of above command. When `network` is + A.B.C.D format, user must define `netmask` value with A.B.C.D + format. `gateway` is same option as above command + +:: + + ip route 10.0.0.0 255.255.255.0 10.0.0.2 + ip route 10.0.0.0 255.255.255.0 ppp0 + ip route 10.0.0.0 255.255.255.0 null0 + + + These statements are equivalent to those in the previous example. + +.. index:: Command {ip route `network` `gateway` `distance`} {} + +Command {ip route `network` `gateway` `distance`} {} + Installs the route with the specified distance. + +Multiple nexthop static route + +:: + + ip route 10.0.0.1/32 10.0.0.2 + ip route 10.0.0.1/32 10.0.0.3 + ip route 10.0.0.1/32 eth0 + + +If there is no route to 10.0.0.2 and 10.0.0.3, and interface eth0 +is reachable, then the last route is installed into the kernel. + +If zebra has been compiled with multipath support, and both 10.0.0.2 and +10.0.0.3 are reachable, zebra will install a multipath route via both +nexthops, if the platform supports this. + +:: + + zebra> show ip route + S> 10.0.0.1/32 [1/0] via 10.0.0.2 inactive + via 10.0.0.3 inactive + * is directly connected, eth0 + + +:: + + ip route 10.0.0.0/8 10.0.0.2 + ip route 10.0.0.0/8 10.0.0.3 + ip route 10.0.0.0/8 null0 255 + + +This will install a multihop route via the specified next-hops if they are +reachable, as well as a high-metric blackhole route, which can be useful to +prevent traffic destined for a prefix to match less-specific routes (eg +default) should the specified gateways not be reachable. Eg: + +:: + + zebra> show ip route 10.0.0.0/8 + Routing entry for 10.0.0.0/8 + Known via "static", distance 1, metric 0 + 10.0.0.2 inactive + 10.0.0.3 inactive + + Routing entry for 10.0.0.0/8 + Known via "static", distance 255, metric 0 + directly connected, Null0 + + +.. index:: Command {ipv6 route `network` `gateway`} {} + +Command {ipv6 route `network` `gateway`} {} +.. index:: Command {ipv6 route `network` `gateway` `distance`} {} + +Command {ipv6 route `network` `gateway` `distance`} {} + These behave similarly to their ipv4 counterparts. + +.. index:: Command {ipv6 route `network` from `srcprefix` `gateway`} {} + +Command {ipv6 route `network` from `srcprefix` `gateway`} {} +.. index:: Command {ipv6 route `network` from `srcprefix` `gateway` `distance`} {} + +Command {ipv6 route `network` from `srcprefix` `gateway` `distance`} {} + Install a static source-specific route. These routes are currently supported + on Linux operating systems only, and perform AND matching on packet's + destination and source addresses in the kernel's forwarding path. Note that + destination longest-prefix match is "more important" than source LPM, e.g. + *"2001:db8:1::/64 from 2001:db8::/48"* will win over + *"2001:db8::/48 from 2001:db8:1::/64"* if both match. + +.. index:: Command {table `tableno`} {} + +Command {table `tableno`} {} + Select the primary kernel routing table to be used. This only works + for kernels supporting multiple routing tables (like GNU/Linux 2.2.x + and later). After setting `tableno` with this command, + static routes defined after this are added to the specified table. + +.. _Multicast_RIB_Commands: + +Multicast RIB Commands +====================== + +The Multicast RIB provides a separate table of unicast destinations which +is used for Multicast Reverse Path Forwarding decisions. It is used with +a multicast source's IP address, hence contains not multicast group +addresses but unicast addresses. + +This table is fully separate from the default unicast table. However, +RPF lookup can include the unicast table. + +WARNING: RPF lookup results are non-responsive in this version of Frr, +i.e. multicast routing does not actively react to changes in underlying +unicast topology! + +.. index:: Command {ip multicast rpf-lookup-mode `mode`} {} + +Command {ip multicast rpf-lookup-mode `mode`} {} +.. index:: Command {no ip multicast rpf-lookup-mode [`mode`]} {} + +Command {no ip multicast rpf-lookup-mode [`mode`]} {} + `mode` sets the method used to perform RPF lookups. Supported modes: + + + +*urib-only* + Performs the lookup on the Unicast RIB. The Multicast RIB is never used. + +*mrib-only* + Performs the lookup on the Multicast RIB. The Unicast RIB is never used. + +*mrib-then-urib* + Tries to perform the lookup on the Multicast RIB. If any route is found, + that route is used. Otherwise, the Unicast RIB is tried. + +*lower-distance* + Performs a lookup on the Multicast RIB and Unicast RIB each. The result + with the lower administrative distance is used; if they're equal, the + Multicast RIB takes precedence. + +*longer-prefix* + Performs a lookup on the Multicast RIB and Unicast RIB each. The result + with the longer prefix length is used; if they're equal, the + Multicast RIB takes precedence. + + The `mrib-then-urib` setting is the default behavior if nothing is + configured. If this is the desired behavior, it should be explicitly + configured to make the configuration immune against possible changes in + what the default behavior is. + + WARNING: Unreachable routes do not receive special treatment and do not + cause fallback to a second lookup. + +.. index:: Command {show ip rpf `addr`} {} + +Command {show ip rpf `addr`} {} + Performs a Multicast RPF lookup, as configured with + *ip multicast rpf-lookup-mode `mode*`. `addr` specifies + the multicast source address to look up. + +:: + + > show ip rpf 192.0.2.1 + Routing entry for 192.0.2.0/24 using Unicast RIB + Known via "kernel", distance 0, metric 0, best + * 198.51.100.1, via eth0 + + + Indicates that a multicast source lookup for 192.0.2.1 would use an + Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1. + +.. index:: Command {show ip rpf} {} + +Command {show ip rpf} {} + Prints the entire Multicast RIB. Note that this is independent of the + configured RPF lookup mode, the Multicast RIB may be printed yet not + used at all. + +.. index:: Command {ip mroute `prefix` `nexthop` [`distance`]} {} + +Command {ip mroute `prefix` `nexthop` [`distance`]} {} +.. index:: Command {no ip mroute `prefix` `nexthop` [`distance`]} {} + +Command {no ip mroute `prefix` `nexthop` [`distance`]} {} + Adds a static route entry to the Multicast RIB. This performs exactly as + the *ip route* command, except that it inserts the route in the + Multicast RIB instead of the Unicast RIB. + +.. _zebra_Route_Filtering: + +zebra Route Filtering +===================== + +Zebra supports *prefix-list* and *route-map* to match +routes received from other frr components. The +*permit*/*deny* facilities provided by these commands +can be used to filter which routes zebra will install in the kernel. + +.. index:: Command {ip protocol `protocol` route-map `routemap`} {} + +Command {ip protocol `protocol` route-map `routemap`} {} + Apply a route-map filter to routes for the specified protocol. `protocol` + can be **any** or one of + **system**, + **kernel**, + **connected**, + **static**, + **rip**, + **ripng**, + **ospf**, + **ospf6**, + **isis**, + **bgp**, + **hsls**. + +.. index:: {Route Map} {set src `address`} + +{Route Map} {set src `address`} + Within a route-map, set the preferred source address for matching routes + when installing in the kernel. + +:: + + The following creates a prefix-list that matches all addresses, a route-map + that sets the preferred source address, and applies the route-map to all + *rip* routes. + + @group + ip prefix-list ANY permit 0.0.0.0/0 le 32 + route-map RM1 permit 10 + match ip address prefix-list ANY + set src 10.0.0.1 + + ip protocol rip route-map RM1 + @end group + + +.. _zebra_FIB_push_interface: + +zebra FIB push interface +======================== + +Zebra supports a 'FIB push' interface that allows an external +component to learn the forwarding information computed by the Frr +routing suite. This is a loadable module that needs to be enabled +at startup as described in :ref:`Loadable_Module_Support`. + +In Frr, the Routing Information Base (RIB) resides inside +zebra. Routing protocols communicate their best routes to zebra, and +zebra computes the best route across protocols for each prefix. This +latter information makes up the Forwarding Information Base +(FIB). Zebra feeds the FIB to the kernel, which allows the IP stack in +the kernel to forward packets according to the routes computed by +Frr. The kernel FIB is updated in an OS-specific way. For example, +the `netlink` interface is used on Linux, and route sockets are +used on FreeBSD. + +The FIB push interface aims to provide a cross-platform mechanism to +support scenarios where the router has a forwarding path that is +distinct from the kernel, commonly a hardware-based fast path. In +these cases, the FIB needs to be maintained reliably in the fast path +as well. We refer to the component that programs the forwarding plane +(directly or indirectly) as the Forwarding Plane Manager or FPM. + +The FIB push interface comprises of a TCP connection between zebra and +the FPM. The connection is initiated by zebra -- that is, the FPM acts +as the TCP server. + +The relevant zebra code kicks in when zebra is configured with the +`--enable-fpm` flag. Zebra periodically attempts to connect to +the well-known FPM port. Once the connection is up, zebra starts +sending messages containing routes over the socket to the FPM. Zebra +sends a complete copy of the forwarding table to the FPM, including +routes that it may have picked up from the kernel. The existing +interaction of zebra with the kernel remains unchanged -- that is, the +kernel continues to receive FIB updates as before. + +The encapsulation header for the messages exchanged with the FPM is +defined by the file :file:`fpm/fpm.h` in the frr tree. The routes +themselves are encoded in netlink or protobuf format, with netlink +being the default. + +Protobuf is one of a number of new serialization formats wherein the +message schema is expressed in a purpose-built language. Code for +encoding/decoding to/from the wire format is generated from the +schema. Protobuf messages can be extended easily while maintaining +backward-compatibility with older code. Protobuf has the following +advantages over netlink: + +* + Code for serialization/deserialization is generated + automatically. This reduces the likelihood of bugs, allows third-party + programs to be integrated quickly, and makes it easy to add fields. +* + The message format is not tied to an OS (Linux), and can be evolved + independently. + +As mentioned before, zebra encodes routes sent to the FPM in netlink +format by default. The format can be controlled via the FPM module's +load-time option to zebra, which currently takes the values `netlink` +and `protobuf`. + +The zebra FPM interface uses replace semantics. That is, if a 'route +add' message for a prefix is followed by another 'route add' message, +the information in the second message is complete by itself, and +replaces the information sent in the first message. + +If the connection to the FPM goes down for some reason, zebra sends +the FPM a complete copy of the forwarding table(s) when it reconnects. + +zebra Terminal Mode Commands +============================ + +.. index:: Command {show ip route} {} + +Command {show ip route} {} + Display current routes which zebra holds in its database. + +:: + + @group + Router# show ip route + Codes: K - kernel route, C - connected, S - static, R - RIP, + B - BGP * - FIB route. + + K* 0.0.0.0/0 203.181.89.241 + S 0.0.0.0/0 203.181.89.1 + C* 127.0.0.0/8 lo + C* 203.181.89.240/28 eth0 + @end group + + +.. index:: Command {show ipv6 route} {} + +Command {show ipv6 route} {} +.. index:: Command {show interface} {} + +Command {show interface} {} +.. index:: Command {show ip prefix-list [`name`]} {} + +Command {show ip prefix-list [`name`]} {} +.. index:: Command {show route-map [`name`]} {} + +Command {show route-map [`name`]} {} +.. index:: Command {show ip protocol} {} + +Command {show ip protocol} {} +.. index:: Command {show ipforward} {} + +Command {show ipforward} {} + Display whether the host's IP forwarding function is enabled or not. + Almost any UNIX kernel can be configured with IP forwarding disabled. + If so, the box can't work as a router. + +.. index:: Command {show ipv6forward} {} + +Command {show ipv6forward} {} + Display whether the host's IP v6 forwarding is enabled or not. + +.. index:: Command {show zebra} {} + +Command {show zebra} {} + Display various statistics related to the installation and deletion + of routes, neighbor updates, and LSP's into the kernel. + +.. index:: Command {show zebra fpm stats} {} + +Command {show zebra fpm stats} {} + Display statistics related to the zebra code that interacts with the + optional Forwarding Plane Manager (FPM) component. + +.. index:: Command {clear zebra fpm stats} {} + +Command {clear zebra fpm stats} {} + Reset statistics related to the zebra code that interacts with the + optional Forwarding Plane Manager (FPM) component. + diff --git a/doc/nhrpd.texi b/doc/user/nhrpd.rst similarity index 67% rename from doc/nhrpd.texi rename to doc/user/nhrpd.rst index 069b46495c..24037f85b6 100644 --- a/doc/nhrpd.texi +++ b/doc/user/nhrpd.rst @@ -1,8 +1,10 @@ -@cindex NHRP -@node NHRP -@chapter NHRP +.. _NHRP: -@command{nhrpd} is a daemon to support Next Hop Routing Protocol (NHRP). +**** +NHRP +**** + +*nhrpd* is a daemon to support Next Hop Routing Protocol (NHRP). NHRP is described in RFC2332. NHRP is used to improve the efficiency of routing computer network @@ -15,17 +17,10 @@ an intermediate hop. Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and @value{PACKAGE_NAME} nhrpd implements this scenario. -@menu -* Routing Design:: -* Configuring NHRP:: -* Hub Functionality:: -* Integration with IKE:: -* NHRP Events:: -* Configuration Example:: -@end menu +.. _Routing_Design: -@node Routing Design -@section Routing Design +Routing Design +============== nhrpd never handles routing of prefixes itself. You need to run some real routing protocol (e.g. BGP) to advertise routes over the tunnels. @@ -38,13 +33,14 @@ a generic subnet route. To create NBMA GRE tunnel you might use the following (linux terminal commands): -@example -@group - ip tunnel add gre1 mode gre key 42 ttl 64 - ip addr add 10.255.255.2/32 dev gre1 - ip link set gre1 up -@end group -@end example +:: + + @group + ip tunnel add gre1 mode gre key 42 ttl 64 + ip addr add 10.255.255.2/32 dev gre1 + ip link set gre1 up + @end group + Note that the IP-address is assigned as host prefix to gre1. nhrpd will automatically create additional host routes pointing to gre1 when @@ -61,24 +57,28 @@ routing protocol (e.g. iBGP) to allow hubs to be able to relay all traffic. This can be achieved in hubs with the following bgp configuration (network command defines the GRE subnet): -@example -@group -router bgp 65555 - address-family ipv4 unicast - network 172.16.0.0/16 - redistribute nhrp - exit-address-family -@end group -@end example +:: + @group + router bgp 65555 + address-family ipv4 unicast + network 172.16.0.0/16 + redistribute nhrp + exit-address-family + @end group + -@node Configuring NHRP -@section Configuring NHRP +.. _Configuring_NHRP: + +Configuring NHRP +================ FIXME -@node Hub Functionality -@section Hub Functionality +.. _Hub_Functionality: + +Hub Functionality +================= In addition to routing nhrp redistributed host prefixes, the hub nodes are also responsible to send NHRP Traffic Indication messages that @@ -89,14 +89,15 @@ using NFLOG. Typically you want to send Traffic Indications for network traffic that is routed from gre1 back to gre1 in rate limited manner. This can be achieved with the following iptables rule. -@example -@group -iptables -A FORWARD -i gre1 -o gre1 \ - -m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \ - --hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \ - --hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128 -@end group -@end example +:: + + @group + iptables -A FORWARD -i gre1 -o gre1 \\ + -m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \\ + --hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \\ + --hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128 + @end group + You can fine tune the src/dstmask according to the prefix lengths you announce internal, add additional IP range matches, or rate limitation @@ -104,23 +105,27 @@ if needed. However, the above should be good in most cases. This kernel NFLOG target's nflog-group is configured in global nhrp config with: -@example -@group -nhrp nflog-group 1 -@end group -@end example +:: + + @group + nhrp nflog-group 1 + @end group + To start sending these traffic notices out from hubs, use the nhrp per-interface directive: -@example -@group -interface gre1 - ip nhrp redirect -@end group -@end example +:: -@node Integration with IKE -@section Integration with IKE + @group + interface gre1 + ip nhrp redirect + @end group + + +.. _Integration_with_IKE: + +Integration with IKE +==================== nhrpd needs tight integration with IKE daemon for various reasons. Currently only strongSwan is supported as IKE daemon. @@ -129,17 +134,20 @@ nhrpd connects to strongSwan using VICI protocol based on UNIX socket (hardcoded now as /var/run/charon.vici). strongSwan currently needs few patches applied. Please check out the -@uref{http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras-release,release} +`http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras-release,release `_ and -@uref{http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree} +`http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree `_ git repositories for the patches. -@node NHRP Events -@section NHRP Events +.. _NHRP_Events: + +NHRP Events +=========== FIXME -@node Configuration Example -@section Configuration Example +Configuration Example +===================== FIXME + diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst new file mode 100644 index 0000000000..3644631c59 --- /dev/null +++ b/doc/user/ospf6d.rst @@ -0,0 +1,206 @@ +.. _OSPFv3: + +****** +OSPFv3 +****** + +*ospf6d* is a daemon support OSPF version 3 for IPv6 network. +OSPF for IPv6 is described in RFC2740. + +.. _OSPF6_router: + +OSPF6 router +============ + +.. index:: {Command} {router ospf6} {} + +{Command} {router ospf6} {} + +.. index:: {OSPF6 Command} {router-id `a.b.c.d`} {} + +{OSPF6 Command} {router-id `a.b.c.d`} {} + Set router's Router-ID. + +.. index:: {OSPF6 Command} {interface `ifname` area `area`} {} + +{OSPF6 Command} {interface `ifname` area `area`} {} + Bind interface to specified area, and start sending OSPF packets. `area` can + be specified as 0. + +.. index:: {OSPF6 Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} + +{OSPF6 Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} +.. index:: {OSPF6 Command} {no timers throttle spf} {} + +{OSPF6 Command} {no timers throttle spf} {} + This command sets the initial `delay`, the `initial-holdtime` + and the `maximum-holdtime` between when SPF is calculated and the + event which triggered the calculation. The times are specified in + milliseconds and must be in the range of 0 to 600000 milliseconds. + + The `delay` specifies the minimum amount of time to delay SPF + calculation (hence it affects how long SPF calculation is delayed after + an event which occurs outside of the holdtime of any previous SPF + calculation, and also serves as a minimum holdtime). + + Consecutive SPF calculations will always be seperated by at least + 'hold-time' milliseconds. The hold-time is adaptive and initially is + set to the `initial-holdtime` configured with the above command. + Events which occur within the holdtime of the previous SPF calculation + will cause the holdtime to be increased by `initial-holdtime`, bounded + by the `maximum-holdtime` configured with this command. If the adaptive + hold-time elapses without any SPF-triggering event occuring then + the current holdtime is reset to the `initial-holdtime`. + +:: + + @group + router ospf6 + timers throttle spf 200 400 10000 + @end group + + + In this example, the `delay` is set to 200ms, the @var{initial + holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence + there will always be at least 200ms between an event which requires SPF + calculation and the actual SPF calculation. Further consecutive SPF + calculations will always be seperated by between 400ms to 10s, the + hold-time increasing by 400ms each time an SPF-triggering event occurs + within the hold-time of the previous SPF calculation. + +.. index:: {OSPF6 Command} {auto-cost reference-bandwidth `cost`} {} + +{OSPF6 Command} {auto-cost reference-bandwidth `cost`} {} +.. index:: {OSPF6 Command} {no auto-cost reference-bandwidth} {} + +{OSPF6 Command} {no auto-cost reference-bandwidth} {} + This sets the reference bandwidth for cost calculations, where this + bandwidth is considered equivalent to an OSPF cost of 1, specified in + Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s + or higher will have a cost of 1. Cost of lower bandwidth links will be + scaled with reference to this cost). + + This configuration setting MUST be consistent across all routers + within the OSPF domain. + +.. _OSPF6_area: + +OSPF6 area +========== + +Area support for OSPFv3 is not yet implemented. + +.. _OSPF6_interface: + +OSPF6 interface +=============== + +.. index:: {Interface Command} {ipv6 ospf6 cost COST} {} + +{Interface Command} {ipv6 ospf6 cost COST} {} + Sets interface's output cost. Default value depends on the interface + bandwidth and on the auto-cost reference bandwidth. + +.. index:: {Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {} + +{Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {} + Sets interface's Hello Interval. Default 40 + +.. index:: {Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {} + +{Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {} + Sets interface's Router Dead Interval. Default value is 40. + +.. index:: {Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {} + +{Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {} + Sets interface's Rxmt Interval. Default value is 5. + +.. index:: {Interface Command} {ipv6 ospf6 priority PRIORITY} {} + +{Interface Command} {ipv6 ospf6 priority PRIORITY} {} + Sets interface's Router Priority. Default value is 1. + +.. index:: {Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {} + +{Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {} + Sets interface's Inf-Trans-Delay. Default value is 1. + +.. index:: {Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {} + +{Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {} + Set explicitly network type for specifed interface. + +.. _Redistribute_routes_to_OSPF6: + +Redistribute routes to OSPF6 +============================ + +.. index:: {OSPF6 Command} {redistribute static} {} + +{OSPF6 Command} {redistribute static} {} +.. index:: {OSPF6 Command} {redistribute connected} {} + +{OSPF6 Command} {redistribute connected} {} +.. index:: {OSPF6 Command} {redistribute ripng} {} + +{OSPF6 Command} {redistribute ripng} {} + +.. _Showing_OSPF6_information: + +Showing OSPF6 information +========================= + +.. index:: {Command} {show ipv6 ospf6 [INSTANCE_ID]} {} + +{Command} {show ipv6 ospf6 [INSTANCE_ID]} {} + INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF + instance ID, simply type "show ipv6 ospf6 ". + +.. index:: {Command} {show ipv6 ospf6 database} {} + +{Command} {show ipv6 ospf6 database} {} + This command shows LSA database summary. You can specify the type of LSA. + +.. index:: {Command} {show ipv6 ospf6 interface} {} + +{Command} {show ipv6 ospf6 interface} {} + To see OSPF interface configuration like costs. + +.. index:: {Command} {show ipv6 ospf6 neighbor} {} + +{Command} {show ipv6 ospf6 neighbor} {} + Shows state and chosen (Backup) DR of neighbor. + +.. index:: {Command} {show ipv6 ospf6 request-list A.B.C.D} {} + +{Command} {show ipv6 ospf6 request-list A.B.C.D} {} + Shows requestlist of neighbor. + +.. index:: {Command} {show ipv6 route ospf6} {} + +{Command} {show ipv6 route ospf6} {} + This command shows internal routing table. + +.. index:: {Command} {show ipv6 ospf6 zebra} {} + +{Command} {show ipv6 ospf6 zebra} {} + Shows state about what is being redistributed between zebra and OSPF6 + +OSPF6 Configuration Examples +============================ + +Example of ospf6d configured on one interface and area: + +:: + + interface eth0 + ipv6 ospf6 instance-id 0 + ! + router ospf6 + router-id 212.17.55.53 + area 0.0.0.0 range 2001:770:105:2::/64 + interface eth0 area 0.0.0.0 + ! + + diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst new file mode 100644 index 0000000000..c11c212da8 --- /dev/null +++ b/doc/user/ospf_fundamentals.rst @@ -0,0 +1,600 @@ +.. _OSPF_Fundamentals: + +OSPF Fundamentals +================= + +.. index:: Link-state routing protocol + +.. index:: Distance-vector routing protocol + +@acronym{OSPF} is, mostly, a link-state routing protocol. In contrast +to @dfn{distance-vector} protocols, such as @acronym{RIP} or +@acronym{BGP}, where routers describe available @dfn{paths} (i.e@. routes) +to each other, in @dfn{link-state} protocols routers instead +describe the state of their links to their immediate neighbouring +routers. + +.. index:: Link State Announcement + +.. index:: Link State Advertisement + +.. index:: LSA flooding + +.. index:: Link State DataBase + +Each router describes their link-state information in a message known +as an @acronym{LSA,Link State Advertisement}, which is then propogated +through to all other routers in a link-state routing domain, by a +process called @dfn{flooding}. Each router thus builds up an +@acronym{LSDB,Link State Database} of all the link-state messages. From +this collection of LSAs in the LSDB, each router can then calculate the +shortest path to any other router, based on some common metric, by +using an algorithm such as @url{http://www.cs.utexas.edu/users/EWD/, +Edgser Dijkstra}'s @acronym{SPF,Shortest Path First}. + +.. index:: Link-state routing protocol advantages + +By describing connectivity of a network in this way, in terms of +routers and links rather than in terms of the paths through a network, +a link-state protocol can use less bandwidth and converge more quickly +than other protocols. A link-state protocol need distribute only one +link-state message throughout the link-state domain when a link on any +single given router changes state, in order for all routers to +reconverge on the best paths through the network. In contrast, distance +vector protocols can require a progression of different path update +messages from a series of different routers in order to converge. + +.. index:: Link-state routing protocol disadvantages + +The disadvantage to a link-state protocol is that the process of +computing the best paths can be relatively intensive when compared to +distance-vector protocols, in which near to no computation need be done +other than (potentially) select between multiple routes. This overhead +is mostly negligible for modern embedded CPUs, even for networks with +thousands of nodes. The primary scaling overhead lies more in coping +with the ever greater frequency of LSA updates as the size of a +link-state area increases, in managing the @acronym{LSDB} and required +flooding. + +This section aims to give a distilled, but accurate, description of the +more important workings of @acronym{OSPF}@ which an administrator may need +to know to be able best configure and trouble-shoot @acronym{OSPF}@. + +OSPF Mechanisms +--------------- + +@acronym{OSPF} defines a range of mechanisms, concerned with detecting, +describing and propogating state through a network. These mechanisms +will nearly all be covered in greater detail further on. They may be +broadly classed as: + + + .. index:: OSPF Hello Protocol overview + + +*The Hello Protocol* + .. index:: OSPF Hello Protocol + + The OSPF Hello protocol allows OSPF to quickly detect changes in + two-way reachability between routers on a link. OSPF can additionally + avail of other sources of reachability information, such as link-state + information provided by hardware, or through dedicated reachability + protocols such as @acronym{BFD,Bi-directional Forwarding Detection}. + + OSPF also uses the Hello protocol to propagate certain state between + routers sharing a link, for example: + + +*Hello protocol configured state, such as the dead-interval.* + +*Router priority, for DR/BDR election.* + +*DR/BDR election results.* + +*Any optional capabilities supported by each router.* + + The Hello protocol is comparatively trivial and will not be explored in + greater detail than here. + + .. index:: OSPF LSA overview + + +*LSAs* + At the heart of @acronym{OSPF} are @acronym{LSA,Link State + Advertisement} messages. Despite the name, some @acronym{LSA}s do not, + strictly speaking, describe link-state information. Common + @acronym{LSA}s describe information such as: + + +** + Routers, in terms of their links. + +** + Networks, in terms of attached routers. + +** + Routes, external to a link-state domain: + + +*External Routes* + Routes entirely external to @acronym{OSPF}@. Routers originating such + routes are known as @acronym{ASBR,Autonomous-System Border Router} + routers. + + +*Summary Routes* + Routes which summarise routing information relating to OSPF areas + external to the OSPF link-state area at hand, originated by + @acronym{ABR,Area Boundary Router} routers. + + +*LSA Flooding* + OSPF defines several related mechanisms, used to manage synchronisation of + @acronym{LSDB}s between neighbours as neighbours form adjacencies and + the propogation, or @dfn{flooding} of new or updated @acronym{LSA}s. + + :ref:`OSPF_Flooding`. + + .. index:: OSPF Areas overview + + +*Areas* + OSPF provides for the protocol to be broken up into multiple smaller + and independent link-state areas. Each area must be connected to a + common backbone area by an @acronym{ABR,Area Boundary Router}. These + @acronym{ABR} routers are responsible for summarising the link-state + routing information of an area into @dfn{Summary LSAs}, possibly in a + condensed (i.e. aggregated) form, and then originating these summaries + into all other areas the @acronym{ABR} is connected to. + + Note that only summaries and external routes are passed between areas. + As these describe *paths*, rather than any router link-states, + routing between areas hence is by @dfn{distance-vector}, @strong{not} + link-state. + + :ref:`OSPF_Areas`. + +OSPF LSAs +--------- + +@acronym{LSA}s are the core object in OSPF@. Everything else in OSPF +revolves around detecting what to describe in LSAs, when to update +them, how to flood them throughout a network and how to calculate +routes from them. + +There are a variety of different @acronym{LSA}s, for purposes such +as describing actual link-state information, describing paths (i.e. +routes), describing bandwidth usage of links for +@acronym{TE,Traffic Engineering} purposes, and even arbitrary data +by way of *Opaque* @acronym{LSA}s. + +LSA Header +^^^^^^^^^^ + +All LSAs share a common header with the following information: + +* Type + + Different types of @acronym{LSA}s describe different things in + @acronym{OSPF}@. Types include: + + * Router LSA + * Network LSA + * Network Summary LSA + * Router Summary LSA + * AS-External LSA + + The specifics of the different types of LSA are examined below. + +* Advertising Router + + The Router ID of the router originating the LSA, see :ref:`ospf_router-id`. + +* LSA ID + + The ID of the LSA, which is typically derived in some way from the + information the LSA describes, e.g. a Router LSA uses the Router ID as + the LSA ID, a Network LSA will have the IP address of the @acronym{DR} + as its LSA ID@. + + The combination of the Type, ID and Advertising Router ID must uniquely + identify the @acronym{LSA}@. There can however be multiple instances of + an LSA with the same Type, LSA ID and Advertising Router ID, see + :ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`. + +* Age + + A number to allow stale @acronym{LSA}s to, eventually, be purged by routers + from their @acronym{LSDB}s. + + The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is + called the @dfn{MaxAge}. MaxAge LSAs are ignored in routing + calculations. LSAs must be periodically refreshed by their Advertising + Router before reaching MaxAge if they are to remain valid. + + Routers may deliberately flood LSAs with the age artificially set to + 3600 to indicate an LSA is no longer valid. This is called + @dfn{flushing} of an LSA@. + + It is not abnormal to see stale LSAs in the LSDB, this can occur where + a router has shutdown without flushing its LSA(s), e.g. where it has + become disconnected from the network. Such LSAs do little harm. + + .. _OSPF_LSA_sequence_number: + +* Sequence Number + + A number used to distinguish newer instances of an LSA from older instances. + +Link-State LSAs +^^^^^^^^^^^^^^^ + +Of all the various kinds of @acronym{LSA}s, just two types comprise the +actual link-state part of @acronym{OSPF}, Router @acronym{LSA}s and +Network @acronym{LSA}s. These LSA types are absolutely core to the +protocol. + +Instances of these LSAs are specific to the link-state area in which +they are originated. Routes calculated from these two LSA types are +called @dfn{intra-area routes}. + +* Router LSA + + Each OSPF Router must originate a router @acronym{LSA} to describe + itself. In it, the router lists each of its @acronym{OSPF} enabled + interfaces, for the given link-state area, in terms of: + + * Cost + + The output cost of that interface, scaled inversely to some commonly known + reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`. + + * Link Type + + * Transit Network + + A link to a multi-access network, on which the router has at least one + Full adjacency with another router. + + * @acronym{PtP,Point-to-Point} + + A link to a single remote router, with a Full adjacency. No + @acronym{DR, Designated Router} is elected on such links; no network + LSA is originated for such a link. + + * Stub + + A link with no adjacent neighbours, or a host route. + + * Link ID and Data + + These values depend on the Link Type: + + @multitable @columnfractions .18 .32 .32 + @headitem Link Type @tab Link ID @tab Link Data + + * Transit + @tab Link IP address of the @acronym{DR} + @tab Interface IP address + + * Point-to-Point + @tab Router ID of the remote router + @tab Local interface IP address, + or the @acronym{ifindex,MIB-II interface index} + for unnumbered links + + * Stub + @tab IP address + @tab Subnet Mask + + @end multitable + + Links on a router may be listed multiple times in the Router LSA, e.g. + a @acronym{PtP} interface on which OSPF is enabled must *always* + be described by a Stub link in the Router @acronym{LSA}, in addition to + being listed as PtP link in the Router @acronym{LSA} if the adjacency + with the remote router is Full. + + Stub links may also be used as a way to describe links on which OSPF is + *not* spoken, known as @dfn{passive interfaces}, see :ref:`OSPF_passive-interface,,passive-interface`. + +* Network LSA + + On multi-access links (e.g. ethernets, certain kinds of ATM and X@.25 + configurations), routers elect a @acronym{DR}@. The @acronym{DR} is + responsible for originating a Network @acronym{LSA}, which helps reduce + the information needed to describe multi-access networks with multiple + routers attached. The @acronym{DR} also acts as a hub for the flooding of + @acronym{LSA}s on that link, thus reducing flooding overheads. + + The contents of the Network LSA describes the: + + * Subnet Mask + + As the @acronym{LSA} ID of a Network LSA must be the IP address of the + @acronym{DR}, the Subnet Mask together with the @acronym{LSA} ID gives + you the network address. + + * Attached Routers + + Each router fully-adjacent with the @acronym{DR} is listed in the LSA, + by their Router-ID. This allows the corresponding Router @acronym{LSA}s to be + easily retrieved from the @acronym{LSDB}@. + +Summary of Link State LSAs: + +@multitable @columnfractions .18 .32 .40 +@headitem LSA Type @tab LSA ID Describes @tab LSA Data Describes + +* Router LSA +@tab The Router ID +@tab The @acronym{OSPF} enabled links of the router, within +a specific link-state area. + +* Network LSA +@tab The IP address of the @acronym{DR} for the network +@tab The Subnet Mask of the network, and the Router IDs of all routers +on the network. +@end multitable + +With an LSDB composed of just these two types of @acronym{LSA}, it is +possible to construct a directed graph of the connectivity between all +routers and networks in a given OSPF link-state area. So, not +surprisingly, when OSPF routers build updated routing tables, the first +stage of @acronym{SPF} calculation concerns itself only with these two +LSA types. + +Link-State LSA Examples +^^^^^^^^^^^^^^^^^^^^^^^ + +The example below (:ref:`OSPF_Link-State_LSA_Example`) shows two +@acronym{LSA}s, both originated by the same router (Router ID +192.168.0.49) and with the same @acronym{LSA} ID (192.168.0.49), but of +different LSA types. + +The first LSA being the router LSA describing 192.168.0.49's links: 2 links +to multi-access networks with fully-adjacent neighbours (i.e. Transit +links) and 1 being a Stub link (no adjacent neighbours). + +The second LSA being a Network LSA, for which 192.168.0.49 is the +@acronym{DR}, listing the Router IDs of 4 routers on that network which +are fully adjacent with 192.168.0.49. + +.. _OSPF_Link-State_LSA_Example: + +:: + + # show ip ospf database router 192.168.0.49 + + OSPF Router with ID (192.168.0.53) + + Router Link States (Area 0.0.0.0) + + LS age: 38 + Options: 0x2 : *|-|-|-|-|-|E|* + LS Flags: 0x6 + Flags: 0x2 : ASBR + LS Type: router-LSA + Link State ID: 192.168.0.49 + Advertising Router: 192.168.0.49 + LS Seq Number: 80000f90 + Checksum: 0x518b + Length: 60 + Number of Links: 3 + + Link connected to: a Transit Network + (Link ID) Designated Router address: 192.168.1.3 + (Link Data) Router Interface address: 192.168.1.3 + Number of TOS metrics: 0 + TOS 0 Metric: 10 + + Link connected to: a Transit Network + (Link ID) Designated Router address: 192.168.0.49 + (Link Data) Router Interface address: 192.168.0.49 + Number of TOS metrics: 0 + TOS 0 Metric: 10 + + Link connected to: Stub Network + (Link ID) Net: 192.168.3.190 + (Link Data) Network Mask: 255.255.255.255 + Number of TOS metrics: 0 + TOS 0 Metric: 39063 + # show ip ospf database network 192.168.0.49 + + OSPF Router with ID (192.168.0.53) + + Net Link States (Area 0.0.0.0) + + LS age: 285 + Options: 0x2 : *|-|-|-|-|-|E|* + LS Flags: 0x6 + LS Type: network-LSA + Link State ID: 192.168.0.49 (address of Designated Router) + Advertising Router: 192.168.0.49 + LS Seq Number: 80000074 + Checksum: 0x0103 + Length: 40 + Network Mask: /29 + Attached Router: 192.168.0.49 + Attached Router: 192.168.0.52 + Attached Router: 192.168.0.53 + Attached Router: 192.168.0.54 + + +Note that from one LSA, you can find the other. E.g. Given the +Network-LSA you have a list of Router IDs on that network, from which +you can then look up, in the local @acronym{LSDB}, the matching Router +LSA@. From that Router-LSA you may (potentially) find links to other +Transit networks and Routers IDs which can be used to lookup the +corresponding Router or Network LSA@. And in that fashion, one can find +all the Routers and Networks reachable from that starting @acronym{LSA}@. + +Given the Router LSA instead, you have the IP address of the +@acronym{DR} of any attached transit links. Network LSAs will have that IP +as their LSA ID, so you can then look up that Network LSA and from that +find all the attached routers on that link, leading potentially to more +links and Network and Router LSAs, etc. etc. + +From just the above two @acronym{LSA}s, one can already see the +following partial topology: +:: + + @group + + --------------------- Network: ...... + | Designated Router IP: 192.168.1.3 + | + IP: 192.168.1.3 + (transit link) + (cost: 10) + Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32 + (cost: 10) (cost: 39063) + (transit link) + IP: 192.168.0.49 + | + | + ------------------------------ Network: 192.168.0.48/29 + | | | Designated Router IP: 192.168.0.49 + | | | + | | Router ID: 192.168.0.54 + | | + | Router ID: 192.168.0.53 + | + Router ID: 192.168.0.52 + @end group + + +Note the Router IDs, though they look like IP addresses and often are +IP addresses, are not strictly speaking IP addresses, nor need they be +reachable addresses (though, OSPF will calculate routes to Router IDs). + +External LSAs +^^^^^^^^^^^^^ + +External, or "Type 5", @acronym{LSA}s describe routing information which is +entirely external to @acronym{OSPF}, and is "injected" into +@acronym{OSPF}@. Such routing information may have come from another +routing protocol, such as RIP or BGP, they may represent static routes +or they may represent a default route. + +An @acronym{OSPF} router which originates External @acronym{LSA}s is known as an +@acronym{ASBR,AS Boundary Router}. Unlike the link-state @acronym{LSA}s, and +most other @acronym{LSA}s, which are flooded only within the area in +which they originate, External @acronym{LSA}s are flooded through-out +the @acronym{OSPF} network to all areas capable of carrying External +@acronym{LSA}s (:ref:`OSPF_Areas`). + +Routes internal to OSPF (intra-area or inter-area) are always preferred +over external routes. + +The External @acronym{LSA} describes the following: + +* IP Network number + + The IP Network number of the route is described by the @acronym{LSA} ID + field. + +* IP Network Mask + + The body of the External LSA describes the IP Network Mask of the + route. This, together with the @acronym{LSA} ID, describes the prefix + of the IP route concerned. + +* Metric + + The cost of the External Route. This cost may be an OSPF cost (also + known as a "Type 1" metric), i.e. equivalent to the normal OSPF costs, + or an externally derived cost ("Type 2" metric) which is not comparable + to OSPF costs and always considered larger than any OSPF cost. Where + there are both Type 1 and 2 External routes for a route, the Type 1 is + always preferred. + +* Forwarding Address + + The address of the router to forward packets to for the route. This may + be, and usually is, left as 0 to specify that the ASBR originating the + External @acronym{LSA} should be used. There must be an internal OSPF + route to the forwarding address, for the forwarding address to be + useable. + +* Tag + + An arbitrary 4-bytes of data, not interpreted by OSPF, which may + carry whatever information about the route which OSPF speakers desire. + +AS External LSA Example +^^^^^^^^^^^^^^^^^^^^^^^ + +To illustrate, below is an example of an External @acronym{LSA} in the +@acronym{LSDB} of an OSPF router. It describes a route to the IP prefix +of 192.168.165.0/24, originated by the ASBR with Router-ID +192.168.0.49. The metric of 20 is external to OSPF. The forwarding +address is 0, so the route should forward to the originating ASBR if +selected. + +:: + + @group + # show ip ospf database external 192.168.165.0 + LS age: 995 + Options: 0x2 : *|-|-|-|-|-|E|* + LS Flags: 0x9 + LS Type: AS-external-LSA + Link State ID: 192.168.165.0 (External Network Number) + Advertising Router: 192.168.0.49 + LS Seq Number: 800001d8 + Checksum: 0xea27 + Length: 36 + Network Mask: /24 + Metric Type: 2 (Larger than any link state path) + TOS: 0 + Metric: 20 + Forward Address: 0.0.0.0 + External Route Tag: 0 + @end group + + +We can add this to our partial topology from above, which now looks +like: +:: + + @group + --------------------- Network: ...... + | Designated Router IP: 192.168.1.3 + | + IP: 192.168.1.3 /---- External route: 192.168.165.0/24 + (transit link) / Cost: 20 (External metric) + (cost: 10) / + Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32 + (cost: 10) (cost: 39063) + (transit link) + IP: 192.168.0.49 + | + | + ------------------------------ Network: 192.168.0.48/29 + | | | Designated Router IP: 192.168.0.49 + | | | + | | Router ID: 192.168.0.54 + | | + | Router ID: 192.168.0.53 + | + Router ID: 192.168.0.52 + @end group + + +Summary LSAs +^^^^^^^^^^^^ + +Summary LSAs are created by @acronym{ABR}s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or @acronym{ASBR} routers. + +.. _OSPF_Flooding: + +OSPF Flooding +------------- + +.. _OSPF_Areas: + +OSPF Areas +---------- + + diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst new file mode 100644 index 0000000000..78360c7503 --- /dev/null +++ b/doc/user/ospfd.rst @@ -0,0 +1,1280 @@ +.. _OSPFv2: + +****** +OSPFv2 +****** + +@acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol +which is described in @cite{RFC2328, OSPF Version 2}. OSPF is an +@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, +@acronym{OSPF} can provide scalable network support and faster +convergence times. OSPF is widely used in large networks such as +@acronym{ISP,Internet Service Provider} backbone and enterprise +networks. + +@include ospf_fundamentals.texi + +.. _Configuring_ospfd: + +Configuring ospfd +================= + +There are no *ospfd* specific options. Common options can be +specified (:ref:`Common_Invocation_Options`) to *ospfd*. +*ospfd* needs to acquire interface information from +*zebra* in order to function. Therefore *zebra* must be +running before invoking *ospfd*. Also, if *zebra* is +restarted then *ospfd* must be too. + +Like other daemons, *ospfd* configuration is done in @acronym{OSPF} +specific configuration file :file:`ospfd.conf`. + +.. _OSPF_router: + +OSPF router +=========== + +To start OSPF process you have to specify the OSPF router. As of this +writing, *ospfd* does not support multiple OSPF processes. + +.. index:: Command {router ospf} {} + +Command {router ospf} {} +.. index:: Command {no router ospf} {} + +Command {no router ospf} {} + Enable or disable the OSPF process. *ospfd* does not yet + support multiple OSPF processes. So you can not specify an OSPF process + number. + +.. index:: {OSPF Command} {ospf router-id `a.b.c.d`} {} + +{OSPF Command} {ospf router-id `a.b.c.d`} {} +.. index:: {OSPF Command} {no ospf router-id} {} + +{OSPF Command} {no ospf router-id} {} + .. _ospf_router-id: + + This sets the router-ID of the OSPF process. The + router-ID may be an IP address of the router, but need not be - it can + be any arbitrary 32bit number. However it MUST be unique within the + entire OSPF domain to the OSPF speaker - bad things will happen if + multiple OSPF speakers are configured with the same router-ID! If one + is not specified then *ospfd* will obtain a router-ID + automatically from *zebra*. + +.. index:: {OSPF Command} {ospf abr-type `type`} {} + +{OSPF Command} {ospf abr-type `type`} {} +.. index:: {OSPF Command} {no ospf abr-type `type`} {} + +{OSPF Command} {no ospf abr-type `type`} {} + `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types + are equivalent. + + The OSPF standard for ABR behaviour does not allow an ABR to consider + routes through non-backbone areas when its links to the backbone are + down, even when there are other ABRs in attached non-backbone areas + which still can reach the backbone - this restriction exists primarily + to ensure routing-loops are avoided. + + With the "Cisco" or "IBM" ABR type, the default in this release of + Frr, this restriction is lifted, allowing an ABR to consider + summaries learnt from other ABRs through non-backbone areas, and hence + route via non-backbone areas as a last resort when, and only when, + backbone links are down. + + Note that areas with fully-adjacent virtual-links are considered to be + "transit capable" and can always be used to route backbone traffic, and + hence are unaffected by this setting (:ref:`OSPF_virtual-link`). + + More information regarding the behaviour controlled by this command can + be found in @cite{RFC 3509, Alternative Implementations of OSPF Area + Border Routers}, and @cite{draft-ietf-ospf-shortcut-abr-02.txt}. + + Quote: "Though the definition of the @acronym{ABR,Area Border Router} + in the OSPF specification does not require a router with multiple + attached areas to have a backbone connection, it is actually + necessary to provide successful routing to the inter-area and + external destinations. If this requirement is not met, all traffic + destined for the areas not connected to such an ABR or out of the + OSPF domain, is dropped. This document describes alternative ABR + behaviors implemented in Cisco and IBM routers." + +.. index:: {OSPF Command} {ospf rfc1583compatibility} {} + +{OSPF Command} {ospf rfc1583compatibility} {} +.. index:: {OSPF Command} {no ospf rfc1583compatibility} {} + +{OSPF Command} {no ospf rfc1583compatibility} {} + @cite{RFC2328}, the sucessor to @cite{RFC1583}, suggests according + to section G.2 (changes) in section 16.4 a change to the path + preference algorithm that prevents possible routing loops that were + possible in the old version of OSPFv2. More specifically it demands + that inter-area paths and intra-area backbone path are now of equal preference + but still both preferred to external paths. + + This command should NOT be set normally. + +.. index:: {OSPF Command} {log-adjacency-changes [detail]} {} + +{OSPF Command} {log-adjacency-changes [detail]} {} +.. index:: {OSPF Command} {no log-adjacency-changes [detail]} {} + +{OSPF Command} {no log-adjacency-changes [detail]} {} + Configures ospfd to log changes in adjacency. With the optional + detail argument, all changes in adjacency status are shown. Without detail, + only changes to full or regressions are shown. + +.. index:: {OSPF Command} {passive-interface `interface`} {} + +{OSPF Command} {passive-interface `interface`} {} +.. index:: {OSPF Command} {no passive-interface `interface`} {} + +{OSPF Command} {no passive-interface `interface`} {} + .. _OSPF_passive-interface: + + Do not speak OSPF interface on the + given interface, but do advertise the interface as a stub link in the + router-@acronym{LSA,Link State Advertisement} for this router. This + allows one to advertise addresses on such connected interfaces without + having to originate AS-External/Type-5 LSAs (which have global flooding + scope) - as would occur if connected addresses were redistributed into + OSPF (:ref:`Redistribute_routes_to_OSPF`)@. This is the only way to + advertise non-OSPF links into stub areas. + +.. index:: {OSPF Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} + +{OSPF Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} +.. index:: {OSPF Command} {no timers throttle spf} {} + +{OSPF Command} {no timers throttle spf} {} + This command sets the initial `delay`, the `initial-holdtime` + and the `maximum-holdtime` between when SPF is calculated and the + event which triggered the calculation. The times are specified in + milliseconds and must be in the range of 0 to 600000 milliseconds. + + The `delay` specifies the minimum amount of time to delay SPF + calculation (hence it affects how long SPF calculation is delayed after + an event which occurs outside of the holdtime of any previous SPF + calculation, and also serves as a minimum holdtime). + + Consecutive SPF calculations will always be seperated by at least + 'hold-time' milliseconds. The hold-time is adaptive and initially is + set to the `initial-holdtime` configured with the above command. + Events which occur within the holdtime of the previous SPF calculation + will cause the holdtime to be increased by `initial-holdtime`, bounded + by the `maximum-holdtime` configured with this command. If the adaptive + hold-time elapses without any SPF-triggering event occuring then + the current holdtime is reset to the `initial-holdtime`. The current + holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as + a multiplier of the `initial-holdtime`. + +:: + + @group + router ospf + timers throttle spf 200 400 10000 + @end group + + + In this example, the `delay` is set to 200ms, the @var{initial + holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence + there will always be at least 200ms between an event which requires SPF + calculation and the actual SPF calculation. Further consecutive SPF + calculations will always be seperated by between 400ms to 10s, the + hold-time increasing by 400ms each time an SPF-triggering event occurs + within the hold-time of the previous SPF calculation. + + This command supercedes the *timers spf* command in previous Frr + releases. + +.. index:: {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} + +{OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} +.. index:: {OSPF Command} {max-metric router-lsa administrative} {} + +{OSPF Command} {max-metric router-lsa administrative} {} +.. index:: {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} + +{OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} + This enables @cite{RFC3137, OSPF Stub Router Advertisement} support, + where the OSPF process describes its transit links in its router-LSA as + having infinite distance so that other routers will avoid calculating + transit paths through the router while still being able to reach + networks through the router. + + This support may be enabled administratively (and indefinitely) or + conditionally. Conditional enabling of max-metric router-lsas can be + for a period of seconds after startup and/or for a period of seconds + prior to shutdown. + + Enabling this for a period after startup allows OSPF to converge fully + first without affecting any existing routes used by other routers, + while still allowing any connected stub links and/or redistributed + routes to be reachable. Enabling this for a period of time in advance + of shutdown allows the router to gracefully excuse itself from the OSPF + domain. + + Enabling this feature administratively allows for administrative + intervention for whatever reason, for an indefinite period of time. + Note that if the configuration is written to file, this administrative + form of the stub-router command will also be written to file. If + *ospfd* is restarted later, the command will then take effect + until manually deconfigured. + + Configured state of this feature as well as current status, such as the + number of second remaining till on-startup or on-shutdown ends, can be + viewed with the :ref:`show_ip_ospf` command. + +.. index:: {OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {} + +{OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {} +.. index:: {OSPF Command} {no auto-cost reference-bandwidth} {} + +{OSPF Command} {no auto-cost reference-bandwidth} {} + .. _OSPF_auto-cost_reference-bandwidth: + + This sets the reference + bandwidth for cost calculations, where this bandwidth is considered + equivalent to an OSPF cost of 1, specified in Mbits/s. The default is + 100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a + cost of 1. Cost of lower bandwidth links will be scaled with reference + to this cost). + + This configuration setting MUST be consistent across all routers within the + OSPF domain. + +.. index:: {OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {} + +{OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {} +.. index:: {OSPF Command} {network `a.b.c.d/m` area `<0-4294967295>`} {} + +{OSPF Command} {network `a.b.c.d/m` area `<0-4294967295>`} {} +.. index:: {OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {} + +{OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {} +.. index:: {OSPF Command} {no network `a.b.c.d/m` area `<0-4294967295>`} {} + +{OSPF Command} {no network `a.b.c.d/m` area `<0-4294967295>`} {} + .. _OSPF_network_command: + + This command specifies the OSPF enabled interface(s). If the interface has + an address from range 192.168.1.0/24 then the command below enables ospf + on this interface so router can provide network information to the other + ospf routers via this interface. + +:: + + @group + router ospf + network 192.168.1.0/24 area 0.0.0.0 + @end group + + + Prefix length in interface must be equal or bigger (ie. smaller network) than + prefix length in network statement. For example statement above doesn't enable + ospf on interface with address 192.168.1.1/23, but it does on interface with + address 192.168.1.129/25. + + Note that the behavior when there is a peer address + defined on an interface changed after release 0.99.7. + Currently, if a peer prefix has been configured, + then we test whether the prefix in the network command contains + the destination prefix. Otherwise, we test whether the network command prefix + contains the local address prefix of the interface. + + In some cases it may be more convenient to enable OSPF on a per + interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`). + + +.. _OSPF_area: + +OSPF area +========= + +.. index:: {OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {} + +{OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {} +.. index:: {OSPF Command} {area <0-4294967295> range `a.b.c.d/m`} {} + +{OSPF Command} {area <0-4294967295> range `a.b.c.d/m`} {} +.. index:: {OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {} + +{OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {} +.. index:: {OSPF Command} {no area <0-4294967295> range `a.b.c.d/m`} {} + +{OSPF Command} {no area <0-4294967295> range `a.b.c.d/m`} {} + Summarize intra area paths from specified area into one Type-3 summary-LSA + announced to other areas. This command can be used only in ABR and ONLY + router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can + be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. + Summarizing Type-7 AS-external-LSAs isn't supported yet by Frr. + +:: + + @group + router ospf + network 192.168.1.0/24 area 0.0.0.0 + network 10.0.0.0/8 area 0.0.0.10 + area 0.0.0.10 range 10.0.0.0/8 + @end group + + + With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is + announced into backbone area if area 0.0.0.10 contains at least one intra-area + network (ie. described with router or network LSA) from this range. + +.. index:: {OSPF Command} {area `a.b.c.d` range IPV4_PREFIX not-advertise} {} + +{OSPF Command} {area `a.b.c.d` range IPV4_PREFIX not-advertise} {} +.. index:: {OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX not-advertise} {} + +{OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX not-advertise} {} + Instead of summarizing intra area paths filter them - ie. intra area paths from this + range are not advertised into other areas. + This command makes sense in ABR only. + +.. index:: {OSPF Command} {area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} + +{OSPF Command} {area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} +.. index:: {OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} + +{OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} + Substitute summarized prefix with another prefix. + +:: + + @group + router ospf + network 192.168.1.0/24 area 0.0.0.0 + network 10.0.0.0/8 area 0.0.0.10 + area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 + @end group + + + One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if + area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or + network-LSA) from range 10.0.0.0/8. + This command makes sense in ABR only. + +.. index:: {OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {} + +{OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {} +.. index:: {OSPF Command} {area <0-4294967295> virtual-link `a.b.c.d`} {} + +{OSPF Command} {area <0-4294967295> virtual-link `a.b.c.d`} {} +.. index:: {OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {} + +{OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {} +.. index:: {OSPF Command} {no area <0-4294967295> virtual-link `a.b.c.d`} {} + +{OSPF Command} {no area <0-4294967295> virtual-link `a.b.c.d`} {} + .. _OSPF_virtual-link: + +.. index:: {OSPF Command} {area `a.b.c.d` shortcut} {} + +{OSPF Command} {area `a.b.c.d` shortcut} {} +.. index:: {OSPF Command} {area <0-4294967295> shortcut} {} + +{OSPF Command} {area <0-4294967295> shortcut} {} +.. index:: {OSPF Command} {no area `a.b.c.d` shortcut} {} + +{OSPF Command} {no area `a.b.c.d` shortcut} {} +.. index:: {OSPF Command} {no area <0-4294967295> shortcut} {} + +{OSPF Command} {no area <0-4294967295> shortcut} {} + Configure the area as Shortcut capable. See @cite{RFC3509}. This requires + that the 'abr-type' be set to 'shortcut'. + +.. index:: {OSPF Command} {area `a.b.c.d` stub} {} + +{OSPF Command} {area `a.b.c.d` stub} {} +.. index:: {OSPF Command} {area <0-4294967295> stub} {} + +{OSPF Command} {area <0-4294967295> stub} {} +.. index:: {OSPF Command} {no area `a.b.c.d` stub} {} + +{OSPF Command} {no area `a.b.c.d` stub} {} +.. index:: {OSPF Command} {no area <0-4294967295> stub} {} + +{OSPF Command} {no area <0-4294967295> stub} {} + Configure the area to be a stub area. That is, an area where no router + originates routes external to OSPF and hence an area where all external + routes are via the ABR(s). Hence, ABRs for such an area do not need + to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the + area. They need only pass Network-Summary (type-3) LSAs into such an area, + along with a default-route summary. + +.. index:: {OSPF Command} {area `a.b.c.d` stub no-summary} {} + +{OSPF Command} {area `a.b.c.d` stub no-summary} {} +.. index:: {OSPF Command} {area <0-4294967295> stub no-summary} {} + +{OSPF Command} {area <0-4294967295> stub no-summary} {} +.. index:: {OSPF Command} {no area `a.b.c.d` stub no-summary} {} + +{OSPF Command} {no area `a.b.c.d` stub no-summary} {} +.. index:: {OSPF Command} {no area <0-4294967295> stub no-summary} {} + +{OSPF Command} {no area <0-4294967295> stub no-summary} {} + Prevents an *ospfd* ABR from injecting inter-area + summaries into the specified stub area. + +.. index:: {OSPF Command} {area `a.b.c.d` default-cost <0-16777215>} {} + +{OSPF Command} {area `a.b.c.d` default-cost <0-16777215>} {} +.. index:: {OSPF Command} {no area `a.b.c.d` default-cost <0-16777215>} {} + +{OSPF Command} {no area `a.b.c.d` default-cost <0-16777215>} {} + Set the cost of default-summary LSAs announced to stubby areas. + +.. index:: {OSPF Command} {area `a.b.c.d` export-list NAME} {} + +{OSPF Command} {area `a.b.c.d` export-list NAME} {} +.. index:: {OSPF Command} {area <0-4294967295> export-list NAME} {} + +{OSPF Command} {area <0-4294967295> export-list NAME} {} +.. index:: {OSPF Command} {no area `a.b.c.d` export-list NAME} {} + +{OSPF Command} {no area `a.b.c.d` export-list NAME} {} +.. index:: {OSPF Command} {no area <0-4294967295> export-list NAME} {} + +{OSPF Command} {no area <0-4294967295> export-list NAME} {} + Filter Type-3 summary-LSAs announced to other areas originated from intra- + area paths from specified area. + +:: + + @group + router ospf + network 192.168.1.0/24 area 0.0.0.0 + network 10.0.0.0/8 area 0.0.0.10 + area 0.0.0.10 export-list foo + ! + access-list foo permit 10.10.0.0/16 + access-list foo deny any + @end group + + + With example above any intra-area paths from area 0.0.0.10 and from range + 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into + other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16 + or 10.128.30.16/30) aren't. + + This command is only relevant if the router is an ABR for the specified + area. + +.. index:: {OSPF Command} {area `a.b.c.d` import-list NAME} {} + +{OSPF Command} {area `a.b.c.d` import-list NAME} {} +.. index:: {OSPF Command} {area <0-4294967295> import-list NAME} {} + +{OSPF Command} {area <0-4294967295> import-list NAME} {} +.. index:: {OSPF Command} {no area `a.b.c.d` import-list NAME} {} + +{OSPF Command} {no area `a.b.c.d` import-list NAME} {} +.. index:: {OSPF Command} {no area <0-4294967295> import-list NAME} {} + +{OSPF Command} {no area <0-4294967295> import-list NAME} {} + Same as export-list, but it applies to paths announced into specified area as + Type-3 summary-LSAs. + +.. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME in} {} + +{OSPF Command} {area `a.b.c.d` filter-list prefix NAME in} {} +.. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {} + +{OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {} +.. index:: {OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {} + +{OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {} +.. index:: {OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {} + +{OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {} +.. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {} + +{OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {} +.. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {} + +{OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {} +.. index:: {OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {} + +{OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {} +.. index:: {OSPF Command} {no area <0-4294967295> filter-list prefix NAME out} {} + +{OSPF Command} {no area <0-4294967295> filter-list prefix NAME out} {} + Filtering Type-3 summary-LSAs to/from area using prefix lists. This command + makes sense in ABR only. + +.. index:: {OSPF Command} {area `a.b.c.d` authentication} {} + +{OSPF Command} {area `a.b.c.d` authentication} {} +.. index:: {OSPF Command} {area <0-4294967295> authentication} {} + +{OSPF Command} {area <0-4294967295> authentication} {} +.. index:: {OSPF Command} {no area `a.b.c.d` authentication} {} + +{OSPF Command} {no area `a.b.c.d` authentication} {} +.. index:: {OSPF Command} {no area <0-4294967295> authentication} {} + +{OSPF Command} {no area <0-4294967295> authentication} {} + Specify that simple password authentication should be used for the given + area. + +.. index:: {OSPF Command} {area `a.b.c.d` authentication message-digest} {} + +{OSPF Command} {area `a.b.c.d` authentication message-digest} {} +.. index:: {OSPF Command} {area <0-4294967295> authentication message-digest} {} + +{OSPF Command} {area <0-4294967295> authentication message-digest} {} + .. _area_authentication_message-digest: + + Specify that OSPF packets + must be authenticated with MD5 HMACs within the given area. Keying + material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`). + + MD5 authentication may also be configured on a per-interface basis + (:ref:`ip_ospf_authentication_message-digest`). Such per-interface + settings will override any per-area authentication setting. + +.. _OSPF_interface: + +OSPF interface +============== + +.. index:: {Interface Command} {ip ospf area `AREA` [`ADDR`]} {} + +{Interface Command} {ip ospf area `AREA` [`ADDR`]} {} +.. index:: {Interface Command} {no ip ospf area [`ADDR`]} {} + +{Interface Command} {no ip ospf area [`ADDR`]} {} + .. _OSPF_ip_ospf_area_command: + + Enable OSPF on the interface, optionally restricted to just the IP address + given by `ADDR`, putting it in the `AREA` area. Per interface area + settings take precedence to network commands (:ref:`OSPF_network_command`). + + If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF + via this command may result in a slight performance improvement. + +.. index:: {Interface Command} {ip ospf authentication-key `AUTH_KEY`} {} + +{Interface Command} {ip ospf authentication-key `AUTH_KEY`} {} +.. index:: {Interface Command} {no ip ospf authentication-key} {} + +{Interface Command} {no ip ospf authentication-key} {} + Set OSPF authentication key to a simple password. After setting `AUTH_KEY`, + all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars. + + Simple text password authentication is insecure and deprecated in favour of + MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`). + +.. index:: {Interface Command} {ip ospf authentication message-digest} {} + +{Interface Command} {ip ospf authentication message-digest} {} + .. _ip_ospf_authentication_message-digest: + + Specify that MD5 HMAC + authentication must be used on this interface. MD5 keying material must + also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any + authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`). + + Note that OSPF MD5 authentication requires that time never go backwards + (correct time is NOT important, only that it never goes backwards), even + across resets, if ospfd is to be able to promptly reestabish adjacencies + with its neighbours after restarts/reboots. The host should have system + time be set at boot from an external or non-volatile source (eg battery backed clock, NTP, + etc.) or else the system clock should be periodically saved to non-volative + storage and restored at boot if MD5 authentication is to be expected to work + reliably. + +.. index:: {Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {} + +{Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {} +.. index:: {Interface Command} {no ip ospf message-digest-key} {} + +{Interface Command} {no ip ospf message-digest-key} {} + .. _ip_ospf_message-digest-key: + + Set OSPF authentication key to a + cryptographic password. The cryptographic algorithm is MD5. + + KEYID identifies secret key used to create the message digest. This ID + is part of the protocol and must be consistent across routers on a + link. + + KEY is the actual message digest key, of up to 16 chars (larger strings + will be truncated), and is associated with the given KEYID. + +.. index:: {Interface Command} {ip ospf cost <1-65535>} {} + +{Interface Command} {ip ospf cost <1-65535>} {} +.. index:: {Interface Command} {no ip ospf cost} {} + +{Interface Command} {no ip ospf cost} {} + Set link cost for the specified interface. The cost value is set to router-LSA's + metric field and used for SPF calculation. + +.. index:: {Interface Command} {ip ospf dead-interval <1-65535>} {} + +{Interface Command} {ip ospf dead-interval <1-65535>} {} +.. index:: {Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {} + +{Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {} +.. index:: {Interface Command} {no ip ospf dead-interval} {} + +{Interface Command} {no ip ospf dead-interval} {} + .. _ip_ospf_dead-interval_minimal: + + Set number of seconds for + RouterDeadInterval timer value used for Wait Timer and Inactivity + Timer. This value must be the same for all routers attached to a + common network. The default value is 40 seconds. + + If 'minimal' is specified instead, then the dead-interval is set to 1 + second and one must specify a hello-multiplier. The hello-multiplier + specifies how many Hellos to send per second, from 2 (every 500ms) to + 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form + is specified, then the hello-interval advertised in Hello packets is set to + 0 and the hello-interval on received Hello packets is not checked, thus + the hello-multiplier need NOT be the same across multiple routers on a common + link. + +.. index:: {Interface Command} {ip ospf hello-interval <1-65535>} {} + +{Interface Command} {ip ospf hello-interval <1-65535>} {} +.. index:: {Interface Command} {no ip ospf hello-interval} {} + +{Interface Command} {no ip ospf hello-interval} {} + Set number of seconds for HelloInterval timer value. Setting this value, + Hello packet will be sent every timer value seconds on the specified interface. + This value must be the same for all routers attached to a common network. + The default value is 10 seconds. + + This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also + specified for the interface. + +.. index:: {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} + +{Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} +.. index:: {Interface Command} {no ip ospf network} {} + +{Interface Command} {no ip ospf network} {} + Set explicitly network type for specifed interface. + +.. index:: {Interface Command} {ip ospf priority <0-255>} {} + +{Interface Command} {ip ospf priority <0-255>} {} +.. index:: {Interface Command} {no ip ospf priority} {} + +{Interface Command} {no ip ospf priority} {} + Set RouterPriority integer value. The router with the highest priority + will be more eligible to become Designated Router. Setting the value + to 0, makes the router ineligible to become Designated Router. The + default value is 1. + +.. index:: {Interface Command} {ip ospf retransmit-interval <1-65535>} {} + +{Interface Command} {ip ospf retransmit-interval <1-65535>} {} +.. index:: {Interface Command} {no ip ospf retransmit interval} {} + +{Interface Command} {no ip ospf retransmit interval} {} + Set number of seconds for RxmtInterval timer value. This value is used + when retransmitting Database Description and Link State Request packets. + The default value is 5 seconds. + +.. index:: {Interface Command} {ip ospf transmit-delay} {} + +{Interface Command} {ip ospf transmit-delay} {} +.. index:: {Interface Command} {no ip ospf transmit-delay} {} + +{Interface Command} {no ip ospf transmit-delay} {} + Set number of seconds for InfTransDelay value. LSAs' age should be + incremented by this value when transmitting. + The default value is 1 seconds. + +.. index:: {Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {} + +{Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {} +.. index:: {Interface Command} {no ip ospf area} {} + +{Interface Command} {no ip ospf area} {} + Enable ospf on an interface and set associated area. + +.. _Redistribute_routes_to_OSPF: + +Redistribute routes to OSPF +=========================== + +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) `route-map`} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) `route-map`} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map `word`} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map `word`} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map `word`} {} + +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map `word`} {} +.. index:: {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} + +{OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} + .. _OSPF_redistribute: + + Redistribute routes of the specified protocol + or kind into OSPF, with the metric type and metric set if specified, + filtering the routes using the given route-map if specified. + Redistributed routes may also be filtered with distribute-lists, see + :ref:`ospf_distribute-list`. + + Redistributed routes are distributed as into OSPF as Type-5 External + LSAs into links to areas that accept external routes, Type-7 External LSAs + for NSSA areas and are not redistributed at all into Stub areas, where + external routes are not permitted. + + Note that for connected routes, one may instead use + @dfn{passive-interface}, see :ref:`OSPF_passive-interface`. + +.. index:: {OSPF Command} {default-information originate} {} + +{OSPF Command} {default-information originate} {} +.. index:: {OSPF Command} {default-information originate metric <0-16777214>} {} + +{OSPF Command} {default-information originate metric <0-16777214>} {} +.. index:: {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {} + +{OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {} +.. index:: {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map `word`} {} + +{OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map `word`} {} +.. index:: {OSPF Command} {default-information originate always} {} + +{OSPF Command} {default-information originate always} {} +.. index:: {OSPF Command} {default-information originate always metric <0-16777214>} {} + +{OSPF Command} {default-information originate always metric <0-16777214>} {} +.. index:: {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {} + +{OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {} +.. index:: {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map `word`} {} + +{OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map `word`} {} +.. index:: {OSPF Command} {no default-information originate} {} + +{OSPF Command} {no default-information originate} {} + Originate an AS-External (type-5) LSA describing a default route into + all external-routing capable areas, of the specified metric and metric + type. If the 'always' keyword is given then the default is always + advertised, even when there is no default present in the routing table. + +.. index:: {OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {} + +{OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {} +.. index:: {OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {} + +{OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {} + .. _ospf_distribute-list: + + Apply the access-list filter, NAME, to + redistributed routes of the given type before allowing the routes to + redistributed into OSPF (:ref:`OSPF_redistribute`). + +.. index:: {OSPF Command} {default-metric <0-16777214>} {} + +{OSPF Command} {default-metric <0-16777214>} {} +.. index:: {OSPF Command} {no default-metric} {} + +{OSPF Command} {no default-metric} {} +.. index:: {OSPF Command} {distance <1-255>} {} + +{OSPF Command} {distance <1-255>} {} +.. index:: {OSPF Command} {no distance <1-255>} {} + +{OSPF Command} {no distance <1-255>} {} +.. index:: {OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {} + +{OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {} +.. index:: {OSPF Command} {no distance ospf} {} + +{OSPF Command} {no distance ospf} {} +.. index:: {Command} {router zebra} {} + +{Command} {router zebra} {} +.. index:: {Command} {no router zebra} {} + +{Command} {no router zebra} {} + +.. _Showing_OSPF_information: + +Showing OSPF information +======================== + +.. index:: {Command} {show ip ospf} {} + +{Command} {show ip ospf} {} + .. _show_ip_ospf: + + Show information on a variety of general OSPF and + area state and configuration information. + +.. index:: {Command} {show ip ospf interface [INTERFACE]} {} + +{Command} {show ip ospf interface [INTERFACE]} {} + Show state and configuration of OSPF the specified interface, or all + interfaces if no interface is given. + +.. index:: {Command} {show ip ospf neighbor} {} + +{Command} {show ip ospf neighbor} {} +.. index:: {Command} {show ip ospf neighbor INTERFACE} {} + +{Command} {show ip ospf neighbor INTERFACE} {} +.. index:: {Command} {show ip ospf neighbor detail} {} + +{Command} {show ip ospf neighbor detail} {} +.. index:: {Command} {show ip ospf neighbor INTERFACE detail} {} + +{Command} {show ip ospf neighbor INTERFACE detail} {} +.. index:: {Command} {show ip ospf database} {} + +{Command} {show ip ospf database} {} +.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {} + +{Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {} +.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id`} {} + +{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id`} {} +.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` adv-router `adv-router`} {} + +{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` adv-router `adv-router`} {} +.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router `adv-router`} {} + +{Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router `adv-router`} {} +.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` self-originate} {} + +{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` self-originate} {} +.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {} + +{Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {} +.. index:: {Command} {show ip ospf database max-age} {} + +{Command} {show ip ospf database max-age} {} +.. index:: {Command} {show ip ospf database self-originate} {} + +{Command} {show ip ospf database self-originate} {} +.. index:: {Command} {show ip ospf route} {} + +{Command} {show ip ospf route} {} + Show the OSPF routing table, as determined by the most recent SPF calculation. + +.. _Opaque_LSA: + +Opaque LSA +========== + +.. index:: {OSPF Command} {ospf opaque-lsa} {} + +{OSPF Command} {ospf opaque-lsa} {} +.. index:: {OSPF Command} {capability opaque} {} + +{OSPF Command} {capability opaque} {} +.. index:: {OSPF Command} {no ospf opaque-lsa} {} + +{OSPF Command} {no ospf opaque-lsa} {} +.. index:: {OSPF Command} {no capability opaque} {} + +{OSPF Command} {no capability opaque} {} + *ospfd* support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration file. Alternate command could be "mpls-te on" (:ref:`OSPF_Traffic_Engineering`). + +.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {} + +{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {} +.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id`} {} + +{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id`} {} +.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` adv-router `adv-router`} {} + +{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` adv-router `adv-router`} {} +.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router `adv-router`} {} + +{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router `adv-router`} {} +.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` self-originate} {} + +{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` self-originate} {} +.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {} + +{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {} + Show Opaque LSA from the database. + +.. _Traffic_Engineering: + +Traffic Engineering +=================== + +.. index:: {OSPF Command} {mpls-te on} {} + +{OSPF Command} {mpls-te on} {} +.. index:: {OSPF Command} {no mpls-te} {} + +{OSPF Command} {no mpls-te} {} + Enable Traffic Engineering LSA flooding. + +.. index:: {OSPF Command} {mpls-te router-address } {} + +{OSPF Command} {mpls-te router-address } {} +.. index:: {OSPF Command} {no mpls-te} {} + +{OSPF Command} {no mpls-te} {} + Configure stable IP address for MPLS-TE. This IP address is then advertise in Opaque LSA Type-10 TLV=1 (TE) + option 1 (Router-Address). + +.. index:: {OSPF Command} {mpls-te inter-as area |as} {} + +{OSPF Command} {mpls-te inter-as area |as} {} +.. index:: {OSPF Command} {no mpls-te inter-as} {} + +{OSPF Command} {no mpls-te inter-as} {} + Enable RFC5392 suuport - Inter-AS TE v2 - to flood Traffic Engineering parameters of Inter-AS link. + 2 modes are supported: AREA and AS; LSA are flood in AREA with Opaque Type-10, + respectively in AS with Opaque Type-11. In all case, Opaque-LSA TLV=6. + +.. index:: {Command} {show ip ospf mpls-te interface} {} + +{Command} {show ip ospf mpls-te interface} {} +.. index:: {Command} {show ip ospf mpls-te interface `interface`} {} + +{Command} {show ip ospf mpls-te interface `interface`} {} + Show MPLS Traffic Engineering parameters for all or specified interface. + +.. index:: {Command} {show ip ospf mpls-te router} {} + +{Command} {show ip ospf mpls-te router} {} + Show Traffic Engineering router parameters. + +.. _Router_Information: + +Router Information +================== + +.. index:: {OSPF Command} {router-info [as | area ]} {} + +{OSPF Command} {router-info [as | area ]} {} +.. index:: {OSPF Command} {no router-info} {} + +{OSPF Command} {no router-info} {} + Enable Router Information (RFC4970) LSA advertisement with AS scope (default) or Area scope flooding + when area is specified. + +.. index:: {OSPF Command} {pce address } {} + +{OSPF Command} {pce address } {} +.. index:: {OSPF Command} {no pce address} {} + +{OSPF Command} {no pce address} {} +.. index:: {OSPF Command} {pce domain as <0-65535>} {} + +{OSPF Command} {pce domain as <0-65535>} {} +.. index:: {OSPF Command} {no pce domain as <0-65535>} {} + +{OSPF Command} {no pce domain as <0-65535>} {} +.. index:: {OSPF Command} {pce neighbor as <0-65535>} {} + +{OSPF Command} {pce neighbor as <0-65535>} {} +.. index:: {OSPF Command} {no pce neighbor as <0-65535>} {} + +{OSPF Command} {no pce neighbor as <0-65535>} {} +.. index:: {OSPF Command} {pce flag BITPATTERN} {} + +{OSPF Command} {pce flag BITPATTERN} {} +.. index:: {OSPF Command} {no pce flag} {} + +{OSPF Command} {no pce flag} {} +.. index:: {OSPF Command} {pce scope BITPATTERN} {} + +{OSPF Command} {pce scope BITPATTERN} {} +.. index:: {OSPF Command} {no pce scope} {} + +{OSPF Command} {no pce scope} {} + The commands are conform to RFC 5088 and allow OSPF router announce Path Compuatation Elemenent (PCE) capabilities + through the Router Information (RI) LSA. Router Information must be enable prior to this. The command set/unset + respectively the PCE IP adress, Autonomous System (AS) numbers of controlled domains, neighbor ASs, flag and scope. + For flag and scope, please refer to RFC5088 for the BITPATTERN recognition. Multiple 'pce neighbor' command could + be specified in order to specify all PCE neighbours. + +.. index:: {Command} {show ip ospf router-info} {} + +{Command} {show ip ospf router-info} {} + Show Router Capabilities flag. +.. index:: {Command} {show ip ospf router-info pce} {} + +{Command} {show ip ospf router-info pce} {} + Show Router Capabilities PCE parameters. + +.. _Debugging_OSPF: + +Debugging OSPF +============== + +.. index:: {Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} + +{Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} +.. index:: {Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} + +{Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} + Dump Packet for debugging + +.. index:: {Command} {debug ospf ism} {} + +{Command} {debug ospf ism} {} +.. index:: {Command} {debug ospf ism (status|events|timers)} {} + +{Command} {debug ospf ism (status|events|timers)} {} +.. index:: {Command} {no debug ospf ism} {} + +{Command} {no debug ospf ism} {} +.. index:: {Command} {no debug ospf ism (status|events|timers)} {} + +{Command} {no debug ospf ism (status|events|timers)} {} + Show debug information of Interface State Machine + +.. index:: {Command} {debug ospf nsm} {} + +{Command} {debug ospf nsm} {} +.. index:: {Command} {debug ospf nsm (status|events|timers)} {} + +{Command} {debug ospf nsm (status|events|timers)} {} +.. index:: {Command} {no debug ospf nsm} {} + +{Command} {no debug ospf nsm} {} +.. index:: {Command} {no debug ospf nsm (status|events|timers)} {} + +{Command} {no debug ospf nsm (status|events|timers)} {} + Show debug information of Network State Machine + +.. index:: {Command} {debug ospf event} {} + +{Command} {debug ospf event} {} +.. index:: {Command} {no debug ospf event} {} + +{Command} {no debug ospf event} {} + Show debug information of OSPF event + +.. index:: {Command} {debug ospf nssa} {} + +{Command} {debug ospf nssa} {} +.. index:: {Command} {no debug ospf nssa} {} + +{Command} {no debug ospf nssa} {} + Show debug information about Not So Stub Area + +.. index:: {Command} {debug ospf lsa} {} + +{Command} {debug ospf lsa} {} +.. index:: {Command} {debug ospf lsa (generate|flooding|refresh)} {} + +{Command} {debug ospf lsa (generate|flooding|refresh)} {} +.. index:: {Command} {no debug ospf lsa} {} + +{Command} {no debug ospf lsa} {} +.. index:: {Command} {no debug ospf lsa (generate|flooding|refresh)} {} + +{Command} {no debug ospf lsa (generate|flooding|refresh)} {} + Show debug detail of Link State messages + +.. index:: {Command} {debug ospf te} {} + +{Command} {debug ospf te} {} +.. index:: {Command} {no debug ospf te} {} + +{Command} {no debug ospf te} {} + Show debug information about Traffic Engineering LSA + +.. index:: {Command} {debug ospf zebra} {} + +{Command} {debug ospf zebra} {} +.. index:: {Command} {debug ospf zebra (interface|redistribute)} {} + +{Command} {debug ospf zebra (interface|redistribute)} {} +.. index:: {Command} {no debug ospf zebra} {} + +{Command} {no debug ospf zebra} {} +.. index:: {Command} {no debug ospf zebra (interface|redistribute)} {} + +{Command} {no debug ospf zebra (interface|redistribute)} {} + Show debug information of ZEBRA API + +.. index:: {Command} {show debugging ospf} {} + +{Command} {show debugging ospf} {} + +OSPF Configuration Examples +=========================== + +A simple example, with MD5 authentication enabled: + +:: + + @group + ! + interface bge0 + ip ospf authentication message-digest + ip ospf message-digest-key 1 md5 ABCDEFGHIJK + ! + router ospf + network 192.168.0.0/16 area 0.0.0.1 + area 0.0.0.1 authentication message-digest + @end group + + +An @acronym{ABR} router, with MD5 authentication and performing summarisation +of networks between the areas: + +:: + + @group + ! + password ABCDEF + log file /var/log/frr/ospfd.log + service advanced-vty + ! + interface eth0 + ip ospf authentication message-digest + ip ospf message-digest-key 1 md5 ABCDEFGHIJK + ! + interface ppp0 + ! + interface br0 + ip ospf authentication message-digest + ip ospf message-digest-key 2 md5 XYZ12345 + ! + router ospf + ospf router-id 192.168.0.1 + redistribute connected + passive interface ppp0 + network 192.168.0.0/24 area 0.0.0.0 + network 10.0.0.0/16 area 0.0.0.0 + network 192.168.1.0/24 area 0.0.0.1 + area 0.0.0.0 authentication message-digest + area 0.0.0.0 range 10.0.0.0/16 + area 0.0.0.0 range 192.168.0.0/24 + area 0.0.0.1 authentication message-digest + area 0.0.0.1 range 10.2.0.0/16 + ! + @end group + + +A Traffic Engineering configuration, with Inter-ASv2 support. + +- First, the 'zebra.conf' part: + +:: + + @group + hostname HOSTNAME + password PASSWORD + log file /var/log/zebra.log + ! + interface eth0 + ip address 198.168.1.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + ! + interface eth1 + ip address 192.168.2.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + mpls-te neighbor 192.168.2.2 as 65000 + @end group + + +- Then the 'ospfd.conf' itself: + +:: + + @group + hostname HOSTNAME + password PASSWORD + log file /var/log/ospfd.log + ! + ! + interface eth0 + ip ospf hello-interval 60 + ip ospf dead-interval 240 + ! + interface eth1 + ip ospf hello-interval 60 + ip ospf dead-interval 240 + ! + ! + router ospf + ospf router-id 192.168.1.1 + network 192.168.0.0/16 area 1 + ospf opaque-lsa + mpls-te + mpls-te router-address 192.168.1.1 + mpls-te inter-as area 1 + ! + line vty + @end group + + +A router information example with PCE advsertisement: + +:: + + @group + ! + router ospf + ospf router-id 192.168.1.1 + network 192.168.0.0/16 area 1 + capability opaque + mpls-te + mpls-te router-address 192.168.1.1 + router-info area 0.0.0.1 + pce address 192.168.1.1 + pce flag 0x80 + pce domain as 65400 + pce neighbor as 65500 + pce neighbor as 65200 + pce scope 0x80 + ! + @end group + + diff --git a/doc/user/overview.rst b/doc/user/overview.rst new file mode 100644 index 0000000000..6393d0ba07 --- /dev/null +++ b/doc/user/overview.rst @@ -0,0 +1,367 @@ +.. _Overview: + +******** +Overview +******** + +.. index:: Overview + +`@value{PACKAGE_URL <@value{PACKAGE_URL>`_,,Frr} is a routing software package that +provides TCP/IP based routing services with routing protocols support such +as RIPv1, RIPv2, RIPng, OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`Supported_RFCs`). Frr also supports special BGP Route Reflector and Route Server +behavior. In addition to traditional IPv4 routing protocols, Frr also +supports IPv6 routing protocols. With SNMP daemon which supports SMUX and AgentX +protocol, Frr provides routing protocol MIBs (:ref:`SNMP_Support`). + +Frr uses an advanced software architecture to provide you with a high +quality, multi server routing engine. Frr has an interactive user +interface for each routing protocol and supports common client commands. +Due to this design, you can add new protocol daemons to Frr easily. You +can use Frr library as your program's client user interface. + +Frr is distributed under the @sc{gnu} General Public License. + +@comment node-name, next, previous, up + +About Frr +========= + +.. index:: About Frr + +Today, TCP/IP networks are covering all of the world. The Internet has +been deployed in many countries, companies, and to the home. When you +connect to the Internet your packet will pass many routers which have TCP/IP +routing functionality. + +A system with Frr installed acts as a dedicated router. With Frr, +your machine exchanges routing information with other routers using routing +protocols. Frr uses this information to update the kernel routing table +so that the right data goes to the right place. You can dynamically change +the configuration and you may view routing table information from the Frr +terminal interface. + +Adding to routing protocol support, Frr can setup interface's flags, +interface's address, static routes and so on. If you have a small network, +or a stub network, or xDSL connection, configuring the Frr routing +software is very easy. The only thing you have to do is to set up the +interfaces and put a few commands about static routes and/or default routes. +If the network is rather large, or if the network structure changes +frequently, you will want to take advantage of Frr's dynamic routing +protocol support for protocols such as RIP, OSPF, IS-IS or BGP. + +Traditionally, UNIX based router configuration is done by +*ifconfig* and *route* commands. Status of routing +table is displayed by *netstat* utility. Almost of these commands +work only if the user has root privileges. Frr has a different system +administration method. There are two user modes in Frr. One is normal +mode, the other is enable mode. Normal mode user can only view system +status, enable mode user can change system configuration. This UNIX account +independent feature will be great help to the router administrator. + +Currently, Frr supports common unicast routing protocols, that is BGP, +OSPF, RIP and IS-IS. Upcoming for MPLS support, an implementation of LDP is +currently being prepared for merging. Implementations of BFD and PIM-SSM +(IPv4) also exist, but are not actively being worked on. + +The ultimate goal of the Frr project is making a productive, quality, free +TCP/IP routing software package. + +@comment node-name, next, previous, up + +System Architecture +=================== + +.. index:: System architecture + +.. index:: Software architecture + +.. index:: Software internals + +Traditional routing software is made as a one process program which +provides all of the routing protocol functionalities. Frr takes a +different approach. It is made from a collection of several daemons that +work together to build the routing table. There may be several +protocol-specific routing daemons and zebra the kernel routing manager. + +The *ripd* daemon handles the RIP protocol, while +*ospfd* is a daemon which supports OSPF version 2. +*bgpd* supports the BGP-4 protocol. For changing the kernel +routing table and for redistribution of routes between different routing +protocols, there is a kernel routing table manager *zebra* daemon. +It is easy to add a new routing protocol daemons to the entire routing +system without affecting any other software. You need to run only the +protocol daemon associated with routing protocols in use. Thus, user may +run a specific daemon and send routing reports to a central routing console. + +There is no need for these daemons to be running on the same machine. You +can even run several same protocol daemons on the same machine. This +architecture creates new possibilities for the routing system. + +:: + + @group + +----+ +----+ +-----+ +-----+ + |bgpd| |ripd| |ospfd| |zebra| + +----+ +----+ +-----+ +-----+ + | + +---------------------------|--+ + | v | + | UNIX Kernel routing table | + | | + +------------------------------+ + + Frr System Architecture + @end group + + +Multi-process architecture brings extensibility, modularity and +maintainability. At the same time it also brings many configuration files +and terminal interfaces. Each daemon has it's own configuration file and +terminal interface. When you configure a static route, it must be done in +*zebra* configuration file. When you configure BGP network it must +be done in *bgpd* configuration file. This can be a very annoying +thing. To resolve the problem, Frr provides integrated user interface +shell called *vtysh*. *vtysh* connects to each daemon with +UNIX domain socket and then works as a proxy for user input. + +Frr was planned to use multi-threaded mechanism when it runs with a +kernel that supports multi-threads. But at the moment, the thread library +which comes with @sc{gnu}/Linux or FreeBSD has some problems with running +reliable services such as routing software, so we don't use threads at all. +Instead we use the *select(2)* system call for multiplexing the +events. + +@comment node-name, next, previous, up + +Supported Platforms +=================== + +.. index:: Supported platforms + +.. index:: Frr on other systems + +.. index:: Compatibility with other systems + +.. index:: Operating systems that support Frr + +Currently Frr supports @sc{gnu}/Linux and BSD. Porting Frr +to other platforms is not too difficult as platform dependent code should +most be limited to the *zebra* daemon. Protocol daemons are mostly +platform independent. Please let us know when you find out Frr runs on a +platform which is not listed below. + +The list of officially supported platforms are listed below. Note that +Frr may run correctly on other platforms, and may run with partial +functionality on further platforms. + +@sp 1 + +* + @sc{gnu}/Linux +* + FreeBSD +* + NetBSD +* + OpenBSD + +Versions of these platforms that are older than around 2 years from the point +of their original release (in case of @sc{gnu}/Linux, this is since the kernel's +release on kernel.org) may need some work. Similarly, the following platforms +may work with some effort: + +@sp 1 + +* + Solaris +* + Mac OSX + +Also note that, in particular regarding proprietary platforms, compiler +and C library choice will affect Frr. Only recent versions of the +following C compilers are well-tested: + +@sp 1 + +* + @sc{gnu}'s GCC +* + LLVM's clang +* + Intel's ICC + +@comment node-name, next, previous, up + +Supported RFCs +============== + +Below is the list of currently supported RFC's. + + + +*@asis{RFC1058}* + @cite{Routing Information Protocol. C.L. Hedrick. Jun-01-1988.} + + +*@asis{RF2082}* + @cite{RIP-2 MD5 Authentication. F. Baker, R. Atkinson. January 1997.} + + +*@asis{RFC2453}* + @cite{RIP Version 2. G. Malkin. November 1998.} + + +*@asis{RFC2080}* + @cite{RIPng for IPv6. G. Malkin, R. Minnear. January 1997.} + + +*@asis{RFC2328}* + @cite{OSPF Version 2. J. Moy. April 1998.} + + +*@asis{RFC2370}* + @cite{The OSPF Opaque LSA Option R. Coltun. July 1998.} + + +*@asis{RFC3101}* + @cite{The OSPF Not-So-Stubby Area (NSSA) Option P. Murphy. January 2003.} + + +*@asis{RFC2740}* + @cite{OSPF for IPv6. R. Coltun, D. Ferguson, J. Moy. December 1999.} + + +*@asis{RFC1771}* + @cite{A Border Gateway Protocol 4 (BGP-4). Y. Rekhter & T. Li. March 1995.} + + +*@asis{RFC1965}* + @cite{Autonomous System Confederations for BGP. P. Traina. June 1996.} + + +*@asis{RFC1997}* + @cite{BGP Communities Attribute. R. Chandra, P. Traina & T. Li. August 1996.} + + +*@asis{RFC2545}* + @cite{Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing. P. Marques, F. Dupont. March 1999.} + + +*@asis{RFC2796}* + @cite{BGP Route Reflection An alternative to full mesh IBGP. T. Bates & R. Chandrasekeran. June 1996.} + + +*@asis{RFC2858}* + @cite{Multiprotocol Extensions for BGP-4. T. Bates, Y. Rekhter, R. Chandra, D. Katz. June 2000.} + + +*@asis{RFC2842}* + @cite{Capabilities Advertisement with BGP-4. R. Chandra, J. Scudder. May 2000.} + + +*@asis{RFC3137}* + @cite{OSPF Stub Router Advertisement, A. Retana, L. Nguyen, R. White, A. Zinin, D. McPherson. June 2001} + +When SNMP support is enabled, below RFC is also supported. + + + +*@asis{RFC1227}* + @cite{SNMP MUX protocol and MIB. M.T. Rose. May-01-1991.} + + +*@asis{RFC1657}* + @cite{Definitions of Managed Objects for the Fourth Version of the + Border Gateway Protocol (BGP-4) using SMIv2. S. Willis, J. Burruss, + J. Chu, Editor. July 1994.} + + +*@asis{RFC1724}* + @cite{RIP Version 2 MIB Extension. G. Malkin & F. Baker. November 1994.} + + +*@asis{RFC1850}* + @cite{OSPF Version 2 Management Information Base. F. Baker, R. Coltun. + November 1995.} + + +*@asis{RFC2741}* + @cite{Agent Extensibility (AgentX) Protocol. M. Daniele, B. Wijnen. January 2000.} + + +@comment node-name, next, previous, up + +How to get Frr +============== + +The official Frr web-site is located at: + +`@value{PACKAGE_URL <@value{PACKAGE_URL>`_} + +and contains further information, as well as links to additional +resources. + +`@value{PACKAGE_URL <@value{PACKAGE_URL>`_,Frr} is a fork of Quagga, whose +web-site is located at: + +`http://www.quagga.net/ `_. + +@comment node-name, next, previous, up + +Mailing List +============ + +.. index:: How to get in touch with Frr + +.. index:: Mailing Frr + +.. index:: Contact information + +.. index:: Mailing lists + +There is a mailing list for discussions about Frr. If you have any +comments or suggestions to Frr, please subscribe to: + +`https://lists.frrouting.org/listinfo/frog `_. + +The `@value{PACKAGE_URL <@value{PACKAGE_URL>`_,,Frr} site has further information on +the available mailing lists, see: + +`https://lists.frrouting.org/ `_ + +Bug Reports +=========== + +.. index:: Bug Reports + +.. index:: Bug hunting + +.. index:: Found a bug? + +.. index:: Reporting bugs + +.. index:: Reporting software errors + +.. index:: Errors in the software + +If you think you have found a bug, please send a bug report to: + +`http://github.com/frrouting/frr/issues `_ + +When you send a bug report, please be careful about the points below. + +* + Please note what kind of OS you are using. If you use the IPv6 stack + please note that as well. +* + Please show us the results of `netstat -rn` and `ifconfig -a`. + Information from zebra's VTY command `show ip route` will also be + helpful. +* + Please send your configuration file with the report. If you specify + arguments to the configure script please note that too. + +Bug reports are very important for us to improve the quality of Frr. +Frr is still in the development stage, but please don't hesitate to +send a bug report to `http://github.com/frrouting/frr/issues `_. + diff --git a/doc/protocol.texi b/doc/user/protocol.rst similarity index 70% rename from doc/protocol.texi rename to doc/user/protocol.rst index 7e8a96dc5d..2a9b76df03 100644 --- a/doc/protocol.texi +++ b/doc/user/protocol.rst @@ -1,6 +1,11 @@ -@node Zebra Protocol -@appendix Zebra Protocol -@appendixsection Overview of the Zebra Protocol +.. _Zebra_Protocol + +************** +Zebra Protocol +************** + +Overview of the Zebra Protocol +============================== Zebra Protocol is used by protocol daemons to communicate with the zebra daemon. @@ -31,32 +36,38 @@ released in 1.0. Version 4 will be used as of Frr 2.0 to indicate that we are a different Routing Suite now and to hopefully prevent accidental Quagga <-> FRR issues. -@appendixsection Zebra Protocol Definition -@appendixsubsec Zebra Protocol Header (version 0) -@example -@group -0 1 2 3 -0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-------------------------------+---------------+ -| Length (2) | Command (1) | -+-------------------------------+---------------+ -@end group -@end example +Zebra Protocol Definition +========================= -@appendixsubsec Zebra Protocol Common Header (version 1) -@example -@group -0 1 2 3 -0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 -+-------------------------------+---------------+-------------+ -| Length (2) | Marker (1) | Version (1) | -+-------------------------------+---------------+-------------+ -| Command (2) | -+-------------------------------+ -@end group -@end example +Zebra Protocol Header (version 0) +---------------------------------- + +:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-------------------------------+---------------+ + | Length (2) | Command (1) | + +-------------------------------+---------------+ + + +Zebra Protocol Common Header (version 1) +---------------------------------------- + +:: + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-------------------------------+---------------+-------------+ + | Length (2) | Marker (1) | Version (1) | + +-------------------------------+---------------+-------------+ + | Command (2) | + +-------------------------------+ + + +Zebra Protocol Header Field Definitions +--------------------------------------- -@appendixsubsec Zebra Protocol Header Field Definitions @table @samp @item Length Total packet length including this header. The minimum length is 3 @@ -77,7 +88,9 @@ recognise. Not present in version 0 messages. The Zebra Protocol command. @end table -@appendixsubsec Zebra Protocol Commands +Zebra Protocol Commands +----------------------- + @multitable {ZEBRA_REDISTRIBUTE_DEFAULT_DELETE_WHATEVER} {99999} @headitem Command @tab Value @item ZEBRA_INTERFACE_ADD diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst new file mode 100644 index 0000000000..0aae9bcc39 --- /dev/null +++ b/doc/user/ripd.rst @@ -0,0 +1,738 @@ +.. _RIP: + +*** +RIP +*** + +RIP -- Routing Information Protocol is widely deployed interior gateway +protocol. RIP was developed in the 1970s at Xerox Labs as part of the +XNS routing protocol. RIP is a @dfn{distance-vector} protocol and is +based on the @dfn{Bellman-Ford} algorithms. As a distance-vector +protocol, RIP router send updates to its neighbors periodically, thus +allowing the convergence to a known topology. In each update, the +distance to any given network will be broadcasted to its neighboring +router. + +*ripd* supports RIP version 2 as described in RFC2453 and RIP +version 1 as described in RFC1058. + +.. _Starting_and_Stopping_ripd: + +Starting and Stopping ripd +========================== + +The default configuration file name of *ripd*'s is +:file:`ripd.conf`. When invocation *ripd* searches directory +@value{INSTALL_PREFIX_ETC}. If :file:`ripd.conf` is not there next +search current directory. + +RIP uses UDP port 520 to send and receive RIP packets. So the user must have +the capability to bind the port, generally this means that the user must +have superuser privileges. RIP protocol requires interface information +maintained by *zebra* daemon. So running *zebra* +is mandatory to run *ripd*. Thus minimum sequence for running +RIP is like below: + +:: + + @group + # zebra -d + # ripd -d + @end group + + +Please note that *zebra* must be invoked before *ripd*. + +To stop *ripd*. Please use @command{kill `cat +/var/run/ripd.pid`}. Certain signals have special meaningss to *ripd*. + + + +*SIGHUP* + Reload configuration file :file:`ripd.conf`. All configurations are + reseted. All routes learned so far are cleared and removed from routing + table. + +*SIGUSR1* + Rotate *ripd* logfile. + +*SIGINT* + +*SIGTERM* + *ripd* sweeps all installed RIP routes then terminates properly. + +*ripd* invocation options. Common options that can be specified +(:ref:`Common_Invocation_Options`). + + + +*-r* + +*--retain* + When the program terminates, retain routes added by *ripd*. + +.. _RIP_netmask: + +RIP netmask +----------- + +The netmask features of *ripd* support both version 1 and version 2 of +RIP. Version 1 of RIP originally contained no netmask information. In +RIP version 1, network classes were originally used to determine the +size of the netmask. Class A networks use 8 bits of mask, Class B +networks use 16 bits of masks, while Class C networks use 24 bits of +mask. Today, the most widely used method of a network mask is assigned +to the packet on the basis of the interface that received the packet. +Version 2 of RIP supports a variable length subnet mask (VLSM). By +extending the subnet mask, the mask can be divided and reused. Each +subnet can be used for different purposes such as large to middle size +LANs and WAN links. Frr *ripd* does not support the non-sequential +netmasks that are included in RIP Version 2. + +In a case of similar information with the same prefix and metric, the +old information will be suppressed. Ripd does not currently support +equal cost multipath routing. + +.. _RIP_Configuration: + +RIP Configuration +================= + +.. index:: Command {router rip} {} + +Command {router rip} {} + The `router rip` command is necessary to enable RIP. To disable + RIP, use the `no router rip` command. RIP must be enabled before + carrying out any of the RIP commands. + +.. index:: Command {no router rip} {} + +Command {no router rip} {} + Disable RIP. + +.. index:: {RIP Command} {network `network`} {} + +{RIP Command} {network `network`} {} +.. index:: {RIP Command} {no network `network`} {} + +{RIP Command} {no network `network`} {} + Set the RIP enable interface by `network`. The interfaces which + have addresses matching with `network` are enabled. + + This group of commands either enables or disables RIP interfaces between + certain numbers of a specified network address. For example, if the + network for 10.0.0.0/24 is RIP enabled, this would result in all the + addresses from 10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will disable RIP for the specified network. + +.. index:: {RIP Command} {network `ifname`} {} + +{RIP Command} {network `ifname`} {} +.. index:: {RIP Command} {no network `ifname`} {} + +{RIP Command} {no network `ifname`} {} + Set a RIP enabled interface by `ifname`. Both the sending and + receiving of RIP packets will be enabled on the port specified in the + `network ifname` command. The `no network ifname` command will disable + RIP on the specified interface. + +.. index:: {RIP Command} {neighbor `a.b.c.d`} {} + +{RIP Command} {neighbor `a.b.c.d`} {} +.. index:: {RIP Command} {no neighbor `a.b.c.d`} {} + +{RIP Command} {no neighbor `a.b.c.d`} {} + Specify RIP neighbor. When a neighbor doesn't understand multicast, + this command is used to specify neighbors. In some cases, not all + routers will be able to understand multicasting, where packets are sent + to a network or a group of addresses. In a situation where a neighbor + cannot process multicast packets, it is necessary to establish a direct + link between routers. The neighbor command allows the network + administrator to specify a router as a RIP neighbor. The `no neighbor a.b.c.d` command will disable the RIP neighbor. + + Below is very simple RIP configuration. Interface `eth0` and + interface which address match to `10.0.0.0/8` are RIP enabled. + +:: + + @group + ! + router rip + network 10.0.0.0/8 + network eth0 + ! + @end group + + + Passive interface + +.. index:: {RIP command} {passive-interface (`IFNAME`|default)} {} + +{RIP command} {passive-interface (`IFNAME`|default)} {} +.. index:: {RIP command} {no passive-interface `IFNAME`} {} + +{RIP command} {no passive-interface `IFNAME`} {} + This command sets the specified interface to passive mode. On passive mode + interface, all receiving packets are processed as normal and ripd does + not send either multicast or unicast RIP packets except to RIP neighbors + specified with `neighbor` command. The interface may be specified + as `default` to make ripd default to passive on all interfaces. + + The default is to be passive on all interfaces. + + RIP split-horizon + +.. index:: {Interface command} {ip split-horizon} {} + +{Interface command} {ip split-horizon} {} +.. index:: {Interface command} {no ip split-horizon} {} + +{Interface command} {no ip split-horizon} {} + Control split-horizon on the interface. Default is `ip split-horizon`. If you don't perform split-horizon on the interface, + please specify `no ip split-horizon`. + +.. _RIP_Version_Control: + +RIP Version Control +=================== + +RIP can be configured to send either Version 1 or Version 2 packets. +The default is to send RIPv2 while accepting both RIPv1 and RIPv2 (and +replying with packets of the appropriate version for REQUESTS / +triggered updates). The version to receive and send can be specified +globally, and further overriden on a per-interface basis if needs be +for send and receive seperately (see below). + +It is important to note that RIPv1 can not be authenticated. Further, +if RIPv1 is enabled then RIP will reply to REQUEST packets, sending the +state of its RIP routing table to any remote routers that ask on +demand. For a more detailed discussion on the security implications of +RIPv1 see :ref:`RIP_Authentication`. + +.. index:: {RIP Command} {version `version`} {} + +{RIP Command} {version `version`} {} + Set RIP version to accept for reads and send. `version` + can be either `1'' or `2''. + + Disabling RIPv1 by specifying version 2 is STRONGLY encouraged, + :ref:`RIP_Authentication`. This may become the default in a future + release. + + Default: Send Version 2, and accept either version. + +.. index:: {RIP Command} {no version} {} + +{RIP Command} {no version} {} + Reset the global version setting back to the default. + +.. index:: {Interface command} {ip rip send version `version`} {} + +{Interface command} {ip rip send version `version`} {} + `version` can be `1', `2' or `1 2'. + + This interface command overrides the global rip version setting, and + selects which version of RIP to send packets with, for this interface + specifically. Choice of RIP Version 1, RIP Version 2, or both versions. + In the latter case, where `1 2' is specified, packets will be both + broadcast and multicast. + + Default: Send packets according to the global version (version 2) + +.. index:: {Interface command} {ip rip receive version `version`} {} + +{Interface command} {ip rip receive version `version`} {} + `version` can be `1', `2' or `1 2'. + + This interface command overrides the global rip version setting, and + selects which versions of RIP packets will be accepted on this + interface. Choice of RIP Version 1, RIP Version 2, or both. + + Default: Accept packets according to the global setting (both 1 and 2). + +.. _How_to_Announce_RIP_route: + +How to Announce RIP route +========================= + +.. index:: {RIP command} {redistribute kernel} {} + +{RIP command} {redistribute kernel} {} +.. index:: {RIP command} {redistribute kernel metric <0-16>} {} + +{RIP command} {redistribute kernel metric <0-16>} {} +.. index:: {RIP command} {redistribute kernel route-map `route-map`} {} + +{RIP command} {redistribute kernel route-map `route-map`} {} +.. index:: {RIP command} {no redistribute kernel} {} + +{RIP command} {no redistribute kernel} {} + `redistribute kernel` redistributes routing information from + kernel route entries into the RIP tables. `no redistribute kernel` + disables the routes. + +.. index:: {RIP command} {redistribute static} {} + +{RIP command} {redistribute static} {} +.. index:: {RIP command} {redistribute static metric <0-16>} {} + +{RIP command} {redistribute static metric <0-16>} {} +.. index:: {RIP command} {redistribute static route-map `route-map`} {} + +{RIP command} {redistribute static route-map `route-map`} {} +.. index:: {RIP command} {no redistribute static} {} + +{RIP command} {no redistribute static} {} + `redistribute static` redistributes routing information from + static route entries into the RIP tables. `no redistribute static` + disables the routes. + +.. index:: {RIP command} {redistribute connected} {} + +{RIP command} {redistribute connected} {} +.. index:: {RIP command} {redistribute connected metric <0-16>} {} + +{RIP command} {redistribute connected metric <0-16>} {} +.. index:: {RIP command} {redistribute connected route-map `route-map`} {} + +{RIP command} {redistribute connected route-map `route-map`} {} +.. index:: {RIP command} {no redistribute connected} {} + +{RIP command} {no redistribute connected} {} + Redistribute connected routes into the RIP tables. `no redistribute connected` disables the connected routes in the RIP tables. + This command redistribute connected of the interface which RIP disabled. + The connected route on RIP enabled interface is announced by default. + +.. index:: {RIP command} {redistribute ospf} {} + +{RIP command} {redistribute ospf} {} +.. index:: {RIP command} {redistribute ospf metric <0-16>} {} + +{RIP command} {redistribute ospf metric <0-16>} {} +.. index:: {RIP command} {redistribute ospf route-map `route-map`} {} + +{RIP command} {redistribute ospf route-map `route-map`} {} +.. index:: {RIP command} {no redistribute ospf} {} + +{RIP command} {no redistribute ospf} {} + `redistribute ospf` redistributes routing information from + ospf route entries into the RIP tables. `no redistribute ospf` + disables the routes. + +.. index:: {RIP command} {redistribute bgp} {} + +{RIP command} {redistribute bgp} {} +.. index:: {RIP command} {redistribute bgp metric <0-16>} {} + +{RIP command} {redistribute bgp metric <0-16>} {} +.. index:: {RIP command} {redistribute bgp route-map `route-map`} {} + +{RIP command} {redistribute bgp route-map `route-map`} {} +.. index:: {RIP command} {no redistribute bgp} {} + +{RIP command} {no redistribute bgp} {} + `redistribute bgp` redistributes routing information from + bgp route entries into the RIP tables. `no redistribute bgp` + disables the routes. + + If you want to specify RIP only static routes: + +.. index:: {RIP command} {default-information originate} {} + +{RIP command} {default-information originate} {} +.. index:: {RIP command} {route `a.b.c.d/m`} {} + +{RIP command} {route `a.b.c.d/m`} {} +.. index:: {RIP command} {no route `a.b.c.d/m`} {} + +{RIP command} {no route `a.b.c.d/m`} {} + This command is specific to Frr. The `route` command makes a static + route only inside RIP. This command should be used only by advanced + users who are particularly knowledgeable about the RIP protocol. In + most cases, we recommend creating a static route in Frr and + redistributing it in RIP using `redistribute static`. + +.. _Filtering_RIP_Routes: + +Filtering RIP Routes +==================== + +RIP routes can be filtered by a distribute-list. + +.. index:: Command {distribute-list `access_list` `direct` `ifname`} {} + +Command {distribute-list `access_list` `direct` `ifname`} {} + You can apply access lists to the interface with a `distribute-list` + command. `access_list` is the access list name. `direct` is + @samp{in} or @samp{out}. If `direct` is @samp{in} the access list + is applied to input packets. + + The `distribute-list` command can be used to filter the RIP path. + `distribute-list` can apply access-lists to a chosen interface. + First, one should specify the access-list. Next, the name of the + access-list is used in the distribute-list command. For example, in the + following configuration @samp{eth0} will permit only the paths that + match the route 10.0.0.0/8 + +:: + + @group + ! + router rip + distribute-list private in eth0 + ! + access-list private permit 10 10.0.0.0/8 + access-list private deny any + ! + @end group + + +`distribute-list` can be applied to both incoming and outgoing data. + +.. index:: Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {} + +Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {} + You can apply prefix lists to the interface with a + `distribute-list` command. `prefix_list` is the prefix list + name. Next is the direction of @samp{in} or @samp{out}. If + `direct` is @samp{in} the access list is applied to input packets. + +.. _RIP_Metric_Manipulation: + +RIP Metric Manipulation +======================= + +RIP metric is a value for distance for the network. Usually +*ripd* increment the metric when the network information is +received. Redistributed routes' metric is set to 1. + +.. index:: {RIP command} {default-metric <1-16>} {} + +{RIP command} {default-metric <1-16>} {} +.. index:: {RIP command} {no default-metric <1-16>} {} + +{RIP command} {no default-metric <1-16>} {} + This command modifies the default metric value for redistributed routes. The + default value is 1. This command does not affect connected route + even if it is redistributed by *redistribute connected*. To modify + connected route's metric value, please use @command{redistribute + connected metric} or *route-map*. *offset-list* also + affects connected routes. + +.. index:: {RIP command} {offset-list `access-list` (in|out)} {} + +{RIP command} {offset-list `access-list` (in|out)} {} +.. index:: {RIP command} {offset-list `access-list` (in|out) `ifname`} {} + +{RIP command} {offset-list `access-list` (in|out) `ifname`} {} + +.. _RIP_distance: + +RIP distance +============ + +Distance value is used in zebra daemon. Default RIP distance is 120. + +.. index:: {RIP command} {distance <1-255>} {} + +{RIP command} {distance <1-255>} {} +.. index:: {RIP command} {no distance <1-255>} {} + +{RIP command} {no distance <1-255>} {} + Set default RIP distance to specified value. + +.. index:: {RIP command} {distance <1-255> `A.B.C.D/M`} {} + +{RIP command} {distance <1-255> `A.B.C.D/M`} {} +.. index:: {RIP command} {no distance <1-255> `A.B.C.D/M`} {} + +{RIP command} {no distance <1-255> `A.B.C.D/M`} {} + Set default RIP distance to specified value when the route's source IP + address matches the specified prefix. + +.. index:: {RIP command} {distance <1-255> `A.B.C.D/M` `access-list`} {} + +{RIP command} {distance <1-255> `A.B.C.D/M` `access-list`} {} +.. index:: {RIP command} {no distance <1-255> `A.B.C.D/M` `access-list`} {} + +{RIP command} {no distance <1-255> `A.B.C.D/M` `access-list`} {} + Set default RIP distance to specified value when the route's source IP + address matches the specified prefix and the specified access-list. + +.. _RIP_route-map: + +RIP route-map +============= + +Usage of *ripd*'s route-map support. + +Optional argument route-map MAP_NAME can be added to each `redistribute` +statement. + +:: + + redistribute static [route-map MAP_NAME] + redistribute connected [route-map MAP_NAME] + ..... + + +Cisco applies route-map _before_ routes will exported to rip route table. +In current Frr's test implementation, *ripd* applies route-map +after routes are listed in the route table and before routes will be +announced to an interface (something like output filter). I think it is not +so clear, but it is draft and it may be changed at future. + +Route-map statement (:ref:`Route_Map`) is needed to use route-map +functionality. + +.. index:: {Route Map} {match interface `word`} {} + +{Route Map} {match interface `word`} {} + This command match to incoming interface. Notation of this match is + different from Cisco. Cisco uses a list of interfaces - NAME1 NAME2 + ... NAMEN. Ripd allows only one name (maybe will change in the + future). Next - Cisco means interface which includes next-hop of + routes (it is somewhat similar to "ip next-hop" statement). Ripd + means interface where this route will be sent. This difference is + because "next-hop" of same routes which sends to different interfaces + must be different. Maybe it'd be better to made new matches - say + "match interface-out NAME" or something like that. + +.. index:: {Route Map} {match ip address `word`} {} + +{Route Map} {match ip address `word`} {} +.. index:: {Route Map} {match ip address prefix-list `word`} {} + +{Route Map} {match ip address prefix-list `word`} {} + Match if route destination is permitted by access-list. + +.. index:: {Route Map} {match ip next-hop `word`} {} + +{Route Map} {match ip next-hop `word`} {} +.. index:: {Route Map} {match ip next-hop prefix-list `word`} {} + +{Route Map} {match ip next-hop prefix-list `word`} {} + Match if route next-hop (meaning next-hop listed in the rip route-table + as displayed by "show ip rip") is permitted by access-list. + +.. index:: {Route Map} {match metric <0-4294967295>} {} + +{Route Map} {match metric <0-4294967295>} {} + This command match to the metric value of RIP updates. For other + protocol compatibility metric range is shown as <0-4294967295>. But + for RIP protocol only the value range <0-16> make sense. + +.. index:: {Route Map} {set ip next-hop A.B.C.D} {} + +{Route Map} {set ip next-hop A.B.C.D} {} + This command set next hop value in RIPv2 protocol. This command does + not affect RIPv1 because there is no next hop field in the packet. + +.. index:: {Route Map} {set metric <0-4294967295>} {} + +{Route Map} {set metric <0-4294967295>} {} + Set a metric for matched route when sending announcement. The metric + value range is very large for compatibility with other protocols. For + RIP, valid metric values are from 1 to 16. + +.. _RIP_Authentication: + +RIP Authentication +================== + +RIPv2 allows packets to be authenticated via either an insecure plain +text password, included with the packet, or via a more secure MD5 based +@acronym{HMAC, keyed-Hashing for Message AuthentiCation}, +RIPv1 can not be authenticated at all, thus when authentication is +configured `ripd` will discard routing updates received via RIPv1 +packets. + +However, unless RIPv1 reception is disabled entirely, +:ref:`RIP_Version_Control`, RIPv1 REQUEST packets which are received, +which query the router for routing information, will still be honoured +by `ripd`, and `ripd` WILL reply to such packets. This allows +`ripd` to honour such REQUESTs (which sometimes is used by old +equipment and very simple devices to bootstrap their default route), +while still providing security for route updates which are received. + +In short: Enabling authentication prevents routes being updated by +unauthenticated remote routers, but still can allow routes (I.e. the +entire RIP routing table) to be queried remotely, potentially by anyone +on the internet, via RIPv1. + +To prevent such unauthenticated querying of routes disable RIPv1, +:ref:`RIP_Version_Control`. + +.. index:: {Interface command} {ip rip authentication mode md5} {} + +{Interface command} {ip rip authentication mode md5} {} +.. index:: {Interface command} {no ip rip authentication mode md5} {} + +{Interface command} {no ip rip authentication mode md5} {} + Set the interface with RIPv2 MD5 authentication. + +.. index:: {Interface command} {ip rip authentication mode text} {} + +{Interface command} {ip rip authentication mode text} {} +.. index:: {Interface command} {no ip rip authentication mode text} {} + +{Interface command} {no ip rip authentication mode text} {} + Set the interface with RIPv2 simple password authentication. + +.. index:: {Interface command} {ip rip authentication string `string`} {} + +{Interface command} {ip rip authentication string `string`} {} +.. index:: {Interface command} {no ip rip authentication string `string`} {} + +{Interface command} {no ip rip authentication string `string`} {} + RIP version 2 has simple text authentication. This command sets + authentication string. The string must be shorter than 16 characters. + +.. index:: {Interface command} {ip rip authentication key-chain `key-chain`} {} + +{Interface command} {ip rip authentication key-chain `key-chain`} {} +.. index:: {Interface command} {no ip rip authentication key-chain `key-chain`} {} + +{Interface command} {no ip rip authentication key-chain `key-chain`} {} + Specifiy Keyed MD5 chain. + +:: + + ! + key chain test + key 1 + key-string test + ! + interface eth1 + ip rip authentication mode md5 + ip rip authentication key-chain test + ! + + +.. _RIP_Timers: + +RIP Timers +========== + +.. index:: {RIP command} {timers basic `update` `timeout` `garbage`} {} + +{RIP command} {timers basic `update` `timeout` `garbage`} {} + + RIP protocol has several timers. User can configure those timers' values + by `timers basic` command. + + The default settings for the timers are as follows: + + +`` + The update timer is 30 seconds. Every update timer seconds, the RIP + process is awakened to send an unsolicited Response message containing + the complete routing table to all neighboring RIP routers. + + +`` + The timeout timer is 180 seconds. Upon expiration of the timeout, the + route is no longer valid; however, it is retained in the routing table + for a short time so that neighbors can be notified that the route has + been dropped. + + +`` + The garbage collect timer is 120 seconds. Upon expiration of the + garbage-collection timer, the route is finally removed from the routing + table. + + + The `timers basic` command allows the the default values of the timers + listed above to be changed. + +.. index:: {RIP command} {no timers basic} {} + +{RIP command} {no timers basic} {} + The `no timers basic` command will reset the timers to the default + settings listed above. + +.. _Show_RIP_Information: + +Show RIP Information +==================== + +To display RIP routes. + +.. index:: Command {show ip rip} {} + +Command {show ip rip} {} + Show RIP routes. + +The command displays all RIP routes. For routes that are received +through RIP, this command will display the time the packet was sent and +the tag information. This command will also display this information +for routes redistributed into RIP. + +.. index:: Command {show ip rip status} {} + +Command {show ip rip status} {} + The command displays current RIP status. It includes RIP timer, + filtering, version, RIP enabled interface and RIP peer inforation. + +:: + + @group + ripd> **show ip rip status** + Routing Protocol is "rip" + Sending updates every 30 seconds with +/-50%, next due in 35 seconds + Timeout after 180 seconds, garbage collect after 120 seconds + Outgoing update filter list for all interface is not set + Incoming update filter list for all interface is not set + Default redistribution metric is 1 + Redistributing: kernel connected + Default version control: send version 2, receive version 2 + Interface Send Recv + Routing for Networks: + eth0 + eth1 + 1.1.1.1 + 203.181.89.241 + Routing Information Sources: + Gateway BadPackets BadRoutes Distance Last Update + @end group + + +RIP Debug Commands +================== + +Debug for RIP protocol. + +.. index:: Command {debug rip events} {} + +Command {debug rip events} {} + Debug rip events. + +`debug rip` will show RIP events. Sending and receiving +packets, timers, and changes in interfaces are events shown with *ripd*. + +.. index:: Command {debug rip packet} {} + +Command {debug rip packet} {} + Debug rip packet. + +`debug rip packet` will display detailed information about the RIP +packets. The origin and port number of the packet as well as a packet +dump is shown. + +.. index:: Command {debug rip zebra} {} + +Command {debug rip zebra} {} + Debug rip between zebra communication. + +This command will show the communication between *ripd* and +*zebra*. The main information will include addition and deletion of +paths to the kernel and the sending and receiving of interface information. + +.. index:: Command {show debugging rip} {} + +Command {show debugging rip} {} + Display *ripd*'s debugging option. + +`show debugging rip` will show all information currently set for ripd +debug. + diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst new file mode 100644 index 0000000000..2c4bfa2c35 --- /dev/null +++ b/doc/user/ripngd.rst @@ -0,0 +1,93 @@ +.. _RIPng: + +***** +RIPng +***** + +*ripngd* supports the RIPng protocol as described in RFC2080. It's an +IPv6 reincarnation of the RIP protocol. + +.. _Invoking_ripngd: + +Invoking ripngd +=============== + +There are no `ripngd` specific invocation options. Common options +can be specified (:ref:`Common_Invocation_Options`). + +.. _ripngd_Configuration: + +ripngd Configuration +==================== + +Currently ripngd supports the following commands: + +.. index:: Command {router ripng} {} + +Command {router ripng} {} + Enable RIPng. + +.. index:: {RIPng Command} {flush_timer `time`} {} + +{RIPng Command} {flush_timer `time`} {} + Set flush timer. + +.. index:: {RIPng Command} {network `network`} {} + +{RIPng Command} {network `network`} {} + Set RIPng enabled interface by `network` + +.. index:: {RIPng Command} {network `ifname`} {} + +{RIPng Command} {network `ifname`} {} + Set RIPng enabled interface by `ifname` + +.. index:: {RIPng Command} {route `network`} {} + +{RIPng Command} {route `network`} {} + Set RIPng static routing announcement of `network`. + +.. index:: Command {router zebra} {} + +Command {router zebra} {} + This command is the default and does not appear in the configuration. + With this statement, RIPng routes go to the *zebra* daemon. + +.. _ripngd_Terminal_Mode_Commands: + +ripngd Terminal Mode Commands +============================= + +.. index:: Command {show ip ripng} {} + +Command {show ip ripng} {} + +.. index:: Command {show debugging ripng} {} + +Command {show debugging ripng} {} +.. index:: Command {debug ripng events} {} + +Command {debug ripng events} {} +.. index:: Command {debug ripng packet} {} + +Command {debug ripng packet} {} +.. index:: Command {debug ripng zebra} {} + +Command {debug ripng zebra} {} + +ripngd Filtering Commands +========================= + +.. index:: Command {distribute-list `access_list` (in|out) `ifname`} {} + +Command {distribute-list `access_list` (in|out) `ifname`} {} + You can apply an access-list to the interface using the + `distribute-list` command. `access_list` is an access-list + name. `direct` is @samp{in} or @samp{out}. If `direct` is + @samp{in}, the access-list is applied only to incoming packets. + +:: + + distribute-list local-only out sit1 + + diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst new file mode 100644 index 0000000000..0be62d4100 --- /dev/null +++ b/doc/user/routemap.rst @@ -0,0 +1,310 @@ +.. _Route_Map: + +********* +Route Map +********* + +Route maps provide a means to both filter and/or apply actions to +route, hence allowing policy to be applied to routes. + +Route-maps are an ordered list of route-map entries. Each entry may +specify up to four distincts sets of clauses: + + + +*Matching Policy* + This specifies the policy implied if the @samp{Matching Conditions} are + met or not met, and which actions of the route-map are to be taken, if + any. The two possibilities are: + + +** + @samp{permit}: If the entry matches, then carry out the @samp{Set + Actions}. Then finish processing the route-map, permitting the route, + unless an @samp{Exit Action} indicates otherwise. + + +** + @samp{deny}: If the entry matches, then finish processing the route-map and + deny the route (return @samp{deny}). + + The @samp{Matching Policy} is specified as part of the command which + defines the ordered entry in the route-map. See below. + + +*Matching Conditions* + A route-map entry may, optionally, specify one or more conditions which + must be matched if the entry is to be considered further, as governed + by the Match Policy. If a route-map entry does not explicitely specify + any matching conditions, then it always matches. + + +*Set Actions* + A route-map entry may, optionally, specify one or more @samp{Set + Actions} to set or modify attributes of the route. + + +*Call Action* + Call to another route-map, after any @samp{Set Actions} have been + carried out. If the route-map called returns @samp{deny} then + processing of the route-map finishes and the route is denied, + regardless of the @samp{Matching Policy} or the @samp{Exit Policy}. If + the called route-map returns @samp{permit}, then @samp{Matching Policy} + and @samp{Exit Policy} govern further behaviour, as normal. + + +*Exit Policy* + An entry may, optionally, specify an alternative @samp{Exit Policy} to + take if the entry matched, rather than the normal policy of exiting the + route-map and permitting the route. The two possibilities are: + + +** + @samp{next}: Continue on with processing of the route-map entries. + + +** + @samp{goto N}: Jump ahead to the first route-map entry whose order in + the route-map is >= N. Jumping to a previous entry is not permitted. + +The default action of a route-map, if no entries match, is to deny. +I.e. a route-map essentially has as its last entry an empty @samp{deny} +entry, which matches all routes. To change this behaviour, one must +specify an empty @samp{permit} entry as the last entry in the route-map. + +To summarise the above: + +@multitable {permit} {action} {No Match} +@headitem @tab Match @tab No Match +* *Permit* @tab action @tab cont +* *Deny* @tab deny @tab cont +@end multitable + + + +*action* + +** + Apply *set* statements + + +** + If *call* is present, call given route-map. If that returns a @samp{deny}, finish + processing and return @samp{deny}. + + +** + If @samp{Exit Policy} is *next*, goto next route-map entry + + +** + If @samp{Exit Policy} is *goto*, goto first entry whose order in the list + is >= the given order. + + +** + Finish processing the route-map and permit the route. + + +*deny* + +** + The route is denied by the route-map (return @samp{deny}). + + +*cont* + +** + goto next route-map entry + +.. _Route_Map_Command: + +Route Map Command +================= + +.. index:: {Command} {route-map `route-map-name` (permit|deny) `order`} {} + +{Command} {route-map `route-map-name` (permit|deny) `order`} {} + + Configure the `order`'th entry in `route-map-name` with + @samp{Match Policy} of either *permit* or *deny*. + + +.. _Route_Map_Match_Command: + +Route Map Match Command +======================= + +.. index:: {Route-map Command} {match ip address `access_list`} {} + +{Route-map Command} {match ip address `access_list`} {} + Matches the specified `access_list` + +.. index:: {Route-map Command} {match ip address `prefix-list`} {} + +{Route-map Command} {match ip address `prefix-list`} {} + Matches the specified `prefix-list` + +.. index:: {Route-map Command} {match ip address prefix-len `0-32`} {} + +{Route-map Command} {match ip address prefix-len `0-32`} {} + Matches the specified `prefix-len`. This is a Zebra specific command. + +.. index:: {Route-map Command} {match ipv6 address `access_list`} {} + +{Route-map Command} {match ipv6 address `access_list`} {} + Matches the specified `access_list` + +.. index:: {Route-map Command} {match ipv6 address `prefix-list`} {} + +{Route-map Command} {match ipv6 address `prefix-list`} {} + Matches the specified `prefix-list` + +.. index:: {Route-map Command} {match ipv6 address prefix-len `0-128`} {} + +{Route-map Command} {match ipv6 address prefix-len `0-128`} {} + Matches the specified `prefix-len`. This is a Zebra specific command. + +.. index:: {Route-map Command} {match ip next-hop `ipv4_addr`} {} + +{Route-map Command} {match ip next-hop `ipv4_addr`} {} + Matches the specified `ipv4_addr`. + +.. index:: {Route-map Command} {match aspath `as_path`} {} + +{Route-map Command} {match aspath `as_path`} {} + Matches the specified `as_path`. + +.. index:: {Route-map Command} {match metric `metric`} {} + +{Route-map Command} {match metric `metric`} {} + Matches the specified `metric`. + +.. index:: {Route-map Command} {match local-preference `metric`} {} + +{Route-map Command} {match local-preference `metric`} {} + Matches the specified `local-preference`. + +.. index:: {Route-map Command} {match community `community_list`} {} + +{Route-map Command} {match community `community_list`} {} + Matches the specified `community_list` + +.. index:: {Route-map Command} {match peer `ipv4_addr`} {} + +{Route-map Command} {match peer `ipv4_addr`} {} + This is a BGP specific match command. Matches the peer ip address + if the neighbor was specified in this manner. + +.. index:: {Route-map Command} {match peer `ipv6_addr`} {} + +{Route-map Command} {match peer `ipv6_addr`} {} + This is a BGP specific match command. Matches the peer ipv6 + address if the neighbor was specified in this manner. + +.. index:: {Route-map Command} {match peer `interface_name`} {} + +{Route-map Command} {match peer `interface_name`} {} + This is a BGP specific match command. Matches the peer + interface name specified if the neighbor was specified + in this manner. + +.. _Route_Map_Set_Command: + +Route Map Set Command +===================== + +.. index:: {Route-map Command} {set ip next-hop `ipv4_address`} {} + +{Route-map Command} {set ip next-hop `ipv4_address`} {} + Set the BGP nexthop address. + +.. index:: {Route-map Command} {set local-preference `local_pref`} {} + +{Route-map Command} {set local-preference `local_pref`} {} + Set the BGP local preference to `local_pref`. + +.. index:: {Route-map Command} {set weight `weight`} {} + +{Route-map Command} {set weight `weight`} {} + Set the route's weight. + +.. index:: {Route-map Command} {set metric `metric`} {} + +{Route-map Command} {set metric `metric`} {} + .. _routemap_set_metric: + + Set the BGP attribute MED. + +.. index:: {Route-map Command} {set as-path prepend `as_path`} {} + +{Route-map Command} {set as-path prepend `as_path`} {} + Set the BGP AS path to prepend. + +.. index:: {Route-map Command} {set community `community`} {} + +{Route-map Command} {set community `community`} {} + Set the BGP community attribute. + +.. index:: {Route-map Command} {set ipv6 next-hop global `ipv6_address`} {} + +{Route-map Command} {set ipv6 next-hop global `ipv6_address`} {} + Set the BGP-4+ global IPv6 nexthop address. + +.. index:: {Route-map Command} {set ipv6 next-hop local `ipv6_address`} {} + +{Route-map Command} {set ipv6 next-hop local `ipv6_address`} {} + Set the BGP-4+ link local IPv6 nexthop address. + +.. _Route_Map_Call_Command: + +Route Map Call Command +====================== + +.. index:: {Route-map Command} {call `name`} {} + +{Route-map Command} {call `name`} {} + Call route-map `name`. If it returns deny, deny the route and + finish processing the route-map. + +.. _Route_Map_Exit_Action_Command: + +Route Map Exit Action Command +============================= + +.. index:: {Route-map Command} {on-match next} {} + +{Route-map Command} {on-match next} {} +.. index:: {Route-map Command} {continue} {} + +{Route-map Command} {continue} {} + Proceed on to the next entry in the route-map. + +.. index:: {Route-map Command} {on-match goto `N`} {} + +{Route-map Command} {on-match goto `N`} {} +.. index:: {Route-map Command} {continue `N`} {} + +{Route-map Command} {continue `N`} {} + Proceed processing the route-map at the first entry whose order is >= N + +Route Map Examples +================== + +A simple example of a route-map: + +:: + + @group + route-map test permit 10 + match ip address 10 + set local-preference 200 + @end group + + +This means that if a route matches ip access-list number 10 it's +local-preference value is set to 200. + +See :ref:`BGP_Configuration_Examples` for examples of more sophisticated +useage of route-maps, including of the @samp{call} action. + diff --git a/doc/user/routeserver.rst b/doc/user/routeserver.rst new file mode 100644 index 0000000000..ac73e30b87 --- /dev/null +++ b/doc/user/routeserver.rst @@ -0,0 +1,18 @@ +.. _Configuring_Frr_as_a_Route_Server: + +********************************* +Configuring Frr as a Route Server +********************************* + +The purpose of a Route Server is to centralize the peerings between BGP +speakers. For example if we have an exchange point scenario with four BGP +speakers, each of which maintaining a BGP peering with the other three +(:ref:`fig:full-mesh`), we can convert it into a centralized scenario where +each of the four establishes a single BGP peering against the Route Server +(:ref:`fig:route-server`). + +We will first describe briefly the Route Server model implemented by Frr. +We will explain the commands that have been added for configuring that +model. And finally we will show a full example of Frr configured as Route +Server. + diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst new file mode 100644 index 0000000000..bf99940e39 --- /dev/null +++ b/doc/user/rpki.rst @@ -0,0 +1,277 @@ +.. _Prefix_Origin_Validation_Using_RPKI: + +Prefix Origin Validation Using RPKI +=================================== + +Prefix Origin Validation allows BGP routers to verify if the origin AS of +an IP prefix is legitimate to announce this IP prefix. The required +attestation objects are stored in the Resource Public Key Infrastructure +(@acronym{RPKI}). However, RPKI-enabled routers do not store cryptographic +data itself but only validation information. The validation of the +cryptographic data (so called Route Origin Authorization, or short +@acronym{ROA}, objects) will be performed by trusted cache servers. The +RPKI/RTR protocol defines a standard mechanism to maintain the exchange of +the prefix/origin AS mapping between the cache server and routers. +In combination with a BGP Prefix Origin Validation scheme a router is able +to verify received BGP updates without suffering from cryptographic +complexity. + +The RPKI/RTR protocol is defined in @cite{RFC6810, The Resource Public Key +Infrastructure (RPKI) to Router Protocol}, and the validation scheme in +@cite{RFC6811, BGP Prefix Origin Validation}. The current version of Prefix +Origin Validation in FRR implements both RFCs. + +For a more detailed but still easy-to-read background, we suggest the +following two articles: + +* @cite{Geoff Huston, Randy Bush: Securing BGP, In: The Internet + Protocol Journal, Volume 14, No. 2, 2011.} + `http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_14-2/142_bgp.html `_ + +* @cite{Geoff Huston: Resource Certification, In: The Internet Protocol + Journal, Volume 12, No.1, 2009.} + `http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_12-1/121_resource.html `_ + +.. _Features_of_the_Current_Implementation: + +Features of the Current Implementation +-------------------------------------- + +In a nutshell, the current implementation provides the following features + +* The BGP router can connect to one or more RPKI cache servers to + receive validated prefix to origin AS mappings. + Advanced failover can be implemented by server sockets with different + preference values. + +* If no connection to an RPKI cache server can be established after a + pre-defined timeout, the router will process routes without prefix origin + validation. It still will try to establish a connection to an RPKI cache + server in the background. + +* By default, enabling RPKI does not change best path selection. In + particular, invalid prefixes will still be considered during best path + selection. However, the router can be configured to ignore all invalid + prefixes. + +* Route maps can be configured to match a specific RPKI validation + state. This allows the creation of local policies, which handle BGP routes + based on the outcome of the Prefix Origin Validation. + + +.. _Enabling_RPKI: + +Enabling RPKI +------------- + +.. index:: {Command} {rpki} {} + +{Command} {rpki} {} + This command enables the RPKI configuration mode. Most commands that start + with *rpki* can only be used in this mode. + + When it is used in a telnet session, leaving of this mode cause rpki to be initialized. + + Executing this command alone does not activate prefix + validation. You need to configure at least one reachable cache server. See section + :ref:`Configuring_RPKI/RTR_Cache_Servers` for configuring a cache server. + +.. _Configuring_RPKI/RTR_Cache_Servers: + +Configuring RPKI/RTR Cache Servers +---------------------------------- + +The following commands are independent of a specific cache server. + +.. index:: {RPKI Command} {rpki polling_period <1-3600>} {} + +{RPKI Command} {rpki polling_period <1-3600>} {} +.. index:: {RPKI Command} {no rpki polling_period} {} + +{RPKI Command} {no rpki polling_period} {} + Set the number of seconds the router waits until the router asks the cache again + for updated data. + + The default value is 300 seconds. + +.. index:: {RPKI Command} {rpki timeout <1-4,294,967,296>} {} + +{RPKI Command} {rpki timeout <1-4,294,967,296>} {} +.. index:: {RPKI Command} {no rpki timeout} {} + +{RPKI Command} {no rpki timeout} {} + Set the number of seconds the router waits for the cache reply. If the + cache server is not replying within this time period, the router deletes + all received prefix records from the prefix table. + + The default value is 600 seconds. + +.. index:: {RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {} + +{RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {} +.. index:: {RPKI Command} {no rpki initial-synchronisation-timeout} {} + +{RPKI Command} {no rpki initial-synchronisation-timeout} {} + Set the number of seconds until the first synchronization with the cache + server needs to be completed. If the timeout expires, BGP routing is + started without RPKI. The router will try to establish the cache server + connection in the background. + + The default value is 30 seconds. + + The following commands configure one or multiple cache servers. + +.. index:: {RPKI Socket Command} {rpki cache (`A.B.C.D`|`WORD`) `PORT` [`SSH_USERNAME`] [`SSH_PRIVKEY_PATH`] [`SSH_PUBKEY_PATH`] [`KNOWN_HOSTS_PATH`] `PREFERENCE`} {} + +{RPKI Socket Command} {rpki cache (`A.B.C.D`|`WORD`) `PORT` [`SSH_USERNAME`] [`SSH_PRIVKEY_PATH`] [`SSH_PUBKEY_PATH`] [`KNOWN_HOSTS_PATH`] `PREFERENCE`} {} +.. index:: {RPKI Socket Command} {no rpki cache (`A.B.C.D`|`WORD`) [`PORT`] `PREFERENCE`} {} + +{RPKI Socket Command} {no rpki cache (`A.B.C.D`|`WORD`) [`PORT`] `PREFERENCE`} {} + Add a cache server to the socket. By default, the connection between + router and cache server is based on plain TCP. Protecting the connection + between router and cache server by SSH is optional. + Deleting a socket removes the associated cache server and + terminates the existing connection. + + + +*`A.B.C.D`|`WORD`* + Address of the cache server. + + +*`PORT`* + Port number to connect to the cache server + + +*`SSH_USERNAME`* + SSH username to establish an SSH connection to the cache server. + + +*`SSH_PRIVKEY_PATH`* + Local path that includes the private key file of the router. + + +*`SSH_PUBKEY_PATH`* + Local path that includes the public key file of the router. + + +*`KNOWN_HOSTS_PATH`* + Local path that includes the known hosts file. The default value depends on the + configuration of the operating system environment, usually + :file:`~/.ssh/known_hosts`. + + +.. _Validating_BGP_Updates: + +Validating BGP Updates +---------------------- + +.. index:: {Route Map Command} {match rpki {notfound|invalid|valid}} {} + +{Route Map Command} {match rpki {notfound|invalid|valid}} {} +.. index:: {Route Map Command} {no match rpki {notfound|invalid|valid}} {} + +{Route Map Command} {no match rpki {notfound|invalid|valid}} {} + Create a clause for a route map to match prefixes with the specified RPKI state. + + @strong{Note} that the matching of invalid prefixes requires that invalid + prefixes are considered for best path selection, i.e., @command{bgp + bestpath prefix-validate disallow-invalid} is not enabled. + + In the following example, the router prefers valid routes over invalid + prefixes because invalid routes have a lower local preference. +:: + + ! Allow for invalid routes in route selection process + route bgp 60001 + ! + ! Set local preference of invalid prefixes to 10 + route-map rpki permit 10 + match rpki invalid + set local-preference 10 + ! + ! Set local preference of valid prefixes to 500 + route-map rpki permit 500 + match rpki valid + set local-preference 500 + + + +.. _Debugging: + +Debugging +--------- + +.. index:: {Command} {debug rpki} {} + +{Command} {debug rpki} {} +.. index:: {Command} {no debug rpki} {} + +{Command} {no debug rpki} {} + Enable or disable debugging output for RPKI. + +.. _Displaying_RPKI: + +Displaying RPKI +--------------- + +.. index:: {Command} {show rpki prefix-table} {} + +{Command} {show rpki prefix-table} {} + Display all validated prefix to origin AS mappings/records which have been + received from the cache servers and stored in the router. Based on this data, + the router validates BGP Updates. + +.. index:: {Command} {show rpki cache-connection} {} + +{Command} {show rpki cache-connection} {} + Display all configured cache servers, whether active or not. + +RPKI Configuration Example +-------------------------- + +:: + + hostname bgpd1 + password zebra + ! log stdout + debug bgp updates + debug bgp keepalives + debug rpki + ! + rpki + rpki polling_period 1000 + rpki timeout 10 + ! SSH Example: + rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1 + ! TCP Example: + rpki cache rpki-validator.realmv6.org 8282 preference 2 + exit + ! + router bgp 60001 + bgp router-id 141.22.28.223 + network 192.168.0.0/16 + neighbor 123.123.123.0 remote-as 60002 + neighbor 123.123.123.0 route-map rpki in + ! + address-family ipv6 + neighbor 123.123.123.0 activate + neighbor 123.123.123.0 route-map rpki in + exit-address-family + ! + route-map rpki permit 10 + match rpki invalid + set local-preference 10 + ! + route-map rpki permit 20 + match rpki notfound + set local-preference 20 + ! + route-map rpki permit 30 + match rpki valid + set local-preference 30 + ! + route-map rpki permit 40 + ! + + diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst new file mode 100644 index 0000000000..286104e396 --- /dev/null +++ b/doc/user/snmp.rst @@ -0,0 +1,207 @@ +.. _SNMP_Support: + +************ +SNMP Support +************ + +@acronym{SNMP,Simple Network Managing Protocol} is a widely implemented +feature for collecting network information from router and/or host. +Frr itself does not support SNMP agent (server daemon) functionality +but is able to connect to a SNMP agent using the SMUX protocol +(@cite{RFC1227}) or the AgentX protocol (@cite{RFC2741}) and make the +routing protocol MIBs available through it. + +Note that SNMP Support needs to be enabled at compile-time and loaded as +module on daemon startup. Refer to :ref:`Loadable_Module_Support` on +the latter. + +.. _Getting_and_installing_an_SNMP_agent: + +Getting and installing an SNMP agent +==================================== + +There are several SNMP agent which support SMUX or AgentX. We recommend to use the latest +version of `net-snmp` which was formerly known as `ucd-snmp`. +It is free and open software and available at `http://www.net-snmp.org/ `_ +and as binary package for most Linux distributions. +`net-snmp` has to be compiled with `--with-mib-modules=agentx` to +be able to accept connections from Frr using AgentX protocol or with +`--with-mib-modules=smux` to use SMUX protocol. + +Nowadays, SMUX is a legacy protocol. The AgentX protocol should be +preferred for any new deployment. Both protocols have the same coverage. + +.. _AgentX_configuration: + +AgentX configuration +==================== + +To enable AgentX protocol support, Frr must have been build with the +`--enable-snmp` or `--enable-snmp=agentx` option. Both the +master SNMP agent (snmpd) and each of the Frr daemons must be +configured. In `/etc/snmp/snmpd.conf`, `master agentx` +directive should be added. In each of the Frr daemons, `agentx` +command will enable AgentX support. + +:: + + /etc/snmp/snmpd.conf: + # + # example access restrictions setup + # + com2sec readonly default public + group MyROGroup v1 readonly + view all included .1 80 + access MyROGroup "" any noauth exact all none none + # + # enable master agent for AgentX subagents + # + master agentx + + /etc/frr/ospfd.conf: + ! ... the rest of ospfd.conf has been omitted for clarity ... + ! + agentx + ! + + +Upon successful connection, you should get something like this in the +log of each Frr daemons: + +:: + + 2012/05/25 11:39:08 ZEBRA: snmp[info]: NET-SNMP version 5.4.3 AgentX subagent connected + + +Then, you can use the following command to check everything works as expected: + +:: + + # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 + OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 + [...] + + +The AgentX protocol can be transported over a Unix socket or using TCP +or UDP. It usually defaults to a Unix socket and depends on how NetSNMP +was built. If need to configure Frr to use another transport, you can +configure it through `/etc/snmp/frr.conf`: + +:: + + /etc/snmp/frr.conf: + [snmpd] + # Use a remote master agent + agentXSocket tcp:192.168.15.12:705 + + +.. _SMUX_configuration: + +SMUX configuration +================== + +To enable SMUX protocol support, Frr must have been build with the +`--enable-snmp=smux` option. + +A separate connection has then to be established between the +SNMP agent (snmpd) and each of the Frr daemons. This connections +each use different OID numbers and passwords. Be aware that this OID +number is not the one that is used in queries by clients, it is solely +used for the intercommunication of the daemons. + +In the following example the ospfd daemon will be connected to the +snmpd daemon using the password "frr_ospfd". For testing it is +recommending to take exactly the below snmpd.conf as wrong access +restrictions can be hard to debug. + +:: + + /etc/snmp/snmpd.conf: + # + # example access restrictions setup + # + com2sec readonly default public + group MyROGroup v1 readonly + view all included .1 80 + access MyROGroup "" any noauth exact all none none + # + # the following line is relevant for Frr + # + smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd + + /etc/frr/ospf: + ! ... the rest of ospfd.conf has been omitted for clarity ... + ! + smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd + ! + + +After restarting snmpd and frr, a successful connection can be verified in +the syslog and by querying the SNMP daemon: + +:: + + snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255 + snmpd[12300]: accepted smux peer: \\ + oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5 + + # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 + OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 + + +Be warned that the current version (5.1.1) of the Net-SNMP daemon writes a line +for every SNMP connect to the syslog which can lead to enormous log file sizes. +If that is a problem you should consider to patch snmpd and comment out the +troublesome `snmp_log()` line in the function +`netsnmp_agent_check_packet()` in `agent/snmp_agent.c`. + +MIB and command reference +========================= + +The following OID numbers are used for the interprocess communication of snmpd and +the Frr daemons with SMUX only. +:: + + (OIDs below .iso.org.dod.internet.private.enterprises) + zebra .1.3.6.1.4.1.3317.1.2.1 .gnome.gnomeProducts.zebra.zserv + bgpd .1.3.6.1.4.1.3317.1.2.2 .gnome.gnomeProducts.zebra.bgpd + ripd .1.3.6.1.4.1.3317.1.2.3 .gnome.gnomeProducts.zebra.ripd + ospfd .1.3.6.1.4.1.3317.1.2.5 .gnome.gnomeProducts.zebra.ospfd + ospf6d .1.3.6.1.4.1.3317.1.2.6 .gnome.gnomeProducts.zebra.ospf6d + + +Sadly, SNMP has not been implemented in all daemons yet. The following +OID numbers are used for querying the SNMP daemon by a client: +:: + + zebra .1.3.6.1.2.1.4.24 .iso.org.dot.internet.mgmt.mib-2.ip.ipForward + ospfd .1.3.6.1.2.1.14 .iso.org.dot.internet.mgmt.mib-2.ospf + bgpd .1.3.6.1.2.1.15 .iso.org.dot.internet.mgmt.mib-2.bgp + ripd .1.3.6.1.2.1.23 .iso.org.dot.internet.mgmt.mib-2.rip2 + ospf6d .1.3.6.1.3.102 .iso.org.dod.internet.experimental.ospfv3 + + +The following syntax is understood by the Frr daemons for configuring SNMP using SMUX: +.. index:: {Command} {smux peer `oid`} {} + +{Command} {smux peer `oid`} {} +.. index:: {Command} {no smux peer `oid`} {} + +{Command} {no smux peer `oid`} {} + +.. index:: {Command} {smux peer `oid` `password`} {} + +{Command} {smux peer `oid` `password`} {} +.. index:: {Command} {no smux peer `oid` `password`} {} + +{Command} {no smux peer `oid` `password`} {} + Here is the syntax for using AgentX: +.. index:: {Command} {agentx} {} + +{Command} {agentx} {} +.. index:: {Command} {no agentx} {} + +{Command} {no agentx} {} + + @include snmptrap.texi + diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst new file mode 100644 index 0000000000..70d5bcdc2f --- /dev/null +++ b/doc/user/snmptrap.rst @@ -0,0 +1,200 @@ +Handling SNMP Traps +=================== + +To handle snmp traps make sure your snmp setup of frr works +correctly as described in the frr documentation in :ref:`SNMP_Support`. + +The BGP4 mib will send traps on peer up/down events. These should be +visible in your snmp logs with a message similar to: + +@samp{snmpd[13733]: Got trap from peer on fd 14} + +To react on these traps they should be handled by a trapsink. Configure +your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: + +:: + + # send traps to the snmptrapd on localhost + trapsink localhost + + +This will send all traps to an snmptrapd running on localhost. You can +of course also use a dedicated management station to catch traps. +Configure the snmptrapd daemon by adding the following line to +:file:`/etc/snmpd/snmptrapd.conf`: + +:: + + traphandle .1.3.6.1.4.1.3317.1.2.2 /etc/snmp/snmptrap_handle.sh + + +This will use the bash script :file:`/etc/snmp/snmptrap_handle.sh` to handle +the BGP4 traps. To add traps for other protocol daemons, lookup their +appropriate OID from their mib. (For additional information about which +traps are supported by your mib, lookup the mib on +`http://www.oidview.com/mibs/detail.html `_). + +Make sure snmptrapd is started. + +The snmptrap_handle.sh script I personally use for handling BGP4 traps +is below. You can of course do all sorts of things when handling traps, +like sound a siren, have your display flash, etc., be creative ;). + +@verbatim +#!/bin/bash + +# routers name +ROUTER=`hostname -s` + +#email address use to sent out notification +EMAILADDR="john@doe.com" +#email address used (allongside above) where warnings should be sent +EMAILADDR_WARN="sms-john@doe.com" + +# type of notification +TYPE="Notice" + +# local snmp community for getting AS belonging to peer +COMMUNITY="" + +# if a peer address is in $WARN_PEERS a warning should be sent +WARN_PEERS="192.0.2.1" + +# get stdin +INPUT=`cat -` + +# get some vars from stdin +uptime=`echo $INPUT | cut -d' ' -f5` +peer=`echo $INPUT | cut -d' ' -f8 | sed -e 's/SNMPv2-SMI::mib-2.15.3.1.14.//g'` +peerstate=`echo $INPUT | cut -d' ' -f13` +errorcode=`echo $INPUT | cut -d' ' -f9 | sed -e 's/\\"//g'` +suberrorcode=`echo $INPUT | cut -d' ' -f10 | sed -e 's/\\"//g'` +remoteas=`snmpget -v2c -c $COMMUNITY localhost SNMPv2-SMI::mib-2.15.3.1.9.$peer | cut -d' ' -f4` + +WHOISINFO=`whois -h whois.ripe.net " -r AS$remoteas" | egrep '(as-name|descr)'` +asname=`echo "$WHOISINFO" | grep "^as-name:" | sed -e 's/^as-name://g' -e 's/ //g' -e 's/^ //g' | uniq` +asdescr=`echo "$WHOISINFO" | grep "^descr:" | sed -e 's/^descr://g' -e 's/ //g' -e 's/^ //g' | uniq` + +# if peer address is in $WARN_PEER, the email should also +# be sent to $EMAILADDR_WARN +for ip in $WARN_PEERS; do +if [ "x$ip" == "x$peer" ]; then +EMAILADDR="$EMAILADDR,$EMAILADDR_WARN" +TYPE="WARNING" +break +fi +done + +# convert peer state +case "$peerstate" in +1) peerstate="Idle" ;; +2) peerstate="Connect" ;; +3) peerstate="Active" ;; +4) peerstate="Opensent" ;; +5) peerstate="Openconfirm" ;; +6) peerstate="Established" ;; +*) peerstate="Unknown" ;; +esac + +# get textual messages for errors +case "$errorcode" in +00) +error="No error" +suberror="" +;; +01) +error="Message Header Error" +case "$suberrorcode" in +01) suberror="Connection Not Synchronized" ;; +02) suberror="Bad Message Length" ;; +03) suberror="Bad Message Type" ;; +*) suberror="Unknown" ;; +esac +;; +02) +error="OPEN Message Error" +case "$suberrorcode" in +01) suberror="Unsupported Version Number" ;; +02) suberror="Bad Peer AS" ;; +03) suberror="Bad BGP Identifier" ;; +04) suberror="Unsupported Optional Parameter" ;; +05) suberror="Authentication Failure" ;; +06) suberror="Unacceptable Hold Time" ;; +*) suberror="Unknown" ;; +esac +;; +03) +error="UPDATE Message Error" +case "$suberrorcode" in +01) suberror="Malformed Attribute List" ;; +02) suberror="Unrecognized Well-known Attribute" ;; +03) suberror="Missing Well-known Attribute" ;; +04) suberror="Attribute Flags Error" ;; +05) suberror="Attribute Length Error" ;; +06) suberror="Invalid ORIGIN Attribute" ;; +07) suberror="AS Routing Loop" ;; +08) suberror="Invalid NEXT_HOP Attribute" ;; +09) suberror="Optional Attribute Error" ;; +10) suberror="Invalid Network Field" ;; +11) suberror="Malformed AS_PATH" ;; +*) suberror="Unknown" ;; +esac +;; +04) +error="Hold Timer Expired" +suberror="" +;; +05) +error="Finite State Machine Error" +suberror="" +;; +06) +error="Cease" +case "$suberrorcode" in +01) suberror="Maximum Number of Prefixes Reached" ;; +02) suberror="Administratively Shutdown" ;; +03) suberror="Peer Unconfigured" ;; +04) suberror="Administratively Reset" ;; +05) suberror="Connection Rejected" ;; +06) suberror="Other Configuration Change" ;; +07) suberror="Connection collision resolution" ;; +08) suberror="Out of Resource" ;; +09) suberror="MAX" ;; +*) suberror="Unknown" ;; +esac +;; +*) +error="Unknown" +suberror="" +;; +esac + +# create textual message from errorcodes +if [ "x$suberror" == "x" ]; then +NOTIFY="$errorcode ($error)" +else +NOTIFY="$errorcode/$suberrorcode ($error/$suberror)" +fi + +# form a decent subject +SUBJECT="$TYPE: $ROUTER [bgp] $peer is $peerstate: $NOTIFY" +# create the email body +MAIL=`cat << EOF +BGP notification on router $ROUTER. + +Peer: $peer +AS: $remoteas +New state: $peerstate +Notification: $NOTIFY + +Info: +$asname +$asdescr + +Snmpd uptime: $uptime +EOF` + +# mail the notification +echo "$MAIL" | mail -s "$SUBJECT" $EMAILADDR +@end verbatim + diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst new file mode 100644 index 0000000000..6d9c4c40fe --- /dev/null +++ b/doc/user/vnc.rst @@ -0,0 +1,1023 @@ +.. _VNC_and_VNC-GW: + +************** +VNC and VNC-GW +************** + +This chapter describes how to use +Virtual Network Control (@acronym{VNC}) services, +including Network Virtualization Authority (@acronym{NVA}) and +VNC Gateway (@acronym{VNC-GW}) functions. +Background information on NVAs, +Network Virtualization Edges (@acronym{NVE}s), underlay networks (@acronym{UN}s), +and virtual networks (@acronym{VN}s) is available from the +`https://datatracker.ietf.org/wg/nvo3,IETF Network Virtualization Overlays (@acronym{NVO3 `_) Working Group}. +VNC Gateways (@acronym{VNC-GW}s) support the import/export of routing +information between VNC and customer edge routers (@acronym{CE}s) +operating within a VN. Both IP/Layer 3 (L3) VNs, and IP with +Ethernet/Layer 2 (L2) VNs are supported. + +BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN +information between NVAs. BGP based IP VPN support is defined in +@cite{RFC4364, BGP/MPLS IP Virtual Private Networks (VPNs)}, and +@cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for +IPv6 VPN }. Both the Encapsulation Subsequent Address Family Identifier +(SAFI) and the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP +Encapsulation Subsequent Address Family Identifier (SAFI) and the BGP +Tunnel Encapsulation Attribute}, are supported. + +The protocol that is used to communicate routing and Ethernet / Layer 2 +(L2) forwarding information between NVAs and NVEs is referred to as the +Remote Forwarder Protocol (RFP). `OpenFlow` is an example +RFP. Specific RFP implementations may choose to implement either a +`hard-state` or `soft-state` prefix and address registration +model. To support a `soft-state` refresh model, a `lifetime` +in seconds is associated with all registrations and responses. + +The chapter also provides sample configurations for basic example scenarios. + +.. _Configuring_VNC: + +Configuring VNC +=============== + +Virtual Network Control (@acronym{VNC}) service configuration commands +appear in the `router bgp` section of the BGPD configuration file +(:ref:`BGP_Configuration_Examples`). The commands are broken down into +the following areas: + +`General VNC` configuration applies to general VNC operation and is +primarily used to control the method used to advertise tunnel +information. + +`Remote Forwarder Protocol (RFP)` configuration relates to the +protocol used between NVAs and NVEs. + +`VNC Defaults` provides default parameters for registered NVEs. + +`VNC NVE Group` provides for configuration of a specific set of +registered NVEs and overrides default parameters. + +`Redistribution` and `Export` control VNC-GW operation, i.e., +the import/export of routing +information between VNC and customer edge routers (@acronym{CE}s) +operating within a VN. + +.. _General_VNC_Configuration: + +General VNC Configuration +------------------------- + +.. index:: {VNC} {vnc advertise-un-method encap-safi|encap-attr} {} + +{VNC} {vnc advertise-un-method encap-safi|encap-attr} {} + Advertise NVE underlay-network IP addresses using the encapsulation SAFI + (`encap-safi`) or the UN address sub-TLV of the Tunnel Encapsulation attribute + (`encap-attr`). When `encap-safi` is used, neighbors under + `address-family encap` and/or `address-family encapv6` must be + configured. The default is `encap-attr`. + +.. _RFP_Related_Configuration: + +RFP Related Configuration +------------------------- + +The protocol that is used to communicate routing and Ethernet / L2 +forwarding information between NVAs and NVEs is referred to as the +Remote Forwarder Protocol (RFP). Currently, only a simple example RFP +is included in Frr. Developers may use this example as a starting +point to integrate Frr with an RFP of their choosing, e.g., +`OpenFlow`. The example code includes the following sample +configuration: + +.. index:: {RFP} {rfp example-config-value `VALUE`} + +{RFP} {rfp example-config-value `VALUE`} + This is a simple example configuration parameter included as part of the + RFP example code. `VALUE` must be in the range of 0 to 4294967295. + +.. _VNC_Defaults_Configuration: + +VNC Defaults Configuration +-------------------------- + +The VNC Defaults section allows the user to specify default values for +configuration parameters for all registered NVEs. +Default values are overridden by :ref:`VNC_NVE_Group_Configuration`. + +.. index:: {VNC} {vnc defaults} {} + +{VNC} {vnc defaults} {} + Enter VNC configuration mode for specifying VNC default behaviors. Use + `exit-vnc` to leave VNC configuration mode. `vnc defaults` is optional. + +:: + + vnc defaults + ... various VNC defaults + exit-vnc + + +These are the statements that can appear between `vnc defaults` +and `exit-vnc`. + +.. index:: {VNC} {rt import `rt-list`} {} + +{VNC} {rt import `rt-list`} {} +.. index:: {VNC} {rt export `rt-list`} {} + +{VNC} {rt export `rt-list`} {} +.. index:: {VNC} {rt both `rt-list`} {} + +{VNC} {rt both `rt-list`} {} + Specify default route target import and export lists. `rt-list` is a + space-separated list of route targets, each element of which is + in one of the following forms: + + +`IPv4-address`:`two-byte-integer` + +`four-byte-autonomous-system-number`:`two-byte-integer` + +`two-byte-autonomous-system-number`:`four-byte-integer` + + If no default import RT list is specified, then the default import RT + list is empty. + If no default export RT list is specified, then the default export RT + list is empty. + + A complete definition of these parameters is + given below (:ref:`VNC_NVE_Group_Configuration`). + +.. index:: {VNC} {rd `route-distinguisher`} + +{VNC} {rd `route-distinguisher`} + Specify the default route distinguisher (RD) for routes advertised via BGP + VPNs. The route distinguisher must be in one of four forms: + + +`IPv4-address`:`two-byte-integer` + +`four-byte-autonomous-system-number`:`two-byte-integer` + +`two-byte-autonomous-system-number`:`four-byte-integer` + +auto:vn:`two-byte-integer` + + If RD is specified in the defaults section, the default RD + value is `two-byte-autonomous-system-number=0`:`four-byte-integer=0`. + + A complete definition of this parameter is + given below (:ref:`VNC_NVE_Group_Configuration`). + +.. index:: {VNC} {l2rd `nve-id-value`} + +{VNC} {l2rd `nve-id-value`} + Set the value used to distinguish NVEs connected to the same logical + Ethernet segment (i.e., L2VPN). + + A complete definition of this parameter is + given below (:ref:`VNC_NVE_Group_Configuration`). + +.. index:: {VNC} {response-lifetime `lifetime`|infinite} {} + +{VNC} {response-lifetime `lifetime`|infinite} {} + Specify the default lifetime to be included in RFP + response messages sent to NVEs. + + A complete definition of this parameter is + given below (:ref:`VNC_NVE_Group_Configuration`). + +.. index:: {VNC} {export bgp|zebra route-map MAP-NAME} + +{VNC} {export bgp|zebra route-map MAP-NAME} + Specify that the named route-map should be applied to routes + being exported to bgp or zebra. + +.. index:: {VNC} {export bgp|zebra no route-map} + +{VNC} {export bgp|zebra no route-map} + Specify that no route-map should be applied to routes + being exported to bgp or zebra. + +.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + +{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + Specify that the named prefix-list filter should be applied to + routes being exported to bgp or zebra. + Prefix-lists for ipv4 and ipv6 are independent of each other. + +.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + +{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + Specify that no prefix-list filter should be applied to + routes being exported to bgp or zebra. + +.. index:: {VNC} {exit-vnc} {} + +{VNC} {exit-vnc} {} + Exit VNC configuration mode. + +.. _VNC_NVE_Group_Configuration: + +VNC NVE Group Configuration +--------------------------- + +A NVE Group corresponds to a specific set of NVEs. A Client NVE is +assigned to an NVE Group based on whether there is a match for either +its virtual or underlay network address against the VN and/or UN address +prefixes specified in the NVE Group definition. When an NVE Group +definition specifies both VN and UN address prefixes, then an NVE must +match both prefixes in order to be assigned to the NVE Group. In the +event that multiple NVE Groups match based on VN and/or UN addresses, +the NVE is assigned to the first NVE Group listed in the configuration. +If an NVE is not assigned to an NVE Group, its messages will be ignored. + +Configuration values specified for an NVE group apply to all +member NVEs and override configuration values specified in the VNC +Defaults section. + +@strong{At least one `nve-group` is mandatory for useful VNC +operation.} + +.. index:: {VNC} {vnc nve-group `name`} {} + +{VNC} {vnc nve-group `name`} {} + Enter VNC configuration mode for defining the NVE group `name`. + Use `exit` or `exit-vnc` to exit group configuration mode. + +:: + + vnc nve-group group1 + ... configuration commands + exit-vnc + + +.. index:: {VNC} {no vnc nve-group `name`} {} + +{VNC} {no vnc nve-group `name`} {} + Delete the NVE group named `name`. + +The following statements are valid in an NVE group definition: + +.. index:: {VNC} {l2rd `nve-id-value`} + +{VNC} {l2rd `nve-id-value`} + Set the value used to distinguish NVEs connected to the same physical + Ethernet segment (i.e., at the same location)@footnote{The nve-id is + carried in the route + distinguisher. It is the second octet of the eight-octet route + distinguisher generated for Ethernet / L2 advertisements. + The first octet is a constant 0xFF, and the third through eighth + octets are set to the L2 ethernet address being advertised.} + + The nve-id subfield may be specified as either a literal value + in the range 1-255, or it may be specified as `auto:vn`, which + means to use the least-significant octet of the originating + NVE's VN address. + +.. index:: {VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {} + +{VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {} + .. _prefix: + + Specify the matching prefix for this NVE group by either virtual-network address + (`vn`) or underlay-network address (`un`). Either or both virtual-network + and underlay-network prefixes may be specified. Subsequent virtual-network or + underlay-network values within a `vnc nve-group` `exit-vnc` + block override their respective previous values. + + These prefixes are used only for determining assignments of NVEs + to NVE Groups. + +.. index:: {VNC} {rd `route-distinguisher`} + +{VNC} {rd `route-distinguisher`} + Specify the route distinguisher for routes advertised via BGP + VPNs. The route distinguisher must be in one of these forms: + + +`IPv4-address`:`two-byte-integer` + +`four-byte-autonomous-system-number`:`two-byte-integer` + +`two-byte-autonomous-system-number`:`four-byte-integer` + +auto:vn:`two-byte-integer` + + Routes originated by NVEs in the NVE group will use + the group's specified `route-distinguisher` when they are + advertised via BGP. + If the `auto` form is specified, it means that a matching NVE has + its RD set to + `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer`, + for IPv4 VN addresses and + `rd_type=IP=1`:`IPv4-address=Last-four-bytes-of-VN-address`:`two-byte-integer`, + for IPv6 VN addresses. + + If the NVE group definition does not specify a `route-distinguisher`, + then the default `route-distinguisher` is used. + If neither a group nor a default `route-distinguisher` is + configured, then the advertised RD is set to + `two-byte-autonomous-system-number=0`:`four-byte-integer=0`. + +.. index:: {VNC} {response-lifetime `lifetime`|infinite} {} + +{VNC} {response-lifetime `lifetime`|infinite} {} + Specify the response lifetime, in seconds, to be included in RFP + response messages sent to NVEs. If the value + 'infinite' is given, an infinite lifetime will be used. + + Note that this parameter is not the same as the lifetime supplied by + NVEs in RFP registration messages. This parameter does not affect + the lifetime value attached to routes sent by this server via BGP. + + If the NVE group definition does not specify a `response-lifetime`, + the default `response-lifetime` will be used. + If neither a group nor a default `response-lifetime` is configured, + the value 3600 will be used. The maximum response lifetime is 2147483647. + +.. index:: {VNC} {rt export `rt-list`} {} + +{VNC} {rt export `rt-list`} {} +.. index:: {VNC} {rt import `rt-list`} {} + +{VNC} {rt import `rt-list`} {} +.. index:: {VNC} {rt both `rt-list`} {} + +{VNC} {rt both `rt-list`} {} + Specify route target import and export lists. `rt-list` is a + space-separated list of route targets, each element of which is + in one of the following forms: + + +`IPv4-address`:`two-byte-integer` + +`four-byte-autonomous-system-number`:`two-byte-integer` + +`two-byte-autonomous-system-number`:`four-byte-integer` + + The first form, `rt export`, specifies an `export rt-list`. + The `export rt-list` will be attached to routes originated by + NVEs in the NVE group when they are advertised via BGP. + If the NVE group definition does not specify an `export rt-list`, + then the default `export rt-list` is used. + If neither a group nor a default `export rt-list` is configured, + then no RT list will be sent; in turn, these routes will probably + not be processed + by receiving NVAs. + + The second form, `rt import` specifies an `import rt-list`, + which is a filter for incoming routes. + In order to be made available to NVEs in the group, + incoming BGP VPN and @w{ENCAP} @w{SAFI} (when `vnc advertise-un-method encap-safi` is set) routes must have + RT lists that have at least one route target in common with the + group's `import rt-list`. + + If the NVE group definition does not specify an import filter, + then the default `import rt-list` is used. + If neither a group nor a default `import rt-list` is configured, + there can be no RT intersections when receiving BGP routes and + therefore no incoming BGP routes will be processed for the group. + + The third, `rt both`, is a shorthand way of specifying both + lists simultaneously, and is equivalent to `rt export `rt-list`` + followed by `rt import `rt-list``. + +.. index:: {VNC} {export bgp|zebra route-map MAP-NAME} + +{VNC} {export bgp|zebra route-map MAP-NAME} + Specify that the named route-map should be applied to routes + being exported to bgp or zebra. + This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. + This item is optional. + +.. index:: {VNC} {export bgp|zebra no route-map} + +{VNC} {export bgp|zebra no route-map} + Specify that no route-map should be applied to routes + being exported to bgp or zebra. + This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. + This item is optional. + +.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + +{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + Specify that the named prefix-list filter should be applied to + routes being exported to bgp or zebra. + Prefix-lists for ipv4 and ipv6 are independent of each other. + This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. + This item is optional. + +.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + +{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + Specify that no prefix-list filter should be applied to + routes being exported to bgp or zebra. + This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. + This item is optional. + +.. _VNC_L2_Group_Configuration: + +VNC L2 Group Configuration +-------------------------- + +The route targets advertised with prefixes and addresses registered by +an NVE are determined based on the NVE's associated VNC NVE Group +Configuration, :ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups +are used to override the route targets for an NVE's Ethernet +registrations based on the Logical Network Identifier and label value. +A Logical Network Identifier is used to uniquely identify a logical +Ethernet segment and is conceptually similar to the Ethernet Segment +Identifier defined in @cite{RFC7432, BGP MPLS-Based Ethernet VPN}. Both +the Logical Network Identifier and Label are passed to VNC via RFP +prefix and address registration. + +Note that a corresponding NVE group configuration must be present, and +that other NVE associated configuration information, notably RD, is +not impacted by L2 Group Configuration. + +.. index:: {VNC} {vnc l2-group `name`} {} + +{VNC} {vnc l2-group `name`} {} + Enter VNC configuration mode for defining the L2 group `name`. + Use `exit` or `exit-vnc` to exit group configuration mode. + +:: + + vnc l2-group group1 + ... configuration commands + exit-vnc + + +.. index:: {VNC} {no vnc l2-group `name`} {} + +{VNC} {no vnc l2-group `name`} {} + Delete the L2 group named `name`. + +The following statements are valid in a L2 group definition: + +.. index:: {VNC} {logical-network-id `VALUE`} + +{VNC} {logical-network-id `VALUE`} + Define the Logical Network Identifier with a value in the range of + 0-4294967295 that identifies the logical Ethernet segment. + +.. index:: {VNC} {labels `label-list`} + +{VNC} {labels `label-list`} +.. index:: {VNC} {no labels `label-list`} + +{VNC} {no labels `label-list`} + Add or remove labels associated with the group. `label-list` is a + space separated list of label values in the range of 0-1048575. + +.. index:: {VNC} {rt import `rt-target`} {} + +{VNC} {rt import `rt-target`} {} +.. index:: {VNC} {rt export `rt-target`} {} + +{VNC} {rt export `rt-target`} {} +.. index:: {VNC} {rt both `rt-target`} {} + +{VNC} {rt both `rt-target`} {} + Specify the route target import and export value associated with the + group. A complete definition of these parameters is given above, + :ref:`VNC_NVE_Group_Configuration`. + +.. _Configuring_Redistribution_of_Routes_from_Other_Routing_Protocols: + +Configuring Redistribution of Routes from Other Routing Protocols +----------------------------------------------------------------- + +Routes from other protocols (including BGP) can be provided to VNC (both +for RFP and for redistribution via BGP) +from three sources: the zebra kernel routing process; +directly from the main (default) unicast BGP RIB; or directly +from a designated BGP unicast exterior routing RIB instance. + +The protocol named in the `vnc redistribute` command indicates +the route source: +`bgp-direct` routes come directly from the main (default) +unicast BGP RIB and are available for RFP and are redistributed via BGP; +`bgp-direct-to-nve-groups` routes come directly from a designated +BGP unicast routing RIB and are made available only to RFP; +and routes from other protocols come from the zebra kernel +routing process. +Note that the zebra process does not need to be active if +only `bgp-direct` or `bgp-direct-to-nve-groups` routes are used. + +`zebra` routes +^^^^^^^^^^^^^^ + +Routes originating from protocols other than BGP must be obtained +via the zebra routing process. +Redistribution of these routes into VNC does not support policy mechanisms +such as prefix-lists or route-maps. + +`bgp-direct` routes +^^^^^^^^^^^^^^^^^^^ + +`bgp-direct` redistribution supports policy via +prefix lists and route-maps. This policy is applied to incoming +original unicast routes before the redistribution translations +(described below) are performed. + +Redistribution of `bgp-direct` routes is performed in one of three +possible modes: `plain`, `nve-group`, or `resolve-nve`. +The default mode is `plain`. +These modes indicate the kind of translations applied to routes before +they are added to the VNC RIB. + +In `plain` mode, the route's next hop is unchanged and the RD is set +based on the next hop. +For `bgp-direct` redistribution, the following translations are performed: + +* + The VN address is set to the original unicast route's next hop address. +* + The UN address is NOT set. (VN->UN mapping will occur via + ENCAP route or attribute, based on `vnc advertise-un-method` + setting, generated by the RFP registration of the actual NVE) +* + The RD is set to as if auto:vn:0 were specified (i.e., + `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer=0`) +* + The RT list is included in the extended community list copied from the + original unicast route (i.e., it must be set in the original unicast route). + +In `nve-group` mode, routes are registered with VNC as +if they came from an NVE in the nve-group designated in the +`vnc redistribute nve-group` command. The following +translations are performed: + +* + The next hop/VN address is set to the VN prefix configured for the + redistribute nve-group. +* + The UN address is set to the UN prefix configured for the + redistribute nve-group. +* + The RD is set to the RD configured for the redistribute nve-group. +* + The RT list is set to the RT list configured for the redistribute nve-group. + If `bgp-direct` routes are being redistributed, + any extended communities present in the original unicast route + will also be included. + +In `resolve-nve` mode, the next hop of the original BGP route is +typically the address of an NVE connected router (CE) connected by one or +more NVEs. +Each of the connected NVEs will register, via RFP, a VNC host route +to the CE. +This mode may be though of as a mechanism to proxy RFP registrations +of BGP unicast routes on behalf of registering NVEs. + +Multiple copies of the BGP route, one per matching NVE host route, will be +added to VNC. +In other words, for a given BGP unicast route, each instance of a +RFP-registered host route to the unicast route's next hop will result +in an instance of an imported VNC route. +Each such imported VNC route will have a prefix equal to the original +BGP unicast route's prefix, and a next hop equal to the next hop of the +matching RFP-registered host route. +If there is no RFP-registered host route to the next hop of the BGP unicast +route, no corresponding VNC route will be imported. + +The following translations are applied: + +* + The Next Hop is set to the next hop of the NVE route (i.e., the + VN address of the NVE). + +* + The extended community list in the new route is set to the + union of: + + * + Any extended communities in the original BGP route + * + Any extended communities in the NVE route + * + An added route-origin extended community with the next hop of the + original BGP route + is added to the new route. + The value of the local administrator field defaults 5226 but may + be configured by the user via the `roo-ec-local-admin` parameter. + +* + The Tunnel Encapsulation attribute is set to the value of the Tunnel + Encapsulation attribute of the NVE route, if any. + + +`bgp-direct-to-nve-groups` routes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Unicast routes from the main or a designated instance of BGP +may be redistributed to VNC as bgp-direct-to-nve-groups routes. These +routes are NOT announced via BGP, +but they are made available for local RFP lookup in response to +queries from NVEs. + +A non-main/default BGP instance is configured using the +`bgp multiple-instance` and `router bgp AS view NAME` +commands as described elsewhere in this document. + +In order for a route in the unicast BGP RIB to be made +available to a querying NVE, there must already be, available to +that NVE, an (interior) VNC route matching the next hop address +of the unicast route. +When the unicast route is provided to the NVE, its next hop +is replaced by the next hop of the corresponding +NVE. If there are multiple longest-prefix-match VNC routes, +the unicast route will be replicated for each. + +There is currently no policy (prefix-list or route-map) support +for `bgp-direct-to-nve-groups` routes. + +Redistribution Command Syntax +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. index:: {VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} + +{VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} +.. index:: {VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view `VIEWNAME`} {} + +{VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view `VIEWNAME`} {} +.. index:: {VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} + +{VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} + Import (or do not import) prefixes from another routing + protocols. Specify both the address family to import (`ipv4` or + `ipv6`) and the protocol (`bgp`, `bgp-direct`, + `bgp-direct-to-nve-groups`, `connected`, + `kernel`, `ospf`, `rip`, or `static`). Repeat + this statement as needed for each combination of address family and + routing protocol. + Prefixes from protocol `bgp-direct` are imported from unicast BGP + in the same bgpd process. + Prefixes from all other protocols (including `bgp`) are imported + via the `zebra` kernel routing process. + +.. index:: {VNC} {vnc redistribute mode plain|nve-group|resolve-nve} + +{VNC} {vnc redistribute mode plain|nve-group|resolve-nve} + Redistribute routes from other protocols into VNC using the + specified mode. + Not all combinations of modes and protocols are supported. + +.. index:: {VNC} {vnc redistribute nve-group `group-name`} {} + +{VNC} {vnc redistribute nve-group `group-name`} {} +.. index:: {VNC} {no vnc redistribute nve-group `group-name`} {} + +{VNC} {no vnc redistribute nve-group `group-name`} {} + When using `nve-group` mode, + assign (or do not assign) the NVE group `group-name` to routes + redistributed from another routing protocol. `group-name` + must be configured using `vnc nve-group`. + + The VN and UN prefixes of the nve-group must both be configured, + and each prefix must be specified as a full-length (/32 for IPv4, + /128 for IPv6) prefix. + +.. index:: {VNC} {vnc redistribute lifetime `lifetime`|infinite} {} + +{VNC} {vnc redistribute lifetime `lifetime`|infinite} {} + Assign a registration lifetime, either `lifetime` seconds or + `infinite`, to prefixes redistributed from other routing + protocols as if they had been received via RFP registration messages + from an NVE. `lifetime` can be any integer between 1 and + 4294967295, inclusive. + +.. index:: {VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`} + +{VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`} + Assign a value to the local-administrator subfield used in the + Route Origin extended community that is assigned to routes exported + under the `resolve-nve` mode. The default value is `5226`. + + The following four `prefix-list` and `route-map` commands + may be specified in the context of an nve-group or not. + If they are specified in the context of an nve-group, they + apply only if the redistribution mode is `nve-group`, + and then only for routes being redistributed from + `bgp-direct`. + If they are specified outside the context of an nve-group, then + they apply only for redistribution modes `plain` and `resolve-nve`, + and then only for routes being redistributed from `bgp-direct`. + +.. index:: {VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list `LIST-NAME`} + +{VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list `LIST-NAME`} + When redistributing `bgp-direct` routes, + specifies that the named prefix-list should be applied. + +.. index:: {VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list} + +{VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list} + When redistributing `bgp-direct` routes, + specifies that no prefix-list should be applied. + +.. index:: {VNC} {vnc redistribute bgp-direct route-map `MAP-NAME`} + +{VNC} {vnc redistribute bgp-direct route-map `MAP-NAME`} + When redistributing `bgp-direct` routes, + specifies that the named route-map should be applied. + +.. index:: {VNC} {vnc redistribute bgp-direct no route-map} + +{VNC} {vnc redistribute bgp-direct no route-map} + When redistributing `bgp-direct` routes, + specifies that no route-map should be applied. + +.. _Configuring_Export_of_Routes_to_Other_Routing_Protocols: + +Configuring Export of Routes to Other Routing Protocols +------------------------------------------------------- + +Routes from VNC (both for RFP and for redistribution via BGP) can be +provided to other protocols, either via zebra or directly to BGP. + +It is important to note that when exporting routes to other protocols, +the downstream protocol must also be configured to import the routes. +For example, when VNC routes are exported to unicast BGP, the BGP +configuration must include a corresponding `redistribute vnc-direct` +statement. + +.. index:: {VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce} + +{VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce} + Specify how routes should be exported to bgp or zebra. + If the mode is `none`, routes are not exported. + If the mode is `group-nve`, routes are exported according + to nve-group or vrf-policy group configuration (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to + allow export, then each prefix visible to the group is exported + with next hops set to the currently-registered NVEs. + If the mode is `registering-nve`, then all VNC routes are + exported with their original next hops. + If the mode is `ce`, only VNC routes that have an NVE connected CE Router + encoded in a Route Origin Extended Community are exported. + This extended community must have an administrative value that + matches the configured `roo-ec-local-admin` value. + The next hop of the exported route is set to the encoded + NVE connected CE Router. + + The default for both bgp and zebra is mode `none`. + +.. index:: {VNC} {vnc export bgp|zebra group-nve group `group-name`} + +{VNC} {vnc export bgp|zebra group-nve group `group-name`} +.. index:: {VNC} {vnc export bgp|zebra group-nve no group `group-name`} + +{VNC} {vnc export bgp|zebra group-nve no group `group-name`} + When export mode is `group-nve`, + export (or do not export) prefixes from the specified nve-group or + vrf-policy group + to unicast BGP or to zebra. + Repeat this statement as needed for each nve-group to be exported. + Each VNC prefix that is exported will result in N exported routes to the + prefix, each with a next hop corresponding to one of the N NVEs currently + associated with the nve-group. + +.. index:: {VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME + +{VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME + When export mode is `ce` or `registering-nve`, + specifies that the named prefix-list should be applied to routes + being exported to bgp or zebra. + Prefix-lists for ipv4 and ipv6 are independent of each other. + +.. index:: {VNC} export bgp|zebra no ipv4|ipv6 prefix-list + +{VNC} export bgp|zebra no ipv4|ipv6 prefix-list + When export mode is `ce` or `registering-nve`, + specifies that no prefix-list should be applied to routes + being exported to bgp or zebra. + +.. index:: {VNC} export bgp|zebra route-map MAP-NAME + +{VNC} export bgp|zebra route-map MAP-NAME + When export mode is `ce` or `registering-nve`, + specifies that the named route-map should be applied to routes + being exported to bgp or zebra. + +.. index:: {VNC} export bgp|zebra no route-map + +{VNC} export bgp|zebra no route-map + When export mode is `ce` or `registering-nve`, + specifies that no route-map should be applied to routes + being exported to bgp or zebra. + + When the export mode is `group-nve`, policy for exported + routes is specified per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block + via the following commands(:ref:`VNC_NVE_Group_Configuration`): + +.. index:: {VNC} {export bgp|zebra route-map MAP-NAME} + +{VNC} {export bgp|zebra route-map MAP-NAME} + This command is valid inside a `nve-group` `RFG-NAME` block. + It specifies that the named route-map should be applied to routes + being exported to bgp or zebra. + +.. index:: {VNC} {export bgp|zebra no route-map} + +{VNC} {export bgp|zebra no route-map} + This command is valid inside a `nve-group` `RFG-NAME` block. + It specifies that no route-map should be applied to routes + being exported to bgp or zebra. + +.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + +{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + This command is valid inside a `nve-group` `RFG-NAME` block. + It specifies that the named prefix-list filter should be applied to + routes being exported to bgp or zebra. + Prefix-lists for ipv4 and ipv6 are independent of each other. + +.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + +{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + This command is valid inside a `nve-group` `RFG-NAME` block. + It specifies that no prefix-list filter should be applied to + routes being exported to bgp or zebra. + +.. _Manual_Address_Control: + +Manual Address Control +====================== + +The commands in this section can be used to augment normal dynamic VNC. +The `add vnc` commands can be used to manually add IP prefix or +Ethernet MAC address forwarding information. The `clear vnc` +commands can be used to remove manually and dynamically added +information. + +.. index:: {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost <0-255>] [lifetime (infinite|<1-4294967295>)] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost <0-255>]]} {} + +{Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost <0-255>] [lifetime (infinite|<1-4294967295>)] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost <0-255>]]} {} + Register an IP prefix on behalf of the NVE identified by the VN and UN + addresses. The `cost` parameter provides the administrative + preference of the forwarding information for remote advertisement. If + omitted, it defaults to 255 (lowest preference). The `lifetime` + parameter identifies the period, in seconds, that the information + remains valid. If omitted, it defaults to `infinite`. The optional + `local-next-hop` parameter is used to configure a nexthop to be + used by an NVE to reach the prefix via a locally connected CE router. + This information remains local to the NVA, i.e., not passed to other + NVAs, and is only passed to registered NVEs. When specified, it is also + possible to provide a `local-cost` parameter to provide a + forwarding preference. If omitted, it defaults to 255 (lowest + preference). + +.. index:: {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier <1-4294967295> vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost <0-255>] [lifetime (infinite|<1-4294967295>)]} {} + +{Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier <1-4294967295> vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost <0-255>] [lifetime (infinite|<1-4294967295>)]} {} + Register a MAC address for a logical Ethernet (L2VPN) on behalf of the + NVE identified by the VN and UN addresses. + The optional `prefix` parameter is to support enable IP address + mediation for the given prefix. The `cost` parameter provides the administrative + preference of the forwarding information. If omitted, it defaults to + 255. The `lifetime` parameter identifies the period, in seconds, + that the information remains valid. If omitted, it defaults to + `infinite`. + +.. index:: {Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} + +{Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} + Delete the information identified by prefix, VN address, and UN address. + Any or all of these parameters may be wilcarded to (potentially) match + more than one registration. + The optional `mac` parameter specifies a layer-2 MAC address + that must match the registration(s) to be deleted. + The optional `local-next-hop` parameter is used to + delete specific local nexthop information. + +.. index:: {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|<1-4294967295>) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} + +{Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|<1-4294967295>) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} + Delete mac forwarding information. + Any or all of these parameters may be wilcarded to (potentially) match + more than one registration. + The default value for the `prefix` parameter is the wildcard value `*`. + +.. index:: {Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {} + +{Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {} + Delete prefixes associated with the NVE specified by the given VN and UN + addresses. + It is permissible to specify only one of VN or UN, in which case + any matching registration will be deleted. + It is also permissible to specify `*` in lieu of any VN or UN + address, in which case all registrations will match. + +.. _Other_VNC-Related_Commands: + +Other VNC-Related Commands +========================== + +Note: VNC-Related configuration can be obtained via the `show running-configuration` command when in `enable` mode. + +The following commands are used to clear and display +Virtual Network Control related information: + +.. index:: {COMMAND} {clear vnc counters} {} + +{COMMAND} {clear vnc counters} {} + Reset the counter values stored by the NVA. Counter + values can be seen using the `show vnc` commands listed above. This + command is only available in `enable` mode. + +.. index:: {Command} {show vnc summary} {} + +{Command} {show vnc summary} {} + Print counter values and other general information + about the NVA. Counter values can be reset + using the `clear vnc counters` command listed below. + +.. index:: {Command} {show vnc nves} {} + +{Command} {show vnc nves} {} +.. index:: {Command} {show vnc nves vn|un `address`} {} + +{Command} {show vnc nves vn|un `address`} {} + Display the NVA's current clients. Specifying `address` + limits the output to the NVEs whose addresses match `address`. + The time since the NVA last communicated with the NVE, per-NVE + summary counters and each NVE's addresses will be displayed. + +.. index:: {Command} {show vnc queries} {} + +{Command} {show vnc queries} {} +.. index:: {Command} {show vnc queries `prefix`} {} + +{Command} {show vnc queries `prefix`} {} + Display active Query information. Queries remain valid for the default + Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group + Response Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying + `prefix` limits the output to Query Targets that fall within + `prefix`. + + Query information is provided for each querying NVE, and includes the + Query Target and the time remaining before the information is removed. + +.. index:: {Command} {show vnc registrations [all|local|remote|holddown|imported]} {} + +{Command} {show vnc registrations [all|local|remote|holddown|imported]} {} +.. index:: {Command} {show vnc registrations [all|local|remote|holddown|imported] `prefix`} {} + +{Command} {show vnc registrations [all|local|remote|holddown|imported] `prefix`} {} + Display local, remote, holddown, and/or imported registration information. + Local registrations are routes received via RFP, which are present in the + NVA Registrations Cache. + Remote registrations are routes received via BGP (VPN SAFIs), which + are present in the NVE-group import tables. + Holddown registrations are local and remote routes that have been + withdrawn but whose holddown timeouts have not yet elapsed. + Imported information represents routes that are imported into NVA and + are made available to querying NVEs. Depending on configuration, + imported routes may also be advertised via BGP. + Specifying `prefix` limits the output to the registered prefixes that + fall within `prefix`. + + Registration information includes the registered prefix, the registering + NVE addresses, the registered administrative cost, the registration + lifetime and the time since the information was registered or, in the + case of Holddown registrations, the amount of time remaining before the + information is removed. + +.. index:: {Command} {show vnc responses [active|removed]} {} + +{Command} {show vnc responses [active|removed]} {} +.. index:: {Command} {show vnc responses [active|removed] `prefix`} {} + +{Command} {show vnc responses [active|removed] `prefix`} {} + Display all, active and/or removed response information which are + present in the NVA Responses Cache. Responses remain valid for the + default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or + NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.) + When Removal Responses are enabled (:ref:`General_VNC_Configuration`), + such responses are listed for the Response Lifetime. Specifying + `prefix` limits the output to the addresses that fall within + `prefix`. + + Response information is provided for each querying NVE, and includes + the response prefix, the prefix-associated registering NVE addresses, + the administrative cost, the provided response lifetime and the time + remaining before the information is to be removed or will become inactive. + +.. index:: {Command} {show memory vnc} {} + +{Command} {show memory vnc} {} + Print the number of memory items allocated by the NVA. + +.. _Example_VNC_and_VNC-GW_Configurations: + +Example VNC and VNC-GW Configurations +===================================== + + diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst new file mode 100644 index 0000000000..d6ed3631a2 --- /dev/null +++ b/doc/user/vtysh.rst @@ -0,0 +1,171 @@ +.. _VTY_shell: + +********* +VTY shell +********* + +*vtysh* provides a combined frontend to all Frr daemons in a +single combined session. It is enabled by default at build time, but can +be disabled through the *--disable-vtysh* option to +*./configure*. + +*vtysh* has a configuration file, :file:`vtysh.conf`. The location +of that file cannot be changed from :file:`@value{INSTALL_PREFIX_ETC`} since +it contains options controlling authentication behavior. This file will +also not be written by configuration-save commands, it is intended to be +updated manually by an administrator with an external editor. + +@quotation Warning +This also means the *hostname* and *banner motd* commands +(which both do have effect for vtysh) need to be manually updated in +:file:`vtysh.conf`. +@end quotation + +Permissions and setup requirements +================================== + +*vtysh* connects to running daemons through Unix sockets located in +:file:`@value{INSTALL_PREFIX_STATE`}. Running vtysh thus requires access to +that directory, plus membership in the *@value{INSTALL_VTY_GROUP*} +group (which is the group that the daemons will change ownership of their +sockets to). + +To restrict access to Frr configuration, make sure no unauthorized users +are members of the *@value{INSTALL_VTY_GROUP*} group. + +PAM support (experimental) +-------------------------- + +vtysh has working (but rather useless) PAM support. It will perform +an "authenticate" PAM call using *@value{PACKAGE_NAME*} as service +name. No other (accounting, session, password change) calls will be +performed by vtysh. + +Users using vtysh still need to have appropriate access to the daemons' +VTY sockets, usually by being member of the *@value{INSTALL_VTY_GROUP*} +group. If they have this membership, PAM support is useless since they can +connect to daemons and issue commands using some other tool. Alternatively, +the *vtysh* binary could be made SGID (set group ID) to the +*@value{INSTALL_VTY_GROUP*} group. @strong{No security guarantees are +made for this configuration}. + +.. index:: {Command} {username `username` nopassword} {} + +{Command} {username `username` nopassword} {} + If PAM support is enabled at build-time, this command allows disabling the + use of PAM on a per-user basis. If vtysh finds that an user is trying to + use vtysh and a "nopassword" entry is found, no calls to PAM will be made + at all. + + +.. _Integrated_configuration_mode: + +Integrated configuration mode +============================= + +Integrated configuration mode uses a single configuration file, +:file:`frr.conf`, for all daemons. This replaces the individual files like +:file:`zebra.conf` or :file:`bgpd.conf`. + +:file:`frr.conf` is located in :file:`@value{INSTALL_PREFIX_ETC`}. All +daemons check for the existence of this file at startup, and if it exists +will not load their individual configuration files. Instead, +*vtysh -b* must be invoked to process :file:`frr.conf` and apply +its settings to the individual daemons. + +@quotation Warning +*vtysh -b* must also be executed after restarting any daemon. +@end quotation + +Configuration saving, file ownership and permissions +---------------------------------------------------- + +The :file:`frr.conf` file is not written by any of the daemons; instead +*vtysh* contains the neccessary logic to collect configuration from +all of the daemons, combine it and write it out. + +@quotation Warning +Daemons must be running for *vtysh* to be able to collect their +configuration. Any configuration from non-running daemons is permanently +lost after doing a configuration save. +@end quotation + +Since the *vtysh* command may be running as ordinary user on the +system, configuration writes will be tried through *watchfrr*, +using the *write integrated* command internally. Since +*watchfrr* is running as superuser, *vtysh* is able to +ensure correct ownership and permissions on :file:`frr.conf`. + +If *watchfrr* is not running or the configuration write fails, +*vtysh* will attempt to directly write to the file. This is likely +to fail if running as unprivileged user; alternatively it may leave the +file with incorrect owner or permissions. + +Writing the configuration can be triggered directly by invoking +*vtysh -w*. This may be useful for scripting. Note this command +should be run as either the superuser or the Frr user. + +We recommend you do not mix the use of the two types of files. Further, it +is better not to use the integrated frr.conf file, as any syntax error in +it can lead to /all/ of your daemons being unable to start up. Per daemon +files are more robust as impact of errors in configuration are limited to +the daemon in whose file the error is made. + +.. index:: {Command} {service integrated-vtysh-config} {} + +{Command} {service integrated-vtysh-config} {} +.. index:: {Command} {no service integrated-vtysh-config} {} + +{Command} {no service integrated-vtysh-config} {} + Control whether integrated :file:`frr.conf` file is written when + 'write file' is issued. + + These commands need to be placed in :file:`vtysh.conf` to have any effect. + Note that since :file:`vtysh.conf` is not written by Frr itself, they + therefore need to be manually placed in that file. + + This command has 3 states: + + +`` + *service integrated-vtysh-config* + + *vtysh* will always write :file:`frr.conf`. + + +`` + *no service integrated-vtysh-config* + + *vtysh* will never write :file:`frr.conf`; instead it will ask + daemons to write their individual configuration files. + + +`` + Neither option present (default) + + *vtysh* will check whether :file:`frr.conf` exists. If it does, + configuration writes will update that file. Otherwise, writes are performed + through the individual daemons. + + This command is primarily intended for packaging/distribution purposes, to + preset one of the two operating modes and ensure consistent operation across + installations. + +.. index:: {Command} {write integrated} {} + +{Command} {write integrated} {} + Unconditionally (regardless of *service integrated-vtysh-config* + setting) write out integrated :file:`frr.conf` file through + *watchfrr*. If *watchfrr* is not running, this command + is unavailable. + + +Caveats +======= + +Configuration changes made while some daemon is not running will be invisible +to that daemon. The daemon will start up with its saved configuration +(either in its individual configuration file, or in :file:`frr.conf`). +This is particularly troublesome for route-maps and prefix lists, which would +otherwise be synchronized between daemons. + diff --git a/doc/vnc.texi b/doc/vnc.texi deleted file mode 100644 index c44519a9f3..0000000000 --- a/doc/vnc.texi +++ /dev/null @@ -1,1596 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. - -@node VNC and VNC-GW -@chapter VNC and VNC-GW -This chapter describes how to use -Virtual Network Control (@acronym{VNC}) services, -including Network Virtualization Authority (@acronym{NVA}) and -VNC Gateway (@acronym{VNC-GW}) functions. -Background information on NVAs, -Network Virtualization Edges (@acronym{NVE}s), underlay networks (@acronym{UN}s), -and virtual networks (@acronym{VN}s) is available from the -@url{https://datatracker.ietf.org/wg/nvo3,IETF Network Virtualization Overlays (@acronym{NVO3}) Working Group}. -VNC Gateways (@acronym{VNC-GW}s) support the import/export of routing -information between VNC and customer edge routers (@acronym{CE}s) -operating within a VN. Both IP/Layer 3 (L3) VNs, and IP with -Ethernet/Layer 2 (L2) VNs are supported. - -BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN -information between NVAs. BGP based IP VPN support is defined in -@cite{RFC4364, BGP/MPLS IP Virtual Private Networks (VPNs)}, and -@cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for -IPv6 VPN }. Both the Encapsulation Subsequent Address Family Identifier -(SAFI) and the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP -Encapsulation Subsequent Address Family Identifier (SAFI) and the BGP -Tunnel Encapsulation Attribute}, are supported. - -The protocol that is used to communicate routing and Ethernet / Layer 2 -(L2) forwarding information between NVAs and NVEs is referred to as the -Remote Forwarder Protocol (RFP). @code{OpenFlow} is an example -RFP. Specific RFP implementations may choose to implement either a -@code{hard-state} or @code{soft-state} prefix and address registration -model. To support a @code{soft-state} refresh model, a @var{lifetime} -in seconds is associated with all registrations and responses. - -The chapter also provides sample configurations for basic example scenarios. - -@menu -* Configuring VNC Services:: -* Manual Address Control:: -* Other VNC-Related Commands:: -* Example VNC and VNC-GW Configurations:: -* Release Notes:: -@end menu - -@node Configuring VNC Services -@section Configuring VNC - -Virtual Network Control (@acronym{VNC}) service configuration commands -appear in the @code{router bgp} section of the BGPD configuration file -(@pxref{BGP Configuration Examples}). The commands are broken down into -the following areas: - -@menu -* General VNC Configuration:: -* RFP Related Configuration:: -* VNC Defaults Configuration:: -* VNC NVE Group Configuration:: -* VNC L2 Group Configuration:: -* Configuring Redistribution of Routes from Other Routing Protocols:: -* Configuring Export of Routes to Other Routing Protocols:: -@end menu - -@code{General VNC} configuration applies to general VNC operation and is -primarily used to control the method used to advertise tunnel -information. - -@code{Remote Forwarder Protocol (RFP)} configuration relates to the -protocol used between NVAs and NVEs. - -@code{VNC Defaults} provides default parameters for registered NVEs. - -@code{VNC NVE Group} provides for configuration of a specific set of -registered NVEs and overrides default parameters. - -@code{Redistribution} and @code{Export} control VNC-GW operation, i.e., -the import/export of routing -information between VNC and customer edge routers (@acronym{CE}s) -operating within a VN. - -@node General VNC Configuration -@subsection General VNC Configuration - -@deffn {VNC} {vnc advertise-un-method encap-safi|encap-attr} {} -Advertise NVE underlay-network IP addresses using the encapsulation SAFI -(@code{encap-safi}) or the UN address sub-TLV of the Tunnel Encapsulation attribute -(@code{encap-attr}). When @code{encap-safi} is used, neighbors under -@code{address-family encap} and/or @code{address-family encapv6} must be -configured. The default is @code{encap-attr}. -@end deffn - -@node RFP Related Configuration -@subsection RFP Related Configuration - -The protocol that is used to communicate routing and Ethernet / L2 -forwarding information between NVAs and NVEs is referred to as the -Remote Forwarder Protocol (RFP). Currently, only a simple example RFP -is included in Frr. Developers may use this example as a starting -point to integrate Frr with an RFP of their choosing, e.g., -@code{OpenFlow}. The example code includes the following sample -configuration: - -@deffn {RFP} {rfp example-config-value @var{VALUE}} -This is a simple example configuration parameter included as part of the -RFP example code. @code{VALUE} must be in the range of 0 to 4294967295. -@end deffn - -@node VNC Defaults Configuration -@subsection VNC Defaults Configuration - -The VNC Defaults section allows the user to specify default values for -configuration parameters for all registered NVEs. -Default values are overridden by @ref{VNC NVE Group Configuration}. - -@deffn {VNC} {vnc defaults} {} -Enter VNC configuration mode for specifying VNC default behaviors. Use -@code{exit-vnc} to leave VNC configuration mode. @code{vnc -defaults} is optional. - -@example -vnc defaults - ... various VNC defaults -exit-vnc -@end example -@end deffn - -These are the statements that can appear between @code{vnc defaults} -and @code{exit-vnc}. - -@deffn {VNC} {rt import @var{rt-list}} {} -@deffnx {VNC} {rt export @var{rt-list}} {} -@deffnx {VNC} {rt both @var{rt-list}} {} - -Specify default route target import and export lists. @var{rt-list} is a -space-separated list of route targets, each element of which is -in one of the following forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@end itemize - -If no default import RT list is specified, then the default import RT -list is empty. -If no default export RT list is specified, then the default export RT -list is empty. - -A complete definition of these parameters is -given below (@pxref{VNC NVE Group Configuration}). - -@end deffn - -@deffn {VNC} {rd @var{route-distinguisher}} - -Specify the default route distinguisher (RD) for routes advertised via BGP -VPNs. The route distinguisher must be in one of four forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@item auto:vn:@var{two-byte-integer} -@end itemize - -If RD is specified in the defaults section, the default RD -value is @var{two-byte-autonomous-system-number=0}:@var{four-byte-integer=0}. - -A complete definition of this parameter is -given below (@pxref{VNC NVE Group Configuration}). -@end deffn - -@deffn {VNC} {l2rd @var{nve-id-value}} -Set the value used to distinguish NVEs connected to the same logical -Ethernet segment (i.e., L2VPN). - -A complete definition of this parameter is -given below (@pxref{VNC NVE Group Configuration}). -@end deffn - -@deffn {VNC} {response-lifetime @var{lifetime}|infinite} {} -Specify the default lifetime to be included in RFP -response messages sent to NVEs. - -A complete definition of this parameter is -given below (@pxref{VNC NVE Group Configuration}). - -@end deffn - -@deffn {VNC} {export bgp|zebra route-map MAP-NAME} -Specify that the named route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra no route-map} -Specify that no route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} -Specify that the named prefix-list filter should be applied to -routes being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -@end deffn - -@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} -Specify that no prefix-list filter should be applied to -routes being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {exit-vnc} {} -Exit VNC configuration mode. -@end deffn - -@c The following example @code{vnc defaults} defines a route target import-export -@c list for the route targets 1000:1 and 1000:2; a default route -@c distinguisher, 4444:10; and a default response lifetime of 500 -@c seconds. -@c -@c @example -@c vnc defaults -@c rt both 1000:1 1000:2 -@c rd 4444:10 -@c response-lifetime 500 -@c exit-vnc -@c @end example - -@node VNC NVE Group Configuration -@subsection VNC NVE Group Configuration - -A NVE Group corresponds to a specific set of NVEs. A Client NVE is -assigned to an NVE Group based on whether there is a match for either -its virtual or underlay network address against the VN and/or UN address -prefixes specified in the NVE Group definition. When an NVE Group -definition specifies both VN and UN address prefixes, then an NVE must -match both prefixes in order to be assigned to the NVE Group. In the -event that multiple NVE Groups match based on VN and/or UN addresses, -the NVE is assigned to the first NVE Group listed in the configuration. -If an NVE is not assigned to an NVE Group, its messages will be ignored. - -Configuration values specified for an NVE group apply to all -member NVEs and override configuration values specified in the VNC -Defaults section. - -@strong{At least one @code{nve-group} is mandatory for useful VNC -operation.} - -@deffn {VNC} {vnc nve-group @var{name}} {} -Enter VNC configuration mode for defining the NVE group @var{name}. -Use @code{exit} or @code{exit-vnc} to exit group configuration mode. - -@example -vnc nve-group group1 - ... configuration commands -exit-vnc -@end example -@end deffn - -@deffn {VNC} {no vnc nve-group @var{name}} {} -Delete the NVE group named @var{name}. -@end deffn - -The following statements are valid in an NVE group definition: - -@deffn {VNC} {l2rd @var{nve-id-value}} -Set the value used to distinguish NVEs connected to the same physical -Ethernet segment (i.e., at the same location)@footnote{The nve-id is -carried in the route -distinguisher. It is the second octet of the eight-octet route -distinguisher generated for Ethernet / L2 advertisements. -The first octet is a constant 0xFF, and the third through eighth -octets are set to the L2 ethernet address being advertised.} - -The nve-id subfield may be specified as either a literal value -in the range 1-255, or it may be specified as @code{auto:vn}, which -means to use the least-significant octet of the originating -NVE's VN address. -@end deffn - -@deffn {VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {} -@anchor{prefix} -Specify the matching prefix for this NVE group by either virtual-network address -(@code{vn}) or underlay-network address (@code{un}). Either or both virtual-network -and underlay-network prefixes may be specified. Subsequent virtual-network or -underlay-network values within a @code{vnc nve-group} @code{exit-vnc} -block override their respective previous values. - -These prefixes are used only for determining assignments of NVEs -to NVE Groups. -@end deffn - -@deffn {VNC} {rd @var{route-distinguisher}} -Specify the route distinguisher for routes advertised via BGP -VPNs. The route distinguisher must be in one of these forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@item auto:vn:@var{two-byte-integer} -@end itemize - -Routes originated by NVEs in the NVE group will use -the group's specified @var{route-distinguisher} when they are -advertised via BGP. -If the @code{auto} form is specified, it means that a matching NVE has -its RD set to -@var{rd_type=IP=1}:@var{IPv4-address=VN-address}:@var{two-byte-integer}, -for IPv4 VN addresses and -@var{rd_type=IP=1}:@var{IPv4-address=Last-four-bytes-of-VN-address}:@var{two-byte-integer}, -for IPv6 VN addresses. - -If the NVE group definition does not specify a @var{route-distinguisher}, -then the default @var{route-distinguisher} is used. -If neither a group nor a default @var{route-distinguisher} is -configured, then the advertised RD is set to -@var{two-byte-autonomous-system-number=0}:@var{four-byte-integer=0}. -@end deffn - -@deffn {VNC} {response-lifetime @var{lifetime}|infinite} {} -Specify the response lifetime, in seconds, to be included in RFP -response messages sent to NVEs. If the value -``infinite'' is given, an infinite lifetime will be used. - -Note that this parameter is not the same as the lifetime supplied by -NVEs in RFP registration messages. This parameter does not affect -the lifetime value attached to routes sent by this server via BGP. - -If the NVE group definition does not specify a @var{response-lifetime}, -the default @var{response-lifetime} will be used. -If neither a group nor a default @var{response-lifetime} is configured, -the value 3600 will be used. The maximum response lifetime is 2147483647. -@end deffn - -@deffn {VNC} {rt export @var{rt-list}} {} -@deffnx {VNC} {rt import @var{rt-list}} {} -@deffnx {VNC} {rt both @var{rt-list}} {} -Specify route target import and export lists. @var{rt-list} is a -space-separated list of route targets, each element of which is -in one of the following forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@end itemize - -The first form, @code{rt export}, specifies an @var{export rt-list}. -The @var{export rt-list} will be attached to routes originated by -NVEs in the NVE group when they are advertised via BGP. -If the NVE group definition does not specify an @var{export rt-list}, -then the default @var{export rt-list} is used. -If neither a group nor a default @var{export rt-list} is configured, -then no RT list will be sent; in turn, these routes will probably -not be processed -by receiving NVAs. - -The second form, @code{rt import} specifies an @var{import rt-list}, -which is a filter for incoming routes. -In order to be made available to NVEs in the group, -incoming BGP VPN and @w{ENCAP} @w{SAFI} (when @code{vnc -advertise-un-method encap-safi} is set) routes must have -RT lists that have at least one route target in common with the -group's @var{import rt-list}. - -If the NVE group definition does not specify an import filter, -then the default @var{import rt-list} is used. -If neither a group nor a default @var{import rt-list} is configured, -there can be no RT intersections when receiving BGP routes and -therefore no incoming BGP routes will be processed for the group. - -The third, @code{rt both}, is a shorthand way of specifying both -lists simultaneously, and is equivalent to @code{rt export @var{rt-list}} -followed by @code{rt import @var{rt-list}}. -@end deffn - -@deffn {VNC} {export bgp|zebra route-map MAP-NAME} -Specify that the named route-map should be applied to routes -being exported to bgp or zebra. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@deffn {VNC} {export bgp|zebra no route-map} -Specify that no route-map should be applied to routes -being exported to bgp or zebra. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} -Specify that the named prefix-list filter should be applied to -routes being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} -Specify that no prefix-list filter should be applied to -routes being exported to bgp or zebra. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@c The following example shows two @code{vnc nve-group} definitions. The first one, -@c ``group1'', applies to the IPV4 virtual-network route prefix 172.16/16. It -@c sets the response lifetime to 200 seconds. It defines a route target -@c import-export filter for the route targets 1000:1 and 1000:2 -@c -@c The second @code{vnc nve-group} definition, ``group2'', applies to the IPV6 -@c underlay-network route prefix 10.0.2/24. It defines the same response -@c lifetime and import-export filter as ``group1''. -@c -@c @example -@c vnc nve-group group1 -@c prefix vn 172.16/16 -@c response-lifetime 200 -@c rt both 1000:1 1000:2 -@c exit-vnc -@c -@c vnc nve-group group2 -@c prefix un 10.0.2/24 -@c response-lifetime 200 -@c rt both 1000:1 1000:2 -@c exit-vnc -@c @end example - -@node VNC L2 Group Configuration -@subsection VNC L2 Group Configuration - -The route targets advertised with prefixes and addresses registered by -an NVE are determined based on the NVE's associated VNC NVE Group -Configuration, @pxref{VNC NVE Group Configuration}. Layer 2 (L2) Groups -are used to override the route targets for an NVE's Ethernet -registrations based on the Logical Network Identifier and label value. -A Logical Network Identifier is used to uniquely identify a logical -Ethernet segment and is conceptually similar to the Ethernet Segment -Identifier defined in @cite{RFC7432, BGP MPLS-Based Ethernet VPN}. Both -the Logical Network Identifier and Label are passed to VNC via RFP -prefix and address registration. - -Note that a corresponding NVE group configuration must be present, and -that other NVE associated configuration information, notably RD, is -not impacted by L2 Group Configuration. - -@deffn {VNC} {vnc l2-group @var{name}} {} -Enter VNC configuration mode for defining the L2 group @var{name}. -Use @code{exit} or @code{exit-vnc} to exit group configuration mode. - -@example -vnc l2-group group1 - ... configuration commands -exit-vnc -@end example -@end deffn - -@deffn {VNC} {no vnc l2-group @var{name}} {} -Delete the L2 group named @var{name}. -@end deffn - -The following statements are valid in a L2 group definition: - -@deffn {VNC} {logical-network-id @var{VALUE}} -Define the Logical Network Identifier with a value in the range of -0-4294967295 that identifies the logical Ethernet segment. -@end deffn - -@deffn {VNC} {labels @var{label-list}} -@deffnx {VNC} {no labels @var{label-list}} -Add or remove labels associated with the group. @var{label-list} is a -space separated list of label values in the range of 0-1048575. -@end deffn - -@deffn {VNC} {rt import @var{rt-target}} {} -@deffnx {VNC} {rt export @var{rt-target}} {} -@deffnx {VNC} {rt both @var{rt-target}} {} -Specify the route target import and export value associated with the -group. A complete definition of these parameters is given above, -@pxref{VNC NVE Group Configuration}. -@end deffn - - -@node Configuring Redistribution of Routes from Other Routing Protocols -@subsection Configuring Redistribution of Routes from Other Routing Protocols - -Routes from other protocols (including BGP) can be provided to VNC (both -for RFP and for redistribution via BGP) -from three sources: the zebra kernel routing process; -directly from the main (default) unicast BGP RIB; or directly -from a designated BGP unicast exterior routing RIB instance. - -The protocol named in the @code{vnc redistribute} command indicates -the route source: -@code{bgp-direct} routes come directly from the main (default) -unicast BGP RIB and are available for RFP and are redistributed via BGP; -@code{bgp-direct-to-nve-groups} routes come directly from a designated -BGP unicast routing RIB and are made available only to RFP; -and routes from other protocols come from the zebra kernel -routing process. -Note that the zebra process does not need to be active if -only @code{bgp-direct} or @code{bgp-direct-to-nve-groups} routes are used. - -@subsubsection @code{zebra} routes - -Routes originating from protocols other than BGP must be obtained -via the zebra routing process. -Redistribution of these routes into VNC does not support policy mechanisms -such as prefix-lists or route-maps. - -@subsubsection @code{bgp-direct} routes - -@code{bgp-direct} redistribution supports policy via -prefix lists and route-maps. This policy is applied to incoming -original unicast routes before the redistribution translations -(described below) are performed. - -Redistribution of @code{bgp-direct} routes is performed in one of three -possible modes: @code{plain}, @code{nve-group}, or @code{resolve-nve}. -The default mode is @code{plain}. -These modes indicate the kind of translations applied to routes before -they are added to the VNC RIB. - -In @code{plain} mode, the route's next hop is unchanged and the RD is set -based on the next hop. -For @code{bgp-direct} redistribution, the following translations are performed: -@itemize @bullet -@item -The VN address is set to the original unicast route's next hop address. -@item -The UN address is NOT set. (VN->UN mapping will occur via -ENCAP route or attribute, based on @code{vnc advertise-un-method} -setting, generated by the RFP registration of the actual NVE) -@item -The RD is set to as if auto:vn:0 were specified (i.e., -@var{rd_type=IP=1}:@var{IPv4-address=VN-address}:@var{two-byte-integer=0}) -@item -The RT list is included in the extended community list copied from the -original unicast route (i.e., it must be set in the original unicast route). -@end itemize - - - -In @code{nve-group} mode, routes are registered with VNC as -if they came from an NVE in the nve-group designated in the -@code{vnc redistribute nve-group} command. The following -translations are performed: - -@itemize @bullet -@item -The next hop/VN address is set to the VN prefix configured for the -redistribute nve-group. -@item -The UN address is set to the UN prefix configured for the -redistribute nve-group. -@item -The RD is set to the RD configured for the redistribute nve-group. -@item -The RT list is set to the RT list configured for the redistribute nve-group. -If @code{bgp-direct} routes are being redistributed, -any extended communities present in the original unicast route -will also be included. -@end itemize - - -In @code{resolve-nve} mode, the next hop of the original BGP route is -typically the address of an NVE connected router (CE) connected by one or -more NVEs. -Each of the connected NVEs will register, via RFP, a VNC host route -to the CE. -This mode may be though of as a mechanism to proxy RFP registrations -of BGP unicast routes on behalf of registering NVEs. - -Multiple copies of the BGP route, one per matching NVE host route, will be -added to VNC. -In other words, for a given BGP unicast route, each instance of a -RFP-registered host route to the unicast route's next hop will result -in an instance of an imported VNC route. -Each such imported VNC route will have a prefix equal to the original -BGP unicast route's prefix, and a next hop equal to the next hop of the -matching RFP-registered host route. -If there is no RFP-registered host route to the next hop of the BGP unicast -route, no corresponding VNC route will be imported. - -The following translations are applied: - -@itemize @bullet -@item -The Next Hop is set to the next hop of the NVE route (i.e., the -VN address of the NVE). - -@item -The extended community list in the new route is set to the -union of: -@itemize @minus -@item -Any extended communities in the original BGP route -@item -Any extended communities in the NVE route -@item -An added route-origin extended community with the next hop of the -original BGP route -is added to the new route. -The value of the local administrator field defaults 5226 but may -be configured by the user via the @code{roo-ec-local-admin} parameter. -@end itemize - -@item -The Tunnel Encapsulation attribute is set to the value of the Tunnel -Encapsulation attribute of the NVE route, if any. - -@end itemize - -@subsubsection @code{bgp-direct-to-nve-groups} routes - -Unicast routes from the main or a designated instance of BGP -may be redistributed to VNC as bgp-direct-to-nve-groups routes. These -routes are NOT announced via BGP, -but they are made available for local RFP lookup in response to -queries from NVEs. - -A non-main/default BGP instance is configured using the -@code{bgp multiple-instance} and @code{router bgp AS view NAME} -commands as described elsewhere in this document. - -In order for a route in the unicast BGP RIB to be made -available to a querying NVE, there must already be, available to -that NVE, an (interior) VNC route matching the next hop address -of the unicast route. -When the unicast route is provided to the NVE, its next hop -is replaced by the next hop of the corresponding -NVE. If there are multiple longest-prefix-match VNC routes, -the unicast route will be replicated for each. - -There is currently no policy (prefix-list or route-map) support -for @code{bgp-direct-to-nve-groups} routes. - -@subsubsection Redistribution Command Syntax - -@deffn {VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} -@deffnx {VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view @var{VIEWNAME}} {} -@deffnx {VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} -Import (or do not import) prefixes from another routing -protocols. Specify both the address family to import (@code{ipv4} or -@code{ipv6}) and the protocol (@code{bgp}, @code{bgp-direct}, -@code{bgp-direct-to-nve-groups}, @code{connected}, -@code{kernel}, @code{ospf}, @code{rip}, or @code{static}). Repeat -this statement as needed for each combination of address family and -routing protocol. -Prefixes from protocol @code{bgp-direct} are imported from unicast BGP -in the same bgpd process. -Prefixes from all other protocols (including @code{bgp}) are imported -via the @code{zebra} kernel routing process. -@end deffn - -@deffn {VNC} {vnc redistribute mode plain|nve-group|resolve-nve} -Redistribute routes from other protocols into VNC using the -specified mode. -Not all combinations of modes and protocols are supported. -@end deffn - -@deffn {VNC} {vnc redistribute nve-group @var{group-name}} {} -@deffnx {VNC} {no vnc redistribute nve-group @var{group-name}} {} -When using @code{nve-group} mode, -assign (or do not assign) the NVE group @var{group-name} to routes -redistributed from another routing protocol. @var{group-name} -must be configured using @code{vnc nve-group}. - -The VN and UN prefixes of the nve-group must both be configured, -and each prefix must be specified as a full-length (/32 for IPv4, -/128 for IPv6) prefix. -@end deffn - -@deffn {VNC} {vnc redistribute lifetime @var{lifetime}|infinite} {} -Assign a registration lifetime, either @var{lifetime} seconds or -@code{infinite}, to prefixes redistributed from other routing -protocols as if they had been received via RFP registration messages -from an NVE. @var{lifetime} can be any integer between 1 and -4294967295, inclusive. -@end deffn - -@deffn {VNC} {vnc redistribute resolve-nve roo-ec-local-admin @var{0-65536}} -Assign a value to the local-administrator subfield used in the -Route Origin extended community that is assigned to routes exported -under the @code{resolve-nve} mode. The default value is @var{5226}. -@end deffn - -The following four @code{prefix-list} and @code{route-map} commands -may be specified in the context of an nve-group or not. -If they are specified in the context of an nve-group, they -apply only if the redistribution mode is @code{nve-group}, -and then only for routes being redistributed from -@code{bgp-direct}. -If they are specified outside the context of an nve-group, then -they apply only for redistribution modes @code{plain} and @code{resolve-nve}, -and then only for routes being redistributed from @code{bgp-direct}. - -@deffn {VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list @var{LIST-NAME}} -When redistributing @code{bgp-direct} routes, -specifies that the named prefix-list should be applied. -@end deffn - -@deffn {VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list} -When redistributing @code{bgp-direct} routes, -specifies that no prefix-list should be applied. -@end deffn - -@deffn {VNC} {vnc redistribute bgp-direct route-map @var{MAP-NAME}} -When redistributing @code{bgp-direct} routes, -specifies that the named route-map should be applied. -@end deffn - -@deffn {VNC} {vnc redistribute bgp-direct no route-map} -When redistributing @code{bgp-direct} routes, -specifies that no route-map should be applied. -@end deffn - -@node Configuring Export of Routes to Other Routing Protocols -@subsection Configuring Export of Routes to Other Routing Protocols - -Routes from VNC (both for RFP and for redistribution via BGP) can be -provided to other protocols, either via zebra or directly to BGP. - -It is important to note that when exporting routes to other protocols, -the downstream protocol must also be configured to import the routes. -For example, when VNC routes are exported to unicast BGP, the BGP -configuration must include a corresponding @code{redistribute vnc-direct} -statement. - -@deffn {VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce} -Specify how routes should be exported to bgp or zebra. -If the mode is @code{none}, routes are not exported. -If the mode is @code{group-nve}, routes are exported according -to nve-group or vrf-policy group configuration (@pxref{VNC NVE Group Configuration}): if a group is configured to -allow export, then each prefix visible to the group is exported -with next hops set to the currently-registered NVEs. -If the mode is @code{registering-nve}, then all VNC routes are -exported with their original next hops. -If the mode is @code{ce}, only VNC routes that have an NVE connected CE Router -encoded in a Route Origin Extended Community are exported. -This extended community must have an administrative value that -matches the configured @code{roo-ec-local-admin} value. -The next hop of the exported route is set to the encoded -NVE connected CE Router. - -The default for both bgp and zebra is mode @code{none}. -@end deffn - -@deffn {VNC} {vnc export bgp|zebra group-nve group @var{group-name}} -@deffnx {VNC} {vnc export bgp|zebra group-nve no group @var{group-name}} -When export mode is @code{group-nve}, -export (or do not export) prefixes from the specified nve-group or -vrf-policy group -to unicast BGP or to zebra. -Repeat this statement as needed for each nve-group to be exported. -Each VNC prefix that is exported will result in N exported routes to the -prefix, each with a next hop corresponding to one of the N NVEs currently -associated with the nve-group. -@end deffn - -@deffn {VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME -When export mode is @code{ce} or @code{registering-nve}, -specifies that the named prefix-list should be applied to routes -being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -@end deffn - -@deffn {VNC} export bgp|zebra no ipv4|ipv6 prefix-list -When export mode is @code{ce} or @code{registering-nve}, -specifies that no prefix-list should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} export bgp|zebra route-map MAP-NAME -When export mode is @code{ce} or @code{registering-nve}, -specifies that the named route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} export bgp|zebra no route-map -When export mode is @code{ce} or @code{registering-nve}, -specifies that no route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -When the export mode is @code{group-nve}, policy for exported -routes is specified per-NVE-group or vrf-policy group inside a @code{nve-group} @var{RFG-NAME} block -via the following commands(@pxref{VNC NVE Group Configuration}): - -@deffn {VNC} {export bgp|zebra route-map MAP-NAME} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that the named route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra no route-map} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that no route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that the named prefix-list filter should be applied to -routes being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -@end deffn - -@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that no prefix-list filter should be applied to -routes being exported to bgp or zebra. -@end deffn - -@node Manual Address Control -@section Manual Address Control - -The commands in this section can be used to augment normal dynamic VNC. -The @code{add vnc} commands can be used to manually add IP prefix or -Ethernet MAC address forwarding information. The @code{clear vnc} -commands can be used to remove manually and dynamically added -information. - -@deffn {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost <0-255>] [lifetime (infinite|<1-4294967295>)] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost <0-255>]]} {} -Register an IP prefix on behalf of the NVE identified by the VN and UN -addresses. The @code{cost} parameter provides the administrative -preference of the forwarding information for remote advertisement. If -omitted, it defaults to 255 (lowest preference). The @code{lifetime} -parameter identifies the period, in seconds, that the information -remains valid. If omitted, it defaults to @var{infinite}. The optional -@code{local-next-hop} parameter is used to configure a nexthop to be -used by an NVE to reach the prefix via a locally connected CE router. -This information remains local to the NVA, i.e., not passed to other -NVAs, and is only passed to registered NVEs. When specified, it is also -possible to provide a @code{local-cost} parameter to provide a -forwarding preference. If omitted, it defaults to 255 (lowest -preference). -@end deffn - - -@deffn {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier <1-4294967295> vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost <0-255>] [lifetime (infinite|<1-4294967295>)]} {} -Register a MAC address for a logical Ethernet (L2VPN) on behalf of the -NVE identified by the VN and UN addresses. -The optional @code{prefix} parameter is to support enable IP address -mediation for the given prefix. The @code{cost} parameter provides the administrative -preference of the forwarding information. If omitted, it defaults to -255. The @code{lifetime} parameter identifies the period, in seconds, -that the information remains valid. If omitted, it defaults to -@var{infinite}. -@end deffn - -@deffn {Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} -Delete the information identified by prefix, VN address, and UN address. -Any or all of these parameters may be wilcarded to (potentially) match -more than one registration. -The optional @code{mac} parameter specifies a layer-2 MAC address -that must match the registration(s) to be deleted. -The optional @code{local-next-hop} parameter is used to -delete specific local nexthop information. -@end deffn - -@deffn {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|<1-4294967295>) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} -Delete mac forwarding information. -Any or all of these parameters may be wilcarded to (potentially) match -more than one registration. -The default value for the @code{prefix} parameter is the wildcard value @var{*}. -@end deffn - -@deffn {Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {} -Delete prefixes associated with the NVE specified by the given VN and UN -addresses. -It is permissible to specify only one of VN or UN, in which case -any matching registration will be deleted. -It is also permissible to specify @code{*} in lieu of any VN or UN -address, in which case all registrations will match. -@end deffn - -@node Other VNC-Related Commands -@section Other VNC-Related Commands - -Note: VNC-Related configuration can be obtained via the @code{show -running-configuration} command when in @code{enable} mode. - -The following commands are used to clear and display -Virtual Network Control related information: - -@deffn {COMMAND} {clear vnc counters} {} -Reset the counter values stored by the NVA. Counter -values can be seen using the @code{show vnc} commands listed above. This -command is only available in @code{enable} mode. -@end deffn - -@deffn {Command} {show vnc summary} {} -Print counter values and other general information -about the NVA. Counter values can be reset -using the @code{clear vnc counters} command listed below. -@end deffn - -@deffn {Command} {show vnc nves} {} -@deffnx {Command} {show vnc nves vn|un @var{address}} {} -Display the NVA's current clients. Specifying @var{address} -limits the output to the NVEs whose addresses match @var{address}. -The time since the NVA last communicated with the NVE, per-NVE -summary counters and each NVE's addresses will be displayed. -@end deffn - -@deffn {Command} {show vnc queries} {} -@deffnx {Command} {show vnc queries @var{prefix}} {} -Display active Query information. Queries remain valid for the default -Response Lifetime (@pxref{VNC Defaults Configuration}) or NVE-group -Response Lifetime (@pxref{VNC NVE Group Configuration}). Specifying -@var{prefix} limits the output to Query Targets that fall within -@var{prefix}. - -Query information is provided for each querying NVE, and includes the -Query Target and the time remaining before the information is removed. -@end deffn - -@deffn {Command} {show vnc registrations [all|local|remote|holddown|imported]} {} -@deffnx {Command} {show vnc registrations [all|local|remote|holddown|imported] @var{prefix}} {} -Display local, remote, holddown, and/or imported registration information. -Local registrations are routes received via RFP, which are present in the -NVA Registrations Cache. -Remote registrations are routes received via BGP (VPN SAFIs), which -are present in the NVE-group import tables. -Holddown registrations are local and remote routes that have been -withdrawn but whose holddown timeouts have not yet elapsed. -Imported information represents routes that are imported into NVA and -are made available to querying NVEs. Depending on configuration, -imported routes may also be advertised via BGP. -Specifying @var{prefix} limits the output to the registered prefixes that -fall within @var{prefix}. - -Registration information includes the registered prefix, the registering -NVE addresses, the registered administrative cost, the registration -lifetime and the time since the information was registered or, in the -case of Holddown registrations, the amount of time remaining before the -information is removed. -@end deffn - -@deffn {Command} {show vnc responses [active|removed]} {} -@deffnx {Command} {show vnc responses [active|removed] @var{prefix}} {} -Display all, active and/or removed response information which are -present in the NVA Responses Cache. Responses remain valid for the -default Response Lifetime (@pxref{VNC Defaults Configuration}) or -NVE-group Response Lifetime (@pxref{VNC NVE Group Configuration}.) -When Removal Responses are enabled (@pxref{General VNC Configuration}), -such responses are listed for the Response Lifetime. Specifying -@var{prefix} limits the output to the addresses that fall within -@var{prefix}. - -Response information is provided for each querying NVE, and includes -the response prefix, the prefix-associated registering NVE addresses, -the administrative cost, the provided response lifetime and the time -remaining before the information is to be removed or will become inactive. -@end deffn - -@deffn {Command} {show memory vnc} {} -Print the number of memory items allocated by the NVA. -@end deffn - -@node Example VNC and VNC-GW Configurations -@section Example VNC and VNC-GW Configurations - -@menu -* Mesh NVA Configuration:: -* Mesh NVA and VNC-GW Configuration:: -* VNC with Frr Route Reflector Configuration:: -* VNC with Commercial Route Reflector Configuration:: -* VNC with Redundant Route Reflectors Configuration:: -@c * Interfacing VNC to an IGP:: -@end menu - -@node Mesh NVA Configuration -@subsection Mesh NVA Configuration - -This example includes three NVAs, nine NVEs, and two NVE groups. Note -that while not shown, a single physical device may support multiple -logical NVEs. @ref{fig:fig-vnc-mesh} shows @code{NVA 1} -(192.168.1.100), @code{NVA 2} (192.168.1.101), and @code{NVA 3} -(192.168.1.102), which are connected in a full mesh. Each is a -member of the autonomous system 64512. Each NVA provides VNC -services to three NVE clients in the 172.16.0.0/16 virtual-network -address range. The 172.16.0.0/16 address range is partitioned into -two NVE groups, @code{group1} (172.16.0.0/17) and @code{group2} -(172.16.128.0/17). - -Each NVE belongs to either NVE group @code{group1} or NVE group -@code{group2}. The NVEs @code{NVE 1}, @code{NVE 2}, @code{NVE -4}, @code{NVE 7}, and @code{NVE 8} are members of the NVE group -@code{group1}. The NVEs @code{NVE 3}, @code{NVE 5}, @code{NVE -6}, and @code{NVE 9} are members of the NVE group @code{group2}. - -Each NVA advertises NVE underlay-network IP addresses using the -Tunnel Encapsulation Attribute. - -@float Figure,fig:fig-vnc-mesh -@center @image{fig-vnc-mesh,400pt,,Three-way Mesh} -@caption{A three-way full mesh with three NVEs per NVA} -@end float - -@file{bgpd.conf} for @code{NVA 1} (192.168.1.100) -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.100 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rt both 1000:1 - exit-vnc - - vnc nve-group group2 - prefix vn 172.16.128.0/17 - rt both 1000:2 - exit-vnc - -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} (192.168.1.101): -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - neighbor 192.168.1.102 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 3} (192.168.1.102): -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - neighbor 192.168.1.101 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -@node Mesh NVA and VNC-GW Configuration -@subsection Mesh NVA and VNC-GW Configuration - -This example includes two NVAs, each with two associated NVEs, and two -VNC-GWs, each supporting two CE routers physically attached to the four -NVEs. Note that this example is showing a more complex configuration -where VNC-GW is separated from normal NVA functions; it is equally -possible to simplify the configuration and combine NVA and VNC-GW -functions in a single frr instance. - -@float Figure,fig:fig-vnc-gw -@center @image{fig-vnc-gw,400pt,,Frr VNC Gateway} -@caption{Meshed NVEs and VNC-GWs} -@end float - -As shown in @ref{fig:fig-vnc-gw}, NVAs and VNC-GWs are connected in a -full iBGP mesh. The VNC-GWs each have two CEs configured as -route-reflector clients. Each client provides BGP updates with unicast -routes that the VNC-GW reflects to the other client. The VNC-GW also -imports these unicast routes into VPN routes to be shared with the other -VNC-GW and the two NVAs. This route importation is controlled with the -@code{vnc redistribute} statements shown in the configuration. -Similarly, registrations sent by NVEs via RFP to the NVAs are exported -by the VNC-GWs to the route-reflector clients as unicast routes. RFP -registrations exported this way have a next-hop address of the CE behind -the connected (registering) NVE. Exporting VNC routes as IPv4 unicast -is enabled with the @code{vnc export} command below. - -The configuration for @code{VNC-GW 1} is shown below. -@verbatim -router bgp 64512 - bgp router-id 192.168.1.101 - bgp cluster-id 1.2.3.4 - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.103 remote-as 64512 - neighbor 192.168.1.104 remote-as 64512 - neighbor 172.16.1.2 remote-as 64512 - neighbor 172.16.2.2 remote-as 64512 - ! - address-family ipv4 unicast - redistribute vnc-direct - no neighbor 192.168.1.102 activate - no neighbor 192.168.1.103 activate - no neighbor 192.168.1.104 activate - neighbor 172.16.1.2 route-reflector-client - neighbor 172.16.2.2 route-reflector-client - exit-address-family - ! - address-family vpnv4 unicast - neighbor 192.168.1.102 activate - neighbor 192.168.1.103 activate - neighbor 192.168.1.104 activate - exit-address-family - vnc export bgp mode ce - vnc redistribute mode resolve-nve - vnc redistribute ipv4 bgp-direct - exit -@end verbatim - -Note that in the VNC-GW configuration, the neighboring VNC-GW and -NVAs each have a statement disabling the IPv4 unicast address family. -IPv4 unicast is on by default and this prevents the other VNC-GW and -NVAs from learning unicast routes advertised by the route-reflector clients. - -Configuration for @code{NVA 2}: -@verbatim -router bgp 64512 - bgp router-id 192.168.1.104 - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.103 remote-as 64512 - ! - address-family ipv4 unicast - no neighbor 192.168.1.101 activate - no neighbor 192.168.1.102 activate - no neighbor 192.168.1.103 activate - exit-address-family - ! - address-family vpnv4 unicast - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - neighbor 192.168.1.103 activate - exit-address-family - ! - vnc defaults - response-lifetime 3600 - exit-vnc - vnc nve-group nve1 - prefix vn 172.16.1.1/32 - response-lifetime 3600 - rt both 1000:1 1000:2 - exit-vnc - vnc nve-group nve2 - prefix vn 172.16.2.1/32 - response-lifetime 3600 - rt both 1000:1 1000:2 - exit-vnc - exit -@end verbatim - -@c TBD make this its own example: -@c -@c @float Figure,fig:fig-vnc-gw-rr -@c @center @image{fig-vnc-gw-rr,400pt,,Frr VNC Gateway with RR} -@c @end float -@c An NVA can also import unicast routes from BGP without advertising the -@c imported routes as VPN routes. Such imported routes, while not -@c distributed to other NVAs or VNC-GWs, are are available to NVEs via -@c RFP query messages sent to the NVA. @ref{fig:fig-vnc-gw-rr} -@c shows an example topology where unicast routes are imported into NVAs -@c from a Route Reflector. (@pxref{Route Reflector} for route reflector -@c configuration details.) The following three lines can be added to the -@c @code{NVA 1} and @code{NVA 2} configurations to import routes into VNC -@c for local VNC use: -@c -@c @verbatim -@c neighbor 192.168.1.105 remote-as 64512 -@c vnc redistribute mode plain -@c vnc redistribute ipv4 bgp-direct-to-nve-groups -@c @end verbatim - -@node VNC with Frr Route Reflector Configuration -@subsection VNC with Frr Route Reflector Configuration -A route reflector eliminates the need for a fully meshed NVA -network by acting as the hub between NVAs. -@ref{fig:fig-vnc-frr-route-reflector} shows BGP route reflector -@code{BGP Route Reflector 1} (192.168.1.100) as a route reflector for -NVAs @code{NVA 2}(192.168.1.101) and @code{NVA 3} -(192.168.1.102). - -@float Figure,fig:fig-vnc-frr-route-reflector -@center @image{fig-vnc-frr-route-reflector,400pt,,Frr Route Reflector} -@caption{Two NVAs and a BGP Route Reflector} -@end float - -@code{NVA 2} and @code{NVA 3} -advertise NVE underlay-network IP addresses using the Tunnel Encapsulation Attribute. -@code{BGP Route Reflector 1} ``reflects'' advertisements from -@code{NVA 2} to @code{NVA 3} and vice versa. - -As in the example of @ref{Mesh NVA Configuration}, there are two NVE groups. -The 172.16.0.0/16 address range is partitioned into two NVE groups, -@code{group1} (172.16.0.0/17) and @code{group2} (172.16.128.0/17). -The NVE @code{NVE 4}, @code{NVE 7}, and @code{NVE 8} are -members of the NVE group @code{group1}. The NVEs @code{NVE 5}, -@code{NVE 6}, and @code{NVE 9} are members of the NVE group -@code{group2}. - -@file{bgpd.conf} for @code{BGP Route Reflector 1} on 192.168.1.100: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.100 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.101 port 7179 - neighbor 192.168.1.101 description iBGP-client-192-168-1-101 - - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.102 port 7179 - neighbor 192.168.1.102 description iBGP-client-192-168-1-102 - - address-family ipv4 unicast - neighbor 192.168.1.101 route-reflector-client - neighbor 192.168.1.102 route-reflector-client - exit-address-family - - address-family vpnv4 - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - - neighbor 192.168.1.101 route-reflector-client - neighbor 192.168.1.102 route-reflector-client - exit-address-family - -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.102: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.100 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -While not shown, an NVA can also be configured as a route reflector. - -@node VNC with Commercial Route Reflector Configuration -@subsection VNC with Commercial Route Reflector Configuration -This example is identical to @ref{VNC with Frr Route Reflector -Configuration} with the exception that the route reflector is a -commercial router. Only the -VNC-relevant configuration is provided. - -@float Figure,fig:fig-vnc-commercial-route-reflector -@center @image{fig-vnc-commercial-route-reflector,400pt,,Commercial Route Reflector} -@caption{Two NVAs with a commercial route reflector} -@end float - -@file{bgpd.conf} for BGP route reflector @code{Commercial Router} on 192.168.1.104: -@verbatim -version 8.5R1.13; -routing-options { - rib inet.0 { - static { - route 172.16.0.0/16 next-hop 192.168.1.104; - } - } - autonomous-system 64512; - resolution { - rib inet.3 { - resolution-ribs inet.0; - } - rib bgp.l3vpn.0 { - resolution-ribs inet.0; - } - } -} -protocols { - bgp { - advertise-inactive; - family inet { - labeled-unicast; - } - group 1 { - type internal; - advertise-inactive; - advertise-peer-as; - import h; - family inet { - unicast; - } - family inet-vpn { - unicast; - } - cluster 192.168.1.104; - neighbor 192.168.1.101; - neighbor 192.168.1.102; - } - } -} -policy-options { - policy-statement h { - from protocol bgp; - then { - as-path-prepend 64512; - accept; - } - } -} -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 3} on 192.168.1.102: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.100 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -@node VNC with Redundant Route Reflectors Configuration -@subsection VNC with Redundant Route Reflectors Configuration -This example combines the previous two (@ref{VNC with Frr Route -Reflector Configuration} and @ref{VNC with Commercial Route Reflector -Configuration}) into a redundant route reflector configuration. BGP -route reflectors @code{BGP Route Reflector 1} and @code{Commercial Router} -are the route reflectors for NVAs @code{NVA 2} and -@code{NVA 3}. The two NVAs have connections to both -route reflectors. - -@float Figure,fig:fig-vnc-redundant-route-reflectors -@center @image{fig-vnc-redundant-route-reflectors,400pt,,Redundant Route Reflectors} -@caption{Frr-based NVA with redundant route reflectors} -@end float - -@file{bgpd.conf} for @code{Bgpd Route Reflector 1} on 192.168.1.100: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.100 - bgp cluster-id 192.168.1.100 - - neighbor 192.168.1.104 remote-as 64512 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.101 description iBGP-client-192-168-1-101 - neighbor 192.168.1.101 route-reflector-client - - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.102 description iBGP-client-192-168-1-102 - neighbor 192.168.1.102 route-reflector-client - - address-family vpnv4 - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - neighbor 192.168.1.104 activate - - neighbor 192.168.1.101 route-reflector-client - neighbor 192.168.1.102 route-reflector-client - exit-address-family -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - neighbor 192.168.1.104 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - neighbor 192.168.1.104 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 3} on 192.168.1.102: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.100 remote-as 64512 - neighbor 192.168.1.104 remote-as 64512 - - address-family vpnv4 - neighbor 192.168.1.100 activate - neighbor 192.168.1.104 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for the Commercial Router route reflector on -192.168.1.104: -@verbatim -routing-options { - rib inet.0 { - static { - route 172.16.0.0/16 next-hop 192.168.1.104; - } - } - autonomous-system 64512; - resolution { - rib inet.3 { - resolution-ribs inet.0; - } - rib bgp.l3vpn.0 { - resolution-ribs inet.0; - } - } -} -protocols { - bgp { - advertise-inactive; - family inet { - labeled-unicast; - } - group 1 { - type internal; - advertise-inactive; - advertise-peer-as; - import h; - family inet { - unicast; - } - family inet-vpn { - unicast; - } - cluster 192.168.1.104; - neighbor 192.168.1.101; - neighbor 192.168.1.102; - } - - group 2 { - type internal; - advertise-inactive; - advertise-peer-as; - import h; - family inet { - unicast; - } - family inet-vpn { - unicast; - } - neighbor 192.168.1.100; - } - - } -} -policy-options { - policy-statement h { - from protocol bgp; - then { - as-path-prepend 64512; - accept; - } - } -} -@end verbatim - -@node Release Notes -@section Release Notes - -@c A paragraph that introduces our release notes. - -@c outer list, one item per VNC release, items preceded by bullet -@itemize @bullet -@item - -@c @item -@end itemize - -@evenheading @thispage@|@|@thistitle -@oddheading @thischapter@|@|@thispage -@everyfooting - diff --git a/doc/vtysh.texi b/doc/vtysh.texi deleted file mode 100644 index de681c8013..0000000000 --- a/doc/vtysh.texi +++ /dev/null @@ -1,161 +0,0 @@ -@node VTY shell -@chapter VTY shell - -@menu -* Integrated configuration mode:: -@end menu - -@command{vtysh} provides a combined frontend to all Frr daemons in a -single combined session. It is enabled by default at build time, but can -be disabled through the @option{--disable-vtysh} option to -@command{./configure}. - -@command{vtysh} has a configuration file, @file{vtysh.conf}. The location -of that file cannot be changed from @file{@value{INSTALL_PREFIX_ETC}} since -it contains options controlling authentication behavior. This file will -also not be written by configuration-save commands, it is intended to be -updated manually by an administrator with an external editor. - -@quotation Warning -This also means the @command{hostname} and @command{banner motd} commands -(which both do have effect for vtysh) need to be manually updated in -@file{vtysh.conf}. -@end quotation - -@section Permissions and setup requirements - -@command{vtysh} connects to running daemons through Unix sockets located in -@file{@value{INSTALL_PREFIX_STATE}}. Running vtysh thus requires access to -that directory, plus membership in the @emph{@value{INSTALL_VTY_GROUP}} -group (which is the group that the daemons will change ownership of their -sockets to). - -To restrict access to Frr configuration, make sure no unauthorized users -are members of the @emph{@value{INSTALL_VTY_GROUP}} group. - -@subsection PAM support (experimental) - -vtysh has working (but rather useless) PAM support. It will perform -an "authenticate" PAM call using @emph{@value{PACKAGE_NAME}} as service -name. No other (accounting, session, password change) calls will be -performed by vtysh. - -Users using vtysh still need to have appropriate access to the daemons' -VTY sockets, usually by being member of the @emph{@value{INSTALL_VTY_GROUP}} -group. If they have this membership, PAM support is useless since they can -connect to daemons and issue commands using some other tool. Alternatively, -the @command{vtysh} binary could be made SGID (set group ID) to the -@emph{@value{INSTALL_VTY_GROUP}} group. @strong{No security guarantees are -made for this configuration}. - -@deffn {Command} {username @var{username} nopassword} {} - -If PAM support is enabled at build-time, this command allows disabling the -use of PAM on a per-user basis. If vtysh finds that an user is trying to -use vtysh and a "nopassword" entry is found, no calls to PAM will be made -at all. - -@end deffn - -@node Integrated configuration mode -@section Integrated configuration mode - -Integrated configuration mode uses a single configuration file, -@file{frr.conf}, for all daemons. This replaces the individual files like -@file{zebra.conf} or @file{bgpd.conf}. - -@file{frr.conf} is located in @file{@value{INSTALL_PREFIX_ETC}}. All -daemons check for the existence of this file at startup, and if it exists -will not load their individual configuration files. Instead, -@command{vtysh -b} must be invoked to process @file{frr.conf} and apply -its settings to the individual daemons. - -@quotation Warning -@command{vtysh -b} must also be executed after restarting any daemon. -@end quotation - -@subsection Configuration saving, file ownership and permissions - -The @file{frr.conf} file is not written by any of the daemons; instead -@command{vtysh} contains the neccessary logic to collect configuration from -all of the daemons, combine it and write it out. - -@quotation Warning -Daemons must be running for @command{vtysh} to be able to collect their -configuration. Any configuration from non-running daemons is permanently -lost after doing a configuration save. -@end quotation - -Since the @command{vtysh} command may be running as ordinary user on the -system, configuration writes will be tried through @command{watchfrr}, -using the @command{write integrated} command internally. Since -@command{watchfrr} is running as superuser, @command{vtysh} is able to -ensure correct ownership and permissions on @file{frr.conf}. - -If @command{watchfrr} is not running or the configuration write fails, -@command{vtysh} will attempt to directly write to the file. This is likely -to fail if running as unprivileged user; alternatively it may leave the -file with incorrect owner or permissions. - -Writing the configuration can be triggered directly by invoking -@command{vtysh -w}. This may be useful for scripting. Note this command -should be run as either the superuser or the Frr user. - -We recommend you do not mix the use of the two types of files. Further, it -is better not to use the integrated frr.conf file, as any syntax error in -it can lead to /all/ of your daemons being unable to start up. Per daemon -files are more robust as impact of errors in configuration are limited to -the daemon in whose file the error is made. - -@deffn {Command} {service integrated-vtysh-config} {} -@deffnx {Command} {no service integrated-vtysh-config} {} - -Control whether integrated @file{frr.conf} file is written when -'write file' is issued. - -These commands need to be placed in @file{vtysh.conf} to have any effect. -Note that since @file{vtysh.conf} is not written by Frr itself, they -therefore need to be manually placed in that file. - -This command has 3 states: -@itemize @bullet -@item -@command{service integrated-vtysh-config} - -@command{vtysh} will always write @file{frr.conf}. - -@item -@command{no service integrated-vtysh-config} - -@command{vtysh} will never write @file{frr.conf}; instead it will ask -daemons to write their individual configuration files. - -@item -Neither option present (default) - -@command{vtysh} will check whether @file{frr.conf} exists. If it does, -configuration writes will update that file. Otherwise, writes are performed -through the individual daemons. -@end itemize - -This command is primarily intended for packaging/distribution purposes, to -preset one of the two operating modes and ensure consistent operation across -installations. -@end deffn - -@deffn {Command} {write integrated} {} - -Unconditionally (regardless of @command{service integrated-vtysh-config} -setting) write out integrated @file{frr.conf} file through -@command{watchfrr}. If @command{watchfrr} is not running, this command -is unavailable. - -@end deffn - -@section Caveats - -Configuration changes made while some daemon is not running will be invisible -to that daemon. The daemon will start up with its saved configuration -(either in its individual configuration file, or in @file{frr.conf}). -This is particularly troublesome for route-maps and prefix lists, which would -otherwise be synchronized between daemons. From 4652e58cefa9b0ee3ba3d40eac076ebc4b6b6953 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 20 Dec 2017 16:05:51 -0500 Subject: [PATCH 010/148] doc: fixup ipv6.rst Manual cleanup from leftover texi -> rst Signed-off-by: Quentin Young --- doc/user/ipv6.rst | 312 ++++++++++++++++++++-------------------------- 1 file changed, 138 insertions(+), 174 deletions(-) diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 5c002467b7..0b1088e5d7 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -7,7 +7,7 @@ IPv6 Support Frr fully supports IPv6 routing. As described so far, Frr supports RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface and configure static IPv6 routing information. Frr IPv6 also provides -automatic address configuration via a feature called `address auto configuration`. To do it, the router must send router advertisement +automatic address configuration via a feature called ``address auto configuration``. To do it, the router must send router advertisement messages to the all nodes that exist on the network. Previous versions of Frr could be built without IPv6 support. This is @@ -16,214 +16,178 @@ no longer possible. Router Advertisement ==================== -.. index:: {Interface Command} {no ipv6 nd suppress-ra} {} +.. index:: no ipv6 nd suppress-ra -{Interface Command} {no ipv6 nd suppress-ra} {} - Send router advertisment messages. +``no ipv6 nd suppress-ra`` + Send router advertisment messages. -.. index:: {Interface Command} {ipv6 nd suppress-ra} {} +.. index:: ipv6 nd suppress-ra -{Interface Command} {ipv6 nd suppress-ra} {} - Don't send router advertisment messages. +``ipv6 nd suppress-ra`` + Don't send router advertisment messages. -.. index:: {Interface Command} {ipv6 nd prefix `ipv6prefix` [`valid-lifetime`] [`preferred-lifetime`] [off-link] [no-autoconfig] [router-address]} {} +.. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] -{Interface Command} {ipv6 nd prefix `ipv6prefix` [`valid-lifetime`] [`preferred-lifetime`] [off-link] [no-autoconfig] [router-address]} {} - Configuring the IPv6 prefix to include in router advertisements. Several prefix - specific optional parameters and flags may follow: +``ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]`` + Configuring the IPv6 prefix to include in router advertisements. Several prefix + specific optional parameters and flags may follow: + + - ``valid-lifetime``: the length of time in seconds during what the prefix is + valid for the purpose of on-link determination. Value ``infinite`` represents + infinity (i.e. a value of all one bits (``0xffffffff``)). + Range: ``<0-4294967295>`` Default: ``2592000`` + + - ``preferred-lifetime``: the length of time in seconds during what addresses + generated from the prefix remain preferred. Value ``infinite`` represents + infinity. + Range: ``<0-4294967295>`` Default: ``604800`` + + - ``off-link``: indicates that advertisement makes no statement about on-link or + off-link properties of the prefix. + Default: not set, i.e. this prefix can be used for on-link determination. + + - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix + cannot be used for IPv6 autoconfiguration. + + Default: not set, i.e. prefix can be used for autoconfiguration. + + - ``router-address``: indicates to hosts on the local link that the specified + prefix contains a complete IP address by setting R flag. + + Default: not set, i.e. hosts do not assume a complete IP address is placed. + +.. index:: + single: no ipv6 nd ra-interval [<1-1800>] + single: no ipv6 nd ra-interval [<1-1800>] + +``[no] ipv6 nd ra-interval [<1-1800>]`` + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in seconds. + Default: ``600`` + +.. index:: ipv6 nd ra-interval msec <70-1800000> -`` - `valid-lifetime` - the length of time in seconds during what the prefix is - valid for the purpose of on-link determination. Value `infinite` represents - infinity (i.e. a value of all one bits (`0xffffffff`)). +.. index:: + single: no ipv6 nd ra-interval [msec <70-1800000>] + single: ipv6 nd ra-interval msec <70-1800000> - Range: `<0-4294967295>` Default: `2592000` +``[no] ipv6 nd ra-interval [msec <70-1800000>]`` + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in milliseconds. + Default: ``600000`` +.. index:: + single: ipv6 nd ra-lifetime <0-9000> + single: no ipv6 nd ra-lifetime [<0-9000>] -`` - `preferred-lifetime` - the length of time in seconds during what addresses - generated from the prefix remain preferred. Value `infinite` represents - infinity. - - Range: `<0-4294967295>` Default: `604800` - - -`` - `off-link` - indicates that advertisement makes no statement about on-link or - off-link properties of the prefix. - - Default: not set, i.e. this prefix can be used for on-link determination. - - -`` - `no-autoconfig` - indicates to hosts on the local link that the specified prefix - cannot be used for IPv6 autoconfiguration. - - Default: not set, i.e. prefix can be used for autoconfiguration. - - -`` - `router-address` - indicates to hosts on the local link that the specified - prefix - contains a complete IP address by setting R flag. - - Default: not set, i.e. hosts do not assume a complete IP address is placed. - -.. index:: {Interface Command} {ipv6 nd ra-interval <1-1800>} {} - -{Interface Command} {ipv6 nd ra-interval <1-1800>} {} -.. index:: {Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} - -{Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} - The maximum time allowed between sending unsolicited multicast router - advertisements from the interface, in seconds. - - Default: `600` - -.. index:: {Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} - -{Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} -.. index:: {Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} - -{Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} - The maximum time allowed between sending unsolicited multicast router - advertisements from the interface, in milliseconds. - - Default: `600000` - -.. index:: {Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} - -{Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} -.. index:: {Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} - -{Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} +``[no] ipv6 nd ra-lifetime [<0-9000>]`` The value to be placed in the Router Lifetime field of router advertisements sent from the interface, in seconds. Indicates the usefulness of the router as a default router on this interface. Setting the value to zero indicates that the router should not be considered a default router on this interface. - Must be either zero or between value specified with `ipv6 nd ra-interval` + Must be either zero or between value specified with ``ipv6 nd ra-interval`` (or default) and 9000 seconds. + Default: ``1800`` - Default: `1800` +.. index:: + single: no ipv6 nd reachable-time [<1-3600000>] + single: ipv6 nd reachable-time <1-3600000> -.. index:: {Interface Command} {ipv6 nd reachable-time <1-3600000>} {} +``[no] ipv6 nd reachable-time [<1-3600000>]`` + The value to be placed in the Reachable Time field in the Router Advertisement + messages sent by the router, in milliseconds. The configured time enables the + router to detect unavailable neighbors. The value zero means unspecified (by + this router). + Default: ``0`` -{Interface Command} {ipv6 nd reachable-time <1-3600000>} {} -.. index:: {Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} +.. index:: + single: ipv6 nd managed-config-flag + single: no ipv6 nd managed-config-flag -{Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} - The value to be placed in the Reachable Time field in the Router Advertisement - messages sent by the router, in milliseconds. The configured time enables the - router to detect unavailable neighbors. The value zero means unspecified (by - this router). +``[no] ipv6 nd managed-config-flag`` + Set/unset flag in IPv6 router advertisements which indicates to hosts that they + should use managed (stateful) protocol for addresses autoconfiguration in + addition to any addresses autoconfigured using stateless address + autoconfiguration. + Default: not set - Default: `0` +.. index:: + single: ipv6 nd other-config-flag + single: no ipv6 nd other-config-flag -.. index:: {Interface Command} {ipv6 nd managed-config-flag} {} +``[no] ipv6 nd other-config-flag`` + Set/unset flag in IPv6 router advertisements which indicates to hosts that + they should use administered (stateful) protocol to obtain autoconfiguration + information other than addresses. + Default: not set -{Interface Command} {ipv6 nd managed-config-flag} {} -.. index:: {Interface Command} {no ipv6 nd managed-config-flag} {} +.. index:: + single: ipv6 nd home-agent-config-flag + single: no ipv6 nd home-agent-config-flag -{Interface Command} {no ipv6 nd managed-config-flag} {} - Set/unset flag in IPv6 router advertisements which indicates to hosts that they - should use managed (stateful) protocol for addresses autoconfiguration in - addition to any addresses autoconfigured using stateless address - autoconfiguration. +``[no] ipv6 nd home-agent-config-flag`` + Set/unset flag in IPv6 router advertisements which indicates to hosts that + the router acts as a Home Agent and includes a Home Agent Option. + Default: not set - Default: not set +.. index:: ipv6 nd home-agent-preference <0-65535> -.. index:: {Interface Command} {ipv6 nd other-config-flag} {} +.. index:: + single: no ipv6 nd home-agent-preference [<0-65535>] + single: ipv6 nd home-agent-preference <0-65535> -{Interface Command} {ipv6 nd other-config-flag} {} -.. index:: {Interface Command} {no ipv6 nd other-config-flag} {} +``[no] ipv6 nd home-agent-preference [<0-65535>]`` + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent preference. The default value of 0 stands + for the lowest preference possible. + Default: ``0`` -{Interface Command} {no ipv6 nd other-config-flag} {} - Set/unset flag in IPv6 router advertisements which indicates to hosts that - they should use administered (stateful) protocol to obtain autoconfiguration - information other than addresses. +.. index:: + single: ipv6 nd home-agent-lifetime <0-65520> + single: no ipv6 nd home-agent-lifetime <0-65520> - Default: not set +``[no] ipv6 nd home-agent-lifetime [<0-65520>]`` + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent Lifetime. The default value of 0 means to + place the current Router Lifetime value. -.. index:: {Interface Command} {ipv6 nd home-agent-config-flag} {} + Default: ``0`` -{Interface Command} {ipv6 nd home-agent-config-flag} {} -.. index:: {Interface Command} {no ipv6 nd home-agent-config-flag} {} +.. index:: + single: ipv6 nd adv-interval-option + single: no ipv6 nd adv-interval-option -{Interface Command} {no ipv6 nd home-agent-config-flag} {} - Set/unset flag in IPv6 router advertisements which indicates to hosts that - the router acts as a Home Agent and includes a Home Agent Option. +``[no] ipv6 nd adv-interval-option`` + Include an Advertisement Interval option which indicates to hosts the maximum time, + in milliseconds, between successive unsolicited Router Advertisements. + Default: not set - Default: not set +.. index:: + single: ipv6 nd router-preference (high|medium|low) + single: no ipv6 nd router-preference (high|medium|low) -.. index:: {Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} +``[no] ipv6 nd router-preference [(high|medium|low)]`` + Set default router preference in IPv6 router advertisements per RFC4191. + Default: medium -{Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} -.. index:: {Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} +.. index:: + single: ipv6 nd mtu <1-65535> + single: no ipv6 nd mtu [<1-65535>] -{Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} - The value to be placed in Home Agent Option, when Home Agent config flag is set, - which indicates to hosts Home Agent preference. The default value of 0 stands - for the lowest preference possible. +``[no] ipv6 nd mtu [<1-65535>]`` + Include an MTU (type 5) option in each RA packet to assist the attached hosts + in proper interface configuration. The announced value is not verified to be + consistent with router interface MTU. - Default: 0 + Default: don't advertise any MTU option.:: + interface eth0 + no ipv6 nd suppress-ra + ipv6 nd prefix 2001:0DB8:5009::/64 -.. index:: {Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} - -{Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} -.. index:: {Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} - -{Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} - The value to be placed in Home Agent Option, when Home Agent config flag is set, - which indicates to hosts Home Agent Lifetime. The default value of 0 means to - place the current Router Lifetime value. - - Default: 0 - -.. index:: {Interface Command} {ipv6 nd adv-interval-option} {} - -{Interface Command} {ipv6 nd adv-interval-option} {} -.. index:: {Interface Command} {no ipv6 nd adv-interval-option} {} - -{Interface Command} {no ipv6 nd adv-interval-option} {} - Include an Advertisement Interval option which indicates to hosts the maximum time, - in milliseconds, between successive unsolicited Router Advertisements. - - Default: not set - -.. index:: {Interface Command} {ipv6 nd router-preference (high|medium|low)} {} - -{Interface Command} {ipv6 nd router-preference (high|medium|low)} {} -.. index:: {Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} - -{Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} - Set default router preference in IPv6 router advertisements per RFC4191. - - Default: medium - -.. index:: {Interface Command} {ipv6 nd mtu <1-65535>} {} - -{Interface Command} {ipv6 nd mtu <1-65535>} {} -.. index:: {Interface Command} {no ipv6 nd mtu [<1-65535>]} {} - -{Interface Command} {no ipv6 nd mtu [<1-65535>]} {} - Include an MTU (type 5) option in each RA packet to assist the attached hosts - in proper interface configuration. The announced value is not verified to be - consistent with router interface MTU. - - Default: don't advertise any MTU option - -:: - - @group - interface eth0 - no ipv6 nd suppress-ra - ipv6 nd prefix 2001:0DB8:5009::/64 - @end group - - - For more information see @cite{RFC2462 (IPv6 Stateless Address Autoconfiguration)} - , @cite{RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))} - , @cite{RFC6275 (Mobility Support in IPv6)} - and @cite{RFC4191 (Default Router Preferences and More-Specific Routes)}. +For more information see +:t:`RFC2462 (IPv6 Stateless Address Autoconfiguration)`, +:t:`RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))`, +:t:`RFC6275 (Mobility Support in IPv6)` and +:t:`RFC4191 (Default Router Preferences and More-Specific Routes)`. From 2dd0a0ed1d3619e3b39e9edb04ccf5aed046b93a Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 20 Dec 2017 17:54:03 -0500 Subject: [PATCH 011/148] doc: fixup babeld.rst Signed-off-by: Quentin Young --- doc/user/babeld.rst | 328 +++++++++++++++++++++++--------------------- 1 file changed, 175 insertions(+), 153 deletions(-) diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst index 926b453e53..72d8531e31 100644 --- a/doc/user/babeld.rst +++ b/doc/user/babeld.rst @@ -13,7 +13,7 @@ perform reliable link quality estimation on wireless links. Babel is a double-stack routing protocol, meaning that a single Babel instance is able to perform routing for both IPv4 and IPv6. -FRR implements Babel as described in RFC6126. +FRR imlements Babel as described in :t:`RFC6126`. .. _Configuring_babeld: @@ -35,231 +35,253 @@ Configuration of *babeld* is done in its configuration file Babel configuration =================== -.. index:: Command {router babel} {} +.. index:: + single: router babel + single: no router babel -Command {router babel} {} -.. index:: Command {no router babel} {} - -Command {no router babel} {} +``[no] router babel`` Enable or disable Babel routing. -.. index:: Command {babel resend-delay <20-655340>} {} +.. index:: + single: babel resend-delay <20-655340> + single: no babel resend-delay [<20-655340>] -Command {babel resend-delay <20-655340>} {} +``[no] babel resend-delay <20-655340>`` Specifies the time after which important messages are resent when - avoiding a black-hole. The default is 2000@dmn{ms}. + avoiding a black-hole. The default is 2000 ms. -.. index:: Command {babel diversity} {} +.. index:: + single: babel diversity + single: no babel diversity -Command {babel diversity} {} -.. index:: Command {no babel diversity} {} - -Command {no babel diversity} {} +``[no] babel diversity`` Enable or disable routing using radio frequency diversity. This is highly recommended in networks with many wireless nodes. + If you enable this, you will probably want to set `babel + diversity-factor` and `babel channel` below. - If you enable this, you will probably want to set `babel diversity-factor` and `babel channel` below. +.. index:: babel diversity-factor <1-256> -.. index:: Command {babel diversity-factor <1-256>} {} - -Command {babel diversity-factor <1-256>} {} +``babel diversity-factor <1-256>`` Sets the multiplicative factor used for diversity routing, in units of 1/256; lower values cause diversity to play a more important role in route selection. The default it 256, which means that diversity plays no role in route selection; you will probably want to set that to 128 or less on nodes with multiple independent radios. -.. index:: {Babel Command} {network `ifname`} {} +.. index:: + single: network IFNAME + single: no network IFNAME -{Babel Command} {network `ifname`} {} -.. index:: {Babel Command} {no network `ifname`} {} +``no network IFNAME`` + Enable or disable Babel on the given interface. -{Babel Command} {no network `ifname`} {} - Enable or disable Babel on the given interface. +.. index:: babel -.. index:: {Interface Command} {babel wired} {} +``babel `` + Specifies whether this interface is wireless, which disables a number + of optimisations that are only correct on wired interfaces. + Specifying `wireless` (the default) is always correct, but may + cause slower convergence and extra routing traffic. -{Interface Command} {babel wired} {} -.. index:: {Interface Command} {babel wireless} {} +.. index:: + single: babel split-horizon + single: no babel split-horizon -{Interface Command} {babel wireless} {} - Specifies whether this interface is wireless, which disables a number - of optimisations that are only correct on wired interfaces. - Specifying `wireless` (the default) is always correct, but may - cause slower convergence and extra routing traffic. +``[no] babel split-horizon`` + Specifies whether to perform split-horizon on the interface. Specifying + ``no babel split-horizon`` is always correct, while ``babel + split-horizon`` is an optimisation that should only be used on symmetric + and transitive (wired) networks. The default is ``babel split-horizon`` + on wired interfaces, and ``no babel split-horizon`` on wireless + interfaces. This flag is reset when the wired/wireless status of an + interface is changed. -.. index:: {Interface Command} {babel split-horizon} +.. index:: babel hello-interval <20-655340> -{Interface Command} {babel split-horizon} -.. index:: {Interface Command} {no babel split-horizon} +``babel hello-interval <20-655340>`` + Specifies the time in milliseconds between two scheduled hellos. On + wired links, Babel notices a link failure within two hello intervals; + on wireless links, the link quality value is reestimated at every + hello interval. The default is 4000 ms. -{Interface Command} {no babel split-horizon} - Specifies whether to perform split-horizon on the interface. - Specifying `no babel split-horizon` is always correct, while - `babel split-horizon` is an optimisation that should only be used - on symmetric and transitive (wired) networks. The default is - `babel split-horizon` on wired interfaces, and `no babel split-horizon` on wireless interfaces. This flag is reset when the - wired/wireless status of an interface is changed. +.. index:: babel update-interval <20-655340> -.. index:: {Interface Command} {babel hello-interval <20-655340>} +``babel update-interval <20-655340>`` + Specifies the time in milliseconds between two scheduled updates. + Since Babel makes extensive use of triggered updates, this can be set + to fairly high values on links with little packet loss. The default + is 20000 ms. -{Interface Command} {babel hello-interval <20-655340>} - Specifies the time in milliseconds between two scheduled hellos. On - wired links, Babel notices a link failure within two hello intervals; - on wireless links, the link quality value is reestimated at every - hello interval. The default is 4000@dmn{ms}. +.. index:: + single: babel channel <1-254> + single: babel channel interfering + single: babel channel noninterfering -.. index:: {Interface Command} {babel update-interval <20-655340>} +``babel channel <1-254>`` + see below -{Interface Command} {babel update-interval <20-655340>} - Specifies the time in milliseconds between two scheduled updates. - Since Babel makes extensive use of triggered updates, this can be set - to fairly high values on links with little packet loss. The default - is 20000@dmn{ms}. +``babel channel interfering`` + see below -.. index:: {Interface Command} {babel channel <1-254>} +``babel channel noninterfering`` + Set the channel number that diversity routing uses for this interface + (see `babel diversity` above). Noninterfering interfaces are + assumed to only interfere with themselves, interfering interfaces are + assumed to interfere with all other channels except noninterfering + channels, and interfaces with a channel number interfere with + interfering interfaces and interfaces with the same channel number. + The default is @samp{babel channel interfering} for wireless + interfaces, and @samp{babel channel noninterfering} for wired + interfaces. This is reset when the wired/wireless status of an + interface is changed. -{Interface Command} {babel channel <1-254>} -.. index:: {Interface Command} {babel channel interfering} +.. index:: babel rxcost <1-65534> -{Interface Command} {babel channel interfering} -.. index:: {Interface Command} {babel channel noninterfering} +``babel rxcost <1-65534>`` + Specifies the base receive cost for this interface. For wireless + interfaces, it specifies the multiplier used for computing the ETX + reception cost (default 256); for wired interfaces, it specifies the + cost that will be advertised to neighbours. This value is reset when + the wired/wireless attribute of the interface is changed. -{Interface Command} {babel channel noninterfering} - Set the channel number that diversity routing uses for this interface - (see `babel diversity` above). Noninterfering interfaces are - assumed to only interfere with themselves, interfering interfaces are - assumed to interfere with all other channels except noninterfering - channels, and interfaces with a channel number interfere with - interfering interfaces and interfaces with the same channel number. - The default is @samp{babel channel interfering} for wireless - interfaces, and @samp{babel channel noninterfering} for wired - interfaces. This is reset when the wired/wireless status of an - interface is changed. + Do not use this command unless you know what you are doing; in most + networks, acting directly on the cost using route maps is a better + technique. -.. index:: {Interface Command} {babel rxcost <1-65534>} +.. index:: babel rtt-decay <1-256> -{Interface Command} {babel rxcost <1-65534>} - Specifies the base receive cost for this interface. For wireless - interfaces, it specifies the multiplier used for computing the ETX - reception cost (default 256); for wired interfaces, it specifies the - cost that will be advertised to neighbours. This value is reset when - the wired/wireless attribute of the interface is changed. +``babel rtt-decay <1-256>`` + This specifies the decay factor for the exponential moving average of + RTT samples, in units of 1/256. Higher values discard old samples + faster. The default is 42. - Do not use this command unless you know what you are doing; in most - networks, acting directly on the cost using route maps is a better - technique. +.. index:: babel rtt-min <1-65535> -.. index:: {Interface Command} {babel rtt-decay <1-256>} +``babel rtt-min <1-65535>`` + This specifies the minimum RTT, in milliseconds, starting from which we + increase the cost to a neighbour. The additional cost is linear in + (rtt - rtt-min). The default is 100 ms. -{Interface Command} {babel rtt-decay <1-256>} - This specifies the decay factor for the exponential moving average of - RTT samples, in units of 1/256. Higher values discard old samples - faster. The default is 42. +.. index:: babel rtt-max <1-65535> -.. index:: {Interface Command} {babel rtt-min <1-65535>} +``babel rtt-max <1-65535>`` + This specifies the maximum RTT, in milliseconds, above which we don't + increase the cost to a neighbour. The default is 120 ms. -{Interface Command} {babel rtt-min <1-65535>} - This specifies the minimum RTT, in milliseconds, starting from which we - increase the cost to a neighbour. The additional cost is linear in (rtt - - rtt-min ). The default is 10@dmn{ms}. +.. index:: babel max-rtt-penalty <0-65535> -.. index:: {Interface Command} {babel rtt-max <1-65535>} +``babel max-rtt-penalty <0-65535>`` + This specifies the maximum cost added to a neighbour because of RTT, + i.e. when the RTT is higher or equal than rtt-max. The default is 0, + which effectively disables the use of a RTT-based cost. -{Interface Command} {babel rtt-max <1-65535>} - This specifies the maximum RTT, in milliseconds, above which we don't - increase the cost to a neighbour. The default is 120@dmn{ms}. +.. index:: + single: babel enable-timestamps + single: no babel enable-timestamps -.. index:: {Interface Command} {babel max-rtt-penalty <0-65535>} +``[no] babel enable-timestamps`` + Enable or disable sending timestamps with each Hello and IHU message in + order to compute RTT values. The default is `no babel enable-timestamps`. -{Interface Command} {babel max-rtt-penalty <0-65535>} - This specifies the maximum cost added to a neighbour because of RTT, - i.e. when the RTT is higher or equal than rtt-max. The default is 0, - which effectively disables the use of a RTT-based cost. +.. index:: babel resend-delay <20-655340> -.. index:: {Interface Command} {babel enable-timestamps} +``babel resend-delay <20-655340>`` + Specifies the time in milliseconds after which an 'important' + request or update will be resent. The default is 2000 ms. You + probably don't want to tweak this value. -{Interface Command} {babel enable-timestamps} -.. index:: {Interface Command} {no babel enable-timestamps} +.. index:: babel smoothing-half-life <0-65534> -{Interface Command} {no babel enable-timestamps} - Enable or disable sending timestamps with each Hello and IHU message in - order to compute RTT values. The default is `no babel enable-timestamps`. - -.. index:: {Babel Command} {babel resend-delay <20-655340>} - -{Babel Command} {babel resend-delay <20-655340>} - Specifies the time in milliseconds after which an 'important' - request or update will be resent. The default is 2000@dmn{ms}. You - probably don't want to tweak this value. - -.. index:: {Babel Command} {babel smoothing-half-life <0-65534>} - -{Babel Command} {babel smoothing-half-life <0-65534>} - Specifies the time constant, in seconds, of the smoothing algorithm - used for implementing hysteresis. Larger values reduce route - oscillation at the cost of very slightly increasing convergence time. - The value 0 disables hysteresis, and is suitable for wired networks. - The default is 4@dmn{s}. +``babel smoothing-half-life <0-65534>`` + Specifies the time constant, in seconds, of the smoothing algorithm + used for implementing hysteresis. Larger values reduce route + oscillation at the cost of very slightly increasing convergence time. + The value 0 disables hysteresis, and is suitable for wired networks. + The default is 4 s. .. _Babel_redistribution: Babel redistribution ==================== -.. index:: {Babel command} {redistribute `` `kind`} +.. index:: + single: redistribute KIND + single: no redistribute KIND -{Babel command} {redistribute `` `kind`} -.. index:: {Babel command} {no redistribute `` `kind`} - -{Babel command} {no redistribute `` `kind`} - Specify which kind of routes should be redistributed into Babel. +``[no] redistribute KIND`` + Specify which kind of routes should be redistributed into Babel. .. _Show_Babel_information: Show Babel information ====================== -.. index:: {Command} {show babel route} {} +These commands dump various parts of *babeld*'s internal state. -{Command} {show babel route} {} -.. index:: {Command} {show babel route A.B.C.D} +.. index:: show babel route -{Command} {show babel route A.B.C.D} -.. index:: {Command} {show babel route X:X::X:X} +``show babel route`` + *missing description* -{Command} {show babel route X:X::X:X} -.. index:: {Command} {show babel route A.B.C.D/M} +.. index:: show babel route A.B.C.D -{Command} {show babel route A.B.C.D/M} -.. index:: {Command} {show babel route X:X::X:X/M} +``show babel route A.B.C.D`` + *missing description* -{Command} {show babel route X:X::X:X/M} -.. index:: {Command} {show babel interface} {} +.. index:: show babel route X:X::X:X -{Command} {show babel interface} {} -.. index:: {Command} {show babel interface `ifname`} {} +``show babel route X:X::X:X`` + *missing description* -{Command} {show babel interface `ifname`} {} -.. index:: {Command} {show babel neighbor} {} +.. index:: show babel route A.B.C.D/M -{Command} {show babel neighbor} {} -.. index:: {Command} {show babel parameters} {} +``show babel route A.B.C.D/M`` + *missing description* -{Command} {show babel parameters} {} - These commands dump various parts of *babeld*'s internal state. +.. index:: show babel route X:X::X:X/M + +``show babel route X:X::X:X/M`` + *missing description* + +.. index:: show babel interface + +``show babel interface`` + *missing description* + +.. index:: show babel interface `IFNAME` + +``show babel interface IFNAME`` + *missing description* + +.. index:: show babel neighbor + +``show babel neighbor`` + *missing description* + +.. index:: show babel parameters + +``show babel parameters`` + *missing description* Babel debugging commands ======================== -.. index:: {Babel Command} {debug babel `kind`} {} +.. index:: + simple: debug babel KIND + simple: no debug babel KIND -{Babel Command} {debug babel `kind`} {} -.. index:: {Babel Command} {no debug babel `kind`} {} +``[no] debug babel KIND`` + Enable or disable debugging messages of a given kind. ``KIND`` can + be one of: -{Babel Command} {no debug babel `kind`} {} - Enable or disable debugging messages of a given kind. `kind` can - be one of @samp{common}, @samp{kernel}, @samp{filter}, @samp{timeout}, - @samp{interface}, @samp{route} or @samp{all}. Note that if you have - compiled with the NO_DEBUG flag, then these commands aren't available. + - common + - filter + - timeout + - interface + - route + - all + + Note that if you have compiled with the NO_DEBUG flag, then these commands + aren't available. From 8d2098618c9cfbefaf238f2c8f1d93a60da869cd Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 22 Dec 2017 16:19:33 -0500 Subject: [PATCH 012/148] doc: fixup basic.rst Signed-off-by: Quentin Young --- doc/user/basic.rst | 546 +++++++++++++++++++-------------------------- 1 file changed, 225 insertions(+), 321 deletions(-) diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 505de59547..c46665c501 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -6,11 +6,15 @@ Basic commands There are five routing daemons in use, and there is one manager daemon. These daemons may be located on separate machines from the manager -daemon. Each of these daemons will listen on a particular port for -incoming VTY connections. The routing daemons are: +daemon. Each of these daemons will listen on a particular port for +incoming VTY connections. The routing daemons are: -* *ripd*, *ripngd*, *ospfd*, *ospf6d*, *bgpd* -* *zebra* +- *ripd* +- *ripngd* +- *ospfd* +- *ospf6d* +- *bgpd* +- *zebra* The following sections discuss commands common to all the routing daemons. @@ -38,12 +42,12 @@ Config files are generally found in: * :file:`@value{INSTALL_PREFIX_ETC}`/\*.conf Each of the daemons has its own -config file. For example, zebra's default config file name is: +config file. For example, zebra's default config file name is: * :file:`@value{INSTALL_PREFIX_ETC`/zebra.conf} The daemon name plus :file:`.conf` is the default config file name. You -can specify a config file using the @kbd{-f} or @kbd{--config-file} +can specify a config file using the :kbd:`-f` or :kbd:`--config-file` options when starting the daemon. .. _Basic_Config_Commands: @@ -51,220 +55,189 @@ options when starting the daemon. Basic Config Commands --------------------- -.. index:: Command {hostname `hostname`} {} +.. index:: hostname HOSTNAME -Command {hostname `hostname`} {} +``hostname HOSTNAME`` Set hostname of the router. -.. index:: Command {password `password`} {} +.. index:: password PASSWORD -Command {password `password`} {} - Set password for vty interface. If there is no password, a vty won't +``password PASSWORD`` + Set password for vty interface. If there is no password, a vty won't accept connections. -.. index:: Command {enable password `password`} {} +.. index:: enable password PASSWORD -Command {enable password `password`} {} +``enable password PASSWORD`` Set enable password. -.. index:: Command {log trap `level`} {} +.. index:: + single: no log trap [LEVEL] + single: log trap LEVEL -Command {log trap `level`} {} -.. index:: Command {no log trap} {} +``[no] log trap LEVEL`` + These commands are deprecated and are present only for historical + compatibility. The log trap command sets the current logging level for all + enabled logging destinations, and it sets the default for all future logging + commands that do not specify a level. The normal default logging level is + debugging. The ``no`` form of the command resets the default level for future + logging commands to debugging, but it does not change the logging level of + existing logging destinations. -Command {no log trap} {} - These commands are deprecated and are present only for historical compatibility. - The log trap command sets the current logging level for all enabled - logging destinations, and it sets the default for all future logging commands - that do not specify a level. The normal default - logging level is debugging. The `no` form of the command resets - the default level for future logging commands to debugging, but it does - not change the logging level of existing logging destinations. +.. index:: + single: no log stdout [LEVEL] + single: log stdout [LEVEL] -.. index:: Command {log stdout} {} +``[no] log stdout LEVEL`` + Enable logging output to stdout. If the optional second argument specifying + the logging level is not present, the default logging level (typically + debugging, but can be changed using the deprecated ``log trap`` command) will + be used. The ``no`` form of the command disables logging to stdout. The + ``LEVEL`` argument must have one of these values: emergencies, alerts, + critical, errors, warnings, notifications, informational, or debugging. Note + that the existing code logs its most important messages with severity + ``errors``. -Command {log stdout} {} -.. index:: Command {log stdout `level`} {} +.. index:: + single: no log file [FILENAME [LEVEL]] + single: log file FILENAME [LEVEL] -Command {log stdout `level`} {} -.. index:: Command {no log stdout} {} +``[no] log file [FILENAME [LEVEL]]`` + If you want to log into a file, please specify ``filename`` as + in this example: :: -Command {no log stdout} {} - Enable logging output to stdout. - If the optional second argument specifying the - logging level is not present, the default logging level (typically debugging, - but can be changed using the deprecated `log trap` command) will be used. - The `no` form of the command disables logging to stdout. - The `level` argument must have one of these values: - emergencies, alerts, critical, errors, warnings, notifications, informational, or debugging. Note that the existing code logs its most important messages - with severity `errors`. + log file /var/log/frr/bgpd.log informational -.. index:: Command {log file `filename`} {} + If the optional second argument specifying the logging level is not present, + the default logging level (typically debugging, but can be changed using the + deprecated ``log trap`` command) will be used. The ``no`` form of the command + disables logging to a file. *Note:* if you do not configure any file logging, + and a daemon crashes due to a signal or an assertion failure, it will attempt + to save the crash information in a file named /var/tmp/frr..crashlog. For security reasons, this will not happen if the file exists + already, so it is important to delete the file after reporting the crash + information. -Command {log file `filename`} {} -.. index:: Command {log file `filename` `level`} {} +.. index:: + single: no log syslog [LEVEL] + single: log syslog [LEVEL] -Command {log file `filename` `level`} {} -.. index:: Command {no log file} {} +``[no] log syslog [LEVEL]`` + Enable logging output to syslog. If the optional second argument specifying + the logging level is not present, the default logging level (typically + debugging, but can be changed using the deprecated ``log trap`` command) will + be used. The ``no`` form of the command disables logging to syslog. -Command {no log file} {} - If you want to log into a file, please specify `filename` as - in this example:: +.. index:: + single: no log monitor [LEVEL] + single: log monitor [LEVEL] - log file /var/log/frr/bgpd.log informational - - If the optional second argument specifying the - logging level is not present, the default logging level (typically debugging, - but can be changed using the deprecated `log trap` command) will be used. - The `no` form of the command disables logging to a file. +``[no] log monitor [LEVEL]`` + Enable logging output to vty terminals that have enabled logging using the + ``terminal monitor`` command. By default, monitor logging is enabled at the + debugging level, but this command (or the deprecated ``log trap`` command) can + be used to change the monitor logging level. If the optional second argument + specifying the logging level is not present, the default logging level + (typically debugging, but can be changed using the deprecated ``log trap`` + command) will be used. The ``no`` form of the command disables logging to + terminal monitors. - Note: if you do not configure any file logging, and a daemon crashes due - to a signal or an assertion failure, it will attempt to save the crash - information in a file named /var/tmp/frr..crashlog. - For security reasons, this will not happen if the file exists already, so - it is important to delete the file after reporting the crash information. +.. index:: + single: no log facility [FACILITY] + single: log facility [FACILITY] -.. index:: Command {log syslog} {} +``[no] log facility [FACILITY]`` + This command changes the facility used in syslog messages. The default + facility is ``daemon``. The ``no`` form of the command resets + the facility to the default ``daemon`` facility. -Command {log syslog} {} -.. index:: Command {log syslog `level`} {} +.. index:: + single: no log record-priority + single: log record-priority -Command {log syslog `level`} {} -.. index:: Command {no log syslog} {} +``[no] log record-priority`` + To include the severity in all messages logged to a file, to stdout, or to + a terminal monitor (i.e. anything except syslog), + use the ``log record-priority`` global configuration command. + To disable this option, use the ``no`` form of the command. By default, + the severity level is not included in logged messages. Note: some + versions of syslogd (including Solaris) can be configured to include + the facility and level in the messages emitted. -Command {no log syslog} {} - Enable logging output to syslog. - If the optional second argument specifying the - logging level is not present, the default logging level (typically debugging, - but can be changed using the deprecated `log trap` command) will be used. - The `no` form of the command disables logging to syslog. +.. index:: + single: log timestamp precision <0-6> + single: [no] log timestamp precision <0-6> -.. index:: Command {log monitor} {} - -Command {log monitor} {} -.. index:: Command {log monitor `level`} {} - -Command {log monitor `level`} {} -.. index:: Command {no log monitor} {} - -Command {no log monitor} {} - Enable logging output to vty terminals that have enabled logging - using the `terminal monitor` command. - By default, monitor logging is enabled at the debugging level, but this - command (or the deprecated `log trap` command) can be used to change - the monitor logging level. - If the optional second argument specifying the - logging level is not present, the default logging level (typically debugging, - but can be changed using the deprecated `log trap` command) will be used. - The `no` form of the command disables logging to terminal monitors. - -.. index:: Command {log facility `facility`} {} - -Command {log facility `facility`} {} -.. index:: Command {no log facility} {} - -Command {no log facility} {} - This command changes the facility used in syslog messages. The default - facility is `daemon`. The `no` form of the command resets - the facility to the default `daemon` facility. - -.. index:: Command {log record-priority} {} - -Command {log record-priority} {} -.. index:: Command {no log record-priority} {} - -Command {no log record-priority} {} - To include the severity in all messages logged to a file, to stdout, or to - a terminal monitor (i.e. anything except syslog), - use the `log record-priority` global configuration command. - To disable this option, use the `no` form of the command. By default, - the severity level is not included in logged messages. Note: some - versions of syslogd (including Solaris) can be configured to include - the facility and level in the messages emitted. - -.. index:: Command {log timestamp precision `<0-6>`} {} - -Command {log timestamp precision `<0-6>`} {} -.. index:: Command {no log timestamp precision} {} - -Command {no log timestamp precision} {} - This command sets the precision of log message timestamps to the - given number of digits after the decimal point. Currently, - the value must be in the range 0 to 6 (i.e. the maximum precision - is microseconds). - To restore the default behavior (1-second accuracy), use the - `no` form of the command, or set the precision explicitly to 0. +``[no] log timestamp precision [<0-6>]`` + This command sets the precision of log message timestamps to the given number + of digits after the decimal point. Currently, the value must be in the range + 0 to 6 (i.e. the maximum precision is microseconds). To restore the default + behavior (1-second accuracy), use the ``no`` form of the command, or set the + precision explicitly to 0. :: - @group - log timestamp precision 3 - @end group - + log timestamp precision 3 - In this example, the precision is set to provide timestamps with - millisecond accuracy. + In this example, the precision is set to provide timestamps with + millisecond accuracy. -.. index:: Command {log commands} {} +.. index:: log commands -Command {log commands} {} - This command enables the logging of all commands typed by a user to - all enabled log destinations. The note that logging includes full - command lines, including passwords. Once set, command logging can only - be turned off by restarting the daemon. +``log commands`` + This command enables the logging of all commands typed by a user to + all enabled log destinations. The note that logging includes full + command lines, including passwords. Once set, command logging can only + be turned off by restarting the daemon. -.. index:: Command {service password-encryption} {} +.. index:: service password-encryption -Command {service password-encryption} {} - Encrypt password. +``service password-encryption`` + Encrypt password. -.. index:: Command {service advanced-vty} {} +.. index:: service advanced-vty -Command {service advanced-vty} {} - Enable advanced mode VTY. +``service advanced-vty`` + Enable advanced mode VTY. -.. index:: Command {service terminal-length `<0-512>`} {} +.. index:: service terminal-length <0-512> -Command {service terminal-length `<0-512>`} {} - Set system wide line configuration. This configuration command applies - to all VTY interfaces. +``service terminal-length <0-512>`` + Set system wide line configuration. This configuration command applies + to all VTY interfaces. -.. index:: Command {line vty} {} +.. index:: line vty -Command {line vty} {} - Enter vty configuration mode. +``line vty`` + Enter vty configuration mode. -.. index:: Command {banner motd default} {} +.. index:: banner motd default -Command {banner motd default} {} - Set default motd string. +``banner motd default`` + Set default motd string. -.. index:: Command {no banner motd} {} +.. index:: no banner motd -Command {no banner motd} {} - No motd banner string will be printed. +``no banner motd`` + No motd banner string will be printed. -.. index:: {Line Command} {exec-timeout `minute`} {} +.. index:: exec-timeout MINUTE [SECOND] -{Line Command} {exec-timeout `minute`} {} -.. index:: {Line Command} {exec-timeout `minute` `second`} {} +``exec-timeout MINUTE [SECOND]`` + Set VTY connection timeout value. When only one argument is specified + it is used for timeout value in minutes. Optional second argument is + used for timeout value in seconds. Default timeout value is 10 minutes. + When timeout value is zero, it means no timeout. -{Line Command} {exec-timeout `minute` `second`} {} - Set VTY connection timeout value. When only one argument is specified - it is used for timeout value in minutes. Optional second argument is - used for timeout value in seconds. Default timeout value is 10 minutes. - When timeout value is zero, it means no timeout. +.. index:: no exec-timeout -.. index:: {Line Command} {no exec-timeout} {} +``no exec-timeout`` + Do not perform timeout at all. This command is as same as *exec-timeout 0 0*. -{Line Command} {no exec-timeout} {} - Do not perform timeout at all. This command is as same as - *exec-timeout 0 0*. +.. index:: access-class ACCESS-LIST -.. index:: {Line Command} {access-class `access-list`} {} - -{Line Command} {access-class `access-list`} {} - Restrict vty connections with an access list. +``access-class ACCESS-LIST`` + Restrict vty connections with an access list. .. _Sample_Config_File: @@ -275,7 +248,6 @@ Below is a sample configuration file for the zebra daemon. :: - @group ! ! Zebra configuration file ! @@ -286,17 +258,15 @@ Below is a sample configuration file for the zebra daemon. log stdout ! ! - @end group - -'!' and '#' are comment characters. If the first character of the word + +'!' and '#' are comment characters. If the first character of the word is one of the comment characters then from the rest of the line forward will be ignored as a comment. :: password zebra!password - If a comment character is not the first character of the word, it's a normal character. So in the above example '!' will not be regarded as a @@ -307,52 +277,52 @@ comment and the password is set to 'zebra!password'. Terminal Mode Commands ====================== -.. index:: Command {write terminal} {} +.. index:: write terminal -Command {write terminal} {} +``write terminal`` Displays the current configuration to the vty interface. -.. index:: Command {write file} {} +.. index:: write file -Command {write file} {} +``write file`` Write current configuration to configuration file. -.. index:: Command {configure terminal} {} +.. index:: configure terminal -Command {configure terminal} {} - Change to configuration mode. This command is the first step to +``configure terminal`` + Change to configuration mode. This command is the first step to configuration. -.. index:: Command {terminal length `<0-512>`} {} +.. index:: terminal length <0-512> -Command {terminal length `<0-512>`} {} - Set terminal display length to `<0-512>`. If length is 0, no +``terminal length <0-512>`` + Set terminal display length to ``<0-512>``. If length is 0, no display control is performed. -.. index:: Command {who} {} +.. index:: who -Command {who} {} +``who`` Show a list of currently connected vty sessions. -.. index:: Command {list} {} +.. index:: list -Command {list} {} +``list`` List all available commands. -.. index:: Command {show version} {} +.. index:: show version -Command {show version} {} +``show version`` Show the current version of @value{PACKAGE_NAME} and its build host information. -.. index:: Command {show logging} {} +.. index:: show logging -Command {show logging} {} - Shows the current configuration of the logging system. This includes +``show logging`` + Shows the current configuration of the logging system. This includes the status of all logging destinations. -.. index:: Command {logmsg `level` `message`} {} +.. index:: logmsg LEVEL MESSAGE -Command {logmsg `level` `message`} {} +``logmsg LEVEL MESSAGE`` Send a message to all logging destinations that are enabled for messages of the given severity. @@ -364,64 +334,46 @@ Common Invocation Options These options apply to all @value{PACKAGE_NAME} daemons. - -*-d* - -*--daemon* +``-d, --daemon`` Runs in daemon mode. -*-f `file`* - -*--config_file=`file`* +``-f file, --config_file=FILE`` Set configuration file name. -*-h* - -*--help* +``-h, --help`` Display this help and exit. -*-i `file`* - -*--pid_file=`file`* +``-i file, --pid_file=file`` Upon startup the process identifier of the daemon is written to a file, - typically in :file:`/var/run`. This file can be used by the init system - to implement commands such as *.../init.d/zebra status*, - *.../init.d/zebra restart* or @command{.../init.d/zebra - stop}. + typically in :file:`/var/run`. This file can be used by the init system + to implement commands such as ``.../init.d/zebra status``, + ``.../init.d/zebra restart`` or ``.../init.d/zebra stop``. The file name is an run-time option rather than a configure-time option - so that multiple routing daemons can be run simultaneously. This is - useful when using @value{PACKAGE_NAME} to implement a routing looking glass. One + so that multiple routing daemons can be run simultaneously. This is + useful when using @value{PACKAGE_NAME} to implement a routing looking glass. One machine can be used to collect differing routing views from differing points in the network. -*-A `address`* - -*--vty_addr=`address`* +``-A address, --vty_addr=address`` Set the VTY local address to bind to. If set, the VTY socket will only - be bound to this address. + be bound to this address. -*-P `port`* - -*--vty_port=`port`* +``-P port, --vty_port=port`` Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not be opened. -*-u `user`* - -*--vty_addr=`user`* +``-u user, --vty_addr=user`` Set the user and group to run as. -*-v* - -*--version* +``-v, --version`` Print program version. @@ -430,21 +382,18 @@ These options apply to all @value{PACKAGE_NAME} daemons. Loadable Module Support ======================= -FRR supports loading extension modules at startup. Loading, reloading or -unloading modules at runtime is not supported (yet). To load a module, use +FRR supports loading extension modules at startup. Loading, reloading or +unloading modules at runtime is not supported (yet). To load a module, use the following command line option at daemon startup: - -*-M `module:options`* - -*--module `module:options`* - Load the specified module, optionally passing options to it. If the module +``-M module:options, --module module:options`` + Load the specified module, optionally passing options to it. If the module name contains a slash (/), it is assumed to be a full pathname to a file to - be loaded. If it does not contain a slash, the + be loaded. If it does not contain a slash, the `@value{INSTALL_PREFIX_MODULES`} directory is searched for a module of - the given name; first with the daemon name prepended (e.g. `zebra_mod` - for `mod`), then without the daemon name prepended. + the given name; first with the daemon name prepended (e.g. ``zebra_mod`` + for ``mod``), then without the daemon name prepended. This option is available on all daemons, though some daemons may not have any modules available to be loaded. @@ -453,23 +402,23 @@ The SNMP Module --------------- If SNMP is enabled during compile-time and installed as part of the package, -the `snmp` module can be loaded for the *zebra*, -*bgpd*, *ospfd*, *ospf6d* and *ripd* daemons. +the ``snmp`` module can be loaded for the *zebra*, *bgpd*, *ospfd*, *ospf6d* +and *ripd* daemons. -The module ignores any options passed to it. Refer to :ref:`SNMP_Support` +The module ignores any options passed to it. Refer to :ref:`SNMP_Support` for information on its usage. The FPM Module -------------- If FPM is enabled during compile-time and installed as part of the package, -the `fpm` module can be loaded for the *zebra* daemon. This +the ``fpm`` module can be loaded for the *zebra* daemon. This provides the Forwarding Plane Manager ("FPM") API. -The module expects its argument to be either `netlink` or -`protobuf`, specifying the encapsulation to use. `netlink` is the +The module expects its argument to be either ``netlink`` or +``protobuf``, specifying the encapsulation to use. `netlink` is the default, and `protobuf` may not be available if the module was built -without protobuf support. Refer to :ref:`zebra_FIB_push_interface` for more +without protobuf support. Refer to :ref:`zebra_FIB_push_interface` for more information. .. _Virtual_Terminal_Interfaces: @@ -485,15 +434,14 @@ interface (CLI) for user interaction with the routing daemon. VTY Overview ------------ -VTY stands for Virtual TeletYpe interface. It means you can connect to +VTY stands for Virtual TeletYpe interface. It means you can connect to the daemon via the telnet protocol. -To enable a VTY interface, you have to setup a VTY password. If there +To enable a VTY interface, you have to setup a VTY password. If there is no VTY password, one cannot connect to the VTY interface at all. :: - @group % telnet localhost 2601 Trying 127.0.0.1... Connected to localhost. @@ -506,12 +454,13 @@ is no VTY password, one cannot connect to the VTY interface at all. Password: XXXXX Router> ? - enable Turn on privileged commands - exit Exit current mode and down to previous mode - help Description of the interactive help system - list Print command list - show Show running system information - who Display who is on a vty + enable . . . Turn on privileged commands + exit . . . Exit current mode and down to previous mode + help . . . Description of the interactive help system + list . . . Print command list + show . . . Show system inform + + wh. . . Display who is on a vty Router> enable Password: XXXXX Router# configure terminal @@ -519,10 +468,9 @@ is no VTY password, one cannot connect to the VTY interface at all. Router(config-if)# ip address 10.0.0.1/8 Router(config-if)# ^Z Router# - @end group - -'?' is very useful for looking up commands. + +:kbd:`?` is very useful for looking up commands. .. _VTY_Modes: @@ -572,41 +520,22 @@ CLI Movement Commands These commands are used for moving the CLI cursor. The :kbd:`C` character means press the Control Key. - - -*C-f* - -*:kbd:`RIGHT`* - @kindex C-f - @kindex :kbd:`RIGHT` +:kbd:`C-f` / :kbd:`LEFT` Move forward one character. - -*C-b* - -*:kbd:`LEFT`* - @kindex C-b - @kindex :kbd:`LEFT` +:kbd:`C-b` / :kbd:`RIGHT` Move backward one character. - -*M-f* - @kindex M-f +:kbd:`M-f` Move forward one word. - -*M-b* - @kindex M-b +:kbd:`M-b` Move backward one word. - -*C-a* - @kindex C-a +:kbd:`C-a` Move to the beginning of the line. - -*C-e* - @kindex C-e +:kbd:`C-e` Move to the end of the line. @@ -619,42 +548,31 @@ These commands are used for editing text on a line. The :kbd:`C` character means press the Control Key. - -*C-h* - -*:kbd:`DEL`* - @kindex C-h - @kindex :kbd:`DEL` +:kbd:`C-h` / :kbd:`DEL` Delete the character before point. -*C-d* - @kindex C-d +:kbd:`C-d` Delete the character after point. -*M-d* - @kindex M-d +:kbd:`M-d` Forward kill word. -*C-w* - @kindex C-w +:kbd:`C-w` Backward kill word. -*C-k* - @kindex C-k +:kbd:`C-k` Kill to the end of the line. -*C-u* - @kindex C-u +:kbd:`C-u` Kill line from the beginning, erasing input. -*C-t* - @kindex C-t +:kbd:`C-t` Transpose character. @@ -665,42 +583,28 @@ There are several additional CLI commands for command line completions, insta-help, and VTY session management. - -*C-c* - @kindex C-c +:kbd:`C-c` Interrupt current input and moves to the next line. -*C-z* - @kindex C-z +:kbd:`C-z` End current configuration session and move to top node. -*C-n* - -*:kbd:`DOWN`* - @kindex C-n - @kindex :kbd:`DOWN` +:kbd:`C-n` / :kbd:`DOWN` Move down to next line in the history buffer. -*C-p* - -*:kbd:`UP`* - @kindex C-p - @kindex :kbd:`UP` +:kbd:`C-p` / :kbd:`UP` Move up to previous line in the history buffer. -*TAB* - @kindex :kbd:`TAB` +:kbd:`TAB` Use command line completion by typing :kbd:`TAB`. -*?* - @kindex :kbd:`?` +:kbd:`?` You can use command line help by typing `help` at the beginning of - the line. Typing @kbd{?} at any point in the line will show possible + the line. Typing :kbd:`?` at any point in the line will show possible completions. - From 964b36623b38b9813cde1a8bf79ab9ced95305c1 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 12 Jan 2018 16:00:24 -0500 Subject: [PATCH 013/148] doc: make conf.py know about variable substitutions The old Texi docs had some Makefile-style variable substitutions they used to pull in information like release date, configured install path, etc. Sphinx has this ability as well, we start making use of it here. Signed-off-by: Quentin Young --- doc/user/conf.py | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/user/conf.py b/doc/user/conf.py index ebb8b828a1..d62e46301c 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -24,7 +24,10 @@ import re # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.0' + +# prolog for various variable substitutions +rst_prolog = '' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -36,7 +39,7 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] +# source_suffix = ['.rst'] source_suffix = '.rst' # The encoding of source files. @@ -59,6 +62,10 @@ version = u'?.?' # The full version, including alpha/beta/rc tags. release = u'?.?-?' +install_prefix_etc = "" + +# extract version information, installation location, other stuff we need to +# use when building final documents val = re.compile('^S\["([^"]+)"\]="(.*)"$') with open('../../config.status', 'r') as cfgstatus: for ln in cfgstatus.readlines(): @@ -67,6 +74,17 @@ with open('../../config.status', 'r') as cfgstatus: if m.group(1) == 'PACKAGE_VERSION': release = m.group(2) version = release.split('-')[0] + if m.group(1) == 'CFG_SYSCONF': + install_prefix_etc = m.group(2) + + +# add substitutions to prolog +rst_prolog += ''' +.. |INSTALL_PREFIX_ETC| replace:: {} +.. |PACKAGE_VERSION| replace:: {} +'''.format(install_prefix_etc, version) + + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. From c3c5a71ff6c3510312bd05d2e76e9710771abd31 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 16 Jan 2018 13:11:25 -0500 Subject: [PATCH 014/148] doc: fixup bgpd.rst Will probably need more cleanup. Signed-off-by: Quentin Young --- doc/user/bgp.rst | 1485 ++++++++++++++++++++++++---------------------- 1 file changed, 769 insertions(+), 716 deletions(-) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 81c55805be..9bc3b9a8af 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -4,15 +4,13 @@ BGP *** -@acronym{BGP} stands for a Border Gateway Protocol. The lastest BGP version -is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway -Protocols and de-fact standard of Inter Domain routing protocol. -BGP-4 is described in @cite{RFC1771, A Border Gateway Protocol -4 (BGP-4)}. +:abbr:`BGP` stands for a Border Gateway Protocol. The lastest BGP version is 4. +It is referred as BGP-4. BGP-4 is one of the Exterior Gateway Protocols and +de-fact standard of Inter Domain routing protocol. BGP-4 is described in +:t:`RFC1771, A Border Gateway Protocol 4 (BGP-4)`. -Many extensions have been added to @cite{RFC1771}. @cite{RFC2858, -Multiprotocol Extensions for BGP-4} provides multiprotocol support to -BGP-4. +Many extensions have been added to :t:`RFC1771`. :t:`RFC2858, Multiprotocol +Extensions for BGP-4` provides multiprotocol support to BGP-4. .. _Starting_BGP: @@ -21,10 +19,10 @@ Starting BGP Default configuration file of *bgpd* is :file:`bgpd.conf`. *bgpd* searches the current directory first then -@value{INSTALL_PREFIX_ETC}/bgpd.conf. All of bgpd's command must be +|INSTALL_PREFIX_ETC|/bgpd.conf. All of bgpd's command must be configured in :file:`bgpd.conf`. -*bgpd* specific invocation options are described below. Common +*bgpd* specific invocation options are described below. Common options may also be specified (:ref:`Common_Invocation_Options`). @@ -44,7 +42,7 @@ options may also be specified (:ref:`Common_Invocation_Options`). *-l* *--listenon* - Specify a specific IP address for bgpd to listen on, rather than its + Specify a specific IP address for bgpd to listen on, rather than its default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd to an internal address, or to run multiple bgpd processes on one host. @@ -55,50 +53,54 @@ BGP router ========== First of all you must configure BGP router with *router bgp* -command. To configure BGP router, you need AS number. AS number is an -identification of autonomous system. BGP protocol uses the AS number +command. To configure BGP router, you need AS number. AS number is an +identification of autonomous system. BGP protocol uses the AS number for detecting whether the BGP connection is internal one or external one. -.. index:: Command {router bgp `asn`} {} +.. index:: router bgp ASN -Command {router bgp `asn`} {} - Enable a BGP protocol process with the specified `asn`. After - this statement you can input any `BGP Commands`. You can not +``router bgp ASN`` + Enable a BGP protocol process with the specified `asn`. After + this statement you can input any `BGP Commands`. You can not create different BGP process under different `asn` without specifying `multiple-instance` (:ref:`Multiple_instance`). -.. index:: Command {no router bgp `asn`} {} +.. index:: no router bgp ASN -Command {no router bgp `asn`} {} +``no router bgp ASN`` Destroy a BGP protocol process with the specified `asn`. -.. index:: {BGP} {bgp router-id `A.B.C.D`} {} +.. index:: bgp router-id `A.B.C.D` -{BGP} {bgp router-id `A.B.C.D`} {} - This command specifies the router-ID. If *bgpd* connects to *zebra* it gets - interface and address information. In that case default router ID value - is selected as the largest IP Address of the interfaces. When +``bgp router-id `A.B.C.D``` + + This command specifies the router-ID. If *bgpd* connects to *zebra* it gets + interface and address information. In that case default router ID value + is selected as the largest IP Address of the interfaces. When `router zebra` is not enabled *bgpd* can't get interface information - so `router-id` is set to 0.0.0.0. So please set router-id by hand. + so `router-id` is set to 0.0.0.0. So please set router-id by hand. .. _BGP_distance: BGP distance ------------ -.. index:: {BGP} {distance bgp <1-255> <1-255> <1-255>} {} +.. index:: distance bgp <1-255> <1-255> <1-255> -{BGP} {distance bgp <1-255> <1-255> <1-255>} {} - This command change distance value of BGP. Each argument is distance +``distance bgp <1-255> <1-255> <1-255>`` + + This command change distance value of BGP. Each argument is distance value for external routes, internal routes and local routes. -.. index:: {BGP} {distance <1-255> `A.B.C.D/M`} {} +.. index:: distance <1-255> `A.B.C.D/M` -{BGP} {distance <1-255> `A.B.C.D/M`} {} -.. index:: {BGP} {distance <1-255> `A.B.C.D/M` `word`} {} +``distance <1-255> `A.B.C.D/M``` -{BGP} {distance <1-255> `A.B.C.D/M` `word`} {} - This command set distance value to +.. index:: distance <1-255> `A.B.C.D/M` `word` + +``distance <1-255> `A.B.C.D/M` `word``` + + This command set distance value to .. _BGP_decision_process: @@ -122,12 +124,12 @@ The decision process Frr BGP uses to select routes is as follows: *4. AS path length check* - Prefer shortest hop-count AS_PATHs. + Prefer shortest hop-count AS_PATHs. *5. Origin check* - Prefer the lowest origin type route. That is, prefer IGP origin routes to - EGP, to Incomplete routes. + Prefer the lowest origin type route. That is, prefer IGP origin routes to + EGP, to Incomplete routes. *6. MED check* @@ -154,20 +156,20 @@ The decision process Frr BGP uses to select routes is as follows: *10 Already-selected external check* Where both routes were received from eBGP peers, then prefer the route which - is already selected. Note that this check is not applied if :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent some cases + is already selected. Note that this check is not applied if :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent some cases of oscillation. *11. Router-ID check* - Prefer the route with the lowest @w{router-ID}. If the - route has an @w{ORIGINATOR_ID} attribute, through iBGP reflection, then that - router ID is used, otherwise the @w{router-ID} of the peer the route was + Prefer the route with the lowest `router-ID`. If the + route has an `ORIGINATOR_ID` attribute, through iBGP reflection, then that + router ID is used, otherwise the `router-ID` of the peer the route was received from is used. *12. Cluster-List length check* The route with the shortest cluster-list - length is used. The cluster-list reflects the iBGP reflection path the + length is used. The cluster-list reflects the iBGP reflection path the route has taken. @@ -176,25 +178,28 @@ The decision process Frr BGP uses to select routes is as follows: transport layer address, as a last-resort tie-breaker. -.. index:: {BGP} {bgp bestpath as-path confed} {} +.. index:: bgp bestpath as-path confed + +``bgp bestpath as-path confed`` -{BGP} {bgp bestpath as-path confed} {} This command specifies that the length of confederation path sets and sequences should should be taken into account during the BGP best path decision process. -.. index:: {BGP} {bgp bestpath as-path multipath-relax} {} +.. index:: bgp bestpath as-path multipath-relax + +``bgp bestpath as-path multipath-relax`` -{BGP} {bgp bestpath as-path multipath-relax} {} .. _bgp_bestpath_as-path_multipath-relax: This command specifies that BGP decision process should consider paths of equal AS_PATH length candidates for multipath computation. Without the knob, the entire AS_PATH must match for multipath computation. -.. index:: {BGP} {bgp bestpath compare-routerid} {} +.. index:: bgp bestpath compare-routerid + +``bgp bestpath compare-routerid`` -{BGP} {bgp bestpath compare-routerid} {} .. _bgp_bestpath_compare-routerid: Ensure that when comparing routes where both are equal on most metrics, @@ -204,15 +209,15 @@ The decision process Frr BGP uses to select routes is as follows: If this option is enabled, then the already-selected check, where already selected eBGP routes are preferred, is skipped. - If a route has an @w{ORIGINATOR_ID} attribute because it has been reflected, - that @w{ORIGINATOR_ID} will be used. Otherwise, the router-ID of the peer the + If a route has an `ORIGINATOR_ID` attribute because it has been reflected, + that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the route was received from will be used. The advantage of this is that the route-selection (at this point) will be - more deterministic. The disadvantage is that a few or even one lowest-ID + more deterministic. The disadvantage is that a few or even one lowest-ID router may attract all trafic to otherwise-equal paths because of this - check. It may increase the possibility of MED or IGP oscillation, unless - other measures were taken to avoid these. The exact behaviour will be + check. It may increase the possibility of MED or IGP oscillation, unless + other measures were taken to avoid these. The exact behaviour will be sensitive to the iBGP and reflection topology. @@ -221,9 +226,10 @@ The decision process Frr BGP uses to select routes is as follows: BGP route flap dampening ------------------------ -.. index:: {BGP} {bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>`} {} +.. index:: bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>` + +``bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>``` -{BGP} {bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>`} {} This command enables BGP route-flap dampening and specifies dampening parameters. @@ -240,7 +246,7 @@ BGP route flap dampening *@asis{max-suppress}* Maximum duration to suppress a stable route - The route-flap damping algorithm is compatible with @cite{RFC2439}. The use of this command + The route-flap damping algorithm is compatible with :t:`RFC2439`. The use of this command is not recommended nowadays, see `http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 `_. .. _BGP_MED: @@ -249,33 +255,33 @@ BGP MED ======= The BGP MED (Multi_Exit_Discriminator) attribute has properties which can -cause subtle convergence problems in BGP. These properties and problems +cause subtle convergence problems in BGP. These properties and problems have proven to be hard to understand, at least historically, and may still -not be widely understood. The following attempts to collect together and +not be widely understood. The following attempts to collect together and present what is known about MED, to help operators and Frr users in designing and configuring their networks. -The BGP @acronym{MED, Multi_Exit_Discriminator} attribute is intended to +The BGP :abbr:`MED ( Multi_Exit_Discriminator)` attribute is intended to allow one AS to indicate its preferences for its ingress points to another -AS. The MED attribute will not be propagated on to another AS by the +AS. The MED attribute will not be propagated on to another AS by the receiving AS - it is 'non-transitive' in the BGP sense. E.g., if AS X and AS Y have 2 different BGP peering points, then AS X might set a MED of 100 on routes advertised at one and a MED of 200 at the -other. When AS Y selects between otherwise equal routes to or via +other. When AS Y selects between otherwise equal routes to or via AS X, AS Y should prefer to take the path via the lower MED peering of 100 with -AS X. Setting the MED allows an AS to influence the routing taken to it +AS X. Setting the MED allows an AS to influence the routing taken to it within another, neighbouring AS. In this use of MED it is not really meaningful to compare the MED value on -routes where the next AS on the paths differs. E.g., if AS Y also had a +routes where the next AS on the paths differs. E.g., if AS Y also had a route for some destination via AS Z in addition to the routes from AS X, and AS Z had also set a MED, it wouldn't make sense for AS Y to compare AS Z's -MED values to those of AS X. The MED values have been set by different +MED values to those of AS X. The MED values have been set by different administrators, with different frames of reference. The default behaviour of BGP therefore is to not compare MED values across -routes received from different neighbouring ASes. In Frr this is done by +routes received from different neighbouring ASes. In Frr this is done by comparing the neighbouring, left-most AS in the received AS_PATHs of the routes and only comparing MED if those are the same. @@ -288,73 +294,73 @@ routes and only comparing MED if those are the same. Unfortunately, this behaviour of MED, of sometimes being compared across routes and sometimes not, depending on the properties of those other routes, means MED can cause the order of preference over all the routes to be -undefined. That is, given routes A, B, and C, if A is preferred to B, and B +undefined. That is, given routes A, B, and C, if A is preferred to B, and B is preferred to C, then a well-defined order should mean the preference is transitive (in the sense of orders @footnote{For some set of objects to have an order, there *must* be some binary ordering relation that is defined for *every* combination of those objects, and that relation *must* -be transitive. I.e.@:, if the relation operator is @mprec{}, and if +be transitive. I.e.@:, if the relation operator is @mprec{}, and if a @mprec{} b and b @mprec{} c then that relation must carry over and it *must* be that a @mprec{} c for the objects to have an -order. The ordering relation may allow for equality, i.e. +order. The ordering relation may allow for equality, i.e. a @mprec{} b and b @mprec{} a may both be true amd imply that a and b are equal in the order and not distinguished by it, in -which case the set has a partial order. Otherwise, if there is an order, +which case the set has a partial order. Otherwise, if there is an order, all the objects have a distinct place in the order and the set has a total order.}) and that A would be preferred to C. -However, when MED is involved this need not be the case. With MED it is -possible that C is actually preferred over A. So A is preferred to B, B is -preferred to C, but C is preferred to A. This can be true even where BGP +However, when MED is involved this need not be the case. With MED it is +possible that C is actually preferred over A. So A is preferred to B, B is +preferred to C, but C is preferred to A. This can be true even where BGP defines a deterministic 'most preferred' route out of the full set of -A,B,C. With MED, for any given set of routes there may be a +A,B,C. With MED, for any given set of routes there may be a deterministically preferred route, but there need not be any way to arrange -them into any order of preference. With unmodified MED, the order of +them into any order of preference. With unmodified MED, the order of preference of routes literally becomes undefined. -That MED can induce non-transitive preferences over routes can cause issues. +That MED can induce non-transitive preferences over routes can cause issues. Firstly, it may be perceived to cause routing table churn locally at speakers; secondly, and more seriously, it may cause routing instability in iBGP topologies, where sets of speakers continually oscillate between different paths. -The first issue arises from how speakers often implement routing decisions. +The first issue arises from how speakers often implement routing decisions. Though BGP defines a selection process that will deterministically select the same route as best at any given speaker, even with MED, that process -requires evaluating all routes together. For performance and ease of +requires evaluating all routes together. For performance and ease of implementation reasons, many implementations evaluate route preferences in a -pair-wise fashion instead. Given there is no well-defined order when MED is +pair-wise fashion instead. Given there is no well-defined order when MED is involved, the best route that will be chosen becomes subject to -implementation details, such as the order the routes are stored in. That +implementation details, such as the order the routes are stored in. That may be (locally) non-deterministic, e.g.@: it may be the order the routes -were received in. +were received in. This indeterminism may be considered undesirable, though it need not cause -problems. It may mean additional routing churn is perceived, as sometimes +problems. It may mean additional routing churn is perceived, as sometimes more updates may be produced than at other times in reaction to some event . This first issue can be fixed with a more deterministic route selection that -ensures routes are ordered by the neighbouring AS during selection. -:ref:`bgp_deterministic-med`. This may reduce the number of updates as -routes are received, and may in some cases reduce routing churn. Though, it +ensures routes are ordered by the neighbouring AS during selection. +:ref:`bgp_deterministic-med`. This may reduce the number of updates as +routes are received, and may in some cases reduce routing churn. Though, it could equally deterministically produce the largest possible set of updates in response to the most common sequence of received updates. A deterministic order of evaluation tends to imply an additional overhead of -sorting over any set of n routes to a destination. The implementation of +sorting over any set of n routes to a destination. The implementation of deterministic MED in Frr scales significantly worse than most sorting -algorithms at present, with the number of paths to a given destination. +algorithms at present, with the number of paths to a given destination. That number is often low enough to not cause any issues, but where there are many paths, the deterministic comparison may quickly become increasingly expensive in terms of CPU. Deterministic local evaluation can *not* fix the second, more major, -issue of MED however. Which is that the non-transitive preference of routes +issue of MED however. Which is that the non-transitive preference of routes MED can cause may lead to routing instability or oscillation across multiple -speakers in iBGP topologies. This can occur with full-mesh iBGP, but is +speakers in iBGP topologies. This can occur with full-mesh iBGP, but is particularly problematic in non-full-mesh iBGP topologies that further -reduce the routing information known to each speaker. This has primarily -been documented with iBGP route-reflection topologies. However, any +reduce the routing information known to each speaker. This has primarily +been documented with iBGP route-reflection topologies. However, any route-hiding technologies potentially could also exacerbate oscillation with MED. @@ -362,35 +368,35 @@ This second issue occurs where speakers each have only a subset of routes, and there are cycles in the preferences between different combinations of routes - as the undefined order of preference of MED allows - and the routes are distributed in a way that causes the BGP speakers to 'chase' those -cycles. This can occur even if all speakers use a deterministic order of +cycles. This can occur even if all speakers use a deterministic order of evaluation in route selection. E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and from speaker 3 in AS Y; while speaker 5 in AS A might receive that route -from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 +from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 at speaker 3. I.e, using ASN:ID:MED to label the speakers: :: - /---------------\\ + /---------------\\ X:2------|--A:4-------A:5--|-Y:1:200 - Y:3:100--|-/ | - \\---------------/ + Y:3:100--|-/ | + \\---------------/ + - Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then based on the RFC4271 decision process speaker 4 will choose X:2 over -Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. +Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. Speaker 5 will continue to prefer Y:1:200 based on the ID, and advertise -this to speaker 4. Speaker 4 will now have the full set of routes, and the +this to speaker 4. Speaker 4 will now have the full set of routes, and the Y:1:200 it receives from 5 will beat X:2, but when speaker 4 compares Y:1:200 to Y:3:100 the MED check now becomes active as the ASes match, and -now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5, +now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5, which will also agrees that Y:3:100 is preferred to Y:1:200, and so -withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100, +withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100, and X:2 beats Y:3:100, and so speaker 4 implicitly updates its route to -speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID, +speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID, and advertises Y:1:200 to speaker 4, and the cycle continues. The root cause is the lack of a clear order of preference caused by how MED @@ -399,28 +405,28 @@ preferences between the routes: :: - /---> X:2 ---beats---> Y:3:100 --\\ - | | - | | - \\---beats--- Y:1:200 <---beats---/ + /---> X:2 ---beats---> Y:3:100 --\\ + | | + | | + \\---beats--- Y:1:200 <---beats---/ + - This particular type of oscillation in full-mesh iBGP topologies can be avoided by speakers preferring already selected, external routes rather than -choosing to update to new a route based on a post-MED metric (e.g. -router-ID), at the cost of a non-deterministic selection process. Frr +choosing to update to new a route based on a post-MED metric (e.g. +router-ID), at the cost of a non-deterministic selection process. Frr implements this, as do many other implementations, so long as it is not overridden by setting :ref:`bgp_bestpath_compare-routerid`, and see also :ref:`BGP_decision_process`, . However, more complex and insidious cycles of oscillation are possible with -iBGP route-reflection, which are not so easily avoided. These have been -documented in various places. See, e.g., @cite{McPherson, D. and Gill, V. +iBGP route-reflection, which are not so easily avoided. These have been +documented in various places. See, e.g., @cite{McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation -Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable -and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong, -"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete +Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable +and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong, +"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete examples and further references. There is as of this writing *no* known way to use MED for its original @@ -431,10 +437,10 @@ networks. There may be iBGP topology specific ways to reduce the instability risks, even while using MED, e.g.@: by constraining the reflection topology and by -tuning IGP costs between route-reflector clusters, see RFC3345 for details. +tuning IGP costs between route-reflector clusters, see RFC3345 for details. In the near future, the Add-Path extension to BGP may also solve MED oscillation while still allowing MED to be used as intended, by distributing -"best-paths per neighbour AS". This would be at the cost of distributing at +"best-paths per neighbour AS". This would be at the cost of distributing at least as many routes to all speakers as a full-mesh iBGP would, if not more, while also imposing similar CPU overheads as the "Deterministic MED" feature at each Add-Path reflector. @@ -443,12 +449,12 @@ More generally, the instability problems that MED can introduce on more complex, non-full-mesh, iBGP topologies may be avoided either by: -* +* Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared across values set by different neighbour ASes, which may not produce coherent desirable results, of itself. -* +* Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using :ref:`routemap_set_metric` on all received routes, in combination with setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest @@ -458,30 +464,31 @@ complex, non-full-mesh, iBGP topologies may be avoided either by: As MED is evaluated after the AS_PATH length check, another possible use for MED is for intra-AS steering of routes with equal AS_PATH length, as an -extension of the last case above. As MED is evaluated before IGP metric, +extension of the last case above. As MED is evaluated before IGP metric, this can allow cold-potato routing to be implemented to send traffic to preferred hand-offs with neighbours, rather than the closest hand-off according to the IGP metric. Note that even if action is taken to address the MED non-transitivity -issues, other oscillations may still be possible. E.g., on IGP cost if +issues, other oscillations may still be possible. E.g., on IGP cost if iBGP and IGP topologies are at cross-purposes with each other - see the -Flavel and Roughan paper above for an example. Hence the guideline that the +Flavel and Roughan paper above for an example. Hence the guideline that the iBGP topology should follow the IGP topology. -.. index:: {BGP} {bgp deterministic-med} {} +.. index:: bgp deterministic-med + +``bgp deterministic-med`` -{BGP} {bgp deterministic-med} {} .. _bgp_deterministic-med: Carry out route-selection in way that produces deterministic answers locally, even in the face of MED and the lack of a well-defined order of - preference it can induce on routes. Without this option the preferred route + preference it can induce on routes. Without this option the preferred route with MED may be determined largely by the order that routes were received in. Setting this option will have a performance cost that may be noticeable when - there are many routes for each destination. Currently in Frr it is + there are many routes for each destination. Currently in Frr it is implemented in a way that scales poorly as the number of routes per destination increases. @@ -491,13 +498,14 @@ Note that there are other sources of indeterminism in the route selection process, specifically, the preference for older and already selected routes from eBGP peers, :ref:`BGP_decision_process`. -.. index:: {BGP} {bgp always-compare-med} {} +.. index:: bgp always-compare-med + +``bgp always-compare-med`` -{BGP} {bgp always-compare-med} {} .. _bgp_always-compare-med: Always compare the MED on routes, even when they were received from - different neighbouring ASes. Setting this option makes the order of + different neighbouring ASes. Setting this option makes the order of preference of routes more defined, and should eliminate MED induced oscillations. @@ -518,94 +526,106 @@ BGP network BGP route --------- -.. index:: {BGP} {network `A.B.C.D/M`} {} +.. index:: network `A.B.C.D/M` + +``network `A.B.C.D/M``` -{BGP} {network `A.B.C.D/M`} {} This command adds the announcement network.:: - @group router bgp 1 address-family ipv4 unicast network 10.0.0.0/8 exit-address-family - @end group - + This configuration example says that network 10.0.0.0/8 will be - announced to all neighbors. Some vendors' routers don't advertise + announced to all neighbors. Some vendors' routers don't advertise routes if they aren't present in their IGP routing tables; `bgpd` doesn't care about IGP routes when announcing its routes. -.. index:: {BGP} {no network `A.B.C.D/M`} {} +.. index:: no network `A.B.C.D/M` + +``no network `A.B.C.D/M``` -{BGP} {no network `A.B.C.D/M`} {} .. _Route_Aggregation: Route Aggregation ----------------- -.. index:: {BGP} {aggregate-address `A.B.C.D/M`} {} +.. index:: aggregate-address `A.B.C.D/M` + +``aggregate-address `A.B.C.D/M``` -{BGP} {aggregate-address `A.B.C.D/M`} {} This command specifies an aggregate address. -.. index:: {BGP} {aggregate-address `A.B.C.D/M` as-set} {} +.. index:: aggregate-address `A.B.C.D/M` as-set -{BGP} {aggregate-address `A.B.C.D/M` as-set} {} - This command specifies an aggregate address. Resulting routes include +``aggregate-address `A.B.C.D/M` as-set`` + + This command specifies an aggregate address. Resulting routes include AS set. -.. index:: {BGP} {aggregate-address `A.B.C.D/M` summary-only} {} +.. index:: aggregate-address `A.B.C.D/M` summary-only -{BGP} {aggregate-address `A.B.C.D/M` summary-only} {} - This command specifies an aggregate address. Aggreated routes will +``aggregate-address `A.B.C.D/M` summary-only`` + + This command specifies an aggregate address. Aggreated routes will not be announce. -.. index:: {BGP} {no aggregate-address `A.B.C.D/M`} {} +.. index:: no aggregate-address `A.B.C.D/M` + +``no aggregate-address `A.B.C.D/M``` -{BGP} {no aggregate-address `A.B.C.D/M`} {} .. _Redistribute_to_BGP: Redistribute to BGP ------------------- -.. index:: {BGP} {redistribute kernel} {} +.. index:: redistribute kernel + +``redistribute kernel`` -{BGP} {redistribute kernel} {} Redistribute kernel route to BGP process. -.. index:: {BGP} {redistribute static} {} +.. index:: redistribute static + +``redistribute static`` -{BGP} {redistribute static} {} Redistribute static route to BGP process. -.. index:: {BGP} {redistribute connected} {} +.. index:: redistribute connected + +``redistribute connected`` -{BGP} {redistribute connected} {} Redistribute connected route to BGP process. -.. index:: {BGP} {redistribute rip} {} +.. index:: redistribute rip + +``redistribute rip`` -{BGP} {redistribute rip} {} Redistribute RIP route to BGP process. -.. index:: {BGP} {redistribute ospf} {} +.. index:: redistribute ospf + +``redistribute ospf`` -{BGP} {redistribute ospf} {} Redistribute OSPF route to BGP process. -.. index:: {BGP} {redistribute vpn} {} +.. index:: redistribute vpn + +``redistribute vpn`` -{BGP} {redistribute vpn} {} Redistribute VNC routes to BGP process. -.. index:: {BGP} {update-delay `max-delay`} {} +.. index:: update-delay `max-delay` -{BGP} {update-delay `max-delay`} {} -.. index:: {BGP} {update-delay `max-delay` `establish-wait`} {} +``update-delay `max-delay``` + +.. index:: update-delay `max-delay` `establish-wait` + +``update-delay `max-delay` `establish-wait``` -{BGP} {update-delay `max-delay` `establish-wait`} {} This feature is used to enable read-only mode on BGP process restart or when BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only mode would begin as soon as the first peer reaches Established status and a timer @@ -627,9 +647,10 @@ Redistribute to BGP Default max-delay is 0, i.e. the feature is off by default. -.. index:: {BGP} {table-map `route-map-name`} {} +.. index:: table-map `route-map-name` + +``table-map `route-map-name``` -{BGP} {table-map `route-map-name`} {} This feature is used to apply a route-map on route updates from BGP to Zebra. All the applicable match operations are allowed, such as match on prefix, next-hop, communities, etc. Set operations for this attach-point are limited @@ -650,17 +671,16 @@ BGP Peer Defining Peer ------------- -.. index:: {BGP} {neighbor `peer` remote-as `asn`} {} +.. index:: neighbor `peer` remote-as `asn` -{BGP} {neighbor `peer` remote-as `asn`} {} - Creates a new neighbor whose remote-as is `asn`. `peer` +``neighbor `peer` remote-as `asn``` + + Creates a new neighbor whose remote-as is `asn`. `peer` can be an IPv4 address or an IPv6 address.:: - @group router bgp 1 neighbor 10.0.0.1 remote-as 2 - @end group - + In this case my router, in AS-1, is trying to peer with AS-2 at 10.0.0.1. @@ -668,7 +688,7 @@ Defining Peer If the remote-as is not specified, *bgpd* will complain like this::: can't find neighbor 10.0.0.1 - + .. _BGP_Peer_commands: @@ -678,188 +698,218 @@ BGP Peer commands In a `router bgp` clause there are neighbor specific configurations required. -.. index:: {BGP} {neighbor `peer` shutdown} {} +.. index:: neighbor `peer` shutdown -{BGP} {neighbor `peer` shutdown} {} -.. index:: {BGP} {no neighbor `peer` shutdown} {} +``neighbor `peer` shutdown`` -{BGP} {no neighbor `peer` shutdown} {} - Shutdown the peer. We can delete the neighbor's configuration by +.. index:: no neighbor `peer` shutdown + +``no neighbor `peer` shutdown`` + + Shutdown the peer. We can delete the neighbor's configuration by `no neighbor `peer` remote-as @var{as-number`} but all - configuration of the neighbor will be deleted. When you want to + configuration of the neighbor will be deleted. When you want to preserve the configuration, but want to drop the BGP peer, use this syntax. -.. index:: {BGP} {neighbor `peer` ebgp-multihop} {} +.. index:: neighbor `peer` ebgp-multihop -{BGP} {neighbor `peer` ebgp-multihop} {} -.. index:: {BGP} {no neighbor `peer` ebgp-multihop} {} +``neighbor `peer` ebgp-multihop`` -{BGP} {no neighbor `peer` ebgp-multihop} {} -.. index:: {BGP} {neighbor `peer` description ...} {} +.. index:: no neighbor `peer` ebgp-multihop -{BGP} {neighbor `peer` description ...} {} -.. index:: {BGP} {no neighbor `peer` description ...} {} +``no neighbor `peer` ebgp-multihop`` -{BGP} {no neighbor `peer` description ...} {} - Set description of the peer. +.. index:: neighbor `peer` description ... -.. index:: {BGP} {neighbor `peer` version `version`} {} +``neighbor `peer` description ...`` -{BGP} {neighbor `peer` version `version`} {} - Set up the neighbor's BGP version. `version` can be `4`, - `4+` or `4-`. BGP version `4` is the default value used for - BGP peering. BGP version `4+` means that the neighbor supports - Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but - the neighbor speaks the old Internet-Draft revision 00's Multiprotocol - Extensions for BGP-4. Some routing software is still using this - version. +.. index:: no neighbor `peer` description ... -.. index:: {BGP} {neighbor `peer` interface `ifname`} {} +``no neighbor `peer` description ...`` -{BGP} {neighbor `peer` interface `ifname`} {} -.. index:: {BGP} {no neighbor `peer` interface `ifname`} {} + Set description of the peer. -{BGP} {no neighbor `peer` interface `ifname`} {} - When you connect to a BGP peer over an IPv6 link-local address, you - have to specify the `ifname` of the interface used for the - connection. To specify IPv4 session addresses, see the - `neighbor `peer` update-source` command below. +.. index:: neighbor `peer` version `version` - This command is deprecated and may be removed in a future release. Its - use should be avoided. +``neighbor `peer` version `version``` -.. index:: {BGP} {neighbor `peer` next-hop-self [all]} {} + Set up the neighbor's BGP version. `version` can be `4`, + `4+` or `4-`. BGP version `4` is the default value used for + BGP peering. BGP version `4+` means that the neighbor supports + Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but + the neighbor speaks the old Internet-Draft revision 00's Multiprotocol + Extensions for BGP-4. Some routing software is still using this + version. -{BGP} {neighbor `peer` next-hop-self [all]} {} -.. index:: {BGP} {no neighbor `peer` next-hop-self [all]} {} +.. index:: neighbor `peer` interface `ifname` -{BGP} {no neighbor `peer` next-hop-self [all]} {} - This command specifies an announced route's nexthop as being equivalent - to the address of the bgp router if it is learned via eBGP. - If the optional keyword `all` is specified the modifiation is done - also for routes learned via iBGP. +``neighbor `peer` interface `ifname``` -.. index:: {BGP} {neighbor `peer` update-source ``} {} +.. index:: no neighbor `peer` interface `ifname` -{BGP} {neighbor `peer` update-source ``} {} -.. index:: {BGP} {no neighbor `peer` update-source} {} +``no neighbor `peer` interface `ifname``` -{BGP} {no neighbor `peer` update-source} {} - Specify the IPv4 source address to use for the @acronym{BGP} session to this - neighbour, may be specified as either an IPv4 address directly or - as an interface name (in which case the *zebra* daemon MUST be running - in order for *bgpd* to be able to retrieve interface state).:: + When you connect to a BGP peer over an IPv6 link-local address, you + have to specify the `ifname` of the interface used for the + connection. To specify IPv4 session addresses, see the + `neighbor `peer` update-source` command below. - @group - router bgp 64555 - neighbor foo update-source 192.168.0.1 - neighbor bar update-source lo0 - @end group - + This command is deprecated and may be removed in a future release. Its + use should be avoided. -.. index:: {BGP} {neighbor `peer` default-originate} {} +.. index:: neighbor `peer` next-hop-self [all] -{BGP} {neighbor `peer` default-originate} {} -.. index:: {BGP} {no neighbor `peer` default-originate} {} +``neighbor `peer` next-hop-self [all]`` -{BGP} {no neighbor `peer` default-originate} {} - *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it - is in routing table. When you want to announce default routes to the - peer, use this command. +.. index:: no neighbor `peer` next-hop-self [all] -.. index:: {BGP} {neighbor `peer` port `port`} {} +``no neighbor `peer` next-hop-self [all]`` -{BGP} {neighbor `peer` port `port`} {} -.. index:: {BGP} {neighbor `peer` port `port`} {} + This command specifies an announced route's nexthop as being equivalent + to the address of the bgp router if it is learned via eBGP. + If the optional keyword `all` is specified the modifiation is done + also for routes learned via iBGP. -{BGP} {neighbor `peer` port `port`} {} -.. index:: {BGP} {neighbor `peer` send-community} {} +.. index:: neighbor `peer` update-source `` -{BGP} {neighbor `peer` send-community} {} -.. index:: {BGP} {neighbor `peer` send-community} {} +``neighbor `peer` update-source ```` -{BGP} {neighbor `peer` send-community} {} -.. index:: {BGP} {neighbor `peer` weight `weight`} {} +.. index:: no neighbor `peer` update-source -{BGP} {neighbor `peer` weight `weight`} {} -.. index:: {BGP} {no neighbor `peer` weight `weight`} {} +``no neighbor `peer` update-source`` -{BGP} {no neighbor `peer` weight `weight`} {} - This command specifies a default `weight` value for the neighbor's - routes. + Specify the IPv4 source address to use for the :abbr:`BGP` session to this + neighbour, may be specified as either an IPv4 address directly or + as an interface name (in which case the *zebra* daemon MUST be running + in order for *bgpd* to be able to retrieve interface state).:: -.. index:: {BGP} {neighbor `peer` maximum-prefix `number`} {} + router bgp 64555 + neighbor foo update-source 192.168.0.1 + neighbor bar update-source lo0 -{BGP} {neighbor `peer` maximum-prefix `number`} {} -.. index:: {BGP} {no neighbor `peer` maximum-prefix `number`} {} -{BGP} {no neighbor `peer` maximum-prefix `number`} {} -.. index:: {BGP} {neighbor `peer` local-as `as-number`} {} +.. index:: neighbor `peer` default-originate -{BGP} {neighbor `peer` local-as `as-number`} {} -.. index:: {BGP} {neighbor `peer` local-as `as-number` no-prepend} {} +``neighbor `peer` default-originate`` -{BGP} {neighbor `peer` local-as `as-number` no-prepend} {} -.. index:: {BGP} {neighbor `peer` local-as `as-number` no-prepend replace-as} {} +.. index:: no neighbor `peer` default-originate -{BGP} {neighbor `peer` local-as `as-number` no-prepend replace-as} {} -.. index:: {BGP} {no neighbor `peer` local-as} {} +``no neighbor `peer` default-originate`` -{BGP} {no neighbor `peer` local-as} {} - Specify an alternate AS for this BGP process when interacting with the - specified peer. With no modifiers, the specified local-as is prepended to - the received AS_PATH when receiving routing updates from the peer, and - prepended to the outgoing AS_PATH (after the process local AS) when - transmitting local routes to the peer. + *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it + is in routing table. When you want to announce default routes to the + peer, use this command. - If the no-prepend attribute is specified, then the supplied local-as is not - prepended to the received AS_PATH. +.. index:: neighbor `peer` port `port` - If the replace-as attribute is specified, then only the supplied local-as is - prepended to the AS_PATH when transmitting local-route updates to this peer. +``neighbor `peer` port `port``` - Note that replace-as can only be specified if no-prepend is. +.. index:: neighbor `peer` port `port` - This command is only allowed for eBGP peers. +``neighbor `peer` port `port``` -.. index:: {BGP} {neighbor `peer` ttl-security hops `number`} {} +.. index:: neighbor `peer` send-community -{BGP} {neighbor `peer` ttl-security hops `number`} {} -.. index:: {BGP} {no neighbor `peer` ttl-security hops `number`} {} +``neighbor `peer` send-community`` -{BGP} {no neighbor `peer` ttl-security hops `number`} {} - This command enforces Generalized TTL Security Mechanism (GTSM), as - specified in RFC 5082. With this command, only neighbors that are the - specified number of hops away will be allowed to become neighbors. This - command is mututally exclusive with *ebgp-multihop*. +.. index:: neighbor `peer` send-community + +``neighbor `peer` send-community`` + +.. index:: neighbor `peer` weight `weight` + +``neighbor `peer` weight `weight``` + +.. index:: no neighbor `peer` weight `weight` + +``no neighbor `peer` weight `weight``` + + This command specifies a default `weight` value for the neighbor's + routes. + +.. index:: neighbor `peer` maximum-prefix `number` + +``neighbor `peer` maximum-prefix `number``` + +.. index:: no neighbor `peer` maximum-prefix `number` + +``no neighbor `peer` maximum-prefix `number``` + +.. index:: neighbor `peer` local-as `as-number` + +``neighbor `peer` local-as `as-number``` + +.. index:: neighbor `peer` local-as `as-number` no-prepend + +``neighbor `peer` local-as `as-number` no-prepend`` + +.. index:: neighbor `peer` local-as `as-number` no-prepend replace-as + +``neighbor `peer` local-as `as-number` no-prepend replace-as`` + +.. index:: no neighbor `peer` local-as + +``no neighbor `peer` local-as`` + + Specify an alternate AS for this BGP process when interacting with the + specified peer. With no modifiers, the specified local-as is prepended to + the received AS_PATH when receiving routing updates from the peer, and + prepended to the outgoing AS_PATH (after the process local AS) when + transmitting local routes to the peer. + + If the no-prepend attribute is specified, then the supplied local-as is not + prepended to the received AS_PATH. + + If the replace-as attribute is specified, then only the supplied local-as is + prepended to the AS_PATH when transmitting local-route updates to this peer. + + Note that replace-as can only be specified if no-prepend is. + + This command is only allowed for eBGP peers. + +.. index:: neighbor `peer` ttl-security hops `number` + +``neighbor `peer` ttl-security hops `number``` + +.. index:: no neighbor `peer` ttl-security hops `number` + +``no neighbor `peer` ttl-security hops `number``` + + This command enforces Generalized TTL Security Mechanism (GTSM), as + specified in RFC 5082. With this command, only neighbors that are the + specified number of hops away will be allowed to become neighbors. This + command is mututally exclusive with *ebgp-multihop*. .. _Peer_filtering: Peer filtering -------------- -.. index:: {BGP} {neighbor `peer` distribute-list `name` [in|out]} {} +.. index:: neighbor `peer` distribute-list `name` [in|out] -{BGP} {neighbor `peer` distribute-list `name` [in|out]} {} - This command specifies a distribute-list for the peer. `direct` is +``neighbor `peer` distribute-list `name` [in|out]`` + + This command specifies a distribute-list for the peer. `direct` is @samp{in} or @samp{out}. -.. index:: {BGP command} {neighbor `peer` prefix-list `name` [in|out]} {} +.. index:: neighbor PEER prefix-list NAME [in|out] -{BGP command} {neighbor `peer` prefix-list `name` [in|out]} {} -.. index:: {BGP command} {neighbor `peer` filter-list `name` [in|out]} {} +``neighbor PEER prefix-list NAME [in|out]`` +.. index:: neighbor PEER filter-list NAME [in|out] -{BGP command} {neighbor `peer` filter-list `name` [in|out]} {} -.. index:: {BGP} {neighbor `peer` route-map `name` [in|out]} {} +``neighbor PEER filter-list NAME [in|out]`` +.. index:: neighbor `peer` route-map `name` [in|out] -{BGP} {neighbor `peer` route-map `name` [in|out]} {} - Apply a route-map on the neighbor. `direct` must be `in` or +``neighbor `peer` route-map `name` [in|out]`` + + Apply a route-map on the neighbor. `direct` must be `in` or `out`. -.. index:: {BGP} {bgp route-reflector allow-outbound-policy} {} +.. index:: bgp route-reflector allow-outbound-policy + +``bgp route-reflector allow-outbound-policy`` -{BGP} {bgp route-reflector allow-outbound-policy} {} By default, attribute modification via route-map policy out is not reflected on reflected routes. This option allows the modifications to be reflected as well. Once enabled, it affects all reflected routes. @@ -869,14 +919,16 @@ Peer filtering BGP Peer Group ============== -.. index:: {BGP} {neighbor `word` peer-group} {} +.. index:: neighbor `word` peer-group + +``neighbor `word` peer-group`` -{BGP} {neighbor `word` peer-group} {} This command defines a new peer group. -.. index:: {BGP} {neighbor `peer` peer-group `word`} {} +.. index:: neighbor `peer` peer-group `word` + +``neighbor `peer` peer-group `word``` -{BGP} {neighbor `peer` peer-group `word`} {} This command bind specific peer to peer group `word`. .. _BGP_Address_Family: @@ -888,54 +940,54 @@ Multiprotocol BGP enables BGP to carry routing information for multiple Network Layer protocols. BGP supports multiple Address Family Identifier (AFI), namely IPv4 and IPv6. Support is also provided for multiple sets of per-AFI information via Subsequent Address Family -Identifiers (SAFI). In addition to unicast information, VPN information -@cite{RFC4364} and @cite{RFC4659}, and Encapsulation information -@cite{RFC5512} is supported. +Identifiers (SAFI). In addition to unicast information, VPN information +:t:`RFC4364` and :t:`RFC4659`, and Encapsulation information +:t:`RFC5512` is supported. -.. index:: {Command} {show ip bgp vpnv4 all} {} +.. index:: show ip bgp vpnv4 all -{Command} {show ip bgp vpnv4 all} {} -.. index:: {Command} {show ipv6 bgp vpn all} {} +``show ip bgp vpnv4 all`` +.. index:: show ipv6 bgp vpn all -{Command} {show ipv6 bgp vpn all} {} +``show ipv6 bgp vpn all`` Print active IPV4 or IPV6 routes advertised via the VPN SAFI. -.. index:: {Command} {show ip bgp encap all} {} +.. index:: show ip bgp encap all -{Command} {show ip bgp encap all} {} -.. index:: {Command} {show ipv6 bgp encap all} {} +``show ip bgp encap all`` +.. index:: show ipv6 bgp encap all -{Command} {show ipv6 bgp encap all} {} +``show ipv6 bgp encap all`` Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI. -.. index:: {Command} {show bgp ipv4 encap summary} {} +.. index:: show bgp ipv4 encap summary -{Command} {show bgp ipv4 encap summary} {} -.. index:: {Command} {show bgp ipv4 vpn summary} {} +``show bgp ipv4 encap summary`` +.. index:: show bgp ipv4 vpn summary -{Command} {show bgp ipv4 vpn summary} {} -.. index:: {Command} {show bgp ipv6 encap summary} {} +``show bgp ipv4 vpn summary`` +.. index:: show bgp ipv6 encap summary -{Command} {show bgp ipv6 encap summary} {} -.. index:: {Command} {show bgp ipv6 vpn summary} {} +``show bgp ipv6 encap summary`` +.. index:: show bgp ipv6 vpn summary -{Command} {show bgp ipv6 vpn summary} {} - Print a summary of neighbor connections for the specified AFI/SAFI combination. +``show bgp ipv6 vpn summary`` + Print a summary of neighbor connections for the specified AFI/SAFI combination. .. _Autonomous_System: Autonomous System ================= -The @acronym{AS,Autonomous System} number is one of the essential -element of BGP. BGP is a distance vector routing protocol, and the +The :abbr:`AS (Autonomous System)` number is one of the essential +element of BGP. BGP is a distance vector routing protocol, and the AS-Path framework provides distance vector metric and loop detection to BGP. @cite{RFC1930, Guidelines for creation, selection, and registration of an Autonomous System (AS)} provides some background on the concepts of an AS. The AS number is a two octet value, ranging in value from 1 to 65535. -The AS numbers 64512 through 65535 are defined as private AS numbers. +The AS numbers 64512 through 65535 are defined as private AS numbers. Private AS numbers must not to be advertised in the global Internet. .. _Display_BGP_Routes_by_AS_Path: @@ -943,11 +995,11 @@ Private AS numbers must not to be advertised in the global Internet. Display BGP Routes by AS Path ----------------------------- -To show BGP routes which has specific AS path information `show ip bgp` command can be used. +To show BGP routes which has specific AS path information `show ip bgp` command can be used. -.. index:: Command {show bgp {ipv4|ipv6} regexp `line`} {} +.. index:: show bgp ipv4|ipv6 regexp LINE -Command {show bgp {ipv4|ipv6} regexp `line`} {} +``show bgp ipv4|ipv6 regexp LINE`` This commands displays BGP routes that matches a regular expression `line` (:ref:`BGP_Regular_Expressions`). @@ -958,35 +1010,35 @@ AS Path Access List AS path access list is user defined AS path. -.. index:: {Command} {ip as-path access-list `word` {permit|deny} `line`} {} +.. index:: ip as-path access-list WORD permit|deny LINE -{Command} {ip as-path access-list `word` {permit|deny} `line`} {} +``ip as-path access-list WORD permit|deny LINE`` This command defines a new AS path access list. -.. index:: {Command} {no ip as-path access-list `word`} {} +.. index:: no ip as-path access-list WORD -{Command} {no ip as-path access-list `word`} {} -.. index:: {Command} {no ip as-path access-list `word` {permit|deny} `line`} {} +``no ip as-path access-list WORD`` +.. index:: no ip as-path access-list WORD permit|deny LINE -{Command} {no ip as-path access-list `word` {permit|deny} `line`} {} +``no ip as-path access-list WORD permit|deny LINE`` .. _Using_AS_Path_in_Route_Map: Using AS Path in Route Map -------------------------- -.. index:: {Route Map} {match as-path `word`} {} +.. index:: match as-path WORD -{Route Map} {match as-path `word`} {} +``match as-path WORD`` -.. index:: {Route Map} {set as-path prepend `as-path`} {} +.. index:: set as-path prepend AS-PATH -{Route Map} {set as-path prepend `as-path`} {} +``set as-path prepend AS-PATH`` Prepend the given string of AS numbers to the AS_PATH. -.. index:: {Route Map} {set as-path prepend last-as `num`} {} +.. index:: set as-path prepend last-as NUM -{Route Map} {set as-path prepend last-as `num`} {} +``set as-path prepend last-as NUM`` Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. .. _Private_AS_Numbers: @@ -1001,24 +1053,24 @@ BGP Communities Attribute ========================= BGP communities attribute is widely used for implementing policy -routing. Network operators can manipulate BGP communities attribute -based on their network policy. BGP communities attribute is defined -in @cite{RFC1997, BGP Communities Attribute} and +routing. Network operators can manipulate BGP communities attribute +based on their network policy. BGP communities attribute is defined +in :t:`RFC1997, BGP Communities Attribute` and @cite{RFC1998, An Application of the BGP Community Attribute -in Multi-home Routing}. It is an optional transitive attribute, +in Multi-home Routing}. It is an optional transitive attribute, therefore local policy can travel through different autonomous system. -Communities attribute is a set of communities values. Each -communities value is 4 octet long. The following format is used to +Communities attribute is a set of communities values. Each +communities value is 4 octet long. The following format is used to define communities value. *AS:VAL* - This format represents 4 octet communities value. `AS` is high - order 2 octet in digit format. `VAL` is low order 2 octet in - digit format. This format is useful to define AS oriented policy - value. For example, `7675:80` can be used when AS 7675 wants to + This format represents 4 octet communities value. `AS` is high + order 2 octet in digit format. `VAL` is low order 2 octet in + digit format. This format is useful to define AS oriented policy + value. For example, `7675:80` can be used when AS 7675 wants to pass local policy value 80 to neighboring peer. *internet* @@ -1026,8 +1078,8 @@ define communities value. *no-export* ``no-export`` represents well-known communities value ``NO_EXPORT`` @\* - @r{(0xFFFFFF01)}. All routes carry this value must not be advertised - to outside a BGP confederation boundary. If neighboring BGP peer is + @r{(0xFFFFFF01)}. All routes carry this value must not be advertised + to outside a BGP confederation boundary. If neighboring BGP peer is part of BGP confederation, the peer is considered as inside a BGP confederation boundary, so the route will be announced to the peer. @@ -1038,8 +1090,8 @@ define communities value. *local-AS* ``local-AS`` represents well-known communities value - ``NO_EXPORT_SUBCONFED`` @r{(0xFFFFFF03)}. All routes carry this - value must not be advertised to external BGP peers. Even if the + ``NO_EXPORT_SUBCONFED`` @r{(0xFFFFFF03)}. All routes carry this + value must not be advertised to external BGP peers. Even if the neighboring router is part of confederation, it is considered as external BGP peer, so the route will not be announced to the peer. @@ -1056,72 +1108,72 @@ BGP community list is a user defined BGP communites attribute list. BGP community list can be used for matching or manipulating BGP communities attribute in updates. -There are two types of community list. One is standard community -list and another is expanded community list. Standard community list -defines communities attribute. Expanded community list defines -communities attribute string with regular expression. Standard +There are two types of community list. One is standard community +list and another is expanded community list. Standard community list +defines communities attribute. Expanded community list defines +communities attribute string with regular expression. Standard community list is compiled into binary format when user define it. Standard community list will be directly compared to BGP communities -attribute in BGP updates. Therefore the comparison is faster than +attribute in BGP updates. Therefore the comparison is faster than expanded community list. -.. index:: Command {ip community-list standard `name` {permit|deny} `community`} {} +.. index:: ip community-list standard NAME permit|deny COMMUNITY -Command {ip community-list standard `name` {permit|deny} `community`} {} - This command defines a new standard community list. `community` - is communities value. The `community` is compiled into community - structure. We can define multiple community list under same name. In - that case match will happen user defined order. Once the +``ip community-list standard NAME permit|deny COMMUNITY`` + This command defines a new standard community list. `community` + is communities value. The `community` is compiled into community + structure. We can define multiple community list under same name. In + that case match will happen user defined order. Once the community list matches to communities attribute in BGP updates it - return permit or deny by the community list definition. When there is - no matched entry, deny will be returned. When `community` is + return permit or deny by the community list definition. When there is + no matched entry, deny will be returned. When `community` is empty it matches to any routes. -.. index:: Command {ip community-list expanded `name` {permit|deny} `line`} {} +.. index:: ip community-list expanded NAME permit|deny LINE -Command {ip community-list expanded `name` {permit|deny} `line`} {} - This command defines a new expanded community list. `line` is a - string expression of communities attribute. `line` can be a +``ip community-list expanded NAME permit|deny LINE`` + This command defines a new expanded community list. `line` is a + string expression of communities attribute. `line` can be a regular expression (:ref:`BGP_Regular_Expressions`) to match the communities attribute in BGP updates. -.. index:: Command {no ip community-list `name`} {} +.. index:: no ip community-list NAME -Command {no ip community-list `name`} {} -.. index:: Command {no ip community-list standard `name`} {} +``no ip community-list NAME`` +.. index:: no ip community-list standard NAME -Command {no ip community-list standard `name`} {} -.. index:: Command {no ip community-list expanded `name`} {} +``no ip community-list standard NAME`` +.. index:: no ip community-list expanded NAME -Command {no ip community-list expanded `name`} {} - These commands delete community lists specified by `name`. All of - community lists shares a single name space. So community lists can be +``no ip community-list expanded NAME`` + These commands delete community lists specified by `name`. All of + community lists shares a single name space. So community lists can be removed simpley specifying community lists name. -.. index:: {Command} {show ip community-list} {} +.. index:: show ip community-list -{Command} {show ip community-list} {} -.. index:: {Command} {show ip community-list `name`} {} +``show ip community-list`` +.. index:: show ip community-list NAME -{Command} {show ip community-list `name`} {} - This command displays current community list information. When - `name` is specified the specified community list's information is - shown. +``show ip community-list NAME`` + This command displays current community list information. When + `name` is specified the specified community list's information is + shown. :: - # show ip community-list - Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet - Named Community expanded list EXPAND - permit : + # show ip community-list + Named Community standard list CLIST + permit 7675:80 7675:100 no-export + deny internet + Named Community expanded list EXPAND + permit : + + # show ip community-list CLIST + Named Community standard list CLIST + permit 7675:80 7675:100 no-export + deny internet - # show ip community-list CLIST - Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet - .. _Numbered_BGP_Community_Lists: @@ -1129,35 +1181,35 @@ Numbered BGP Community Lists ---------------------------- When number is used for BGP community list name, the number has -special meanings. Community list number in the range from 1 and 99 is -standard community list. Community list number in the range from 100 -to 199 is expanded community list. These community lists are called -as numbered community lists. On the other hand normal community lists +special meanings. Community list number in the range from 1 and 99 is +standard community list. Community list number in the range from 100 +to 199 is expanded community list. These community lists are called +as numbered community lists. On the other hand normal community lists is called as named community lists. -.. index:: Command {ip community-list <1-99> {permit|deny} `community`} {} +.. index:: ip community-list <1-99> permit|deny COMMUNITY -Command {ip community-list <1-99> {permit|deny} `community`} {} - This command defines a new community list. <1-99> is standard - community list number. Community list name within this range defines - standard community list. When `community` is empty it matches to +``ip community-list <1-99> permit|deny COMMUNITY`` + This command defines a new community list. <1-99> is standard + community list number. Community list name within this range defines + standard community list. When `community` is empty it matches to any routes. -.. index:: Command {ip community-list <100-199> {permit|deny} `community`} {} +.. index:: ip community-list <100-199> permit|deny COMMUNITY -Command {ip community-list <100-199> {permit|deny} `community`} {} - This command defines a new community list. <100-199> is expanded - community list number. Community list name within this range defines +``ip community-list <100-199> permit|deny COMMUNITY`` + This command defines a new community list. <100-199> is expanded + community list number. Community list name within this range defines expanded community list. -.. index:: Command {ip community-list `name` {permit|deny} `community`} {} +.. index:: ip community-list NAME permit|deny COMMUNITY -Command {ip community-list `name` {permit|deny} `community`} {} +``ip community-list NAME permit|deny COMMUNITY`` When community list type is not specifed, the community list type is - automatically detected. If `community` can be compiled into + automatically detected. If `community` can be compiled into communities attribute, the community list is defined as a standard - community list. Otherwise it is defined as an expanded community - list. This feature is left for backward compability. Use of this + community list. Otherwise it is defined as an expanded community + list. This feature is left for backward compability. Use of this feature is not recommended. .. _BGP_Community_in_Route_Map: @@ -1166,50 +1218,50 @@ BGP Community in Route Map -------------------------- In Route Map (:ref:`Route_Map`), we can match or set BGP -communities attribute. Using this feature network operator can +communities attribute. Using this feature network operator can implement their network policy based on BGP communities attribute. Following commands can be used in Route Map. -.. index:: {Route Map} {match community `word`} {} +.. index:: match community WORD -{Route Map} {match community `word`} {} -.. index:: {Route Map} {match community `word` exact-match} {} +``match community WORD`` +.. index:: match community WORD exact-match -{Route Map} {match community `word` exact-match} {} +``match community WORD exact-match`` This command perform match to BGP updates using community list - `word`. When the one of BGP communities value match to the one of - communities value in community list, it is match. When + `word`. When the one of BGP communities value match to the one of + communities value in community list, it is match. When `exact-match` keyword is spcified, match happen only when BGP updates have completely same communities value specified in the community list. -.. index:: {Route Map} {set community none} {} +.. index:: set community none -{Route Map} {set community none} {} -.. index:: {Route Map} {set community `community`} {} +``set community none`` +.. index:: set community COMMUNITY -{Route Map} {set community `community`} {} -.. index:: {Route Map} {set community `community` additive} {} +``set community COMMUNITY`` +.. index:: set community COMMUNITY additive -{Route Map} {set community `community` additive} {} - This command manipulate communities value in BGP updates. When - `none` is specified as communities value, it removes entire - communities attribute from BGP updates. When `community` is not - `none`, specified communities value is set to BGP updates. If - BGP updates already has BGP communities value, the existing BGP - communities value is replaced with specified `community` value. - When `additive` keyword is specified, `community` is appended - to the existing communities value. +``set community COMMUNITY additive`` + This command manipulate communities value in BGP updates. When + `none` is specified as communities value, it removes entire + communities attribute from BGP updates. When `community` is not + `none`, specified communities value is set to BGP updates. If + BGP updates already has BGP communities value, the existing BGP + communities value is replaced with specified `community` value. + When `additive` keyword is specified, `community` is appended + to the existing communities value. -.. index:: {Route Map} {set comm-list `word` delete} {} +.. index:: set comm-list WORD delete -{Route Map} {set comm-list `word` delete} {} - This command remove communities value from BGP communities attribute. - The `word` is community list name. When BGP route's communities - value matches to the community list `word`, the communities value - is removed. When all of communities value is removed eventually, the - BGP update's communities attribute is completely removed. +``set comm-list WORD delete`` + This command remove communities value from BGP communities attribute. + The `word` is community list name. When BGP route's communities + value matches to the community list `word`, the communities value + is removed. When all of communities value is removed eventually, the + BGP update's communities attribute is completely removed. .. _Display_BGP_Routes_by_Community: @@ -1220,15 +1272,15 @@ To show BGP routes which has specific BGP communities attribute, `show bgp {ipv4|ipv6}` command can be used. The `community` and `community-list` subcommand can be used. -.. index:: Command {show bgp {ipv4|ipv6} community} {} +.. index:: show bgp ipv4|ipv6 community -Command {show bgp {ipv4|ipv6} community} {} -.. index:: Command {show bgp {ipv4|ipv6} community `community`} {} +``show bgp ipv4|ipv6 community`` +.. index:: show bgp ipv4|ipv6 community COMMUNITY -Command {show bgp {ipv4|ipv6} community `community`} {} -.. index:: Command {show bgp {ipv4|ipv6} community `community` exact-match} {} +``show bgp ipv4|ipv6 community COMMUNITY`` +.. index:: show bgp ipv4|ipv6 community COMMUNITY exact-match -Command {show bgp {ipv4|ipv6} community `community` exact-match} {} +``show bgp ipv4|ipv6 community COMMUNITY exact-match`` `show bgp {ipv4|ipv6} community` displays BGP routes which has communities attribute. Where the address family can be IPv4 or IPv6 among others. When `community` is specified, BGP routes that matches `community` value is @@ -1236,15 +1288,15 @@ Command {show bgp {ipv4|ipv6} community `community` exact-match} {} `community` value. When `exact-match` is specified, it display only routes that have an exact match. -.. index:: Command {show bgp {ipv4|ipv6} community-list `word`} {} +.. index:: show bgp ipv4|ipv6 community-list WORD -Command {show bgp {ipv4|ipv6} community-list `word`} {} -.. index:: Command {show bgp {ipv4|ipv6} community-list `word` exact-match} {} +``show bgp ipv4|ipv6 community-list WORD`` +.. index:: show bgp ipv4|ipv6 community-list WORD exact-match -Command {show bgp {ipv4|ipv6} community-list `word` exact-match} {} - This commands display BGP routes for the address family specified that matches - community list `word`. When `exact-match` is specified, display only - routes that have an exact match. +``show bgp ipv4|ipv6 community-list WORD exact-match`` + This commands display BGP routes for the address family specified that matches + community list `word`. When `exact-match` is specified, display only + routes that have an exact match. .. _Using_BGP_Communities_Attribute: @@ -1252,7 +1304,7 @@ Using BGP Communities Attribute ------------------------------- Following configuration is the most typical usage of BGP communities -attribute. AS 7675 provides upstream Internet connection to AS 100. +attribute. AS 7675 provides upstream Internet connection to AS 100. When following configuration exists in AS 7675, AS 100 networks operator can set local preference in AS 7675 network by setting BGP communities attribute to the updates. @@ -1283,7 +1335,7 @@ communities attribute to the updates. route-map RMAP permit 30 match community 90 set local-preference 90 - + Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675. The route has communities value 7675:80 so when above configuration @@ -1304,11 +1356,11 @@ value 80. route-map RMAP permit 10 match ip address prefix-list PLIST set community 7675:80 - + Following configuration is an example of BGP route filtering using -communities attribute. This configuration only permit BGP routes -which has BGP communities value 0:80 or 0:90. Network operator can +communities attribute. This configuration only permit BGP routes +which has BGP communities value 0:80 or 0:90. Network operator can put special internal communities value at BGP border router, then limit the BGP routes announcement into the internal network. @@ -1324,10 +1376,10 @@ limit the BGP routes announcement into the internal network. ! route-map RMAP permit in match community 1 - + Following exmaple filter BGP routes which has communities value 1:1. -When there is no match community-list returns deny. To avoid +When there is no match community-list returns deny. To avoid filtering all of routes, we need to define permit any at last. :: @@ -1343,24 +1395,24 @@ filtering all of routes, we need to define permit any at last. ! route-map RMAP permit 10 match community FILTER - + Communities value keyword `internet` has special meanings in -standard community lists. In below example `internet` act as -match any. It matches all of BGP routes even if the route does not -have communities attribute at all. So community list `INTERNET` +standard community lists. In below example `internet` act as +match any. It matches all of BGP routes even if the route does not +have communities attribute at all. So community list `INTERNET` is same as above example's `FILTER`. :: ip community-list standard INTERNET deny 1:1 ip community-list standard INTERNET permit internet - + Following configuration is an example of communities value deletion. With this configuration communities value 100:1 and 100:2 is removed -from BGP updates. For communities value deletion, only `permit` -community-list is used. `deny` community-list is ignored. +from BGP updates. For communities value deletion, only `permit` +community-list is used. `deny` community-list is ignored. :: @@ -1374,7 +1426,7 @@ community-list is used. `deny` community-list is ignored. ! route-map RMAP permit 10 set comm-list DEL delete - + .. _BGP_Extended_Communities_Attribute: @@ -1382,22 +1434,22 @@ BGP Extended Communities Attribute ================================== BGP extended communities attribute is introduced with MPLS VPN/BGP -technology. MPLS VPN/BGP expands capability of network infrastructure -to provide VPN functionality. At the same time it requires a new -framework for policy routing. With BGP Extended Communities Attribute +technology. MPLS VPN/BGP expands capability of network infrastructure +to provide VPN functionality. At the same time it requires a new +framework for policy routing. With BGP Extended Communities Attribute we can use Route Target or Site of Origin for implementing network policy for MPLS VPN/BGP. BGP Extended Communities Attribute is similar to BGP Communities -Attribute. It is an optional transitive attribute. BGP Extended +Attribute. It is an optional transitive attribute. BGP Extended Communities Attribute can carry multiple Extended Community value. Each Extended Community value is eight octet length. BGP Extended Communities Attribute provides an extended range -compared with BGP Communities Attribute. Adding to that there is a +compared with BGP Communities Attribute. Adding to that there is a type field in each value to provides community space structure. -There are two format to define Extended Community value. One is AS +There are two format to define Extended Community value. One is AS based format the other is IP address based format. @@ -1405,14 +1457,14 @@ based format the other is IP address based format. *AS:VAL* This is a format to define AS based Extended Community value. `AS` part is 2 octets Global Administrator subfield in Extended - Community value. `VAL` part is 4 octets Local Administrator - subfield. `7675:100` represents AS 7675 policy value 100. + Community value. `VAL` part is 4 octets Local Administrator + subfield. `7675:100` represents AS 7675 policy value 100. *IP-Address:VAL* This is a format to define IP address based Extended Community value. `IP-Address` part is 4 octets Global Administrator subfield. `VAL` part is 2 octets Local Administrator subfield. - `10.0.0.1:100` represents + `10.0.0.1:100` represents .. _BGP_Extended_Community_Lists: @@ -1422,72 +1474,72 @@ BGP Extended Community Lists Expanded Community Lists is a user defined BGP Expanded Community Lists. -.. index:: Command {ip extcommunity-list standard `name` {permit|deny} `extcommunity`} {} +.. index:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY -Command {ip extcommunity-list standard `name` {permit|deny} `extcommunity`} {} +``ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY`` This command defines a new standard extcommunity-list. - `extcommunity` is extended communities value. The - `extcommunity` is compiled into extended community structure. We - can define multiple extcommunity-list under same name. In that case - match will happen user defined order. Once the extcommunity-list + `extcommunity` is extended communities value. The + `extcommunity` is compiled into extended community structure. We + can define multiple extcommunity-list under same name. In that case + match will happen user defined order. Once the extcommunity-list matches to extended communities attribute in BGP updates it return - permit or deny based upon the extcommunity-list definition. When - there is no matched entry, deny will be returned. When + permit or deny based upon the extcommunity-list definition. When + there is no matched entry, deny will be returned. When `extcommunity` is empty it matches to any routes. -.. index:: Command {ip extcommunity-list expanded `name` {permit|deny} `line`} {} +.. index:: ip extcommunity-list expanded NAME permit|deny LINE -Command {ip extcommunity-list expanded `name` {permit|deny} `line`} {} - This command defines a new expanded extcommunity-list. `line` is - a string expression of extended communities attribute. `line` can +``ip extcommunity-list expanded NAME permit|deny LINE`` + This command defines a new expanded extcommunity-list. `line` is + a string expression of extended communities attribute. `line` can be a regular expression (:ref:`BGP_Regular_Expressions`) to match an extended communities attribute in BGP updates. -.. index:: Command {no ip extcommunity-list `name`} {} +.. index:: no ip extcommunity-list NAME -Command {no ip extcommunity-list `name`} {} -.. index:: Command {no ip extcommunity-list standard `name`} {} +``no ip extcommunity-list NAME`` +.. index:: no ip extcommunity-list standard NAME -Command {no ip extcommunity-list standard `name`} {} -.. index:: Command {no ip extcommunity-list expanded `name`} {} +``no ip extcommunity-list standard NAME`` +.. index:: no ip extcommunity-list expanded NAME -Command {no ip extcommunity-list expanded `name`} {} +``no ip extcommunity-list expanded NAME`` These commands delete extended community lists specified by - `name`. All of extended community lists shares a single name - space. So extended community lists can be removed simpley specifying + `name`. All of extended community lists shares a single name + space. So extended community lists can be removed simpley specifying the name. -.. index:: {Command} {show ip extcommunity-list} {} +.. index:: show ip extcommunity-list -{Command} {show ip extcommunity-list} {} -.. index:: {Command} {show ip extcommunity-list `name`} {} +``show ip extcommunity-list`` +.. index:: show ip extcommunity-list NAME -{Command} {show ip extcommunity-list `name`} {} - This command displays current extcommunity-list information. When - `name` is specified the community list's information is shown. +``show ip extcommunity-list NAME`` + This command displays current extcommunity-list information. When + `name` is specified the community list's information is shown. :: - # show ip extcommunity-list - + # show ip extcommunity-list + .. _BGP_Extended_Communities_in_Route_Map: BGP Extended Communities in Route Map ------------------------------------- -.. index:: {Route Map} {match extcommunity `word`} {} +.. index:: match extcommunity WORD -{Route Map} {match extcommunity `word`} {} +``match extcommunity WORD`` -.. index:: {Route Map} {set extcommunity rt `extcommunity`} {} +.. index:: set extcommunity rt EXTCOMMUNITY -{Route Map} {set extcommunity rt `extcommunity`} {} +``set extcommunity rt EXTCOMMUNITY`` This command set Route Target value. -.. index:: {Route Map} {set extcommunity soo `extcommunity`} {} +.. index:: set extcommunity soo EXTCOMMUNITY -{Route Map} {set extcommunity soo `extcommunity`} {} +``set extcommunity soo EXTCOMMUNITY`` This command set Site of Origin value. .. _BGP_Large_Communities_Attribute: @@ -1496,7 +1548,7 @@ BGP Large Communities Attribute =============================== The BGP Large Communities attribute was introduced in Feb 2017 with -@cite{RFC8092, BGP Large Communities Attribute}. +:t:`RFC8092, BGP Large Communities Attribute`. The BGP Large Communities Attribute is similar to the BGP Communities Attribute except that it has 3 components instead of two and each of @@ -1509,7 +1561,7 @@ AS4 operators seamless use. *GLOBAL:LOCAL1:LOCAL2* This is the format to define Large Community values. Referencing - @cite{RFC8195, Use of BGP Large Communities} the values are commonly + :t:`RFC8195, Use of BGP Large Communities` the values are commonly referred to as follows. The `GLOBAL` part is a 4 octet Global Administrator field, common use of this field is the operators AS number. @@ -1528,76 +1580,76 @@ BGP Large Community Lists Two types of large community lists are supported, namely `standard` and `expanded`. -.. index:: Command {ip large-community-list standard `name` {permit|deny} `large-community`} {} +.. index:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY -Command {ip large-community-list standard `name` {permit|deny} `large-community`} {} +``ip large-community-list standard NAME permit|deny LARGE-COMMUNITY`` This command defines a new standard large-community-list. `large-community` is the Large Community value. We can add multiple large communities under same name. In that case the match will happen in the user defined order. Once the large-community-list matches the Large Communities attribute in BGP updates it will return - permit or deny based upon the large-community-list definition. When - there is no matched entry, a deny will be returned. When `large-community` + permit or deny based upon the large-community-list definition. When + there is no matched entry, a deny will be returned. When `large-community` is empty it matches any routes. -.. index:: Command {ip large-community-list expanded `name` {permit|deny} `line`} {} +.. index:: ip large-community-list expanded NAME permit|deny LINE -Command {ip large-community-list expanded `name` {permit|deny} `line`} {} +``ip large-community-list expanded NAME permit|deny LINE`` This command defines a new expanded large-community-list. Where `line` is a string matching expression, it will be compared to the entire Large Communities attribute as a string, with each large-community in order from lowest to highest. `line` can also be a regular expression which matches this Large Community attribute. -.. index:: Command {no ip large-community-list `name`} {} +.. index:: no ip large-community-list NAME -Command {no ip large-community-list `name`} {} -.. index:: Command {no ip large-community-list standard `name`} {} +``no ip large-community-list NAME`` +.. index:: no ip large-community-list standard NAME -Command {no ip large-community-list standard `name`} {} -.. index:: Command {no ip large-community-list expanded `name`} {} +``no ip large-community-list standard NAME`` +.. index:: no ip large-community-list expanded NAME -Command {no ip large-community-list expanded `name`} {} +``no ip large-community-list expanded NAME`` These commands delete Large Community lists specified by `name`. All Large Community lists share a single namespace. This means Large Community lists can be removed by simply specifying the name. -.. index:: {Command} {show ip large-community-list} {} +.. index:: show ip large-community-list -{Command} {show ip large-community-list} {} -.. index:: {Command} {show ip large-community-list `name`} {} +``show ip large-community-list`` +.. index:: show ip large-community-list NAME -{Command} {show ip large-community-list `name`} {} - This command display current large-community-list information. When - `name` is specified the community list information is shown. +``show ip large-community-list NAME`` + This command display current large-community-list information. When + `name` is specified the community list information is shown. -.. index:: {Command} {show ip bgp large-community-info} {} +.. index:: show ip bgp large-community-info -{Command} {show ip bgp large-community-info} {} - This command displays the current large communities in use. +``show ip bgp large-community-info`` + This command displays the current large communities in use. .. _BGP_Large_Communities_in_Route_Map: BGP Large Communities in Route Map ---------------------------------- -.. index:: {Route Map} {match large-community `line`} {} +.. index:: match large-community LINE -{Route Map} {match large-community `line`} {} +``match large-community LINE`` Where `line` can be a simple string to match, or a regular expression. It is very important to note that this match occurs on the entire large-community string as a whole, where each large-community is ordered from lowest to highest. -.. index:: {Route Map} {set large-community `large-community`} {} +.. index:: set large-community LARGE-COMMUNITY -{Route Map} {set large-community `large-community`} {} -.. index:: {Route Map} {set large-community `large-community` `large-community`} {} +``set large-community LARGE-COMMUNITY`` +.. index:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY -{Route Map} {set large-community `large-community` `large-community`} {} -.. index:: {Route Map} {set large-community `large-community` additive} {} +``set large-community LARGE-COMMUNITY LARGE-COMMUNITY`` +.. index:: set large-community LARGE-COMMUNITY additive -{Route Map} {set large-community `large-community` additive} {} +``set large-community LARGE-COMMUNITY additive`` These commands are used for setting large-community values. The first command will overwrite any large-communities currently present. The second specifies two large-communities, which overwrites the current @@ -1615,16 +1667,16 @@ Displaying BGP information Showing BGP information ----------------------- -.. index:: {Command} {show ip bgp} {} +.. index:: show ip bgp -{Command} {show ip bgp} {} -.. index:: {Command} {show ip bgp `A.B.C.D`} {} +``show ip bgp`` +.. index:: show ip bgp A.B.C.D -{Command} {show ip bgp `A.B.C.D`} {} -.. index:: {Command} {show ip bgp `X:X::X:X`} {} +``show ip bgp A.B.C.D`` +.. index:: show ip bgp X:X::X:X -{Command} {show ip bgp `X:X::X:X`} {} - This command displays BGP routes. When no route is specified it +``show ip bgp X:X::X:X`` + This command displays BGP routes. When no route is specified it display all of IPv4 BGP routes. :: @@ -1633,193 +1685,202 @@ Showing BGP information Status codes: s suppressed, d damped, h history, * valid, > best, i - internal Origin codes: i - IGP, e - EGP, ? - incomplete - Network Next Hop Metric LocPrf Weight Path - *> 1.1.1.1/32 0.0.0.0 0 32768 i + Network Next Hop Metric LocPrf Weight Path + *> 1.1.1.1/32 0.0.0.0 0 32768 i Total number of prefixes 1 - -.. index:: {Command} {show ip bgp regexp `line`} {} -{Command} {show ip bgp regexp `line`} {} +.. index:: show ip bgp regexp LINE + +``show ip bgp regexp LINE`` This command displays BGP routes using AS path regular expression (:ref:`BGP_Regular_Expressions`). -.. index:: Command {show ip bgp community `community`} {} +.. index:: show ip bgp community COMMUNITY -Command {show ip bgp community `community`} {} -.. index:: Command {show ip bgp community `community` exact-match} {} +``show ip bgp community COMMUNITY`` +.. index:: show ip bgp community COMMUNITY exact-match -Command {show ip bgp community `community` exact-match} {} - This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). +``show ip bgp community COMMUNITY exact-match`` + This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). -.. index:: Command {show ip bgp community-list `word`} {} +.. index:: show ip bgp community-list WORD -Command {show ip bgp community-list `word`} {} -.. index:: Command {show ip bgp community-list `word` exact-match} {} +``show ip bgp community-list WORD`` +.. index:: show ip bgp community-list WORD exact-match -Command {show ip bgp community-list `word` exact-match} {} - This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). +``show ip bgp community-list WORD exact-match`` + This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). -.. index:: {Command} {show bgp {ipv4|ipv6} summary} {} +.. index:: show bgp ipv4|ipv6 summary -{Command} {show bgp {ipv4|ipv6} summary} {} - Show a bgp peer summary for the specified address family. +``show bgp ipv4|ipv6 summary`` + Show a bgp peer summary for the specified address family. -.. index:: {Command} {show bgp {ipv4|ipv6} neighbor [`peer`]} {} +.. index:: show bgp ipv4|ipv6 neighbor [PEER] -{Command} {show bgp {ipv4|ipv6} neighbor [`peer`]} {} - This command shows information on a specific BGP `peer`. +``show bgp ipv4|ipv6 neighbor [PEER]`` + This command shows information on a specific BGP `peer`. -.. index:: {Command} {show bgp {ipv4|ipv6} dampening dampened-paths} {} +.. index:: show bgp ipv4|ipv6 dampening dampened-paths -{Command} {show bgp {ipv4|ipv6} dampening dampened-paths} {} - Display paths suppressed due to dampening. +``show bgp ipv4|ipv6 dampening dampened-paths`` + Display paths suppressed due to dampening. -.. index:: {Command} {show bgp {ipv4|ipv6} dampening flap-statistics} {} +.. index:: show bgp ipv4|ipv6 dampening flap-statistics -{Command} {show bgp {ipv4|ipv6} dampening flap-statistics} {} - Display flap statistics of routes. +``show bgp ipv4|ipv6 dampening flap-statistics`` + Display flap statistics of routes. .. _Other_BGP_commands: Other BGP commands ------------------ -.. index:: {Command} {clear bgp {ipv4|ipv6} \*} {} +.. index:: clear bgp ipv4|ipv6 \* -{Command} {clear bgp {ipv4|ipv6} \*} {} +``clear bgp ipv4|ipv6 \*`` Clear all address family peers. -.. index:: {Command} {clear bgp {ipv4|ipv6} `peer`} {} +.. index:: clear bgp ipv4|ipv6 PEER -{Command} {clear bgp {ipv4|ipv6} `peer`} {} +``clear bgp ipv4|ipv6 PEER`` Clear peers which have addresses of X.X.X.X -.. index:: {Command} {clear bgp {ipv4|ipv6} `peer` soft in} {} +.. index:: clear bgp ipv4|ipv6 PEER soft in -{Command} {clear bgp {ipv4|ipv6} `peer` soft in} {} +``clear bgp ipv4|ipv6 PEER soft in`` Clear peer using soft reconfiguration. -.. index:: {Command} {show debug} {} +.. index:: show debug -{Command} {show debug} {} -.. index:: {Command} {debug event} {} +``show debug`` +.. index:: debug event -{Command} {debug event} {} -.. index:: {Command} {debug update} {} +``debug event`` +.. index:: debug update -{Command} {debug update} {} -.. index:: {Command} {debug keepalive} {} +``debug update`` +.. index:: debug keepalive -{Command} {debug keepalive} {} -.. index:: {Command} {no debug event} {} +``debug keepalive`` +.. index:: no debug event -{Command} {no debug event} {} -.. index:: {Command} {no debug update} {} +``no debug event`` +.. index:: no debug update -{Command} {no debug update} {} -.. index:: {Command} {no debug keepalive} {} +``no debug update`` +.. index:: no debug keepalive -{Command} {no debug keepalive} {} +``no debug keepalive`` .. _Capability_Negotiation: Capability Negotiation ====================== -When adding IPv6 routing information exchange feature to BGP. There -were some proposals. @acronym{IETF,Internet Engineering Task Force} -@acronym{IDR, Inter Domain Routing} @acronym{WG, Working group} adopted -a proposal called Multiprotocol Extension for BGP. The specification -is described in @cite{RFC2283}. The protocol does not define new protocols. -It defines new attributes to existing BGP. When it is used exchanging -IPv6 routing information it is called BGP-4+. When it is used for +When adding IPv6 routing information exchange feature to BGP. There +were some proposals. :abbr:`IETF (Internet Engineering Task Force)` +:abbr:`IDR ( Inter Domain Routing)` :abbr:`IDR ( Inter Domain Routing)` adopted +a proposal called Multiprotocol Extension for BGP. The specification +is described in :t:`RFC2283`. The protocol does not define new protocols. +It defines new attributes to existing BGP. When it is used exchanging +IPv6 routing information it is called BGP-4+. When it is used for exchanging multicast routing information it is called MBGP. -*bgpd* supports Multiprotocol Extension for BGP. So if remote +*bgpd* supports Multiprotocol Extension for BGP. So if remote peer supports the protocol, *bgpd* can exchange IPv6 and/or multicast routing information. Traditional BGP did not have the feature to detect remote peer's capabilities, e.g. whether it can handle prefix types other than IPv4 -unicast routes. This was a big problem using Multiprotocol Extension -for BGP to operational network. @cite{RFC2842, Capabilities +unicast routes. This was a big problem using Multiprotocol Extension +for BGP to operational network. @cite{RFC2842, Capabilities Advertisement with BGP-4} adopted a feature called Capability Negotiation. *bgpd* use this Capability Negotiation to detect -the remote peer's capabilities. If the peer is only configured as IPv4 +the remote peer's capabilities. If the peer is only configured as IPv4 unicast neighbor, *bgpd* does not send these Capability Negotiation packets (at least not unless other optional BGP features require capability negotation). By default, Frr will bring up peering with minimal common capability -for the both sides. For example, local router has unicast and -multicast capabilitie and remote router has unicast capability. In +for the both sides. For example, local router has unicast and +multicast capabilitie and remote router has unicast capability. In this case, the local router will establish the connection with unicast only capability. When there are no common capabilities, Frr sends Unsupported Capability error and then resets the connection. -If you want to completely match capabilities with remote peer. Please +If you want to completely match capabilities with remote peer. Please use *strict-capability-match* command. -.. index:: {BGP} {neighbor `peer` strict-capability-match} {} +.. index:: neighbor `peer` strict-capability-match -{BGP} {neighbor `peer` strict-capability-match} {} -.. index:: {BGP} {no neighbor `peer` strict-capability-match} {} +``neighbor `peer` strict-capability-match`` -{BGP} {no neighbor `peer` strict-capability-match} {} - Strictly compares remote capabilities and local capabilities. If capabilities +.. index:: no neighbor `peer` strict-capability-match + +``no neighbor `peer` strict-capability-match`` + + Strictly compares remote capabilities and local capabilities. If capabilities are different, send Unsupported Capability error then reset connection. You may want to disable sending Capability Negotiation OPEN message optional parameter to the peer when remote peer does not implement - Capability Negotiation. Please use *dont-capability-negotiate* + Capability Negotiation. Please use *dont-capability-negotiate* command to disable the feature. -.. index:: {BGP} {neighbor `peer` dont-capability-negotiate} {} +.. index:: neighbor `peer` dont-capability-negotiate -{BGP} {neighbor `peer` dont-capability-negotiate} {} -.. index:: {BGP} {no neighbor `peer` dont-capability-negotiate} {} +``neighbor `peer` dont-capability-negotiate`` + +.. index:: no neighbor `peer` dont-capability-negotiate + +``no neighbor `peer` dont-capability-negotiate`` -{BGP} {no neighbor `peer` dont-capability-negotiate} {} Suppress sending Capability Negotiation as OPEN message optional - parameter to the peer. This command only affects the peer is configured + parameter to the peer. This command only affects the peer is configured other than IPv4 unicast configuration. When remote peer does not have capability negotiation feature, remote - peer will not send any capabilities at all. In that case, bgp + peer will not send any capabilities at all. In that case, bgp configures the peer with configured capabilities. You may prefer locally configured capabilities more than the negotiated - capabilities even though remote peer sends capabilities. If the peer + capabilities even though remote peer sends capabilities. If the peer is configured by *override-capability*, *bgpd* ignores received capabilities then override negotiated capabilities with configured values. -.. index:: {BGP} {neighbor `peer` override-capability} {} +.. index:: neighbor `peer` override-capability -{BGP} {neighbor `peer` override-capability} {} -.. index:: {BGP} {no neighbor `peer` override-capability} {} +``neighbor `peer` override-capability`` -{BGP} {no neighbor `peer` override-capability} {} - Override the result of Capability Negotiation with local configuration. - Ignore remote peer's capability value. +.. index:: no neighbor `peer` override-capability + +``no neighbor `peer` override-capability`` + + Override the result of Capability Negotiation with local configuration. + Ignore remote peer's capability value. .. _Route_Reflector: Route Reflector =============== -.. index:: {BGP} {bgp cluster-id `a.b.c.d`} {} +.. index:: bgp cluster-id `a.b.c.d` -{BGP} {bgp cluster-id `a.b.c.d`} {} +``bgp cluster-id `a.b.c.d``` -.. index:: {BGP} {neighbor `peer` route-reflector-client} {} -{BGP} {neighbor `peer` route-reflector-client} {} -.. index:: {BGP} {no neighbor `peer` route-reflector-client} {} +.. index:: neighbor `peer` route-reflector-client + +``neighbor `peer` route-reflector-client`` + +.. index:: no neighbor `peer` route-reflector-client + +``no neighbor `peer` route-reflector-client`` -{BGP} {no neighbor `peer` route-reflector-client} {} .. _Route_Server: @@ -1827,19 +1888,19 @@ Route Server ============ At an Internet Exchange point, many ISPs are connected to each other by -external BGP peering. Normally these external BGP connection are done by -@samp{full mesh} method. As with internal BGP full mesh formation, +external BGP peering. Normally these external BGP connection are done by +@samp{full mesh} method. As with internal BGP full mesh formation, this method has a scaling problem. -This scaling problem is well known. Route Server is a method to resolve -the problem. Each ISP's BGP router only peers to Route Server. Route -Server serves as BGP information exchange to other BGP routers. By +This scaling problem is well known. Route Server is a method to resolve +the problem. Each ISP's BGP router only peers to Route Server. Route +Server serves as BGP information exchange to other BGP routers. By applying this method, numbers of BGP connections is reduced from O(n*(n-1)/2) to O(n). Unlike normal BGP router, Route Server must have several routing tables -for managing different routing policies for each BGP speaker. We call the -routing tables as different ``view`` s. *bgpd* can work as +for managing different routing policies for each BGP speaker. We call the +routing tables as different ``view`` s. *bgpd* can work as normal BGP router or Route Server or both at the same time. .. _Multiple_instance: @@ -1850,26 +1911,26 @@ Multiple instance To enable multiple view function of `bgpd`, you must turn on multiple instance feature beforehand. -.. index:: {Command} {bgp multiple-instance} {} +.. index:: bgp multiple-instance -{Command} {bgp multiple-instance} {} - Enable BGP multiple instance feature. After this feature is enabled, +``bgp multiple-instance`` + Enable BGP multiple instance feature. After this feature is enabled, you can make multiple BGP instances or multiple BGP views. -.. index:: {Command} {no bgp multiple-instance} {} +.. index:: no bgp multiple-instance -{Command} {no bgp multiple-instance} {} - Disable BGP multiple instance feature. You can not disable this feature +``no bgp multiple-instance`` + Disable BGP multiple instance feature. You can not disable this feature when BGP multiple instances or views exist. -When you want to make configuration more Cisco like one, +When you want to make configuration more Cisco like one, -.. index:: {Command} {bgp config-type cisco} {} +.. index:: bgp config-type cisco -{Command} {bgp config-type cisco} {} +``bgp config-type cisco`` Cisco compatible BGP configuration output. -When bgp config-type cisco is specified, +When bgp config-type cisco is specified, 'no synchronization' is displayed. 'no auto-summary' is displayed. @@ -1883,12 +1944,12 @@ Cisco: network 10.0.0.0 Frr: aggregate-address 192.168.0.0/24 Cisco: aggregate-address 192.168.0.0 255.255.255.0 -Community attribute handling is also different. If there is no +Community attribute handling is also different. If there is no configuration is specified community attribute and extended community -attribute are sent to neighbor. When user manually disable the -feature community attribute is not sent to the neighbor. In case of +attribute are sent to neighbor. When user manually disable the +feature community attribute is not sent to the neighbor. In case of *bgp config-type cisco* is specified, community attribute is not -sent to the neighbor by default. To send community attribute user has +sent to the neighbor by default. To send community attribute user has to specify *neighbor A.B.C.D send-community* command. :: @@ -1906,30 +1967,29 @@ to specify *neighbor A.B.C.D send-community* command. neighbor 10.0.0.1 send-community exit-address-family ! - -.. index:: {Command} {bgp config-type zebra} {} -{Command} {bgp config-type zebra} {} - Frr style BGP configuration. This is default. +.. index:: bgp config-type zebra + +``bgp config-type zebra`` + Frr style BGP configuration. This is default. .. _BGP_instance_and_view: BGP instance and view --------------------- -BGP instance is a normal BGP process. The result of route selection -goes to the kernel routing table. You can setup different AS at the +BGP instance is a normal BGP process. The result of route selection +goes to the kernel routing table. You can setup different AS at the same time when BGP multiple instance feature is enabled. -.. index:: {Command} {router bgp `as-number`} {} +.. index:: router bgp AS-NUMBER -{Command} {router bgp `as-number`} {} - Make a new BGP instance. You can use arbitrary word for the `name`. +``router bgp AS-NUMBER`` + Make a new BGP instance. You can use arbitrary word for the `name`. :: - @group bgp multiple-instance ! router bgp 1 @@ -1939,24 +1999,22 @@ same time when BGP multiple instance feature is enabled. router bgp 2 neighbor 10.0.0.3 remote-as 4 neighbor 10.0.0.4 remote-as 5 - @end group - + BGP view is almost same as normal BGP process. The result of -route selection does not go to the kernel routing table. BGP view is +route selection does not go to the kernel routing table. BGP view is only for exchanging BGP routing information. -.. index:: {Command} {router bgp `as-number` view `name`} {} +.. index:: router bgp AS-NUMBER view NAME -{Command} {router bgp `as-number` view `name`} {} - Make a new BGP view. You can use arbitrary word for the `name`. This +``router bgp AS-NUMBER view NAME`` + Make a new BGP view. You can use arbitrary word for the `name`. This view's route selection result does not go to the kernel routing table. With this command, you can setup Route Server like below. :: - @group bgp multiple-instance ! router bgp 1 view 1 @@ -1966,20 +2024,18 @@ With this command, you can setup Route Server like below. router bgp 2 view 2 neighbor 10.0.0.3 remote-as 4 neighbor 10.0.0.4 remote-as 5 - @end group - + .. _Routing_policy: Routing policy -------------- -You can set different routing policy for a peer. For example, you can +You can set different routing policy for a peer. For example, you can set different filter for a peer. :: - @group bgp multiple-instance ! router bgp 1 view 1 @@ -1993,12 +2049,11 @@ set different filter for a peer. address-family ipv4 unicast neighbor 10.0.0.1 distribute-list 2 in exit-address-family - @end group - + This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view -2. When the update is inserted into view 1, distribute-list 1 is -applied. On the other hand, when the update is inserted into view 2, +2. When the update is inserted into view 1, distribute-list 1 is +applied. On the other hand, when the update is inserted into view 2, distribute-list 2 is applied. .. _Viewing_the_view: @@ -2008,9 +2063,9 @@ Viewing the view To display routing table of BGP view, you must specify view name. -.. index:: {Command} {show ip bgp view `name`} {} +.. index:: show ip bgp view NAME -{Command} {show ip bgp view `name`} {} +``show ip bgp view NAME`` Display routing table of BGP view `name`. .. _BGP_Regular_Expressions: @@ -2046,8 +2101,8 @@ $ _ Character `_` has special meanings in BGP regular expressions. It matches to space and comma , and AS set delimiter { and } and AS - confederation delimiter `(` and `)`. And it also matches to - the beginning of the line and the end of the line. So `_` can be + confederation delimiter `(` and `)`. And it also matches to + the beginning of the line and the end of the line. So `_` can be used for AS value boundaries match. This character technically evaluates to `(^|[,{}() ]|$)`. @@ -2058,11 +2113,10 @@ How to set up a 6-Bone connection :: - @group - zebra configuration - =================== - ! - ! Actually there is no need to configure zebra + zebra configuration + =================== + ! + ! Actually there is no need to configure zebra ! bgpd configuration @@ -2095,61 +2149,60 @@ How to set up a 6-Bone connection set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 ! - ! logfile FILENAME is obsolete. Please use log file FILENAME + ! logfile FILENAME is obsolete. Please use log file FILENAME log file bgpd.log ! - @end group - + .. _Dump_BGP_packets_and_table: Dump BGP packets and table ========================== -.. index:: Command {dump bgp all `path` [`interval`]} {} +.. index:: dump bgp all PATH [INTERVAL] -Command {dump bgp all `path` [`interval`]} {} -.. index:: Command {dump bgp all-et `path` [`interval`]} {} +``dump bgp all PATH [INTERVAL]`` +.. index:: dump bgp all-et PATH [INTERVAL] -Command {dump bgp all-et `path` [`interval`]} {} -.. index:: Command {no dump bgp all [`path`] [`interval`]} {} +``dump bgp all-et PATH [INTERVAL]`` +.. index:: no dump bgp all [PATH] [INTERVAL] -Command {no dump bgp all [`path`] [`interval`]} {} +``no dump bgp all [PATH] [INTERVAL]`` Dump all BGP packet and events to `path` file. If `interval` is set, a new file will be created for echo `interval` of seconds. The path `path` can be set with date and time formatting (strftime). The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). (:ref:`Packet_Binary_Dump_Format`) -.. index:: Command {dump bgp updates `path` [`interval`]} {} +.. index:: dump bgp updates PATH [INTERVAL] -Command {dump bgp updates `path` [`interval`]} {} -.. index:: Command {dump bgp updates-et `path` [`interval`]} {} +``dump bgp updates PATH [INTERVAL]`` +.. index:: dump bgp updates-et PATH [INTERVAL] -Command {dump bgp updates-et `path` [`interval`]} {} -.. index:: Command {no dump bgp updates [`path`] [`interval`]} {} +``dump bgp updates-et PATH [INTERVAL]`` +.. index:: no dump bgp updates [PATH] [INTERVAL] -Command {no dump bgp updates [`path`] [`interval`]} {} - Dump only BGP updates messages to `path` file. - If `interval` is set, a new file will be created for echo `interval` of seconds. - The path `path` can be set with date and time formatting (strftime). - The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). +``no dump bgp updates [PATH] [INTERVAL]`` + Dump only BGP updates messages to `path` file. + If `interval` is set, a new file will be created for echo `interval` of seconds. + The path `path` can be set with date and time formatting (strftime). + The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). -.. index:: Command {dump bgp routes-mrt `path`} {} +.. index:: dump bgp routes-mrt PATH -Command {dump bgp routes-mrt `path`} {} -.. index:: Command {dump bgp routes-mrt `path` `interval`} {} +``dump bgp routes-mrt PATH`` +.. index:: dump bgp routes-mrt PATH INTERVAL -Command {dump bgp routes-mrt `path` `interval`} {} -.. index:: Command {no dump bgp route-mrt [`path`] [`interval`]} {} +``dump bgp routes-mrt PATH INTERVAL`` +.. index:: no dump bgp route-mrt [PATH] [INTERVAL] -Command {no dump bgp route-mrt [`path`] [`interval`]} {} - Dump whole BGP routing table to `path`. This is heavy process. - The path `path` can be set with date and time formatting (strftime). - If `interval` is set, a new file will be created for echo `interval` of seconds. +``no dump bgp route-mrt [PATH] [INTERVAL]`` + Dump whole BGP routing table to `path`. This is heavy process. + The path `path` can be set with date and time formatting (strftime). + If `interval` is set, a new file will be created for echo `interval` of seconds. - Note: the interval variable can also be set using hours and minutes: 04h20m00. + Note: the interval variable can also be set using hours and minutes: 04h20m00. BGP Configuration Examples ========================== @@ -2174,7 +2227,7 @@ Example of a session to an upstream, advertising only one prefix to it. ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 ip prefix-list pl-allowed-adv seq 10 deny any - + A more complex example. With upstream, peer and customer sessions. Advertising global prefixes and NO_EXPORT prefixes and providing @@ -2340,7 +2393,7 @@ flaws. ! ! ##################################################################### ! Community actions to take when advertising a route. - ! These are filtering route-maps, + ! These are filtering route-maps, ! ! Deny customer routes to upstream with cust-only set. route-map rm-community-filt-to-upstream deny 10 @@ -2387,6 +2440,6 @@ flaws. ! route-map rm-peer-in permit 10 set community additive 64512:3200 - + @include rpki.texi From be46d2884737e18c6d0996a17c622b5bff336dee Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 19 Jan 2018 14:11:06 -0500 Subject: [PATCH 015/148] doc: use RST variable substitutions In conf.py, extract & construct values for inline variables throughout the docs. In the docs, use these inline variables in RST syntax. Signed-off-by: Quentin Young --- doc/user/basic.rst | 16 +++---- doc/user/conf.py | 42 +++++++++++++----- doc/user/defines.rst | 2 +- doc/user/eigrpd.rst | 2 +- doc/user/installation.rst | 2 +- doc/user/nhrpd.rst | 2 +- doc/user/overview.rst | 92 +++++++++++++++++++-------------------- doc/user/ripd.rst | 2 +- doc/user/vtysh.rst | 16 +++---- 9 files changed, 96 insertions(+), 80 deletions(-) diff --git a/doc/user/basic.rst b/doc/user/basic.rst index c46665c501..933d49b01a 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -39,12 +39,12 @@ starting. Config files are generally found in: -* :file:`@value{INSTALL_PREFIX_ETC}`/\*.conf +* :file:`|INSTALL_PREFIX_ETC|`/\*.conf Each of the daemons has its own config file. For example, zebra's default config file name is: -* :file:`@value{INSTALL_PREFIX_ETC`/zebra.conf} +* :file:`INSTALL_PREFIX_ETC`/zebra.conf The daemon name plus :file:`.conf` is the default config file name. You can specify a config file using the :kbd:`-f` or :kbd:`--config-file` @@ -312,7 +312,7 @@ Terminal Mode Commands .. index:: show version ``show version`` - Show the current version of @value{PACKAGE_NAME} and its build host information. + Show the current version of |PACKAGE_NAME| and its build host information. .. index:: show logging @@ -331,7 +331,7 @@ Terminal Mode Commands Common Invocation Options ========================= -These options apply to all @value{PACKAGE_NAME} daemons. +These options apply to all |PACKAGE_NAME| daemons. ``-d, --daemon`` @@ -354,7 +354,7 @@ These options apply to all @value{PACKAGE_NAME} daemons. The file name is an run-time option rather than a configure-time option so that multiple routing daemons can be run simultaneously. This is - useful when using @value{PACKAGE_NAME} to implement a routing looking glass. One + useful when using |PACKAGE_NAME| to implement a routing looking glass. One machine can be used to collect differing routing views from differing points in the network. @@ -391,7 +391,7 @@ the following command line option at daemon startup: Load the specified module, optionally passing options to it. If the module name contains a slash (/), it is assumed to be a full pathname to a file to be loaded. If it does not contain a slash, the - `@value{INSTALL_PREFIX_MODULES`} directory is searched for a module of + `INSTALL_PREFIX_MODULES` directory is searched for a module of the given name; first with the daemon name prepended (e.g. ``zebra_mod`` for ``mod``), then without the daemon name prepended. @@ -447,8 +447,8 @@ is no VTY password, one cannot connect to the VTY interface at all. Connected to localhost. Escape character is '^]'. - Hello, this is @value{PACKAGE_NAME} (version @value{PACKAGE_VERSION}) - @value{COPYRIGHT_STR} + Hello, this is |PACKAGE_NAME| (version |PACKAGE_VERSION|) + |COPYRIGHT_STR| User Access Verification diff --git a/doc/user/conf.py b/doc/user/conf.py index d62e46301c..23ca7d8fe7 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -62,7 +62,30 @@ version = u'?.?' # The full version, including alpha/beta/rc tags. release = u'?.?-?' -install_prefix_etc = "" + +# ----------------------------------------------------------------------------- +# Extract values from codebase for substitution into docs. +# ----------------------------------------------------------------------------- + +# Various installation prefixes. Reasonable defaults are set where possible. +# Values are overridden by logic below. +replace_vars = { + 'AUTHORS': 'Kunihiro Ishiguro, et al.', + 'COPYRIGHT_YEAR': '1999-2005', + 'COPYRIGHT_STR': None, + 'PACKAGE_NAME': project.lower(), + 'PACKAGE_TARNAME': project.lower(), + 'PACKAGE_STRING': None, + 'PACKAGE_URL': 'https://frrouting.org/', + 'PACKAGE_VERSION': None, + 'INSTALL_PREFIX_ETC': None, + 'INSTALL_PREFIX_SBIN': None, + 'INSTALL_PREFIX_STATE': None, + 'INSTALL_PREFIX_MODULES': None, + 'INSTALL_USER': None, + 'INSTALL_GROUP': None, + 'INSTALL_VTY_GROUP': None, +} # extract version information, installation location, other stuff we need to # use when building final documents @@ -70,20 +93,15 @@ val = re.compile('^S\["([^"]+)"\]="(.*)"$') with open('../../config.status', 'r') as cfgstatus: for ln in cfgstatus.readlines(): m = val.match(ln) - if m is None: continue - if m.group(1) == 'PACKAGE_VERSION': - release = m.group(2) - version = release.split('-')[0] - if m.group(1) == 'CFG_SYSCONF': - install_prefix_etc = m.group(2) + if not m or m.group(1) not in replace_vars.keys(): continue + replace_vars[m.group(1)] = m.group(2) +# manually fill out some of these we can't get from config.status +replace_vars['COPYRIGHT_STR'] = "Copyright (c) {} {}".format(replace_vars['COPYRIGHT_YEAR'], replace_vars['AUTHORS']) # add substitutions to prolog -rst_prolog += ''' -.. |INSTALL_PREFIX_ETC| replace:: {} -.. |PACKAGE_VERSION| replace:: {} -'''.format(install_prefix_etc, version) - +for key, value in replace_vars.items(): + rst_prolog += '.. |{0}| replace:: {1}\n'.format(key, value) # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/user/defines.rst b/doc/user/defines.rst index 014d66d0e8..e8c779d3a0 100644 --- a/doc/user/defines.rst +++ b/doc/user/defines.rst @@ -12,7 +12,7 @@ @set PACKAGE_VERSION 3.1-dev @set AUTHORS Kunihiro Ishiguro, et al. @set COPYRIGHT_YEAR 1999-2005 - @set COPYRIGHT_STR Copyright @copyright{} @value{COPYRIGHT_YEAR} @value{AUTHORS} + @set COPYRIGHT_STR Copyright @copyright{} |COPYRIGHT_YEAR| |AUTHORS| @c These may vary with installation environment. @set INSTALL_PREFIX_ETC /etc/frr diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index effec5dc1e..7686ef099d 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -20,7 +20,7 @@ Starting and Stopping eigrpd The default configuration file name of *eigrpd*'s is :file:`eigrpd.conf`. When invocation *eigrpd* searches directory -@value{INSTALL_PREFIX_ETC}. If :file:`eigrpd.conf` is not there next +|INSTALL_PREFIX_ETC|. If :file:`eigrpd.conf` is not there next search current directory. If an integrated config is specified configuration is written into frr.conf diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 8ede815f7e..4695a08373 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -325,5 +325,5 @@ specify a port number when starting the daemon, these entries may not be needed. You may need to make changes to the config files in -:file:`@value{INSTALL_PREFIX_ETC`/\*.conf}. :ref:`Config_Commands`. +:file:`|INSTALL_PREFIX_ETC`/\*.conf|. :ref:`Config_Commands`. diff --git a/doc/user/nhrpd.rst b/doc/user/nhrpd.rst index 24037f85b6..a16730a3cc 100644 --- a/doc/user/nhrpd.rst +++ b/doc/user/nhrpd.rst @@ -15,7 +15,7 @@ these systems to directly communicate without requiring traffic to use an intermediate hop. Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and -@value{PACKAGE_NAME} nhrpd implements this scenario. +|PACKAGE_NAME| nhrpd implements this scenario. .. _Routing_Design: diff --git a/doc/user/overview.rst b/doc/user/overview.rst index 6393d0ba07..204393e2df 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -6,64 +6,63 @@ Overview .. index:: Overview -`@value{PACKAGE_URL <@value{PACKAGE_URL>`_,,Frr} is a routing software package that -provides TCP/IP based routing services with routing protocols support such -as RIPv1, RIPv2, RIPng, OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`Supported_RFCs`). Frr also supports special BGP Route Reflector and Route Server -behavior. In addition to traditional IPv4 routing protocols, Frr also -supports IPv6 routing protocols. With SNMP daemon which supports SMUX and AgentX -protocol, Frr provides routing protocol MIBs (:ref:`SNMP_Support`). +`FRR <|PACKAGE_URL|>`_ is a routing software package that provides TCP/IP based +routing services with routing protocols support such as RIPv1, RIPv2, RIPng, +OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`Supported_RFCs`). FRR also +supports special BGP Route Reflector and Route Server behavior. In addition to +traditional IPv4 routing protocols, FRR also supports IPv6 routing protocols. +With SNMP daemon which supports SMUX and AgentX protocol, FRR provides routing +protocol MIBs (:ref:`SNMP_Support`). -Frr uses an advanced software architecture to provide you with a high -quality, multi server routing engine. Frr has an interactive user +FRR uses an advanced software architecture to provide you with a high +quality, multi server routing engine. FRR has an interactive user interface for each routing protocol and supports common client commands. -Due to this design, you can add new protocol daemons to Frr easily. You -can use Frr library as your program's client user interface. +Due to this design, you can add new protocol daemons to FRR easily. You +can use FRR library as your program's client user interface. -Frr is distributed under the @sc{gnu} General Public License. +FRR is distributed under the GNU General Public License. -@comment node-name, next, previous, up - -About Frr +About FRR ========= -.. index:: About Frr +.. index:: About FRR Today, TCP/IP networks are covering all of the world. The Internet has been deployed in many countries, companies, and to the home. When you connect to the Internet your packet will pass many routers which have TCP/IP routing functionality. -A system with Frr installed acts as a dedicated router. With Frr, +A system with FRR installed acts as a dedicated router. With FRR, your machine exchanges routing information with other routers using routing -protocols. Frr uses this information to update the kernel routing table +protocols. FRR uses this information to update the kernel routing table so that the right data goes to the right place. You can dynamically change -the configuration and you may view routing table information from the Frr +the configuration and you may view routing table information from the FRR terminal interface. -Adding to routing protocol support, Frr can setup interface's flags, +Adding to routing protocol support, FRR can setup interface's flags, interface's address, static routes and so on. If you have a small network, -or a stub network, or xDSL connection, configuring the Frr routing +or a stub network, or xDSL connection, configuring the FRR routing software is very easy. The only thing you have to do is to set up the interfaces and put a few commands about static routes and/or default routes. If the network is rather large, or if the network structure changes -frequently, you will want to take advantage of Frr's dynamic routing +frequently, you will want to take advantage of FRR's dynamic routing protocol support for protocols such as RIP, OSPF, IS-IS or BGP. Traditionally, UNIX based router configuration is done by *ifconfig* and *route* commands. Status of routing table is displayed by *netstat* utility. Almost of these commands -work only if the user has root privileges. Frr has a different system -administration method. There are two user modes in Frr. One is normal +work only if the user has root privileges. FRR has a different system +administration method. There are two user modes in FRR. One is normal mode, the other is enable mode. Normal mode user can only view system status, enable mode user can change system configuration. This UNIX account independent feature will be great help to the router administrator. -Currently, Frr supports common unicast routing protocols, that is BGP, +Currently, FRR supports common unicast routing protocols, that is BGP, OSPF, RIP and IS-IS. Upcoming for MPLS support, an implementation of LDP is currently being prepared for merging. Implementations of BFD and PIM-SSM (IPv4) also exist, but are not actively being worked on. -The ultimate goal of the Frr project is making a productive, quality, free +The ultimate goal of the FRR project is making a productive, quality, free TCP/IP routing software package. @comment node-name, next, previous, up @@ -78,7 +77,7 @@ System Architecture .. index:: Software internals Traditional routing software is made as a one process program which -provides all of the routing protocol functionalities. Frr takes a +provides all of the routing protocol functionalities. FRR takes a different approach. It is made from a collection of several daemons that work together to build the routing table. There may be several protocol-specific routing daemons and zebra the kernel routing manager. @@ -110,7 +109,7 @@ architecture creates new possibilities for the routing system. | | +------------------------------+ - Frr System Architecture + FRR System Architecture @end group @@ -120,11 +119,11 @@ and terminal interfaces. Each daemon has it's own configuration file and terminal interface. When you configure a static route, it must be done in *zebra* configuration file. When you configure BGP network it must be done in *bgpd* configuration file. This can be a very annoying -thing. To resolve the problem, Frr provides integrated user interface +thing. To resolve the problem, FRR provides integrated user interface shell called *vtysh*. *vtysh* connects to each daemon with UNIX domain socket and then works as a proxy for user input. -Frr was planned to use multi-threaded mechanism when it runs with a +FRR was planned to use multi-threaded mechanism when it runs with a kernel that supports multi-threads. But at the moment, the thread library which comes with @sc{gnu}/Linux or FreeBSD has some problems with running reliable services such as routing software, so we don't use threads at all. @@ -138,20 +137,20 @@ Supported Platforms .. index:: Supported platforms -.. index:: Frr on other systems +.. index:: FRR on other systems .. index:: Compatibility with other systems -.. index:: Operating systems that support Frr +.. index:: Operating systems that support FRR -Currently Frr supports @sc{gnu}/Linux and BSD. Porting Frr +Currently FRR supports @sc{gnu}/Linux and BSD. Porting FRR to other platforms is not too difficult as platform dependent code should most be limited to the *zebra* daemon. Protocol daemons are mostly -platform independent. Please let us know when you find out Frr runs on a +platform independent. Please let us know when you find out FRR runs on a platform which is not listed below. The list of officially supported platforms are listed below. Note that -Frr may run correctly on other platforms, and may run with partial +FRR may run correctly on other platforms, and may run with partial functionality on further platforms. @sp 1 @@ -178,7 +177,7 @@ may work with some effort: Mac OSX Also note that, in particular regarding proprietary platforms, compiler -and C library choice will affect Frr. Only recent versions of the +and C library choice will affect FRR. Only recent versions of the following C compilers are well-tested: @sp 1 @@ -291,18 +290,17 @@ When SNMP support is enabled, below RFC is also supported. @comment node-name, next, previous, up -How to get Frr +How to get FRR ============== -The official Frr web-site is located at: +The official FRR web-site is located at: -`@value{PACKAGE_URL <@value{PACKAGE_URL>`_} +`|PACKAGE_URL| <|PACKAGE_URL|>`_ and contains further information, as well as links to additional resources. -`@value{PACKAGE_URL <@value{PACKAGE_URL>`_,Frr} is a fork of Quagga, whose -web-site is located at: +FRR is a fork of Quagga, whose website is located at: `http://www.quagga.net/ `_. @@ -311,20 +309,20 @@ web-site is located at: Mailing List ============ -.. index:: How to get in touch with Frr +.. index:: How to get in touch with FRR -.. index:: Mailing Frr +.. index:: Mailing FRR .. index:: Contact information .. index:: Mailing lists -There is a mailing list for discussions about Frr. If you have any -comments or suggestions to Frr, please subscribe to: +There is a mailing list for discussions about FRR. If you have any +comments or suggestions to FRR, please subscribe to: `https://lists.frrouting.org/listinfo/frog `_. -The `@value{PACKAGE_URL <@value{PACKAGE_URL>`_,,Frr} site has further information on +The `FRR <|PACKAGE_URL|>`_ site has further information on the available mailing lists, see: `https://lists.frrouting.org/ `_ @@ -361,7 +359,7 @@ When you send a bug report, please be careful about the points below. Please send your configuration file with the report. If you specify arguments to the configure script please note that too. -Bug reports are very important for us to improve the quality of Frr. -Frr is still in the development stage, but please don't hesitate to +Bug reports are very important for us to improve the quality of FRR. +FRR is still in the development stage, but please don't hesitate to send a bug report to `http://github.com/frrouting/frr/issues `_. diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 0aae9bcc39..dc9d7c06d2 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -23,7 +23,7 @@ Starting and Stopping ripd The default configuration file name of *ripd*'s is :file:`ripd.conf`. When invocation *ripd* searches directory -@value{INSTALL_PREFIX_ETC}. If :file:`ripd.conf` is not there next +|INSTALL_PREFIX_ETC|. If :file:`ripd.conf` is not there next search current directory. RIP uses UDP port 520 to send and receive RIP packets. So the user must have diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst index d6ed3631a2..a609c2fd7c 100644 --- a/doc/user/vtysh.rst +++ b/doc/user/vtysh.rst @@ -10,7 +10,7 @@ be disabled through the *--disable-vtysh* option to *./configure*. *vtysh* has a configuration file, :file:`vtysh.conf`. The location -of that file cannot be changed from :file:`@value{INSTALL_PREFIX_ETC`} since +of that file cannot be changed from :file:`|INSTALL_PREFIX_ETC|` since it contains options controlling authentication behavior. This file will also not be written by configuration-save commands, it is intended to be updated manually by an administrator with an external editor. @@ -25,28 +25,28 @@ Permissions and setup requirements ================================== *vtysh* connects to running daemons through Unix sockets located in -:file:`@value{INSTALL_PREFIX_STATE`}. Running vtysh thus requires access to -that directory, plus membership in the *@value{INSTALL_VTY_GROUP*} +:file:`|INSTALL_PREFIX_STATE|`. Running vtysh thus requires access to +that directory, plus membership in the *|INSTALL_VTY_GROUP|* group (which is the group that the daemons will change ownership of their sockets to). To restrict access to Frr configuration, make sure no unauthorized users -are members of the *@value{INSTALL_VTY_GROUP*} group. +are members of the *|INSTALL_VTY_GROUP|* group. PAM support (experimental) -------------------------- vtysh has working (but rather useless) PAM support. It will perform -an "authenticate" PAM call using *@value{PACKAGE_NAME*} as service +an "authenticate" PAM call using *|PACKAGE_NAME|* as service name. No other (accounting, session, password change) calls will be performed by vtysh. Users using vtysh still need to have appropriate access to the daemons' -VTY sockets, usually by being member of the *@value{INSTALL_VTY_GROUP*} +VTY sockets, usually by being member of the *|INSTALL_VTY_GROUP|* group. If they have this membership, PAM support is useless since they can connect to daemons and issue commands using some other tool. Alternatively, the *vtysh* binary could be made SGID (set group ID) to the -*@value{INSTALL_VTY_GROUP*} group. @strong{No security guarantees are +*|INSTALL_VTY_GROUP|* group. @strong{No security guarantees are made for this configuration}. .. index:: {Command} {username `username` nopassword} {} @@ -67,7 +67,7 @@ Integrated configuration mode uses a single configuration file, :file:`frr.conf`, for all daemons. This replaces the individual files like :file:`zebra.conf` or :file:`bgpd.conf`. -:file:`frr.conf` is located in :file:`@value{INSTALL_PREFIX_ETC`}. All +:file:`frr.conf` is located in :file:`|INSTALL_PREFIX_ETC|`. All daemons check for the existence of this file at startup, and if it exists will not load their individual configuration files. Instead, *vtysh -b* must be invoked to process :file:`frr.conf` and apply From dc1046f72608c0ee237c59957a240fbd135b794a Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 19 Jan 2018 14:13:00 -0500 Subject: [PATCH 016/148] doc: Frr -> FRR Signed-off-by: Quentin Young --- doc/user/bgp.rst | 22 +++++++++++----------- doc/user/filter.rst | 2 +- doc/user/ipv6.rst | 6 +++--- doc/user/kernel.rst | 6 +++--- doc/user/main.rst | 8 ++++---- doc/user/ospfd.rst | 6 +++--- doc/user/protocol.rst | 2 +- doc/user/ripd.rst | 8 ++++---- doc/user/routeserver.rst | 8 ++++---- doc/user/snmp.rst | 24 ++++++++++++------------ doc/user/vnc.rst | 4 ++-- doc/user/vtysh.rst | 8 ++++---- 12 files changed, 52 insertions(+), 52 deletions(-) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 9bc3b9a8af..fbc14ca140 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -107,7 +107,7 @@ BGP distance BGP decision process -------------------- -The decision process Frr BGP uses to select routes is as follows: +The decision process FRR BGP uses to select routes is as follows: @@ -258,7 +258,7 @@ The BGP MED (Multi_Exit_Discriminator) attribute has properties which can cause subtle convergence problems in BGP. These properties and problems have proven to be hard to understand, at least historically, and may still not be widely understood. The following attempts to collect together and -present what is known about MED, to help operators and Frr users in +present what is known about MED, to help operators and FRR users in designing and configuring their networks. The BGP :abbr:`MED ( Multi_Exit_Discriminator)` attribute is intended to @@ -281,7 +281,7 @@ MED values to those of AS X. The MED values have been set by different administrators, with different frames of reference. The default behaviour of BGP therefore is to not compare MED values across -routes received from different neighbouring ASes. In Frr this is done by +routes received from different neighbouring ASes. In FRR this is done by comparing the neighbouring, left-most AS in the received AS_PATHs of the routes and only comparing MED if those are the same. @@ -348,7 +348,7 @@ in response to the most common sequence of received updates. A deterministic order of evaluation tends to imply an additional overhead of sorting over any set of n routes to a destination. The implementation of -deterministic MED in Frr scales significantly worse than most sorting +deterministic MED in FRR scales significantly worse than most sorting algorithms at present, with the number of paths to a given destination. That number is often low enough to not cause any issues, but where there are many paths, the deterministic comparison may quickly become increasingly @@ -415,7 +415,7 @@ preferences between the routes: This particular type of oscillation in full-mesh iBGP topologies can be avoided by speakers preferring already selected, external routes rather than choosing to update to new a route based on a post-MED metric (e.g. -router-ID), at the cost of a non-deterministic selection process. Frr +router-ID), at the cost of a non-deterministic selection process. FRR implements this, as do many other implementations, so long as it is not overridden by setting :ref:`bgp_bestpath_compare-routerid`, and see also :ref:`BGP_decision_process`, . @@ -488,7 +488,7 @@ iBGP topology should follow the IGP topology. in. Setting this option will have a performance cost that may be noticeable when - there are many routes for each destination. Currently in Frr it is + there are many routes for each destination. Currently in FRR it is implemented in a way that scales poorly as the number of routes per destination increases. @@ -1804,11 +1804,11 @@ unicast neighbor, *bgpd* does not send these Capability Negotiation packets (at least not unless other optional BGP features require capability negotation). -By default, Frr will bring up peering with minimal common capability +By default, FRR will bring up peering with minimal common capability for the both sides. For example, local router has unicast and multicast capabilitie and remote router has unicast capability. In this case, the local router will establish the connection with unicast -only capability. When there are no common capabilities, Frr sends +only capability. When there are no common capabilities, FRR sends Unsupported Capability error and then resets the connection. If you want to completely match capabilities with remote peer. Please @@ -1938,10 +1938,10 @@ When bgp config-type cisco is specified, 'network' and 'aggregate-address' argument is displayed as 'A.B.C.D M.M.M.M' -Frr: network 10.0.0.0/8 +FRR: network 10.0.0.0/8 Cisco: network 10.0.0.0 -Frr: aggregate-address 192.168.0.0/24 +FRR: aggregate-address 192.168.0.0/24 Cisco: aggregate-address 192.168.0.0 255.255.255.0 Community attribute handling is also different. If there is no @@ -1972,7 +1972,7 @@ to specify *neighbor A.B.C.D send-community* command. .. index:: bgp config-type zebra ``bgp config-type zebra`` - Frr style BGP configuration. This is default. + FRR style BGP configuration. This is default. .. _BGP_instance_and_view: diff --git a/doc/user/filter.rst b/doc/user/filter.rst index 75f5933e7b..730e42403a 100644 --- a/doc/user/filter.rst +++ b/doc/user/filter.rst @@ -2,7 +2,7 @@ Filtering ********* -Frr provides many very flexible filtering features. Filtering is used +FRR provides many very flexible filtering features. Filtering is used for both input and output of the routing information. Once filtering is defined, it can be applied in any direction. diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 0b1088e5d7..9a842ee595 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -4,13 +4,13 @@ IPv6 Support ************ -Frr fully supports IPv6 routing. As described so far, Frr supports +FRR fully supports IPv6 routing. As described so far, Frr supports RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface -and configure static IPv6 routing information. Frr IPv6 also provides +and configure static IPv6 routing information. FRR IPv6 also provides automatic address configuration via a feature called ``address auto configuration``. To do it, the router must send router advertisement messages to the all nodes that exist on the network. -Previous versions of Frr could be built without IPv6 support. This is +Previous versions of FRR could be built without IPv6 support. This is no longer possible. Router Advertisement diff --git a/doc/user/kernel.rst b/doc/user/kernel.rst index 04559ffa9a..4161c4ae94 100644 --- a/doc/user/kernel.rst +++ b/doc/user/kernel.rst @@ -35,7 +35,7 @@ interfaces. *netlink* On recent Linux kernels (2.0.x and 2.2.x), there is a kernel/user communication support called `netlink`. It makes asynchronous - communication between kernel and Frr possible, similar to a routing + communication between kernel and FRR possible, similar to a routing socket on BSD systems. Before you use this feature, be sure to select (in kernel configuration) @@ -45,7 +45,7 @@ interfaces. Today, the /dev/route special device file is obsolete. Netlink communication is done by reading/writing over netlink socket. - After the kernel configuration, please reconfigure and rebuild Frr. - You can use netlink as a dynamic routing update channel between Frr + After the kernel configuration, please reconfigure and rebuild FRR. + You can use netlink as a dynamic routing update channel between FRR and the kernel. diff --git a/doc/user/main.rst b/doc/user/main.rst index a48a27d9c1..d42da83a46 100644 --- a/doc/user/main.rst +++ b/doc/user/main.rst @@ -351,7 +351,7 @@ addresses but unicast addresses. This table is fully separate from the default unicast table. However, RPF lookup can include the unicast table. -WARNING: RPF lookup results are non-responsive in this version of Frr, +WARNING: RPF lookup results are non-responsive in this version of FRR, i.e. multicast routing does not actively react to changes in underlying unicast topology! @@ -483,17 +483,17 @@ zebra FIB push interface ======================== Zebra supports a 'FIB push' interface that allows an external -component to learn the forwarding information computed by the Frr +component to learn the forwarding information computed by the FRR routing suite. This is a loadable module that needs to be enabled at startup as described in :ref:`Loadable_Module_Support`. -In Frr, the Routing Information Base (RIB) resides inside +In FRR, the Routing Information Base (RIB) resides inside zebra. Routing protocols communicate their best routes to zebra, and zebra computes the best route across protocols for each prefix. This latter information makes up the Forwarding Information Base (FIB). Zebra feeds the FIB to the kernel, which allows the IP stack in the kernel to forward packets according to the routes computed by -Frr. The kernel FIB is updated in an OS-specific way. For example, +FRR. The kernel FIB is updated in an OS-specific way. For example, the `netlink` interface is used on Linux, and route sockets are used on FreeBSD. diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 78360c7503..65a5959447 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -79,7 +79,7 @@ Command {no router ospf} {} to ensure routing-loops are avoided. With the "Cisco" or "IBM" ABR type, the default in this release of - Frr, this restriction is lifted, allowing an ABR to consider + FRR, this restriction is lifted, allowing an ABR to consider summaries learnt from other ABRs through non-backbone areas, and hence route via non-backbone areas as a last resort when, and only when, backbone links are down. @@ -186,7 +186,7 @@ Command {no router ospf} {} hold-time increasing by 400ms each time an SPF-triggering event occurs within the hold-time of the previous SPF calculation. - This command supercedes the *timers spf* command in previous Frr + This command supercedes the *timers spf* command in previous FRR releases. .. index:: {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} @@ -309,7 +309,7 @@ OSPF area announced to other areas. This command can be used only in ABR and ONLY router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. - Summarizing Type-7 AS-external-LSAs isn't supported yet by Frr. + Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR. :: diff --git a/doc/user/protocol.rst b/doc/user/protocol.rst index 2a9b76df03..2dce4c9855 100644 --- a/doc/user/protocol.rst +++ b/doc/user/protocol.rst @@ -32,7 +32,7 @@ seperate commands. Version 0 is used by all versions of GNU Zebra as of this writing, and versions of Quagga up to and including Quagga 0.98. Version 2 was created for 0.99.21 of Quagga. Version 3 designates VRF compatibility and was -released in 1.0. Version 4 will be used as of Frr 2.0 to indicate that +released in 1.0. Version 4 will be used as of FRR 2.0 to indicate that we are a different Routing Suite now and to hopefully prevent accidental Quagga <-> FRR issues. diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index dc9d7c06d2..53fca7c57f 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -86,7 +86,7 @@ to the packet on the basis of the interface that received the packet. Version 2 of RIP supports a variable length subnet mask (VLSM). By extending the subnet mask, the mask can be divided and reused. Each subnet can be used for different purposes such as large to middle size -LANs and WAN links. Frr *ripd* does not support the non-sequential +LANs and WAN links. FRR *ripd* does not support the non-sequential netmasks that are included in RIP Version 2. In a case of similar information with the same prefix and metric, the @@ -345,10 +345,10 @@ How to Announce RIP route .. index:: {RIP command} {no route `a.b.c.d/m`} {} {RIP command} {no route `a.b.c.d/m`} {} - This command is specific to Frr. The `route` command makes a static + This command is specific to FRR. The `route` command makes a static route only inside RIP. This command should be used only by advanced users who are particularly knowledgeable about the RIP protocol. In - most cases, we recommend creating a static route in Frr and + most cases, we recommend creating a static route in FRR and redistributing it in RIP using `redistribute static`. .. _Filtering_RIP_Routes: @@ -476,7 +476,7 @@ statement. Cisco applies route-map _before_ routes will exported to rip route table. -In current Frr's test implementation, *ripd* applies route-map +In current FRR's test implementation, *ripd* applies route-map after routes are listed in the route table and before routes will be announced to an interface (something like output filter). I think it is not so clear, but it is draft and it may be changed at future. diff --git a/doc/user/routeserver.rst b/doc/user/routeserver.rst index ac73e30b87..9ebbe17671 100644 --- a/doc/user/routeserver.rst +++ b/doc/user/routeserver.rst @@ -1,7 +1,7 @@ -.. _Configuring_Frr_as_a_Route_Server: +.. _Configuring_FRR_as_a_Route_Server: ********************************* -Configuring Frr as a Route Server +Configuring FRR as a Route Server ********************************* The purpose of a Route Server is to centralize the peerings between BGP @@ -11,8 +11,8 @@ speakers, each of which maintaining a BGP peering with the other three each of the four establishes a single BGP peering against the Route Server (:ref:`fig:route-server`). -We will first describe briefly the Route Server model implemented by Frr. +We will first describe briefly the Route Server model implemented by FRR. We will explain the commands that have been added for configuring that -model. And finally we will show a full example of Frr configured as Route +model. And finally we will show a full example of FRR configured as Route Server. diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 286104e396..5c7da0e00c 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -6,7 +6,7 @@ SNMP Support @acronym{SNMP,Simple Network Managing Protocol} is a widely implemented feature for collecting network information from router and/or host. -Frr itself does not support SNMP agent (server daemon) functionality +FRR itself does not support SNMP agent (server daemon) functionality but is able to connect to a SNMP agent using the SMUX protocol (@cite{RFC1227}) or the AgentX protocol (@cite{RFC2741}) and make the routing protocol MIBs available through it. @@ -25,7 +25,7 @@ version of `net-snmp` which was formerly known as `ucd-snmp`. It is free and open software and available at `http://www.net-snmp.org/ `_ and as binary package for most Linux distributions. `net-snmp` has to be compiled with `--with-mib-modules=agentx` to -be able to accept connections from Frr using AgentX protocol or with +be able to accept connections from FRR using AgentX protocol or with `--with-mib-modules=smux` to use SMUX protocol. Nowadays, SMUX is a legacy protocol. The AgentX protocol should be @@ -36,11 +36,11 @@ preferred for any new deployment. Both protocols have the same coverage. AgentX configuration ==================== -To enable AgentX protocol support, Frr must have been build with the +To enable AgentX protocol support, FRR must have been build with the `--enable-snmp` or `--enable-snmp=agentx` option. Both the -master SNMP agent (snmpd) and each of the Frr daemons must be +master SNMP agent (snmpd) and each of the FRR daemons must be configured. In `/etc/snmp/snmpd.conf`, `master agentx` -directive should be added. In each of the Frr daemons, `agentx` +directive should be added. In each of the FRR daemons, `agentx` command will enable AgentX support. :: @@ -66,7 +66,7 @@ command will enable AgentX support. Upon successful connection, you should get something like this in the -log of each Frr daemons: +log of each FRR daemons: :: @@ -84,7 +84,7 @@ Then, you can use the following command to check everything works as expected: The AgentX protocol can be transported over a Unix socket or using TCP or UDP. It usually defaults to a Unix socket and depends on how NetSNMP -was built. If need to configure Frr to use another transport, you can +was built. If need to configure FRR to use another transport, you can configure it through `/etc/snmp/frr.conf`: :: @@ -100,11 +100,11 @@ configure it through `/etc/snmp/frr.conf`: SMUX configuration ================== -To enable SMUX protocol support, Frr must have been build with the +To enable SMUX protocol support, FRR must have been build with the `--enable-snmp=smux` option. A separate connection has then to be established between the -SNMP agent (snmpd) and each of the Frr daemons. This connections +SNMP agent (snmpd) and each of the FRR daemons. This connections each use different OID numbers and passwords. Be aware that this OID number is not the one that is used in queries by clients, it is solely used for the intercommunication of the daemons. @@ -125,7 +125,7 @@ restrictions can be hard to debug. view all included .1 80 access MyROGroup "" any noauth exact all none none # - # the following line is relevant for Frr + # the following line is relevant for FRR # smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd @@ -159,7 +159,7 @@ MIB and command reference ========================= The following OID numbers are used for the interprocess communication of snmpd and -the Frr daemons with SMUX only. +the FRR daemons with SMUX only. :: (OIDs below .iso.org.dod.internet.private.enterprises) @@ -181,7 +181,7 @@ OID numbers are used for querying the SNMP daemon by a client: ospf6d .1.3.6.1.3.102 .iso.org.dod.internet.experimental.ospfv3 -The following syntax is understood by the Frr daemons for configuring SNMP using SMUX: +The following syntax is understood by the FRR daemons for configuring SNMP using SMUX: .. index:: {Command} {smux peer `oid`} {} {Command} {smux peer `oid`} {} diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 6d9c4c40fe..525e4b1ecf 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -85,8 +85,8 @@ RFP Related Configuration The protocol that is used to communicate routing and Ethernet / L2 forwarding information between NVAs and NVEs is referred to as the Remote Forwarder Protocol (RFP). Currently, only a simple example RFP -is included in Frr. Developers may use this example as a starting -point to integrate Frr with an RFP of their choosing, e.g., +is included in FRR. Developers may use this example as a starting +point to integrate FRR with an RFP of their choosing, e.g., `OpenFlow`. The example code includes the following sample configuration: diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst index a609c2fd7c..d94eba110e 100644 --- a/doc/user/vtysh.rst +++ b/doc/user/vtysh.rst @@ -4,7 +4,7 @@ VTY shell ********* -*vtysh* provides a combined frontend to all Frr daemons in a +*vtysh* provides a combined frontend to all FRR daemons in a single combined session. It is enabled by default at build time, but can be disabled through the *--disable-vtysh* option to *./configure*. @@ -30,7 +30,7 @@ that directory, plus membership in the *|INSTALL_VTY_GROUP|* group (which is the group that the daemons will change ownership of their sockets to). -To restrict access to Frr configuration, make sure no unauthorized users +To restrict access to FRR configuration, make sure no unauthorized users are members of the *|INSTALL_VTY_GROUP|* group. PAM support (experimental) @@ -103,7 +103,7 @@ file with incorrect owner or permissions. Writing the configuration can be triggered directly by invoking *vtysh -w*. This may be useful for scripting. Note this command -should be run as either the superuser or the Frr user. +should be run as either the superuser or the FRR user. We recommend you do not mix the use of the two types of files. Further, it is better not to use the integrated frr.conf file, as any syntax error in @@ -121,7 +121,7 @@ the daemon in whose file the error is made. 'write file' is issued. These commands need to be placed in :file:`vtysh.conf` to have any effect. - Note that since :file:`vtysh.conf` is not written by Frr itself, they + Note that since :file:`vtysh.conf` is not written by FRR itself, they therefore need to be manually placed in that file. This command has 3 states: From 44f2550ef38c6562ffd866fa89198f64970d2b67 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 19 Jan 2018 17:03:07 -0500 Subject: [PATCH 017/148] doc: clean up overview.rst, installation.rst Just reading through the docs and fixing bugs as I go. Signed-off-by: Quentin Young --- doc/user/installation.rst | 36 ++--- doc/user/overview.rst | 285 +++++++++++++++----------------------- 2 files changed, 128 insertions(+), 193 deletions(-) diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 4695a08373..a60d09dd43 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -5,27 +5,27 @@ Installation ************ .. index:: How to install FRR - .. index:: Installation - .. index:: Installing FRR - .. index:: Building the system - .. index:: Making FRR -There are three steps for installing the software: configuration, -compilation, and installation. +Several distributions provide packages for FRR. Check your distribution's +respositories to find out if a suitable version is available. -The easiest way to get FRR running is to issue the following -commands: +If you wish to build FRR yourself, please see the `Building`_ appendix. + +FRR depends on various libraries depending on your operationg system. + +After installing these dependencies, change to the frr source directory and issue the following commands: :: - % configure + % ./bootstrap.sh + % ./configure % make % make install - + .. _Configure_the_Software: @@ -133,9 +133,9 @@ customize the build to include or exclude specific features and dependencies. only tool and should not be used for normal operations You may specify any combination of the above options to the configure -script. By default, the executables are placed in :file:`/usr/local/sbin` +script. By default, the executables are placed in :file:`/usr/local/sbin` and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/` -installation prefix and other directories may be changed using the following +installation prefix and other directories may be changed using the following options to the configuration script. @@ -154,7 +154,7 @@ options to the configuration script. :: % ./configure --disable-snmp - + This command will configure zebra and the routing daemons. @@ -180,7 +180,7 @@ options to control the behaviour of FRR daemons. *--enable-group=`group`* Switch real and effective group to `group` shortly after - startup. + startup. *--enable-vty-group=`group`* Create Unix Vty sockets (for use with vtysh) with group owndership set to @@ -233,7 +233,7 @@ recommendations do exist. *CONFIG_IP_MULTICAST* - IP: multicasting. + IP: multicasting. This option should be specified when you use *ripd* (:ref:`RIP`) or *ospfd* (:ref:`OSPFv2`) because these protocols use multicast. @@ -278,7 +278,7 @@ bug report :ref:`Bug_Reports`. % ./bootstrap.sh % ./configure % make - + @comment node-name, next, previous, up @@ -298,7 +298,7 @@ prompt: *make install*. % % make install % - + FRR daemons have their own terminal interface or VTY. After installation, you have to setup each beast's port number to connect to @@ -317,7 +317,7 @@ them. Please add the following entries to :file:`/etc/services`. isisd 2608/tcp # ISISd vty nhrpd 2610/tcp # nhrpd vty pimd 2611/tcp # PIMd vty - + If you use a FreeBSD newer than 2.2.8, the above entries are already added to :file:`/etc/services` so there is no need to add it. If you diff --git a/doc/user/overview.rst b/doc/user/overview.rst index 204393e2df..5fd9b490c6 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -4,11 +4,9 @@ Overview ******** -.. index:: Overview - -`FRR <|PACKAGE_URL|>`_ is a routing software package that provides TCP/IP based +`FRR`_ is a routing software package that provides TCP/IP based routing services with routing protocols support such as RIPv1, RIPv2, RIPng, -OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`Supported_RFCs`). FRR also +OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`supported-rfcs`). FRR also supports special BGP Route Reflector and Route Server behavior. In addition to traditional IPv4 routing protocols, FRR also supports IPv6 routing protocols. With SNMP daemon which supports SMUX and AgentX protocol, FRR provides routing @@ -16,17 +14,17 @@ protocol MIBs (:ref:`SNMP_Support`). FRR uses an advanced software architecture to provide you with a high quality, multi server routing engine. FRR has an interactive user -interface for each routing protocol and supports common client commands. +interface for each routing protocol and supports common client commands. Due to this design, you can add new protocol daemons to FRR easily. You can use FRR library as your program's client user interface. FRR is distributed under the GNU General Public License. +.. _About-FRR: + About FRR ========= -.. index:: About FRR - Today, TCP/IP networks are covering all of the world. The Internet has been deployed in many countries, companies, and to the home. When you connect to the Internet your packet will pass many routers which have TCP/IP @@ -43,7 +41,7 @@ Adding to routing protocol support, FRR can setup interface's flags, interface's address, static routes and so on. If you have a small network, or a stub network, or xDSL connection, configuring the FRR routing software is very easy. The only thing you have to do is to set up the -interfaces and put a few commands about static routes and/or default routes. +interfaces and put a few commands about static routes and/or default routes. If the network is rather large, or if the network structure changes frequently, you will want to take advantage of FRR's dynamic routing protocol support for protocols such as RIP, OSPF, IS-IS or BGP. @@ -65,7 +63,6 @@ currently being prepared for merging. Implementations of BFD and PIM-SSM The ultimate goal of the FRR project is making a productive, quality, free TCP/IP routing software package. -@comment node-name, next, previous, up System Architecture =================== @@ -86,7 +83,7 @@ The *ripd* daemon handles the RIP protocol, while *ospfd* is a daemon which supports OSPF version 2. *bgpd* supports the BGP-4 protocol. For changing the kernel routing table and for redistribution of routes between different routing -protocols, there is a kernel routing table manager *zebra* daemon. +protocols, there is a kernel routing table manager *zebra* daemon. It is easy to add a new routing protocol daemons to the entire routing system without affecting any other software. You need to run only the protocol daemon associated with routing protocols in use. Thus, user may @@ -98,7 +95,6 @@ architecture creates new possibilities for the routing system. :: - @group +----+ +----+ +-----+ +-----+ |bgpd| |ripd| |ospfd| |zebra| +----+ +----+ +-----+ +-----+ @@ -110,8 +106,7 @@ architecture creates new possibilities for the routing system. +------------------------------+ FRR System Architecture - @end group - + Multi-process architecture brings extensibility, modularity and maintainability. At the same time it also brings many configuration files @@ -125,12 +120,11 @@ UNIX domain socket and then works as a proxy for user input. FRR was planned to use multi-threaded mechanism when it runs with a kernel that supports multi-threads. But at the moment, the thread library -which comes with @sc{gnu}/Linux or FreeBSD has some problems with running -reliable services such as routing software, so we don't use threads at all. +which comes with GNU/Linux or FreeBSD has some problems with running +reliable services such as routing software, so we don't use threads at all. Instead we use the *select(2)* system call for multiplexing the events. -@comment node-name, next, previous, up Supported Platforms =================== @@ -143,7 +137,7 @@ Supported Platforms .. index:: Operating systems that support FRR -Currently FRR supports @sc{gnu}/Linux and BSD. Porting FRR +Currently FRR supports GNU/Linux and BSD. Porting FRR to other platforms is not too difficult as platform dependent code should most be limited to the *zebra* daemon. Protocol daemons are mostly platform independent. Please let us know when you find out FRR runs on a @@ -153,213 +147,154 @@ The list of officially supported platforms are listed below. Note that FRR may run correctly on other platforms, and may run with partial functionality on further platforms. -@sp 1 - -* - @sc{gnu}/Linux -* - FreeBSD -* - NetBSD -* - OpenBSD +- GNU/Linux +- FreeBSD +- NetBSD +- OpenBSD Versions of these platforms that are older than around 2 years from the point -of their original release (in case of @sc{gnu}/Linux, this is since the kernel's -release on kernel.org) may need some work. Similarly, the following platforms +of their original release (in case of GNU/Linux, this is since the kernel's +release on https://kernel.org/) may need some work. Similarly, the following platforms may work with some effort: -@sp 1 - -* - Solaris -* - Mac OSX +- Solaris +- MacOS Also note that, in particular regarding proprietary platforms, compiler and C library choice will affect FRR. Only recent versions of the following C compilers are well-tested: -@sp 1 +- GNU's GCC +- LLVM's clang +- Intel's ICC -* - @sc{gnu}'s GCC -* - LLVM's clang -* - Intel's ICC -@comment node-name, next, previous, up +.. _supported-rfcs: Supported RFCs ============== -Below is the list of currently supported RFC's. +FRR implements the following RFCs: +- :rfc:`1058` + :t:`Routing Information Protocol. C.L. Hedrick. Jun-01-1988.` +- :rfc:`2082` + :t:`RIP-2 MD5 Authentication. F. Baker, R. Atkinson. January 1997.` +- :rfc:`2453` + :t:`RIP Version 2. G. Malkin. November 1998.` +- :rfc:`2080` + :t:`RIPng for IPv6. G. Malkin, R. Minnear. January 1997.` +- :rfc:`2328` + :t:`OSPF Version 2. J. Moy. April 1998.` +- :rfc:`2370` + :t:`The OSPF Opaque LSA Option R. Coltun. July 1998.` +- :rfc:`3101` + :t:`The OSPF Not-So-Stubby Area (NSSA) Option P. Murphy. January 2003.` +- :rfc:`2740` + :t:`OSPF for IPv6. R. Coltun, D. Ferguson, J. Moy. December 1999.` +- :rfc:`1771` + :t:`A Border Gateway Protocol 4 (BGP-4). Y. Rekhter & T. Li. March 1995.` +- :rfc:`1965` + :t:`Autonomous System Confederations for BGP. P. Traina. June 1996.` +- :rfc:`1997` + :t:`BGP Communities Attribute. R. Chandra, P. Traina & T. Li. August 1996.` +- :rfc:`2545` + :t:`Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing. P. + Marques, F. Dupont. March 1999.` +- :rfc:`2796` + :t:`BGP Route Reflection An alternative to full mesh IBGP. T. Bates & R. + Chandrasekeran. June 1996.` +- :rfc:`2858` + :t:`Multiprotocol Extensions for BGP-4. T. Bates, Y. Rekhter, R. Chandra, D. + Katz. June 2000.` +- :rfc:`2842` + :t:`Capabilities Advertisement with BGP-4. R. Chandra, J. Scudder. May 2000.` +- :rfc:`3137` + :t:`OSPF Stub Router Advertisement, A. Retana, L. Nguyen, R. White, A. Zinin, + D. McPherson. June 2001` +**When SNMP support is enabled, the following RFCs are also supported:** -*@asis{RFC1058}* - @cite{Routing Information Protocol. C.L. Hedrick. Jun-01-1988.} - - -*@asis{RF2082}* - @cite{RIP-2 MD5 Authentication. F. Baker, R. Atkinson. January 1997.} - - -*@asis{RFC2453}* - @cite{RIP Version 2. G. Malkin. November 1998.} - - -*@asis{RFC2080}* - @cite{RIPng for IPv6. G. Malkin, R. Minnear. January 1997.} - - -*@asis{RFC2328}* - @cite{OSPF Version 2. J. Moy. April 1998.} - - -*@asis{RFC2370}* - @cite{The OSPF Opaque LSA Option R. Coltun. July 1998.} - - -*@asis{RFC3101}* - @cite{The OSPF Not-So-Stubby Area (NSSA) Option P. Murphy. January 2003.} - - -*@asis{RFC2740}* - @cite{OSPF for IPv6. R. Coltun, D. Ferguson, J. Moy. December 1999.} - - -*@asis{RFC1771}* - @cite{A Border Gateway Protocol 4 (BGP-4). Y. Rekhter & T. Li. March 1995.} - - -*@asis{RFC1965}* - @cite{Autonomous System Confederations for BGP. P. Traina. June 1996.} - - -*@asis{RFC1997}* - @cite{BGP Communities Attribute. R. Chandra, P. Traina & T. Li. August 1996.} - - -*@asis{RFC2545}* - @cite{Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing. P. Marques, F. Dupont. March 1999.} - - -*@asis{RFC2796}* - @cite{BGP Route Reflection An alternative to full mesh IBGP. T. Bates & R. Chandrasekeran. June 1996.} - - -*@asis{RFC2858}* - @cite{Multiprotocol Extensions for BGP-4. T. Bates, Y. Rekhter, R. Chandra, D. Katz. June 2000.} - - -*@asis{RFC2842}* - @cite{Capabilities Advertisement with BGP-4. R. Chandra, J. Scudder. May 2000.} - - -*@asis{RFC3137}* - @cite{OSPF Stub Router Advertisement, A. Retana, L. Nguyen, R. White, A. Zinin, D. McPherson. June 2001} - -When SNMP support is enabled, below RFC is also supported. - - - -*@asis{RFC1227}* - @cite{SNMP MUX protocol and MIB. M.T. Rose. May-01-1991.} - - -*@asis{RFC1657}* - @cite{Definitions of Managed Objects for the Fourth Version of the - Border Gateway Protocol (BGP-4) using SMIv2. S. Willis, J. Burruss, - J. Chu, Editor. July 1994.} - - -*@asis{RFC1724}* - @cite{RIP Version 2 MIB Extension. G. Malkin & F. Baker. November 1994.} - - -*@asis{RFC1850}* - @cite{OSPF Version 2 Management Information Base. F. Baker, R. Coltun. - November 1995.} - - -*@asis{RFC2741}* - @cite{Agent Extensibility (AgentX) Protocol. M. Daniele, B. Wijnen. January 2000.} - - -@comment node-name, next, previous, up +- :rfc:`1227` + :t:`SNMP MUX protocol and MIB. M.T. Rose. May-01-1991.` +- :rfc:`1657` + :t:`Definitions of Managed Objects for the Fourth Version of the Border + Gateway Protocol (BGP-4) using SMIv2. S. Willis, J. Burruss, J. Chu, Editor. + July 1994.` +- :rfc:`1724` + :t:`RIP Version 2 MIB Extension. G. Malkin & F. Baker. November 1994.` +- :rfc:`1850` + :t:`OSPF Version 2 Management Information Base. F. Baker, R. Coltun. + November 1995.` +- :rfc:`2741` + :t:`Agent Extensibility (AgentX) Protocol. M. Daniele, B. Wijnen. January 2000.` How to get FRR ============== -The official FRR web-site is located at: +The official FRR website is located at |PACKAGE_URL| and contains further +information, as well as links to additional resources. -`|PACKAGE_URL| <|PACKAGE_URL|>`_ +FRR is a fork of `Quagga `_. -and contains further information, as well as links to additional -resources. - -FRR is a fork of Quagga, whose website is located at: - -`http://www.quagga.net/ `_. - -@comment node-name, next, previous, up - -Mailing List -============ +Mailing Lists +============= .. index:: How to get in touch with FRR - -.. index:: Mailing FRR - .. index:: Contact information - .. index:: Mailing lists -There is a mailing list for discussions about FRR. If you have any -comments or suggestions to FRR, please subscribe to: -`https://lists.frrouting.org/listinfo/frog `_. +Italicized lists are private. -The `FRR <|PACKAGE_URL|>`_ site has further information on -the available mailing lists, see: ++--------------------------------+------------------------------+ +| Topic | List | ++================================+==============================+ +| Development | dev@lists.frrouting.org | ++--------------------------------+------------------------------+ +| Users & Operators | frog@lists.frrouting.org | ++--------------------------------+------------------------------+ +| Announcements | announce@lists.frrouting.org | ++--------------------------------+------------------------------+ +| *Security* | security@lists.frrouting.org | ++--------------------------------+------------------------------+ +| *Technical Steering Committee* | tsc@lists.frrouting.org | ++--------------------------------+------------------------------+ -`https://lists.frrouting.org/ `_ +The Development list is used to discuss and document general issues related to +project development and governance. The public `Slack instance +`_, and weekly technical meetings provide a higher +bandwidth channel for discussions. The results of such discussions are +reflected in updates, as appropriate, to code (i.e., merges), `GitHub +`_ tracked issues, and for governance +or process changes, updates to the Development list and either this file or +information posted at https://frrouting.org/. Bug Reports =========== .. index:: Bug Reports - .. index:: Bug hunting - .. index:: Found a bug? - .. index:: Reporting bugs - .. index:: Reporting software errors - .. index:: Errors in the software -If you think you have found a bug, please send a bug report to: - -`http://github.com/frrouting/frr/issues `_ +If you think you have found a bug, please file a bug report on our +`GitHub issues`_ page. When you send a bug report, please be careful about the points below. -* - Please note what kind of OS you are using. If you use the IPv6 stack +- Please note what kind of OS you are using. If you use the IPv6 stack please note that as well. -* - Please show us the results of `netstat -rn` and `ifconfig -a`. +- Please show us the results of `netstat -rn` and `ifconfig -a`. Information from zebra's VTY command `show ip route` will also be helpful. -* - Please send your configuration file with the report. If you specify +- Please send your configuration file with the report. If you specify arguments to the configure script please note that too. -Bug reports are very important for us to improve the quality of FRR. -FRR is still in the development stage, but please don't hesitate to -send a bug report to `http://github.com/frrouting/frr/issues `_. +Bug reports help us improve FRR and are very much appreciated. +.. _FRR: |PACKAGE_URL| +.. _GitHub: http://github.com/frrouting/frr/ +.. _GitHub issues: http://github.com/frrouting/frr/ From f381786082da6c1891e9bd45b92adcc201ac88fb Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 19 Jan 2018 17:09:03 -0500 Subject: [PATCH 018/148] doc: move routeserver.rst into bgp.rst This is an incomplete stub of a chapter and goes under BGP docs anyway. Also fix an include statement for RPKI. Signed-off-by: Quentin Young --- doc/user/bgp.rst | 19 ++++++++++++++++++- doc/user/index.rst | 1 - doc/user/routeserver.rst | 18 ------------------ 3 files changed, 18 insertions(+), 20 deletions(-) delete mode 100644 doc/user/routeserver.rst diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index fbc14ca140..ccc3192bab 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -2442,4 +2442,21 @@ flaws. set community additive 64512:3200 -@include rpki.texi +.. _Configuring_FRR_as_a_Route_Server: + +Configuring FRR as a Route Server +================================= + +The purpose of a Route Server is to centralize the peerings between BGP +speakers. For example if we have an exchange point scenario with four BGP +speakers, each of which maintaining a BGP peering with the other three +(:ref:`fig:full-mesh`), we can convert it into a centralized scenario where +each of the four establishes a single BGP peering against the Route Server +(:ref:`fig:route-server`). + +We will first describe briefly the Route Server model implemented by FRR. +We will explain the commands that have been added for configuring that +model. And finally we will show a full example of FRR configured as Route +Server. + +.. include:: rpki.rst diff --git a/doc/user/index.rst b/doc/user/index.rst index 57225fc250..375b1d1333 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -16,7 +16,6 @@ Welcome to FRR's documentation! nhrpd bgp babeld - routeserver vnc vtysh filter diff --git a/doc/user/routeserver.rst b/doc/user/routeserver.rst deleted file mode 100644 index 9ebbe17671..0000000000 --- a/doc/user/routeserver.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _Configuring_FRR_as_a_Route_Server: - -********************************* -Configuring FRR as a Route Server -********************************* - -The purpose of a Route Server is to centralize the peerings between BGP -speakers. For example if we have an exchange point scenario with four BGP -speakers, each of which maintaining a BGP peering with the other three -(:ref:`fig:full-mesh`), we can convert it into a centralized scenario where -each of the four establishes a single BGP peering against the Route Server -(:ref:`fig:route-server`). - -We will first describe briefly the Route Server model implemented by FRR. -We will explain the commands that have been added for configuring that -model. And finally we will show a full example of FRR configured as Route -Server. - From fd8100976ef122293af75ffdefd9d84beda48416 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 19 Jan 2018 17:24:48 -0500 Subject: [PATCH 019/148] doc: set 'release' and 'version' again accidentally removed in older commit Signed-off-by: Quentin Young --- doc/user/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/user/conf.py b/doc/user/conf.py index 23ca7d8fe7..86d8353e2a 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -97,7 +97,11 @@ with open('../../config.status', 'r') as cfgstatus: replace_vars[m.group(1)] = m.group(2) # manually fill out some of these we can't get from config.status -replace_vars['COPYRIGHT_STR'] = "Copyright (c) {} {}".format(replace_vars['COPYRIGHT_YEAR'], replace_vars['AUTHORS']) +replace_vars['COPYRIGHT_STR'] = "Copyright (c)" +replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['COPYRIGHT_YEAR']) +replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['AUTHORS']) +release = replace_vars['PACKAGE_VERSION'] +version = release.split('-')[0] # add substitutions to prolog for key, value in replace_vars.items(): From c2caa2970b19ee07ac3e7a8f3718c57f458fd063 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 12:35:52 -0500 Subject: [PATCH 020/148] doc: rename main.rst -> zebra.rst This name hasn't made sense for a long time. Signed-off-by: Quentin Young --- doc/user/index.rst | 2 +- doc/user/{main.rst => zebra.rst} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename doc/user/{main.rst => zebra.rst} (100%) diff --git a/doc/user/index.rst b/doc/user/index.rst index 375b1d1333..0d705d10ad 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -7,7 +7,7 @@ Welcome to FRR's documentation! overview installation basic - main + zebra ripd ripngd ospfd diff --git a/doc/user/main.rst b/doc/user/zebra.rst similarity index 100% rename from doc/user/main.rst rename to doc/user/zebra.rst From fce2ac600e8397474f7a5f5e0ed91c8a26a295f7 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 12:38:08 -0500 Subject: [PATCH 021/148] doc: remove @group / @end group Don't need these in RST Signed-off-by: Quentin Young --- doc/user/appendix.rst | 1 - doc/user/eigrpd.rst | 6 ------ doc/user/isisd.rst | 6 ------ doc/user/nhrpd.rst | 10 ---------- doc/user/ospf6d.rst | 2 -- doc/user/ospf_fundamentals.rst | 6 ------ doc/user/ospfd.rst | 20 -------------------- doc/user/ripd.rst | 8 -------- doc/user/routemap.rst | 2 -- doc/user/zebra.rst | 4 ---- 10 files changed, 65 deletions(-) diff --git a/doc/user/appendix.rst b/doc/user/appendix.rst index 334d162c91..e2948312a3 100644 --- a/doc/user/appendix.rst +++ b/doc/user/appendix.rst @@ -210,7 +210,6 @@ The file specified in "File Name" contains all routing entries, which are in the format of ``subtype == BGP4MP_ENTRY``. @example -@group Constants::: /* type value */ diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index 7686ef099d..d4f7e301b3 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -31,10 +31,8 @@ EIGRP is like below: :: - @group # zebra -d # eigrpd -d - @end group Please note that *zebra* must be invoked before *eigrpd*. @@ -99,12 +97,10 @@ Command {no router eigrp (1-65535)} {} :: - @group ! router eigrp 1 network 10.0.0.0/8 ! - @end group Passive interface @@ -214,7 +210,6 @@ Command {show ip eigrp topology} {} :: - @group eigrpd> **show ip eigrp topology** # show ip eigrp topo @@ -225,7 +220,6 @@ Command {show ip eigrp topology} {} P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 via Connected, enp0s3 - @end group EIGRP Debug Commands diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 667af96057..d1c1336b4e 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -553,7 +553,6 @@ A simple example, with MD5 authentication enabled: :: - @group ! interface eth0 ip router isis FOO @@ -564,7 +563,6 @@ A simple example, with MD5 authentication enabled: net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 metric-style wide is-type level-2-only - @end group A Traffic Engineering configuration, with Inter-ASv2 support. @@ -573,7 +571,6 @@ A Traffic Engineering configuration, with Inter-ASv2 support. :: - @group hostname HOSTNAME password PASSWORD log file /var/log/zebra.log @@ -610,14 +607,12 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te link unrsv-bw 7 1.25e+06 mpls-te link rsc-clsclr 0xab mpls-te neighbor 10.1.1.2 as 65000 - @end group - Then the 'isisd.conf' itself: :: - @group hostname HOSTNAME password PASSWORD log file /var/log/isisd.log @@ -636,6 +631,5 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te router-address 10.1.1.1 ! line vty - @end group diff --git a/doc/user/nhrpd.rst b/doc/user/nhrpd.rst index a16730a3cc..ae8a986192 100644 --- a/doc/user/nhrpd.rst +++ b/doc/user/nhrpd.rst @@ -35,11 +35,9 @@ To create NBMA GRE tunnel you might use the following (linux terminal commands): :: - @group ip tunnel add gre1 mode gre key 42 ttl 64 ip addr add 10.255.255.2/32 dev gre1 ip link set gre1 up - @end group Note that the IP-address is assigned as host prefix to gre1. nhrpd will @@ -59,13 +57,11 @@ This can be achieved in hubs with the following bgp configuration (network command defines the GRE subnet): :: - @group router bgp 65555 address-family ipv4 unicast network 172.16.0.0/16 redistribute nhrp exit-address-family - @end group .. _Configuring_NHRP: @@ -91,12 +87,10 @@ This can be achieved with the following iptables rule. :: - @group iptables -A FORWARD -i gre1 -o gre1 \\ -m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \\ --hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \\ --hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128 - @end group You can fine tune the src/dstmask according to the prefix lengths you @@ -107,19 +101,15 @@ This kernel NFLOG target's nflog-group is configured in global nhrp config with: :: - @group nhrp nflog-group 1 - @end group To start sending these traffic notices out from hubs, use the nhrp per-interface directive: :: - @group interface gre1 ip nhrp redirect - @end group .. _Integration_with_IKE: diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index 3644631c59..4fbf5c0dd1 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -54,10 +54,8 @@ OSPF6 router :: - @group router ospf6 timers throttle spf 200 400 10000 - @end group In this example, the `delay` is set to 200ms, the @var{initial diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index c11c212da8..dc3321ff5e 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -439,7 +439,6 @@ From just the above two @acronym{LSA}s, one can already see the following partial topology: :: - @group --------------------- Network: ...... | Designated Router IP: 192.168.1.3 @@ -461,7 +460,6 @@ following partial topology: | Router ID: 192.168.0.53 | Router ID: 192.168.0.52 - @end group Note the Router IDs, though they look like IP addresses and often are @@ -534,7 +532,6 @@ selected. :: - @group # show ip ospf database external 192.168.165.0 LS age: 995 Options: 0x2 : *|-|-|-|-|-|E|* @@ -551,14 +548,12 @@ selected. Metric: 20 Forward Address: 0.0.0.0 External Route Tag: 0 - @end group We can add this to our partial topology from above, which now looks like: :: - @group --------------------- Network: ...... | Designated Router IP: 192.168.1.3 | @@ -579,7 +574,6 @@ like: | Router ID: 192.168.0.53 | Router ID: 192.168.0.52 - @end group Summary LSAs diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 65a5959447..23aae50ecc 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -172,10 +172,8 @@ Command {no router ospf} {} :: - @group router ospf timers throttle spf 200 400 10000 - @end group In this example, the `delay` is set to 200ms, the @var{initial @@ -266,10 +264,8 @@ Command {no router ospf} {} :: - @group router ospf network 192.168.1.0/24 area 0.0.0.0 - @end group Prefix length in interface must be equal or bigger (ie. smaller network) than @@ -313,12 +309,10 @@ OSPF area :: - @group router ospf network 192.168.1.0/24 area 0.0.0.0 network 10.0.0.0/8 area 0.0.0.10 area 0.0.0.10 range 10.0.0.0/8 - @end group With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is @@ -345,12 +339,10 @@ OSPF area :: - @group router ospf network 192.168.1.0/24 area 0.0.0.0 network 10.0.0.0/8 area 0.0.0.10 area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 - @end group One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if @@ -446,7 +438,6 @@ OSPF area :: - @group router ospf network 192.168.1.0/24 area 0.0.0.0 network 10.0.0.0/8 area 0.0.0.10 @@ -454,7 +445,6 @@ OSPF area ! access-list foo permit 10.10.0.0/16 access-list foo deny any - @end group With example above any intra-area paths from area 0.0.0.10 and from range @@ -1129,7 +1119,6 @@ A simple example, with MD5 authentication enabled: :: - @group ! interface bge0 ip ospf authentication message-digest @@ -1138,7 +1127,6 @@ A simple example, with MD5 authentication enabled: router ospf network 192.168.0.0/16 area 0.0.0.1 area 0.0.0.1 authentication message-digest - @end group An @acronym{ABR} router, with MD5 authentication and performing summarisation @@ -1146,7 +1134,6 @@ of networks between the areas: :: - @group ! password ABCDEF log file /var/log/frr/ospfd.log @@ -1175,7 +1162,6 @@ of networks between the areas: area 0.0.0.1 authentication message-digest area 0.0.0.1 range 10.2.0.0/16 ! - @end group A Traffic Engineering configuration, with Inter-ASv2 support. @@ -1184,7 +1170,6 @@ A Traffic Engineering configuration, with Inter-ASv2 support. :: - @group hostname HOSTNAME password PASSWORD log file /var/log/zebra.log @@ -1221,14 +1206,12 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te link unrsv-bw 7 1.25e+06 mpls-te link rsc-clsclr 0xab mpls-te neighbor 192.168.2.2 as 65000 - @end group - Then the 'ospfd.conf' itself: :: - @group hostname HOSTNAME password PASSWORD log file /var/log/ospfd.log @@ -1252,14 +1235,12 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te inter-as area 1 ! line vty - @end group A router information example with PCE advsertisement: :: - @group ! router ospf ospf router-id 192.168.1.1 @@ -1275,6 +1256,5 @@ A router information example with PCE advsertisement: pce neighbor as 65200 pce scope 0x80 ! - @end group diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 53fca7c57f..201ea7ce19 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -35,10 +35,8 @@ RIP is like below: :: - @group # zebra -d # ripd -d - @end group Please note that *zebra* must be invoked before *ripd*. @@ -154,13 +152,11 @@ Command {no router rip} {} :: - @group ! router rip network 10.0.0.0/8 network eth0 ! - @end group Passive interface @@ -375,7 +371,6 @@ Command {distribute-list `access_list` `direct` `ifname`} {} :: - @group ! router rip distribute-list private in eth0 @@ -383,7 +378,6 @@ Command {distribute-list `access_list` `direct` `ifname`} {} access-list private permit 10 10.0.0.0/8 access-list private deny any ! - @end group `distribute-list` can be applied to both incoming and outgoing data. @@ -676,7 +670,6 @@ Command {show ip rip status} {} :: - @group ripd> **show ip rip status** Routing Protocol is "rip" Sending updates every 30 seconds with +/-50%, next due in 35 seconds @@ -694,7 +687,6 @@ Command {show ip rip status} {} 203.181.89.241 Routing Information Sources: Gateway BadPackets BadRoutes Distance Last Update - @end group RIP Debug Commands diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 0be62d4100..7ec3fcaf4f 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -295,11 +295,9 @@ A simple example of a route-map: :: - @group route-map test permit 10 match ip address 10 set local-preference 200 - @end group This means that if a route matches ip access-list number 10 it's diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index d42da83a46..922b1691d3 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -467,14 +467,12 @@ Command {ip protocol `protocol` route-map `routemap`} {} that sets the preferred source address, and applies the route-map to all *rip* routes. - @group ip prefix-list ANY permit 0.0.0.0/0 le 32 route-map RM1 permit 10 match ip address prefix-list ANY set src 10.0.0.1 ip protocol rip route-map RM1 - @end group .. _zebra_FIB_push_interface: @@ -560,7 +558,6 @@ Command {show ip route} {} :: - @group Router# show ip route Codes: K - kernel route, C - connected, S - static, R - RIP, B - BGP * - FIB route. @@ -569,7 +566,6 @@ Command {show ip route} {} S 0.0.0.0/0 203.181.89.1 C* 127.0.0.0/8 lo C* 203.181.89.240/28 eth0 - @end group .. index:: Command {show ipv6 route} {} From a90cfb7f71afacb7de20d08143441d29b0b0bc62 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 12:57:34 -0500 Subject: [PATCH 022/148] doc: fixup eigrpd.rst Signed-off-by: Quentin Young --- doc/user/eigrpd.rst | 216 ++++++++++++++++++++++---------------------- 1 file changed, 108 insertions(+), 108 deletions(-) diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index d4f7e301b3..44af4a263d 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -5,7 +5,7 @@ EIGRP ***** EIGRP -- Routing Information Protocol is widely deployed interior gateway -routing protocol. EIGRP was developed in the 1990's. EIGRP is a +routing protocol. EIGRP was developed in the 1990's. EIGRP is a @dfn{distance-vector} protocol and is based on the @dfn{dual} algorithms. As a distance-vector protocol, the EIGRP router send updates to its neighbors as networks change, thus allowing the convergence to a @@ -19,14 +19,14 @@ Starting and Stopping eigrpd ============================ The default configuration file name of *eigrpd*'s is -:file:`eigrpd.conf`. When invocation *eigrpd* searches directory -|INSTALL_PREFIX_ETC|. If :file:`eigrpd.conf` is not there next -search current directory. If an integrated config is specified +:file:`eigrpd.conf`. When invocation *eigrpd* searches directory +|INSTALL_PREFIX_ETC|. If :file:`eigrpd.conf` is not there next +search current directory. If an integrated config is specified configuration is written into frr.conf The EIGRP protocol requires interface information -maintained by *zebra* daemon. So running *zebra* -is mandatory to run *eigrpd*. Thus minimum sequence for running +maintained by *zebra* daemon. So running *zebra* +is mandatory to run *eigrpd*. Thus minimum sequence for running EIGRP is like below: :: @@ -37,63 +37,62 @@ EIGRP is like below: Please note that *zebra* must be invoked before *eigrpd*. -To stop *eigrpd*. Please use @command{kill `cat -/var/run/eigrpd.pid`}. Certain signals have special meanings to *eigrpd*. +To stop *eigrpd*. Please use @command{kill `cat +/var/run/eigrpd.pid`}. Certain signals have special meanings to *eigrpd*. + ++------------------+-----------------------------------------------------------+ +| Signal | Meaning | ++==================+===========================================================+ +| SIGHUP & SIGUSR1 | Rotate the log file | ++------------------+-----------------------------------------------------------+ +| SIGINT & SIGTERM | Sweep all installed EIGRP routes and gracefully terminate | ++------------------+-----------------------------------------------------------+ - -*SIGHUP* - -*SIGUSR1* - Rotate *eigrpd* Rotate the logfile. - -*SIGINT* - -*SIGTERM* - *eigrpd* sweeps all installed EIGRP routes then terminates properly. - -*eigrpd* invocation options. Common options that can be specified +*eigrpd* invocation options. Common options that can be specified (:ref:`Common_Invocation_Options`). +.. program:: eigrpd +.. option:: -r +.. option:: --retain -*-r* - -*--retain* - When the program terminates, retain routes added by *eigrpd*. + When the program terminates, retain routes added by *eigrpd*. .. _EIGRP_Configuration: EIGRP Configuration =================== -.. index:: Command {router eigrp (1-65535)} {} +.. index:: router eigrp (1-65535) -Command {router eigrp (1-65535)} {} - The `router eigrp` command is necessary to enable EIGRP. To disable - EIGRP, use the `no router eigrp (1-65535)` command. EIGRP must be enabled before carrying out any of the EIGRP commands. +``router eigrp (1-65535)`` + The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP, + use the `no router eigrp (1-65535)` command. EIGRP must be enabled before + carrying out any of the EIGRP commands. -.. index:: Command {no router eigrp (1-65535)} {} +.. index:: no router eigrp (1-65535) -Command {no router eigrp (1-65535)} {} - Disable EIGRP. +``no router eigrp (1-65535)`` + Disable EIGRP. -.. index:: {EIGRP Command} {network `network`} {} +.. index:: network NETWORK -{EIGRP Command} {network `network`} {} -.. index:: {EIGRP Command} {no network `network`} {} +``network NETWORK`` +.. index:: no network NETWORK -{EIGRP Command} {no network `network`} {} - Set the EIGRP enable interface by `network`. The interfaces which - have addresses matching with `network` are enabled. +``no network NETWORK`` + Set the EIGRP enable interface by `network`. The interfaces which + have addresses matching with `network` are enabled. - This group of commands either enables or disables EIGRP interfaces between - certain numbers of a specified network address. For example, if the - network for 10.0.0.0/24 is EIGRP enabled, this would result in all the - addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The `no network` command will disable EIGRP for the specified network. + This group of commands either enables or disables EIGRP interfaces between + certain numbers of a specified network address. For example, if the + network for 10.0.0.0/24 is EIGRP enabled, this would result in all the + addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The `no + network` command will disable EIGRP for the specified network. - Below is very simple EIGRP configuration. Interface `eth0` and - interface which address match to `10.0.0.0/8` are EIGRP enabled. + Below is very simple EIGRP configuration. Interface `eth0` and + interface which address match to `10.0.0.0/8` are EIGRP enabled. :: @@ -105,89 +104,90 @@ Command {no router eigrp (1-65535)} {} Passive interface -.. index:: {EIGRP command} {passive-interface (`IFNAME`|default)} {} +.. index:: passive-interface (IFNAME|default) -{EIGRP command} {passive-interface (`IFNAME`|default)} {} -.. index:: {EIGRP command} {no passive-interface `IFNAME`} {} +``passive-interface (IFNAME|default)`` +.. index:: no passive-interface IFNAME -{EIGRP command} {no passive-interface `IFNAME`} {} - This command sets the specified interface to passive mode. On passive mode - interface, all receiving packets are ignored and eigrpd does - not send either multicast or unicast EIGRP packets except to EIGRP neighbors - specified with `neighbor` command. The interface may be specified - as `default` to make eigrpd default to passive on all interfaces. +``no passive-interface IFNAME`` + This command sets the specified interface to passive mode. On passive mode + interface, all receiving packets are ignored and eigrpd does + not send either multicast or unicast EIGRP packets except to EIGRP neighbors + specified with `neighbor` command. The interface may be specified + as `default` to make eigrpd default to passive on all interfaces. - The default is to be passive on all interfaces. + The default is to be passive on all interfaces. .. _How_to_Announce_EIGRP_route: How to Announce EIGRP route =========================== -.. index:: {EIGRP command} {redistribute kernel} {} +.. index:: redistribute kernel -{EIGRP command} {redistribute kernel} {} -.. index:: {EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +``redistribute kernel`` +.. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -{EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -.. index:: {EIGRP command} {no redistribute kernel} {} +``redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. index:: no redistribute kernel -{EIGRP command} {no redistribute kernel} {} - `redistribute kernel` redistributes routing information from - kernel route entries into the EIGRP tables. `no redistribute kernel` - disables the routes. +``no redistribute kernel`` + `redistribute kernel` redistributes routing information from + kernel route entries into the EIGRP tables. `no redistribute kernel` + disables the routes. -.. index:: {EIGRP command} {redistribute static} {} +.. index:: redistribute static -{EIGRP command} {redistribute static} {} -.. index:: {EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +``redistribute static`` +.. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -{EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -.. index:: {EIGRP command} {no redistribute static} {} +``redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. index:: no redistribute static -{EIGRP command} {no redistribute static} {} - `redistribute static` redistributes routing information from - static route entries into the EIGRP tables. `no redistribute static` - disables the routes. +``no redistribute static`` + `redistribute static` redistributes routing information from + static route entries into the EIGRP tables. `no redistribute static` + disables the routes. -.. index:: {EIGRP command} {redistribute connected} {} +.. index:: redistribute connected -{EIGRP command} {redistribute connected} {} -.. index:: {EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +``redistribute connected`` +.. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -{EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -.. index:: {EIGRP command} {no redistribute connected} {} +``redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. index:: no redistribute connected -{EIGRP command} {no redistribute connected} {} - Redistribute connected routes into the EIGRP tables. `no redistribute connected` disables the connected routes in the EIGRP tables. - This command redistribute connected of the interface which EIGRP disabled. - The connected route on EIGRP enabled interface is announced by default. +``no redistribute connected`` + Redistribute connected routes into the EIGRP tables. `no redistribute + connected` disables the connected routes in the EIGRP tables. This command + redistribute connected of the interface which EIGRP disabled. The connected + route on EIGRP enabled interface is announced by default. -.. index:: {EIGRP command} {redistribute ospf} {} +.. index:: redistribute ospf -{EIGRP command} {redistribute ospf} {} -.. index:: {EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +``redistribute ospf`` +.. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -{EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -.. index:: {EIGRP command} {no redistribute ospf} {} +``redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. index:: no redistribute ospf -{EIGRP command} {no redistribute ospf} {} - `redistribute ospf` redistributes routing information from - ospf route entries into the EIGRP tables. `no redistribute ospf` - disables the routes. +``no redistribute ospf`` + `redistribute ospf` redistributes routing information from ospf route + entries into the EIGRP tables. `no redistribute ospf` disables the + routes. -.. index:: {EIGRP command} {redistribute bgp} {} +.. index:: redistribute bgp -{EIGRP command} {redistribute bgp} {} -.. index:: {EIGRP command} {redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} +``redistribute bgp`` +.. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -{EIGRP command} {redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {} -.. index:: {EIGRP command} {no redistribute bgp} {} +``redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. index:: no redistribute bgp -{EIGRP command} {no redistribute bgp} {} - `redistribute bgp` redistributes routing information from - bgp route entries into the EIGRP tables. `no redistribute bgp` - disables the routes. +``no redistribute bgp`` + `redistribute bgp` redistributes routing information from + bgp route entries into the EIGRP tables. `no redistribute bgp` + disables the routes. .. _Show_EIGRP_Information: @@ -196,16 +196,16 @@ Show EIGRP Information To display EIGRP routes. -.. index:: Command {show ip eigrp topology} {} +.. index:: show ip eigrp topology -Command {show ip eigrp topology} {} +``show ip eigrp topology`` Show EIGRP routes. The command displays all EIGRP routes. -.. index:: Command {show ip eigrp topology} {} +.. index:: show ip eigrp topology -Command {show ip eigrp topology} {} +``show ip eigrp topology`` The command displays current EIGRP status :: @@ -227,23 +227,23 @@ EIGRP Debug Commands Debug for EIGRP protocol. -.. index:: Command {debug eigrp packets} {} +.. index:: debug eigrp packets -Command {debug eigrp packets} {} +``debug eigrp packets`` Debug eigrp packets `debug eigrp` will show EIGRP packets that are sent and recevied. -.. index:: Command {debug eigrp transmit} {} +.. index:: debug eigrp transmit -Command {debug eigrp transmit} {} +``debug eigrp transmit`` Debug eigrp transmit events `debug eigrp transmit` will display detailed information about the EIGRP transmit events. -.. index:: Command {show debugging eigrp} {} +.. index:: show debugging eigrp -Command {show debugging eigrp} {} +``show debugging eigrp`` Display *eigrpd*'s debugging option. `show debugging eigrp` will show all information currently set for eigrpd From dc5564c76fc486c6cd7d234dae7f4082e5b73156 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 13:29:16 -0500 Subject: [PATCH 023/148] doc: cleanup installation instructions Use program and option directives for CLI options Signed-off-by: Quentin Young --- doc/user/basic.rst | 10 +- doc/user/installation.rst | 255 +++++++++++++++++++------------------- 2 files changed, 133 insertions(+), 132 deletions(-) diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 933d49b01a..58c8caa4e3 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -37,16 +37,12 @@ routing daemon configurations, a log file name, and so forth. This information forms the initial command set for a routing beast as it is starting. -Config files are generally found in: - -* :file:`|INSTALL_PREFIX_ETC|`/\*.conf +Config files are generally found in |INSTALL_PREFIX_ETC|. Each of the daemons has its own -config file. For example, zebra's default config file name is: +config file. For example, zebra's default config file name is *zebra.conf*. -* :file:`INSTALL_PREFIX_ETC`/zebra.conf - -The daemon name plus :file:`.conf` is the default config file name. You +The daemon name plus `.conf` is the default config file name. You can specify a config file using the :kbd:`-f` or :kbd:`--config-file` options when starting the daemon. diff --git a/doc/user/installation.rst b/doc/user/installation.rst index a60d09dd43..70d1a7c5b1 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -33,10 +33,10 @@ Configure the Software ====================== -.. _The_Configure_script_and_its_options: +.. _The_Configure_Script: -The Configure script and its options ------------------------------------- +The Configure Script +-------------------- .. index:: Configuration options @@ -52,111 +52,132 @@ FRR has an excellent configure script which automatically detects most host configurations. There are several additional configure options to customize the build to include or exclude specific features and dependencies. +.. program:: configure + +.. option:: --disable-zebra -*--disable-zebra* - Do not build zebra daemon. + Do not build zebra daemon. -*--disable-ripd* - Do not build ripd. +.. option:: --disable-ripd -*--disable-ripngd* - Do not build ripngd. + Do not build ripd. -*--disable-ospfd* - Do not build ospfd. +.. option:: --disable-ripngd -*--disable-ospf6d* - Do not build ospf6d. + Do not build ripngd. -*--disable-bgpd* - Do not build bgpd. +.. option:: --disable-ospfd -*--disable-bgp-announce* - Make *bgpd* which does not make bgp announcements at all. This - feature is good for using *bgpd* as a BGP announcement listener. + Do not build ospfd. -*--enable-datacenter* - Enable system defaults to work as if in a Data Center. See defaults.h - for what is changed by this configure option. +.. option:: --disable-ospf6d -*--enable-snmp* - Enable SNMP support. By default, SNMP support is disabled. + Do not build ospf6d. -*--disable-ospfapi* - Disable support for OSPF-API, an API to interface directly with ospfd. - OSPF-API is enabled if --enable-opaque-lsa is set. +.. option:: --disable-bgpd -*--disable-ospfclient* - Disable building of the example OSPF-API client. + Do not build bgpd. -*--disable-ospf-ri* - Disable support for OSPF Router Information (RFC4970 & RFC5088) this - requires support for Opaque LSAs and Traffic Engineering. +.. option:: --disable-bgp-announce -*--disable-isisd* - Do not build isisd. + Make *bgpd* which does not make bgp announcements at all. This + feature is good for using *bgpd* as a BGP announcement listener. -*--enable-isis-topology* - Enable IS-IS topology generator. +.. option:: --enable-datacenter -*--enable-isis-te* - Enable Traffic Engineering Extension for ISIS (RFC5305) + Enable system defaults to work as if in a Data Center. See defaults.h + for what is changed by this configure option. -*--enable-multipath=`ARG`* - Enable support for Equal Cost Multipath. `ARG` is the maximum number - of ECMP paths to allow, set to 0 to allow unlimited number of paths. +.. option:: --enable-snmp -*--disable-rtadv* - Disable support IPV6 router advertisement in zebra. + Enable SNMP support. By default, SNMP support is disabled. -*--enable-gcc-rdynamic* - Pass the *-rdynamic* option to the linker driver. This is in most - cases neccessary for getting usable backtraces. This option defaults to on - if the compiler is detected as gcc, but giving an explicit enable/disable is - suggested. +.. option:: --disable-ospfapi -*--disable-backtrace* - Controls backtrace support for the crash handlers. This is autodetected by - default. Using the switch will enforce the requested behaviour, failing with - an error if support is requested but not available. On BSD systems, this - needs libexecinfo, while on glibc support for this is part of libc itself. + Disable support for OSPF-API, an API to interface directly with ospfd. + OSPF-API is enabled if --enable-opaque-lsa is set. -*--enable-dev-build* - Turn on some options for compiling FRR within a development environment in - mind. Specifically turn on -g3 -O0 for compiling options and add inclusion - of grammar sandbox. +.. option:: --disable-ospfclient + + Disable building of the example OSPF-API client. + +.. option:: --disable-ospf-ri + + Disable support for OSPF Router Information (RFC4970 & RFC5088) this + requires support for Opaque LSAs and Traffic Engineering. + +.. option:: --disable-isisd + + Do not build isisd. + +.. option:: --enable-isis-topology + + Enable IS-IS topology generator. + +.. option:: --enable-isis-te + + Enable Traffic Engineering Extension for ISIS (RFC5305) + +.. option:: --enable-multipath=`ARG` + + Enable support for Equal Cost Multipath. `ARG` is the maximum number + of ECMP paths to allow, set to 0 to allow unlimited number of paths. + +.. option:: --disable-rtadv + + Disable support IPV6 router advertisement in zebra. + +.. option:: --enable-gcc-rdynamic + + Pass the *-rdynamic* option to the linker driver. This is in most + cases neccessary for getting usable backtraces. This option defaults to on + if the compiler is detected as gcc, but giving an explicit enable/disable is + suggested. + +.. option:: --disable-backtrace + + Controls backtrace support for the crash handlers. This is autodetected by + default. Using the switch will enforce the requested behaviour, failing with + an error if support is requested but not available. On BSD systems, this + needs libexecinfo, while on glibc support for this is part of libc itself. + +.. option:: --enable-dev-build + + Turn on some options for compiling FRR within a development environment in + mind. Specifically turn on -g3 -O0 for compiling options and add inclusion + of grammar sandbox. + +.. option:: --enable-fuzzing + + Turn on some compile options to allow you to run fuzzing tools against the + system. This flag is intended as a developer only tool and should not be + used for normal operations. + +.. option:: --disable-snmp + + Build without SNMP support. -*--enable-fuzzing* - Turn on some compile options to allow you to run fuzzing tools - against the system. This tools is intended as a developer - only tool and should not be used for normal operations You may specify any combination of the above options to the configure -script. By default, the executables are placed in :file:`/usr/local/sbin` +script. By default, the executables are placed in :file:`/usr/local/sbin` and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/` installation prefix and other directories may be changed using the following options to the configuration script. +.. option:: --prefix=`prefix` + Install architecture-independent files in `prefix` [/usr/local]. -*--prefix=`prefix`* - Install architecture-independent files in `prefix` [/usr/local]. +.. option:: --sysconfdir=`dir` -*--sysconfdir=`dir`* - Look for configuration files in `dir` [`prefix`/etc]. Note - that sample configuration files will be installed here. + Look for configuration files in `dir` [`prefix`/etc]. Note that sample + configuration files will be installed here. -*--localstatedir=`dir`* - Configure zebra to use `dir` for local state files, such - as pid files and unix sockets. +.. option:: --localstatedir=`dir` -:: - - % ./configure --disable-snmp - - -This command will configure zebra and the routing daemons. + Configure zebra to use `dir` for local state files, such + as pid files and unix sockets. .. _Least-Privilege_support: @@ -172,34 +193,34 @@ shortly after startup and switch to another user. The configure script will automatically try to configure this support. There are three configure options to control the behaviour of FRR daemons. +.. option:: --enable-user=`user` + Switch to user `ARG` shortly after startup, and run as user `ARG` + in normal operation. -*--enable-user=`user`* - Switch to user `ARG` shortly after startup, and run as user `ARG` - in normal operation. +.. option:: --enable-group=`group` -*--enable-group=`group`* - Switch real and effective group to `group` shortly after - startup. + Switch real and effective group to `group` shortly after + startup. -*--enable-vty-group=`group`* - Create Unix Vty sockets (for use with vtysh) with group owndership set to - `group`. This allows one to create a seperate group which is - restricted to accessing only the Vty sockets, hence allowing one to - delegate this group to individual users, or to run vtysh setgid to - this group. +.. option:: --enable-vty-group=`group` + + Create Unix Vty sockets (for use with vtysh) with group owndership set to + `group`. This allows one to create a seperate group which is + restricted to accessing only the Vty sockets, hence allowing one to + delegate this group to individual users, or to run vtysh setgid to + this group. The default user and group which will be configured is 'frr' if no user or group is specified. Note that this user or group requires write access to -the local state directory (see --localstatedir) and requires at least read +the local state directory (see `--localstatedir`) and requires at least read access, and write access if you wish to allow daemons to write out their -configuration, to the configuration directory (see --sysconfdir). +configuration, to the configuration directory (see `--sysconfdir`). -On systems which have the 'libcap' capabilities manipulation library -(currently only linux), the frr system will retain only minimal -capabilities required, further it will only raise these capabilities for -brief periods. On systems without libcap, frr will run as the user -specified and only raise its uid back to uid 0 for brief periods. +On systems which have the 'libcap' capabilities manipulation library (currently +only Linux), FRR will retain only minimal capabilities required and will only +raise these capabilities for brief periods. On systems without libcap, FRR will +run as the user specified and only raise its UID to 0 for brief periods. .. _Linux_Notes: @@ -219,33 +240,25 @@ what you want. FRR will run with any kernel configuration but some recommendations do exist. - -*CONFIG_NETLINK* +- CONFIG_NETLINK Kernel/User netlink socket. This is a brand new feature which enables an advanced interface between the Linux kernel and zebra (:ref:`Kernel_Interface`). - - -*CONFIG_RTNETLINK* +- CONFIG_RTNETLINK Routing messages. This makes it possible to receive netlink routing messages. If you specify this option, *zebra* can detect routing information updates directly from the kernel (:ref:`Kernel_Interface`). - - -*CONFIG_IP_MULTICAST* +- CONFIG_IP_MULTICAST IP: multicasting. This option should be specified when you use *ripd* (:ref:`RIP`) or *ospfd* (:ref:`OSPFv2`) because these protocols use multicast. - IPv6 support has been added in GNU/Linux kernel version 2.2. If you try to use the FRR IPv6 feature on a GNU/Linux kernel, please make sure the following libraries have been installed. Please note that these libraries will not be needed when you uses GNU C library 2.1 or upper. - - *inet6-apps* The `inet6-apps` package includes basic IPv6 related libraries such as `inet_ntop` and `inet_pton`. Some basic IPv6 programs such @@ -266,22 +279,19 @@ or upper. Build the Software ================== -After configuring the software, you will need to compile it for your -system. Simply issue the command *make* in the root of the source -directory and the software will be compiled. Cliff Note versions of -different compilation examples can be found in the doc/Building_FRR_on_XXX.md -files. If you have *any* problems at this stage, be certain to send a -bug report :ref:`Bug_Reports`. +After configuring the software, you will need to compile it for your system. +Simply issue the command *make* in the root of the source directory and the +software will be compiled. Cliff Notes versions of different compilation +examples can be found in the Developer's Manual Appendix. If you have *any* +problems at this stage, please send a bug report :ref:`Bug_Reports`. :: - % ./bootstrap.sh - % ./configure - % make + $ ./bootstrap.sh + $ ./configure + $ make -@comment node-name, next, previous, up - Install the Software ==================== @@ -291,18 +301,13 @@ installation process has completed, these files have been copied from your work directory to :file:`/usr/local/bin`, and :file:`/usr/local/etc`. To install the FRR suite, issue the following command at your shell -prompt: *make install*. - -:: - - % - % make install - % +prompt::: + $ make install FRR daemons have their own terminal interface or VTY. After installation, you have to setup each beast's port number to connect to -them. Please add the following entries to :file:`/etc/services`. +them. Please add the following entries to :file:`/etc/services`. :: @@ -325,5 +330,5 @@ specify a port number when starting the daemon, these entries may not be needed. You may need to make changes to the config files in -:file:`|INSTALL_PREFIX_ETC`/\*.conf|. :ref:`Config_Commands`. +|INSTALL_PREFIX_ETC|. :ref:`Config_Commands`. From 8fa64b2a3fa554e261ad49892515410a14c3baf0 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 13:50:36 -0500 Subject: [PATCH 024/148] doc: @smp{foo} -> ``foo`` Signed-off-by: Quentin Young --- doc/user/babeld.rst | 4 ++-- doc/user/bgp.rst | 4 ++-- doc/user/installation.rst | 10 ++++----- doc/user/kernel.rst | 14 +++++++----- doc/user/ripd.rst | 8 +++---- doc/user/ripngd.rst | 4 ++-- doc/user/routemap.rst | 46 +++++++++++++++++++-------------------- doc/user/snmptrap.rst | 2 +- 8 files changed, 47 insertions(+), 45 deletions(-) diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst index 72d8531e31..fd96fea40a 100644 --- a/doc/user/babeld.rst +++ b/doc/user/babeld.rst @@ -131,8 +131,8 @@ Babel configuration assumed to interfere with all other channels except noninterfering channels, and interfaces with a channel number interfere with interfering interfaces and interfaces with the same channel number. - The default is @samp{babel channel interfering} for wireless - interfaces, and @samp{babel channel noninterfering} for wired + The default is ``babel channel interfering`` for wireless + interfaces, and ``babel channel noninterfering`` for wired interfaces. This is reset when the wired/wireless status of an interface is changed. diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index ccc3192bab..485f60e759 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -891,7 +891,7 @@ Peer filtering ``neighbor `peer` distribute-list `name` [in|out]`` This command specifies a distribute-list for the peer. `direct` is - @samp{in} or @samp{out}. + ``in`` or ``out``. .. index:: neighbor PEER prefix-list NAME [in|out] @@ -1889,7 +1889,7 @@ Route Server At an Internet Exchange point, many ISPs are connected to each other by external BGP peering. Normally these external BGP connection are done by -@samp{full mesh} method. As with internal BGP full mesh formation, +``full mesh`` method. As with internal BGP full mesh formation, this method has a scaling problem. This scaling problem is well known. Route Server is a method to resolve diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 70d1a7c5b1..4fd916c475 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -233,11 +233,10 @@ Linux Notes .. index:: Linux configurations -There are several options available only to GNU/Linux systems: -@footnote{GNU/Linux has very flexible kernel configuration features}. If -you use GNU/Linux, make sure that the current kernel configuration is -what you want. FRR will run with any kernel configuration but some -recommendations do exist. +There are several options available only to GNU/Linux systems [#]_. +If you use GNU/Linux, make sure that the current kernel configuration is what +you want. FRR will run with any kernel configuration but some recommendations +do exist. - CONFIG_NETLINK @@ -332,3 +331,4 @@ needed. You may need to make changes to the config files in |INSTALL_PREFIX_ETC|. :ref:`Config_Commands`. +.. [#] GNU/Linux has very flexible kernel configuration features. diff --git a/doc/user/kernel.rst b/doc/user/kernel.rst index 4161c4ae94..a11b3ef167 100644 --- a/doc/user/kernel.rst +++ b/doc/user/kernel.rst @@ -1,3 +1,5 @@ +.. _Kernel_Interface: + **************** Kernel Interface **************** @@ -9,24 +11,24 @@ interfaces. *ioctl* - The @samp{ioctl} method is a very traditional way for reading or writing - kernel information. @samp{ioctl} can be used for looking up interfaces + The ``ioctl`` method is a very traditional way for reading or writing + kernel information. ``ioctl`` can be used for looking up interfaces and for modifying interface addresses, flags, mtu settings and other - types of information. Also, @samp{ioctl} can insert and delete kernel + types of information. Also, ``ioctl`` can insert and delete kernel routing table entries. It will soon be available on almost any platform which zebra supports, but it is a little bit ugly thus far, so if a better method is supported by the kernel, zebra will use that. *sysctl* - @samp{sysctl} can lookup kernel information using MIB (Management + ``sysctl`` can lookup kernel information using MIB (Management Information Base) syntax. Normally, it only provides a way of getting information from the kernel. So one would usually want to change kernel - information using another method such as @samp{ioctl}. + information using another method such as ``ioctl``. *proc filesystem* - @samp{proc filesystem} provides an easy way of getting kernel + ``proc filesystem`` provides an easy way of getting kernel information. diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 201ea7ce19..504ff15185 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -359,14 +359,14 @@ RIP routes can be filtered by a distribute-list. Command {distribute-list `access_list` `direct` `ifname`} {} You can apply access lists to the interface with a `distribute-list` command. `access_list` is the access list name. `direct` is - @samp{in} or @samp{out}. If `direct` is @samp{in} the access list + ``in`` or ``out``. If `direct` is ``in`` the access list is applied to input packets. The `distribute-list` command can be used to filter the RIP path. `distribute-list` can apply access-lists to a chosen interface. First, one should specify the access-list. Next, the name of the access-list is used in the distribute-list command. For example, in the - following configuration @samp{eth0} will permit only the paths that + following configuration ``eth0`` will permit only the paths that match the route 10.0.0.0/8 :: @@ -387,8 +387,8 @@ Command {distribute-list `access_list` `direct` `ifname`} {} Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {} You can apply prefix lists to the interface with a `distribute-list` command. `prefix_list` is the prefix list - name. Next is the direction of @samp{in} or @samp{out}. If - `direct` is @samp{in} the access list is applied to input packets. + name. Next is the direction of ``in`` or ``out``. If + `direct` is ``in`` the access list is applied to input packets. .. _RIP_Metric_Manipulation: diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst index 2c4bfa2c35..07ce7175fc 100644 --- a/doc/user/ripngd.rst +++ b/doc/user/ripngd.rst @@ -83,8 +83,8 @@ ripngd Filtering Commands Command {distribute-list `access_list` (in|out) `ifname`} {} You can apply an access-list to the interface using the `distribute-list` command. `access_list` is an access-list - name. `direct` is @samp{in} or @samp{out}. If `direct` is - @samp{in}, the access-list is applied only to incoming packets. + name. `direct` is ``in`` or ``out``. If `direct` is + ``in``, the access-list is applied only to incoming packets. :: diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 7ec3fcaf4f..75864b5edf 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -13,22 +13,22 @@ specify up to four distincts sets of clauses: *Matching Policy* - This specifies the policy implied if the @samp{Matching Conditions} are + This specifies the policy implied if the ``Matching Conditions`` are met or not met, and which actions of the route-map are to be taken, if any. The two possibilities are: ** - @samp{permit}: If the entry matches, then carry out the @samp{Set + ``permit``: If the entry matches, then carry out the @samp{Set Actions}. Then finish processing the route-map, permitting the route, - unless an @samp{Exit Action} indicates otherwise. + unless an ``Exit Action`` indicates otherwise. ** - @samp{deny}: If the entry matches, then finish processing the route-map and - deny the route (return @samp{deny}). + ``deny``: If the entry matches, then finish processing the route-map and + deny the route (return ``deny``). - The @samp{Matching Policy} is specified as part of the command which + The ``Matching Policy`` is specified as part of the command which defines the ordered entry in the route-map. See below. @@ -45,32 +45,32 @@ specify up to four distincts sets of clauses: *Call Action* - Call to another route-map, after any @samp{Set Actions} have been - carried out. If the route-map called returns @samp{deny} then + Call to another route-map, after any ``Set Actions`` have been + carried out. If the route-map called returns ``deny`` then processing of the route-map finishes and the route is denied, - regardless of the @samp{Matching Policy} or the @samp{Exit Policy}. If - the called route-map returns @samp{permit}, then @samp{Matching Policy} - and @samp{Exit Policy} govern further behaviour, as normal. + regardless of the ``Matching Policy`` or the ``Exit Policy``. If + the called route-map returns ``permit``, then ``Matching Policy`` + and ``Exit Policy`` govern further behaviour, as normal. *Exit Policy* - An entry may, optionally, specify an alternative @samp{Exit Policy} to + An entry may, optionally, specify an alternative ``Exit Policy`` to take if the entry matched, rather than the normal policy of exiting the route-map and permitting the route. The two possibilities are: ** - @samp{next}: Continue on with processing of the route-map entries. + ``next``: Continue on with processing of the route-map entries. ** - @samp{goto N}: Jump ahead to the first route-map entry whose order in + ``goto N``: Jump ahead to the first route-map entry whose order in the route-map is >= N. Jumping to a previous entry is not permitted. The default action of a route-map, if no entries match, is to deny. -I.e. a route-map essentially has as its last entry an empty @samp{deny} +I.e. a route-map essentially has as its last entry an empty ``deny`` entry, which matches all routes. To change this behaviour, one must -specify an empty @samp{permit} entry as the last entry in the route-map. +specify an empty ``permit`` entry as the last entry in the route-map. To summarise the above: @@ -89,16 +89,16 @@ To summarise the above: ** - If *call* is present, call given route-map. If that returns a @samp{deny}, finish - processing and return @samp{deny}. + If *call* is present, call given route-map. If that returns a ``deny``, finish + processing and return ``deny``. ** - If @samp{Exit Policy} is *next*, goto next route-map entry + If ``Exit Policy`` is *next*, goto next route-map entry ** - If @samp{Exit Policy} is *goto*, goto first entry whose order in the list + If ``Exit Policy`` is *goto*, goto first entry whose order in the list is >= the given order. @@ -109,7 +109,7 @@ To summarise the above: *deny* ** - The route is denied by the route-map (return @samp{deny}). + The route is denied by the route-map (return ``deny``). *cont* @@ -127,7 +127,7 @@ Route Map Command {Command} {route-map `route-map-name` (permit|deny) `order`} {} Configure the `order`'th entry in `route-map-name` with - @samp{Match Policy} of either *permit* or *deny*. + ``Match Policy`` of either *permit* or *deny*. .. _Route_Map_Match_Command: @@ -304,5 +304,5 @@ This means that if a route matches ip access-list number 10 it's local-preference value is set to 200. See :ref:`BGP_Configuration_Examples` for examples of more sophisticated -useage of route-maps, including of the @samp{call} action. +useage of route-maps, including of the ``call`` action. diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst index 70d5bcdc2f..9c6cb05b89 100644 --- a/doc/user/snmptrap.rst +++ b/doc/user/snmptrap.rst @@ -7,7 +7,7 @@ correctly as described in the frr documentation in :ref:`SNMP_Support`. The BGP4 mib will send traps on peer up/down events. These should be visible in your snmp logs with a message similar to: -@samp{snmpd[13733]: Got trap from peer on fd 14} +``snmpd[13733]: Got trap from peer on fd 14`` To react on these traps they should be handled by a trapsink. Configure your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: From 07a17e6d4e55786b609249d4999eae0f63cca536 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 14:40:54 -0500 Subject: [PATCH 025/148] doc: shotgun cleanup Signed-off-by: Quentin Young --- doc/user/babeld.rst | 2 +- doc/user/bgp.rst | 27 ++++++++++++------------- doc/user/installation.rst | 42 ++++++++++++++++++--------------------- doc/user/overview.rst | 16 ++++++++++++--- doc/user/ripd.rst | 34 ++++++++++++++----------------- 5 files changed, 61 insertions(+), 60 deletions(-) diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst index fd96fea40a..fd0b853b7d 100644 --- a/doc/user/babeld.rst +++ b/doc/user/babeld.rst @@ -13,7 +13,7 @@ perform reliable link quality estimation on wireless links. Babel is a double-stack routing protocol, meaning that a single Babel instance is able to perform routing for both IPv4 and IPv6. -FRR imlements Babel as described in :t:`RFC6126`. +FRR implements Babel as described in :rfc:`6126`. .. _Configuring_babeld: diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 485f60e759..6abb5cfa3b 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -7,10 +7,10 @@ BGP :abbr:`BGP` stands for a Border Gateway Protocol. The lastest BGP version is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway Protocols and de-fact standard of Inter Domain routing protocol. BGP-4 is described in -:t:`RFC1771, A Border Gateway Protocol 4 (BGP-4)`. +:rfc:`1771`. -Many extensions have been added to :t:`RFC1771`. :t:`RFC2858, Multiprotocol -Extensions for BGP-4` provides multiprotocol support to BGP-4. +Many extensions have been added to :rfc:`1771`. :rfc:`2858` provides +multiprotocol support to BGP-4. .. _Starting_BGP: @@ -233,7 +233,6 @@ BGP route flap dampening This command enables BGP route-flap dampening and specifies dampening parameters. - *@asis{half-life}* Half-life time for the penalty @@ -246,25 +245,25 @@ BGP route flap dampening *@asis{max-suppress}* Maximum duration to suppress a stable route - The route-flap damping algorithm is compatible with :t:`RFC2439`. The use of this command - is not recommended nowadays, see `http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 `_. + The route-flap damping algorithm is compatible with :rfc:`2439`. The use of this command + is not recommended nowadays, see http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 . .. _BGP_MED: BGP MED ======= -The BGP MED (Multi_Exit_Discriminator) attribute has properties which can +The BGP :abbr:`MED (Multi Exit Discriminator)` attribute has properties which can cause subtle convergence problems in BGP. These properties and problems have proven to be hard to understand, at least historically, and may still not be widely understood. The following attempts to collect together and present what is known about MED, to help operators and FRR users in designing and configuring their networks. -The BGP :abbr:`MED ( Multi_Exit_Discriminator)` attribute is intended to -allow one AS to indicate its preferences for its ingress points to another -AS. The MED attribute will not be propagated on to another AS by the -receiving AS - it is 'non-transitive' in the BGP sense. +The BGP :abbr:`MED` attribute is intended to allow one AS to indicate its +preferences for its ingress points to another AS. The MED attribute will not be +propagated on to another AS by the receiving AS - it is 'non-transitive' in the +BGP sense. E.g., if AS X and AS Y have 2 different BGP peering points, then AS X might set a MED of 100 on routes advertised at one and a MED of 200 at the @@ -941,8 +940,8 @@ Network Layer protocols. BGP supports multiple Address Family Identifier (AFI), namely IPv4 and IPv6. Support is also provided for multiple sets of per-AFI information via Subsequent Address Family Identifiers (SAFI). In addition to unicast information, VPN information -:t:`RFC4364` and :t:`RFC4659`, and Encapsulation information -:t:`RFC5512` is supported. +:rfc:`4364` and :rfc:`4659`, and Encapsulation information +:rfc:`5512` is supported. .. index:: show ip bgp vpnv4 all @@ -1784,7 +1783,7 @@ When adding IPv6 routing information exchange feature to BGP. There were some proposals. :abbr:`IETF (Internet Engineering Task Force)` :abbr:`IDR ( Inter Domain Routing)` :abbr:`IDR ( Inter Domain Routing)` adopted a proposal called Multiprotocol Extension for BGP. The specification -is described in :t:`RFC2283`. The protocol does not define new protocols. +is described in :rfc:`2283`. The protocol does not define new protocols. It defines new attributes to existing BGP. When it is used exchanging IPv6 routing information it is called BGP-4+. When it is used for exchanging multicast routing information it is called MBGP. diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 4fd916c475..3bf0eac332 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -13,18 +13,17 @@ Installation Several distributions provide packages for FRR. Check your distribution's respositories to find out if a suitable version is available. -If you wish to build FRR yourself, please see the `Building`_ appendix. +FRR depends on various libraries depending on your operating system. -FRR depends on various libraries depending on your operationg system. - -After installing these dependencies, change to the frr source directory and issue the following commands: +After installing these dependencies, change to the frr source directory and +issue the following commands: :: - % ./bootstrap.sh - % ./configure - % make - % make install + $ ./bootstrap.sh + $ ./configure + $ make + $ make install .. _Configure_the_Software: @@ -211,11 +210,11 @@ options to control the behaviour of FRR daemons. delegate this group to individual users, or to run vtysh setgid to this group. -The default user and group which will be configured is 'frr' if no user -or group is specified. Note that this user or group requires write access to -the local state directory (see `--localstatedir`) and requires at least read -access, and write access if you wish to allow daemons to write out their -configuration, to the configuration directory (see `--sysconfdir`). +The default user and group which will be configured is 'frr' if no user or +group is specified. Note that this user or group requires write access to the +local state directory (see :option:`--localstatedir`) and requires at least +read access, and write access if you wish to allow daemons to write out their +configuration, to the configuration directory (see :option:`--sysconfdir`). On systems which have the 'libcap' capabilities manipulation library (currently only Linux), FRR will retain only minimal capabilities required and will only @@ -239,15 +238,15 @@ you want. FRR will run with any kernel configuration but some recommendations do exist. -- CONFIG_NETLINK +- :makevar:`CONFIG_NETLINK` Kernel/User netlink socket. This is a brand new feature which enables an advanced interface between the Linux kernel and zebra (:ref:`Kernel_Interface`). -- CONFIG_RTNETLINK +- :makevar:`CONFIG_RTNETLINK` Routing messages. This makes it possible to receive netlink routing messages. If you specify this option, *zebra* can detect routing information updates directly from the kernel (:ref:`Kernel_Interface`). -- CONFIG_IP_MULTICAST +- :makevar:`CONFIG_IP_MULTICAST` IP: multicasting. This option should be specified when you use *ripd* (:ref:`RIP`) or *ospfd* (:ref:`OSPFv2`) because these protocols use multicast. @@ -265,13 +264,10 @@ or upper. included. The `inet-apps` can be found at `ftp://ftp.inner.net/pub/ipv6/ `_. - *net-tools* - The `net-tools` package provides an IPv6 enabled interface and - routing utility. It contains *ifconfig*, *route*, - *netstat*, and other tools. `net-tools` may be found at - `http://www.tazenda.demon.co.uk/phil/net-tools/ `_. - + The `net-tools` package provides an IPv6 enabled interface and routing + utility. It contains *ifconfig*, *route*, *netstat*, and other tools. + `net-tools` may be found at http://www.tazenda.demon.co.uk/phil/net-tools/. .. _Build_the_Software: @@ -282,7 +278,7 @@ After configuring the software, you will need to compile it for your system. Simply issue the command *make* in the root of the source directory and the software will be compiled. Cliff Notes versions of different compilation examples can be found in the Developer's Manual Appendix. If you have *any* -problems at this stage, please send a bug report :ref:`Bug_Reports`. +problems at this stage, please send a bug report :ref:`Bug-Reports`. :: diff --git a/doc/user/overview.rst b/doc/user/overview.rst index 5fd9b490c6..7a6cdf11d2 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -4,6 +4,14 @@ Overview ******** +big booty bizitches + + ballsack + +show ip bgp sum + + example + `FRR`_ is a routing software package that provides TCP/IP based routing services with routing protocols support such as RIPv1, RIPv2, RIPng, OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`supported-rfcs`). FRR also @@ -270,9 +278,6 @@ reflected in updates, as appropriate, to code (i.e., merges), `GitHub or process changes, updates to the Development list and either this file or information posted at https://frrouting.org/. -Bug Reports -=========== - .. index:: Bug Reports .. index:: Bug hunting .. index:: Found a bug? @@ -280,6 +285,11 @@ Bug Reports .. index:: Reporting software errors .. index:: Errors in the software +.. _Bug-Reports: + +Bug Reports +=========== + If you think you have found a bug, please file a bug report on our `GitHub issues`_ page. diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 504ff15185..8150f960b6 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -44,30 +44,26 @@ Please note that *zebra* must be invoked before *ripd*. To stop *ripd*. Please use @command{kill `cat /var/run/ripd.pid`}. Certain signals have special meaningss to *ripd*. - - -*SIGHUP* - Reload configuration file :file:`ripd.conf`. All configurations are - reseted. All routes learned so far are cleared and removed from routing - table. - -*SIGUSR1* - Rotate *ripd* logfile. - -*SIGINT* - -*SIGTERM* - *ripd* sweeps all installed RIP routes then terminates properly. + +-------------+------------------------------------------------------+ + | Signal | Action | + +=============+======================================================+ + | ``SIGHUP`` | Reload configuration file :file:`ripd.conf`. | + | | All configurations are reset. All routes learned | + | | so far are cleared and removed from routing table. | + +-------------+------------------------------------------------------+ + | ``SIGUSR1`` | Rotate the *ripd* logfile. | + +-------------+------------------------------------------------------+ + | ``SIGINT`` | | + | ``SIGTERM`` | Sweep all installed routes and gracefully terminate. | + +-------------+------------------------------------------------------+ *ripd* invocation options. Common options that can be specified (:ref:`Common_Invocation_Options`). +.. option:: -r +.. option:: --retain - -*-r* - -*--retain* - When the program terminates, retain routes added by *ripd*. + When the program terminates, retain routes added by *ripd*. .. _RIP_netmask: From a4c53928632881d10ea98e40491659b5b9790e43 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 14:44:58 -0500 Subject: [PATCH 026/148] doc: replace random @cite{RFC...} with :rfc:... Signed-off-by: Quentin Young --- doc/user/ospfd.rst | 8 ++++---- doc/user/rpki.rst | 2 +- doc/user/snmp.rst | 2 +- doc/user/vnc.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 23aae50ecc..d1dfd529f9 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -5,7 +5,7 @@ OSPFv2 ****** @acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol -which is described in @cite{RFC2328, OSPF Version 2}. OSPF is an +which is described in :rfc:`2328`. OSPF is an @acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, @acronym{OSPF} can provide scalable network support and faster convergence times. OSPF is widely used in large networks such as @@ -107,7 +107,7 @@ Command {no router ospf} {} .. index:: {OSPF Command} {no ospf rfc1583compatibility} {} {OSPF Command} {no ospf rfc1583compatibility} {} - @cite{RFC2328}, the sucessor to @cite{RFC1583}, suggests according + :rfc:`2328`, the sucessor to :rfc:`1583`, suggests according to section G.2 (changes) in section 16.4 a change to the path preference algorithm that prevents possible routing loops that were possible in the old version of OSPFv2. More specifically it demands @@ -196,7 +196,7 @@ Command {no router ospf} {} .. index:: {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} - This enables @cite{RFC3137, OSPF Stub Router Advertisement} support, + This enables :rfc:`3137` support, where the OSPF process describes its transit links in its router-LSA as having infinite distance so that other routers will avoid calculating transit paths through the router while still being able to reach @@ -376,7 +376,7 @@ OSPF area .. index:: {OSPF Command} {no area <0-4294967295> shortcut} {} {OSPF Command} {no area <0-4294967295> shortcut} {} - Configure the area as Shortcut capable. See @cite{RFC3509}. This requires + Configure the area as Shortcut capable. See :rfc:`3509`. This requires that the 'abr-type' be set to 'shortcut'. .. index:: {OSPF Command} {area `a.b.c.d` stub} {} diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index bf99940e39..3a1b23a3b3 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -18,7 +18,7 @@ complexity. The RPKI/RTR protocol is defined in @cite{RFC6810, The Resource Public Key Infrastructure (RPKI) to Router Protocol}, and the validation scheme in -@cite{RFC6811, BGP Prefix Origin Validation}. The current version of Prefix +:rfc:`6811`. The current version of Prefix Origin Validation in FRR implements both RFCs. For a more detailed but still easy-to-read background, we suggest the diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 5c7da0e00c..26775743fe 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -8,7 +8,7 @@ SNMP Support feature for collecting network information from router and/or host. FRR itself does not support SNMP agent (server daemon) functionality but is able to connect to a SNMP agent using the SMUX protocol -(@cite{RFC1227}) or the AgentX protocol (@cite{RFC2741}) and make the +(:rfc:`1227`) or the AgentX protocol (:rfc:`2741`) and make the routing protocol MIBs available through it. Note that SNMP Support needs to be enabled at compile-time and loaded as diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 525e4b1ecf..012ee33c77 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -19,7 +19,7 @@ Ethernet/Layer 2 (L2) VNs are supported. BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN information between NVAs. BGP based IP VPN support is defined in -@cite{RFC4364, BGP/MPLS IP Virtual Private Networks (VPNs)}, and +:rfc:`4364`, and @cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for IPv6 VPN }. Both the Encapsulation Subsequent Address Family Identifier (SAFI) and the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP @@ -433,7 +433,7 @@ are used to override the route targets for an NVE's Ethernet registrations based on the Logical Network Identifier and label value. A Logical Network Identifier is used to uniquely identify a logical Ethernet segment and is conceptually similar to the Ethernet Segment -Identifier defined in @cite{RFC7432, BGP MPLS-Based Ethernet VPN}. Both +Identifier defined in :rfc:`7432`. Both the Logical Network Identifier and Label are passed to VNC via RFP prefix and address registration. From 2731b07dba127668f8e0b0e405b61e388ba202fe Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 15:51:59 -0500 Subject: [PATCH 027/148] doc: add clicmd role for frr cli Signed-off-by: Quentin Young --- doc/user/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/user/conf.py b/doc/user/conf.py index 86d8353e2a..1eac6af763 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -331,3 +331,9 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +# custom extensions here +def setup(app): + # object type for FRR CLI commands, can be extended to document parent CLI + # node later on + app.add_object_type('clicmd', 'clicmd') From 29adcd50089793e31e9ed182a0b370763827ed27 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 15:52:30 -0500 Subject: [PATCH 028/148] doc: fix cli documentation formatting * Use new 'clicmd' directive / role * Convert old style range syntax to new style Signed-off-by: Quentin Young --- doc/user/babeld.rst | 88 +++++------ doc/user/basic.rst | 313 +++++++++++++++++++++---------------- doc/user/bgp.rst | 356 +++++++++++++++++++++--------------------- doc/user/eigrpd.rst | 52 +++--- doc/user/ipv6.rst | 66 ++++---- doc/user/isisd.rst | 88 +++++------ doc/user/ospfd.rst | 208 ++++++++++++------------ doc/user/overview.rst | 8 - doc/user/ripd.rst | 64 ++++---- doc/user/rpki.rst | 4 +- doc/user/snmptrap.rst | 2 +- doc/user/vnc.rst | 12 +- doc/user/zebra.rst | 28 ++-- 13 files changed, 660 insertions(+), 629 deletions(-) diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst index fd0b853b7d..3e5c1b16b3 100644 --- a/doc/user/babeld.rst +++ b/doc/user/babeld.rst @@ -39,14 +39,14 @@ Babel configuration single: router babel single: no router babel -``[no] router babel`` +.. clicmd:: [no] router babel Enable or disable Babel routing. .. index:: - single: babel resend-delay <20-655340> - single: no babel resend-delay [<20-655340>] + single: babel resend-delay (20-655340) + single: no babel resend-delay [(20-655340)] -``[no] babel resend-delay <20-655340>`` +.. clicmd:: [no] babel resend-delay (20-655340) Specifies the time after which important messages are resent when avoiding a black-hole. The default is 2000 ms. @@ -54,15 +54,15 @@ Babel configuration single: babel diversity single: no babel diversity -``[no] babel diversity`` +.. clicmd:: [no] babel diversity Enable or disable routing using radio frequency diversity. This is highly recommended in networks with many wireless nodes. If you enable this, you will probably want to set `babel diversity-factor` and `babel channel` below. -.. index:: babel diversity-factor <1-256> +.. index:: babel diversity-factor (1-256) -``babel diversity-factor <1-256>`` +.. clicmd:: babel diversity-factor (1-256) Sets the multiplicative factor used for diversity routing, in units of 1/256; lower values cause diversity to play a more important role in route selection. The default it 256, which means that diversity plays @@ -73,12 +73,12 @@ Babel configuration single: network IFNAME single: no network IFNAME -``no network IFNAME`` +.. clicmd:: no network IFNAME Enable or disable Babel on the given interface. .. index:: babel -``babel `` +.. clicmd:: babel Specifies whether this interface is wireless, which disables a number of optimisations that are only correct on wired interfaces. Specifying `wireless` (the default) is always correct, but may @@ -88,7 +88,7 @@ Babel configuration single: babel split-horizon single: no babel split-horizon -``[no] babel split-horizon`` +.. clicmd:: [no] babel split-horizon Specifies whether to perform split-horizon on the interface. Specifying ``no babel split-horizon`` is always correct, while ``babel split-horizon`` is an optimisation that should only be used on symmetric @@ -97,34 +97,34 @@ Babel configuration interfaces. This flag is reset when the wired/wireless status of an interface is changed. -.. index:: babel hello-interval <20-655340> +.. index:: babel hello-interval (20-655340) -``babel hello-interval <20-655340>`` +.. clicmd:: babel hello-interval (20-655340) Specifies the time in milliseconds between two scheduled hellos. On wired links, Babel notices a link failure within two hello intervals; on wireless links, the link quality value is reestimated at every hello interval. The default is 4000 ms. -.. index:: babel update-interval <20-655340> +.. index:: babel update-interval (20-655340) -``babel update-interval <20-655340>`` +.. clicmd:: babel update-interval (20-655340) Specifies the time in milliseconds between two scheduled updates. Since Babel makes extensive use of triggered updates, this can be set to fairly high values on links with little packet loss. The default is 20000 ms. .. index:: - single: babel channel <1-254> + single: babel channel (1-254) single: babel channel interfering single: babel channel noninterfering -``babel channel <1-254>`` +.. clicmd:: babel channel (1-254) see below -``babel channel interfering`` +.. clicmd:: babel channel interfering see below -``babel channel noninterfering`` +.. clicmd:: babel channel noninterfering Set the channel number that diversity routing uses for this interface (see `babel diversity` above). Noninterfering interfaces are assumed to only interfere with themselves, interfering interfaces are @@ -136,9 +136,9 @@ Babel configuration interfaces. This is reset when the wired/wireless status of an interface is changed. -.. index:: babel rxcost <1-65534> +.. index:: babel rxcost (1-65534) -``babel rxcost <1-65534>`` +.. clicmd:: babel rxcost (1-65534) Specifies the base receive cost for this interface. For wireless interfaces, it specifies the multiplier used for computing the ETX reception cost (default 256); for wired interfaces, it specifies the @@ -149,29 +149,29 @@ Babel configuration networks, acting directly on the cost using route maps is a better technique. -.. index:: babel rtt-decay <1-256> +.. index:: babel rtt-decay (1-256) -``babel rtt-decay <1-256>`` +.. clicmd:: babel rtt-decay (1-256) This specifies the decay factor for the exponential moving average of RTT samples, in units of 1/256. Higher values discard old samples faster. The default is 42. -.. index:: babel rtt-min <1-65535> +.. index:: babel rtt-min (1-65535) -``babel rtt-min <1-65535>`` +.. clicmd:: babel rtt-min (1-65535) This specifies the minimum RTT, in milliseconds, starting from which we increase the cost to a neighbour. The additional cost is linear in (rtt - rtt-min). The default is 100 ms. -.. index:: babel rtt-max <1-65535> +.. index:: babel rtt-max (1-65535) -``babel rtt-max <1-65535>`` +.. clicmd:: babel rtt-max (1-65535) This specifies the maximum RTT, in milliseconds, above which we don't increase the cost to a neighbour. The default is 120 ms. -.. index:: babel max-rtt-penalty <0-65535> +.. index:: babel max-rtt-penalty (0-65535) -``babel max-rtt-penalty <0-65535>`` +.. clicmd:: babel max-rtt-penalty (0-65535) This specifies the maximum cost added to a neighbour because of RTT, i.e. when the RTT is higher or equal than rtt-max. The default is 0, which effectively disables the use of a RTT-based cost. @@ -180,20 +180,20 @@ Babel configuration single: babel enable-timestamps single: no babel enable-timestamps -``[no] babel enable-timestamps`` +.. clicmd:: [no] babel enable-timestamps Enable or disable sending timestamps with each Hello and IHU message in order to compute RTT values. The default is `no babel enable-timestamps`. -.. index:: babel resend-delay <20-655340> +.. index:: babel resend-delay (20-655340) -``babel resend-delay <20-655340>`` +.. clicmd:: babel resend-delay (20-655340) Specifies the time in milliseconds after which an 'important' request or update will be resent. The default is 2000 ms. You probably don't want to tweak this value. -.. index:: babel smoothing-half-life <0-65534> +.. index:: babel smoothing-half-life (0-65534) -``babel smoothing-half-life <0-65534>`` +.. clicmd:: babel smoothing-half-life (0-65534) Specifies the time constant, in seconds, of the smoothing algorithm used for implementing hysteresis. Larger values reduce route oscillation at the cost of very slightly increasing convergence time. @@ -209,7 +209,7 @@ Babel redistribution single: redistribute KIND single: no redistribute KIND -``[no] redistribute KIND`` +.. clicmd:: [no] redistribute KIND Specify which kind of routes should be redistributed into Babel. .. _Show_Babel_information: @@ -221,47 +221,47 @@ These commands dump various parts of *babeld*'s internal state. .. index:: show babel route -``show babel route`` +.. clicmd:: show babel route *missing description* .. index:: show babel route A.B.C.D -``show babel route A.B.C.D`` +.. clicmd:: show babel route A.B.C.D *missing description* .. index:: show babel route X:X::X:X -``show babel route X:X::X:X`` +.. clicmd:: show babel route X:X::X:X *missing description* .. index:: show babel route A.B.C.D/M -``show babel route A.B.C.D/M`` +.. clicmd:: show babel route A.B.C.D/M *missing description* .. index:: show babel route X:X::X:X/M -``show babel route X:X::X:X/M`` +.. clicmd:: show babel route X:X::X:X/M *missing description* .. index:: show babel interface -``show babel interface`` +.. clicmd:: show babel interface *missing description* .. index:: show babel interface `IFNAME` -``show babel interface IFNAME`` +.. clicmd:: show babel interface IFNAME *missing description* .. index:: show babel neighbor -``show babel neighbor`` +.. clicmd:: show babel neighbor *missing description* .. index:: show babel parameters -``show babel parameters`` +.. clicmd:: show babel parameters *missing description* Babel debugging commands @@ -271,7 +271,7 @@ Babel debugging commands simple: debug babel KIND simple: no debug babel KIND -``[no] debug babel KIND`` +.. clicmd:: [no] debug babel KIND Enable or disable debugging messages of a given kind. ``KIND`` can be one of: diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 58c8caa4e3..97a29129c9 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -53,187 +53,208 @@ Basic Config Commands .. index:: hostname HOSTNAME -``hostname HOSTNAME`` - Set hostname of the router. +.. clicmd:: hostname HOSTNAME + + Set hostname of the router. .. index:: password PASSWORD -``password PASSWORD`` - Set password for vty interface. If there is no password, a vty won't - accept connections. +.. clicmd:: password PASSWORD + + Set password for vty interface. If there is no password, a vty won't + accept connections. .. index:: enable password PASSWORD -``enable password PASSWORD`` - Set enable password. +.. clicmd:: enable password PASSWORD + + Set enable password. .. index:: - single: no log trap [LEVEL] - single: log trap LEVEL + single: no log trap [LEVEL] + single: log trap LEVEL -``[no] log trap LEVEL`` - These commands are deprecated and are present only for historical - compatibility. The log trap command sets the current logging level for all - enabled logging destinations, and it sets the default for all future logging - commands that do not specify a level. The normal default logging level is - debugging. The ``no`` form of the command resets the default level for future - logging commands to debugging, but it does not change the logging level of - existing logging destinations. +.. clicmd:: [no] log trap LEVEL + + These commands are deprecated and are present only for historical + compatibility. The log trap command sets the current logging level for all + enabled logging destinations, and it sets the default for all future logging + commands that do not specify a level. The normal default logging level is + debugging. The ``no`` form of the command resets the default level for future + logging commands to debugging, but it does not change the logging level of + existing logging destinations. .. index:: - single: no log stdout [LEVEL] - single: log stdout [LEVEL] + single: no log stdout [LEVEL] + single: log stdout [LEVEL] -``[no] log stdout LEVEL`` - Enable logging output to stdout. If the optional second argument specifying - the logging level is not present, the default logging level (typically - debugging, but can be changed using the deprecated ``log trap`` command) will - be used. The ``no`` form of the command disables logging to stdout. The - ``LEVEL`` argument must have one of these values: emergencies, alerts, - critical, errors, warnings, notifications, informational, or debugging. Note - that the existing code logs its most important messages with severity - ``errors``. +.. clicmd:: [no] log stdout LEVEL + + Enable logging output to stdout. If the optional second argument specifying + the logging level is not present, the default logging level (typically + debugging, but can be changed using the deprecated ``log trap`` command) will + be used. The ``no`` form of the command disables logging to stdout. The + ``LEVEL`` argument must have one of these values: emergencies, alerts, + critical, errors, warnings, notifications, informational, or debugging. Note + that the existing code logs its most important messages with severity + ``errors``. .. index:: - single: no log file [FILENAME [LEVEL]] - single: log file FILENAME [LEVEL] + single: no log file [FILENAME [LEVEL]] + single: log file FILENAME [LEVEL] -``[no] log file [FILENAME [LEVEL]]`` - If you want to log into a file, please specify ``filename`` as - in this example: :: +.. clicmd:: [no] log file [FILENAME [LEVEL]] - log file /var/log/frr/bgpd.log informational + If you want to log into a file, please specify ``filename`` as + in this example: :: - If the optional second argument specifying the logging level is not present, - the default logging level (typically debugging, but can be changed using the - deprecated ``log trap`` command) will be used. The ``no`` form of the command - disables logging to a file. *Note:* if you do not configure any file logging, - and a daemon crashes due to a signal or an assertion failure, it will attempt - to save the crash information in a file named /var/tmp/frr..crashlog. For security reasons, this will not happen if the file exists - already, so it is important to delete the file after reporting the crash - information. + log file /var/log/frr/bgpd.log informational + + If the optional second argument specifying the logging level is not present, + the default logging level (typically debugging, but can be changed using the + deprecated ``log trap`` command) will be used. The ``no`` form of the command + disables logging to a file. *Note:* if you do not configure any file logging, + and a daemon crashes due to a signal or an assertion failure, it will attempt + to save the crash information in a file named /var/tmp/frr..crashlog. For security reasons, this will not happen if the file exists + already, so it is important to delete the file after reporting the crash + information. .. index:: - single: no log syslog [LEVEL] - single: log syslog [LEVEL] + single: no log syslog [LEVEL] + single: log syslog [LEVEL] -``[no] log syslog [LEVEL]`` - Enable logging output to syslog. If the optional second argument specifying - the logging level is not present, the default logging level (typically - debugging, but can be changed using the deprecated ``log trap`` command) will - be used. The ``no`` form of the command disables logging to syslog. +.. clicmd:: [no] log syslog [LEVEL] + + Enable logging output to syslog. If the optional second argument specifying + the logging level is not present, the default logging level (typically + debugging, but can be changed using the deprecated ``log trap`` command) will + be used. The ``no`` form of the command disables logging to syslog. .. index:: - single: no log monitor [LEVEL] - single: log monitor [LEVEL] + single: no log monitor [LEVEL] + single: log monitor [LEVEL] -``[no] log monitor [LEVEL]`` - Enable logging output to vty terminals that have enabled logging using the - ``terminal monitor`` command. By default, monitor logging is enabled at the - debugging level, but this command (or the deprecated ``log trap`` command) can - be used to change the monitor logging level. If the optional second argument - specifying the logging level is not present, the default logging level - (typically debugging, but can be changed using the deprecated ``log trap`` - command) will be used. The ``no`` form of the command disables logging to - terminal monitors. +.. clicmd:: [no] log monitor [LEVEL] + + Enable logging output to vty terminals that have enabled logging using the + ``terminal monitor`` command. By default, monitor logging is enabled at the + debugging level, but this command (or the deprecated ``log trap`` command) can + be used to change the monitor logging level. If the optional second argument + specifying the logging level is not present, the default logging level + (typically debugging, but can be changed using the deprecated ``log trap`` + command) will be used. The ``no`` form of the command disables logging to + terminal monitors. .. index:: - single: no log facility [FACILITY] - single: log facility [FACILITY] + single: no log facility [FACILITY] + single: log facility [FACILITY] -``[no] log facility [FACILITY]`` - This command changes the facility used in syslog messages. The default - facility is ``daemon``. The ``no`` form of the command resets - the facility to the default ``daemon`` facility. +.. clicmd:: [no] log facility [FACILITY] + + This command changes the facility used in syslog messages. The default + facility is ``daemon``. The ``no`` form of the command resets + the facility to the default ``daemon`` facility. .. index:: - single: no log record-priority - single: log record-priority + single: no log record-priority + single: log record-priority -``[no] log record-priority`` - To include the severity in all messages logged to a file, to stdout, or to - a terminal monitor (i.e. anything except syslog), - use the ``log record-priority`` global configuration command. - To disable this option, use the ``no`` form of the command. By default, - the severity level is not included in logged messages. Note: some - versions of syslogd (including Solaris) can be configured to include - the facility and level in the messages emitted. +.. clicmd:: [no] log record-priority + + To include the severity in all messages logged to a file, to stdout, or to + a terminal monitor (i.e. anything except syslog), + use the ``log record-priority`` global configuration command. + To disable this option, use the ``no`` form of the command. By default, + the severity level is not included in logged messages. Note: some + versions of syslogd (including Solaris) can be configured to include + the facility and level in the messages emitted. .. index:: - single: log timestamp precision <0-6> - single: [no] log timestamp precision <0-6> + single: log timestamp precision (0-6) + single: [no] log timestamp precision (0-6) -``[no] log timestamp precision [<0-6>]`` - This command sets the precision of log message timestamps to the given number - of digits after the decimal point. Currently, the value must be in the range - 0 to 6 (i.e. the maximum precision is microseconds). To restore the default - behavior (1-second accuracy), use the ``no`` form of the command, or set the - precision explicitly to 0. +.. clicmd:: [no] log timestamp precision [(0-6)] + + This command sets the precision of log message timestamps to the given number + of digits after the decimal point. Currently, the value must be in the range + 0 to 6 (i.e. the maximum precision is microseconds). To restore the default + behavior (1-second accuracy), use the ``no`` form of the command, or set the + precision explicitly to 0. :: - log timestamp precision 3 + log timestamp precision 3 - In this example, the precision is set to provide timestamps with - millisecond accuracy. + In this example, the precision is set to provide timestamps with + millisecond accuracy. .. index:: log commands -``log commands`` - This command enables the logging of all commands typed by a user to - all enabled log destinations. The note that logging includes full - command lines, including passwords. Once set, command logging can only - be turned off by restarting the daemon. +.. clicmd:: log commands + + This command enables the logging of all commands typed by a user to + all enabled log destinations. The note that logging includes full + command lines, including passwords. Once set, command logging can only + be turned off by restarting the daemon. .. index:: service password-encryption -``service password-encryption`` - Encrypt password. +.. clicmd:: service password-encryption + + Encrypt password. .. index:: service advanced-vty -``service advanced-vty`` - Enable advanced mode VTY. +.. clicmd:: service advanced-vty -.. index:: service terminal-length <0-512> + Enable advanced mode VTY. -``service terminal-length <0-512>`` - Set system wide line configuration. This configuration command applies - to all VTY interfaces. +.. index:: service terminal-length (0-512) + +.. clicmd:: service terminal-length (0-512) + + Set system wide line configuration. This configuration command applies + to all VTY interfaces. .. index:: line vty -``line vty`` - Enter vty configuration mode. +.. clicmd:: line vty + + Enter vty configuration mode. .. index:: banner motd default -``banner motd default`` - Set default motd string. +.. clicmd:: banner motd default + + Set default motd string. .. index:: no banner motd -``no banner motd`` - No motd banner string will be printed. +.. clicmd:: no banner motd + + No motd banner string will be printed. .. index:: exec-timeout MINUTE [SECOND] -``exec-timeout MINUTE [SECOND]`` - Set VTY connection timeout value. When only one argument is specified - it is used for timeout value in minutes. Optional second argument is - used for timeout value in seconds. Default timeout value is 10 minutes. - When timeout value is zero, it means no timeout. +.. clicmd:: exec-timeout MINUTE [SECOND] + + Set VTY connection timeout value. When only one argument is specified + it is used for timeout value in minutes. Optional second argument is + used for timeout value in seconds. Default timeout value is 10 minutes. + When timeout value is zero, it means no timeout. .. index:: no exec-timeout -``no exec-timeout`` - Do not perform timeout at all. This command is as same as *exec-timeout 0 0*. +.. clicmd:: no exec-timeout + + Do not perform timeout at all. This command is as same as *exec-timeout 0 0*. .. index:: access-class ACCESS-LIST -``access-class ACCESS-LIST`` - Restrict vty connections with an access list. +.. clicmd:: access-class ACCESS-LIST + + Restrict vty connections with an access list. .. _Sample_Config_File: @@ -275,50 +296,59 @@ Terminal Mode Commands .. index:: write terminal -``write terminal`` +.. clicmd:: write terminal + Displays the current configuration to the vty interface. .. index:: write file -``write file`` +.. clicmd:: write file + Write current configuration to configuration file. .. index:: configure terminal -``configure terminal`` +.. clicmd:: configure terminal + Change to configuration mode. This command is the first step to configuration. -.. index:: terminal length <0-512> +.. index:: terminal length (0-512) -``terminal length <0-512>`` - Set terminal display length to ``<0-512>``. If length is 0, no +.. clicmd:: terminal length (0-512) + + Set terminal display length to ``(0-512)``. If length is 0, no display control is performed. .. index:: who -``who`` +.. clicmd:: who + Show a list of currently connected vty sessions. .. index:: list -``list`` +.. clicmd:: list + List all available commands. .. index:: show version -``show version`` +.. clicmd:: show version + Show the current version of |PACKAGE_NAME| and its build host information. .. index:: show logging -``show logging`` +.. clicmd:: show logging + Shows the current configuration of the logging system. This includes the status of all logging destinations. .. index:: logmsg LEVEL MESSAGE -``logmsg LEVEL MESSAGE`` +.. clicmd:: logmsg LEVEL MESSAGE + Send a message to all logging destinations that are enabled for messages of the given severity. @@ -330,19 +360,23 @@ Common Invocation Options These options apply to all |PACKAGE_NAME| daemons. -``-d, --daemon`` +.. clicmd:: -d, --daemon + Runs in daemon mode. -``-f file, --config_file=FILE`` +.. clicmd:: -f file, --config_file=FILE + Set configuration file name. -``-h, --help`` +.. clicmd:: -h, --help + Display this help and exit. -``-i file, --pid_file=file`` +.. clicmd:: -i file, --pid_file=file + Upon startup the process identifier of the daemon is written to a file, typically in :file:`/var/run`. This file can be used by the init system to implement commands such as ``.../init.d/zebra status``, @@ -355,21 +389,25 @@ These options apply to all |PACKAGE_NAME| daemons. points in the network. -``-A address, --vty_addr=address`` +.. clicmd:: -A address, --vty_addr=address + Set the VTY local address to bind to. If set, the VTY socket will only be bound to this address. -``-P port, --vty_port=port`` +.. clicmd:: -P port, --vty_port=port + Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not be opened. -``-u user, --vty_addr=user`` +.. clicmd:: -u user, --vty_addr=user + Set the user and group to run as. -``-v, --version`` +.. clicmd:: -v, --version + Print program version. @@ -383,7 +421,8 @@ unloading modules at runtime is not supported (yet). To load a module, use the following command line option at daemon startup: -``-M module:options, --module module:options`` +.. clicmd:: -M module:options, --module module:options + Load the specified module, optionally passing options to it. If the module name contains a slash (/), it is assumed to be a full pathname to a file to be loaded. If it does not contain a slash, the @@ -412,7 +451,7 @@ the ``fpm`` module can be loaded for the *zebra* daemon. This provides the Forwarding Plane Manager ("FPM") API. The module expects its argument to be either ``netlink`` or -``protobuf``, specifying the encapsulation to use. `netlink` is the +.. clicmd:: protobuf, specifying the encapsulation to use. `netlink` is the default, and `protobuf` may not be available if the module was built without protobuf support. Refer to :ref:`zebra_FIB_push_interface` for more information. diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 6abb5cfa3b..6e11937953 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -59,7 +59,7 @@ for detecting whether the BGP connection is internal one or external one. .. index:: router bgp ASN -``router bgp ASN`` +.. clicmd:: router bgp ASN Enable a BGP protocol process with the specified `asn`. After this statement you can input any `BGP Commands`. You can not create different BGP process under different `asn` without @@ -67,12 +67,12 @@ for detecting whether the BGP connection is internal one or external one. .. index:: no router bgp ASN -``no router bgp ASN`` +.. clicmd:: no router bgp ASN Destroy a BGP protocol process with the specified `asn`. .. index:: bgp router-id `A.B.C.D` -``bgp router-id `A.B.C.D``` +.. clicmd:: bgp router-id `A.B.C.D` This command specifies the router-ID. If *bgpd* connects to *zebra* it gets interface and address information. In that case default router ID value @@ -85,20 +85,20 @@ for detecting whether the BGP connection is internal one or external one. BGP distance ------------ -.. index:: distance bgp <1-255> <1-255> <1-255> +.. index:: distance bgp (1-255) (1-255) (1-255) -``distance bgp <1-255> <1-255> <1-255>`` +.. clicmd:: distance bgp (1-255) (1-255) (1-255) This command change distance value of BGP. Each argument is distance value for external routes, internal routes and local routes. -.. index:: distance <1-255> `A.B.C.D/M` +.. index:: distance (1-255) `A.B.C.D/M` -``distance <1-255> `A.B.C.D/M``` +.. clicmd:: distance (1-255) `A.B.C.D/M` -.. index:: distance <1-255> `A.B.C.D/M` `word` +.. index:: distance (1-255) `A.B.C.D/M` `word` -``distance <1-255> `A.B.C.D/M` `word``` +.. clicmd:: distance (1-255) `A.B.C.D/M` `word` This command set distance value to @@ -180,7 +180,7 @@ The decision process FRR BGP uses to select routes is as follows: .. index:: bgp bestpath as-path confed -``bgp bestpath as-path confed`` +.. clicmd:: bgp bestpath as-path confed This command specifies that the length of confederation path sets and sequences should should be taken into account during the BGP best path @@ -188,7 +188,7 @@ The decision process FRR BGP uses to select routes is as follows: .. index:: bgp bestpath as-path multipath-relax -``bgp bestpath as-path multipath-relax`` +.. clicmd:: bgp bestpath as-path multipath-relax .. _bgp_bestpath_as-path_multipath-relax: @@ -198,7 +198,7 @@ The decision process FRR BGP uses to select routes is as follows: .. index:: bgp bestpath compare-routerid -``bgp bestpath compare-routerid`` +.. clicmd:: bgp bestpath compare-routerid .. _bgp_bestpath_compare-routerid: @@ -226,9 +226,9 @@ The decision process FRR BGP uses to select routes is as follows: BGP route flap dampening ------------------------ -.. index:: bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>` +.. index:: bgp dampening `(1-45)` `(1-20000)` `(1-20000)` `(1-255)` -``bgp dampening `<1-45>` `<1-20000>` `<1-20000>` `<1-255>``` +.. clicmd:: bgp dampening `(1-45)` `(1-20000)` `(1-20000)` `(1-255)` This command enables BGP route-flap dampening and specifies dampening parameters. @@ -476,7 +476,7 @@ iBGP topology should follow the IGP topology. .. index:: bgp deterministic-med -``bgp deterministic-med`` +.. clicmd:: bgp deterministic-med .. _bgp_deterministic-med: @@ -499,7 +499,7 @@ from eBGP peers, :ref:`BGP_decision_process`. .. index:: bgp always-compare-med -``bgp always-compare-med`` +.. clicmd:: bgp always-compare-med .. _bgp_always-compare-med: @@ -527,7 +527,7 @@ BGP route .. index:: network `A.B.C.D/M` -``network `A.B.C.D/M``` +.. clicmd:: network `A.B.C.D/M` This command adds the announcement network.:: @@ -543,7 +543,7 @@ BGP route .. index:: no network `A.B.C.D/M` -``no network `A.B.C.D/M``` +.. clicmd:: no network `A.B.C.D/M` .. _Route_Aggregation: @@ -553,27 +553,27 @@ Route Aggregation .. index:: aggregate-address `A.B.C.D/M` -``aggregate-address `A.B.C.D/M``` +.. clicmd:: aggregate-address `A.B.C.D/M` This command specifies an aggregate address. .. index:: aggregate-address `A.B.C.D/M` as-set -``aggregate-address `A.B.C.D/M` as-set`` +.. clicmd:: aggregate-address `A.B.C.D/M` as-set This command specifies an aggregate address. Resulting routes include AS set. .. index:: aggregate-address `A.B.C.D/M` summary-only -``aggregate-address `A.B.C.D/M` summary-only`` +.. clicmd:: aggregate-address `A.B.C.D/M` summary-only This command specifies an aggregate address. Aggreated routes will not be announce. .. index:: no aggregate-address `A.B.C.D/M` -``no aggregate-address `A.B.C.D/M``` +.. clicmd:: no aggregate-address `A.B.C.D/M` .. _Redistribute_to_BGP: @@ -583,47 +583,47 @@ Redistribute to BGP .. index:: redistribute kernel -``redistribute kernel`` +.. clicmd:: redistribute kernel Redistribute kernel route to BGP process. .. index:: redistribute static -``redistribute static`` +.. clicmd:: redistribute static Redistribute static route to BGP process. .. index:: redistribute connected -``redistribute connected`` +.. clicmd:: redistribute connected Redistribute connected route to BGP process. .. index:: redistribute rip -``redistribute rip`` +.. clicmd:: redistribute rip Redistribute RIP route to BGP process. .. index:: redistribute ospf -``redistribute ospf`` +.. clicmd:: redistribute ospf Redistribute OSPF route to BGP process. .. index:: redistribute vpn -``redistribute vpn`` +.. clicmd:: redistribute vpn Redistribute VNC routes to BGP process. .. index:: update-delay `max-delay` -``update-delay `max-delay``` +.. clicmd:: update-delay `max-delay` .. index:: update-delay `max-delay` `establish-wait` -``update-delay `max-delay` `establish-wait``` +.. clicmd:: update-delay `max-delay` `establish-wait` This feature is used to enable read-only mode on BGP process restart or when BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only mode @@ -648,7 +648,7 @@ Redistribute to BGP .. index:: table-map `route-map-name` -``table-map `route-map-name``` +.. clicmd:: table-map `route-map-name` This feature is used to apply a route-map on route updates from BGP to Zebra. All the applicable match operations are allowed, such as match on prefix, @@ -672,7 +672,7 @@ Defining Peer .. index:: neighbor `peer` remote-as `asn` -``neighbor `peer` remote-as `asn``` +.. clicmd:: neighbor `peer` remote-as `asn` Creates a new neighbor whose remote-as is `asn`. `peer` can be an IPv4 address or an IPv6 address.:: @@ -699,11 +699,11 @@ required. .. index:: neighbor `peer` shutdown -``neighbor `peer` shutdown`` +.. clicmd:: neighbor `peer` shutdown .. index:: no neighbor `peer` shutdown -``no neighbor `peer` shutdown`` +.. clicmd:: no neighbor `peer` shutdown Shutdown the peer. We can delete the neighbor's configuration by `no neighbor `peer` remote-as @var{as-number`} but all @@ -713,25 +713,25 @@ required. .. index:: neighbor `peer` ebgp-multihop -``neighbor `peer` ebgp-multihop`` +.. clicmd:: neighbor `peer` ebgp-multihop .. index:: no neighbor `peer` ebgp-multihop -``no neighbor `peer` ebgp-multihop`` +.. clicmd:: no neighbor `peer` ebgp-multihop .. index:: neighbor `peer` description ... -``neighbor `peer` description ...`` +.. clicmd:: neighbor `peer` description ... .. index:: no neighbor `peer` description ... -``no neighbor `peer` description ...`` +.. clicmd:: no neighbor `peer` description ... Set description of the peer. .. index:: neighbor `peer` version `version` -``neighbor `peer` version `version``` +.. clicmd:: neighbor `peer` version `version` Set up the neighbor's BGP version. `version` can be `4`, `4+` or `4-`. BGP version `4` is the default value used for @@ -743,11 +743,11 @@ required. .. index:: neighbor `peer` interface `ifname` -``neighbor `peer` interface `ifname``` +.. clicmd:: neighbor `peer` interface `ifname` .. index:: no neighbor `peer` interface `ifname` -``no neighbor `peer` interface `ifname``` +.. clicmd:: no neighbor `peer` interface `ifname` When you connect to a BGP peer over an IPv6 link-local address, you have to specify the `ifname` of the interface used for the @@ -759,11 +759,11 @@ required. .. index:: neighbor `peer` next-hop-self [all] -``neighbor `peer` next-hop-self [all]`` +.. clicmd:: neighbor `peer` next-hop-self [all] .. index:: no neighbor `peer` next-hop-self [all] -``no neighbor `peer` next-hop-self [all]`` +.. clicmd:: no neighbor `peer` next-hop-self [all] This command specifies an announced route's nexthop as being equivalent to the address of the bgp router if it is learned via eBGP. @@ -772,11 +772,11 @@ required. .. index:: neighbor `peer` update-source `` -``neighbor `peer` update-source ```` +.. clicmd:: neighbor `peer` update-source `` .. index:: no neighbor `peer` update-source -``no neighbor `peer` update-source`` +.. clicmd:: no neighbor `peer` update-source Specify the IPv4 source address to use for the :abbr:`BGP` session to this neighbour, may be specified as either an IPv4 address directly or @@ -790,11 +790,11 @@ required. .. index:: neighbor `peer` default-originate -``neighbor `peer` default-originate`` +.. clicmd:: neighbor `peer` default-originate .. index:: no neighbor `peer` default-originate -``no neighbor `peer` default-originate`` +.. clicmd:: no neighbor `peer` default-originate *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it is in routing table. When you want to announce default routes to the @@ -802,54 +802,54 @@ required. .. index:: neighbor `peer` port `port` -``neighbor `peer` port `port``` +.. clicmd:: neighbor `peer` port `port` .. index:: neighbor `peer` port `port` -``neighbor `peer` port `port``` +.. clicmd:: neighbor `peer` port `port` .. index:: neighbor `peer` send-community -``neighbor `peer` send-community`` +.. clicmd:: neighbor `peer` send-community .. index:: neighbor `peer` send-community -``neighbor `peer` send-community`` +.. clicmd:: neighbor `peer` send-community .. index:: neighbor `peer` weight `weight` -``neighbor `peer` weight `weight``` +.. clicmd:: neighbor `peer` weight `weight` .. index:: no neighbor `peer` weight `weight` -``no neighbor `peer` weight `weight``` +.. clicmd:: no neighbor `peer` weight `weight` This command specifies a default `weight` value for the neighbor's routes. .. index:: neighbor `peer` maximum-prefix `number` -``neighbor `peer` maximum-prefix `number``` +.. clicmd:: neighbor `peer` maximum-prefix `number` .. index:: no neighbor `peer` maximum-prefix `number` -``no neighbor `peer` maximum-prefix `number``` +.. clicmd:: no neighbor `peer` maximum-prefix `number` .. index:: neighbor `peer` local-as `as-number` -``neighbor `peer` local-as `as-number``` +.. clicmd:: neighbor `peer` local-as `as-number` .. index:: neighbor `peer` local-as `as-number` no-prepend -``neighbor `peer` local-as `as-number` no-prepend`` +.. clicmd:: neighbor `peer` local-as `as-number` no-prepend .. index:: neighbor `peer` local-as `as-number` no-prepend replace-as -``neighbor `peer` local-as `as-number` no-prepend replace-as`` +.. clicmd:: neighbor `peer` local-as `as-number` no-prepend replace-as .. index:: no neighbor `peer` local-as -``no neighbor `peer` local-as`` +.. clicmd:: no neighbor `peer` local-as Specify an alternate AS for this BGP process when interacting with the specified peer. With no modifiers, the specified local-as is prepended to @@ -869,11 +869,11 @@ required. .. index:: neighbor `peer` ttl-security hops `number` -``neighbor `peer` ttl-security hops `number``` +.. clicmd:: neighbor `peer` ttl-security hops `number` .. index:: no neighbor `peer` ttl-security hops `number` -``no neighbor `peer` ttl-security hops `number``` +.. clicmd:: no neighbor `peer` ttl-security hops `number` This command enforces Generalized TTL Security Mechanism (GTSM), as specified in RFC 5082. With this command, only neighbors that are the @@ -887,27 +887,27 @@ Peer filtering .. index:: neighbor `peer` distribute-list `name` [in|out] -``neighbor `peer` distribute-list `name` [in|out]`` +.. clicmd:: neighbor `peer` distribute-list `name` [in|out] This command specifies a distribute-list for the peer. `direct` is ``in`` or ``out``. .. index:: neighbor PEER prefix-list NAME [in|out] -``neighbor PEER prefix-list NAME [in|out]`` +.. clicmd:: neighbor PEER prefix-list NAME [in|out] .. index:: neighbor PEER filter-list NAME [in|out] -``neighbor PEER filter-list NAME [in|out]`` +.. clicmd:: neighbor PEER filter-list NAME [in|out] .. index:: neighbor `peer` route-map `name` [in|out] -``neighbor `peer` route-map `name` [in|out]`` +.. clicmd:: neighbor `peer` route-map `name` [in|out] Apply a route-map on the neighbor. `direct` must be `in` or `out`. .. index:: bgp route-reflector allow-outbound-policy -``bgp route-reflector allow-outbound-policy`` +.. clicmd:: bgp route-reflector allow-outbound-policy By default, attribute modification via route-map policy out is not reflected on reflected routes. This option allows the modifications to be reflected as @@ -920,13 +920,13 @@ BGP Peer Group .. index:: neighbor `word` peer-group -``neighbor `word` peer-group`` +.. clicmd:: neighbor `word` peer-group This command defines a new peer group. .. index:: neighbor `peer` peer-group `word` -``neighbor `peer` peer-group `word``` +.. clicmd:: neighbor `peer` peer-group `word` This command bind specific peer to peer group `word`. @@ -945,32 +945,32 @@ Identifiers (SAFI). In addition to unicast information, VPN information .. index:: show ip bgp vpnv4 all -``show ip bgp vpnv4 all`` +.. clicmd:: show ip bgp vpnv4 all .. index:: show ipv6 bgp vpn all -``show ipv6 bgp vpn all`` +.. clicmd:: show ipv6 bgp vpn all Print active IPV4 or IPV6 routes advertised via the VPN SAFI. .. index:: show ip bgp encap all -``show ip bgp encap all`` +.. clicmd:: show ip bgp encap all .. index:: show ipv6 bgp encap all -``show ipv6 bgp encap all`` +.. clicmd:: show ipv6 bgp encap all Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI. .. index:: show bgp ipv4 encap summary -``show bgp ipv4 encap summary`` +.. clicmd:: show bgp ipv4 encap summary .. index:: show bgp ipv4 vpn summary -``show bgp ipv4 vpn summary`` +.. clicmd:: show bgp ipv4 vpn summary .. index:: show bgp ipv6 encap summary -``show bgp ipv6 encap summary`` +.. clicmd:: show bgp ipv6 encap summary .. index:: show bgp ipv6 vpn summary -``show bgp ipv6 vpn summary`` +.. clicmd:: show bgp ipv6 vpn summary Print a summary of neighbor connections for the specified AFI/SAFI combination. .. _Autonomous_System: @@ -998,7 +998,7 @@ To show BGP routes which has specific AS path information `show ip bgp` command .. index:: show bgp ipv4|ipv6 regexp LINE -``show bgp ipv4|ipv6 regexp LINE`` +.. clicmd:: show bgp ipv4|ipv6 regexp LINE This commands displays BGP routes that matches a regular expression `line` (:ref:`BGP_Regular_Expressions`). @@ -1011,15 +1011,15 @@ AS path access list is user defined AS path. .. index:: ip as-path access-list WORD permit|deny LINE -``ip as-path access-list WORD permit|deny LINE`` +.. clicmd:: ip as-path access-list WORD permit|deny LINE This command defines a new AS path access list. .. index:: no ip as-path access-list WORD -``no ip as-path access-list WORD`` +.. clicmd:: no ip as-path access-list WORD .. index:: no ip as-path access-list WORD permit|deny LINE -``no ip as-path access-list WORD permit|deny LINE`` +.. clicmd:: no ip as-path access-list WORD permit|deny LINE .. _Using_AS_Path_in_Route_Map: @@ -1028,16 +1028,16 @@ Using AS Path in Route Map .. index:: match as-path WORD -``match as-path WORD`` +.. clicmd:: match as-path WORD .. index:: set as-path prepend AS-PATH -``set as-path prepend AS-PATH`` +.. clicmd:: set as-path prepend AS-PATH Prepend the given string of AS numbers to the AS_PATH. .. index:: set as-path prepend last-as NUM -``set as-path prepend last-as NUM`` +.. clicmd:: set as-path prepend last-as NUM Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. .. _Private_AS_Numbers: @@ -1118,7 +1118,7 @@ expanded community list. .. index:: ip community-list standard NAME permit|deny COMMUNITY -``ip community-list standard NAME permit|deny COMMUNITY`` +.. clicmd:: ip community-list standard NAME permit|deny COMMUNITY This command defines a new standard community list. `community` is communities value. The `community` is compiled into community structure. We can define multiple community list under same name. In @@ -1130,7 +1130,7 @@ expanded community list. .. index:: ip community-list expanded NAME permit|deny LINE -``ip community-list expanded NAME permit|deny LINE`` +.. clicmd:: ip community-list expanded NAME permit|deny LINE This command defines a new expanded community list. `line` is a string expression of communities attribute. `line` can be a regular expression (:ref:`BGP_Regular_Expressions`) to match @@ -1138,23 +1138,23 @@ expanded community list. .. index:: no ip community-list NAME -``no ip community-list NAME`` +.. clicmd:: no ip community-list NAME .. index:: no ip community-list standard NAME -``no ip community-list standard NAME`` +.. clicmd:: no ip community-list standard NAME .. index:: no ip community-list expanded NAME -``no ip community-list expanded NAME`` +.. clicmd:: no ip community-list expanded NAME These commands delete community lists specified by `name`. All of community lists shares a single name space. So community lists can be removed simpley specifying community lists name. .. index:: show ip community-list -``show ip community-list`` +.. clicmd:: show ip community-list .. index:: show ip community-list NAME -``show ip community-list NAME`` +.. clicmd:: show ip community-list NAME This command displays current community list information. When `name` is specified the specified community list's information is shown. @@ -1186,24 +1186,24 @@ to 199 is expanded community list. These community lists are called as numbered community lists. On the other hand normal community lists is called as named community lists. -.. index:: ip community-list <1-99> permit|deny COMMUNITY +.. index:: ip community-list (1-99) permit|deny COMMUNITY -``ip community-list <1-99> permit|deny COMMUNITY`` - This command defines a new community list. <1-99> is standard +.. clicmd:: ip community-list (1-99) permit|deny COMMUNITY + This command defines a new community list. (1-99) is standard community list number. Community list name within this range defines standard community list. When `community` is empty it matches to any routes. -.. index:: ip community-list <100-199> permit|deny COMMUNITY +.. index:: ip community-list (100-199) permit|deny COMMUNITY -``ip community-list <100-199> permit|deny COMMUNITY`` - This command defines a new community list. <100-199> is expanded +.. clicmd:: ip community-list (100-199) permit|deny COMMUNITY + This command defines a new community list. (100-199) is expanded community list number. Community list name within this range defines expanded community list. .. index:: ip community-list NAME permit|deny COMMUNITY -``ip community-list NAME permit|deny COMMUNITY`` +.. clicmd:: ip community-list NAME permit|deny COMMUNITY When community list type is not specifed, the community list type is automatically detected. If `community` can be compiled into communities attribute, the community list is defined as a standard @@ -1224,10 +1224,10 @@ Following commands can be used in Route Map. .. index:: match community WORD -``match community WORD`` +.. clicmd:: match community WORD .. index:: match community WORD exact-match -``match community WORD exact-match`` +.. clicmd:: match community WORD exact-match This command perform match to BGP updates using community list `word`. When the one of BGP communities value match to the one of communities value in community list, it is match. When @@ -1237,13 +1237,13 @@ Following commands can be used in Route Map. .. index:: set community none -``set community none`` +.. clicmd:: set community none .. index:: set community COMMUNITY -``set community COMMUNITY`` +.. clicmd:: set community COMMUNITY .. index:: set community COMMUNITY additive -``set community COMMUNITY additive`` +.. clicmd:: set community COMMUNITY additive This command manipulate communities value in BGP updates. When `none` is specified as communities value, it removes entire communities attribute from BGP updates. When `community` is not @@ -1255,7 +1255,7 @@ Following commands can be used in Route Map. .. index:: set comm-list WORD delete -``set comm-list WORD delete`` +.. clicmd:: set comm-list WORD delete This command remove communities value from BGP communities attribute. The `word` is community list name. When BGP route's communities value matches to the community list `word`, the communities value @@ -1273,13 +1273,13 @@ To show BGP routes which has specific BGP communities attribute, .. index:: show bgp ipv4|ipv6 community -``show bgp ipv4|ipv6 community`` +.. clicmd:: show bgp ipv4|ipv6 community .. index:: show bgp ipv4|ipv6 community COMMUNITY -``show bgp ipv4|ipv6 community COMMUNITY`` +.. clicmd:: show bgp ipv4|ipv6 community COMMUNITY .. index:: show bgp ipv4|ipv6 community COMMUNITY exact-match -``show bgp ipv4|ipv6 community COMMUNITY exact-match`` +.. clicmd:: show bgp ipv4|ipv6 community COMMUNITY exact-match `show bgp {ipv4|ipv6} community` displays BGP routes which has communities attribute. Where the address family can be IPv4 or IPv6 among others. When `community` is specified, BGP routes that matches `community` value is @@ -1289,10 +1289,10 @@ To show BGP routes which has specific BGP communities attribute, .. index:: show bgp ipv4|ipv6 community-list WORD -``show bgp ipv4|ipv6 community-list WORD`` +.. clicmd:: show bgp ipv4|ipv6 community-list WORD .. index:: show bgp ipv4|ipv6 community-list WORD exact-match -``show bgp ipv4|ipv6 community-list WORD exact-match`` +.. clicmd:: show bgp ipv4|ipv6 community-list WORD exact-match This commands display BGP routes for the address family specified that matches community list `word`. When `exact-match` is specified, display only routes that have an exact match. @@ -1475,7 +1475,7 @@ Lists. .. index:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY -``ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY`` +.. clicmd:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY This command defines a new standard extcommunity-list. `extcommunity` is extended communities value. The `extcommunity` is compiled into extended community structure. We @@ -1488,7 +1488,7 @@ Lists. .. index:: ip extcommunity-list expanded NAME permit|deny LINE -``ip extcommunity-list expanded NAME permit|deny LINE`` +.. clicmd:: ip extcommunity-list expanded NAME permit|deny LINE This command defines a new expanded extcommunity-list. `line` is a string expression of extended communities attribute. `line` can be a regular expression (:ref:`BGP_Regular_Expressions`) to match an @@ -1496,13 +1496,13 @@ Lists. .. index:: no ip extcommunity-list NAME -``no ip extcommunity-list NAME`` +.. clicmd:: no ip extcommunity-list NAME .. index:: no ip extcommunity-list standard NAME -``no ip extcommunity-list standard NAME`` +.. clicmd:: no ip extcommunity-list standard NAME .. index:: no ip extcommunity-list expanded NAME -``no ip extcommunity-list expanded NAME`` +.. clicmd:: no ip extcommunity-list expanded NAME These commands delete extended community lists specified by `name`. All of extended community lists shares a single name space. So extended community lists can be removed simpley specifying @@ -1510,10 +1510,10 @@ Lists. .. index:: show ip extcommunity-list -``show ip extcommunity-list`` +.. clicmd:: show ip extcommunity-list .. index:: show ip extcommunity-list NAME -``show ip extcommunity-list NAME`` +.. clicmd:: show ip extcommunity-list NAME This command displays current extcommunity-list information. When `name` is specified the community list's information is shown. @@ -1529,16 +1529,16 @@ BGP Extended Communities in Route Map .. index:: match extcommunity WORD -``match extcommunity WORD`` +.. clicmd:: match extcommunity WORD .. index:: set extcommunity rt EXTCOMMUNITY -``set extcommunity rt EXTCOMMUNITY`` +.. clicmd:: set extcommunity rt EXTCOMMUNITY This command set Route Target value. .. index:: set extcommunity soo EXTCOMMUNITY -``set extcommunity soo EXTCOMMUNITY`` +.. clicmd:: set extcommunity soo EXTCOMMUNITY This command set Site of Origin value. .. _BGP_Large_Communities_Attribute: @@ -1581,7 +1581,7 @@ Two types of large community lists are supported, namely `standard` and .. index:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY -``ip large-community-list standard NAME permit|deny LARGE-COMMUNITY`` +.. clicmd:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY This command defines a new standard large-community-list. `large-community` is the Large Community value. We can add multiple large communities under same name. In that case @@ -1593,7 +1593,7 @@ Two types of large community lists are supported, namely `standard` and .. index:: ip large-community-list expanded NAME permit|deny LINE -``ip large-community-list expanded NAME permit|deny LINE`` +.. clicmd:: ip large-community-list expanded NAME permit|deny LINE This command defines a new expanded large-community-list. Where `line` is a string matching expression, it will be compared to the entire Large Communities attribute as a string, with each large-community in order from lowest to highest. @@ -1602,29 +1602,29 @@ Two types of large community lists are supported, namely `standard` and .. index:: no ip large-community-list NAME -``no ip large-community-list NAME`` +.. clicmd:: no ip large-community-list NAME .. index:: no ip large-community-list standard NAME -``no ip large-community-list standard NAME`` +.. clicmd:: no ip large-community-list standard NAME .. index:: no ip large-community-list expanded NAME -``no ip large-community-list expanded NAME`` +.. clicmd:: no ip large-community-list expanded NAME These commands delete Large Community lists specified by `name`. All Large Community lists share a single namespace. This means Large Community lists can be removed by simply specifying the name. .. index:: show ip large-community-list -``show ip large-community-list`` +.. clicmd:: show ip large-community-list .. index:: show ip large-community-list NAME -``show ip large-community-list NAME`` +.. clicmd:: show ip large-community-list NAME This command display current large-community-list information. When `name` is specified the community list information is shown. .. index:: show ip bgp large-community-info -``show ip bgp large-community-info`` +.. clicmd:: show ip bgp large-community-info This command displays the current large communities in use. .. _BGP_Large_Communities_in_Route_Map: @@ -1634,7 +1634,7 @@ BGP Large Communities in Route Map .. index:: match large-community LINE -``match large-community LINE`` +.. clicmd:: match large-community LINE Where `line` can be a simple string to match, or a regular expression. It is very important to note that this match occurs on the entire large-community string as a whole, where each large-community is ordered @@ -1642,13 +1642,13 @@ BGP Large Communities in Route Map .. index:: set large-community LARGE-COMMUNITY -``set large-community LARGE-COMMUNITY`` +.. clicmd:: set large-community LARGE-COMMUNITY .. index:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY -``set large-community LARGE-COMMUNITY LARGE-COMMUNITY`` +.. clicmd:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY .. index:: set large-community LARGE-COMMUNITY additive -``set large-community LARGE-COMMUNITY additive`` +.. clicmd:: set large-community LARGE-COMMUNITY additive These commands are used for setting large-community values. The first command will overwrite any large-communities currently present. The second specifies two large-communities, which overwrites the current @@ -1668,13 +1668,13 @@ Showing BGP information .. index:: show ip bgp -``show ip bgp`` +.. clicmd:: show ip bgp .. index:: show ip bgp A.B.C.D -``show ip bgp A.B.C.D`` +.. clicmd:: show ip bgp A.B.C.D .. index:: show ip bgp X:X::X:X -``show ip bgp X:X::X:X`` +.. clicmd:: show ip bgp X:X::X:X This command displays BGP routes. When no route is specified it display all of IPv4 BGP routes. @@ -1692,44 +1692,44 @@ Showing BGP information .. index:: show ip bgp regexp LINE -``show ip bgp regexp LINE`` +.. clicmd:: show ip bgp regexp LINE This command displays BGP routes using AS path regular expression (:ref:`BGP_Regular_Expressions`). .. index:: show ip bgp community COMMUNITY -``show ip bgp community COMMUNITY`` +.. clicmd:: show ip bgp community COMMUNITY .. index:: show ip bgp community COMMUNITY exact-match -``show ip bgp community COMMUNITY exact-match`` +.. clicmd:: show ip bgp community COMMUNITY exact-match This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). .. index:: show ip bgp community-list WORD -``show ip bgp community-list WORD`` +.. clicmd:: show ip bgp community-list WORD .. index:: show ip bgp community-list WORD exact-match -``show ip bgp community-list WORD exact-match`` +.. clicmd:: show ip bgp community-list WORD exact-match This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). .. index:: show bgp ipv4|ipv6 summary -``show bgp ipv4|ipv6 summary`` +.. clicmd:: show bgp ipv4|ipv6 summary Show a bgp peer summary for the specified address family. .. index:: show bgp ipv4|ipv6 neighbor [PEER] -``show bgp ipv4|ipv6 neighbor [PEER]`` +.. clicmd:: show bgp ipv4|ipv6 neighbor [PEER] This command shows information on a specific BGP `peer`. .. index:: show bgp ipv4|ipv6 dampening dampened-paths -``show bgp ipv4|ipv6 dampening dampened-paths`` +.. clicmd:: show bgp ipv4|ipv6 dampening dampened-paths Display paths suppressed due to dampening. .. index:: show bgp ipv4|ipv6 dampening flap-statistics -``show bgp ipv4|ipv6 dampening flap-statistics`` +.. clicmd:: show bgp ipv4|ipv6 dampening flap-statistics Display flap statistics of routes. .. _Other_BGP_commands: @@ -1739,40 +1739,40 @@ Other BGP commands .. index:: clear bgp ipv4|ipv6 \* -``clear bgp ipv4|ipv6 \*`` +.. clicmd:: clear bgp ipv4|ipv6 \* Clear all address family peers. .. index:: clear bgp ipv4|ipv6 PEER -``clear bgp ipv4|ipv6 PEER`` +.. clicmd:: clear bgp ipv4|ipv6 PEER Clear peers which have addresses of X.X.X.X .. index:: clear bgp ipv4|ipv6 PEER soft in -``clear bgp ipv4|ipv6 PEER soft in`` +.. clicmd:: clear bgp ipv4|ipv6 PEER soft in Clear peer using soft reconfiguration. .. index:: show debug -``show debug`` +.. clicmd:: show debug .. index:: debug event -``debug event`` +.. clicmd:: debug event .. index:: debug update -``debug update`` +.. clicmd:: debug update .. index:: debug keepalive -``debug keepalive`` +.. clicmd:: debug keepalive .. index:: no debug event -``no debug event`` +.. clicmd:: no debug event .. index:: no debug update -``no debug update`` +.. clicmd:: no debug update .. index:: no debug keepalive -``no debug keepalive`` +.. clicmd:: no debug keepalive .. _Capability_Negotiation: @@ -1815,11 +1815,11 @@ use *strict-capability-match* command. .. index:: neighbor `peer` strict-capability-match -``neighbor `peer` strict-capability-match`` +.. clicmd:: neighbor `peer` strict-capability-match .. index:: no neighbor `peer` strict-capability-match -``no neighbor `peer` strict-capability-match`` +.. clicmd:: no neighbor `peer` strict-capability-match Strictly compares remote capabilities and local capabilities. If capabilities are different, send Unsupported Capability error then reset connection. @@ -1831,11 +1831,11 @@ use *strict-capability-match* command. .. index:: neighbor `peer` dont-capability-negotiate -``neighbor `peer` dont-capability-negotiate`` +.. clicmd:: neighbor `peer` dont-capability-negotiate .. index:: no neighbor `peer` dont-capability-negotiate -``no neighbor `peer` dont-capability-negotiate`` +.. clicmd:: no neighbor `peer` dont-capability-negotiate Suppress sending Capability Negotiation as OPEN message optional parameter to the peer. This command only affects the peer is configured @@ -1853,11 +1853,11 @@ use *strict-capability-match* command. .. index:: neighbor `peer` override-capability -``neighbor `peer` override-capability`` +.. clicmd:: neighbor `peer` override-capability .. index:: no neighbor `peer` override-capability -``no neighbor `peer` override-capability`` +.. clicmd:: no neighbor `peer` override-capability Override the result of Capability Negotiation with local configuration. Ignore remote peer's capability value. @@ -1869,16 +1869,16 @@ Route Reflector .. index:: bgp cluster-id `a.b.c.d` -``bgp cluster-id `a.b.c.d``` +.. clicmd:: bgp cluster-id `a.b.c.d` .. index:: neighbor `peer` route-reflector-client -``neighbor `peer` route-reflector-client`` +.. clicmd:: neighbor `peer` route-reflector-client .. index:: no neighbor `peer` route-reflector-client -``no neighbor `peer` route-reflector-client`` +.. clicmd:: no neighbor `peer` route-reflector-client .. _Route_Server: @@ -1888,7 +1888,7 @@ Route Server At an Internet Exchange point, many ISPs are connected to each other by external BGP peering. Normally these external BGP connection are done by -``full mesh`` method. As with internal BGP full mesh formation, +.. clicmd:: full mesh method. As with internal BGP full mesh formation, this method has a scaling problem. This scaling problem is well known. Route Server is a method to resolve @@ -1912,13 +1912,13 @@ multiple instance feature beforehand. .. index:: bgp multiple-instance -``bgp multiple-instance`` +.. clicmd:: bgp multiple-instance Enable BGP multiple instance feature. After this feature is enabled, you can make multiple BGP instances or multiple BGP views. .. index:: no bgp multiple-instance -``no bgp multiple-instance`` +.. clicmd:: no bgp multiple-instance Disable BGP multiple instance feature. You can not disable this feature when BGP multiple instances or views exist. @@ -1926,7 +1926,7 @@ When you want to make configuration more Cisco like one, .. index:: bgp config-type cisco -``bgp config-type cisco`` +.. clicmd:: bgp config-type cisco Cisco compatible BGP configuration output. When bgp config-type cisco is specified, @@ -1970,7 +1970,7 @@ to specify *neighbor A.B.C.D send-community* command. .. index:: bgp config-type zebra -``bgp config-type zebra`` +.. clicmd:: bgp config-type zebra FRR style BGP configuration. This is default. .. _BGP_instance_and_view: @@ -1984,7 +1984,7 @@ same time when BGP multiple instance feature is enabled. .. index:: router bgp AS-NUMBER -``router bgp AS-NUMBER`` +.. clicmd:: router bgp AS-NUMBER Make a new BGP instance. You can use arbitrary word for the `name`. :: @@ -2006,7 +2006,7 @@ only for exchanging BGP routing information. .. index:: router bgp AS-NUMBER view NAME -``router bgp AS-NUMBER view NAME`` +.. clicmd:: router bgp AS-NUMBER view NAME Make a new BGP view. You can use arbitrary word for the `name`. This view's route selection result does not go to the kernel routing table. @@ -2064,7 +2064,7 @@ To display routing table of BGP view, you must specify view name. .. index:: show ip bgp view NAME -``show ip bgp view NAME`` +.. clicmd:: show ip bgp view NAME Display routing table of BGP view `name`. .. _BGP_Regular_Expressions: @@ -2161,13 +2161,13 @@ Dump BGP packets and table .. index:: dump bgp all PATH [INTERVAL] -``dump bgp all PATH [INTERVAL]`` +.. clicmd:: dump bgp all PATH [INTERVAL] .. index:: dump bgp all-et PATH [INTERVAL] -``dump bgp all-et PATH [INTERVAL]`` +.. clicmd:: dump bgp all-et PATH [INTERVAL] .. index:: no dump bgp all [PATH] [INTERVAL] -``no dump bgp all [PATH] [INTERVAL]`` +.. clicmd:: no dump bgp all [PATH] [INTERVAL] Dump all BGP packet and events to `path` file. If `interval` is set, a new file will be created for echo `interval` of seconds. The path `path` can be set with date and time formatting (strftime). @@ -2176,13 +2176,13 @@ Dump BGP packets and table .. index:: dump bgp updates PATH [INTERVAL] -``dump bgp updates PATH [INTERVAL]`` +.. clicmd:: dump bgp updates PATH [INTERVAL] .. index:: dump bgp updates-et PATH [INTERVAL] -``dump bgp updates-et PATH [INTERVAL]`` +.. clicmd:: dump bgp updates-et PATH [INTERVAL] .. index:: no dump bgp updates [PATH] [INTERVAL] -``no dump bgp updates [PATH] [INTERVAL]`` +.. clicmd:: no dump bgp updates [PATH] [INTERVAL] Dump only BGP updates messages to `path` file. If `interval` is set, a new file will be created for echo `interval` of seconds. The path `path` can be set with date and time formatting (strftime). @@ -2190,13 +2190,13 @@ Dump BGP packets and table .. index:: dump bgp routes-mrt PATH -``dump bgp routes-mrt PATH`` +.. clicmd:: dump bgp routes-mrt PATH .. index:: dump bgp routes-mrt PATH INTERVAL -``dump bgp routes-mrt PATH INTERVAL`` +.. clicmd:: dump bgp routes-mrt PATH INTERVAL .. index:: no dump bgp route-mrt [PATH] [INTERVAL] -``no dump bgp route-mrt [PATH] [INTERVAL]`` +.. clicmd:: no dump bgp route-mrt [PATH] [INTERVAL] Dump whole BGP routing table to `path`. This is heavy process. The path `path` can be set with date and time formatting (strftime). If `interval` is set, a new file will be created for echo `interval` of seconds. diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index 44af4a263d..0af627e1d7 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -66,22 +66,22 @@ EIGRP Configuration .. index:: router eigrp (1-65535) -``router eigrp (1-65535)`` +.. clicmd:: router eigrp (1-65535) The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP, use the `no router eigrp (1-65535)` command. EIGRP must be enabled before carrying out any of the EIGRP commands. .. index:: no router eigrp (1-65535) -``no router eigrp (1-65535)`` +.. clicmd:: no router eigrp (1-65535) Disable EIGRP. .. index:: network NETWORK -``network NETWORK`` +.. clicmd:: network NETWORK .. index:: no network NETWORK -``no network NETWORK`` +.. clicmd:: no network NETWORK Set the EIGRP enable interface by `network`. The interfaces which have addresses matching with `network` are enabled. @@ -106,10 +106,10 @@ EIGRP Configuration .. index:: passive-interface (IFNAME|default) -``passive-interface (IFNAME|default)`` +.. clicmd:: passive-interface (IFNAME|default) .. index:: no passive-interface IFNAME -``no passive-interface IFNAME`` +.. clicmd:: no passive-interface IFNAME This command sets the specified interface to passive mode. On passive mode interface, all receiving packets are ignored and eigrpd does not send either multicast or unicast EIGRP packets except to EIGRP neighbors @@ -125,39 +125,39 @@ How to Announce EIGRP route .. index:: redistribute kernel -``redistribute kernel`` +.. clicmd:: redistribute kernel .. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -``redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. clicmd:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) .. index:: no redistribute kernel -``no redistribute kernel`` +.. clicmd:: no redistribute kernel `redistribute kernel` redistributes routing information from kernel route entries into the EIGRP tables. `no redistribute kernel` disables the routes. .. index:: redistribute static -``redistribute static`` +.. clicmd:: redistribute static .. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -``redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. clicmd:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) .. index:: no redistribute static -``no redistribute static`` +.. clicmd:: no redistribute static `redistribute static` redistributes routing information from static route entries into the EIGRP tables. `no redistribute static` disables the routes. .. index:: redistribute connected -``redistribute connected`` +.. clicmd:: redistribute connected .. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -``redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. clicmd:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) .. index:: no redistribute connected -``no redistribute connected`` +.. clicmd:: no redistribute connected Redistribute connected routes into the EIGRP tables. `no redistribute connected` disables the connected routes in the EIGRP tables. This command redistribute connected of the interface which EIGRP disabled. The connected @@ -165,26 +165,26 @@ How to Announce EIGRP route .. index:: redistribute ospf -``redistribute ospf`` +.. clicmd:: redistribute ospf .. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -``redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. clicmd:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) .. index:: no redistribute ospf -``no redistribute ospf`` +.. clicmd:: no redistribute ospf `redistribute ospf` redistributes routing information from ospf route entries into the EIGRP tables. `no redistribute ospf` disables the routes. .. index:: redistribute bgp -``redistribute bgp`` +.. clicmd:: redistribute bgp .. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -``redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)`` +.. clicmd:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) .. index:: no redistribute bgp -``no redistribute bgp`` +.. clicmd:: no redistribute bgp `redistribute bgp` redistributes routing information from bgp route entries into the EIGRP tables. `no redistribute bgp` disables the routes. @@ -198,14 +198,14 @@ To display EIGRP routes. .. index:: show ip eigrp topology -``show ip eigrp topology`` +.. clicmd:: show ip eigrp topology Show EIGRP routes. The command displays all EIGRP routes. .. index:: show ip eigrp topology -``show ip eigrp topology`` +.. clicmd:: show ip eigrp topology The command displays current EIGRP status :: @@ -229,21 +229,21 @@ Debug for EIGRP protocol. .. index:: debug eigrp packets -``debug eigrp packets`` +.. clicmd:: debug eigrp packets Debug eigrp packets `debug eigrp` will show EIGRP packets that are sent and recevied. .. index:: debug eigrp transmit -``debug eigrp transmit`` +.. clicmd:: debug eigrp transmit Debug eigrp transmit events `debug eigrp transmit` will display detailed information about the EIGRP transmit events. .. index:: show debugging eigrp -``show debugging eigrp`` +.. clicmd:: show debugging eigrp Display *eigrpd*'s debugging option. `show debugging eigrp` will show all information currently set for eigrpd diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 9a842ee595..d6b7d972ad 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -18,29 +18,29 @@ Router Advertisement .. index:: no ipv6 nd suppress-ra -``no ipv6 nd suppress-ra`` +.. clicmd:: no ipv6 nd suppress-ra Send router advertisment messages. .. index:: ipv6 nd suppress-ra -``ipv6 nd suppress-ra`` +.. clicmd:: ipv6 nd suppress-ra Don't send router advertisment messages. .. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] -``ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]`` +.. clicmd:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] Configuring the IPv6 prefix to include in router advertisements. Several prefix specific optional parameters and flags may follow: - ``valid-lifetime``: the length of time in seconds during what the prefix is valid for the purpose of on-link determination. Value ``infinite`` represents infinity (i.e. a value of all one bits (``0xffffffff``)). - Range: ``<0-4294967295>`` Default: ``2592000`` + Range: ``(0-4294967295)`` Default: ``2592000`` - ``preferred-lifetime``: the length of time in seconds during what addresses generated from the prefix remain preferred. Value ``infinite`` represents infinity. - Range: ``<0-4294967295>`` Default: ``604800`` + Range: ``(0-4294967295)`` Default: ``604800`` - ``off-link``: indicates that advertisement makes no statement about on-link or off-link properties of the prefix. @@ -57,31 +57,31 @@ Router Advertisement Default: not set, i.e. hosts do not assume a complete IP address is placed. .. index:: - single: no ipv6 nd ra-interval [<1-1800>] - single: no ipv6 nd ra-interval [<1-1800>] + single: no ipv6 nd ra-interval [(1-1800)] + single: no ipv6 nd ra-interval [(1-1800)] -``[no] ipv6 nd ra-interval [<1-1800>]`` +.. clicmd:: [no] ipv6 nd ra-interval [(1-1800)] The maximum time allowed between sending unsolicited multicast router advertisements from the interface, in seconds. Default: ``600`` -.. index:: ipv6 nd ra-interval msec <70-1800000> +.. index:: ipv6 nd ra-interval msec (70-1800000) .. index:: - single: no ipv6 nd ra-interval [msec <70-1800000>] - single: ipv6 nd ra-interval msec <70-1800000> + single: no ipv6 nd ra-interval [msec (70-1800000)] + single: ipv6 nd ra-interval msec (70-1800000) -``[no] ipv6 nd ra-interval [msec <70-1800000>]`` +.. clicmd:: [no] ipv6 nd ra-interval [msec (70-1800000)] The maximum time allowed between sending unsolicited multicast router advertisements from the interface, in milliseconds. Default: ``600000`` .. index:: - single: ipv6 nd ra-lifetime <0-9000> - single: no ipv6 nd ra-lifetime [<0-9000>] + single: ipv6 nd ra-lifetime (0-9000) + single: no ipv6 nd ra-lifetime [(0-9000)] -``[no] ipv6 nd ra-lifetime [<0-9000>]`` +.. clicmd:: [no] ipv6 nd ra-lifetime [(0-9000)] The value to be placed in the Router Lifetime field of router advertisements sent from the interface, in seconds. Indicates the usefulness of the router as a default router on this interface. Setting the value to zero indicates @@ -91,10 +91,10 @@ Router Advertisement Default: ``1800`` .. index:: - single: no ipv6 nd reachable-time [<1-3600000>] - single: ipv6 nd reachable-time <1-3600000> + single: no ipv6 nd reachable-time [(1-3600000)] + single: ipv6 nd reachable-time (1-3600000) -``[no] ipv6 nd reachable-time [<1-3600000>]`` +.. clicmd:: [no] ipv6 nd reachable-time [(1-3600000)] The value to be placed in the Reachable Time field in the Router Advertisement messages sent by the router, in milliseconds. The configured time enables the router to detect unavailable neighbors. The value zero means unspecified (by @@ -105,7 +105,7 @@ Router Advertisement single: ipv6 nd managed-config-flag single: no ipv6 nd managed-config-flag -``[no] ipv6 nd managed-config-flag`` +.. clicmd:: [no] ipv6 nd managed-config-flag Set/unset flag in IPv6 router advertisements which indicates to hosts that they should use managed (stateful) protocol for addresses autoconfiguration in addition to any addresses autoconfigured using stateless address @@ -116,7 +116,7 @@ Router Advertisement single: ipv6 nd other-config-flag single: no ipv6 nd other-config-flag -``[no] ipv6 nd other-config-flag`` +.. clicmd:: [no] ipv6 nd other-config-flag Set/unset flag in IPv6 router advertisements which indicates to hosts that they should use administered (stateful) protocol to obtain autoconfiguration information other than addresses. @@ -126,28 +126,28 @@ Router Advertisement single: ipv6 nd home-agent-config-flag single: no ipv6 nd home-agent-config-flag -``[no] ipv6 nd home-agent-config-flag`` +.. clicmd:: [no] ipv6 nd home-agent-config-flag Set/unset flag in IPv6 router advertisements which indicates to hosts that the router acts as a Home Agent and includes a Home Agent Option. Default: not set -.. index:: ipv6 nd home-agent-preference <0-65535> +.. index:: ipv6 nd home-agent-preference (0-65535) .. index:: - single: no ipv6 nd home-agent-preference [<0-65535>] - single: ipv6 nd home-agent-preference <0-65535> + single: no ipv6 nd home-agent-preference [(0-65535)] + single: ipv6 nd home-agent-preference (0-65535) -``[no] ipv6 nd home-agent-preference [<0-65535>]`` +.. clicmd:: [no] ipv6 nd home-agent-preference [(0-65535)] The value to be placed in Home Agent Option, when Home Agent config flag is set, which indicates to hosts Home Agent preference. The default value of 0 stands for the lowest preference possible. Default: ``0`` .. index:: - single: ipv6 nd home-agent-lifetime <0-65520> - single: no ipv6 nd home-agent-lifetime <0-65520> + single: ipv6 nd home-agent-lifetime (0-65520) + single: no ipv6 nd home-agent-lifetime (0-65520) -``[no] ipv6 nd home-agent-lifetime [<0-65520>]`` +.. clicmd:: [no] ipv6 nd home-agent-lifetime [(0-65520)] The value to be placed in Home Agent Option, when Home Agent config flag is set, which indicates to hosts Home Agent Lifetime. The default value of 0 means to place the current Router Lifetime value. @@ -158,7 +158,7 @@ Router Advertisement single: ipv6 nd adv-interval-option single: no ipv6 nd adv-interval-option -``[no] ipv6 nd adv-interval-option`` +.. clicmd:: [no] ipv6 nd adv-interval-option Include an Advertisement Interval option which indicates to hosts the maximum time, in milliseconds, between successive unsolicited Router Advertisements. Default: not set @@ -167,15 +167,15 @@ Router Advertisement single: ipv6 nd router-preference (high|medium|low) single: no ipv6 nd router-preference (high|medium|low) -``[no] ipv6 nd router-preference [(high|medium|low)]`` +.. clicmd:: [no] ipv6 nd router-preference [(high|medium|low)] Set default router preference in IPv6 router advertisements per RFC4191. Default: medium .. index:: - single: ipv6 nd mtu <1-65535> - single: no ipv6 nd mtu [<1-65535>] + single: ipv6 nd mtu (1-65535) + single: no ipv6 nd mtu [(1-65535)] -``[no] ipv6 nd mtu [<1-65535>]`` +.. clicmd:: [no] ipv6 nd mtu [(1-65535)] Include an MTU (type 5) option in each RA packet to assist the attached hosts in proper interface configuration. The announced value is not verified to be consistent with router interface MTU. diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index d1c1336b4e..7da4379f4c 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -112,12 +112,12 @@ Command {no router isis WORD} {} ISIS Timer ========== -.. index:: {ISIS Command} {lsp-gen-interval <1-120>} {} +.. index:: {ISIS Command} {lsp-gen-interval (1-120)} {} -{ISIS Command} {lsp-gen-interval <1-120>} {} -.. index:: {ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {} +{ISIS Command} {lsp-gen-interval (1-120)} {} +.. index:: {ISIS Command} {lsp-gen-interval [level-1 | level-2] (1-120)} {} -{ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {} +{ISIS Command} {lsp-gen-interval [level-1 | level-2] (1-120)} {} .. index:: {ISIS Command} {no lsp-gen-interval} {} {ISIS Command} {no lsp-gen-interval} {} @@ -127,12 +127,12 @@ ISIS Timer Set minimum interval in seconds between regenerating same LSP, globally, for an area (level-1) or a domain (level-2). -.. index:: {ISIS Command} {lsp-refresh-interval <1-65235>} {} +.. index:: {ISIS Command} {lsp-refresh-interval (1-65235)} {} -{ISIS Command} {lsp-refresh-interval <1-65235>} {} -.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} +{ISIS Command} {lsp-refresh-interval (1-65235)} {} +.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} -{ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} +{ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} .. index:: {ISIS Command} {no lsp-refresh-interval} {} {ISIS Command} {no lsp-refresh-interval} {} @@ -141,12 +141,12 @@ ISIS Timer {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). -.. index:: {ISIS Command} {lsp-refresh-interval <1-65235>} {} +.. index:: {ISIS Command} {lsp-refresh-interval (1-65235)} {} -{ISIS Command} {lsp-refresh-interval <1-65235>} {} -.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} +{ISIS Command} {lsp-refresh-interval (1-65235)} {} +.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} -{ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} +{ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} .. index:: {ISIS Command} {no lsp-refresh-interval} {} {ISIS Command} {no lsp-refresh-interval} {} @@ -155,12 +155,12 @@ ISIS Timer {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). -.. index:: {ISIS Command} {max-lsp-lifetime <360-65535>} {} +.. index:: {ISIS Command} {max-lsp-lifetime (360-65535)} {} -{ISIS Command} {max-lsp-lifetime <360-65535>} {} -.. index:: {ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {} +{ISIS Command} {max-lsp-lifetime (360-65535)} {} +.. index:: {ISIS Command} {max-lsp-lifetime [level-1 | level-2] (360-65535)} {} -{ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {} +{ISIS Command} {max-lsp-lifetime [level-1 | level-2] (360-65535)} {} .. index:: {ISIS Command} {no max-lsp-lifetime} {} {ISIS Command} {no max-lsp-lifetime} {} @@ -169,12 +169,12 @@ ISIS Timer {ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or a domain (level-2). -.. index:: {ISIS Command} {spf-interval <1-120>} {} +.. index:: {ISIS Command} {spf-interval (1-120)} {} -{ISIS Command} {spf-interval <1-120>} {} -.. index:: {ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {} +{ISIS Command} {spf-interval (1-120)} {} +.. index:: {ISIS Command} {spf-interval [level-1 | level-2] (1-120)} {} -{ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {} +{ISIS Command} {spf-interval [level-1 | level-2] (1-120)} {} .. index:: {ISIS Command} {no spf-interval} {} {ISIS Command} {no spf-interval} {} @@ -227,12 +227,12 @@ ISIS interface - level-1-2 Level-1-2 adjacencies are formed - level-2-only Level-2 only adjacencies are formed -.. index:: {Interface Command} {isis csnp-interval <1-600>} {} +.. index:: {Interface Command} {isis csnp-interval (1-600)} {} -{Interface Command} {isis csnp-interval <1-600>} {} -.. index:: {Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {} +{Interface Command} {isis csnp-interval (1-600)} {} +.. index:: {Interface Command} {isis csnp-interval (1-600) [level-1 | level-2]} {} -{Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {} +{Interface Command} {isis csnp-interval (1-600) [level-1 | level-2]} {} .. index:: {Interface Command} {no isis csnp-interval} {} {Interface Command} {no isis csnp-interval} {} @@ -246,12 +246,12 @@ ISIS interface {Interface Command} {isis hello padding} {} Add padding to IS-IS hello packets. -.. index:: {Interface Command} {isis hello-interval <1-600>} {} +.. index:: {Interface Command} {isis hello-interval (1-600)} {} -{Interface Command} {isis hello-interval <1-600>} {} -.. index:: {Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {} +{Interface Command} {isis hello-interval (1-600)} {} +.. index:: {Interface Command} {isis hello-interval (1-600) [level-1 | level-2]} {} -{Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {} +{Interface Command} {isis hello-interval (1-600) [level-1 | level-2]} {} .. index:: {Interface Command} {no isis hello-interval} {} {Interface Command} {no isis hello-interval} {} @@ -260,12 +260,12 @@ ISIS interface {Interface Command} {no isis hello-interval [level-1 | level-2]} {} Set Hello interval in seconds globally, for an area (level-1) or a domain (level-2). -.. index:: {Interface Command} {isis hello-multiplier <2-100>} {} +.. index:: {Interface Command} {isis hello-multiplier (2-100)} {} -{Interface Command} {isis hello-multiplier <2-100>} {} -.. index:: {Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {} +{Interface Command} {isis hello-multiplier (2-100)} {} +.. index:: {Interface Command} {isis hello-multiplier (2-100) [level-1 | level-2]} {} -{Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {} +{Interface Command} {isis hello-multiplier (2-100) [level-1 | level-2]} {} .. index:: {Interface Command} {no isis hello-multiplier} {} {Interface Command} {no isis hello-multiplier} {} @@ -274,12 +274,12 @@ ISIS interface {Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} Set multiplier for Hello holding time globally, for an area (level-1) or a domain (level-2). -.. index:: {Interface Command} {isis metric [<0-255> | <0-16777215>]} {} +.. index:: {Interface Command} {isis metric [(0-255) | (0-16777215)]} {} -{Interface Command} {isis metric [<0-255> | <0-16777215>]} {} -.. index:: {Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {} +{Interface Command} {isis metric [(0-255) | (0-16777215)]} {} +.. index:: {Interface Command} {isis metric [(0-255) | (0-16777215)] [level-1 | level-2]} {} -{Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {} +{Interface Command} {isis metric [(0-255) | (0-16777215)] [level-1 | level-2]} {} .. index:: {Interface Command} {no isis metric} {} {Interface Command} {no isis metric} {} @@ -313,12 +313,12 @@ ISIS interface {Interface Command} {no isis password} {} Configure the authentication password (clear or encoded text) for the interface. -.. index:: {Interface Command} {isis priority <0-127>} {} +.. index:: {Interface Command} {isis priority (0-127)} {} -{Interface Command} {isis priority <0-127>} {} -.. index:: {Interface Command} {isis priority <0-127> [level-1 | level-2]} {} +{Interface Command} {isis priority (0-127)} {} +.. index:: {Interface Command} {isis priority (0-127) [level-1 | level-2]} {} -{Interface Command} {isis priority <0-127> [level-1 | level-2]} {} +{Interface Command} {isis priority (0-127) [level-1 | level-2]} {} .. index:: {Interface Command} {no isis priority} {} {Interface Command} {no isis priority} {} @@ -328,12 +328,12 @@ ISIS interface Set priority for Designated Router election, globally, for the area (level-1) or the domain (level-2). -.. index:: {Interface Command} {isis psnp-interval <1-120>} {} +.. index:: {Interface Command} {isis psnp-interval (1-120)} {} -{Interface Command} {isis psnp-interval <1-120>} {} -.. index:: {Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {} +{Interface Command} {isis psnp-interval (1-120)} {} +.. index:: {Interface Command} {isis psnp-interval (1-120) [level-1 | level-2]} {} -{Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {} +{Interface Command} {isis psnp-interval (1-120) [level-1 | level-2]} {} .. index:: {Interface Command} {no isis psnp-interval} {} {Interface Command} {no isis psnp-interval} {} diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index d1dfd529f9..384df6f785 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -187,9 +187,9 @@ Command {no router ospf} {} This command supercedes the *timers spf* command in previous FRR releases. -.. index:: {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} +.. index:: {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] (5-86400)} {} -{OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} +{OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] (5-86400)} {} .. index:: {OSPF Command} {max-metric router-lsa administrative} {} {OSPF Command} {max-metric router-lsa administrative} {} @@ -225,9 +225,9 @@ Command {no router ospf} {} number of second remaining till on-startup or on-shutdown ends, can be viewed with the :ref:`show_ip_ospf` command. -.. index:: {OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {} +.. index:: {OSPF Command} {auto-cost reference-bandwidth (1-4294967)} {} -{OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {} +{OSPF Command} {auto-cost reference-bandwidth (1-4294967)} {} .. index:: {OSPF Command} {no auto-cost reference-bandwidth} {} {OSPF Command} {no auto-cost reference-bandwidth} {} @@ -246,15 +246,15 @@ Command {no router ospf} {} .. index:: {OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {} {OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {} -.. index:: {OSPF Command} {network `a.b.c.d/m` area `<0-4294967295>`} {} +.. index:: {OSPF Command} {network `a.b.c.d/m` area `(0-4294967295)`} {} -{OSPF Command} {network `a.b.c.d/m` area `<0-4294967295>`} {} +{OSPF Command} {network `a.b.c.d/m` area `(0-4294967295)`} {} .. index:: {OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {} {OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {} -.. index:: {OSPF Command} {no network `a.b.c.d/m` area `<0-4294967295>`} {} +.. index:: {OSPF Command} {no network `a.b.c.d/m` area `(0-4294967295)`} {} -{OSPF Command} {no network `a.b.c.d/m` area `<0-4294967295>`} {} +{OSPF Command} {no network `a.b.c.d/m` area `(0-4294967295)`} {} .. _OSPF_network_command: This command specifies the OSPF enabled interface(s). If the interface has @@ -292,15 +292,15 @@ OSPF area .. index:: {OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {} {OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {} -.. index:: {OSPF Command} {area <0-4294967295> range `a.b.c.d/m`} {} +.. index:: {OSPF Command} {area (0-4294967295) range `a.b.c.d/m`} {} -{OSPF Command} {area <0-4294967295> range `a.b.c.d/m`} {} +{OSPF Command} {area (0-4294967295) range `a.b.c.d/m`} {} .. index:: {OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {} {OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {} -.. index:: {OSPF Command} {no area <0-4294967295> range `a.b.c.d/m`} {} +.. index:: {OSPF Command} {no area (0-4294967295) range `a.b.c.d/m`} {} -{OSPF Command} {no area <0-4294967295> range `a.b.c.d/m`} {} +{OSPF Command} {no area (0-4294967295) range `a.b.c.d/m`} {} Summarize intra area paths from specified area into one Type-3 summary-LSA announced to other areas. This command can be used only in ABR and ONLY router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can @@ -353,44 +353,44 @@ OSPF area .. index:: {OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {} {OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {} -.. index:: {OSPF Command} {area <0-4294967295> virtual-link `a.b.c.d`} {} +.. index:: {OSPF Command} {area (0-4294967295) virtual-link `a.b.c.d`} {} -{OSPF Command} {area <0-4294967295> virtual-link `a.b.c.d`} {} +{OSPF Command} {area (0-4294967295) virtual-link `a.b.c.d`} {} .. index:: {OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {} {OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {} -.. index:: {OSPF Command} {no area <0-4294967295> virtual-link `a.b.c.d`} {} +.. index:: {OSPF Command} {no area (0-4294967295) virtual-link `a.b.c.d`} {} -{OSPF Command} {no area <0-4294967295> virtual-link `a.b.c.d`} {} +{OSPF Command} {no area (0-4294967295) virtual-link `a.b.c.d`} {} .. _OSPF_virtual-link: .. index:: {OSPF Command} {area `a.b.c.d` shortcut} {} {OSPF Command} {area `a.b.c.d` shortcut} {} -.. index:: {OSPF Command} {area <0-4294967295> shortcut} {} +.. index:: {OSPF Command} {area (0-4294967295) shortcut} {} -{OSPF Command} {area <0-4294967295> shortcut} {} +{OSPF Command} {area (0-4294967295) shortcut} {} .. index:: {OSPF Command} {no area `a.b.c.d` shortcut} {} {OSPF Command} {no area `a.b.c.d` shortcut} {} -.. index:: {OSPF Command} {no area <0-4294967295> shortcut} {} +.. index:: {OSPF Command} {no area (0-4294967295) shortcut} {} -{OSPF Command} {no area <0-4294967295> shortcut} {} +{OSPF Command} {no area (0-4294967295) shortcut} {} Configure the area as Shortcut capable. See :rfc:`3509`. This requires that the 'abr-type' be set to 'shortcut'. .. index:: {OSPF Command} {area `a.b.c.d` stub} {} {OSPF Command} {area `a.b.c.d` stub} {} -.. index:: {OSPF Command} {area <0-4294967295> stub} {} +.. index:: {OSPF Command} {area (0-4294967295) stub} {} -{OSPF Command} {area <0-4294967295> stub} {} +{OSPF Command} {area (0-4294967295) stub} {} .. index:: {OSPF Command} {no area `a.b.c.d` stub} {} {OSPF Command} {no area `a.b.c.d` stub} {} -.. index:: {OSPF Command} {no area <0-4294967295> stub} {} +.. index:: {OSPF Command} {no area (0-4294967295) stub} {} -{OSPF Command} {no area <0-4294967295> stub} {} +{OSPF Command} {no area (0-4294967295) stub} {} Configure the area to be a stub area. That is, an area where no router originates routes external to OSPF and hence an area where all external routes are via the ABR(s). Hence, ABRs for such an area do not need @@ -401,38 +401,38 @@ OSPF area .. index:: {OSPF Command} {area `a.b.c.d` stub no-summary} {} {OSPF Command} {area `a.b.c.d` stub no-summary} {} -.. index:: {OSPF Command} {area <0-4294967295> stub no-summary} {} +.. index:: {OSPF Command} {area (0-4294967295) stub no-summary} {} -{OSPF Command} {area <0-4294967295> stub no-summary} {} +{OSPF Command} {area (0-4294967295) stub no-summary} {} .. index:: {OSPF Command} {no area `a.b.c.d` stub no-summary} {} {OSPF Command} {no area `a.b.c.d` stub no-summary} {} -.. index:: {OSPF Command} {no area <0-4294967295> stub no-summary} {} +.. index:: {OSPF Command} {no area (0-4294967295) stub no-summary} {} -{OSPF Command} {no area <0-4294967295> stub no-summary} {} +{OSPF Command} {no area (0-4294967295) stub no-summary} {} Prevents an *ospfd* ABR from injecting inter-area summaries into the specified stub area. -.. index:: {OSPF Command} {area `a.b.c.d` default-cost <0-16777215>} {} +.. index:: {OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {} -{OSPF Command} {area `a.b.c.d` default-cost <0-16777215>} {} -.. index:: {OSPF Command} {no area `a.b.c.d` default-cost <0-16777215>} {} +{OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {} +.. index:: {OSPF Command} {no area `a.b.c.d` default-cost (0-16777215)} {} -{OSPF Command} {no area `a.b.c.d` default-cost <0-16777215>} {} +{OSPF Command} {no area `a.b.c.d` default-cost (0-16777215)} {} Set the cost of default-summary LSAs announced to stubby areas. .. index:: {OSPF Command} {area `a.b.c.d` export-list NAME} {} {OSPF Command} {area `a.b.c.d` export-list NAME} {} -.. index:: {OSPF Command} {area <0-4294967295> export-list NAME} {} +.. index:: {OSPF Command} {area (0-4294967295) export-list NAME} {} -{OSPF Command} {area <0-4294967295> export-list NAME} {} +{OSPF Command} {area (0-4294967295) export-list NAME} {} .. index:: {OSPF Command} {no area `a.b.c.d` export-list NAME} {} {OSPF Command} {no area `a.b.c.d` export-list NAME} {} -.. index:: {OSPF Command} {no area <0-4294967295> export-list NAME} {} +.. index:: {OSPF Command} {no area (0-4294967295) export-list NAME} {} -{OSPF Command} {no area <0-4294967295> export-list NAME} {} +{OSPF Command} {no area (0-4294967295) export-list NAME} {} Filter Type-3 summary-LSAs announced to other areas originated from intra- area paths from specified area. @@ -458,15 +458,15 @@ OSPF area .. index:: {OSPF Command} {area `a.b.c.d` import-list NAME} {} {OSPF Command} {area `a.b.c.d` import-list NAME} {} -.. index:: {OSPF Command} {area <0-4294967295> import-list NAME} {} +.. index:: {OSPF Command} {area (0-4294967295) import-list NAME} {} -{OSPF Command} {area <0-4294967295> import-list NAME} {} +{OSPF Command} {area (0-4294967295) import-list NAME} {} .. index:: {OSPF Command} {no area `a.b.c.d` import-list NAME} {} {OSPF Command} {no area `a.b.c.d` import-list NAME} {} -.. index:: {OSPF Command} {no area <0-4294967295> import-list NAME} {} +.. index:: {OSPF Command} {no area (0-4294967295) import-list NAME} {} -{OSPF Command} {no area <0-4294967295> import-list NAME} {} +{OSPF Command} {no area (0-4294967295) import-list NAME} {} Same as export-list, but it applies to paths announced into specified area as Type-3 summary-LSAs. @@ -476,48 +476,48 @@ OSPF area .. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {} {OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {} -.. index:: {OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {} +.. index:: {OSPF Command} {area (0-4294967295) filter-list prefix NAME in} {} -{OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {} -.. index:: {OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {} +{OSPF Command} {area (0-4294967295) filter-list prefix NAME in} {} +.. index:: {OSPF Command} {area (0-4294967295) filter-list prefix NAME out} {} -{OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {} +{OSPF Command} {area (0-4294967295) filter-list prefix NAME out} {} .. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {} {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {} .. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {} {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {} -.. index:: {OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {} +.. index:: {OSPF Command} {no area (0-4294967295) filter-list prefix NAME in} {} -{OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {} -.. index:: {OSPF Command} {no area <0-4294967295> filter-list prefix NAME out} {} +{OSPF Command} {no area (0-4294967295) filter-list prefix NAME in} {} +.. index:: {OSPF Command} {no area (0-4294967295) filter-list prefix NAME out} {} -{OSPF Command} {no area <0-4294967295> filter-list prefix NAME out} {} +{OSPF Command} {no area (0-4294967295) filter-list prefix NAME out} {} Filtering Type-3 summary-LSAs to/from area using prefix lists. This command makes sense in ABR only. .. index:: {OSPF Command} {area `a.b.c.d` authentication} {} {OSPF Command} {area `a.b.c.d` authentication} {} -.. index:: {OSPF Command} {area <0-4294967295> authentication} {} +.. index:: {OSPF Command} {area (0-4294967295) authentication} {} -{OSPF Command} {area <0-4294967295> authentication} {} +{OSPF Command} {area (0-4294967295) authentication} {} .. index:: {OSPF Command} {no area `a.b.c.d` authentication} {} {OSPF Command} {no area `a.b.c.d` authentication} {} -.. index:: {OSPF Command} {no area <0-4294967295> authentication} {} +.. index:: {OSPF Command} {no area (0-4294967295) authentication} {} -{OSPF Command} {no area <0-4294967295> authentication} {} +{OSPF Command} {no area (0-4294967295) authentication} {} Specify that simple password authentication should be used for the given area. .. index:: {OSPF Command} {area `a.b.c.d` authentication message-digest} {} {OSPF Command} {area `a.b.c.d` authentication message-digest} {} -.. index:: {OSPF Command} {area <0-4294967295> authentication message-digest} {} +.. index:: {OSPF Command} {area (0-4294967295) authentication message-digest} {} -{OSPF Command} {area <0-4294967295> authentication message-digest} {} +{OSPF Command} {area (0-4294967295) authentication message-digest} {} .. _area_authentication_message-digest: Specify that OSPF packets @@ -597,21 +597,21 @@ OSPF interface KEY is the actual message digest key, of up to 16 chars (larger strings will be truncated), and is associated with the given KEYID. -.. index:: {Interface Command} {ip ospf cost <1-65535>} {} +.. index:: {Interface Command} {ip ospf cost (1-65535)} {} -{Interface Command} {ip ospf cost <1-65535>} {} +{Interface Command} {ip ospf cost (1-65535)} {} .. index:: {Interface Command} {no ip ospf cost} {} {Interface Command} {no ip ospf cost} {} Set link cost for the specified interface. The cost value is set to router-LSA's metric field and used for SPF calculation. -.. index:: {Interface Command} {ip ospf dead-interval <1-65535>} {} +.. index:: {Interface Command} {ip ospf dead-interval (1-65535)} {} -{Interface Command} {ip ospf dead-interval <1-65535>} {} -.. index:: {Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {} +{Interface Command} {ip ospf dead-interval (1-65535)} {} +.. index:: {Interface Command} {ip ospf dead-interval minimal hello-multiplier (2-20)} {} -{Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {} +{Interface Command} {ip ospf dead-interval minimal hello-multiplier (2-20)} {} .. index:: {Interface Command} {no ip ospf dead-interval} {} {Interface Command} {no ip ospf dead-interval} {} @@ -631,9 +631,9 @@ OSPF interface the hello-multiplier need NOT be the same across multiple routers on a common link. -.. index:: {Interface Command} {ip ospf hello-interval <1-65535>} {} +.. index:: {Interface Command} {ip ospf hello-interval (1-65535)} {} -{Interface Command} {ip ospf hello-interval <1-65535>} {} +{Interface Command} {ip ospf hello-interval (1-65535)} {} .. index:: {Interface Command} {no ip ospf hello-interval} {} {Interface Command} {no ip ospf hello-interval} {} @@ -653,9 +653,9 @@ OSPF interface {Interface Command} {no ip ospf network} {} Set explicitly network type for specifed interface. -.. index:: {Interface Command} {ip ospf priority <0-255>} {} +.. index:: {Interface Command} {ip ospf priority (0-255)} {} -{Interface Command} {ip ospf priority <0-255>} {} +{Interface Command} {ip ospf priority (0-255)} {} .. index:: {Interface Command} {no ip ospf priority} {} {Interface Command} {no ip ospf priority} {} @@ -664,9 +664,9 @@ OSPF interface to 0, makes the router ineligible to become Designated Router. The default value is 1. -.. index:: {Interface Command} {ip ospf retransmit-interval <1-65535>} {} +.. index:: {Interface Command} {ip ospf retransmit-interval (1-65535)} {} -{Interface Command} {ip ospf retransmit-interval <1-65535>} {} +{Interface Command} {ip ospf retransmit-interval (1-65535)} {} .. index:: {Interface Command} {no ip ospf retransmit interval} {} {Interface Command} {no ip ospf retransmit interval} {} @@ -684,9 +684,9 @@ OSPF interface incremented by this value when transmitting. The default value is 1 seconds. -.. index:: {Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {} +.. index:: {Interface Command} {ip ospf area (A.B.C.D|(0-4294967295))} {} -{Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {} +{Interface Command} {ip ospf area (A.B.C.D|(0-4294967295))} {} .. index:: {Interface Command} {no ip ospf area} {} {Interface Command} {no ip ospf area} {} @@ -709,18 +709,18 @@ Redistribute routes to OSPF .. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {} {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)} {} -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map `word`} {} +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map `word`} {} -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map `word`} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {} +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map `word`} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)} {} -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map `word`} {} +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)} {} +.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map `word`} {} -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map `word`} {} +{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map `word`} {} .. index:: {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} @@ -743,27 +743,27 @@ Redistribute routes to OSPF .. index:: {OSPF Command} {default-information originate} {} {OSPF Command} {default-information originate} {} -.. index:: {OSPF Command} {default-information originate metric <0-16777214>} {} +.. index:: {OSPF Command} {default-information originate metric (0-16777214)} {} -{OSPF Command} {default-information originate metric <0-16777214>} {} -.. index:: {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {} +{OSPF Command} {default-information originate metric (0-16777214)} {} +.. index:: {OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2)} {} -{OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {} -.. index:: {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map `word`} {} +{OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2)} {} +.. index:: {OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2) route-map `word`} {} -{OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map `word`} {} +{OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2) route-map `word`} {} .. index:: {OSPF Command} {default-information originate always} {} {OSPF Command} {default-information originate always} {} -.. index:: {OSPF Command} {default-information originate always metric <0-16777214>} {} +.. index:: {OSPF Command} {default-information originate always metric (0-16777214)} {} -{OSPF Command} {default-information originate always metric <0-16777214>} {} -.. index:: {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {} +{OSPF Command} {default-information originate always metric (0-16777214)} {} +.. index:: {OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2)} {} -{OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {} -.. index:: {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map `word`} {} +{OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2)} {} +.. index:: {OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2) route-map `word`} {} -{OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map `word`} {} +{OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2) route-map `word`} {} .. index:: {OSPF Command} {no default-information originate} {} {OSPF Command} {no default-information originate} {} @@ -784,21 +784,21 @@ Redistribute routes to OSPF redistributed routes of the given type before allowing the routes to redistributed into OSPF (:ref:`OSPF_redistribute`). -.. index:: {OSPF Command} {default-metric <0-16777214>} {} +.. index:: {OSPF Command} {default-metric (0-16777214)} {} -{OSPF Command} {default-metric <0-16777214>} {} +{OSPF Command} {default-metric (0-16777214)} {} .. index:: {OSPF Command} {no default-metric} {} {OSPF Command} {no default-metric} {} -.. index:: {OSPF Command} {distance <1-255>} {} +.. index:: {OSPF Command} {distance (1-255)} {} -{OSPF Command} {distance <1-255>} {} -.. index:: {OSPF Command} {no distance <1-255>} {} +{OSPF Command} {distance (1-255)} {} +.. index:: {OSPF Command} {no distance (1-255)} {} -{OSPF Command} {no distance <1-255>} {} -.. index:: {OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {} +{OSPF Command} {no distance (1-255)} {} +.. index:: {OSPF Command} {distance ospf (intra-area|inter-area|external) (1-255)} {} -{OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {} +{OSPF Command} {distance ospf (intra-area|inter-area|external) (1-255)} {} .. index:: {OSPF Command} {no distance ospf} {} {OSPF Command} {no distance ospf} {} @@ -976,18 +976,18 @@ Router Information .. index:: {OSPF Command} {no pce address} {} {OSPF Command} {no pce address} {} -.. index:: {OSPF Command} {pce domain as <0-65535>} {} +.. index:: {OSPF Command} {pce domain as (0-65535)} {} -{OSPF Command} {pce domain as <0-65535>} {} -.. index:: {OSPF Command} {no pce domain as <0-65535>} {} +{OSPF Command} {pce domain as (0-65535)} {} +.. index:: {OSPF Command} {no pce domain as (0-65535)} {} -{OSPF Command} {no pce domain as <0-65535>} {} -.. index:: {OSPF Command} {pce neighbor as <0-65535>} {} +{OSPF Command} {no pce domain as (0-65535)} {} +.. index:: {OSPF Command} {pce neighbor as (0-65535)} {} -{OSPF Command} {pce neighbor as <0-65535>} {} -.. index:: {OSPF Command} {no pce neighbor as <0-65535>} {} +{OSPF Command} {pce neighbor as (0-65535)} {} +.. index:: {OSPF Command} {no pce neighbor as (0-65535)} {} -{OSPF Command} {no pce neighbor as <0-65535>} {} +{OSPF Command} {no pce neighbor as (0-65535)} {} .. index:: {OSPF Command} {pce flag BITPATTERN} {} {OSPF Command} {pce flag BITPATTERN} {} diff --git a/doc/user/overview.rst b/doc/user/overview.rst index 7a6cdf11d2..2b5e2f9b2b 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -4,14 +4,6 @@ Overview ******** -big booty bizitches - - ballsack - -show ip bgp sum - - example - `FRR`_ is a routing software package that provides TCP/IP based routing services with routing protocols support such as RIPv1, RIPv2, RIPng, OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`supported-rfcs`). FRR also diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 8150f960b6..7aaaf61778 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -249,9 +249,9 @@ How to Announce RIP route .. index:: {RIP command} {redistribute kernel} {} {RIP command} {redistribute kernel} {} -.. index:: {RIP command} {redistribute kernel metric <0-16>} {} +.. index:: {RIP command} {redistribute kernel metric (0-16)} {} -{RIP command} {redistribute kernel metric <0-16>} {} +{RIP command} {redistribute kernel metric (0-16)} {} .. index:: {RIP command} {redistribute kernel route-map `route-map`} {} {RIP command} {redistribute kernel route-map `route-map`} {} @@ -265,9 +265,9 @@ How to Announce RIP route .. index:: {RIP command} {redistribute static} {} {RIP command} {redistribute static} {} -.. index:: {RIP command} {redistribute static metric <0-16>} {} +.. index:: {RIP command} {redistribute static metric (0-16)} {} -{RIP command} {redistribute static metric <0-16>} {} +{RIP command} {redistribute static metric (0-16)} {} .. index:: {RIP command} {redistribute static route-map `route-map`} {} {RIP command} {redistribute static route-map `route-map`} {} @@ -281,9 +281,9 @@ How to Announce RIP route .. index:: {RIP command} {redistribute connected} {} {RIP command} {redistribute connected} {} -.. index:: {RIP command} {redistribute connected metric <0-16>} {} +.. index:: {RIP command} {redistribute connected metric (0-16)} {} -{RIP command} {redistribute connected metric <0-16>} {} +{RIP command} {redistribute connected metric (0-16)} {} .. index:: {RIP command} {redistribute connected route-map `route-map`} {} {RIP command} {redistribute connected route-map `route-map`} {} @@ -297,9 +297,9 @@ How to Announce RIP route .. index:: {RIP command} {redistribute ospf} {} {RIP command} {redistribute ospf} {} -.. index:: {RIP command} {redistribute ospf metric <0-16>} {} +.. index:: {RIP command} {redistribute ospf metric (0-16)} {} -{RIP command} {redistribute ospf metric <0-16>} {} +{RIP command} {redistribute ospf metric (0-16)} {} .. index:: {RIP command} {redistribute ospf route-map `route-map`} {} {RIP command} {redistribute ospf route-map `route-map`} {} @@ -313,9 +313,9 @@ How to Announce RIP route .. index:: {RIP command} {redistribute bgp} {} {RIP command} {redistribute bgp} {} -.. index:: {RIP command} {redistribute bgp metric <0-16>} {} +.. index:: {RIP command} {redistribute bgp metric (0-16)} {} -{RIP command} {redistribute bgp metric <0-16>} {} +{RIP command} {redistribute bgp metric (0-16)} {} .. index:: {RIP command} {redistribute bgp route-map `route-map`} {} {RIP command} {redistribute bgp route-map `route-map`} {} @@ -395,12 +395,12 @@ RIP metric is a value for distance for the network. Usually *ripd* increment the metric when the network information is received. Redistributed routes' metric is set to 1. -.. index:: {RIP command} {default-metric <1-16>} {} +.. index:: {RIP command} {default-metric (1-16)} {} -{RIP command} {default-metric <1-16>} {} -.. index:: {RIP command} {no default-metric <1-16>} {} +{RIP command} {default-metric (1-16)} {} +.. index:: {RIP command} {no default-metric (1-16)} {} -{RIP command} {no default-metric <1-16>} {} +{RIP command} {no default-metric (1-16)} {} This command modifies the default metric value for redistributed routes. The default value is 1. This command does not affect connected route even if it is redistributed by *redistribute connected*. To modify @@ -422,29 +422,29 @@ RIP distance Distance value is used in zebra daemon. Default RIP distance is 120. -.. index:: {RIP command} {distance <1-255>} {} +.. index:: {RIP command} {distance (1-255)} {} -{RIP command} {distance <1-255>} {} -.. index:: {RIP command} {no distance <1-255>} {} +{RIP command} {distance (1-255)} {} +.. index:: {RIP command} {no distance (1-255)} {} -{RIP command} {no distance <1-255>} {} +{RIP command} {no distance (1-255)} {} Set default RIP distance to specified value. -.. index:: {RIP command} {distance <1-255> `A.B.C.D/M`} {} +.. index:: {RIP command} {distance (1-255) `A.B.C.D/M`} {} -{RIP command} {distance <1-255> `A.B.C.D/M`} {} -.. index:: {RIP command} {no distance <1-255> `A.B.C.D/M`} {} +{RIP command} {distance (1-255) `A.B.C.D/M`} {} +.. index:: {RIP command} {no distance (1-255) `A.B.C.D/M`} {} -{RIP command} {no distance <1-255> `A.B.C.D/M`} {} +{RIP command} {no distance (1-255) `A.B.C.D/M`} {} Set default RIP distance to specified value when the route's source IP address matches the specified prefix. -.. index:: {RIP command} {distance <1-255> `A.B.C.D/M` `access-list`} {} +.. index:: {RIP command} {distance (1-255) `A.B.C.D/M` `access-list`} {} -{RIP command} {distance <1-255> `A.B.C.D/M` `access-list`} {} -.. index:: {RIP command} {no distance <1-255> `A.B.C.D/M` `access-list`} {} +{RIP command} {distance (1-255) `A.B.C.D/M` `access-list`} {} +.. index:: {RIP command} {no distance (1-255) `A.B.C.D/M` `access-list`} {} -{RIP command} {no distance <1-255> `A.B.C.D/M` `access-list`} {} +{RIP command} {no distance (1-255) `A.B.C.D/M` `access-list`} {} Set default RIP distance to specified value when the route's source IP address matches the specified prefix and the specified access-list. @@ -504,12 +504,12 @@ functionality. Match if route next-hop (meaning next-hop listed in the rip route-table as displayed by "show ip rip") is permitted by access-list. -.. index:: {Route Map} {match metric <0-4294967295>} {} +.. index:: {Route Map} {match metric (0-4294967295)} {} -{Route Map} {match metric <0-4294967295>} {} +{Route Map} {match metric (0-4294967295)} {} This command match to the metric value of RIP updates. For other - protocol compatibility metric range is shown as <0-4294967295>. But - for RIP protocol only the value range <0-16> make sense. + protocol compatibility metric range is shown as (0-4294967295). But + for RIP protocol only the value range (0-16) make sense. .. index:: {Route Map} {set ip next-hop A.B.C.D} {} @@ -517,9 +517,9 @@ functionality. This command set next hop value in RIPv2 protocol. This command does not affect RIPv1 because there is no next hop field in the packet. -.. index:: {Route Map} {set metric <0-4294967295>} {} +.. index:: {Route Map} {set metric (0-4294967295)} {} -{Route Map} {set metric <0-4294967295>} {} +{Route Map} {set metric (0-4294967295)} {} Set a metric for matched route when sending announcement. The metric value range is very large for compatibility with other protocols. For RIP, valid metric values are from 1 to 16. diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index 3a1b23a3b3..d8a0055ac3 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -83,9 +83,9 @@ Configuring RPKI/RTR Cache Servers The following commands are independent of a specific cache server. -.. index:: {RPKI Command} {rpki polling_period <1-3600>} {} +.. index:: {RPKI Command} {rpki polling_period (1-3600)} {} -{RPKI Command} {rpki polling_period <1-3600>} {} +{RPKI Command} {rpki polling_period (1-3600)} {} .. index:: {RPKI Command} {no rpki polling_period} {} {RPKI Command} {no rpki polling_period} {} diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst index 9c6cb05b89..7ca94ff325 100644 --- a/doc/user/snmptrap.rst +++ b/doc/user/snmptrap.rst @@ -7,7 +7,7 @@ correctly as described in the frr documentation in :ref:`SNMP_Support`. The BGP4 mib will send traps on peer up/down events. These should be visible in your snmp logs with a message similar to: -``snmpd[13733]: Got trap from peer on fd 14`` +.. clicmd:: snmpd[13733]: Got trap from peer on fd 14 To react on these traps they should be handled by a trapsink. Configure your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 012ee33c77..c76b736225 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -857,9 +857,9 @@ Ethernet MAC address forwarding information. The `clear vnc` commands can be used to remove manually and dynamically added information. -.. index:: {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost <0-255>] [lifetime (infinite|<1-4294967295>)] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost <0-255>]]} {} +.. index:: {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]} {} -{Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost <0-255>] [lifetime (infinite|<1-4294967295>)] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost <0-255>]]} {} +{Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]} {} Register an IP prefix on behalf of the NVE identified by the VN and UN addresses. The `cost` parameter provides the administrative preference of the forwarding information for remote advertisement. If @@ -874,9 +874,9 @@ information. forwarding preference. If omitted, it defaults to 255 (lowest preference). -.. index:: {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier <1-4294967295> vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost <0-255>] [lifetime (infinite|<1-4294967295>)]} {} +.. index:: {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]} {} -{Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier <1-4294967295> vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost <0-255>] [lifetime (infinite|<1-4294967295>)]} {} +{Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]} {} Register a MAC address for a logical Ethernet (L2VPN) on behalf of the NVE identified by the VN and UN addresses. The optional `prefix` parameter is to support enable IP address @@ -897,9 +897,9 @@ information. The optional `local-next-hop` parameter is used to delete specific local nexthop information. -.. index:: {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|<1-4294967295>) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} +.. index:: {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|(1-4294967295)) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} -{Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|<1-4294967295>) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} +{Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|(1-4294967295)) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} Delete mac forwarding information. Any or all of these parameters may be wilcarded to (potentially) match more than one registration. diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index 922b1691d3..3d448f6c8e 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -110,12 +110,12 @@ Command {interface `ifname`} {} {Interface Command} {no multicast} {} Enable or disables multicast flag for the interface. -.. index:: {Interface Command} {bandwidth <1-10000000>} {} +.. index:: {Interface Command} {bandwidth (1-10000000)} {} -{Interface Command} {bandwidth <1-10000000>} {} -.. index:: {Interface Command} {no bandwidth <1-10000000>} {} +{Interface Command} {bandwidth (1-10000000)} {} +.. index:: {Interface Command} {no bandwidth (1-10000000)} {} -{Interface Command} {no bandwidth <1-10000000>} {} +{Interface Command} {no bandwidth (1-10000000)} {} Set bandwidth value of the interface in kilobits/sec. This is for calculating OSPF cost. This command does not affect the actual device configuration. @@ -153,18 +153,18 @@ Link Parameters Commands link-params {enable} Enable link parameters for this interface. -.. index:: link-params {metric <0-4294967295>} {} +.. index:: link-params {metric (0-4294967295)} {} -link-params {metric <0-4294967295>} {} +link-params {metric (0-4294967295)} {} .. index:: link-params {max-bw `bandwidth`} {} link-params {max-bw `bandwidth`} {} .. index:: link-params {max-rsv-bw `bandwidth`} {} link-params {max-rsv-bw `bandwidth`} {} -.. index:: link-params {unrsv-bw <0-7> `bandwidth`} {} +.. index:: link-params {unrsv-bw (0-7) `bandwidth`} {} -link-params {unrsv-bw <0-7> `bandwidth`} {} +link-params {unrsv-bw (0-7) `bandwidth`} {} .. index:: link-params {admin-grp `bandwidth`} {} link-params {admin-grp `bandwidth`} {} @@ -176,12 +176,12 @@ link-params {admin-grp `bandwidth`} {} Note that `bandwidth` are specified in IEEE floating point format and express in Bytes/second. -.. index:: link-param {delay <0-16777215> [min <0-16777215> | max <0-16777215>]} {} +.. index:: link-param {delay (0-16777215) [min (0-16777215) | max (0-16777215)]} {} -link-param {delay <0-16777215> [min <0-16777215> | max <0-16777215>]} {} -.. index:: link-param {delay-variation <0-16777215>} {} +link-param {delay (0-16777215) [min (0-16777215) | max (0-16777215)]} {} +.. index:: link-param {delay-variation (0-16777215)} {} -link-param {delay-variation <0-16777215>} {} +link-param {delay-variation (0-16777215)} {} .. index:: link-param {packet-loss `percentage`} {} link-param {packet-loss `percentage`} {} @@ -202,9 +202,9 @@ link-param {use-bw `bandwidth`} {} Delays and delay variation are express in micro-second (µs). Loss is specified in `percentage` ranging from 0 to 50.331642% by step of 0.000003. -.. index:: link-param {neighbor as <0-65535>} {} +.. index:: link-param {neighbor as (0-65535)} {} -link-param {neighbor as <0-65535>} {} +link-param {neighbor as (0-65535)} {} .. index:: link-param {no neighbor} {} link-param {no neighbor} {} From dfab2669d3f1e71bec733e736090a31e376cf018 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 15:57:47 -0500 Subject: [PATCH 029/148] doc: use :term:, will add glossary later Signed-off-by: Quentin Young --- doc/user/eigrpd.rst | 12 ++++++------ doc/user/ospf_fundamentals.rst | 22 +++++++++++----------- doc/user/ospfd.rst | 2 +- doc/user/ripd.rst | 4 ++-- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index 0af627e1d7..a3ad382a98 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -6,7 +6,7 @@ EIGRP EIGRP -- Routing Information Protocol is widely deployed interior gateway routing protocol. EIGRP was developed in the 1990's. EIGRP is a -@dfn{distance-vector} protocol and is based on the @dfn{dual} algorithms. +:term:`distance-vector` protocol and is based on the :term:`dual` algorithms. As a distance-vector protocol, the EIGRP router send updates to its neighbors as networks change, thus allowing the convergence to a known topology. @@ -33,7 +33,7 @@ EIGRP is like below: # zebra -d # eigrpd -d - + Please note that *zebra* must be invoked before *eigrpd*. @@ -100,7 +100,7 @@ EIGRP Configuration router eigrp 1 network 10.0.0.0/8 ! - + Passive interface @@ -114,7 +114,7 @@ EIGRP Configuration interface, all receiving packets are ignored and eigrpd does not send either multicast or unicast EIGRP packets except to EIGRP neighbors specified with `neighbor` command. The interface may be specified - as `default` to make eigrpd default to passive on all interfaces. + as `default` to make eigrpd default to passive on all interfaces. The default is to be passive on all interfaces. @@ -218,9 +218,9 @@ The command displays all EIGRP routes. Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply r - reply Status, s - sia Status - P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 + P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 via Connected, enp0s3 - + EIGRP Debug Commands ==================== diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index dc3321ff5e..6fa0ee176b 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -8,9 +8,9 @@ OSPF Fundamentals .. index:: Distance-vector routing protocol @acronym{OSPF} is, mostly, a link-state routing protocol. In contrast -to @dfn{distance-vector} protocols, such as @acronym{RIP} or -@acronym{BGP}, where routers describe available @dfn{paths} (i.e@. routes) -to each other, in @dfn{link-state} protocols routers instead +to :term:`distance-vector` protocols, such as @acronym{RIP} or +@acronym{BGP}, where routers describe available :term:`paths` (i.e@. routes) +to each other, in :term:`link-state` protocols routers instead describe the state of their links to their immediate neighbouring routers. @@ -25,7 +25,7 @@ routers. Each router describes their link-state information in a message known as an @acronym{LSA,Link State Advertisement}, which is then propogated through to all other routers in a link-state routing domain, by a -process called @dfn{flooding}. Each router thus builds up an +process called :term:`flooding`. Each router thus builds up an @acronym{LSDB,Link State Database} of all the link-state messages. From this collection of LSAs in the LSDB, each router can then calculate the shortest path to any other router, based on some common metric, by @@ -131,7 +131,7 @@ broadly classed as: *LSA Flooding* OSPF defines several related mechanisms, used to manage synchronisation of @acronym{LSDB}s between neighbours as neighbours form adjacencies and - the propogation, or @dfn{flooding} of new or updated @acronym{LSA}s. + the propogation, or :term:`flooding` of new or updated @acronym{LSA}s. :ref:`OSPF_Flooding`. @@ -143,13 +143,13 @@ broadly classed as: and independent link-state areas. Each area must be connected to a common backbone area by an @acronym{ABR,Area Boundary Router}. These @acronym{ABR} routers are responsible for summarising the link-state - routing information of an area into @dfn{Summary LSAs}, possibly in a + routing information of an area into :term:`Summary LSAs`, possibly in a condensed (i.e. aggregated) form, and then originating these summaries into all other areas the @acronym{ABR} is connected to. Note that only summaries and external routes are passed between areas. As these describe *paths*, rather than any router link-states, - routing between areas hence is by @dfn{distance-vector}, @strong{not} + routing between areas hence is by :term:`distance-vector`, @strong{not} link-state. :ref:`OSPF_Areas`. @@ -208,13 +208,13 @@ All LSAs share a common header with the following information: from their @acronym{LSDB}s. The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is - called the @dfn{MaxAge}. MaxAge LSAs are ignored in routing + called the :term:`MaxAge`. MaxAge LSAs are ignored in routing calculations. LSAs must be periodically refreshed by their Advertising Router before reaching MaxAge if they are to remain valid. Routers may deliberately flood LSAs with the age artificially set to 3600 to indicate an LSA is no longer valid. This is called - @dfn{flushing} of an LSA@. + :term:`flushing` of an LSA@. It is not abnormal to see stale LSAs in the LSDB, this can occur where a router has shutdown without flushing its LSA(s), e.g. where it has @@ -236,7 +236,7 @@ protocol. Instances of these LSAs are specific to the link-state area in which they are originated. Routes calculated from these two LSA types are -called @dfn{intra-area routes}. +called :term:`intra-area routes`. * Router LSA @@ -296,7 +296,7 @@ called @dfn{intra-area routes}. with the remote router is Full. Stub links may also be used as a way to describe links on which OSPF is - *not* spoken, known as @dfn{passive interfaces}, see :ref:`OSPF_passive-interface,,passive-interface`. + *not* spoken, known as :term:`passive interfaces`, see :ref:`OSPF_passive-interface,,passive-interface`. * Network LSA diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 384df6f785..db02caefed 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -738,7 +738,7 @@ Redistribute routes to OSPF external routes are not permitted. Note that for connected routes, one may instead use - @dfn{passive-interface}, see :ref:`OSPF_passive-interface`. + :term:`passive-interface`, see :ref:`OSPF_passive-interface`. .. index:: {OSPF Command} {default-information originate} {} diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 7aaaf61778..f81ddad32a 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -6,8 +6,8 @@ RIP RIP -- Routing Information Protocol is widely deployed interior gateway protocol. RIP was developed in the 1970s at Xerox Labs as part of the -XNS routing protocol. RIP is a @dfn{distance-vector} protocol and is -based on the @dfn{Bellman-Ford} algorithms. As a distance-vector +XNS routing protocol. RIP is a :term:`distance-vector` protocol and is +based on the :term:`Bellman-Ford` algorithms. As a distance-vector protocol, RIP router send updates to its neighbors periodically, thus allowing the convergence to a known topology. In each update, the distance to any given network will be broadcasted to its neighboring From d50b2aa038817f8c09a465d695becb8bf813e79d Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 16:10:07 -0500 Subject: [PATCH 030/148] doc: use :abbr: Signed-off-by: Quentin Young --- doc/user/isisd.rst | 12 +-- doc/user/ospf_fundamentals.rst | 162 ++++++++++++++++----------------- doc/user/ospfd.rst | 16 ++-- doc/user/ripd.rst | 2 +- doc/user/rpki.rst | 4 +- doc/user/snmp.rst | 2 +- doc/user/vnc.rst | 20 ++-- 7 files changed, 109 insertions(+), 109 deletions(-) diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 7da4379f4c..648e849ee2 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -4,12 +4,12 @@ ISIS **** -@acronym{ISIS,Intermediate System to Intermediate System} is a routing protocol +:abbr:`ISIS (Intermediate System to Intermediate System)` is a routing protocol which is described in @cite{ISO10589, RFC1195, RFC5308}. ISIS is an -@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, -@acronym{ISIS} can provide scalable network support and faster -convergence times like @acronym{OSPF}. ISIS is widely used in large networks such as -@acronym{ISP,Internet Service Provider} and carrier backbone networks. +:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`, +:abbr:`ISIS` can provide scalable network support and faster +convergence times like :abbr:`OSPF`. ISIS is widely used in large networks such as +:abbr:`ISP (Internet Service Provider)` and carrier backbone networks. .. _Configuring_isisd: @@ -23,7 +23,7 @@ specified (:ref:`Common_Invocation_Options`) to *isisd*. running before invoking *isisd*. Also, if *zebra* is restarted then *isisd* must be too. -Like other daemons, *isisd* configuration is done in @acronym{ISIS} +Like other daemons, *isisd* configuration is done in :abbr:`ISIS` specific configuration file :file:`isisd.conf`. .. _ISIS_router: diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index 6fa0ee176b..a9df639b22 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -7,9 +7,9 @@ OSPF Fundamentals .. index:: Distance-vector routing protocol -@acronym{OSPF} is, mostly, a link-state routing protocol. In contrast -to :term:`distance-vector` protocols, such as @acronym{RIP} or -@acronym{BGP}, where routers describe available :term:`paths` (i.e@. routes) +:abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast +to :term:`distance-vector` protocols, such as :abbr:`RIP` or +:abbr:`BGP`, where routers describe available :term:`paths` (i.e@. routes) to each other, in :term:`link-state` protocols routers instead describe the state of their links to their immediate neighbouring routers. @@ -23,14 +23,14 @@ routers. .. index:: Link State DataBase Each router describes their link-state information in a message known -as an @acronym{LSA,Link State Advertisement}, which is then propogated +as an :abbr:`LSA (Link State Advertisement)`, which is then propogated through to all other routers in a link-state routing domain, by a process called :term:`flooding`. Each router thus builds up an -@acronym{LSDB,Link State Database} of all the link-state messages. From +:abbr:`LSDB (Link State Database)` of all the link-state messages. From this collection of LSAs in the LSDB, each router can then calculate the shortest path to any other router, based on some common metric, by using an algorithm such as @url{http://www.cs.utexas.edu/users/EWD/, -Edgser Dijkstra}'s @acronym{SPF,Shortest Path First}. +Edgser Dijkstra}'s :abbr:`SPF (Shortest Path First)`. .. index:: Link-state routing protocol advantages @@ -53,17 +53,17 @@ other than (potentially) select between multiple routes. This overhead is mostly negligible for modern embedded CPUs, even for networks with thousands of nodes. The primary scaling overhead lies more in coping with the ever greater frequency of LSA updates as the size of a -link-state area increases, in managing the @acronym{LSDB} and required +link-state area increases, in managing the :abbr:`LSDB` and required flooding. This section aims to give a distilled, but accurate, description of the -more important workings of @acronym{OSPF}@ which an administrator may need -to know to be able best configure and trouble-shoot @acronym{OSPF}@. +more important workings of :abbr:`OSPF`@ which an administrator may need +to know to be able best configure and trouble-shoot :abbr:`OSPF`@. OSPF Mechanisms --------------- -@acronym{OSPF} defines a range of mechanisms, concerned with detecting, +:abbr:`OSPF` defines a range of mechanisms, concerned with detecting, describing and propogating state through a network. These mechanisms will nearly all be covered in greater detail further on. They may be broadly classed as: @@ -79,7 +79,7 @@ broadly classed as: two-way reachability between routers on a link. OSPF can additionally avail of other sources of reachability information, such as link-state information provided by hardware, or through dedicated reachability - protocols such as @acronym{BFD,Bi-directional Forwarding Detection}. + protocols such as :abbr:`BFD (Bi-directional Forwarding Detection)`. OSPF also uses the Hello protocol to propagate certain state between routers sharing a link, for example: @@ -100,10 +100,10 @@ broadly classed as: *LSAs* - At the heart of @acronym{OSPF} are @acronym{LSA,Link State - Advertisement} messages. Despite the name, some @acronym{LSA}s do not, - strictly speaking, describe link-state information. Common - @acronym{LSA}s describe information such as: + At the heart of :abbr:`OSPF` are :abbr:`LSA (Link State Advertisement)` + messages. Despite the name, some :abbr:`LSA`s do not, strictly speaking, + describe link-state information. Common :abbr:`LSA`s describe information + such as: ** @@ -117,21 +117,21 @@ broadly classed as: *External Routes* - Routes entirely external to @acronym{OSPF}@. Routers originating such - routes are known as @acronym{ASBR,Autonomous-System Border Router} + Routes entirely external to :abbr:`OSPF`@. Routers originating such + routes are known as :abbr:`ASBR (Autonomous-System Border Router)` routers. *Summary Routes* Routes which summarise routing information relating to OSPF areas external to the OSPF link-state area at hand, originated by - @acronym{ABR,Area Boundary Router} routers. + :abbr:`ABR (Area Boundary Router)` routers. *LSA Flooding* OSPF defines several related mechanisms, used to manage synchronisation of - @acronym{LSDB}s between neighbours as neighbours form adjacencies and - the propogation, or :term:`flooding` of new or updated @acronym{LSA}s. + :abbr:`LSDB`s between neighbours as neighbours form adjacencies and + the propogation, or :term:`flooding` of new or updated :abbr:`LSA`s. :ref:`OSPF_Flooding`. @@ -141,11 +141,11 @@ broadly classed as: *Areas* OSPF provides for the protocol to be broken up into multiple smaller and independent link-state areas. Each area must be connected to a - common backbone area by an @acronym{ABR,Area Boundary Router}. These - @acronym{ABR} routers are responsible for summarising the link-state + common backbone area by an :abbr:`ABR (Area Boundary Router)`. These + :abbr:`ABR` routers are responsible for summarising the link-state routing information of an area into :term:`Summary LSAs`, possibly in a condensed (i.e. aggregated) form, and then originating these summaries - into all other areas the @acronym{ABR} is connected to. + into all other areas the :abbr:`ABR` is connected to. Note that only summaries and external routes are passed between areas. As these describe *paths*, rather than any router link-states, @@ -157,16 +157,16 @@ broadly classed as: OSPF LSAs --------- -@acronym{LSA}s are the core object in OSPF@. Everything else in OSPF +:abbr:`LSA`s are the core object in OSPF@. Everything else in OSPF revolves around detecting what to describe in LSAs, when to update them, how to flood them throughout a network and how to calculate routes from them. -There are a variety of different @acronym{LSA}s, for purposes such +There are a variety of different :abbr:`LSA`s, for purposes such as describing actual link-state information, describing paths (i.e. routes), describing bandwidth usage of links for -@acronym{TE,Traffic Engineering} purposes, and even arbitrary data -by way of *Opaque* @acronym{LSA}s. +:abbr:`TE (Traffic Engineering)` purposes, and even arbitrary data +by way of *Opaque* :abbr:`LSA`s. LSA Header ^^^^^^^^^^ @@ -175,8 +175,8 @@ All LSAs share a common header with the following information: * Type - Different types of @acronym{LSA}s describe different things in - @acronym{OSPF}@. Types include: + Different types of :abbr:`LSA`s describe different things in + :abbr:`OSPF`@. Types include: * Router LSA * Network LSA @@ -194,18 +194,18 @@ All LSAs share a common header with the following information: The ID of the LSA, which is typically derived in some way from the information the LSA describes, e.g. a Router LSA uses the Router ID as - the LSA ID, a Network LSA will have the IP address of the @acronym{DR} + the LSA ID, a Network LSA will have the IP address of the :abbr:`DR` as its LSA ID@. The combination of the Type, ID and Advertising Router ID must uniquely - identify the @acronym{LSA}@. There can however be multiple instances of + identify the :abbr:`LSA`@. There can however be multiple instances of an LSA with the same Type, LSA ID and Advertising Router ID, see :ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`. * Age - A number to allow stale @acronym{LSA}s to, eventually, be purged by routers - from their @acronym{LSDB}s. + A number to allow stale :abbr:`LSA`s to, eventually, be purged by routers + from their :abbr:`LSDB`s. The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is called the :term:`MaxAge`. MaxAge LSAs are ignored in routing @@ -229,9 +229,9 @@ All LSAs share a common header with the following information: Link-State LSAs ^^^^^^^^^^^^^^^ -Of all the various kinds of @acronym{LSA}s, just two types comprise the -actual link-state part of @acronym{OSPF}, Router @acronym{LSA}s and -Network @acronym{LSA}s. These LSA types are absolutely core to the +Of all the various kinds of :abbr:`LSA`s, just two types comprise the +actual link-state part of :abbr:`OSPF`, Router :abbr:`LSA`s and +Network :abbr:`LSA`s. These LSA types are absolutely core to the protocol. Instances of these LSAs are specific to the link-state area in which @@ -240,8 +240,8 @@ called :term:`intra-area routes`. * Router LSA - Each OSPF Router must originate a router @acronym{LSA} to describe - itself. In it, the router lists each of its @acronym{OSPF} enabled + Each OSPF Router must originate a router :abbr:`LSA` to describe + itself. In it, the router lists each of its :abbr:`OSPF` enabled interfaces, for the given link-state area, in terms of: * Cost @@ -256,10 +256,10 @@ called :term:`intra-area routes`. A link to a multi-access network, on which the router has at least one Full adjacency with another router. - * @acronym{PtP,Point-to-Point} + * :abbr:`PtP (Point-to-Point)` A link to a single remote router, with a Full adjacency. No - @acronym{DR, Designated Router} is elected on such links; no network + :abbr:`DR (Designated Router)` is elected on such links; no network LSA is originated for such a link. * Stub @@ -274,13 +274,13 @@ called :term:`intra-area routes`. @headitem Link Type @tab Link ID @tab Link Data * Transit - @tab Link IP address of the @acronym{DR} + @tab Link IP address of the :abbr:`DR` @tab Interface IP address * Point-to-Point @tab Router ID of the remote router @tab Local interface IP address, - or the @acronym{ifindex,MIB-II interface index} + or the :abbr:`ifindex (MIB-II interface index)` for unnumbered links * Stub @@ -290,9 +290,9 @@ called :term:`intra-area routes`. @end multitable Links on a router may be listed multiple times in the Router LSA, e.g. - a @acronym{PtP} interface on which OSPF is enabled must *always* - be described by a Stub link in the Router @acronym{LSA}, in addition to - being listed as PtP link in the Router @acronym{LSA} if the adjacency + a :abbr:`PtP` interface on which OSPF is enabled must *always* + be described by a Stub link in the Router :abbr:`LSA`, in addition to + being listed as PtP link in the Router :abbr:`LSA` if the adjacency with the remote router is Full. Stub links may also be used as a way to describe links on which OSPF is @@ -301,25 +301,25 @@ called :term:`intra-area routes`. * Network LSA On multi-access links (e.g. ethernets, certain kinds of ATM and X@.25 - configurations), routers elect a @acronym{DR}@. The @acronym{DR} is - responsible for originating a Network @acronym{LSA}, which helps reduce + configurations), routers elect a :abbr:`DR`@. The :abbr:`DR` is + responsible for originating a Network :abbr:`LSA`, which helps reduce the information needed to describe multi-access networks with multiple - routers attached. The @acronym{DR} also acts as a hub for the flooding of - @acronym{LSA}s on that link, thus reducing flooding overheads. + routers attached. The :abbr:`DR` also acts as a hub for the flooding of + :abbr:`LSA`s on that link, thus reducing flooding overheads. The contents of the Network LSA describes the: * Subnet Mask - As the @acronym{LSA} ID of a Network LSA must be the IP address of the - @acronym{DR}, the Subnet Mask together with the @acronym{LSA} ID gives + As the :abbr:`LSA` ID of a Network LSA must be the IP address of the + :abbr:`DR`, the Subnet Mask together with the :abbr:`LSA` ID gives you the network address. * Attached Routers - Each router fully-adjacent with the @acronym{DR} is listed in the LSA, - by their Router-ID. This allows the corresponding Router @acronym{LSA}s to be - easily retrieved from the @acronym{LSDB}@. + Each router fully-adjacent with the :abbr:`DR` is listed in the LSA, + by their Router-ID. This allows the corresponding Router :abbr:`LSA`s to be + easily retrieved from the :abbr:`LSDB`@. Summary of Link State LSAs: @@ -328,28 +328,28 @@ Summary of Link State LSAs: * Router LSA @tab The Router ID -@tab The @acronym{OSPF} enabled links of the router, within +@tab The :abbr:`OSPF` enabled links of the router, within a specific link-state area. * Network LSA -@tab The IP address of the @acronym{DR} for the network +@tab The IP address of the :abbr:`DR` for the network @tab The Subnet Mask of the network, and the Router IDs of all routers on the network. @end multitable -With an LSDB composed of just these two types of @acronym{LSA}, it is +With an LSDB composed of just these two types of :abbr:`LSA`, it is possible to construct a directed graph of the connectivity between all routers and networks in a given OSPF link-state area. So, not surprisingly, when OSPF routers build updated routing tables, the first -stage of @acronym{SPF} calculation concerns itself only with these two +stage of :abbr:`SPF` calculation concerns itself only with these two LSA types. Link-State LSA Examples ^^^^^^^^^^^^^^^^^^^^^^^ The example below (:ref:`OSPF_Link-State_LSA_Example`) shows two -@acronym{LSA}s, both originated by the same router (Router ID -192.168.0.49) and with the same @acronym{LSA} ID (192.168.0.49), but of +:abbr:`LSA`s, both originated by the same router (Router ID +192.168.0.49) and with the same :abbr:`LSA` ID (192.168.0.49), but of different LSA types. The first LSA being the router LSA describing 192.168.0.49's links: 2 links @@ -357,7 +357,7 @@ to multi-access networks with fully-adjacent neighbours (i.e. Transit links) and 1 being a Stub link (no adjacent neighbours). The second LSA being a Network LSA, for which 192.168.0.49 is the -@acronym{DR}, listing the Router IDs of 4 routers on that network which +:abbr:`DR`, listing the Router IDs of 4 routers on that network which are fully adjacent with 192.168.0.49. .. _OSPF_Link-State_LSA_Example: @@ -423,19 +423,19 @@ are fully adjacent with 192.168.0.49. Note that from one LSA, you can find the other. E.g. Given the Network-LSA you have a list of Router IDs on that network, from which -you can then look up, in the local @acronym{LSDB}, the matching Router +you can then look up, in the local :abbr:`LSDB`, the matching Router LSA@. From that Router-LSA you may (potentially) find links to other Transit networks and Routers IDs which can be used to lookup the corresponding Router or Network LSA@. And in that fashion, one can find -all the Routers and Networks reachable from that starting @acronym{LSA}@. +all the Routers and Networks reachable from that starting :abbr:`LSA`@. Given the Router LSA instead, you have the IP address of the -@acronym{DR} of any attached transit links. Network LSAs will have that IP +:abbr:`DR` of any attached transit links. Network LSAs will have that IP as their LSA ID, so you can then look up that Network LSA and from that find all the attached routers on that link, leading potentially to more links and Network and Router LSAs, etc. etc. -From just the above two @acronym{LSA}s, one can already see the +From just the above two :abbr:`LSA`s, one can already see the following partial topology: :: @@ -469,33 +469,33 @@ reachable addresses (though, OSPF will calculate routes to Router IDs). External LSAs ^^^^^^^^^^^^^ -External, or "Type 5", @acronym{LSA}s describe routing information which is -entirely external to @acronym{OSPF}, and is "injected" into -@acronym{OSPF}@. Such routing information may have come from another +External, or "Type 5", :abbr:`LSA`s describe routing information which is +entirely external to :abbr:`OSPF`, and is "injected" into +:abbr:`OSPF`@. Such routing information may have come from another routing protocol, such as RIP or BGP, they may represent static routes or they may represent a default route. -An @acronym{OSPF} router which originates External @acronym{LSA}s is known as an -@acronym{ASBR,AS Boundary Router}. Unlike the link-state @acronym{LSA}s, and -most other @acronym{LSA}s, which are flooded only within the area in -which they originate, External @acronym{LSA}s are flooded through-out -the @acronym{OSPF} network to all areas capable of carrying External -@acronym{LSA}s (:ref:`OSPF_Areas`). +An :abbr:`OSPF` router which originates External :abbr:`LSA`s is known as an +:abbr:`ASBR (AS Boundary Router)`. Unlike the link-state :abbr:`LSA`s, and +most other :abbr:`LSA`s, which are flooded only within the area in +which they originate, External :abbr:`LSA`s are flooded through-out +the :abbr:`OSPF` network to all areas capable of carrying External +:abbr:`LSA`s (:ref:`OSPF_Areas`). Routes internal to OSPF (intra-area or inter-area) are always preferred over external routes. -The External @acronym{LSA} describes the following: +The External :abbr:`LSA` describes the following: * IP Network number - The IP Network number of the route is described by the @acronym{LSA} ID + The IP Network number of the route is described by the :abbr:`LSA` ID field. * IP Network Mask The body of the External LSA describes the IP Network Mask of the - route. This, together with the @acronym{LSA} ID, describes the prefix + route. This, together with the :abbr:`LSA` ID, describes the prefix of the IP route concerned. * Metric @@ -511,7 +511,7 @@ The External @acronym{LSA} describes the following: The address of the router to forward packets to for the route. This may be, and usually is, left as 0 to specify that the ASBR originating the - External @acronym{LSA} should be used. There must be an internal OSPF + External :abbr:`LSA` should be used. There must be an internal OSPF route to the forwarding address, for the forwarding address to be useable. @@ -523,8 +523,8 @@ The External @acronym{LSA} describes the following: AS External LSA Example ^^^^^^^^^^^^^^^^^^^^^^^ -To illustrate, below is an example of an External @acronym{LSA} in the -@acronym{LSDB} of an OSPF router. It describes a route to the IP prefix +To illustrate, below is an example of an External :abbr:`LSA` in the +:abbr:`LSDB` of an OSPF router. It describes a route to the IP prefix of 192.168.165.0/24, originated by the ASBR with Router-ID 192.168.0.49. The metric of 20 is external to OSPF. The forwarding address is 0, so the route should forward to the originating ASBR if @@ -579,7 +579,7 @@ like: Summary LSAs ^^^^^^^^^^^^ -Summary LSAs are created by @acronym{ABR}s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or @acronym{ASBR} routers. +Summary LSAs are created by :abbr:`ABR`s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or :abbr:`ASBR` routers. .. _OSPF_Flooding: diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index db02caefed..f2ba1fc6a0 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -4,12 +4,12 @@ OSPFv2 ****** -@acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol +:abbr:`OSPF (Open Shortest Path First)` version 2 is a routing protocol which is described in :rfc:`2328`. OSPF is an -@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, -@acronym{OSPF} can provide scalable network support and faster +:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`, +:abbr:`OSPF` can provide scalable network support and faster convergence times. OSPF is widely used in large networks such as -@acronym{ISP,Internet Service Provider} backbone and enterprise +:abbr:`ISP (Internet Service Provider)` backbone and enterprise networks. @include ospf_fundamentals.texi @@ -26,7 +26,7 @@ specified (:ref:`Common_Invocation_Options`) to *ospfd*. running before invoking *ospfd*. Also, if *zebra* is restarted then *ospfd* must be too. -Like other daemons, *ospfd* configuration is done in @acronym{OSPF} +Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` specific configuration file :file:`ospfd.conf`. .. _OSPF_router: @@ -92,7 +92,7 @@ Command {no router ospf} {} be found in @cite{RFC 3509, Alternative Implementations of OSPF Area Border Routers}, and @cite{draft-ietf-ospf-shortcut-abr-02.txt}. - Quote: "Though the definition of the @acronym{ABR,Area Border Router} + Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` in the OSPF specification does not require a router with multiple attached areas to have a backbone connection, it is actually necessary to provide successful routing to the inter-area and @@ -136,7 +136,7 @@ Command {no router ospf} {} Do not speak OSPF interface on the given interface, but do advertise the interface as a stub link in the - router-@acronym{LSA,Link State Advertisement} for this router. This + router-:abbr:`LSA (Link State Advertisement)` for this router. This allows one to advertise addresses on such connected interfaces without having to originate AS-External/Type-5 LSAs (which have global flooding scope) - as would occur if connected addresses were redistributed into @@ -1129,7 +1129,7 @@ A simple example, with MD5 authentication enabled: area 0.0.0.1 authentication message-digest -An @acronym{ABR} router, with MD5 authentication and performing summarisation +An :abbr:`ABR` router, with MD5 authentication and performing summarisation of networks between the areas: :: diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index f81ddad32a..505ac92514 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -531,7 +531,7 @@ RIP Authentication RIPv2 allows packets to be authenticated via either an insecure plain text password, included with the packet, or via a more secure MD5 based -@acronym{HMAC, keyed-Hashing for Message AuthentiCation}, +:abbr:`HMAC (keyed-Hashing for Message AuthentiCation)`, RIPv1 can not be authenticated at all, thus when authentication is configured `ripd` will discard routing updates received via RIPv1 packets. diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index d8a0055ac3..c4970fa9c9 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -6,10 +6,10 @@ Prefix Origin Validation Using RPKI Prefix Origin Validation allows BGP routers to verify if the origin AS of an IP prefix is legitimate to announce this IP prefix. The required attestation objects are stored in the Resource Public Key Infrastructure -(@acronym{RPKI}). However, RPKI-enabled routers do not store cryptographic +(:abbr:`RPKI`). However, RPKI-enabled routers do not store cryptographic data itself but only validation information. The validation of the cryptographic data (so called Route Origin Authorization, or short -@acronym{ROA}, objects) will be performed by trusted cache servers. The +:abbr:`ROA`, objects) will be performed by trusted cache servers. The RPKI/RTR protocol defines a standard mechanism to maintain the exchange of the prefix/origin AS mapping between the cache server and routers. In combination with a BGP Prefix Origin Validation scheme a router is able diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 26775743fe..5d60ade981 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -4,7 +4,7 @@ SNMP Support ************ -@acronym{SNMP,Simple Network Managing Protocol} is a widely implemented +:abbr:`SNMP (Simple Network Managing Protocol)` is a widely implemented feature for collecting network information from router and/or host. FRR itself does not support SNMP agent (server daemon) functionality but is able to connect to a SNMP agent using the SMUX protocol diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index c76b736225..8f675310bf 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -5,15 +5,15 @@ VNC and VNC-GW ************** This chapter describes how to use -Virtual Network Control (@acronym{VNC}) services, -including Network Virtualization Authority (@acronym{NVA}) and -VNC Gateway (@acronym{VNC-GW}) functions. +Virtual Network Control (:abbr:`VNC`) services, +including Network Virtualization Authority (:abbr:`NVA`) and +VNC Gateway (:abbr:`VNC-GW`) functions. Background information on NVAs, -Network Virtualization Edges (@acronym{NVE}s), underlay networks (@acronym{UN}s), -and virtual networks (@acronym{VN}s) is available from the -`https://datatracker.ietf.org/wg/nvo3,IETF Network Virtualization Overlays (@acronym{NVO3 `_) Working Group}. -VNC Gateways (@acronym{VNC-GW}s) support the import/export of routing -information between VNC and customer edge routers (@acronym{CE}s) +Network Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s), +and virtual networks (:abbr:`VN`s) is available from the +`IETF Network Virtualization Overlays `_ +VNC Gateways (:abbr:`VNC-GW`s) support the import/export of routing +information between VNC and customer edge routers (:abbr:`CE`s) operating within a VN. Both IP/Layer 3 (L3) VNs, and IP with Ethernet/Layer 2 (L2) VNs are supported. @@ -41,7 +41,7 @@ The chapter also provides sample configurations for basic example scenarios. Configuring VNC =============== -Virtual Network Control (@acronym{VNC}) service configuration commands +Virtual Network Control (:abbr:`VNC`) service configuration commands appear in the `router bgp` section of the BGPD configuration file (:ref:`BGP_Configuration_Examples`). The commands are broken down into the following areas: @@ -60,7 +60,7 @@ registered NVEs and overrides default parameters. `Redistribution` and `Export` control VNC-GW operation, i.e., the import/export of routing -information between VNC and customer edge routers (@acronym{CE}s) +information between VNC and customer edge routers (:abbr:`CE`s) operating within a VN. .. _General_VNC_Configuration: From a8c90e154fd60b45f8efe99443a82e867169a59c Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 16:11:41 -0500 Subject: [PATCH 031/148] doc: strip trailing whitespace Signed-off-by: Quentin Young --- doc/user/defines.rst | 4 +- doc/user/filter.rst | 8 +-- doc/user/index.rst | 2 +- doc/user/isisd.rst | 6 +- doc/user/kernel.rst | 4 +- doc/user/nhrpd.rst | 10 ++-- doc/user/ospf6d.rst | 4 +- doc/user/ospf_fundamentals.rst | 30 +++++----- doc/user/ospfd.rst | 44 +++++++------- doc/user/protocol.rst | 2 +- doc/user/ripd.rst | 28 ++++----- doc/user/ripngd.rst | 2 +- doc/user/routemap.rst | 4 +- doc/user/rpki.rst | 4 +- doc/user/snmp.rst | 20 +++---- doc/user/snmptrap.rst | 6 +- doc/user/vnc.rst | 104 ++++++++++++++++----------------- doc/user/zebra.rst | 22 +++---- 18 files changed, 152 insertions(+), 152 deletions(-) diff --git a/doc/user/defines.rst b/doc/user/defines.rst index e8c779d3a0..69766d3da4 100644 --- a/doc/user/defines.rst +++ b/doc/user/defines.rst @@ -3,7 +3,7 @@ That, in turn, needs to be generated by make at compile time. @c -*- texinfo -*- @c doc/defines.texi. Generated from defines.texi.in by configure. - + @c Set variables @set PACKAGE_NAME frr @set PACKAGE_TARNAME frr @@ -13,7 +13,7 @@ @set AUTHORS Kunihiro Ishiguro, et al. @set COPYRIGHT_YEAR 1999-2005 @set COPYRIGHT_STR Copyright @copyright{} |COPYRIGHT_YEAR| |AUTHORS| - + @c These may vary with installation environment. @set INSTALL_PREFIX_ETC /etc/frr @set INSTALL_PREFIX_SBIN /usr/lib/frr diff --git a/doc/user/filter.rst b/doc/user/filter.rst index 730e42403a..73ffba8f36 100644 --- a/doc/user/filter.rst +++ b/doc/user/filter.rst @@ -25,7 +25,7 @@ IP Access List access-list filter deny 10.0.0.0/9 access-list filter permit 10.0.0.0/8 - + @comment node-name, next, previous, up @@ -38,7 +38,7 @@ filtering mechanism. In addition to *access-list* functionality, sequential number specification. You can add or delete prefix based filters to arbitrary points of prefix-list using sequential number specification. -If no ip prefix-list is specified, it acts as permit. If *ip prefix-list* +If no ip prefix-list is specified, it acts as permit. If *ip prefix-list* is defined, and no match is found, default deny is applied. .. index:: {Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {} @@ -66,12 +66,12 @@ is defined, and no match is found, default deny is applied. *@asis{le}* - *le* command specifies prefix length. The prefix list will be + *le* command specifies prefix length. The prefix list will be applied if the prefix length is less than or equal to the le prefix length. *@asis{ge}* - *ge* command specifies prefix length. The prefix list will be + *ge* command specifies prefix length. The prefix list will be applied if the prefix length is greater than or equal to the ge prefix length. diff --git a/doc/user/index.rst b/doc/user/index.rst index 0d705d10ad..2e4636ec8c 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -7,7 +7,7 @@ Welcome to FRR's documentation! overview installation basic - zebra + zebra ripd ripngd ospfd diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 648e849ee2..83d7af55b0 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -563,7 +563,7 @@ A simple example, with MD5 authentication enabled: net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 metric-style wide is-type level-2-only - + A Traffic Engineering configuration, with Inter-ASv2 support. @@ -607,7 +607,7 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te link unrsv-bw 7 1.25e+06 mpls-te link rsc-clsclr 0xab mpls-te neighbor 10.1.1.2 as 65000 - + - Then the 'isisd.conf' itself: @@ -631,5 +631,5 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te router-address 10.1.1.1 ! line vty - + diff --git a/doc/user/kernel.rst b/doc/user/kernel.rst index a11b3ef167..4611277dec 100644 --- a/doc/user/kernel.rst +++ b/doc/user/kernel.rst @@ -40,8 +40,8 @@ interfaces. communication between kernel and FRR possible, similar to a routing socket on BSD systems. - Before you use this feature, be sure to select (in kernel configuration) - the kernel/netlink support option 'Kernel/User network link driver' and + Before you use this feature, be sure to select (in kernel configuration) + the kernel/netlink support option 'Kernel/User network link driver' and 'Routing messages'. Today, the /dev/route special device file is obsolete. Netlink diff --git a/doc/user/nhrpd.rst b/doc/user/nhrpd.rst index ae8a986192..ba6011b44a 100644 --- a/doc/user/nhrpd.rst +++ b/doc/user/nhrpd.rst @@ -38,7 +38,7 @@ commands): ip tunnel add gre1 mode gre key 42 ttl 64 ip addr add 10.255.255.2/32 dev gre1 ip link set gre1 up - + Note that the IP-address is assigned as host prefix to gre1. nhrpd will automatically create additional host routes pointing to gre1 when @@ -62,7 +62,7 @@ command defines the GRE subnet): network 172.16.0.0/16 redistribute nhrp exit-address-family - + .. _Configuring_NHRP: @@ -91,7 +91,7 @@ This can be achieved with the following iptables rule. -m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \\ --hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \\ --hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128 - + You can fine tune the src/dstmask according to the prefix lengths you announce internal, add additional IP range matches, or rate limitation @@ -102,7 +102,7 @@ with: :: nhrp nflog-group 1 - + To start sending these traffic notices out from hubs, use the nhrp per-interface directive: @@ -110,7 +110,7 @@ per-interface directive: interface gre1 ip nhrp redirect - + .. _Integration_with_IKE: diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index 4fbf5c0dd1..651849d466 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -56,7 +56,7 @@ OSPF6 router router ospf6 timers throttle spf 200 400 10000 - + In this example, the `delay` is set to 200ms, the @var{initial holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence @@ -200,5 +200,5 @@ Example of ospf6d configured on one interface and area: area 0.0.0.0 range 2001:770:105:2::/64 interface eth0 area 0.0.0.0 ! - + diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index a9df639b22..8651ad0287 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -9,7 +9,7 @@ OSPF Fundamentals :abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast to :term:`distance-vector` protocols, such as :abbr:`RIP` or -:abbr:`BGP`, where routers describe available :term:`paths` (i.e@. routes) +:abbr:`BGP`, where routers describe available :term:`paths` (i.e@. routes) to each other, in :term:`link-state` protocols routers instead describe the state of their links to their immediate neighbouring routers. @@ -96,7 +96,7 @@ broadly classed as: The Hello protocol is comparatively trivial and will not be explored in greater detail than here. - .. index:: OSPF LSA overview + .. index:: OSPF LSA overview *LSAs* @@ -160,11 +160,11 @@ OSPF LSAs :abbr:`LSA`s are the core object in OSPF@. Everything else in OSPF revolves around detecting what to describe in LSAs, when to update them, how to flood them throughout a network and how to calculate -routes from them. +routes from them. There are a variety of different :abbr:`LSA`s, for purposes such as describing actual link-state information, describing paths (i.e. -routes), describing bandwidth usage of links for +routes), describing bandwidth usage of links for :abbr:`TE (Traffic Engineering)` purposes, and even arbitrary data by way of *Opaque* :abbr:`LSA`s. @@ -232,7 +232,7 @@ Link-State LSAs Of all the various kinds of :abbr:`LSA`s, just two types comprise the actual link-state part of :abbr:`OSPF`, Router :abbr:`LSA`s and Network :abbr:`LSA`s. These LSA types are absolutely core to the -protocol. +protocol. Instances of these LSAs are specific to the link-state area in which they are originated. Routes calculated from these two LSA types are @@ -280,7 +280,7 @@ called :term:`intra-area routes`. * Point-to-Point @tab Router ID of the remote router @tab Local interface IP address, - or the :abbr:`ifindex (MIB-II interface index)` + or the :abbr:`ifindex (MIB-II interface index)` for unnumbered links * Stub @@ -327,7 +327,7 @@ Summary of Link State LSAs: @headitem LSA Type @tab LSA ID Describes @tab LSA Data Describes * Router LSA -@tab The Router ID +@tab The Router ID @tab The :abbr:`OSPF` enabled links of the router, within a specific link-state area. @@ -372,10 +372,10 @@ are fully adjacent with 192.168.0.49. LS age: 38 Options: 0x2 : *|-|-|-|-|-|E|* - LS Flags: 0x6 + LS Flags: 0x6 Flags: 0x2 : ASBR LS Type: router-LSA - Link State ID: 192.168.0.49 + Link State ID: 192.168.0.49 Advertising Router: 192.168.0.49 LS Seq Number: 80000f90 Checksum: 0x518b @@ -407,7 +407,7 @@ are fully adjacent with 192.168.0.49. LS age: 285 Options: 0x2 : *|-|-|-|-|-|E|* - LS Flags: 0x6 + LS Flags: 0x6 LS Type: network-LSA Link State ID: 192.168.0.49 (address of Designated Router) Advertising Router: 192.168.0.49 @@ -419,7 +419,7 @@ are fully adjacent with 192.168.0.49. Attached Router: 192.168.0.52 Attached Router: 192.168.0.53 Attached Router: 192.168.0.54 - + Note that from one LSA, you can find the other. E.g. Given the Network-LSA you have a list of Router IDs on that network, from which @@ -460,7 +460,7 @@ following partial topology: | Router ID: 192.168.0.53 | Router ID: 192.168.0.52 - + Note the Router IDs, though they look like IP addresses and often are IP addresses, are not strictly speaking IP addresses, nor need they be @@ -548,7 +548,7 @@ selected. Metric: 20 Forward Address: 0.0.0.0 External Route Tag: 0 - + We can add this to our partial topology from above, which now looks like: @@ -574,12 +574,12 @@ like: | Router ID: 192.168.0.53 | Router ID: 192.168.0.52 - + Summary LSAs ^^^^^^^^^^^^ -Summary LSAs are created by :abbr:`ABR`s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or :abbr:`ASBR` routers. +Summary LSAs are created by :abbr:`ABR`s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or :abbr:`ASBR` routers. .. _OSPF_Flooding: diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index f2ba1fc6a0..da46905e8a 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -165,16 +165,16 @@ Command {no router ospf} {} Events which occur within the holdtime of the previous SPF calculation will cause the holdtime to be increased by `initial-holdtime`, bounded by the `maximum-holdtime` configured with this command. If the adaptive - hold-time elapses without any SPF-triggering event occuring then + hold-time elapses without any SPF-triggering event occuring then the current holdtime is reset to the `initial-holdtime`. The current - holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as + holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as a multiplier of the `initial-holdtime`. :: router ospf timers throttle spf 200 400 10000 - + In this example, the `delay` is set to 200ms, the @var{initial holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence @@ -205,14 +205,14 @@ Command {no router ospf} {} This support may be enabled administratively (and indefinitely) or conditionally. Conditional enabling of max-metric router-lsas can be for a period of seconds after startup and/or for a period of seconds - prior to shutdown. + prior to shutdown. Enabling this for a period after startup allows OSPF to converge fully first without affecting any existing routes used by other routers, while still allowing any connected stub links and/or redistributed routes to be reachable. Enabling this for a period of time in advance of shutdown allows the router to gracefully excuse itself from the OSPF - domain. + domain. Enabling this feature administratively allows for administrative intervention for whatever reason, for an indefinite period of time. @@ -266,7 +266,7 @@ Command {no router ospf} {} router ospf network 192.168.1.0/24 area 0.0.0.0 - + Prefix length in interface must be equal or bigger (ie. smaller network) than prefix length in network statement. For example statement above doesn't enable @@ -278,7 +278,7 @@ Command {no router ospf} {} Currently, if a peer prefix has been configured, then we test whether the prefix in the network command contains the destination prefix. Otherwise, we test whether the network command prefix - contains the local address prefix of the interface. + contains the local address prefix of the interface. In some cases it may be more convenient to enable OSPF on a per interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`). @@ -313,7 +313,7 @@ OSPF area network 192.168.1.0/24 area 0.0.0.0 network 10.0.0.0/8 area 0.0.0.10 area 0.0.0.10 range 10.0.0.0/8 - + With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is announced into backbone area if area 0.0.0.10 contains at least one intra-area @@ -343,7 +343,7 @@ OSPF area network 192.168.1.0/24 area 0.0.0.0 network 10.0.0.0/8 area 0.0.0.10 area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 - + One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or @@ -392,7 +392,7 @@ OSPF area {OSPF Command} {no area (0-4294967295) stub} {} Configure the area to be a stub area. That is, an area where no router - originates routes external to OSPF and hence an area where all external + originates routes external to OSPF and hence an area where all external routes are via the ABR(s). Hence, ABRs for such an area do not need to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the area. They need only pass Network-Summary (type-3) LSAs into such an area, @@ -410,7 +410,7 @@ OSPF area .. index:: {OSPF Command} {no area (0-4294967295) stub no-summary} {} {OSPF Command} {no area (0-4294967295) stub no-summary} {} - Prevents an *ospfd* ABR from injecting inter-area + Prevents an *ospfd* ABR from injecting inter-area summaries into the specified stub area. .. index:: {OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {} @@ -445,7 +445,7 @@ OSPF area ! access-list foo permit 10.10.0.0/16 access-list foo deny any - + With example above any intra-area paths from area 0.0.0.10 and from range 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into @@ -533,7 +533,7 @@ OSPF area OSPF interface ============== -.. index:: {Interface Command} {ip ospf area `AREA` [`ADDR`]} {} +.. index:: {Interface Command} {ip ospf area `AREA` [`ADDR`]} {} {Interface Command} {ip ospf area `AREA` [`ADDR`]} {} .. index:: {Interface Command} {no ip ospf area [`ADDR`]} {} @@ -588,7 +588,7 @@ OSPF interface .. _ip_ospf_message-digest-key: Set OSPF authentication key to a - cryptographic password. The cryptographic algorithm is MD5. + cryptographic password. The cryptographic algorithm is MD5. KEYID identifies secret key used to create the message digest. This ID is part of the protocol and must be consistent across routers on a @@ -627,7 +627,7 @@ OSPF interface specifies how many Hellos to send per second, from 2 (every 500ms) to 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form is specified, then the hello-interval advertised in Hello packets is set to - 0 and the hello-interval on received Hello packets is not checked, thus + 0 and the hello-interval on received Hello packets is not checked, thus the hello-multiplier need NOT be the same across multiple routers on a common link. @@ -642,7 +642,7 @@ OSPF interface This value must be the same for all routers attached to a common network. The default value is 10 seconds. - This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also + This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also specified for the interface. .. index:: {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} @@ -680,7 +680,7 @@ OSPF interface .. index:: {Interface Command} {no ip ospf transmit-delay} {} {Interface Command} {no ip ospf transmit-delay} {} - Set number of seconds for InfTransDelay value. LSAs' age should be + Set number of seconds for InfTransDelay value. LSAs' age should be incremented by this value when transmitting. The default value is 1 seconds. @@ -1127,7 +1127,7 @@ A simple example, with MD5 authentication enabled: router ospf network 192.168.0.0/16 area 0.0.0.1 area 0.0.0.1 authentication message-digest - + An :abbr:`ABR` router, with MD5 authentication and performing summarisation of networks between the areas: @@ -1162,7 +1162,7 @@ of networks between the areas: area 0.0.0.1 authentication message-digest area 0.0.0.1 range 10.2.0.0/16 ! - + A Traffic Engineering configuration, with Inter-ASv2 support. @@ -1206,7 +1206,7 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te link unrsv-bw 7 1.25e+06 mpls-te link rsc-clsclr 0xab mpls-te neighbor 192.168.2.2 as 65000 - + - Then the 'ospfd.conf' itself: @@ -1235,7 +1235,7 @@ A Traffic Engineering configuration, with Inter-ASv2 support. mpls-te inter-as area 1 ! line vty - + A router information example with PCE advsertisement: @@ -1256,5 +1256,5 @@ A router information example with PCE advsertisement: pce neighbor as 65200 pce scope 0x80 ! - + diff --git a/doc/user/protocol.rst b/doc/user/protocol.rst index 2dce4c9855..475b9c69b2 100644 --- a/doc/user/protocol.rst +++ b/doc/user/protocol.rst @@ -93,7 +93,7 @@ Zebra Protocol Commands @multitable {ZEBRA_REDISTRIBUTE_DEFAULT_DELETE_WHATEVER} {99999} @headitem Command @tab Value -@item ZEBRA_INTERFACE_ADD +@item ZEBRA_INTERFACE_ADD @tab 1 @item ZEBRA_INTERFACE_DELETE @tab 2 diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index 505ac92514..e28d215c6b 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -37,7 +37,7 @@ RIP is like below: # zebra -d # ripd -d - + Please note that *zebra* must be invoked before *ripd*. @@ -153,7 +153,7 @@ Command {no router rip} {} network 10.0.0.0/8 network eth0 ! - + Passive interface @@ -167,7 +167,7 @@ Command {no router rip} {} interface, all receiving packets are processed as normal and ripd does not send either multicast or unicast RIP packets except to RIP neighbors specified with `neighbor` command. The interface may be specified - as `default` to make ripd default to passive on all interfaces. + as `default` to make ripd default to passive on all interfaces. The default is to be passive on all interfaces. @@ -204,7 +204,7 @@ RIPv1 see :ref:`RIP_Authentication`. {RIP Command} {version `version`} {} Set RIP version to accept for reads and send. `version` - can be either `1'' or `2''. + can be either `1'' or `2''. Disabling RIPv1 by specifying version 2 is STRONGLY encouraged, :ref:`RIP_Authentication`. This may become the default in a future @@ -224,7 +224,7 @@ RIPv1 see :ref:`RIP_Authentication`. This interface command overrides the global rip version setting, and selects which version of RIP to send packets with, for this interface - specifically. Choice of RIP Version 1, RIP Version 2, or both versions. + specifically. Choice of RIP Version 1, RIP Version 2, or both versions. In the latter case, where `1 2' is specified, packets will be both broadcast and multicast. @@ -374,7 +374,7 @@ Command {distribute-list `access_list` `direct` `ifname`} {} access-list private permit 10 10.0.0.0/8 access-list private deny any ! - + `distribute-list` can be applied to both incoming and outgoing data. @@ -463,9 +463,9 @@ statement. redistribute static [route-map MAP_NAME] redistribute connected [route-map MAP_NAME] ..... - -Cisco applies route-map _before_ routes will exported to rip route table. + +Cisco applies route-map _before_ routes will exported to rip route table. In current FRR's test implementation, *ripd* applies route-map after routes are listed in the route table and before routes will be announced to an interface (something like output filter). I think it is not @@ -536,10 +536,10 @@ RIPv1 can not be authenticated at all, thus when authentication is configured `ripd` will discard routing updates received via RIPv1 packets. -However, unless RIPv1 reception is disabled entirely, +However, unless RIPv1 reception is disabled entirely, :ref:`RIP_Version_Control`, RIPv1 REQUEST packets which are received, which query the router for routing information, will still be honoured -by `ripd`, and `ripd` WILL reply to such packets. This allows +by `ripd`, and `ripd` WILL reply to such packets. This allows `ripd` to honour such REQUESTs (which sometimes is used by old equipment and very simple devices to bootstrap their default route), while still providing security for route updates which are received. @@ -596,7 +596,7 @@ To prevent such unauthenticated querying of routes disable RIPv1, ip rip authentication mode md5 ip rip authentication key-chain test ! - + .. _RIP_Timers: @@ -610,7 +610,7 @@ RIP Timers RIP protocol has several timers. User can configure those timers' values by `timers basic` command. - The default settings for the timers are as follows: + The default settings for the timers are as follows: `` @@ -674,7 +674,7 @@ Command {show ip rip status} {} Incoming update filter list for all interface is not set Default redistribution metric is 1 Redistributing: kernel connected - Default version control: send version 2, receive version 2 + Default version control: send version 2, receive version 2 Interface Send Recv Routing for Networks: eth0 @@ -683,7 +683,7 @@ Command {show ip rip status} {} 203.181.89.241 Routing Information Sources: Gateway BadPackets BadRoutes Distance Last Update - + RIP Debug Commands ================== diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst index 07ce7175fc..46b78eb197 100644 --- a/doc/user/ripngd.rst +++ b/doc/user/ripngd.rst @@ -89,5 +89,5 @@ Command {distribute-list `access_list` (in|out) `ifname`} {} :: distribute-list local-only out sit1 - + diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 75864b5edf..e0507bceed 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -222,7 +222,7 @@ Route Map Set Command .. index:: {Route-map Command} {set local-preference `local_pref`} {} {Route-map Command} {set local-preference `local_pref`} {} - Set the BGP local preference to `local_pref`. + Set the BGP local preference to `local_pref`. .. index:: {Route-map Command} {set weight `weight`} {} @@ -298,7 +298,7 @@ A simple example of a route-map: route-map test permit 10 match ip address 10 set local-preference 200 - + This means that if a route matches ip access-list number 10 it's local-preference value is set to 200. diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index c4970fa9c9..c1a62ea859 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -194,7 +194,7 @@ Validating BGP Updates route-map rpki permit 500 match rpki valid set local-preference 500 - + .. _Debugging: @@ -273,5 +273,5 @@ RPKI Configuration Example ! route-map rpki permit 40 ! - + diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 5d60ade981..a315cc127c 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -63,7 +63,7 @@ command will enable AgentX support. ! agentx ! - + Upon successful connection, you should get something like this in the log of each FRR daemons: @@ -71,7 +71,7 @@ log of each FRR daemons: :: 2012/05/25 11:39:08 ZEBRA: snmp[info]: NET-SNMP version 5.4.3 AgentX subagent connected - + Then, you can use the following command to check everything works as expected: @@ -80,7 +80,7 @@ Then, you can use the following command to check everything works as expected: # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 [...] - + The AgentX protocol can be transported over a Unix socket or using TCP or UDP. It usually defaults to a Unix socket and depends on how NetSNMP @@ -93,7 +93,7 @@ configure it through `/etc/snmp/frr.conf`: [snmpd] # Use a remote master agent agentXSocket tcp:192.168.15.12:705 - + .. _SMUX_configuration: @@ -134,20 +134,20 @@ restrictions can be hard to debug. ! smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd ! - + After restarting snmpd and frr, a successful connection can be verified in the syslog and by querying the SNMP daemon: :: - snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255 + snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255 snmpd[12300]: accepted smux peer: \\ oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5 # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 - + Be warned that the current version (5.1.1) of the Net-SNMP daemon writes a line for every SNMP connect to the syslog which can lead to enormous log file sizes. @@ -168,7 +168,7 @@ the FRR daemons with SMUX only. ripd .1.3.6.1.4.1.3317.1.2.3 .gnome.gnomeProducts.zebra.ripd ospfd .1.3.6.1.4.1.3317.1.2.5 .gnome.gnomeProducts.zebra.ospfd ospf6d .1.3.6.1.4.1.3317.1.2.6 .gnome.gnomeProducts.zebra.ospf6d - + Sadly, SNMP has not been implemented in all daemons yet. The following OID numbers are used for querying the SNMP daemon by a client: @@ -176,10 +176,10 @@ OID numbers are used for querying the SNMP daemon by a client: zebra .1.3.6.1.2.1.4.24 .iso.org.dot.internet.mgmt.mib-2.ip.ipForward ospfd .1.3.6.1.2.1.14 .iso.org.dot.internet.mgmt.mib-2.ospf - bgpd .1.3.6.1.2.1.15 .iso.org.dot.internet.mgmt.mib-2.bgp + bgpd .1.3.6.1.2.1.15 .iso.org.dot.internet.mgmt.mib-2.bgp ripd .1.3.6.1.2.1.23 .iso.org.dot.internet.mgmt.mib-2.rip2 ospf6d .1.3.6.1.3.102 .iso.org.dod.internet.experimental.ospfv3 - + The following syntax is understood by the FRR daemons for configuring SNMP using SMUX: .. index:: {Command} {smux peer `oid`} {} diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst index 7ca94ff325..dccff057db 100644 --- a/doc/user/snmptrap.rst +++ b/doc/user/snmptrap.rst @@ -16,7 +16,7 @@ your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: # send traps to the snmptrapd on localhost trapsink localhost - + This will send all traps to an snmptrapd running on localhost. You can of course also use a dedicated management station to catch traps. @@ -26,7 +26,7 @@ Configure the snmptrapd daemon by adding the following line to :: traphandle .1.3.6.1.4.1.3317.1.2.2 /etc/snmp/snmptrap_handle.sh - + This will use the bash script :file:`/etc/snmp/snmptrap_handle.sh` to handle the BGP4 traps. To add traps for other protocol daemons, lookup their @@ -111,7 +111,7 @@ case "$suberrorcode" in *) suberror="Unknown" ;; esac ;; -02) +02) error="OPEN Message Error" case "$suberrorcode" in 01) suberror="Unsupported Version Number" ;; diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 8f675310bf..78366713b6 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -6,11 +6,11 @@ VNC and VNC-GW This chapter describes how to use Virtual Network Control (:abbr:`VNC`) services, -including Network Virtualization Authority (:abbr:`NVA`) and +including Network Virtualization Authority (:abbr:`NVA`) and VNC Gateway (:abbr:`VNC-GW`) functions. -Background information on NVAs, +Background information on NVAs, Network Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s), -and virtual networks (:abbr:`VN`s) is available from the +and virtual networks (:abbr:`VN`s) is available from the `IETF Network Virtualization Overlays `_ VNC Gateways (:abbr:`VNC-GW`s) support the import/export of routing information between VNC and customer edge routers (:abbr:`CE`s) @@ -48,14 +48,14 @@ the following areas: `General VNC` configuration applies to general VNC operation and is primarily used to control the method used to advertise tunnel -information. +information. `Remote Forwarder Protocol (RFP)` configuration relates to the -protocol used between NVAs and NVEs. +protocol used between NVAs and NVEs. `VNC Defaults` provides default parameters for registered NVEs. -`VNC NVE Group` provides for configuration of a specific set of +`VNC NVE Group` provides for configuration of a specific set of registered NVEs and overrides default parameters. `Redistribution` and `Export` control VNC-GW operation, i.e., @@ -73,9 +73,9 @@ General VNC Configuration {VNC} {vnc advertise-un-method encap-safi|encap-attr} {} Advertise NVE underlay-network IP addresses using the encapsulation SAFI (`encap-safi`) or the UN address sub-TLV of the Tunnel Encapsulation attribute - (`encap-attr`). When `encap-safi` is used, neighbors under + (`encap-attr`). When `encap-safi` is used, neighbors under `address-family encap` and/or `address-family encapv6` must be - configured. The default is `encap-attr`. + configured. The default is `encap-attr`. .. _RFP_Related_Configuration: @@ -88,9 +88,9 @@ Remote Forwarder Protocol (RFP). Currently, only a simple example RFP is included in FRR. Developers may use this example as a starting point to integrate FRR with an RFP of their choosing, e.g., `OpenFlow`. The example code includes the following sample -configuration: +configuration: -.. index:: {RFP} {rfp example-config-value `VALUE`} +.. index:: {RFP} {rfp example-config-value `VALUE`} {RFP} {rfp example-config-value `VALUE`} This is a simple example configuration parameter included as part of the @@ -103,7 +103,7 @@ VNC Defaults Configuration The VNC Defaults section allows the user to specify default values for configuration parameters for all registered NVEs. -Default values are overridden by :ref:`VNC_NVE_Group_Configuration`. +Default values are overridden by :ref:`VNC_NVE_Group_Configuration`. .. index:: {VNC} {vnc defaults} {} @@ -116,7 +116,7 @@ Default values are overridden by :ref:`VNC_NVE_Group_Configuration`. vnc defaults ... various VNC defaults exit-vnc - + These are the statements that can appear between `vnc defaults` and `exit-vnc`. @@ -230,7 +230,7 @@ prefixes specified in the NVE Group definition. When an NVE Group definition specifies both VN and UN address prefixes, then an NVE must match both prefixes in order to be assigned to the NVE Group. In the event that multiple NVE Groups match based on VN and/or UN addresses, -the NVE is assigned to the first NVE Group listed in the configuration. +the NVE is assigned to the first NVE Group listed in the configuration. If an NVE is not assigned to an NVE Group, its messages will be ignored. Configuration values specified for an NVE group apply to all @@ -243,7 +243,7 @@ operation.} .. index:: {VNC} {vnc nve-group `name`} {} {VNC} {vnc nve-group `name`} {} - Enter VNC configuration mode for defining the NVE group `name`. + Enter VNC configuration mode for defining the NVE group `name`. Use `exit` or `exit-vnc` to exit group configuration mode. :: @@ -251,7 +251,7 @@ operation.} vnc nve-group group1 ... configuration commands exit-vnc - + .. index:: {VNC} {no vnc nve-group `name`} {} @@ -307,7 +307,7 @@ auto:vn:`two-byte-integer` Routes originated by NVEs in the NVE group will use the group's specified `route-distinguisher` when they are - advertised via BGP. + advertised via BGP. If the `auto` form is specified, it means that a matching NVE has its RD set to `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer`, @@ -359,7 +359,7 @@ auto:vn:`two-byte-integer` The first form, `rt export`, specifies an `export rt-list`. The `export rt-list` will be attached to routes originated by - NVEs in the NVE group when they are advertised via BGP. + NVEs in the NVE group when they are advertised via BGP. If the NVE group definition does not specify an `export rt-list`, then the default `export rt-list` is used. If neither a group nor a default `export rt-list` is configured, @@ -388,8 +388,8 @@ auto:vn:`two-byte-integer` {VNC} {export bgp|zebra route-map MAP-NAME} Specify that the named route-map should be applied to routes - being exported to bgp or zebra. - This paramter is used in conjunction with + being exported to bgp or zebra. + This paramter is used in conjunction with :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item is optional. @@ -397,8 +397,8 @@ auto:vn:`two-byte-integer` {VNC} {export bgp|zebra no route-map} Specify that no route-map should be applied to routes - being exported to bgp or zebra. - This paramter is used in conjunction with + being exported to bgp or zebra. + This paramter is used in conjunction with :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item is optional. @@ -407,8 +407,8 @@ auto:vn:`two-byte-integer` {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} Specify that the named prefix-list filter should be applied to routes being exported to bgp or zebra. - Prefix-lists for ipv4 and ipv6 are independent of each other. - This paramter is used in conjunction with + Prefix-lists for ipv4 and ipv6 are independent of each other. + This paramter is used in conjunction with :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item is optional. @@ -416,8 +416,8 @@ auto:vn:`two-byte-integer` {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} Specify that no prefix-list filter should be applied to - routes being exported to bgp or zebra. - This paramter is used in conjunction with + routes being exported to bgp or zebra. + This paramter is used in conjunction with :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item is optional. @@ -444,7 +444,7 @@ not impacted by L2 Group Configuration. .. index:: {VNC} {vnc l2-group `name`} {} {VNC} {vnc l2-group `name`} {} - Enter VNC configuration mode for defining the L2 group `name`. + Enter VNC configuration mode for defining the L2 group `name`. Use `exit` or `exit-vnc` to exit group configuration mode. :: @@ -452,7 +452,7 @@ not impacted by L2 Group Configuration. vnc l2-group group1 ... configuration commands exit-vnc - + .. index:: {VNC} {no vnc l2-group `name`} {} @@ -465,7 +465,7 @@ The following statements are valid in a L2 group definition: {VNC} {logical-network-id `VALUE`} Define the Logical Network Identifier with a value in the range of - 0-4294967295 that identifies the logical Ethernet segment. + 0-4294967295 that identifies the logical Ethernet segment. .. index:: {VNC} {labels `label-list`} @@ -537,16 +537,16 @@ In `plain` mode, the route's next hop is unchanged and the RD is set based on the next hop. For `bgp-direct` redistribution, the following translations are performed: -* +* The VN address is set to the original unicast route's next hop address. -* +* The UN address is NOT set. (VN->UN mapping will occur via ENCAP route or attribute, based on `vnc advertise-un-method` - setting, generated by the RFP registration of the actual NVE) -* + setting, generated by the RFP registration of the actual NVE) +* The RD is set to as if auto:vn:0 were specified (i.e., `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer=0`) -* +* The RT list is included in the extended community list copied from the original unicast route (i.e., it must be set in the original unicast route). @@ -555,17 +555,17 @@ if they came from an NVE in the nve-group designated in the `vnc redistribute nve-group` command. The following translations are performed: -* +* The next hop/VN address is set to the VN prefix configured for the redistribute nve-group. -* +* The UN address is set to the UN prefix configured for the redistribute nve-group. -* +* The RD is set to the RD configured for the redistribute nve-group. -* +* The RT list is set to the RT list configured for the redistribute nve-group. - If `bgp-direct` routes are being redistributed, + If `bgp-direct` routes are being redistributed, any extended communities present in the original unicast route will also be included. @@ -590,26 +590,26 @@ route, no corresponding VNC route will be imported. The following translations are applied: -* +* The Next Hop is set to the next hop of the NVE route (i.e., the VN address of the NVE). -* - The extended community list in the new route is set to the +* + The extended community list in the new route is set to the union of: - * + * Any extended communities in the original BGP route - * + * Any extended communities in the NVE route - * + * An added route-origin extended community with the next hop of the original BGP route is added to the new route. The value of the local administrator field defaults 5226 but may be configured by the user via the `roo-ec-local-admin` parameter. -* +* The Tunnel Encapsulation attribute is set to the value of the Tunnel Encapsulation attribute of the NVE route, if any. @@ -631,7 +631,7 @@ In order for a route in the unicast BGP RIB to be made available to a querying NVE, there must already be, available to that NVE, an (interior) VNC route matching the next hop address of the unicast route. -When the unicast route is provided to the NVE, its next hop +When the unicast route is provided to the NVE, its next hop is replaced by the next hop of the corresponding NVE. If there are multiple longest-prefix-match VNC routes, the unicast route will be replicated for each. @@ -692,13 +692,13 @@ Redistribution Command Syntax `infinite`, to prefixes redistributed from other routing protocols as if they had been received via RFP registration messages from an NVE. `lifetime` can be any integer between 1 and - 4294967295, inclusive. + 4294967295, inclusive. .. index:: {VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`} {VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`} Assign a value to the local-administrator subfield used in the - Route Origin extended community that is assigned to routes exported + Route Origin extended community that is assigned to routes exported under the `resolve-nve` mode. The default value is `5226`. The following four `prefix-list` and `route-map` commands @@ -884,7 +884,7 @@ information. preference of the forwarding information. If omitted, it defaults to 255. The `lifetime` parameter identifies the period, in seconds, that the information remains valid. If omitted, it defaults to - `infinite`. + `infinite`. .. index:: {Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} @@ -922,7 +922,7 @@ Other VNC-Related Commands Note: VNC-Related configuration can be obtained via the `show running-configuration` command when in `enable` mode. -The following commands are used to clear and display +The following commands are used to clear and display Virtual Network Control related information: .. index:: {COMMAND} {clear vnc counters} {} @@ -935,8 +935,8 @@ Virtual Network Control related information: .. index:: {Command} {show vnc summary} {} {Command} {show vnc summary} {} - Print counter values and other general information - about the NVA. Counter values can be reset + Print counter values and other general information + about the NVA. Counter values can be reset using the `clear vnc counters` command listed below. .. index:: {Command} {show vnc nves} {} diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index 3d448f6c8e..ab60857bca 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -233,7 +233,7 @@ Command {ip route `network` `gateway`} {} ip route 10.0.0.0/8 10.0.0.2 ip route 10.0.0.0/8 ppp0 ip route 10.0.0.0/8 null0 - + First example defines 10.0.0.0/8 static route with gateway 10.0.0.2. Second one defines the same prefix but with gateway to interface ppp0. The @@ -251,7 +251,7 @@ Command {ip route `network` `netmask` `gateway`} {} ip route 10.0.0.0 255.255.255.0 10.0.0.2 ip route 10.0.0.0 255.255.255.0 ppp0 ip route 10.0.0.0 255.255.255.0 null0 - + These statements are equivalent to those in the previous example. @@ -267,7 +267,7 @@ Multiple nexthop static route ip route 10.0.0.1/32 10.0.0.2 ip route 10.0.0.1/32 10.0.0.3 ip route 10.0.0.1/32 eth0 - + If there is no route to 10.0.0.2 and 10.0.0.3, and interface eth0 is reachable, then the last route is installed into the kernel. @@ -282,14 +282,14 @@ nexthops, if the platform supports this. S> 10.0.0.1/32 [1/0] via 10.0.0.2 inactive via 10.0.0.3 inactive * is directly connected, eth0 - + :: ip route 10.0.0.0/8 10.0.0.2 ip route 10.0.0.0/8 10.0.0.3 ip route 10.0.0.0/8 null0 255 - + This will install a multihop route via the specified next-hops if they are reachable, as well as a high-metric blackhole route, which can be useful to @@ -307,7 +307,7 @@ default) should the specified gateways not be reachable. Eg: Routing entry for 10.0.0.0/8 Known via "static", distance 255, metric 0 directly connected, Null0 - + .. index:: Command {ipv6 route `network` `gateway`} {} @@ -406,7 +406,7 @@ Command {show ip rpf `addr`} {} Routing entry for 192.0.2.0/24 using Unicast RIB Known via "kernel", distance 0, metric 0, best * 198.51.100.1, via eth0 - + Indicates that a multicast source lookup for 192.0.2.1 would use an Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1. @@ -473,7 +473,7 @@ Command {ip protocol `protocol` route-map `routemap`} {} set src 10.0.0.1 ip protocol rip route-map RM1 - + .. _zebra_FIB_push_interface: @@ -527,11 +527,11 @@ schema. Protobuf messages can be extended easily while maintaining backward-compatibility with older code. Protobuf has the following advantages over netlink: -* +* Code for serialization/deserialization is generated automatically. This reduces the likelihood of bugs, allows third-party programs to be integrated quickly, and makes it easy to add fields. -* +* The message format is not tied to an OS (Linux), and can be evolved independently. @@ -566,7 +566,7 @@ Command {show ip route} {} S 0.0.0.0/0 203.181.89.1 C* 127.0.0.0/8 lo C* 203.181.89.240/28 eth0 - + .. index:: Command {show ipv6 route} {} From ec8404d84bb2fd348ba5a5c48224245b60e7791e Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 17:09:25 -0500 Subject: [PATCH 032/148] doc: remove some more @stuff{} Signed-off-by: Quentin Young --- doc/user/appendix.rst | 20 +-- doc/user/isisd.rst | 8 +- doc/user/ospf_fundamentals.rst | 95 +++++------ doc/user/ospfd.rst | 3 +- doc/user/rpki.rst | 9 +- doc/user/snmp.rst | 3 +- doc/user/snmptrap.rst | 289 +++++++++++++++++---------------- doc/user/vnc.rst | 7 +- 8 files changed, 209 insertions(+), 225 deletions(-) diff --git a/doc/user/appendix.rst b/doc/user/appendix.rst index e2948312a3..2615123451 100644 --- a/doc/user/appendix.rst +++ b/doc/user/appendix.rst @@ -209,14 +209,14 @@ If 'type' is PROTOCOL_BGP4MP and 'subtype' is BGP4MP_SNAPSHOT:: The file specified in "File Name" contains all routing entries, which are in the format of ``subtype == BGP4MP_ENTRY``. -@example -Constants::: +:: + Constants: - /* type value */ - #define MSG_PROTOCOL_BGP4MP 16 - #define MSG_PROTOCOL_BGP4MP_ET 17 - /* subtype value */ - #define BGP4MP_STATE_CHANGE 0 - #define BGP4MP_MESSAGE 1 - #define BGP4MP_ENTRY 2 - #define BGP4MP_SNAPSHOT 3 + /* type value */ + #define MSG_PROTOCOL_BGP4MP 16 + #define MSG_PROTOCOL_BGP4MP_ET 17 + /* subtype value */ + #define BGP4MP_STATE_CHANGE 0 + #define BGP4MP_MESSAGE 1 + #define BGP4MP_ENTRY 2 + #define BGP4MP_SNAPSHOT 3 diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 83d7af55b0..7c2012687c 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -5,11 +5,11 @@ ISIS **** :abbr:`ISIS (Intermediate System to Intermediate System)` is a routing protocol -which is described in @cite{ISO10589, RFC1195, RFC5308}. ISIS is an +which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an :abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`, -:abbr:`ISIS` can provide scalable network support and faster -convergence times like :abbr:`OSPF`. ISIS is widely used in large networks such as -:abbr:`ISP (Internet Service Provider)` and carrier backbone networks. +:abbr:`ISIS` can provide scalable network support and faster convergence times +like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP +(Internet Service Provider)` and carrier backbone networks. .. _Configuring_isisd: diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index 8651ad0287..c91c2ac8ff 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -9,7 +9,7 @@ OSPF Fundamentals :abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast to :term:`distance-vector` protocols, such as :abbr:`RIP` or -:abbr:`BGP`, where routers describe available :term:`paths` (i.e@. routes) +:abbr:`BGP`, where routers describe available :term:`paths` (i.e. routes) to each other, in :term:`link-state` protocols routers instead describe the state of their links to their immediate neighbouring routers. @@ -28,9 +28,9 @@ through to all other routers in a link-state routing domain, by a process called :term:`flooding`. Each router thus builds up an :abbr:`LSDB (Link State Database)` of all the link-state messages. From this collection of LSAs in the LSDB, each router can then calculate the -shortest path to any other router, based on some common metric, by -using an algorithm such as @url{http://www.cs.utexas.edu/users/EWD/, -Edgser Dijkstra}'s :abbr:`SPF (Shortest Path First)`. +shortest path to any other router, based on some common metric, by using an +algorithm such as `Edgar Djikstra's `_ +:abbr:`SPF (Shortest Path First)` algorithm. .. index:: Link-state routing protocol advantages @@ -57,8 +57,8 @@ link-state area increases, in managing the :abbr:`LSDB` and required flooding. This section aims to give a distilled, but accurate, description of the -more important workings of :abbr:`OSPF`@ which an administrator may need -to know to be able best configure and trouble-shoot :abbr:`OSPF`@. +more important workings of :abbr:`OSPF` which an administrator may need +to know to be able best configure and trouble-shoot :abbr:`OSPF`. OSPF Mechanisms --------------- @@ -117,7 +117,7 @@ broadly classed as: *External Routes* - Routes entirely external to :abbr:`OSPF`@. Routers originating such + Routes entirely external to :abbr:`OSPF`. Routers originating such routes are known as :abbr:`ASBR (Autonomous-System Border Router)` routers. @@ -149,7 +149,7 @@ broadly classed as: Note that only summaries and external routes are passed between areas. As these describe *paths*, rather than any router link-states, - routing between areas hence is by :term:`distance-vector`, @strong{not} + routing between areas hence is by :term:`distance-vector`, **not** link-state. :ref:`OSPF_Areas`. @@ -157,7 +157,7 @@ broadly classed as: OSPF LSAs --------- -:abbr:`LSA`s are the core object in OSPF@. Everything else in OSPF +:abbr:`LSA`s are the core object in OSPF. Everything else in OSPF revolves around detecting what to describe in LSAs, when to update them, how to flood them throughout a network and how to calculate routes from them. @@ -176,7 +176,7 @@ All LSAs share a common header with the following information: * Type Different types of :abbr:`LSA`s describe different things in - :abbr:`OSPF`@. Types include: + :abbr:`OSPF`. Types include: * Router LSA * Network LSA @@ -195,10 +195,10 @@ All LSAs share a common header with the following information: The ID of the LSA, which is typically derived in some way from the information the LSA describes, e.g. a Router LSA uses the Router ID as the LSA ID, a Network LSA will have the IP address of the :abbr:`DR` - as its LSA ID@. + as its LSA ID. The combination of the Type, ID and Advertising Router ID must uniquely - identify the :abbr:`LSA`@. There can however be multiple instances of + identify the :abbr:`LSA`. There can however be multiple instances of an LSA with the same Type, LSA ID and Advertising Router ID, see :ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`. @@ -214,7 +214,7 @@ All LSAs share a common header with the following information: Routers may deliberately flood LSAs with the age artificially set to 3600 to indicate an LSA is no longer valid. This is called - :term:`flushing` of an LSA@. + :term:`flushing` of an LSA. It is not abnormal to see stale LSAs in the LSDB, this can occur where a router has shutdown without flushing its LSA(s), e.g. where it has @@ -270,24 +270,17 @@ called :term:`intra-area routes`. These values depend on the Link Type: - @multitable @columnfractions .18 .32 .32 - @headitem Link Type @tab Link ID @tab Link Data - - * Transit - @tab Link IP address of the :abbr:`DR` - @tab Interface IP address - - * Point-to-Point - @tab Router ID of the remote router - @tab Local interface IP address, - or the :abbr:`ifindex (MIB-II interface index)` - for unnumbered links - - * Stub - @tab IP address - @tab Subnet Mask - - @end multitable + +----------------+-----------------------------------+------------------------------------------+ + | Link Type | Link ID | Link Data | + +================+===================================+==========================================+ + | Transit | Link IP address of the :abbr:`DR` | Interface IP address | + +----------------+-----------------------------------+------------------------------------------+ + | Point-to-Point | Router ID of the remote router | Local interface IP address, or the | + | | | :abbr:`ifindex (MIB-II interface index)` | + | | | for unnumbered links | + +----------------+-----------------------------------+------------------------------------------+ + | Stub | IP address | Subnet Mask | + +----------------+-----------------------------------+------------------------------------------+ Links on a router may be listed multiple times in the Router LSA, e.g. a :abbr:`PtP` interface on which OSPF is enabled must *always* @@ -300,8 +293,8 @@ called :term:`intra-area routes`. * Network LSA - On multi-access links (e.g. ethernets, certain kinds of ATM and X@.25 - configurations), routers elect a :abbr:`DR`@. The :abbr:`DR` is + On multi-access links (e.g. ethernets, certain kinds of ATM and X.25 + configurations), routers elect a :abbr:`DR`. The :abbr:`DR` is responsible for originating a Network :abbr:`LSA`, which helps reduce the information needed to describe multi-access networks with multiple routers attached. The :abbr:`DR` also acts as a hub for the flooding of @@ -319,23 +312,19 @@ called :term:`intra-area routes`. Each router fully-adjacent with the :abbr:`DR` is listed in the LSA, by their Router-ID. This allows the corresponding Router :abbr:`LSA`s to be - easily retrieved from the :abbr:`LSDB`@. + easily retrieved from the :abbr:`LSDB`. Summary of Link State LSAs: -@multitable @columnfractions .18 .32 .40 -@headitem LSA Type @tab LSA ID Describes @tab LSA Data Describes - -* Router LSA -@tab The Router ID -@tab The :abbr:`OSPF` enabled links of the router, within -a specific link-state area. - -* Network LSA -@tab The IP address of the :abbr:`DR` for the network -@tab The Subnet Mask of the network, and the Router IDs of all routers -on the network. -@end multitable ++-------------+----------------------------+--------------------------------------------+ +| LSA Type | LSA ID | LSA Data Describes | ++=============+============================+============================================+ +| Router LSA | Router ID | The :abbr:`OSPF` enabled links of the | +| | | router, within a specific link-state area. | ++-------------+----------------------------+--------------------------------------------+ +| Network LSA | The IP address of the | The subet mask of the network and the | +| | :abbr:`DR` for the network | Router IDs of all routers on the network | ++-------------+----------------------------+--------------------------------------------+ With an LSDB composed of just these two types of :abbr:`LSA`, it is possible to construct a directed graph of the connectivity between all @@ -424,10 +413,10 @@ are fully adjacent with 192.168.0.49. Note that from one LSA, you can find the other. E.g. Given the Network-LSA you have a list of Router IDs on that network, from which you can then look up, in the local :abbr:`LSDB`, the matching Router -LSA@. From that Router-LSA you may (potentially) find links to other +LSA. From that Router-LSA you may (potentially) find links to other Transit networks and Routers IDs which can be used to lookup the -corresponding Router or Network LSA@. And in that fashion, one can find -all the Routers and Networks reachable from that starting :abbr:`LSA`@. +corresponding Router or Network LSA. And in that fashion, one can find +all the Routers and Networks reachable from that starting :abbr:`LSA`. Given the Router LSA instead, you have the IP address of the :abbr:`DR` of any attached transit links. Network LSAs will have that IP @@ -437,10 +426,10 @@ links and Network and Router LSAs, etc. etc. From just the above two :abbr:`LSA`s, one can already see the following partial topology: + :: - - --------------------- Network: ...... + ------------------------ Network: ...... | Designated Router IP: 192.168.1.3 | IP: 192.168.1.3 @@ -471,7 +460,7 @@ External LSAs External, or "Type 5", :abbr:`LSA`s describe routing information which is entirely external to :abbr:`OSPF`, and is "injected" into -:abbr:`OSPF`@. Such routing information may have come from another +:abbr:`OSPF`. Such routing information may have come from another routing protocol, such as RIP or BGP, they may represent static routes or they may represent a default route. diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index da46905e8a..b87f75e138 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -89,8 +89,7 @@ Command {no router ospf} {} hence are unaffected by this setting (:ref:`OSPF_virtual-link`). More information regarding the behaviour controlled by this command can - be found in @cite{RFC 3509, Alternative Implementations of OSPF Area - Border Routers}, and @cite{draft-ietf-ospf-shortcut-abr-02.txt}. + be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` in the OSPF specification does not require a router with multiple diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index c1a62ea859..59cae088a1 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -16,10 +16,9 @@ In combination with a BGP Prefix Origin Validation scheme a router is able to verify received BGP updates without suffering from cryptographic complexity. -The RPKI/RTR protocol is defined in @cite{RFC6810, The Resource Public Key -Infrastructure (RPKI) to Router Protocol}, and the validation scheme in -:rfc:`6811`. The current version of Prefix -Origin Validation in FRR implements both RFCs. +The RPKI/RTR protocol is defined in :rfc:`6810` and the validation scheme in +:rfc:`6811`. The current version of Prefix Origin Validation in FRR implements +both RFCs. For a more detailed but still easy-to-read background, we suggest the following two articles: @@ -174,7 +173,7 @@ Validating BGP Updates {Route Map Command} {no match rpki {notfound|invalid|valid}} {} Create a clause for a route map to match prefixes with the specified RPKI state. - @strong{Note} that the matching of invalid prefixes requires that invalid + **Note** that the matching of invalid prefixes requires that invalid prefixes are considered for best path selection, i.e., @command{bgp bestpath prefix-validate disallow-invalid} is not enabled. diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index a315cc127c..9b82cf2967 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -203,5 +203,4 @@ The following syntax is understood by the FRR daemons for configuring SNMP using {Command} {no agentx} {} - @include snmptrap.texi - +.. include:: snmptrap.rst diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst index dccff057db..28cc5fceca 100644 --- a/doc/user/snmptrap.rst +++ b/doc/user/snmptrap.rst @@ -7,15 +7,17 @@ correctly as described in the frr documentation in :ref:`SNMP_Support`. The BGP4 mib will send traps on peer up/down events. These should be visible in your snmp logs with a message similar to: -.. clicmd:: snmpd[13733]: Got trap from peer on fd 14 +:: + + snmpd[13733]: Got trap from peer on fd 14 To react on these traps they should be handled by a trapsink. Configure your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: :: - # send traps to the snmptrapd on localhost - trapsink localhost + # send traps to the snmptrapd on localhost + trapsink localhost This will send all traps to an snmptrapd running on localhost. You can @@ -25,7 +27,7 @@ Configure the snmptrapd daemon by adding the following line to :: - traphandle .1.3.6.1.4.1.3317.1.2.2 /etc/snmp/snmptrap_handle.sh + traphandle .1.3.6.1.4.1.3317.1.2.2 /etc/snmp/snmptrap_handle.sh This will use the bash script :file:`/etc/snmp/snmptrap_handle.sh` to handle @@ -40,161 +42,160 @@ The snmptrap_handle.sh script I personally use for handling BGP4 traps is below. You can of course do all sorts of things when handling traps, like sound a siren, have your display flash, etc., be creative ;). -@verbatim -#!/bin/bash +:: -# routers name -ROUTER=`hostname -s` + #!/bin/bash -#email address use to sent out notification -EMAILADDR="john@doe.com" -#email address used (allongside above) where warnings should be sent -EMAILADDR_WARN="sms-john@doe.com" + # routers name + ROUTER=`hostname -s` -# type of notification -TYPE="Notice" + #email address use to sent out notification + EMAILADDR="john@doe.com" + #email address used (allongside above) where warnings should be sent + EMAILADDR_WARN="sms-john@doe.com" -# local snmp community for getting AS belonging to peer -COMMUNITY="" + # type of notification + TYPE="Notice" -# if a peer address is in $WARN_PEERS a warning should be sent -WARN_PEERS="192.0.2.1" + # local snmp community for getting AS belonging to peer + COMMUNITY="" -# get stdin -INPUT=`cat -` + # if a peer address is in $WARN_PEERS a warning should be sent + WARN_PEERS="192.0.2.1" -# get some vars from stdin -uptime=`echo $INPUT | cut -d' ' -f5` -peer=`echo $INPUT | cut -d' ' -f8 | sed -e 's/SNMPv2-SMI::mib-2.15.3.1.14.//g'` -peerstate=`echo $INPUT | cut -d' ' -f13` -errorcode=`echo $INPUT | cut -d' ' -f9 | sed -e 's/\\"//g'` -suberrorcode=`echo $INPUT | cut -d' ' -f10 | sed -e 's/\\"//g'` -remoteas=`snmpget -v2c -c $COMMUNITY localhost SNMPv2-SMI::mib-2.15.3.1.9.$peer | cut -d' ' -f4` + # get stdin + INPUT=`cat -` -WHOISINFO=`whois -h whois.ripe.net " -r AS$remoteas" | egrep '(as-name|descr)'` -asname=`echo "$WHOISINFO" | grep "^as-name:" | sed -e 's/^as-name://g' -e 's/ //g' -e 's/^ //g' | uniq` -asdescr=`echo "$WHOISINFO" | grep "^descr:" | sed -e 's/^descr://g' -e 's/ //g' -e 's/^ //g' | uniq` + # get some vars from stdin + uptime=`echo $INPUT | cut -d' ' -f5` + peer=`echo $INPUT | cut -d' ' -f8 | sed -e 's/SNMPv2-SMI::mib-2.15.3.1.14.//g'` + peerstate=`echo $INPUT | cut -d' ' -f13` + errorcode=`echo $INPUT | cut -d' ' -f9 | sed -e 's/\\"//g'` + suberrorcode=`echo $INPUT | cut -d' ' -f10 | sed -e 's/\\"//g'` + remoteas=`snmpget -v2c -c $COMMUNITY localhost SNMPv2-SMI::mib-2.15.3.1.9.$peer | cut -d' ' -f4` -# if peer address is in $WARN_PEER, the email should also -# be sent to $EMAILADDR_WARN -for ip in $WARN_PEERS; do -if [ "x$ip" == "x$peer" ]; then -EMAILADDR="$EMAILADDR,$EMAILADDR_WARN" -TYPE="WARNING" -break -fi -done + WHOISINFO=`whois -h whois.ripe.net " -r AS$remoteas" | egrep '(as-name|descr)'` + asname=`echo "$WHOISINFO" | grep "^as-name:" | sed -e 's/^as-name://g' -e 's/ //g' -e 's/^ //g' | uniq` + asdescr=`echo "$WHOISINFO" | grep "^descr:" | sed -e 's/^descr://g' -e 's/ //g' -e 's/^ //g' | uniq` -# convert peer state -case "$peerstate" in -1) peerstate="Idle" ;; -2) peerstate="Connect" ;; -3) peerstate="Active" ;; -4) peerstate="Opensent" ;; -5) peerstate="Openconfirm" ;; -6) peerstate="Established" ;; -*) peerstate="Unknown" ;; -esac + # if peer address is in $WARN_PEER, the email should also + # be sent to $EMAILADDR_WARN + for ip in $WARN_PEERS; do + if [ "x$ip" == "x$peer" ]; then + EMAILADDR="$EMAILADDR,$EMAILADDR_WARN" + TYPE="WARNING" + break + fi + done -# get textual messages for errors -case "$errorcode" in -00) -error="No error" -suberror="" -;; -01) -error="Message Header Error" -case "$suberrorcode" in -01) suberror="Connection Not Synchronized" ;; -02) suberror="Bad Message Length" ;; -03) suberror="Bad Message Type" ;; -*) suberror="Unknown" ;; -esac -;; -02) -error="OPEN Message Error" -case "$suberrorcode" in -01) suberror="Unsupported Version Number" ;; -02) suberror="Bad Peer AS" ;; -03) suberror="Bad BGP Identifier" ;; -04) suberror="Unsupported Optional Parameter" ;; -05) suberror="Authentication Failure" ;; -06) suberror="Unacceptable Hold Time" ;; -*) suberror="Unknown" ;; -esac -;; -03) -error="UPDATE Message Error" -case "$suberrorcode" in -01) suberror="Malformed Attribute List" ;; -02) suberror="Unrecognized Well-known Attribute" ;; -03) suberror="Missing Well-known Attribute" ;; -04) suberror="Attribute Flags Error" ;; -05) suberror="Attribute Length Error" ;; -06) suberror="Invalid ORIGIN Attribute" ;; -07) suberror="AS Routing Loop" ;; -08) suberror="Invalid NEXT_HOP Attribute" ;; -09) suberror="Optional Attribute Error" ;; -10) suberror="Invalid Network Field" ;; -11) suberror="Malformed AS_PATH" ;; -*) suberror="Unknown" ;; -esac -;; -04) -error="Hold Timer Expired" -suberror="" -;; -05) -error="Finite State Machine Error" -suberror="" -;; -06) -error="Cease" -case "$suberrorcode" in -01) suberror="Maximum Number of Prefixes Reached" ;; -02) suberror="Administratively Shutdown" ;; -03) suberror="Peer Unconfigured" ;; -04) suberror="Administratively Reset" ;; -05) suberror="Connection Rejected" ;; -06) suberror="Other Configuration Change" ;; -07) suberror="Connection collision resolution" ;; -08) suberror="Out of Resource" ;; -09) suberror="MAX" ;; -*) suberror="Unknown" ;; -esac -;; -*) -error="Unknown" -suberror="" -;; -esac + # convert peer state + case "$peerstate" in + 1) peerstate="Idle" ;; + 2) peerstate="Connect" ;; + 3) peerstate="Active" ;; + 4) peerstate="Opensent" ;; + 5) peerstate="Openconfirm" ;; + 6) peerstate="Established" ;; + *) peerstate="Unknown" ;; + esac -# create textual message from errorcodes -if [ "x$suberror" == "x" ]; then -NOTIFY="$errorcode ($error)" -else -NOTIFY="$errorcode/$suberrorcode ($error/$suberror)" -fi + # get textual messages for errors + case "$errorcode" in + 00) + error="No error" + suberror="" + ;; + 01) + error="Message Header Error" + case "$suberrorcode" in + 01) suberror="Connection Not Synchronized" ;; + 02) suberror="Bad Message Length" ;; + 03) suberror="Bad Message Type" ;; + *) suberror="Unknown" ;; + esac + ;; + 02) + error="OPEN Message Error" + case "$suberrorcode" in + 01) suberror="Unsupported Version Number" ;; + 02) suberror="Bad Peer AS" ;; + 03) suberror="Bad BGP Identifier" ;; + 04) suberror="Unsupported Optional Parameter" ;; + 05) suberror="Authentication Failure" ;; + 06) suberror="Unacceptable Hold Time" ;; + *) suberror="Unknown" ;; + esac + ;; + 03) + error="UPDATE Message Error" + case "$suberrorcode" in + 01) suberror="Malformed Attribute List" ;; + 02) suberror="Unrecognized Well-known Attribute" ;; + 03) suberror="Missing Well-known Attribute" ;; + 04) suberror="Attribute Flags Error" ;; + 05) suberror="Attribute Length Error" ;; + 06) suberror="Invalid ORIGIN Attribute" ;; + 07) suberror="AS Routing Loop" ;; + 08) suberror="Invalid NEXT_HOP Attribute" ;; + 09) suberror="Optional Attribute Error" ;; + 10) suberror="Invalid Network Field" ;; + 11) suberror="Malformed AS_PATH" ;; + *) suberror="Unknown" ;; + esac + ;; + 04) + error="Hold Timer Expired" + suberror="" + ;; + 05) + error="Finite State Machine Error" + suberror="" + ;; + 06) + error="Cease" + case "$suberrorcode" in + 01) suberror="Maximum Number of Prefixes Reached" ;; + 02) suberror="Administratively Shutdown" ;; + 03) suberror="Peer Unconfigured" ;; + 04) suberror="Administratively Reset" ;; + 05) suberror="Connection Rejected" ;; + 06) suberror="Other Configuration Change" ;; + 07) suberror="Connection collision resolution" ;; + 08) suberror="Out of Resource" ;; + 09) suberror="MAX" ;; + *) suberror="Unknown" ;; + esac + ;; + *) + error="Unknown" + suberror="" + ;; + esac -# form a decent subject -SUBJECT="$TYPE: $ROUTER [bgp] $peer is $peerstate: $NOTIFY" -# create the email body -MAIL=`cat << EOF -BGP notification on router $ROUTER. + # create textual message from errorcodes + if [ "x$suberror" == "x" ]; then + NOTIFY="$errorcode ($error)" + else + NOTIFY="$errorcode/$suberrorcode ($error/$suberror)" + fi -Peer: $peer -AS: $remoteas -New state: $peerstate -Notification: $NOTIFY + # form a decent subject + SUBJECT="$TYPE: $ROUTER [bgp] $peer is $peerstate: $NOTIFY" + # create the email body + MAIL=`cat << EOF + BGP notification on router $ROUTER. -Info: -$asname -$asdescr + Peer: $peer + AS: $remoteas + New state: $peerstate + Notification: $NOTIFY -Snmpd uptime: $uptime -EOF` + Info: + $asname + $asdescr -# mail the notification -echo "$MAIL" | mail -s "$SUBJECT" $EMAILADDR -@end verbatim + Snmpd uptime: $uptime + EOF` + # mail the notification + echo "$MAIL" | mail -s "$SUBJECT" $EMAILADDR diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 78366713b6..2f87308e86 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -20,11 +20,8 @@ Ethernet/Layer 2 (L2) VNs are supported. BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN information between NVAs. BGP based IP VPN support is defined in :rfc:`4364`, and -@cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for -IPv6 VPN }. Both the Encapsulation Subsequent Address Family Identifier -(SAFI) and the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP -Encapsulation Subsequent Address Family Identifier (SAFI) and the BGP -Tunnel Encapsulation Attribute}, are supported. +:rfc:`4659`. Both the Encapsulation Subsequent Address Family Identifier +(SAFI) and the Tunnel Encapsulation Attribute, :rfc:`5512` are supported. The protocol that is used to communicate routing and Ethernet / Layer 2 (L2) forwarding information between NVAs and NVEs is referred to as the From 655cdc3233a09d602d4d0d3f1206e22c8ccba336 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 29 Jan 2018 10:46:35 -0500 Subject: [PATCH 033/148] doc: fixup routemap.rst Signed-off-by: Quentin Young --- doc/user/routemap.rst | 318 +++++++++++++++++++----------------------- 1 file changed, 142 insertions(+), 176 deletions(-) diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index e0507bceed..3a3afb99fd 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -1,211 +1,179 @@ .. _Route_Map: -********* -Route Map -********* +********** +Route Maps +********** -Route maps provide a means to both filter and/or apply actions to -route, hence allowing policy to be applied to routes. +Route maps provide a means to both filter and/or apply actions to route, hence +allowing policy to be applied to routes. -Route-maps are an ordered list of route-map entries. Each entry may -specify up to four distincts sets of clauses: +Route maps are an ordered list of route map entries. Each entry may specify up +to four distincts sets of clauses: +- :dfn:`Matching Policy` - -*Matching Policy* - This specifies the policy implied if the ``Matching Conditions`` are + This specifies the policy implied if the *Matching Conditions* are met or not met, and which actions of the route-map are to be taken, if any. The two possibilities are: + - :dfn:`permit`: If the entry matches, then carry out the :term:`Set + Actions`. Then finish processing the route-map, permitting the route, + unless an *Exit Action* indicates otherwise. -** - ``permit``: If the entry matches, then carry out the @samp{Set - Actions}. Then finish processing the route-map, permitting the route, - unless an ``Exit Action`` indicates otherwise. - - -** - ``deny``: If the entry matches, then finish processing the route-map and + - :dfn:`deny`: If the entry matches, then finish processing the route-map and deny the route (return ``deny``). - The ``Matching Policy`` is specified as part of the command which - defines the ordered entry in the route-map. See below. + The *Matching Policy* is specified as part of the command which + defines the ordered entry in the route-map. See below. +- :dfn:`Matching Conditions` -*Matching Conditions* - A route-map entry may, optionally, specify one or more conditions which - must be matched if the entry is to be considered further, as governed - by the Match Policy. If a route-map entry does not explicitely specify - any matching conditions, then it always matches. + A route-map entry may, optionally, specify one or more conditions which must + be matched if the entry is to be considered further, as governed by the Match + Policy. If a route-map entry does not explicitely specify any matching + conditions, then it always matches. +- :dfn:`Set Actions` -*Set Actions* - A route-map entry may, optionally, specify one or more @samp{Set - Actions} to set or modify attributes of the route. + A route-map entry may, optionally, specify one or more *Set Actions* to + set or modify attributes of the route. +- :dfn:`Call Action` -*Call Action* - Call to another route-map, after any ``Set Actions`` have been - carried out. If the route-map called returns ``deny`` then - processing of the route-map finishes and the route is denied, - regardless of the ``Matching Policy`` or the ``Exit Policy``. If - the called route-map returns ``permit``, then ``Matching Policy`` - and ``Exit Policy`` govern further behaviour, as normal. + Call to another route-map, after any *Set Actions* have been carried out. + If the route-map called returns *deny* then processing of the route-map + finishes and the route is denied, regardless of the *Matching Policy* or + the *Exit Policy*. If the called route-map returns *permit*, then + *Matching Policy* and *Exit Policy* govern further behaviour, as normal. +- :dfn:`Exit Policy` -*Exit Policy* - An entry may, optionally, specify an alternative ``Exit Policy`` to + An entry may, optionally, specify an alternative *Exit Policy* to take if the entry matched, rather than the normal policy of exiting the route-map and permitting the route. The two possibilities are: + - :dfn:`next`: Continue on with processing of the route-map entries. -** - ``next``: Continue on with processing of the route-map entries. - - -** - ``goto N``: Jump ahead to the first route-map entry whose order in + - :dfn:`goto N`: Jump ahead to the first route-map entry whose order in the route-map is >= N. Jumping to a previous entry is not permitted. -The default action of a route-map, if no entries match, is to deny. -I.e. a route-map essentially has as its last entry an empty ``deny`` -entry, which matches all routes. To change this behaviour, one must -specify an empty ``permit`` entry as the last entry in the route-map. +The default action of a route-map, if no entries match, is to deny. I.e. a +route-map essentially has as its last entry an empty *deny* entry, which +matches all routes. To change this behaviour, one must specify an empty +*permit* entry as the last entry in the route-map. To summarise the above: -@multitable {permit} {action} {No Match} -@headitem @tab Match @tab No Match -* *Permit* @tab action @tab cont -* *Deny* @tab deny @tab cont -@end multitable ++--------+--------+----------+ +| | Match | No Match | ++========+========+==========+ +| Permit | action | cont | ++--------+--------+----------+ +| Deny | deny | cont | ++--------+--------+----------+ +action + - Apply *set* statements + - If *call* is present, call given route-map. If that returns a ``deny``, + finish processing and return ``deny``. + - If *Exit Policy* is *next*, goto next route-map entry + - If *Exit Policy* is *goto*, goto first entry whose order in the + list is >= the given order. + - Finish processing the route-map and permit the route. +deny + The route is denied by the route-map (return ``deny``). -*action* - -** - Apply *set* statements - - -** - If *call* is present, call given route-map. If that returns a ``deny``, finish - processing and return ``deny``. - - -** - If ``Exit Policy`` is *next*, goto next route-map entry - - -** - If ``Exit Policy`` is *goto*, goto first entry whose order in the list - is >= the given order. - - -** - Finish processing the route-map and permit the route. - - -*deny* - -** - The route is denied by the route-map (return ``deny``). - - -*cont* - -** - goto next route-map entry +cont + goto next route-map entry .. _Route_Map_Command: Route Map Command ================= -.. index:: {Command} {route-map `route-map-name` (permit|deny) `order`} {} - -{Command} {route-map `route-map-name` (permit|deny) `order`} {} - - Configure the `order`'th entry in `route-map-name` with - ``Match Policy`` of either *permit* or *deny*. +.. index:: route-map ROUTE-MAP-NAME (permit|deny) ORDER +.. clicmd:: route-map ROUTE-MAP-NAME (permit|deny) ORDER + Configure the `order`'th entry in `route-map-name` with ``Match Policy`` of + either *permit* or *deny*. .. _Route_Map_Match_Command: Route Map Match Command ======================= -.. index:: {Route-map Command} {match ip address `access_list`} {} +.. index:: match ip address ACCESS_LIST +.. clicmd:: match ip address ACCESS_LIST -{Route-map Command} {match ip address `access_list`} {} - Matches the specified `access_list` + Matches the specified `access_list` -.. index:: {Route-map Command} {match ip address `prefix-list`} {} +.. index:: match ip address PREFIX-LIST +.. clicmd:: match ip address PREFIX-LIST -{Route-map Command} {match ip address `prefix-list`} {} - Matches the specified `prefix-list` + Matches the specified `prefix-list` -.. index:: {Route-map Command} {match ip address prefix-len `0-32`} {} +.. index:: match ip address prefix-len 0-32 +.. clicmd:: match ip address prefix-len 0-32 -{Route-map Command} {match ip address prefix-len `0-32`} {} - Matches the specified `prefix-len`. This is a Zebra specific command. + Matches the specified `prefix-len`. This is a Zebra specific command. -.. index:: {Route-map Command} {match ipv6 address `access_list`} {} +.. index:: match ipv6 address ACCESS_LIST +.. clicmd:: match ipv6 address ACCESS_LIST -{Route-map Command} {match ipv6 address `access_list`} {} - Matches the specified `access_list` + Matches the specified `access_list` -.. index:: {Route-map Command} {match ipv6 address `prefix-list`} {} +.. index:: match ipv6 address PREFIX-LIST +.. clicmd:: match ipv6 address PREFIX-LIST -{Route-map Command} {match ipv6 address `prefix-list`} {} - Matches the specified `prefix-list` + Matches the specified `prefix-list` -.. index:: {Route-map Command} {match ipv6 address prefix-len `0-128`} {} +.. index:: match ipv6 address prefix-len 0-128 +.. clicmd:: match ipv6 address prefix-len 0-128 -{Route-map Command} {match ipv6 address prefix-len `0-128`} {} - Matches the specified `prefix-len`. This is a Zebra specific command. + Matches the specified `prefix-len`. This is a Zebra specific command. -.. index:: {Route-map Command} {match ip next-hop `ipv4_addr`} {} +.. index:: match ip next-hop IPV4_ADDR +.. clicmd:: match ip next-hop IPV4_ADDR -{Route-map Command} {match ip next-hop `ipv4_addr`} {} - Matches the specified `ipv4_addr`. + Matches the specified `ipv4_addr`. -.. index:: {Route-map Command} {match aspath `as_path`} {} +.. index:: match aspath AS_PATH +.. clicmd:: match aspath AS_PATH -{Route-map Command} {match aspath `as_path`} {} - Matches the specified `as_path`. + Matches the specified `as_path`. -.. index:: {Route-map Command} {match metric `metric`} {} +.. index:: match metric METRIC +.. clicmd:: match metric METRIC -{Route-map Command} {match metric `metric`} {} - Matches the specified `metric`. + Matches the specified `metric`. -.. index:: {Route-map Command} {match local-preference `metric`} {} +.. index:: match local-preference METRIC +.. clicmd:: match local-preference METRIC -{Route-map Command} {match local-preference `metric`} {} - Matches the specified `local-preference`. + Matches the specified `local-preference`. -.. index:: {Route-map Command} {match community `community_list`} {} +.. index:: match community COMMUNITY_LIST +.. clicmd:: match community COMMUNITY_LIST -{Route-map Command} {match community `community_list`} {} - Matches the specified `community_list` + Matches the specified `community_list` -.. index:: {Route-map Command} {match peer `ipv4_addr`} {} +.. index:: match peer IPV4_ADDR +.. clicmd:: match peer IPV4_ADDR -{Route-map Command} {match peer `ipv4_addr`} {} - This is a BGP specific match command. Matches the peer ip address - if the neighbor was specified in this manner. + This is a BGP specific match command. Matches the peer ip address + if the neighbor was specified in this manner. -.. index:: {Route-map Command} {match peer `ipv6_addr`} {} +.. index:: match peer IPV6_ADDR +.. clicmd:: match peer IPV6_ADDR -{Route-map Command} {match peer `ipv6_addr`} {} - This is a BGP specific match command. Matches the peer ipv6 - address if the neighbor was specified in this manner. + This is a BGP specific match command. Matches the peer ipv6 + address if the neighbor was specified in this manner. -.. index:: {Route-map Command} {match peer `interface_name`} {} +.. index:: match peer INTERFACE_NAME +.. clicmd:: match peer INTERFACE_NAME -{Route-map Command} {match peer `interface_name`} {} - This is a BGP specific match command. Matches the peer + This is a BGP specific match command. Matches the peer interface name specified if the neighbor was specified in this manner. @@ -214,79 +182,77 @@ Route Map Match Command Route Map Set Command ===================== -.. index:: {Route-map Command} {set ip next-hop `ipv4_address`} {} +.. index:: set ip next-hop IPV4_ADDRESS +.. clicmd:: set ip next-hop IPV4_ADDRESS -{Route-map Command} {set ip next-hop `ipv4_address`} {} - Set the BGP nexthop address. + Set the BGP nexthop address. -.. index:: {Route-map Command} {set local-preference `local_pref`} {} +.. index:: set local-preference LOCAL_PREF +.. clicmd:: set local-preference LOCAL_PREF -{Route-map Command} {set local-preference `local_pref`} {} - Set the BGP local preference to `local_pref`. + Set the BGP local preference to `local_pref`. -.. index:: {Route-map Command} {set weight `weight`} {} +.. index:: set weight WEIGHT +.. clicmd:: set weight WEIGHT -{Route-map Command} {set weight `weight`} {} - Set the route's weight. + Set the route's weight. -.. index:: {Route-map Command} {set metric `metric`} {} +.. index:: set metric METRIC +.. clicmd:: set metric METRIC -{Route-map Command} {set metric `metric`} {} - .. _routemap_set_metric: + Set the BGP attribute MED. - Set the BGP attribute MED. +.. index:: set as-path prepend AS_PATH +.. clicmd:: set as-path prepend AS_PATH -.. index:: {Route-map Command} {set as-path prepend `as_path`} {} + Set the BGP AS path to prepend. -{Route-map Command} {set as-path prepend `as_path`} {} - Set the BGP AS path to prepend. +.. index:: set community COMMUNITY +.. clicmd:: set community COMMUNITY -.. index:: {Route-map Command} {set community `community`} {} + Set the BGP community attribute. -{Route-map Command} {set community `community`} {} - Set the BGP community attribute. +.. index:: set ipv6 next-hop global IPV6_ADDRESS +.. clicmd:: set ipv6 next-hop global IPV6_ADDRESS -.. index:: {Route-map Command} {set ipv6 next-hop global `ipv6_address`} {} + Set the BGP-4+ global IPv6 nexthop address. -{Route-map Command} {set ipv6 next-hop global `ipv6_address`} {} - Set the BGP-4+ global IPv6 nexthop address. +.. index:: set ipv6 next-hop local IPV6_ADDRESS +.. clicmd:: set ipv6 next-hop local IPV6_ADDRESS -.. index:: {Route-map Command} {set ipv6 next-hop local `ipv6_address`} {} - -{Route-map Command} {set ipv6 next-hop local `ipv6_address`} {} - Set the BGP-4+ link local IPv6 nexthop address. + Set the BGP-4+ link local IPv6 nexthop address. .. _Route_Map_Call_Command: Route Map Call Command ====================== -.. index:: {Route-map Command} {call `name`} {} +.. index:: call NAME +.. clicmd:: call NAME -{Route-map Command} {call `name`} {} - Call route-map `name`. If it returns deny, deny the route and - finish processing the route-map. + Call route-map `name`. If it returns deny, deny the route and + finish processing the route-map. .. _Route_Map_Exit_Action_Command: Route Map Exit Action Command ============================= -.. index:: {Route-map Command} {on-match next} {} +.. index:: on-match next +.. clicmd:: on-match next -{Route-map Command} {on-match next} {} -.. index:: {Route-map Command} {continue} {} +.. index:: continue +.. clicmd:: continue -{Route-map Command} {continue} {} - Proceed on to the next entry in the route-map. + Proceed on to the next entry in the route-map. -.. index:: {Route-map Command} {on-match goto `N`} {} +.. index:: on-match goto N +.. clicmd:: on-match goto N -{Route-map Command} {on-match goto `N`} {} -.. index:: {Route-map Command} {continue `N`} {} +.. index:: continue N +.. clicmd:: continue N -{Route-map Command} {continue `N`} {} - Proceed processing the route-map at the first entry whose order is >= N + Proceed processing the route-map at the first entry whose order is >= N Route Map Examples ================== From 50e75a2b82fc0d394fd51d153bf2f539db6e9755 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 29 Jan 2018 10:57:13 -0500 Subject: [PATCH 034/148] doc: cleanup kernel.rst Signed-off-by: Quentin Young --- doc/user/kernel.rst | 67 +++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 39 deletions(-) diff --git a/doc/user/kernel.rst b/doc/user/kernel.rst index 4611277dec..3020fd81d6 100644 --- a/doc/user/kernel.rst +++ b/doc/user/kernel.rst @@ -5,49 +5,38 @@ Kernel Interface **************** There are several different methods for reading kernel routing table -information, updating kernel routing tables, and for looking up -interfaces. +information, updating kernel routing tables, and for looking up interfaces. +- ioctl + This method is a very traditional way for reading or writing kernel + information. `ioctl` can be used for looking up interfaces and for + modifying interface addresses, flags, mtu settings and other types of + information. Also, `ioctl` can insert and delete kernel routing table + entries. It will soon be available on almost any platform which zebra + supports, but it is a little bit ugly thus far, so if a better method is + supported by the kernel, zebra will use that. +- sysctl + This is a program that can lookup kernel information using MIB (Management + Information Base) syntax. Normally, it only provides a way of getting + information from the kernel. So one would usually want to change kernel + information using another method such as `ioctl`. -*ioctl* - The ``ioctl`` method is a very traditional way for reading or writing - kernel information. ``ioctl`` can be used for looking up interfaces - and for modifying interface addresses, flags, mtu settings and other - types of information. Also, ``ioctl`` can insert and delete kernel - routing table entries. It will soon be available on almost any platform - which zebra supports, but it is a little bit ugly thus far, so if a - better method is supported by the kernel, zebra will use that. +- proc filesystem + This is a special filesystem mount that provides an easy way of getting + kernel information. +- routing socket / netlink + On recent Linux kernels (2.0.x and 2.2.x), there is a kernel/user + communication support called `netlink`. It makes asynchronous communication + between kernel and FRR possible, similar to a routing socket on BSD systems. -*sysctl* - ``sysctl`` can lookup kernel information using MIB (Management - Information Base) syntax. Normally, it only provides a way of getting - information from the kernel. So one would usually want to change kernel - information using another method such as ``ioctl``. + Before you use this feature, be sure to select (in kernel configuration) the + kernel/netlink support option 'Kernel/User network link driver' and 'Routing + messages'. + Today, the :file:`/dev/route` special device file is obsolete. Netlink + communication is done by reading/writing over netlink socket. -*proc filesystem* - ``proc filesystem`` provides an easy way of getting kernel - information. - - -*routing socket* - -*netlink* - On recent Linux kernels (2.0.x and 2.2.x), there is a kernel/user - communication support called `netlink`. It makes asynchronous - communication between kernel and FRR possible, similar to a routing - socket on BSD systems. - - Before you use this feature, be sure to select (in kernel configuration) - the kernel/netlink support option 'Kernel/User network link driver' and - 'Routing messages'. - - Today, the /dev/route special device file is obsolete. Netlink - communication is done by reading/writing over netlink socket. - - After the kernel configuration, please reconfigure and rebuild FRR. - You can use netlink as a dynamic routing update channel between FRR - and the kernel. - + After the kernel configuration, please reconfigure and rebuild FRR. You can + use netlink as a dynamic routing update channel between FRR and the kernel. From d1a242fdbf983c4902fe41bcd827f4ff9bd4deb7 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 29 Jan 2018 12:16:20 -0500 Subject: [PATCH 035/148] doc: cleanup multiple Signed-off-by: Quentin Young --- doc/user/babeld.rst | 212 ++++++------ doc/user/basic.rst | 171 +++++----- doc/user/installation.rst | 47 ++- doc/user/zebra.rst | 659 +++++++++++++++++++------------------- 4 files changed, 550 insertions(+), 539 deletions(-) diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst index 3e5c1b16b3..62ba8a26f2 100644 --- a/doc/user/babeld.rst +++ b/doc/user/babeld.rst @@ -4,14 +4,13 @@ Babel ***** -Babel is an interior gateway protocol that is suitable both for wired -networks and for wireless mesh networks. Babel has been described as -'RIP on speed' --- it is based on the same principles as RIP, but -includes a number of refinements that make it react much faster to -topology changes without ever counting to infinity, and allow it to -perform reliable link quality estimation on wireless links. Babel is -a double-stack routing protocol, meaning that a single Babel instance -is able to perform routing for both IPv4 and IPv6. +Babel is an interior gateway protocol that is suitable both for wired networks +and for wireless mesh networks. Babel has been described as 'RIP on speed' -- +it is based on the same principles as RIP, but includes a number of refinements +that make it react much faster to topology changes without ever counting to +infinity, and allow it to perform reliable link quality estimation on wireless +links. Babel is a double-stack routing protocol, meaning that a single Babel +instance is able to perform routing for both IPv4 and IPv6. FRR implements Babel as described in :rfc:`6126`. @@ -40,78 +39,86 @@ Babel configuration single: no router babel .. clicmd:: [no] router babel - Enable or disable Babel routing. + + Enable or disable Babel routing. .. index:: single: babel resend-delay (20-655340) single: no babel resend-delay [(20-655340)] .. clicmd:: [no] babel resend-delay (20-655340) - Specifies the time after which important messages are resent when - avoiding a black-hole. The default is 2000 ms. + + Specifies the time after which important messages are resent when + avoiding a black-hole. The default is 2000 ms. .. index:: single: babel diversity single: no babel diversity .. clicmd:: [no] babel diversity - Enable or disable routing using radio frequency diversity. This is - highly recommended in networks with many wireless nodes. - If you enable this, you will probably want to set `babel - diversity-factor` and `babel channel` below. + + Enable or disable routing using radio frequency diversity. This is + highly recommended in networks with many wireless nodes. + If you enable this, you will probably want to set `babel + diversity-factor` and `babel channel` below. .. index:: babel diversity-factor (1-256) .. clicmd:: babel diversity-factor (1-256) - Sets the multiplicative factor used for diversity routing, in units of - 1/256; lower values cause diversity to play a more important role in - route selection. The default it 256, which means that diversity plays - no role in route selection; you will probably want to set that to 128 - or less on nodes with multiple independent radios. + + Sets the multiplicative factor used for diversity routing, in units of + 1/256; lower values cause diversity to play a more important role in + route selection. The default it 256, which means that diversity plays + no role in route selection; you will probably want to set that to 128 + or less on nodes with multiple independent radios. .. index:: single: network IFNAME single: no network IFNAME .. clicmd:: no network IFNAME - Enable or disable Babel on the given interface. + + Enable or disable Babel on the given interface. .. index:: babel .. clicmd:: babel - Specifies whether this interface is wireless, which disables a number - of optimisations that are only correct on wired interfaces. - Specifying `wireless` (the default) is always correct, but may - cause slower convergence and extra routing traffic. + + Specifies whether this interface is wireless, which disables a number + of optimisations that are only correct on wired interfaces. + Specifying `wireless` (the default) is always correct, but may + cause slower convergence and extra routing traffic. .. index:: single: babel split-horizon single: no babel split-horizon .. clicmd:: [no] babel split-horizon - Specifies whether to perform split-horizon on the interface. Specifying - ``no babel split-horizon`` is always correct, while ``babel - split-horizon`` is an optimisation that should only be used on symmetric - and transitive (wired) networks. The default is ``babel split-horizon`` - on wired interfaces, and ``no babel split-horizon`` on wireless - interfaces. This flag is reset when the wired/wireless status of an - interface is changed. + + Specifies whether to perform split-horizon on the interface. Specifying + ``no babel split-horizon`` is always correct, while ``babel + split-horizon`` is an optimisation that should only be used on symmetric + and transitive (wired) networks. The default is ``babel split-horizon`` + on wired interfaces, and ``no babel split-horizon`` on wireless + interfaces. This flag is reset when the wired/wireless status of an + interface is changed. .. index:: babel hello-interval (20-655340) .. clicmd:: babel hello-interval (20-655340) - Specifies the time in milliseconds between two scheduled hellos. On - wired links, Babel notices a link failure within two hello intervals; - on wireless links, the link quality value is reestimated at every - hello interval. The default is 4000 ms. + + Specifies the time in milliseconds between two scheduled hellos. On + wired links, Babel notices a link failure within two hello intervals; + on wireless links, the link quality value is reestimated at every + hello interval. The default is 4000 ms. .. index:: babel update-interval (20-655340) .. clicmd:: babel update-interval (20-655340) - Specifies the time in milliseconds between two scheduled updates. - Since Babel makes extensive use of triggered updates, this can be set - to fairly high values on links with little packet loss. The default - is 20000 ms. + + Specifies the time in milliseconds between two scheduled updates. Since + Babel makes extensive use of triggered updates, this can be set to fairly + high values on links with little packet loss. The default is 20000 ms. .. index:: single: babel channel (1-254) @@ -119,86 +126,90 @@ Babel configuration single: babel channel noninterfering .. clicmd:: babel channel (1-254) - see below - .. clicmd:: babel channel interfering - see below - .. clicmd:: babel channel noninterfering - Set the channel number that diversity routing uses for this interface - (see `babel diversity` above). Noninterfering interfaces are - assumed to only interfere with themselves, interfering interfaces are - assumed to interfere with all other channels except noninterfering - channels, and interfaces with a channel number interfere with - interfering interfaces and interfaces with the same channel number. - The default is ``babel channel interfering`` for wireless - interfaces, and ``babel channel noninterfering`` for wired - interfaces. This is reset when the wired/wireless status of an - interface is changed. + + Set the channel number that diversity routing uses for this interface (see + `babel diversity` above). Noninterfering interfaces are assumed to only + interfere with themselves, interfering interfaces are assumed to interfere + with all other channels except noninterfering channels, and interfaces with + a channel number interfere with interfering interfaces and interfaces with + the same channel number. The default is ``babel channel interfering`` for + wireless interfaces, and ``babel channel noninterfering`` for wired + interfaces. This is reset when the wired/wireless status of an interface is + changed. .. index:: babel rxcost (1-65534) .. clicmd:: babel rxcost (1-65534) - Specifies the base receive cost for this interface. For wireless - interfaces, it specifies the multiplier used for computing the ETX - reception cost (default 256); for wired interfaces, it specifies the - cost that will be advertised to neighbours. This value is reset when - the wired/wireless attribute of the interface is changed. - Do not use this command unless you know what you are doing; in most - networks, acting directly on the cost using route maps is a better - technique. + Specifies the base receive cost for this interface. For wireless + interfaces, it specifies the multiplier used for computing the ETX + reception cost (default 256); for wired interfaces, it specifies the + cost that will be advertised to neighbours. This value is reset when + the wired/wireless attribute of the interface is changed. + +.. note:: + Do not use this command unless you know what you are doing; in most + networks, acting directly on the cost using route maps is a better + technique. .. index:: babel rtt-decay (1-256) .. clicmd:: babel rtt-decay (1-256) - This specifies the decay factor for the exponential moving average of - RTT samples, in units of 1/256. Higher values discard old samples - faster. The default is 42. + + This specifies the decay factor for the exponential moving average of + RTT samples, in units of 1/256. Higher values discard old samples + faster. The default is 42. .. index:: babel rtt-min (1-65535) .. clicmd:: babel rtt-min (1-65535) - This specifies the minimum RTT, in milliseconds, starting from which we - increase the cost to a neighbour. The additional cost is linear in - (rtt - rtt-min). The default is 100 ms. + + This specifies the minimum RTT, in milliseconds, starting from which we + increase the cost to a neighbour. The additional cost is linear in + (rtt - rtt-min). The default is 100 ms. .. index:: babel rtt-max (1-65535) .. clicmd:: babel rtt-max (1-65535) - This specifies the maximum RTT, in milliseconds, above which we don't - increase the cost to a neighbour. The default is 120 ms. + + This specifies the maximum RTT, in milliseconds, above which we don't + increase the cost to a neighbour. The default is 120 ms. .. index:: babel max-rtt-penalty (0-65535) .. clicmd:: babel max-rtt-penalty (0-65535) - This specifies the maximum cost added to a neighbour because of RTT, - i.e. when the RTT is higher or equal than rtt-max. The default is 0, - which effectively disables the use of a RTT-based cost. + + This specifies the maximum cost added to a neighbour because of RTT, i.e. + when the RTT is higher or equal than rtt-max. The default is 0, which + effectively disables the use of a RTT-based cost. .. index:: single: babel enable-timestamps single: no babel enable-timestamps .. clicmd:: [no] babel enable-timestamps - Enable or disable sending timestamps with each Hello and IHU message in - order to compute RTT values. The default is `no babel enable-timestamps`. + + Enable or disable sending timestamps with each Hello and IHU message in + order to compute RTT values. The default is `no babel enable-timestamps`. .. index:: babel resend-delay (20-655340) .. clicmd:: babel resend-delay (20-655340) - Specifies the time in milliseconds after which an 'important' - request or update will be resent. The default is 2000 ms. You - probably don't want to tweak this value. + + Specifies the time in milliseconds after which an 'important' request or + update will be resent. The default is 2000 ms. You probably don't want to + tweak this value. .. index:: babel smoothing-half-life (0-65534) .. clicmd:: babel smoothing-half-life (0-65534) - Specifies the time constant, in seconds, of the smoothing algorithm - used for implementing hysteresis. Larger values reduce route - oscillation at the cost of very slightly increasing convergence time. - The value 0 disables hysteresis, and is suitable for wired networks. - The default is 4 s. + + Specifies the time constant, in seconds, of the smoothing algorithm used for + implementing hysteresis. Larger values reduce route oscillation at the cost + of very slightly increasing convergence time. The value 0 disables + hysteresis, and is suitable for wired networks. The default is 4 s. .. _Babel_redistribution: @@ -210,7 +221,8 @@ Babel redistribution single: no redistribute KIND .. clicmd:: [no] redistribute KIND - Specify which kind of routes should be redistributed into Babel. + + Specify which kind of routes should be redistributed into Babel. .. _Show_Babel_information: @@ -222,47 +234,38 @@ These commands dump various parts of *babeld*'s internal state. .. index:: show babel route .. clicmd:: show babel route - *missing description* .. index:: show babel route A.B.C.D .. clicmd:: show babel route A.B.C.D - *missing description* .. index:: show babel route X:X::X:X .. clicmd:: show babel route X:X::X:X - *missing description* .. index:: show babel route A.B.C.D/M .. clicmd:: show babel route A.B.C.D/M - *missing description* .. index:: show babel route X:X::X:X/M .. clicmd:: show babel route X:X::X:X/M - *missing description* .. index:: show babel interface .. clicmd:: show babel interface - *missing description* -.. index:: show babel interface `IFNAME` +.. index:: show babel interface IFNAME .. clicmd:: show babel interface IFNAME - *missing description* .. index:: show babel neighbor .. clicmd:: show babel neighbor - *missing description* .. index:: show babel parameters .. clicmd:: show babel parameters - *missing description* Babel debugging commands ======================== @@ -272,16 +275,17 @@ Babel debugging commands simple: no debug babel KIND .. clicmd:: [no] debug babel KIND - Enable or disable debugging messages of a given kind. ``KIND`` can - be one of: - - common - - filter - - timeout - - interface - - route - - all + Enable or disable debugging messages of a given kind. ``KIND`` can + be one of: - Note that if you have compiled with the NO_DEBUG flag, then these commands - aren't available. + - ``common`` + - ``filter`` + - ``timeout`` + - ``interface`` + - ``route`` + - ``all`` +.. note:: + If you have compiled with the ``NO_DEBUG`` flag, then these commands aren't + available. diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 97a29129c9..7c6f97aed6 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -39,12 +39,10 @@ starting. Config files are generally found in |INSTALL_PREFIX_ETC|. -Each of the daemons has its own -config file. For example, zebra's default config file name is *zebra.conf*. - -The daemon name plus `.conf` is the default config file name. You -can specify a config file using the :kbd:`-f` or :kbd:`--config-file` -options when starting the daemon. +Each of the daemons has its own config file. The daemon name plus ``.conf`` is +the default config file name. For example, zebra's default config file name is +:file:`zebra.conf`. You can specify a config file using the :option:`-f` or +:option:`--config-file` options when starting the daemon. .. _Basic_Config_Commands: @@ -71,8 +69,8 @@ Basic Config Commands Set enable password. .. index:: - single: no log trap [LEVEL] - single: log trap LEVEL + single: no log trap [LEVEL] + single: log trap LEVEL .. clicmd:: [no] log trap LEVEL @@ -85,8 +83,8 @@ Basic Config Commands existing logging destinations. .. index:: - single: no log stdout [LEVEL] - single: log stdout [LEVEL] + single: no log stdout [LEVEL] + single: log stdout [LEVEL] .. clicmd:: [no] log stdout LEVEL @@ -100,8 +98,8 @@ Basic Config Commands ``errors``. .. index:: - single: no log file [FILENAME [LEVEL]] - single: log file FILENAME [LEVEL] + single: no log file [FILENAME [LEVEL]] + single: log file FILENAME [LEVEL] .. clicmd:: [no] log file [FILENAME [LEVEL]] @@ -121,8 +119,8 @@ Basic Config Commands information. .. index:: - single: no log syslog [LEVEL] - single: log syslog [LEVEL] + single: no log syslog [LEVEL] + single: log syslog [LEVEL] .. clicmd:: [no] log syslog [LEVEL] @@ -132,8 +130,8 @@ Basic Config Commands be used. The ``no`` form of the command disables logging to syslog. .. index:: - single: no log monitor [LEVEL] - single: log monitor [LEVEL] + single: no log monitor [LEVEL] + single: log monitor [LEVEL] .. clicmd:: [no] log monitor [LEVEL] @@ -147,8 +145,8 @@ Basic Config Commands terminal monitors. .. index:: - single: no log facility [FACILITY] - single: log facility [FACILITY] + single: no log facility [FACILITY] + single: log facility [FACILITY] .. clicmd:: [no] log facility [FACILITY] @@ -157,8 +155,8 @@ Basic Config Commands the facility to the default ``daemon`` facility. .. index:: - single: no log record-priority - single: log record-priority + single: no log record-priority + single: log record-priority .. clicmd:: [no] log record-priority @@ -171,8 +169,8 @@ Basic Config Commands the facility and level in the messages emitted. .. index:: - single: log timestamp precision (0-6) - single: [no] log timestamp precision (0-6) + single: log timestamp precision (0-6) + single: [no] log timestamp precision (0-6) .. clicmd:: [no] log timestamp precision [(0-6)] @@ -298,59 +296,59 @@ Terminal Mode Commands .. clicmd:: write terminal - Displays the current configuration to the vty interface. + Displays the current configuration to the vty interface. .. index:: write file .. clicmd:: write file - Write current configuration to configuration file. + Write current configuration to configuration file. .. index:: configure terminal .. clicmd:: configure terminal - Change to configuration mode. This command is the first step to - configuration. + Change to configuration mode. This command is the first step to + configuration. .. index:: terminal length (0-512) .. clicmd:: terminal length (0-512) - Set terminal display length to ``(0-512)``. If length is 0, no - display control is performed. + Set terminal display length to ``(0-512)``. If length is 0, no + display control is performed. .. index:: who .. clicmd:: who - Show a list of currently connected vty sessions. + Show a list of currently connected vty sessions. .. index:: list .. clicmd:: list - List all available commands. + List all available commands. .. index:: show version .. clicmd:: show version - Show the current version of |PACKAGE_NAME| and its build host information. + Show the current version of |PACKAGE_NAME| and its build host information. .. index:: show logging .. clicmd:: show logging - Shows the current configuration of the logging system. This includes - the status of all logging destinations. + Shows the current configuration of the logging system. This includes + the status of all logging destinations. .. index:: logmsg LEVEL MESSAGE .. clicmd:: logmsg LEVEL MESSAGE - Send a message to all logging destinations that are enabled for messages - of the given severity. + Send a message to all logging destinations that are enabled for messages + of the given severity. .. _Common_Invocation_Options: @@ -360,56 +358,55 @@ Common Invocation Options These options apply to all |PACKAGE_NAME| daemons. -.. clicmd:: -d, --daemon +.. option:: -d +.. option:: --daemon - Runs in daemon mode. + Run in daemon mode. +.. option:: -f +.. option:: --config-file -.. clicmd:: -f file, --config_file=FILE + Set configuration file name. - Set configuration file name. +.. option:: -h, --help + Display this help and exit. -.. clicmd:: -h, --help +.. option:: -i +.. option:: --pid-file - Display this help and exit. + Upon startup the process identifier of the daemon is written to a file, + typically in :file:`/var/run`. This file can be used by the init system + to implement commands such as ``.../init.d/zebra status``, + ``.../init.d/zebra restart`` or ``.../init.d/zebra stop``. + The file name is an run-time option rather than a configure-time option + so that multiple routing daemons can be run simultaneously. This is + useful when using |PACKAGE_NAME| to implement a routing looking glass. One + machine can be used to collect differing routing views from differing + points in the network. -.. clicmd:: -i file, --pid_file=file +.. option:: -A
+.. option:: --vty-addr
- Upon startup the process identifier of the daemon is written to a file, - typically in :file:`/var/run`. This file can be used by the init system - to implement commands such as ``.../init.d/zebra status``, - ``.../init.d/zebra restart`` or ``.../init.d/zebra stop``. + Set the VTY local address to bind to. If set, the VTY socket will only + be bound to this address. - The file name is an run-time option rather than a configure-time option - so that multiple routing daemons can be run simultaneously. This is - useful when using |PACKAGE_NAME| to implement a routing looking glass. One - machine can be used to collect differing routing views from differing - points in the network. +.. option:: -P +.. option:: --vty-port + Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not + be opened. -.. clicmd:: -A address, --vty_addr=address +.. option:: -u +.. option:: --vty_addr - Set the VTY local address to bind to. If set, the VTY socket will only - be bound to this address. + Set the user and group to run as. +.. option:: -v +.. option:: --version -.. clicmd:: -P port, --vty_port=port - - Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not - be opened. - - -.. clicmd:: -u user, --vty_addr=user - - Set the user and group to run as. - - -.. clicmd:: -v, --version - - Print program version. - + Print program version. .. _Loadable_Module_Support: @@ -421,17 +418,18 @@ unloading modules at runtime is not supported (yet). To load a module, use the following command line option at daemon startup: -.. clicmd:: -M module:options, --module module:options +.. option:: -M +.. option:: --module - Load the specified module, optionally passing options to it. If the module - name contains a slash (/), it is assumed to be a full pathname to a file to - be loaded. If it does not contain a slash, the - `INSTALL_PREFIX_MODULES` directory is searched for a module of - the given name; first with the daemon name prepended (e.g. ``zebra_mod`` - for ``mod``), then without the daemon name prepended. + Load the specified module, optionally passing options to it. If the module + name contains a slash (/), it is assumed to be a full pathname to a file to + be loaded. If it does not contain a slash, the |INSTALL_PREFIX_MODULES| + directory is searched for a module of the given name; first with the daemon + name prepended (e.g. ``zebra_mod`` for ``mod``), then without the daemon + name prepended. - This option is available on all daemons, though some daemons may not have - any modules available to be loaded. + This option is available on all daemons, though some daemons may not have + any modules available to be loaded. The SNMP Module --------------- @@ -446,15 +444,14 @@ for information on its usage. The FPM Module -------------- -If FPM is enabled during compile-time and installed as part of the package, -the ``fpm`` module can be loaded for the *zebra* daemon. This -provides the Forwarding Plane Manager ("FPM") API. +If FPM is enabled during compile-time and installed as part of the package, the +``fpm`` module can be loaded for the *zebra* daemon. This provides the +Forwarding Plane Manager ("FPM") API. -The module expects its argument to be either ``netlink`` or -.. clicmd:: protobuf, specifying the encapsulation to use. `netlink` is the -default, and `protobuf` may not be available if the module was built -without protobuf support. Refer to :ref:`zebra_FIB_push_interface` for more -information. +The module expects its argument to be either ``netlink`` or ``protobuf``, +specifying the encapsulation to use. ``netlink`` is the default, and +``protobuf`` may not be available if the module was built without protobuf +support. Refer to :ref:`zebra_FIB_push_interface` for more information. .. _Virtual_Terminal_Interfaces: @@ -505,7 +502,7 @@ is no VTY password, one cannot connect to the VTY interface at all. Router# -:kbd:`?` is very useful for looking up commands. +:kbd:`?` and the ``find`` command are very useful for looking up commands. .. _VTY_Modes: diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 3bf0eac332..43f7ddb4a2 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -55,7 +55,6 @@ customize the build to include or exclude specific features and dependencies. .. option:: --disable-zebra - Do not build zebra daemon. .. option:: --disable-ripd @@ -118,7 +117,7 @@ customize the build to include or exclude specific features and dependencies. Enable Traffic Engineering Extension for ISIS (RFC5305) -.. option:: --enable-multipath=`ARG` +.. option:: --enable-multipath Enable support for Equal Cost Multipath. `ARG` is the maximum number of ECMP paths to allow, set to 0 to allow unlimited number of paths. @@ -129,9 +128,9 @@ customize the build to include or exclude specific features and dependencies. .. option:: --enable-gcc-rdynamic - Pass the *-rdynamic* option to the linker driver. This is in most - cases neccessary for getting usable backtraces. This option defaults to on - if the compiler is detected as gcc, but giving an explicit enable/disable is + Pass the ``-rdynamic`` option to the linker driver. This is in most cases + neccessary for getting usable backtraces. This option defaults to on if the + compiler is detected as gcc, but giving an explicit enable/disable is suggested. .. option:: --disable-backtrace @@ -164,23 +163,23 @@ and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/` installation prefix and other directories may be changed using the following options to the configuration script. -.. option:: --prefix=`prefix` +.. option:: --prefix Install architecture-independent files in `prefix` [/usr/local]. -.. option:: --sysconfdir=`dir` +.. option:: --sysconfdir Look for configuration files in `dir` [`prefix`/etc]. Note that sample configuration files will be installed here. -.. option:: --localstatedir=`dir` +.. option:: --localstatedir - Configure zebra to use `dir` for local state files, such - as pid files and unix sockets. + Configure zebra to use `dir` for local state files, such as pid files and + unix sockets. .. _Least-Privilege_support: -Least-Privilege support +Least-Privilege Support ----------------------- .. index:: FRR Least-Privileges @@ -192,23 +191,21 @@ shortly after startup and switch to another user. The configure script will automatically try to configure this support. There are three configure options to control the behaviour of FRR daemons. -.. option:: --enable-user=`user` +.. option:: --enable-user - Switch to user `ARG` shortly after startup, and run as user `ARG` - in normal operation. + Switch to user `user shortly after startup, and run as user `user` in normal + operation. -.. option:: --enable-group=`group` +.. option:: --enable-group - Switch real and effective group to `group` shortly after - startup. + Switch real and effective group to `group` shortly after startup. -.. option:: --enable-vty-group=`group` +.. option:: --enable-vty-group Create Unix Vty sockets (for use with vtysh) with group owndership set to - `group`. This allows one to create a seperate group which is - restricted to accessing only the Vty sockets, hence allowing one to - delegate this group to individual users, or to run vtysh setgid to - this group. + `group`. This allows one to create a seperate group which is restricted to + accessing only the vty sockets, hence allowing one to delegate this group to + individual users, or to run vtysh setgid to this group. The default user and group which will be configured is 'frr' if no user or group is specified. Note that this user or group requires write access to the @@ -257,14 +254,16 @@ make sure the following libraries have been installed. Please note that these libraries will not be needed when you uses GNU C library 2.1 or upper. -*inet6-apps* +- inet6-apps + The `inet6-apps` package includes basic IPv6 related libraries such as `inet_ntop` and `inet_pton`. Some basic IPv6 programs such as *ping*, *ftp*, and *inetd* are also included. The `inet-apps` can be found at `ftp://ftp.inner.net/pub/ipv6/ `_. -*net-tools* +- net-tools + The `net-tools` package provides an IPv6 enabled interface and routing utility. It contains *ifconfig*, *route*, *netstat*, and other tools. `net-tools` may be found at http://www.tazenda.demon.co.uk/phil/net-tools/. diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index ab60857bca..b04b8c7365 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -4,7 +4,7 @@ Zebra ***** -*zebra* is an IP routing manager. It provides kernel routing +*zebra* is an IP routing manager. It provides kernel routing table updates, interface lookups, and redistribution of routes between different routing protocols. @@ -16,257 +16,268 @@ Invoking zebra Besides the common invocation options (:ref:`Common_Invocation_Options`), the *zebra* specific invocation options are listed below. +.. program:: zebra +.. option:: -b +.. option:: --batch -*-b* + Runs in batch mode. *zebra* parses configuration file and terminates + immediately. -*--batch* - Runs in batch mode. *zebra* parses configuration file and terminates - immediately. +.. option:: -k +.. option:: --keep_kernel + When zebra starts up, don't delete old self inserted routes. -*-k* - -*--keep_kernel* - When zebra starts up, don't delete old self inserted routes. - - -*-r* - -*--retain* - When program terminates, retain routes added by zebra. +.. option:: -r +.. option:: --retain + When program terminates, retain routes added by zebra. .. _Interface_Commands: Interface Commands ================== - .. _Standard_Commands: Standard Commands ----------------- -.. index:: Command {interface `ifname`} {} +.. index:: interface IFNAME -Command {interface `ifname`} {} +.. clicmd:: interface IFNAME -.. index:: {Interface Command} {shutdown} {} +.. index:: shutdown -{Interface Command} {shutdown} {} -.. index:: {Interface Command} {no shutdown} {} +.. clicmd:: shutdown +.. index:: no shutdown -{Interface Command} {no shutdown} {} - Up or down the current interface. +.. clicmd:: no shutdown -.. index:: {Interface Command} {ip address `address/prefix`} {} + Up or down the current interface. -{Interface Command} {ip address `address/prefix`} {} -.. index:: {Interface Command} {ipv6 address `address/prefix`} {} +.. index:: ip address ADDRESS/PREFIX -{Interface Command} {ipv6 address `address/prefix`} {} -.. index:: {Interface Command} {no ip address `address/prefix`} {} +.. clicmd:: ip address ADDRESS/PREFIX +.. index:: ipv6 address ADDRESS/PREFIX -{Interface Command} {no ip address `address/prefix`} {} -.. index:: {Interface Command} {no ipv6 address `address/prefix`} {} +.. clicmd:: ipv6 address ADDRESS/PREFIX +.. index:: no ip address ADDRESS/PREFIX -{Interface Command} {no ipv6 address `address/prefix`} {} - Set the IPv4 or IPv6 address/prefix for the interface. +.. clicmd:: no ip address ADDRESS/PREFIX +.. index:: no ipv6 address ADDRESS/PREFIX -.. index:: {Interface Command} {ip address `local-addr` peer `peer-addr/prefix`} {} +.. clicmd:: no ipv6 address ADDRESS/PREFIX -{Interface Command} {ip address `local-addr` peer `peer-addr/prefix`} {} -.. index:: {Interface Command} {no ip address `local-addr` peer `peer-addr/prefix`} {} + Set the IPv4 or IPv6 address/prefix for the interface. -{Interface Command} {no ip address `local-addr` peer `peer-addr/prefix`} {} - Configure an IPv4 Pointopoint address on the interface. - (The concept of PtP addressing does not exist for IPv6.) +.. index:: ip address LOCAL-ADDR peer PEER-ADDR/PREFIX - `local-addr` has no subnet mask since the local side in PtP - addressing is always a single (/32) address. `peer-addr/prefix` - can be an arbitrary subnet behind the other end of the link (or even on the - link in Point-to-Multipoint setups), though generally /32s are used. +.. clicmd:: ip address LOCAL-ADDR peer PEER-ADDR/PREFIX +.. index:: no ip address LOCAL-ADDR peer PEER-ADDR/PREFIX -.. index:: {Interface Command} {ip address `address/prefix` secondary} {} +.. clicmd:: no ip address LOCAL-ADDR peer PEER-ADDR/PREFIX -{Interface Command} {ip address `address/prefix` secondary} {} -.. index:: {Interface Command} {no ip address `address/prefix` secondary} {} + Configure an IPv4 Pointopoint address on the interface. (The concept of PtP + addressing does not exist for IPv6.) -{Interface Command} {no ip address `address/prefix` secondary} {} - Set the secondary flag for this address. This causes ospfd to not treat the - address as a distinct subnet. + `local-addr` has no subnet mask since the local side in PtP addressing is + always a single (/32) address. `peer-addr/prefix` can be an arbitrary subnet + behind the other end of the link (or even on the link in Point-to-Multipoint + setups), though generally /32s are used. -.. index:: {Interface Command} {description `description` ...} {} +.. index:: ip address ADDRESS/PREFIX secondary -{Interface Command} {description `description` ...} {} - Set description for the interface. +.. clicmd:: ip address ADDRESS/PREFIX secondary +.. index:: no ip address ADDRESS/PREFIX secondary -.. index:: {Interface Command} {multicast} {} +.. clicmd:: no ip address ADDRESS/PREFIX secondary -{Interface Command} {multicast} {} -.. index:: {Interface Command} {no multicast} {} + Set the secondary flag for this address. This causes ospfd to not treat the + address as a distinct subnet. -{Interface Command} {no multicast} {} - Enable or disables multicast flag for the interface. +.. index:: description DESCRIPTION ... -.. index:: {Interface Command} {bandwidth (1-10000000)} {} +.. clicmd:: description DESCRIPTION ... -{Interface Command} {bandwidth (1-10000000)} {} -.. index:: {Interface Command} {no bandwidth (1-10000000)} {} + Set description for the interface. -{Interface Command} {no bandwidth (1-10000000)} {} - Set bandwidth value of the interface in kilobits/sec. This is for - calculating OSPF cost. This command does not affect the actual device - configuration. +.. index:: multicast -.. index:: {Interface Command} {link-detect} {} +.. clicmd:: multicast +.. index:: no multicast -{Interface Command} {link-detect} {} -.. index:: {Interface Command} {no link-detect} {} +.. clicmd:: no multicast -{Interface Command} {no link-detect} {} - Enable/disable link-detect on platforms which support this. Currently - only Linux and Solaris, and only where network interface drivers support reporting - link-state via the IFF_RUNNING flag. + Enable or disables multicast flag for the interface. + +.. index:: bandwidth (1-10000000) + +.. clicmd:: bandwidth (1-10000000) +.. index:: no bandwidth (1-10000000) + +.. clicmd:: no bandwidth (1-10000000) + + Set bandwidth value of the interface in kilobits/sec. This is for + calculating OSPF cost. This command does not affect the actual device + configuration. + +.. index:: link-detect + +.. clicmd:: link-detect +.. index:: no link-detect + +.. clicmd:: no link-detect + + Enable/disable link-detect on platforms which support this. Currently only + Linux and Solaris, and only where network interface drivers support + reporting link-state via the ``IFF_RUNNING`` flag. .. _Link_Parameters_Commands: Link Parameters Commands ------------------------ -.. index:: {Interface Command} {link-params} {} +.. index:: link-params +.. clicmd:: link-params -{Interface Command} {link-params} {} -.. index:: {Interface Command} {no link-param} {} +.. index:: no link-param +.. clicmd:: no link-param -{Interface Command} {no link-param} {} - Enter into the link parameters sub node. At least 'enable' must be set to activate the link parameters, - and consequently Traffic Engineering on this interface. MPLS-TE must be enable at the OSPF (:ref:`OSPF_Traffic_Engineering`) - or ISIS (:ref:`ISIS_Traffic_Engineering`) router level in complement to this. - Disable link parameters for this interface. + Enter into the link parameters sub node. At least 'enable' must be set to + activate the link parameters, and consequently Traffic Engineering on this + interface. MPLS-TE must be enable at the OSPF + (:ref:`OSPF_Traffic_Engineering`) or ISIS (:ref:`ISIS_Traffic_Engineering`) + router level in complement to this. Disable link parameters for this + interface. - Under link parameter statement, the following commands set the different TE values: + Under link parameter statement, the following commands set the different TE values: -.. index:: link-params {enable} +.. index:: link-params [enable] +.. clicmd:: link-params [enable] -link-params {enable} - Enable link parameters for this interface. + Enable link parameters for this interface. -.. index:: link-params {metric (0-4294967295)} {} +.. index:: link-params [metric (0-4294967295)] +.. clicmd:: link-params [metric (0-4294967295)] -link-params {metric (0-4294967295)} {} -.. index:: link-params {max-bw `bandwidth`} {} +.. index:: link-params max-bw BANDWIDTH +.. clicmd:: link-params max-bw BANDWIDTH -link-params {max-bw `bandwidth`} {} -.. index:: link-params {max-rsv-bw `bandwidth`} {} +.. index:: link-params max-rsv-bw BANDWIDTH +.. clicmd:: link-params max-rsv-bw BANDWIDTH -link-params {max-rsv-bw `bandwidth`} {} -.. index:: link-params {unrsv-bw (0-7) `bandwidth`} {} +.. index:: link-params unrsv-bw (0-7) BANDWIDTH +.. clicmd:: link-params unrsv-bw (0-7) BANDWIDTH -link-params {unrsv-bw (0-7) `bandwidth`} {} -.. index:: link-params {admin-grp `bandwidth`} {} +.. index:: link-params admin-grp BANDWIDTH +.. clicmd:: link-params admin-grp BANDWIDTH -link-params {admin-grp `bandwidth`} {} - These commands specifies the Traffic Engineering parameters of the interface in conformity to RFC3630 (OSPF) - or RFC5305 (ISIS). - There are respectively the TE Metric (different from the OSPF or ISIS metric), Maximum Bandwidth (interface speed - by default), Maximum Reservable Bandwidth, Unreserved Bandwidth for each 0-7 priority and Admin Group (ISIS) or - Resource Class/Color (OSPF). + These commands specifies the Traffic Engineering parameters of the interface + in conformity to RFC3630 (OSPF) or RFC5305 (ISIS). There are respectively + the TE Metric (different from the OSPF or ISIS metric), Maximum Bandwidth + (interface speed by default), Maximum Reservable Bandwidth, Unreserved + Bandwidth for each 0-7 priority and Admin Group (ISIS) or Resource + Class/Color (OSPF). - Note that `bandwidth` are specified in IEEE floating point format and express in Bytes/second. + Note that BANDIWDTH is specified in IEEE floating point format and express + in Bytes/second. -.. index:: link-param {delay (0-16777215) [min (0-16777215) | max (0-16777215)]} {} +.. index:: link-param delay (0-16777215) [min (0-16777215) | max (0-16777215)] +.. clicmd:: link-param delay (0-16777215) [min (0-16777215) | max (0-16777215)] -link-param {delay (0-16777215) [min (0-16777215) | max (0-16777215)]} {} -.. index:: link-param {delay-variation (0-16777215)} {} +.. index:: link-param delay-variation (0-16777215) +.. clicmd:: link-param delay-variation (0-16777215) -link-param {delay-variation (0-16777215)} {} -.. index:: link-param {packet-loss `percentage`} {} +.. index:: link-param packet-loss PERCENTAGE +.. clicmd:: link-param packet-loss PERCENTAGE -link-param {packet-loss `percentage`} {} -.. index:: link-param {res-bw `bandwidth`} {} +.. index:: link-param res-bw BANDWIDTH +.. clicmd:: link-param res-bw BANDWIDTH -link-param {res-bw `bandwidth`} {} -.. index:: link-param {ava-bw `bandwidth`} {} +.. index:: link-param ava-bw BANDWIDTH +.. clicmd:: link-param ava-bw BANDWIDTH -link-param {ava-bw `bandwidth`} {} -.. index:: link-param {use-bw `bandwidth`} {} +.. index:: link-param use-bw BANDWIDTH +.. clicmd:: link-param use-bw BANDWIDTH -link-param {use-bw `bandwidth`} {} - These command specifies additionnal Traffic Engineering parameters of the interface in conformity to - draft-ietf-ospf-te-metrics-extension-05.txt and draft-ietf-isis-te-metrics-extension-03.txt. There are - respectively the delay, jitter, loss, available bandwidth, reservable bandwidth and utilized bandwidth. + These command specifies additionnal Traffic Engineering parameters of the + interface in conformity to draft-ietf-ospf-te-metrics-extension-05.txt and + draft-ietf-isis-te-metrics-extension-03.txt. There are respectively the + delay, jitter, loss, available bandwidth, reservable bandwidth and utilized + bandwidth. - Note that `bandwidth` are specified in IEEE floating point format and express in Bytes/second. - Delays and delay variation are express in micro-second (µs). Loss is specified in `percentage` ranging - from 0 to 50.331642% by step of 0.000003. + Note that BANDWIDTH is specified in IEEE floating point format and express + in Bytes/second. Delays and delay variation are express in micro-second + (µs). Loss is specified in PERCENTAGE ranging from 0 to 50.331642% by step + of 0.000003. -.. index:: link-param {neighbor as (0-65535)} {} +.. index:: link-param neighbor as (0-65535) +.. clicmd:: link-param neighbor as (0-65535) -link-param {neighbor as (0-65535)} {} -.. index:: link-param {no neighbor} {} +.. index:: link-param no neighbor +.. clicmd:: link-param no neighbor -link-param {no neighbor} {} - Specifies the remote ASBR IP address and Autonomous System (AS) number for InterASv2 link in OSPF (RFC5392). - Note that this option is not yet supported for ISIS (RFC5316). + Specifies the remote ASBR IP address and Autonomous System (AS) number + for InterASv2 link in OSPF (RFC5392). Note that this option is not yet + supported for ISIS (RFC5316). .. _Static_Route_Commands: Static Route Commands ===================== -Static routing is a very fundamental feature of routing technology. It +Static routing is a very fundamental feature of routing technology. It defines static prefix and gateway. -.. index:: Command {ip route `network` `gateway`} {} +.. index:: ip route NETWORK GATEWAY +.. clicmd:: ip route NETWORK GATEWAY -Command {ip route `network` `gateway`} {} - `network` is destination prefix with format of A.B.C.D/M. - `gateway` is gateway for the prefix. When `gateway` is - A.B.C.D format. It is taken as a IPv4 address gateway. Otherwise it - is treated as an interface name. If the interface name is `null0` then - zebra installs a blackhole route. + NETWORK is destination prefix with format of A.B.C.D/M. GATEWAY is gateway + for the prefix. When GATEWAY is A.B.C.D format. It is taken as a IPv4 + address gateway. Otherwise it is treated as an interface name. If the + interface name is ``null0`` then zebra installs a blackhole route. -:: + Some example configuration: - ip route 10.0.0.0/8 10.0.0.2 - ip route 10.0.0.0/8 ppp0 - ip route 10.0.0.0/8 null0 + :: + ip route 10.0.0.0/8 10.0.0.2 + ip route 10.0.0.0/8 ppp0 + ip route 10.0.0.0/8 null0 + + First example defines 10.0.0.0/8 static route with gateway 10.0.0.2. + Second one defines the same prefix but with gateway to interface ppp0. The + third install a blackhole route. + +.. index:: ip route NETWORK NETMASK GATEWAY +.. clicmd:: ip route NETWORK NETMASK GATEWAY + + This is alternate version of above command. When NETWORK is + A.B.C.D format, user must define NETMASK value with A.B.C.D + format. GATEWAY is same option as above command. + + :: + + ip route 10.0.0.0 255.255.255.0 10.0.0.2 + ip route 10.0.0.0 255.255.255.0 ppp0 + ip route 10.0.0.0 255.255.255.0 null0 - First example defines 10.0.0.0/8 static route with gateway 10.0.0.2. - Second one defines the same prefix but with gateway to interface ppp0. The - third install a blackhole route. + These statements are equivalent to those in the previous example. -.. index:: Command {ip route `network` `netmask` `gateway`} {} +.. index:: ip route NETWORK GATEWAY DISTANCE +.. clicmd:: ip route NETWORK GATEWAY DISTANCE -Command {ip route `network` `netmask` `gateway`} {} - This is alternate version of above command. When `network` is - A.B.C.D format, user must define `netmask` value with A.B.C.D - format. `gateway` is same option as above command - -:: - - ip route 10.0.0.0 255.255.255.0 10.0.0.2 - ip route 10.0.0.0 255.255.255.0 ppp0 - ip route 10.0.0.0 255.255.255.0 null0 - - - These statements are equivalent to those in the previous example. - -.. index:: Command {ip route `network` `gateway` `distance`} {} - -Command {ip route `network` `gateway` `distance`} {} - Installs the route with the specified distance. + Installs the route with the specified distance. Multiple nexthop static route :: - ip route 10.0.0.1/32 10.0.0.2 - ip route 10.0.0.1/32 10.0.0.3 - ip route 10.0.0.1/32 eth0 + ip route 10.0.0.1/32 10.0.0.2 + ip route 10.0.0.1/32 10.0.0.3 + ip route 10.0.0.1/32 eth0 If there is no route to 10.0.0.2 and 10.0.0.3, and interface eth0 @@ -278,17 +289,17 @@ nexthops, if the platform supports this. :: - zebra> show ip route - S> 10.0.0.1/32 [1/0] via 10.0.0.2 inactive - via 10.0.0.3 inactive - * is directly connected, eth0 + zebra> show ip route + S> 10.0.0.1/32 [1/0] via 10.0.0.2 inactive + via 10.0.0.3 inactive + * is directly connected, eth0 :: - ip route 10.0.0.0/8 10.0.0.2 - ip route 10.0.0.0/8 10.0.0.3 - ip route 10.0.0.0/8 null0 255 + ip route 10.0.0.0/8 10.0.0.2 + ip route 10.0.0.0/8 10.0.0.3 + ip route 10.0.0.0/8 null0 255 This will install a multihop route via the specified next-hops if they are @@ -298,45 +309,45 @@ default) should the specified gateways not be reachable. Eg: :: - zebra> show ip route 10.0.0.0/8 - Routing entry for 10.0.0.0/8 - Known via "static", distance 1, metric 0 - 10.0.0.2 inactive - 10.0.0.3 inactive + zebra> show ip route 10.0.0.0/8 + Routing entry for 10.0.0.0/8 + Known via "static", distance 1, metric 0 + 10.0.0.2 inactive + 10.0.0.3 inactive - Routing entry for 10.0.0.0/8 - Known via "static", distance 255, metric 0 - directly connected, Null0 + Routing entry for 10.0.0.0/8 + Known via "static", distance 255, metric 0 + directly connected, Null0 -.. index:: Command {ipv6 route `network` `gateway`} {} +.. index:: ipv6 route NETWORK GATEWAY +.. clicmd:: ipv6 route NETWORK GATEWAY -Command {ipv6 route `network` `gateway`} {} -.. index:: Command {ipv6 route `network` `gateway` `distance`} {} +.. index:: ipv6 route NETWORK GATEWAY DISTANCE +.. clicmd:: ipv6 route NETWORK GATEWAY DISTANCE -Command {ipv6 route `network` `gateway` `distance`} {} - These behave similarly to their ipv4 counterparts. + These behave similarly to their ipv4 counterparts. -.. index:: Command {ipv6 route `network` from `srcprefix` `gateway`} {} +.. index:: ipv6 route NETWORK from SRCPREFIX GATEWAY +.. clicmd:: ipv6 route NETWORK from SRCPREFIX GATEWAY -Command {ipv6 route `network` from `srcprefix` `gateway`} {} -.. index:: Command {ipv6 route `network` from `srcprefix` `gateway` `distance`} {} +.. index:: ipv6 route NETWORK from SRCPREFIX GATEWAY DISTANCE +.. clicmd:: ipv6 route NETWORK from SRCPREFIX GATEWAY DISTANCE -Command {ipv6 route `network` from `srcprefix` `gateway` `distance`} {} - Install a static source-specific route. These routes are currently supported - on Linux operating systems only, and perform AND matching on packet's - destination and source addresses in the kernel's forwarding path. Note that - destination longest-prefix match is "more important" than source LPM, e.g. - *"2001:db8:1::/64 from 2001:db8::/48"* will win over - *"2001:db8::/48 from 2001:db8:1::/64"* if both match. + Install a static source-specific route. These routes are currently supported + on Linux operating systems only, and perform AND matching on packet's + destination and source addresses in the kernel's forwarding path. Note that + destination longest-prefix match is "more important" than source LPM, e.g. + *"2001:db8:1::/64 from 2001:db8::/48"* will win over + *"2001:db8::/48 from 2001:db8:1::/64"* if both match. -.. index:: Command {table `tableno`} {} +.. index:: table TABLENO +.. clicmd:: table TABLENO -Command {table `tableno`} {} - Select the primary kernel routing table to be used. This only works - for kernels supporting multiple routing tables (like GNU/Linux 2.2.x - and later). After setting `tableno` with this command, - static routes defined after this are added to the specified table. + Select the primary kernel routing table to be used. This only works + for kernels supporting multiple routing tables (like GNU/Linux 2.2.x + and later). After setting TABLENO with this command, + static routes defined after this are added to the specified table. .. _Multicast_RIB_Commands: @@ -344,135 +355,137 @@ Multicast RIB Commands ====================== The Multicast RIB provides a separate table of unicast destinations which -is used for Multicast Reverse Path Forwarding decisions. It is used with +is used for Multicast Reverse Path Forwarding decisions. It is used with a multicast source's IP address, hence contains not multicast group addresses but unicast addresses. -This table is fully separate from the default unicast table. However, +This table is fully separate from the default unicast table. However, RPF lookup can include the unicast table. WARNING: RPF lookup results are non-responsive in this version of FRR, i.e. multicast routing does not actively react to changes in underlying unicast topology! -.. index:: Command {ip multicast rpf-lookup-mode `mode`} {} +.. index:: ip multicast rpf-lookup-mode MODE +.. clicmd:: ip multicast rpf-lookup-mode MODE -Command {ip multicast rpf-lookup-mode `mode`} {} -.. index:: Command {no ip multicast rpf-lookup-mode [`mode`]} {} +.. index:: no ip multicast rpf-lookup-mode [MODE] +.. clicmd:: no ip multicast rpf-lookup-mode [MODE] -Command {no ip multicast rpf-lookup-mode [`mode`]} {} - `mode` sets the method used to perform RPF lookups. Supported modes: + MODE sets the method used to perform RPF lookups. Supported modes: +urib-only + Performs the lookup on the Unicast RIB. The Multicast RIB is never used. +mrib-only + Performs the lookup on the Multicast RIB. The Unicast RIB is never used. -*urib-only* - Performs the lookup on the Unicast RIB. The Multicast RIB is never used. +mrib-then-urib + Tries to perform the lookup on the Multicast RIB. If any route is found, + that route is used. Otherwise, the Unicast RIB is tried. -*mrib-only* - Performs the lookup on the Multicast RIB. The Unicast RIB is never used. +lower-distance + Performs a lookup on the Multicast RIB and Unicast RIB each. The result + with the lower administrative distance is used; if they're equal, the + Multicast RIB takes precedence. -*mrib-then-urib* - Tries to perform the lookup on the Multicast RIB. If any route is found, - that route is used. Otherwise, the Unicast RIB is tried. +longer-prefix + Performs a lookup on the Multicast RIB and Unicast RIB each. The result + with the longer prefix length is used; if they're equal, the + Multicast RIB takes precedence. -*lower-distance* - Performs a lookup on the Multicast RIB and Unicast RIB each. The result - with the lower administrative distance is used; if they're equal, the - Multicast RIB takes precedence. + The `mrib-then-urib` setting is the default behavior if nothing is + configured. If this is the desired behavior, it should be explicitly + configured to make the configuration immune against possible changes in + what the default behavior is. -*longer-prefix* - Performs a lookup on the Multicast RIB and Unicast RIB each. The result - with the longer prefix length is used; if they're equal, the - Multicast RIB takes precedence. +.. warning:: + Unreachable routes do not receive special treatment and do not cause + fallback to a second lookup. - The `mrib-then-urib` setting is the default behavior if nothing is - configured. If this is the desired behavior, it should be explicitly - configured to make the configuration immune against possible changes in - what the default behavior is. +.. index:: show ip rpf ADDR +.. clicmd:: show ip rpf ADDR - WARNING: Unreachable routes do not receive special treatment and do not - cause fallback to a second lookup. + Performs a Multicast RPF lookup, as configured with ``ip multicast + rpf-lookup-mode MODE``. ADDR specifies the multicast source address to look + up. -.. index:: Command {show ip rpf `addr`} {} - -Command {show ip rpf `addr`} {} - Performs a Multicast RPF lookup, as configured with - *ip multicast rpf-lookup-mode `mode*`. `addr` specifies - the multicast source address to look up. - -:: + :: > show ip rpf 192.0.2.1 Routing entry for 192.0.2.0/24 using Unicast RIB - Known via "kernel", distance 0, metric 0, best - * 198.51.100.1, via eth0 + + Known via "kernel", distance 0, metric 0, best + * 198.51.100.1, via eth0 - Indicates that a multicast source lookup for 192.0.2.1 would use an - Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1. + Indicates that a multicast source lookup for 192.0.2.1 would use an + Unicast RIB entry for 192.0.2.0/24 with a gateway of 198.51.100.1. -.. index:: Command {show ip rpf} {} +.. index:: show ip rpf +.. clicmd:: show ip rpf -Command {show ip rpf} {} - Prints the entire Multicast RIB. Note that this is independent of the - configured RPF lookup mode, the Multicast RIB may be printed yet not - used at all. + Prints the entire Multicast RIB. Note that this is independent of the + configured RPF lookup mode, the Multicast RIB may be printed yet not + used at all. -.. index:: Command {ip mroute `prefix` `nexthop` [`distance`]} {} +.. index:: ip mroute PREFIX NEXTHOP [DISTANCE] +.. clicmd:: ip mroute PREFIX NEXTHOP [DISTANCE] -Command {ip mroute `prefix` `nexthop` [`distance`]} {} -.. index:: Command {no ip mroute `prefix` `nexthop` [`distance`]} {} +.. index:: no ip mroute PREFIX NEXTHOP [DISTANCE] +.. clicmd:: no ip mroute PREFIX NEXTHOP [DISTANCE] -Command {no ip mroute `prefix` `nexthop` [`distance`]} {} - Adds a static route entry to the Multicast RIB. This performs exactly as - the *ip route* command, except that it inserts the route in the - Multicast RIB instead of the Unicast RIB. + Adds a static route entry to the Multicast RIB. This performs exactly as the + ``ip route`` command, except that it inserts the route in the Multicast RIB + instead of the Unicast RIB. .. _zebra_Route_Filtering: zebra Route Filtering ===================== -Zebra supports *prefix-list* and *route-map* to match -routes received from other frr components. The -*permit*/*deny* facilities provided by these commands -can be used to filter which routes zebra will install in the kernel. +Zebra supports :dfn:`prefix-list`s and :ref:`Route_Map`s to match routes +received from other frr components. The permit/deny facilities provided by +these commands can be used to filter which routes zebra will install in the +kernel. -.. index:: Command {ip protocol `protocol` route-map `routemap`} {} +.. index:: ip protocol PROTOCOL route-map ROUTEMAP +.. clicmd:: ip protocol PROTOCOL route-map ROUTEMAP -Command {ip protocol `protocol` route-map `routemap`} {} - Apply a route-map filter to routes for the specified protocol. `protocol` - can be **any** or one of - **system**, - **kernel**, - **connected**, - **static**, - **rip**, - **ripng**, - **ospf**, - **ospf6**, - **isis**, - **bgp**, - **hsls**. + Apply a route-map filter to routes for the specified protocol. PROTOCOL can + be **any** or one of -.. index:: {Route Map} {set src `address`} + - system, + - kernel, + - connected, + - static, + - rip, + - ripng, + - ospf, + - ospf6, + - isis, + - bgp, + - hsls. -{Route Map} {set src `address`} - Within a route-map, set the preferred source address for matching routes - when installing in the kernel. +.. index:: set src ADDRESS +.. clicmd:: set src ADDRESS + + Within a route-map, set the preferred source address for matching routes + when installing in the kernel. + + +The following creates a prefix-list that matches all addresses, a route-map +that sets the preferred source address, and applies the route-map to all +*rip* routes. :: - The following creates a prefix-list that matches all addresses, a route-map - that sets the preferred source address, and applies the route-map to all - *rip* routes. + ip prefix-list ANY permit 0.0.0.0/0 le 32 + route-map RM1 permit 10 + match ip address prefix-list ANY + set src 10.0.0.1 - ip prefix-list ANY permit 0.0.0.0/0 le 32 - route-map RM1 permit 10 - match ip address prefix-list ANY - set src 10.0.0.1 - - ip protocol rip route-map RM1 + ip protocol rip route-map RM1 .. _zebra_FIB_push_interface: @@ -482,7 +495,7 @@ zebra FIB push interface Zebra supports a 'FIB push' interface that allows an external component to learn the forwarding information computed by the FRR -routing suite. This is a loadable module that needs to be enabled +routing suite. This is a loadable module that needs to be enabled at startup as described in :ref:`Loadable_Module_Support`. In FRR, the Routing Information Base (RIB) resides inside @@ -507,7 +520,7 @@ the FPM. The connection is initiated by zebra -- that is, the FPM acts as the TCP server. The relevant zebra code kicks in when zebra is configured with the -`--enable-fpm` flag. Zebra periodically attempts to connect to +:option:`--enable-fpm` flag. Zebra periodically attempts to connect to the well-known FPM port. Once the connection is up, zebra starts sending messages containing routes over the socket to the FPM. Zebra sends a complete copy of the forwarding table to the FPM, including @@ -527,12 +540,10 @@ schema. Protobuf messages can be extended easily while maintaining backward-compatibility with older code. Protobuf has the following advantages over netlink: -* - Code for serialization/deserialization is generated - automatically. This reduces the likelihood of bugs, allows third-party - programs to be integrated quickly, and makes it easy to add fields. -* - The message format is not tied to an OS (Linux), and can be evolved +- Code for serialization/deserialization is generated automatically. This + reduces the likelihood of bugs, allows third-party programs to be integrated + quickly, and makes it easy to add fields. +- The message format is not tied to an OS (Linux), and can be evolved independently. As mentioned before, zebra encodes routes sent to the FPM in netlink @@ -551,65 +562,65 @@ the FPM a complete copy of the forwarding table(s) when it reconnects. zebra Terminal Mode Commands ============================ -.. index:: Command {show ip route} {} +.. index:: show ip route +.. clicmd:: show ip route -Command {show ip route} {} - Display current routes which zebra holds in its database. + Display current routes which zebra holds in its database. :: Router# show ip route Codes: K - kernel route, C - connected, S - static, R - RIP, - B - BGP * - FIB route. + B - BGP * - FIB route. - K* 0.0.0.0/0 203.181.89.241 - S 0.0.0.0/0 203.181.89.1 - C* 127.0.0.0/8 lo + K* 0.0.0.0/0 203.181.89.241 + S 0.0.0.0/0 203.181.89.1 + C* 127.0.0.0/8 lo C* 203.181.89.240/28 eth0 -.. index:: Command {show ipv6 route} {} +.. index:: show ipv6 route +.. clicmd:: show ipv6 route -Command {show ipv6 route} {} -.. index:: Command {show interface} {} +.. index:: show interface +.. clicmd:: show interface -Command {show interface} {} -.. index:: Command {show ip prefix-list [`name`]} {} +.. index:: show ip prefix-list [NAME] +.. clicmd:: show ip prefix-list [NAME] -Command {show ip prefix-list [`name`]} {} -.. index:: Command {show route-map [`name`]} {} +.. index:: show route-map [NAME] +.. clicmd:: show route-map [NAME] -Command {show route-map [`name`]} {} -.. index:: Command {show ip protocol} {} +.. index:: show ip protocol +.. clicmd:: show ip protocol -Command {show ip protocol} {} -.. index:: Command {show ipforward} {} +.. index:: show ipforward +.. clicmd:: show ipforward -Command {show ipforward} {} - Display whether the host's IP forwarding function is enabled or not. - Almost any UNIX kernel can be configured with IP forwarding disabled. - If so, the box can't work as a router. + Display whether the host's IP forwarding function is enabled or not. + Almost any UNIX kernel can be configured with IP forwarding disabled. + If so, the box can't work as a router. -.. index:: Command {show ipv6forward} {} +.. index:: show ipv6forward +.. clicmd:: show ipv6forward -Command {show ipv6forward} {} - Display whether the host's IP v6 forwarding is enabled or not. + Display whether the host's IP v6 forwarding is enabled or not. -.. index:: Command {show zebra} {} +.. index:: show zebra +.. clicmd:: show zebra -Command {show zebra} {} - Display various statistics related to the installation and deletion - of routes, neighbor updates, and LSP's into the kernel. + Display various statistics related to the installation and deletion + of routes, neighbor updates, and LSP's into the kernel. -.. index:: Command {show zebra fpm stats} {} +.. index:: show zebra fpm stats +.. clicmd:: show zebra fpm stats -Command {show zebra fpm stats} {} - Display statistics related to the zebra code that interacts with the - optional Forwarding Plane Manager (FPM) component. + Display statistics related to the zebra code that interacts with the + optional Forwarding Plane Manager (FPM) component. -.. index:: Command {clear zebra fpm stats} {} +.. index:: clear zebra fpm stats +.. clicmd:: clear zebra fpm stats -Command {clear zebra fpm stats} {} - Reset statistics related to the zebra code that interacts with the - optional Forwarding Plane Manager (FPM) component. + Reset statistics related to the zebra code that interacts with the + optional Forwarding Plane Manager (FPM) component. From c1a54c054d434b9e50467db30665cfb688e16a2e Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 29 Jan 2018 16:38:07 -0500 Subject: [PATCH 036/148] doc: manually finish conversion Signed-off-by: Quentin Young --- doc/user/appendix.rst | 5 +- doc/user/bgp.rst | 2710 +++++++++++++++----------------- doc/user/eigrpd.rst | 157 +- doc/user/filter.rst | 211 ++- doc/user/installation.rst | 3 + doc/user/ipv6.rst | 192 +-- doc/user/isisd.rst | 803 +++++----- doc/user/nhrpd.rst | 35 +- doc/user/ospf6d.rst | 219 ++- doc/user/ospf_fundamentals.rst | 424 +++-- doc/user/ospfd.rst | 1723 ++++++++++---------- doc/user/protocol.rst | 168 +- doc/user/ripd.rst | 799 +++++----- doc/user/ripngd.rst | 84 +- doc/user/routemap.rst | 2 +- doc/user/rpki.rst | 337 ++-- doc/user/snmp.rst | 210 ++- doc/user/snmptrap.rst | 30 +- doc/user/vnc.rst | 1279 +++++++-------- doc/user/vtysh.rst | 208 ++- 20 files changed, 4615 insertions(+), 4984 deletions(-) diff --git a/doc/user/appendix.rst b/doc/user/appendix.rst index 2615123451..8f0343da58 100644 --- a/doc/user/appendix.rst +++ b/doc/user/appendix.rst @@ -1,11 +1,12 @@ +.. _packet-binary-dump-format: + Packet Binary Dump Format ========================= Packet Binary Dump Format ------------------------- -FRR can dump routing protocol packet into file with a binary format -(@pxref{Dump BGP packets and table}). +FRR can dump routing protocol packet into file with a binary format. It seems to be better that we share the MRT's header format for backward compatibility with MRT's dump logs. We should also define the diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 6e11937953..4ba69394b2 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -17,34 +17,31 @@ multiprotocol support to BGP-4. Starting BGP ============ -Default configuration file of *bgpd* is :file:`bgpd.conf`. -*bgpd* searches the current directory first then -|INSTALL_PREFIX_ETC|/bgpd.conf. All of bgpd's command must be -configured in :file:`bgpd.conf`. +Default configuration file of *bgpd* is :file:`bgpd.conf`. *bgpd* searches the +current directory first then |INSTALL_PREFIX_ETC|/bgpd.conf. All of bgpd's +command must be configured in :file:`bgpd.conf`. -*bgpd* specific invocation options are described below. Common -options may also be specified (:ref:`Common_Invocation_Options`). +*bgpd* specific invocation options are described below. Common options may also +be specified (:ref:`Common_Invocation_Options`). +.. program:: bgpd +.. option:: -p +.. option:: --bgp_port -*-p `PORT`* + Set the bgp protocol's port number. -*--bgp_port=`PORT`* - Set the bgp protocol's port number. +.. option:: -r +.. option:: --retain + When program terminates, retain BGP routes added by zebra. -*-r* +.. option:: -l +.. option:: --listenon -*--retain* - When program terminates, retain BGP routes added by zebra. - - -*-l* - -*--listenon* - Specify a specific IP address for bgpd to listen on, rather than its - default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd - to an internal address, or to run multiple bgpd processes on one host. + Specify a specific IP address for bgpd to listen on, rather than its + default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd + to an internal address, or to run multiple bgpd processes on one host. .. _BGP_router: @@ -52,33 +49,32 @@ options may also be specified (:ref:`Common_Invocation_Options`). BGP router ========== -First of all you must configure BGP router with *router bgp* -command. To configure BGP router, you need AS number. AS number is an -identification of autonomous system. BGP protocol uses the AS number -for detecting whether the BGP connection is internal one or external one. +First of all you must configure BGP router with *router bgp* command. To +configure BGP router, you need AS number. AS number is an identification of +autonomous system. BGP protocol uses the AS number for detecting whether the +BGP connection is internal one or external one. .. index:: router bgp ASN - .. clicmd:: router bgp ASN - Enable a BGP protocol process with the specified `asn`. After - this statement you can input any `BGP Commands`. You can not - create different BGP process under different `asn` without - specifying `multiple-instance` (:ref:`Multiple_instance`). + + Enable a BGP protocol process with the specified ASN. After + this statement you can input any `BGP Commands`. You can not + create different BGP process under different ASN without + specifying `multiple-instance` (:ref:`Multiple_instance`). .. index:: no router bgp ASN - .. clicmd:: no router bgp ASN - Destroy a BGP protocol process with the specified `asn`. -.. index:: bgp router-id `A.B.C.D` + Destroy a BGP protocol process with the specified ASN. -.. clicmd:: bgp router-id `A.B.C.D` +.. index:: bgp router-id A.B.C.D +.. clicmd:: bgp router-id A.B.C.D - This command specifies the router-ID. If *bgpd* connects to *zebra* it gets - interface and address information. In that case default router ID value - is selected as the largest IP Address of the interfaces. When - `router zebra` is not enabled *bgpd* can't get interface information - so `router-id` is set to 0.0.0.0. So please set router-id by hand. + This command specifies the router-ID. If *bgpd* connects to *zebra* it gets + interface and address information. In that case default router ID value is + selected as the largest IP Address of the interfaces. When `router zebra` is + not enabled *bgpd* can't get interface information so `router-id` is set to + 0.0.0.0. So please set router-id by hand. .. _BGP_distance: @@ -86,21 +82,16 @@ BGP distance ------------ .. index:: distance bgp (1-255) (1-255) (1-255) - .. clicmd:: distance bgp (1-255) (1-255) (1-255) - This command change distance value of BGP. Each argument is distance - value for external routes, internal routes and local routes. + This command change distance value of BGP. Each argument is distance value + for external routes, internal routes and local routes. -.. index:: distance (1-255) `A.B.C.D/M` +.. index:: distance (1-255) A.B.C.D/M +.. clicmd:: distance (1-255) A.B.C.D/M -.. clicmd:: distance (1-255) `A.B.C.D/M` - -.. index:: distance (1-255) `A.B.C.D/M` `word` - -.. clicmd:: distance (1-255) `A.B.C.D/M` `word` - - This command set distance value to +.. index:: distance (1-255) A.B.C.D/M word +.. clicmd:: distance (1-255) A.B.C.D/M word .. _BGP_decision_process: @@ -109,116 +100,112 @@ BGP decision process The decision process FRR BGP uses to select routes is as follows: +1. Weight check -*1. Weight check* - prefer higher local weight routes to lower routes. + Prefer higher local weight routes to lower routes. + +2. Local preference check -*2. Local preference check* - prefer higher local preference routes to lower. + Prefer higher local preference routes to lower. + +3. Local route check + + Prefer local routes (statics, aggregates, redistributed) to received routes. + +4. AS path length check + + Prefer shortest hop-count AS_PATHs. + +5. Origin check + + Prefer the lowest origin type route. That is, prefer IGP origin routes to + EGP, to Incomplete routes. + +6. MED check + + Where routes with a MED were received from the same AS, prefer the route + with the lowest MED. :ref:`BGP_MED`. + +7. External check + + Prefer the route received from an external, eBGP peer over routes received + from other types of peers. + +8. IGP cost check + + Prefer the route with the lower IGP cost. + +9. Multi-path check + + If multi-pathing is enabled, then check whether the routes not yet + distinguished in preference may be considered equal. If + :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are + considered equal, otherwise routes received via iBGP with identical AS_PATHs + or routes received from eBGP neighbours in the same AS are considered equal. + +10. Already-selected external check + + Where both routes were received from eBGP peers, then prefer the route + which is already selected. Note that this check is not applied if + :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent + some cases of oscillation. + +11. Router-ID check + + Prefer the route with the lowest `router-ID`. If the route has an + `ORIGINATOR_ID` attribute, through iBGP reflection, then that router ID is + used, otherwise the `router-ID` of the peer the route was received from is + used. + +12. Cluster-List length check + + The route with the shortest cluster-list length is used. The cluster-list + reflects the iBGP reflection path the route has taken. -*3. Local route check* - Prefer local routes (statics, aggregates, redistributed) to received routes. +13. Peer address - -*4. AS path length check* - Prefer shortest hop-count AS_PATHs. - - -*5. Origin check* - Prefer the lowest origin type route. That is, prefer IGP origin routes to - EGP, to Incomplete routes. - - -*6. MED check* - Where routes with a MED were received from the same AS, - prefer the route with the lowest MED. :ref:`BGP_MED`. - - -*7. External check* - Prefer the route received from an external, eBGP peer - over routes received from other types of peers. - - -*8. IGP cost check* - Prefer the route with the lower IGP cost. - - -*9. Multi-path check* - If multi-pathing is enabled, then check whether - the routes not yet distinguished in preference may be considered equal. If - :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are - considered equal, otherwise routes received via iBGP with identical AS_PATHs - or routes received from eBGP neighbours in the same AS are considered equal. - - -*10 Already-selected external check* - Where both routes were received from eBGP peers, then prefer the route which - is already selected. Note that this check is not applied if :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent some cases - of oscillation. - - -*11. Router-ID check* - Prefer the route with the lowest `router-ID`. If the - route has an `ORIGINATOR_ID` attribute, through iBGP reflection, then that - router ID is used, otherwise the `router-ID` of the peer the route was - received from is used. - - -*12. Cluster-List length check* - The route with the shortest cluster-list - length is used. The cluster-list reflects the iBGP reflection path the - route has taken. - - -*13. Peer address* - Prefer the route received from the peer with the higher - transport layer address, as a last-resort tie-breaker. + Prefer the route received from the peer with the higher + transport layer address, as a last-resort tie-breaker. .. index:: bgp bestpath as-path confed - .. clicmd:: bgp bestpath as-path confed - This command specifies that the length of confederation path sets and - sequences should should be taken into account during the BGP best path - decision process. + This command specifies that the length of confederation path sets and + sequences should should be taken into account during the BGP best path + decision process. +.. _bgp_bestpath_as-path_multipath-relax: .. index:: bgp bestpath as-path multipath-relax - .. clicmd:: bgp bestpath as-path multipath-relax - .. _bgp_bestpath_as-path_multipath-relax: - - This command specifies that BGP decision process should consider paths - of equal AS_PATH length candidates for multipath computation. Without - the knob, the entire AS_PATH must match for multipath computation. - -.. index:: bgp bestpath compare-routerid + This command specifies that BGP decision process should consider paths + of equal AS_PATH length candidates for multipath computation. Without + the knob, the entire AS_PATH must match for multipath computation. +.. _bgp_bestpath_compare-routerid: .. clicmd:: bgp bestpath compare-routerid - .. _bgp_bestpath_compare-routerid: + Ensure that when comparing routes where both are equal on most metrics, + including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken + based on router-ID. - Ensure that when comparing routes where both are equal on most metrics, - including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken - based on router-ID. + If this option is enabled, then the already-selected check, where + already selected eBGP routes are preferred, is skipped. - If this option is enabled, then the already-selected check, where - already selected eBGP routes are preferred, is skipped. + If a route has an `ORIGINATOR_ID` attribute because it has been reflected, + that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the + route was received from will be used. - If a route has an `ORIGINATOR_ID` attribute because it has been reflected, - that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the - route was received from will be used. - - The advantage of this is that the route-selection (at this point) will be - more deterministic. The disadvantage is that a few or even one lowest-ID - router may attract all trafic to otherwise-equal paths because of this - check. It may increase the possibility of MED or IGP oscillation, unless - other measures were taken to avoid these. The exact behaviour will be - sensitive to the iBGP and reflection topology. + The advantage of this is that the route-selection (at this point) will be + more deterministic. The disadvantage is that a few or even one lowest-ID + router may attract all trafic to otherwise-equal paths because of this + check. It may increase the possibility of MED or IGP oscillation, unless + other measures were taken to avoid these. The exact behaviour will be + sensitive to the iBGP and reflection topology. .. _BGP_route_flap_dampening: @@ -226,177 +213,171 @@ The decision process FRR BGP uses to select routes is as follows: BGP route flap dampening ------------------------ -.. index:: bgp dampening `(1-45)` `(1-20000)` `(1-20000)` `(1-255)` - -.. clicmd:: bgp dampening `(1-45)` `(1-20000)` `(1-20000)` `(1-255)` - - This command enables BGP route-flap dampening and specifies dampening parameters. +.. clicmd:: bgp dampening (1-45) (1-20000) (1-20000) (1-255) -*@asis{half-life}* - Half-life time for the penalty + This command enables BGP route-flap dampening and specifies dampening parameters. -*@asis{reuse-threshold}* - Value to start reusing a route -*@asis{suppress-threshold}* - Value to start suppressing a route + half-life + Half-life time for the penalty -*@asis{max-suppress}* - Maximum duration to suppress a stable route + reuse-threshold + Value to start reusing a route - The route-flap damping algorithm is compatible with :rfc:`2439`. The use of this command - is not recommended nowadays, see http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 . + suppress-threshold + Value to start suppressing a route + + max-suppress + Maximum duration to suppress a stable route + + The route-flap damping algorithm is compatible with :rfc:`2439`. The use of + this command is not recommended nowadays. + +.. seealso:: + + `http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 `_ .. _BGP_MED: BGP MED ======= -The BGP :abbr:`MED (Multi Exit Discriminator)` attribute has properties which can -cause subtle convergence problems in BGP. These properties and problems -have proven to be hard to understand, at least historically, and may still -not be widely understood. The following attempts to collect together and -present what is known about MED, to help operators and FRR users in -designing and configuring their networks. +The BGP :abbr:`MED (Multi Exit Discriminator)` attribute has properties which +can cause subtle convergence problems in BGP. These properties and problems +have proven to be hard to understand, at least historically, and may still not +be widely understood. The following attempts to collect together and present +what is known about MED, to help operators and FRR users in designing and +configuring their networks. The BGP :abbr:`MED` attribute is intended to allow one AS to indicate its preferences for its ingress points to another AS. The MED attribute will not be propagated on to another AS by the receiving AS - it is 'non-transitive' in the BGP sense. -E.g., if AS X and AS Y have 2 different BGP peering points, then AS X -might set a MED of 100 on routes advertised at one and a MED of 200 at the -other. When AS Y selects between otherwise equal routes to or via -AS X, AS Y should prefer to take the path via the lower MED peering of 100 with -AS X. Setting the MED allows an AS to influence the routing taken to it -within another, neighbouring AS. +E.g., if AS X and AS Y have 2 different BGP peering points, then AS X might set +a MED of 100 on routes advertised at one and a MED of 200 at the other. When AS +Y selects between otherwise equal routes to or via AS X, AS Y should prefer to +take the path via the lower MED peering of 100 with AS X. Setting the MED +allows an AS to influence the routing taken to it within another, neighbouring +AS. In this use of MED it is not really meaningful to compare the MED value on -routes where the next AS on the paths differs. E.g., if AS Y also had a -route for some destination via AS Z in addition to the routes from AS X, and -AS Z had also set a MED, it wouldn't make sense for AS Y to compare AS Z's -MED values to those of AS X. The MED values have been set by different -administrators, with different frames of reference. +routes where the next AS on the paths differs. E.g., if AS Y also had a route +for some destination via AS Z in addition to the routes from AS X, and AS Z had +also set a MED, it wouldn't make sense for AS Y to compare AS Z's MED values to +those of AS X. The MED values have been set by different administrators, with +different frames of reference. The default behaviour of BGP therefore is to not compare MED values across routes received from different neighbouring ASes. In FRR this is done by -comparing the neighbouring, left-most AS in the received AS_PATHs of the -routes and only comparing MED if those are the same. +comparing the neighbouring, left-most AS in the received AS_PATHs of the routes +and only comparing MED if those are the same. -@ifnottex -@macro mprec{} -@math{<} -@end macro -@end ifnottex - -Unfortunately, this behaviour of MED, of sometimes being compared across -routes and sometimes not, depending on the properties of those other routes, -means MED can cause the order of preference over all the routes to be -undefined. That is, given routes A, B, and C, if A is preferred to B, and B -is preferred to C, then a well-defined order should mean the preference is -transitive (in the sense of orders @footnote{For some set of objects to have -an order, there *must* be some binary ordering relation that is defined -for *every* combination of those objects, and that relation *must* -be transitive. I.e.@:, if the relation operator is @mprec{}, and if -a @mprec{} b and b @mprec{} c then that relation must carry over -and it *must* be that a @mprec{} c for the objects to have an -order. The ordering relation may allow for equality, i.e. -a @mprec{} b and b @mprec{} a may both be true amd imply that -a and b are equal in the order and not distinguished by it, in -which case the set has a partial order. Otherwise, if there is an order, -all the objects have a distinct place in the order and the set has a total -order.}) and that A would be preferred to C. +Unfortunately, this behaviour of MED, of sometimes being compared across routes +and sometimes not, depending on the properties of those other routes, means MED +can cause the order of preference over all the routes to be undefined. That is, +given routes A, B, and C, if A is preferred to B, and B is preferred to C, then +a well-defined order should mean the preference is transitive (in the sense of +orders @footnote{For some set of objects to have an order, there *must* be some +binary ordering relation that is defined for *every* combination of those +objects, and that relation *must* be transitive. I.e.@:, if the relation +operator is <, and if a < b and b < c then that relation +must carry over and it *must* be that a < c for the objects to have an +order. The ordering relation may allow for equality, i.e. a < b and b +< a may both be true amd imply that a and b are equal in the order and +not distinguished by it, in which case the set has a partial order. Otherwise, +if there is an order, all the objects have a distinct place in the order and +the set has a total order) and that A would be preferred to C. However, when MED is involved this need not be the case. With MED it is possible that C is actually preferred over A. So A is preferred to B, B is preferred to C, but C is preferred to A. This can be true even where BGP -defines a deterministic 'most preferred' route out of the full set of -A,B,C. With MED, for any given set of routes there may be a -deterministically preferred route, but there need not be any way to arrange -them into any order of preference. With unmodified MED, the order of -preference of routes literally becomes undefined. +defines a deterministic 'most preferred' route out of the full set of A,B,C. +With MED, for any given set of routes there may be a deterministically +preferred route, but there need not be any way to arrange them into any order +of preference. With unmodified MED, the order of preference of routes literally +becomes undefined. That MED can induce non-transitive preferences over routes can cause issues. -Firstly, it may be perceived to cause routing table churn locally at -speakers; secondly, and more seriously, it may cause routing instability in -iBGP topologies, where sets of speakers continually oscillate between -different paths. +Firstly, it may be perceived to cause routing table churn locally at speakers; +secondly, and more seriously, it may cause routing instability in iBGP +topologies, where sets of speakers continually oscillate between different +paths. The first issue arises from how speakers often implement routing decisions. -Though BGP defines a selection process that will deterministically select -the same route as best at any given speaker, even with MED, that process -requires evaluating all routes together. For performance and ease of -implementation reasons, many implementations evaluate route preferences in a -pair-wise fashion instead. Given there is no well-defined order when MED is -involved, the best route that will be chosen becomes subject to -implementation details, such as the order the routes are stored in. That -may be (locally) non-deterministic, e.g.@: it may be the order the routes -were received in. +Though BGP defines a selection process that will deterministically select the +same route as best at any given speaker, even with MED, that process requires +evaluating all routes together. For performance and ease of implementation +reasons, many implementations evaluate route preferences in a pair-wise fashion +instead. Given there is no well-defined order when MED is involved, the best +route that will be chosen becomes subject to implementation details, such as +the order the routes are stored in. That may be (locally) non-deterministic, +e.g.: it may be the order the routes were received in. This indeterminism may be considered undesirable, though it need not cause -problems. It may mean additional routing churn is perceived, as sometimes -more updates may be produced than at other times in reaction to some event . +problems. It may mean additional routing churn is perceived, as sometimes more +updates may be produced than at other times in reaction to some event . This first issue can be fixed with a more deterministic route selection that ensures routes are ordered by the neighbouring AS during selection. -:ref:`bgp_deterministic-med`. This may reduce the number of updates as -routes are received, and may in some cases reduce routing churn. Though, it -could equally deterministically produce the largest possible set of updates -in response to the most common sequence of received updates. +:ref:`bgp_deterministic-med`. This may reduce the number of updates as routes +are received, and may in some cases reduce routing churn. Though, it could +equally deterministically produce the largest possible set of updates in +response to the most common sequence of received updates. A deterministic order of evaluation tends to imply an additional overhead of sorting over any set of n routes to a destination. The implementation of deterministic MED in FRR scales significantly worse than most sorting -algorithms at present, with the number of paths to a given destination. -That number is often low enough to not cause any issues, but where there are -many paths, the deterministic comparison may quickly become increasingly -expensive in terms of CPU. +algorithms at present, with the number of paths to a given destination. That +number is often low enough to not cause any issues, but where there are many +paths, the deterministic comparison may quickly become increasingly expensive +in terms of CPU. -Deterministic local evaluation can *not* fix the second, more major, -issue of MED however. Which is that the non-transitive preference of routes -MED can cause may lead to routing instability or oscillation across multiple -speakers in iBGP topologies. This can occur with full-mesh iBGP, but is -particularly problematic in non-full-mesh iBGP topologies that further -reduce the routing information known to each speaker. This has primarily -been documented with iBGP route-reflection topologies. However, any -route-hiding technologies potentially could also exacerbate oscillation with -MED. +Deterministic local evaluation can *not* fix the second, more major, issue of +MED however. Which is that the non-transitive preference of routes MED can +cause may lead to routing instability or oscillation across multiple speakers +in iBGP topologies. This can occur with full-mesh iBGP, but is particularly +problematic in non-full-mesh iBGP topologies that further reduce the routing +information known to each speaker. This has primarily been documented with iBGP +route-reflection topologies. However, any route-hiding technologies potentially +could also exacerbate oscillation with MED. -This second issue occurs where speakers each have only a subset of routes, -and there are cycles in the preferences between different combinations of -routes - as the undefined order of preference of MED allows - and the routes -are distributed in a way that causes the BGP speakers to 'chase' those -cycles. This can occur even if all speakers use a deterministic order of -evaluation in route selection. +This second issue occurs where speakers each have only a subset of routes, and +there are cycles in the preferences between different combinations of routes - +as the undefined order of preference of MED allows - and the routes are +distributed in a way that causes the BGP speakers to 'chase' those cycles. This +can occur even if all speakers use a deterministic order of evaluation in route +selection. -E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and -from speaker 3 in AS Y; while speaker 5 in AS A might receive that route -from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 -at speaker 3. I.e, using ASN:ID:MED to label the speakers: +E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and from +speaker 3 in AS Y; while speaker 5 in AS A might receive that route from +speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 at speaker +3. I.e, using ASN:ID:MED to label the speakers: :: - /---------------\\ + . + /---------------\\ X:2------|--A:4-------A:5--|-Y:1:200 - Y:3:100--|-/ | - \\---------------/ + Y:3:100--|-/ | + \\---------------/ -Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then -based on the RFC4271 decision process speaker 4 will choose X:2 over -Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. -Speaker 5 will continue to prefer Y:1:200 based on the ID, and advertise -this to speaker 4. Speaker 4 will now have the full set of routes, and the -Y:1:200 it receives from 5 will beat X:2, but when speaker 4 compares -Y:1:200 to Y:3:100 the MED check now becomes active as the ASes match, and -now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5, -which will also agrees that Y:3:100 is preferred to Y:1:200, and so -withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100, -and X:2 beats Y:3:100, and so speaker 4 implicitly updates its route to -speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID, -and advertises Y:1:200 to speaker 4, and the cycle continues. +Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then based +on the RFC4271 decision process speaker 4 will choose X:2 over Y:3:100, based +on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. Speaker 5 will +continue to prefer Y:1:200 based on the ID, and advertise this to speaker 4. +Speaker 4 will now have the full set of routes, and the Y:1:200 it receives +from 5 will beat X:2, but when speaker 4 compares Y:1:200 to Y:3:100 the MED +check now becomes active as the ASes match, and now Y:3:100 is preferred. +Speaker 4 therefore now advertises Y:3:100 to 5, which will also agrees that +Y:3:100 is preferred to Y:1:200, and so withdraws the latter route from 4. +Speaker 4 now has only X:2 and Y:3:100, and X:2 beats Y:3:100, and so speaker 4 +implicitly updates its route to speaker 5 to X:2. Speaker 5 sees that Y:1:200 +beats X:2 based on the ID, and advertises Y:1:200 to speaker 4, and the cycle +continues. The root cause is the lack of a clear order of preference caused by how MED sometimes is and sometimes is not compared, leading to this cycle in the @@ -404,115 +385,110 @@ preferences between the routes: :: - /---> X:2 ---beats---> Y:3:100 --\\ - | | - | | - \\---beats--- Y:1:200 <---beats---/ + . + /---> X:2 ---beats---> Y:3:100 --\\ + | | + | | + \\---beats--- Y:1:200 <---beats---/ This particular type of oscillation in full-mesh iBGP topologies can be avoided by speakers preferring already selected, external routes rather than -choosing to update to new a route based on a post-MED metric (e.g. -router-ID), at the cost of a non-deterministic selection process. FRR -implements this, as do many other implementations, so long as it is not -overridden by setting :ref:`bgp_bestpath_compare-routerid`, and see also -:ref:`BGP_decision_process`, . +choosing to update to new a route based on a post-MED metric (e.g. router-ID), +at the cost of a non-deterministic selection process. FRR implements this, as +do many other implementations, so long as it is not overridden by setting +:ref:`bgp_bestpath_compare-routerid`, and see also :ref:`BGP_decision_process`, +. However, more complex and insidious cycles of oscillation are possible with iBGP route-reflection, which are not so easily avoided. These have been -documented in various places. See, e.g., @cite{McPherson, D. and Gill, V. -and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation -Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable -and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong, -"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete -examples and further references. +documented in various places. See, e.g.: -There is as of this writing *no* known way to use MED for its original -purpose; *and* reduce routing information in iBGP topologies; -*and* be sure to avoid the instability problems of MED due the -non-transitive routing preferences it can induce; in general on arbitrary -networks. +- [bgp-route-osci-cond]_ +- [stable-flexible-ibgp]_ +- [ibgp-correctness]_ -There may be iBGP topology specific ways to reduce the instability risks, -even while using MED, e.g.@: by constraining the reflection topology and by -tuning IGP costs between route-reflector clusters, see RFC3345 for details. -In the near future, the Add-Path extension to BGP may also solve MED -oscillation while still allowing MED to be used as intended, by distributing -"best-paths per neighbour AS". This would be at the cost of distributing at -least as many routes to all speakers as a full-mesh iBGP would, if not more, -while also imposing similar CPU overheads as the "Deterministic MED" feature -at each Add-Path reflector. +for concrete examples and further references. + +There is as of this writing *no* known way to use MED for its original purpose; +*and* reduce routing information in iBGP topologies; *and* be sure to avoid the +instability problems of MED due the non-transitive routing preferences it can +induce; in general on arbitrary networks. + +There may be iBGP topology specific ways to reduce the instability risks, even +while using MED, e.g.: by constraining the reflection topology and by tuning +IGP costs between route-reflector clusters, see RFC3345 for details. In the +near future, the Add-Path extension to BGP may also solve MED oscillation while +still allowing MED to be used as intended, by distributing "best-paths per +neighbour AS". This would be at the cost of distributing at least as many +routes to all speakers as a full-mesh iBGP would, if not more, while also +imposing similar CPU overheads as the "Deterministic MED" feature at each +Add-Path reflector. More generally, the instability problems that MED can introduce on more complex, non-full-mesh, iBGP topologies may be avoided either by: - -* - Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared +- Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared across values set by different neighbour ASes, which may not produce coherent desirable results, of itself. - -* - Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using +- Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using :ref:`routemap_set_metric` on all received routes, in combination with setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest and most performant way to avoid MED oscillation issues, where an AS is happy not to allow neighbours to inject this problematic metric. - As MED is evaluated after the AS_PATH length check, another possible use for MED is for intra-AS steering of routes with equal AS_PATH length, as an -extension of the last case above. As MED is evaluated before IGP metric, -this can allow cold-potato routing to be implemented to send traffic to -preferred hand-offs with neighbours, rather than the closest hand-off -according to the IGP metric. +extension of the last case above. As MED is evaluated before IGP metric, this +can allow cold-potato routing to be implemented to send traffic to preferred +hand-offs with neighbours, rather than the closest hand-off according to the +IGP metric. -Note that even if action is taken to address the MED non-transitivity -issues, other oscillations may still be possible. E.g., on IGP cost if -iBGP and IGP topologies are at cross-purposes with each other - see the -Flavel and Roughan paper above for an example. Hence the guideline that the -iBGP topology should follow the IGP topology. +Note that even if action is taken to address the MED non-transitivity issues, +other oscillations may still be possible. E.g., on IGP cost if iBGP and IGP +topologies are at cross-purposes with each other - see the Flavel and Roughan +paper above for an example. Hence the guideline that the iBGP topology should +follow the IGP topology. +.. _bgp_deterministic-med: .. index:: bgp deterministic-med - .. clicmd:: bgp deterministic-med - .. _bgp_deterministic-med: + Carry out route-selection in way that produces deterministic answers + locally, even in the face of MED and the lack of a well-defined order of + preference it can induce on routes. Without this option the preferred route + with MED may be determined largely by the order that routes were received + in. - Carry out route-selection in way that produces deterministic answers - locally, even in the face of MED and the lack of a well-defined order of - preference it can induce on routes. Without this option the preferred route - with MED may be determined largely by the order that routes were received - in. + Setting this option will have a performance cost that may be noticeable when + there are many routes for each destination. Currently in FRR it is + implemented in a way that scales poorly as the number of routes per + destination increases. - Setting this option will have a performance cost that may be noticeable when - there are many routes for each destination. Currently in FRR it is - implemented in a way that scales poorly as the number of routes per - destination increases. - - The default is that this option is not set. + The default is that this option is not set. Note that there are other sources of indeterminism in the route selection process, specifically, the preference for older and already selected routes from eBGP peers, :ref:`BGP_decision_process`. .. index:: bgp always-compare-med - .. clicmd:: bgp always-compare-med - .. _bgp_always-compare-med: +.. _bgp_always-compare-med: - Always compare the MED on routes, even when they were received from - different neighbouring ASes. Setting this option makes the order of - preference of routes more defined, and should eliminate MED induced - oscillations. + Always compare the MED on routes, even when they were received from + different neighbouring ASes. Setting this option makes the order of + preference of routes more defined, and should eliminate MED induced + oscillations. - If using this option, it may also be desirable to use :ref:`routemap_set_metric` to set MED to 0 on routes received from external neighbours. + If using this option, it may also be desirable to use + :ref:`routemap_set_metric` to set MED to 0 on routes received from external + neighbours. - This option can be used, together with :ref:`routemap_set_metric` to use MED - as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired - exit points. + This option can be used, together with :ref:`routemap_set_metric` to use MED + as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired + exit points. .. _BGP_network: @@ -525,25 +501,23 @@ BGP network BGP route --------- -.. index:: network `A.B.C.D/M` +.. index:: network A.B.C.D/M +.. clicmd:: network A.B.C.D/M -.. clicmd:: network `A.B.C.D/M` + This command adds the announcement network.:: - This command adds the announcement network.:: + router bgp 1 + address-family ipv4 unicast + network 10.0.0.0/8 + exit-address-family - router bgp 1 - address-family ipv4 unicast - network 10.0.0.0/8 - exit-address-family + This configuration example says that network 10.0.0.0/8 will be + announced to all neighbors. Some vendors' routers don't advertise + routes if they aren't present in their IGP routing tables; `bgpd` + doesn't care about IGP routes when announcing its routes. - This configuration example says that network 10.0.0.0/8 will be - announced to all neighbors. Some vendors' routers don't advertise - routes if they aren't present in their IGP routing tables; `bgpd` - doesn't care about IGP routes when announcing its routes. - -.. index:: no network `A.B.C.D/M` - -.. clicmd:: no network `A.B.C.D/M` +.. index:: no network A.B.C.D/M +.. clicmd:: no network A.B.C.D/M .. _Route_Aggregation: @@ -551,29 +525,26 @@ BGP route Route Aggregation ----------------- -.. index:: aggregate-address `A.B.C.D/M` +.. index:: aggregate-address A.B.C.D/M +.. clicmd:: aggregate-address A.B.C.D/M -.. clicmd:: aggregate-address `A.B.C.D/M` + This command specifies an aggregate address. - This command specifies an aggregate address. +.. index:: aggregate-address A.B.C.D/M as-set +.. clicmd:: aggregate-address A.B.C.D/M as-set -.. index:: aggregate-address `A.B.C.D/M` as-set + This command specifies an aggregate address. Resulting routes include + AS set. -.. clicmd:: aggregate-address `A.B.C.D/M` as-set +.. index:: aggregate-address A.B.C.D/M summary-only +.. clicmd:: aggregate-address A.B.C.D/M summary-only - This command specifies an aggregate address. Resulting routes include - AS set. + This command specifies an aggregate address. Aggreated routes will + not be announce. -.. index:: aggregate-address `A.B.C.D/M` summary-only +.. index:: no aggregate-address A.B.C.D/M +.. clicmd:: no aggregate-address A.B.C.D/M -.. clicmd:: aggregate-address `A.B.C.D/M` summary-only - - This command specifies an aggregate address. Aggreated routes will - not be announce. - -.. index:: no aggregate-address `A.B.C.D/M` - -.. clicmd:: no aggregate-address `A.B.C.D/M` .. _Redistribute_to_BGP: @@ -582,111 +553,102 @@ Redistribute to BGP ------------------- .. index:: redistribute kernel - .. clicmd:: redistribute kernel - Redistribute kernel route to BGP process. + Redistribute kernel route to BGP process. .. index:: redistribute static - .. clicmd:: redistribute static - Redistribute static route to BGP process. + Redistribute static route to BGP process. .. index:: redistribute connected - .. clicmd:: redistribute connected - Redistribute connected route to BGP process. + Redistribute connected route to BGP process. .. index:: redistribute rip - .. clicmd:: redistribute rip - Redistribute RIP route to BGP process. + Redistribute RIP route to BGP process. .. index:: redistribute ospf - .. clicmd:: redistribute ospf - Redistribute OSPF route to BGP process. + Redistribute OSPF route to BGP process. .. index:: redistribute vpn - .. clicmd:: redistribute vpn - Redistribute VNC routes to BGP process. + Redistribute VNC routes to BGP process. -.. index:: update-delay `max-delay` +.. index:: update-delay MAX-DELAY +.. clicmd:: update-delay MAX-DELAY -.. clicmd:: update-delay `max-delay` +.. index:: update-delay MAX-DELAY ESTABLISH-WAIT +.. clicmd:: update-delay MAX-DELAY ESTABLISH-WAIT -.. index:: update-delay `max-delay` `establish-wait` + This feature is used to enable read-only mode on BGP process restart or when + BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only + mode would begin as soon as the first peer reaches Established status and a + timer for max-delay seconds is started. -.. clicmd:: update-delay `max-delay` `establish-wait` + During this mode BGP doesn't run any best-path or generate any updates to its + peers. This mode continues until: - This feature is used to enable read-only mode on BGP process restart or when - BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only mode - would begin as soon as the first peer reaches Established status and a timer - for max-delay seconds is started. + 1. All the configured peers, except the shutdown peers, have sent explicit EOR + (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached + Established is considered an implicit-EOR. + If the establish-wait optional value is given, then BGP will wait for + peers to reach established from the begining of the update-delay till the + establish-wait period is over, i.e. the minimum set of established peers for + which EOR is expected would be peers established during the establish-wait + window, not necessarily all the configured neighbors. + 2. max-delay period is over. - During this mode BGP doesn't run any best-path or generate any updates to its - peers. This mode continues until: - 1. All the configured peers, except the shutdown peers, have sent explicit EOR - (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached - Established is considered an implicit-EOR. - If the establish-wait optional value is given, then BGP will wait for - peers to reach established from the begining of the update-delay till the - establish-wait period is over, i.e. the minimum set of established peers for - which EOR is expected would be peers established during the establish-wait - window, not necessarily all the configured neighbors. - 2. max-delay period is over. - On hitting any of the above two conditions, BGP resumes the decision process - and generates updates to its peers. + On hitting any of the above two conditions, BGP resumes the decision process + and generates updates to its peers. - Default max-delay is 0, i.e. the feature is off by default. + Default max-delay is 0, i.e. the feature is off by default. -.. index:: table-map `route-map-name` +.. index:: table-map ROUTE-MAP-NAME +.. clicmd:: table-map ROUTE-MAP-NAME -.. clicmd:: table-map `route-map-name` + This feature is used to apply a route-map on route updates from BGP to + Zebra. All the applicable match operations are allowed, such as match on + prefix, next-hop, communities, etc. Set operations for this attach-point are + limited to metric and next-hop only. Any operation of this feature does not + affect BGPs internal RIB. - This feature is used to apply a route-map on route updates from BGP to Zebra. - All the applicable match operations are allowed, such as match on prefix, - next-hop, communities, etc. Set operations for this attach-point are limited - to metric and next-hop only. Any operation of this feature does not affect - BGPs internal RIB. - - Supported for ipv4 and ipv6 address families. It works on multi-paths as well, - however, metric setting is based on the best-path only. + Supported for ipv4 and ipv6 address families. It works on multi-paths as + well, however, metric setting is based on the best-path only. .. _BGP_Peer: BGP Peer ======== - .. _Defining_Peer: Defining Peer ------------- -.. index:: neighbor `peer` remote-as `asn` +.. index:: neighbor PEER remote-as ASN +.. clicmd:: neighbor PEER remote-as ASN -.. clicmd:: neighbor `peer` remote-as `asn` - Creates a new neighbor whose remote-as is `asn`. `peer` - can be an IPv4 address or an IPv6 address.:: - - router bgp 1 - neighbor 10.0.0.1 remote-as 2 - - In this case my router, in AS-1, is trying to peer with AS-2 at - 10.0.0.1. - - This command must be the first command used when configuring a neighbor. - If the remote-as is not specified, *bgpd* will complain like this::: - - can't find neighbor 10.0.0.1 + Creates a new neighbor whose remote-as is ASN. PEER can be an IPv4 address + or an IPv6 address.:: + + router bgp 1 + neighbor 10.0.0.1 remote-as 2 + + In this case my router, in AS-1, is trying to peer with AS-2 at 10.0.0.1. + + This command must be the first command used when configuring a neighbor. If + the remote-as is not specified, *bgpd* will complain like this::: + + can't find neighbor 10.0.0.1 .. _BGP_Peer_commands: @@ -697,310 +659,277 @@ BGP Peer commands In a `router bgp` clause there are neighbor specific configurations required. -.. index:: neighbor `peer` shutdown +.. index:: neighbor PEER shutdown +.. clicmd:: neighbor PEER shutdown -.. clicmd:: neighbor `peer` shutdown +.. index:: no neighbor PEER shutdown +.. clicmd:: no neighbor PEER shutdown -.. index:: no neighbor `peer` shutdown + Shutdown the peer. We can delete the neighbor's configuration by + ``no neighbor PEER remote-as ASN`` but all configuration of the neighbor + will be deleted. When you want to preserve the configuration, but want to + drop the BGP peer, use this syntax. -.. clicmd:: no neighbor `peer` shutdown +.. index:: neighbor PEER ebgp-multihop +.. clicmd:: neighbor PEER ebgp-multihop - Shutdown the peer. We can delete the neighbor's configuration by - `no neighbor `peer` remote-as @var{as-number`} but all - configuration of the neighbor will be deleted. When you want to - preserve the configuration, but want to drop the BGP peer, use this - syntax. +.. index:: no neighbor PEER ebgp-multihop +.. clicmd:: no neighbor PEER ebgp-multihop -.. index:: neighbor `peer` ebgp-multihop -.. clicmd:: neighbor `peer` ebgp-multihop +.. index:: neighbor PEER description ... +.. clicmd:: neighbor PEER description ... -.. index:: no neighbor `peer` ebgp-multihop -.. clicmd:: no neighbor `peer` ebgp-multihop +.. index:: no neighbor PEER description ... +.. clicmd:: no neighbor PEER description ... -.. index:: neighbor `peer` description ... + Set description of the peer. -.. clicmd:: neighbor `peer` description ... +.. index:: neighbor PEER version VERSION +.. clicmd:: neighbor PEER version VERSION -.. index:: no neighbor `peer` description ... + Set up the neighbor's BGP version. `version` can be `4`, + `4+` or `4-`. BGP version `4` is the default value used for + BGP peering. BGP version `4+` means that the neighbor supports + Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but + the neighbor speaks the old Internet-Draft revision 00's Multiprotocol + Extensions for BGP-4. Some routing software is still using this + version. -.. clicmd:: no neighbor `peer` description ... +.. index:: neighbor PEER interface IFNAME +.. clicmd:: neighbor PEER interface IFNAME - Set description of the peer. -.. index:: neighbor `peer` version `version` +.. index:: no neighbor PEER interface IFNAME +.. clicmd:: no neighbor PEER interface IFNAME -.. clicmd:: neighbor `peer` version `version` + When you connect to a BGP peer over an IPv6 link-local address, you have to + specify the IFNAME of the interface used for the connection. To specify + IPv4 session addresses, see the ``neighbor PEER update-source`` command + below. - Set up the neighbor's BGP version. `version` can be `4`, - `4+` or `4-`. BGP version `4` is the default value used for - BGP peering. BGP version `4+` means that the neighbor supports - Multiprotocol Extensions for BGP-4. BGP version `4-` is similar but - the neighbor speaks the old Internet-Draft revision 00's Multiprotocol - Extensions for BGP-4. Some routing software is still using this - version. + This command is deprecated and may be removed in a future release. Its use + should be avoided. -.. index:: neighbor `peer` interface `ifname` +.. index:: neighbor PEER next-hop-self [all] +.. clicmd:: neighbor PEER next-hop-self [all] -.. clicmd:: neighbor `peer` interface `ifname` -.. index:: no neighbor `peer` interface `ifname` +.. index:: no neighbor PEER next-hop-self [all] +.. clicmd:: no neighbor PEER next-hop-self [all] -.. clicmd:: no neighbor `peer` interface `ifname` + This command specifies an announced route's nexthop as being equivalent to + the address of the bgp router if it is learned via eBGP. If the optional + keyword `all` is specified the modifiation is done also for routes learned + via iBGP. - When you connect to a BGP peer over an IPv6 link-local address, you - have to specify the `ifname` of the interface used for the - connection. To specify IPv4 session addresses, see the - `neighbor `peer` update-source` command below. +.. index:: neighbor PEER update-source +.. clicmd:: neighbor PEER update-source - This command is deprecated and may be removed in a future release. Its - use should be avoided. -.. index:: neighbor `peer` next-hop-self [all] +.. index:: no neighbor PEER update-source +.. clicmd:: no neighbor PEER update-source -.. clicmd:: neighbor `peer` next-hop-self [all] + Specify the IPv4 source address to use for the :abbr:`BGP` session to this + neighbour, may be specified as either an IPv4 address directly or as an + interface name (in which case the *zebra* daemon MUST be running in order + for *bgpd* to be able to retrieve interface state).:: -.. index:: no neighbor `peer` next-hop-self [all] + router bgp 64555 + neighbor foo update-source 192.168.0.1 + neighbor bar update-source lo0 -.. clicmd:: no neighbor `peer` next-hop-self [all] - This command specifies an announced route's nexthop as being equivalent - to the address of the bgp router if it is learned via eBGP. - If the optional keyword `all` is specified the modifiation is done - also for routes learned via iBGP. +.. index:: neighbor PEER default-originate +.. clicmd:: neighbor PEER default-originate -.. index:: neighbor `peer` update-source `` +.. index:: no neighbor PEER default-originate +.. clicmd:: no neighbor PEER default-originate -.. clicmd:: neighbor `peer` update-source `` + *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it + is in routing table. When you want to announce default routes to the + peer, use this command. -.. index:: no neighbor `peer` update-source +.. index:: neighbor PEER port PORT +.. clicmd:: neighbor PEER port PORT -.. clicmd:: no neighbor `peer` update-source +.. index:: neighbor PEER send-community +.. clicmd:: neighbor PEER send-community - Specify the IPv4 source address to use for the :abbr:`BGP` session to this - neighbour, may be specified as either an IPv4 address directly or - as an interface name (in which case the *zebra* daemon MUST be running - in order for *bgpd* to be able to retrieve interface state).:: +.. index:: neighbor PEER weight WEIGHT +.. clicmd:: neighbor PEER weight WEIGHT - router bgp 64555 - neighbor foo update-source 192.168.0.1 - neighbor bar update-source lo0 +.. index:: no neighbor PEER weight WEIGHT +.. clicmd:: no neighbor PEER weight WEIGHT -.. index:: neighbor `peer` default-originate + This command specifies a default `weight` value for the neighbor's routes. -.. clicmd:: neighbor `peer` default-originate +.. index:: neighbor PEER maximum-prefix NUMBER +.. clicmd:: neighbor PEER maximum-prefix NUMBER -.. index:: no neighbor `peer` default-originate -.. clicmd:: no neighbor `peer` default-originate +.. index:: no neighbor PEER maximum-prefix NUMBER +.. clicmd:: no neighbor PEER maximum-prefix NUMBER - *bgpd*'s default is to not announce the default route (0.0.0.0/0) even it - is in routing table. When you want to announce default routes to the - peer, use this command. -.. index:: neighbor `peer` port `port` +.. index:: neighbor PEER local-as AS-NUMBER +.. clicmd:: neighbor PEER local-as AS-NUMBER -.. clicmd:: neighbor `peer` port `port` -.. index:: neighbor `peer` port `port` +.. index:: neighbor PEER local-as AS-NUMBER no-prepend +.. clicmd:: neighbor PEER local-as AS-NUMBER no-prepend -.. clicmd:: neighbor `peer` port `port` -.. index:: neighbor `peer` send-community +.. index:: neighbor PEER local-as AS-NUMBER no-prepend replace-as +.. clicmd:: neighbor PEER local-as AS-NUMBER no-prepend replace-as -.. clicmd:: neighbor `peer` send-community -.. index:: neighbor `peer` send-community +.. index:: no neighbor PEER local-as +.. clicmd:: no neighbor PEER local-as -.. clicmd:: neighbor `peer` send-community + Specify an alternate AS for this BGP process when interacting with the + specified peer. With no modifiers, the specified local-as is prepended to + the received AS_PATH when receiving routing updates from the peer, and + prepended to the outgoing AS_PATH (after the process local AS) when + transmitting local routes to the peer. -.. index:: neighbor `peer` weight `weight` + If the no-prepend attribute is specified, then the supplied local-as is not + prepended to the received AS_PATH. -.. clicmd:: neighbor `peer` weight `weight` + If the replace-as attribute is specified, then only the supplied local-as is + prepended to the AS_PATH when transmitting local-route updates to this peer. -.. index:: no neighbor `peer` weight `weight` + Note that replace-as can only be specified if no-prepend is. -.. clicmd:: no neighbor `peer` weight `weight` + This command is only allowed for eBGP peers. - This command specifies a default `weight` value for the neighbor's - routes. +.. index:: neighbor PEER ttl-security hops NUMBER +.. clicmd:: neighbor PEER ttl-security hops NUMBER -.. index:: neighbor `peer` maximum-prefix `number` -.. clicmd:: neighbor `peer` maximum-prefix `number` +.. index:: no neighbor PEER ttl-security hops NUMBER +.. clicmd:: no neighbor PEER ttl-security hops NUMBER -.. index:: no neighbor `peer` maximum-prefix `number` - -.. clicmd:: no neighbor `peer` maximum-prefix `number` - -.. index:: neighbor `peer` local-as `as-number` - -.. clicmd:: neighbor `peer` local-as `as-number` - -.. index:: neighbor `peer` local-as `as-number` no-prepend - -.. clicmd:: neighbor `peer` local-as `as-number` no-prepend - -.. index:: neighbor `peer` local-as `as-number` no-prepend replace-as - -.. clicmd:: neighbor `peer` local-as `as-number` no-prepend replace-as - -.. index:: no neighbor `peer` local-as - -.. clicmd:: no neighbor `peer` local-as - - Specify an alternate AS for this BGP process when interacting with the - specified peer. With no modifiers, the specified local-as is prepended to - the received AS_PATH when receiving routing updates from the peer, and - prepended to the outgoing AS_PATH (after the process local AS) when - transmitting local routes to the peer. - - If the no-prepend attribute is specified, then the supplied local-as is not - prepended to the received AS_PATH. - - If the replace-as attribute is specified, then only the supplied local-as is - prepended to the AS_PATH when transmitting local-route updates to this peer. - - Note that replace-as can only be specified if no-prepend is. - - This command is only allowed for eBGP peers. - -.. index:: neighbor `peer` ttl-security hops `number` - -.. clicmd:: neighbor `peer` ttl-security hops `number` - -.. index:: no neighbor `peer` ttl-security hops `number` - -.. clicmd:: no neighbor `peer` ttl-security hops `number` - - This command enforces Generalized TTL Security Mechanism (GTSM), as - specified in RFC 5082. With this command, only neighbors that are the - specified number of hops away will be allowed to become neighbors. This - command is mututally exclusive with *ebgp-multihop*. + This command enforces Generalized TTL Security Mechanism (GTSM), as + specified in RFC 5082. With this command, only neighbors that are the + specified number of hops away will be allowed to become neighbors. This + command is mututally exclusive with *ebgp-multihop*. .. _Peer_filtering: Peer filtering -------------- -.. index:: neighbor `peer` distribute-list `name` [in|out] +.. index:: neighbor PEER distribute-list NAME [in|out] +.. clicmd:: neighbor PEER distribute-list NAME [in|out] -.. clicmd:: neighbor `peer` distribute-list `name` [in|out] - - This command specifies a distribute-list for the peer. `direct` is - ``in`` or ``out``. + This command specifies a distribute-list for the peer. `direct` is + ``in`` or ``out``. .. index:: neighbor PEER prefix-list NAME [in|out] - .. clicmd:: neighbor PEER prefix-list NAME [in|out] + .. index:: neighbor PEER filter-list NAME [in|out] - .. clicmd:: neighbor PEER filter-list NAME [in|out] -.. index:: neighbor `peer` route-map `name` [in|out] -.. clicmd:: neighbor `peer` route-map `name` [in|out] +.. index:: neighbor PEER route-map NAME [in|out] +.. clicmd:: neighbor PEER route-map NAME [in|out] - Apply a route-map on the neighbor. `direct` must be `in` or - `out`. + Apply a route-map on the neighbor. `direct` must be `in` or `out`. .. index:: bgp route-reflector allow-outbound-policy - .. clicmd:: bgp route-reflector allow-outbound-policy - By default, attribute modification via route-map policy out is not reflected - on reflected routes. This option allows the modifications to be reflected as - well. Once enabled, it affects all reflected routes. + By default, attribute modification via route-map policy out is not reflected + on reflected routes. This option allows the modifications to be reflected as + well. Once enabled, it affects all reflected routes. .. _BGP_Peer_Group: BGP Peer Group ============== -.. index:: neighbor `word` peer-group +.. index:: neighbor WORD peer-group +.. clicmd:: neighbor WORD peer-group -.. clicmd:: neighbor `word` peer-group + This command defines a new peer group. - This command defines a new peer group. +.. index:: neighbor PEER peer-group WORD +.. clicmd:: neighbor PEER peer-group WORD -.. index:: neighbor `peer` peer-group `word` - -.. clicmd:: neighbor `peer` peer-group `word` - - This command bind specific peer to peer group `word`. + This command bind specific peer to peer group WORD. .. _BGP_Address_Family: BGP Address Family ================== -Multiprotocol BGP enables BGP to carry routing information for multiple -Network Layer protocols. BGP supports multiple Address Family -Identifier (AFI), namely IPv4 and IPv6. Support is also provided for -multiple sets of per-AFI information via Subsequent Address Family -Identifiers (SAFI). In addition to unicast information, VPN information -:rfc:`4364` and :rfc:`4659`, and Encapsulation information -:rfc:`5512` is supported. +Multiprotocol BGP enables BGP to carry routing information for multiple Network +Layer protocols. BGP supports multiple Address Family Identifier (AFI), namely +IPv4 and IPv6. Support is also provided for multiple sets of per-AFI +information via Subsequent Address Family Identifiers (SAFI). In addition to +unicast information, VPN information :rfc:`4364` and :rfc:`4659`, and +Encapsulation information :rfc:`5512` is supported. .. index:: show ip bgp vpnv4 all - .. clicmd:: show ip bgp vpnv4 all -.. index:: show ipv6 bgp vpn all +.. index:: show ipv6 bgp vpn all .. clicmd:: show ipv6 bgp vpn all - Print active IPV4 or IPV6 routes advertised via the VPN SAFI. + + Print active IPV4 or IPV6 routes advertised via the VPN SAFI. .. index:: show ip bgp encap all - .. clicmd:: show ip bgp encap all -.. index:: show ipv6 bgp encap all +.. index:: show ipv6 bgp encap all .. clicmd:: show ipv6 bgp encap all - Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI. + + Print active IPV4 or IPV6 routes advertised via the Encapsulation SAFI. .. index:: show bgp ipv4 encap summary - .. clicmd:: show bgp ipv4 encap summary + .. index:: show bgp ipv4 vpn summary - .. clicmd:: show bgp ipv4 vpn summary + .. index:: show bgp ipv6 encap summary - .. clicmd:: show bgp ipv6 encap summary -.. index:: show bgp ipv6 vpn summary +.. index:: show bgp ipv6 vpn summary .. clicmd:: show bgp ipv6 vpn summary - Print a summary of neighbor connections for the specified AFI/SAFI combination. + + Print a summary of neighbor connections for the specified AFI/SAFI combination. .. _Autonomous_System: Autonomous System ================= -The :abbr:`AS (Autonomous System)` number is one of the essential -element of BGP. BGP is a distance vector routing protocol, and the -AS-Path framework provides distance vector metric and loop detection to -BGP. @cite{RFC1930, Guidelines for creation, selection, and -registration of an Autonomous System (AS)} provides some background on -the concepts of an AS. +The :abbr:`AS (Autonomous System)` number is one of the essential element of +BGP. BGP is a distance vector routing protocol, and the AS-Path framework +provides distance vector metric and loop detection to BGP. :rfc:`1930` provides +some background on the concepts of an AS. -The AS number is a two octet value, ranging in value from 1 to 65535. -The AS numbers 64512 through 65535 are defined as private AS numbers. -Private AS numbers must not to be advertised in the global Internet. +The AS number is a two octet value, ranging in value from 1 to 65535. The AS +numbers 64512 through 65535 are defined as private AS numbers. Private AS +numbers must not to be advertised in the global Internet. .. _Display_BGP_Routes_by_AS_Path: Display BGP Routes by AS Path ----------------------------- -To show BGP routes which has specific AS path information `show ip bgp` command can be used. +To show BGP routes which has specific AS path information `show ip bgp` command +can be used. .. index:: show bgp ipv4|ipv6 regexp LINE - .. clicmd:: show bgp ipv4|ipv6 regexp LINE - This commands displays BGP routes that matches a regular - expression `line` (:ref:`BGP_Regular_Expressions`). + + This commands displays BGP routes that matches a regular + expression `line` (:ref:`BGP_Regular_Expressions`). .. _AS_Path_Access_List: @@ -1010,15 +939,14 @@ AS Path Access List AS path access list is user defined AS path. .. index:: ip as-path access-list WORD permit|deny LINE - .. clicmd:: ip as-path access-list WORD permit|deny LINE - This command defines a new AS path access list. + + This command defines a new AS path access list. .. index:: no ip as-path access-list WORD - .. clicmd:: no ip as-path access-list WORD -.. index:: no ip as-path access-list WORD permit|deny LINE +.. index:: no ip as-path access-list WORD permit|deny LINE .. clicmd:: no ip as-path access-list WORD permit|deny LINE .. _Using_AS_Path_in_Route_Map: @@ -1027,151 +955,143 @@ Using AS Path in Route Map -------------------------- .. index:: match as-path WORD - .. clicmd:: match as-path WORD -.. index:: set as-path prepend AS-PATH +.. index:: set as-path prepend AS-PATH .. clicmd:: set as-path prepend AS-PATH - Prepend the given string of AS numbers to the AS_PATH. + + Prepend the given string of AS numbers to the AS_PATH. .. index:: set as-path prepend last-as NUM - .. clicmd:: set as-path prepend last-as NUM - Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. + + Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. .. _Private_AS_Numbers: Private AS Numbers ------------------ - .. _BGP_Communities_Attribute: BGP Communities Attribute ========================= -BGP communities attribute is widely used for implementing policy -routing. Network operators can manipulate BGP communities attribute -based on their network policy. BGP communities attribute is defined -in :t:`RFC1997, BGP Communities Attribute` and -@cite{RFC1998, An Application of the BGP Community Attribute -in Multi-home Routing}. It is an optional transitive attribute, -therefore local policy can travel through different autonomous system. +BGP communities attribute is widely used for implementing policy routing. +Network operators can manipulate BGP communities attribute based on their +network policy. BGP communities attribute is defined in :rfc:`1997` and +:rfc:`1998`. It is an optional transitive attribute, therefore local policy can +travel through different autonomous system. -Communities attribute is a set of communities values. Each -communities value is 4 octet long. The following format is used to -define communities value. +Communities attribute is a set of communities values. Each communities value is +4 octet long. The following format is used to define communities value. +AS:VAL + This format represents 4 octet communities value. ``AS`` is high order 2 + octet in digit format. ``VAL`` is low order 2 octet in digit format. This + format is useful to define AS oriented policy value. For example, + ``7675:80`` can be used when AS 7675 wants to pass local policy value 80 to + neighboring peer. -*AS:VAL* - This format represents 4 octet communities value. `AS` is high - order 2 octet in digit format. `VAL` is low order 2 octet in - digit format. This format is useful to define AS oriented policy - value. For example, `7675:80` can be used when AS 7675 wants to - pass local policy value 80 to neighboring peer. +internet + `internet` represents well-known communities value 0. -*internet* - `internet` represents well-known communities value 0. +no-export + ``no-export`` represents well-known communities value ``NO_EXPORT`` + ``0xFFFFFF01``. All routes carry this value must not be advertised to + outside a BGP confederation boundary. If neighboring BGP peer is part of BGP + confederation, the peer is considered as inside a BGP confederation + boundary, so the route will be announced to the peer. -*no-export* - ``no-export`` represents well-known communities value ``NO_EXPORT`` @\* - @r{(0xFFFFFF01)}. All routes carry this value must not be advertised - to outside a BGP confederation boundary. If neighboring BGP peer is - part of BGP confederation, the peer is considered as inside a BGP - confederation boundary, so the route will be announced to the peer. +no-advertise + ``no-advertise`` represents well-known communities value ``NO_ADVERTISE`` + ``0xFFFFFF02``. All routes carry this value must not be advertise to other + BGP peers. -*no-advertise* - ``no-advertise`` represents well-known communities value - ``NO_ADVERTISE`` @*@r{(0xFFFFFF02)}. All routes carry this value - must not be advertise to other BGP peers. +local-AS + ``local-AS`` represents well-known communities value ``NO_EXPORT_SUBCONFED`` + ``0xFFFFFF03``. All routes carry this value must not be advertised to + external BGP peers. Even if the neighboring router is part of confederation, + it is considered as external BGP peer, so the route will not be announced to + the peer. -*local-AS* - ``local-AS`` represents well-known communities value - ``NO_EXPORT_SUBCONFED`` @r{(0xFFFFFF03)}. All routes carry this - value must not be advertised to external BGP peers. Even if the - neighboring router is part of confederation, it is considered as - external BGP peer, so the route will not be announced to the peer. - -When BGP communities attribute is received, duplicated communities -value in the communities attribute is ignored and each communities -values are sorted in numerical order. +When BGP communities attribute is received, duplicated communities value in the +communities attribute is ignored and each communities values are sorted in +numerical order. .. _BGP_Community_Lists: BGP Community Lists ------------------- -BGP community list is a user defined BGP communites attribute list. -BGP community list can be used for matching or manipulating BGP -communities attribute in updates. +BGP community list is a user defined BGP communites attribute list. BGP +community list can be used for matching or manipulating BGP communities +attribute in updates. -There are two types of community list. One is standard community -list and another is expanded community list. Standard community list -defines communities attribute. Expanded community list defines -communities attribute string with regular expression. Standard -community list is compiled into binary format when user define it. -Standard community list will be directly compared to BGP communities -attribute in BGP updates. Therefore the comparison is faster than +There are two types of community list. One is standard community list and +another is expanded community list. Standard community list defines communities +attribute. Expanded community list defines communities attribute string with +regular expression. Standard community list is compiled into binary format when +user define it. Standard community list will be directly compared to BGP +communities attribute in BGP updates. Therefore the comparison is faster than expanded community list. .. index:: ip community-list standard NAME permit|deny COMMUNITY - .. clicmd:: ip community-list standard NAME permit|deny COMMUNITY - This command defines a new standard community list. `community` - is communities value. The `community` is compiled into community - structure. We can define multiple community list under same name. In - that case match will happen user defined order. Once the - community list matches to communities attribute in BGP updates it - return permit or deny by the community list definition. When there is - no matched entry, deny will be returned. When `community` is - empty it matches to any routes. + + This command defines a new standard community list. COMUNITY is + communities value. The COMUNITY is compiled into community structure. We + can define multiple community list under same name. In that case match will + happen user defined order. Once the community list matches to communities + attribute in BGP updates it return permit or deny by the community list + definition. When there is no matched entry, deny will be returned. When + COMUNITY is empty it matches to any routes. .. index:: ip community-list expanded NAME permit|deny LINE - .. clicmd:: ip community-list expanded NAME permit|deny LINE - This command defines a new expanded community list. `line` is a - string expression of communities attribute. `line` can be a - regular expression (:ref:`BGP_Regular_Expressions`) to match - the communities attribute in BGP updates. + + This command defines a new expanded community list. COMUNITY is a + string expression of communities attribute. COMUNITY can be a + regular expression (:ref:`BGP_Regular_Expressions`) to match + the communities attribute in BGP updates. .. index:: no ip community-list NAME - .. clicmd:: no ip community-list NAME + .. index:: no ip community-list standard NAME - .. clicmd:: no ip community-list standard NAME -.. index:: no ip community-list expanded NAME +.. index:: no ip community-list expanded NAME .. clicmd:: no ip community-list expanded NAME - These commands delete community lists specified by `name`. All of - community lists shares a single name space. So community lists can be - removed simpley specifying community lists name. + + These commands delete community lists specified by NAME. All of + community lists shares a single name space. So community lists can be + removed simpley specifying community lists name. .. index:: show ip community-list - .. clicmd:: show ip community-list + .. index:: show ip community-list NAME - .. clicmd:: show ip community-list NAME - This command displays current community list information. When - `name` is specified the specified community list's information is - shown. -:: + This command displays current community list information. When NAME is + specified the specified community list's information is shown. - # show ip community-list - Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet - Named Community expanded list EXPAND - permit : - - # show ip community-list CLIST - Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet + :: + + # show ip community-list + Named Community standard list CLIST + permit 7675:80 7675:100 no-export + deny internet + Named Community expanded list EXPAND + permit : + + # show ip community-list CLIST + Named Community standard list CLIST + permit 7675:80 7675:100 no-export + deny internet .. _Numbered_BGP_Community_Lists: @@ -1187,29 +1107,28 @@ as numbered community lists. On the other hand normal community lists is called as named community lists. .. index:: ip community-list (1-99) permit|deny COMMUNITY - .. clicmd:: ip community-list (1-99) permit|deny COMMUNITY - This command defines a new community list. (1-99) is standard - community list number. Community list name within this range defines - standard community list. When `community` is empty it matches to - any routes. + + This command defines a new community list. (1-99) is standard + community list number. Community list name within this range defines + standard community list. When `community` is empty it matches to + any routes. .. index:: ip community-list (100-199) permit|deny COMMUNITY - .. clicmd:: ip community-list (100-199) permit|deny COMMUNITY - This command defines a new community list. (100-199) is expanded - community list number. Community list name within this range defines - expanded community list. + + This command defines a new community list. (100-199) is expanded + community list number. Community list name within this range defines + expanded community list. .. index:: ip community-list NAME permit|deny COMMUNITY - .. clicmd:: ip community-list NAME permit|deny COMMUNITY - When community list type is not specifed, the community list type is - automatically detected. If `community` can be compiled into - communities attribute, the community list is defined as a standard - community list. Otherwise it is defined as an expanded community - list. This feature is left for backward compability. Use of this - feature is not recommended. + + When community list type is not specifed, the community list type is + automatically detected. If COMMUNITY can be compiled into communities + attribute, the community list is defined as a standard community list. + Otherwise it is defined as an expanded community list. This feature is left + for backward compability. Use of this feature is not recommended. .. _BGP_Community_in_Route_Map: @@ -1223,44 +1142,43 @@ implement their network policy based on BGP communities attribute. Following commands can be used in Route Map. .. index:: match community WORD - .. clicmd:: match community WORD -.. index:: match community WORD exact-match +.. index:: match community WORD exact-match .. clicmd:: match community WORD exact-match - This command perform match to BGP updates using community list - `word`. When the one of BGP communities value match to the one of - communities value in community list, it is match. When - `exact-match` keyword is spcified, match happen only when BGP - updates have completely same communities value specified in the - community list. + + This command perform match to BGP updates using community list WORD. When + the one of BGP communities value match to the one of communities value in + community list, it is match. When `exact-match` keyword is spcified, match + happen only when BGP updates have completely same communities value + specified in the community list. .. index:: set community none - .. clicmd:: set community none + .. index:: set community COMMUNITY - .. clicmd:: set community COMMUNITY -.. index:: set community COMMUNITY additive +.. index:: set community COMMUNITY additive .. clicmd:: set community COMMUNITY additive - This command manipulate communities value in BGP updates. When - `none` is specified as communities value, it removes entire - communities attribute from BGP updates. When `community` is not - `none`, specified communities value is set to BGP updates. If - BGP updates already has BGP communities value, the existing BGP - communities value is replaced with specified `community` value. - When `additive` keyword is specified, `community` is appended - to the existing communities value. + + This command manipulate communities value in BGP updates. When + `none` is specified as communities value, it removes entire + communities attribute from BGP updates. When `community` is not + `none`, specified communities value is set to BGP updates. If + BGP updates already has BGP communities value, the existing BGP + communities value is replaced with specified `community` value. + When `additive` keyword is specified, `community` is appended + to the existing communities value. .. index:: set comm-list WORD delete - .. clicmd:: set comm-list WORD delete - This command remove communities value from BGP communities attribute. - The `word` is community list name. When BGP route's communities - value matches to the community list `word`, the communities value - is removed. When all of communities value is removed eventually, the - BGP update's communities attribute is completely removed. + + This command remove communities value from BGP communities attribute. + The `word` is community list name. When BGP route's communities + value matches to the community list `word`, the communities value + is removed. When all of communities value is removed eventually, the + BGP update's communities attribute is completely removed. .. _Display_BGP_Routes_by_Community: @@ -1272,30 +1190,30 @@ To show BGP routes which has specific BGP communities attribute, `community` and `community-list` subcommand can be used. .. index:: show bgp ipv4|ipv6 community - .. clicmd:: show bgp ipv4|ipv6 community + .. index:: show bgp ipv4|ipv6 community COMMUNITY - .. clicmd:: show bgp ipv4|ipv6 community COMMUNITY -.. index:: show bgp ipv4|ipv6 community COMMUNITY exact-match +.. index:: show bgp ipv4|ipv6 community COMMUNITY exact-match .. clicmd:: show bgp ipv4|ipv6 community COMMUNITY exact-match - `show bgp {ipv4|ipv6} community` displays BGP routes which has communities - attribute. Where the address family can be IPv4 or IPv6 among others. When - `community` is specified, BGP routes that matches `community` value is - displayed. For this command, `internet` keyword can't be used for - `community` value. When `exact-match` is specified, it display only - routes that have an exact match. + + `show bgp {ipv4|ipv6} community` displays BGP routes which has communities + attribute. Where the address family can be IPv4 or IPv6 among others. When + `community` is specified, BGP routes that matches `community` value is + displayed. For this command, `internet` keyword can't be used for + `community` value. When `exact-match` is specified, it display only + routes that have an exact match. .. index:: show bgp ipv4|ipv6 community-list WORD - .. clicmd:: show bgp ipv4|ipv6 community-list WORD -.. index:: show bgp ipv4|ipv6 community-list WORD exact-match +.. index:: show bgp ipv4|ipv6 community-list WORD exact-match .. clicmd:: show bgp ipv4|ipv6 community-list WORD exact-match - This commands display BGP routes for the address family specified that matches - community list `word`. When `exact-match` is specified, display only - routes that have an exact match. + + This commands display BGP routes for the address family specified that matches + community list `word`. When `exact-match` is specified, display only + routes that have an exact match. .. _Using_BGP_Communities_Attribute: @@ -1306,125 +1224,113 @@ Following configuration is the most typical usage of BGP communities attribute. AS 7675 provides upstream Internet connection to AS 100. When following configuration exists in AS 7675, AS 100 networks operator can set local preference in AS 7675 network by setting BGP -communities attribute to the updates. +communities attribute to the updates.:: -:: - - router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family - ! - ip community-list 70 permit 7675:70 - ip community-list 70 deny - ip community-list 80 permit 7675:80 - ip community-list 80 deny - ip community-list 90 permit 7675:90 - ip community-list 90 deny - ! - route-map RMAP permit 10 - match community 70 - set local-preference 70 - ! - route-map RMAP permit 20 - match community 80 - set local-preference 80 - ! - route-map RMAP permit 30 - match community 90 - set local-preference 90 + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list 70 permit 7675:70 + ip community-list 70 deny + ip community-list 80 permit 7675:80 + ip community-list 80 deny + ip community-list 90 permit 7675:90 + ip community-list 90 deny + ! + route-map RMAP permit 10 + match community 70 + set local-preference 70 + ! + route-map RMAP permit 20 + match community 80 + set local-preference 80 + ! + route-map RMAP permit 30 + match community 90 + set local-preference 90 Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675. The route has communities value 7675:80 so when above configuration exists in AS 7675, announced route's local preference will be set to -value 80. +value 80.:: -:: - - router bgp 100 - network 10.0.0.0/8 - neighbor 192.168.0.2 remote-as 7675 - address-family ipv4 unicast - neighbor 192.168.0.2 route-map RMAP out - exit-address-family - ! - ip prefix-list PLIST permit 10.0.0.0/8 - ! - route-map RMAP permit 10 - match ip address prefix-list PLIST - set community 7675:80 + router bgp 100 + network 10.0.0.0/8 + neighbor 192.168.0.2 remote-as 7675 + address-family ipv4 unicast + neighbor 192.168.0.2 route-map RMAP out + exit-address-family + ! + ip prefix-list PLIST permit 10.0.0.0/8 + ! + route-map RMAP permit 10 + match ip address prefix-list PLIST + set community 7675:80 Following configuration is an example of BGP route filtering using communities attribute. This configuration only permit BGP routes which has BGP communities value 0:80 or 0:90. Network operator can put special internal communities value at BGP border router, then -limit the BGP routes announcement into the internal network. +limit the BGP routes announcement into the internal network.:: -:: - - router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family - ! - ip community-list 1 permit 0:80 0:90 - ! - route-map RMAP permit in - match community 1 + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list 1 permit 0:80 0:90 + ! + route-map RMAP permit in + match community 1 Following exmaple filter BGP routes which has communities value 1:1. When there is no match community-list returns deny. To avoid -filtering all of routes, we need to define permit any at last. +filtering all of routes, we need to define permit any at last.:: -:: - - router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family - ! - ip community-list standard FILTER deny 1:1 - ip community-list standard FILTER permit - ! - route-map RMAP permit 10 - match community FILTER + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list standard FILTER deny 1:1 + ip community-list standard FILTER permit + ! + route-map RMAP permit 10 + match community FILTER Communities value keyword `internet` has special meanings in standard community lists. In below example `internet` act as match any. It matches all of BGP routes even if the route does not -have communities attribute at all. So community list `INTERNET` -is same as above example's `FILTER`. +have communities attribute at all. So community list ``INTERNET`` +is same as above example's ``FILTER``.:: -:: - - ip community-list standard INTERNET deny 1:1 - ip community-list standard INTERNET permit internet + ip community-list standard INTERNET deny 1:1 + ip community-list standard INTERNET permit internet Following configuration is an example of communities value deletion. With this configuration communities value 100:1 and 100:2 is removed from BGP updates. For communities value deletion, only `permit` -community-list is used. `deny` community-list is ignored. +community-list is used. `deny` community-list is ignored.:: -:: - - router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family - ! - ip community-list standard DEL permit 100:1 100:2 - ! - route-map RMAP permit 10 - set comm-list DEL delete + router bgp 7675 + neighbor 192.168.0.1 remote-as 100 + address-family ipv4 unicast + neighbor 192.168.0.1 route-map RMAP in + exit-address-family + ! + ip community-list standard DEL permit 100:1 100:2 + ! + route-map RMAP permit 10 + set comm-list DEL delete .. _BGP_Extended_Communities_Attribute: @@ -1432,38 +1338,35 @@ community-list is used. `deny` community-list is ignored. BGP Extended Communities Attribute ================================== -BGP extended communities attribute is introduced with MPLS VPN/BGP -technology. MPLS VPN/BGP expands capability of network infrastructure -to provide VPN functionality. At the same time it requires a new -framework for policy routing. With BGP Extended Communities Attribute -we can use Route Target or Site of Origin for implementing network -policy for MPLS VPN/BGP. +BGP extended communities attribute is introduced with MPLS VPN/BGP technology. +MPLS VPN/BGP expands capability of network infrastructure to provide VPN +functionality. At the same time it requires a new framework for policy routing. +With BGP Extended Communities Attribute we can use Route Target or Site of +Origin for implementing network policy for MPLS VPN/BGP. -BGP Extended Communities Attribute is similar to BGP Communities -Attribute. It is an optional transitive attribute. BGP Extended -Communities Attribute can carry multiple Extended Community value. -Each Extended Community value is eight octet length. - -BGP Extended Communities Attribute provides an extended range -compared with BGP Communities Attribute. Adding to that there is a -type field in each value to provides community space structure. - -There are two format to define Extended Community value. One is AS -based format the other is IP address based format. +BGP Extended Communities Attribute is similar to BGP Communities Attribute. It +is an optional transitive attribute. BGP Extended Communities Attribute can +carry multiple Extended Community value. Each Extended Community value is +eight octet length. +BGP Extended Communities Attribute provides an extended range compared with BGP +Communities Attribute. Adding to that there is a type field in each value to +provides community space structure. +There are two format to define Extended Community value. One is AS based format +the other is IP address based format. *AS:VAL* - This is a format to define AS based Extended Community value. - `AS` part is 2 octets Global Administrator subfield in Extended - Community value. `VAL` part is 4 octets Local Administrator - subfield. `7675:100` represents AS 7675 policy value 100. + This is a format to define AS based Extended Community value. + `AS` part is 2 octets Global Administrator subfield in Extended + Community value. `VAL` part is 4 octets Local Administrator + subfield. `7675:100` represents AS 7675 policy value 100. *IP-Address:VAL* - This is a format to define IP address based Extended Community value. - `IP-Address` part is 4 octets Global Administrator subfield. - `VAL` part is 2 octets Local Administrator subfield. - `10.0.0.1:100` represents + This is a format to define IP address based Extended Community value. + `IP-Address` part is 4 octets Global Administrator subfield. + `VAL` part is 2 octets Local Administrator subfield. + `10.0.0.1:100` represents .. _BGP_Extended_Community_Lists: @@ -1474,48 +1377,48 @@ Expanded Community Lists is a user defined BGP Expanded Community Lists. .. index:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY - .. clicmd:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY - This command defines a new standard extcommunity-list. - `extcommunity` is extended communities value. The - `extcommunity` is compiled into extended community structure. We - can define multiple extcommunity-list under same name. In that case - match will happen user defined order. Once the extcommunity-list - matches to extended communities attribute in BGP updates it return - permit or deny based upon the extcommunity-list definition. When - there is no matched entry, deny will be returned. When - `extcommunity` is empty it matches to any routes. + + This command defines a new standard extcommunity-list. + `extcommunity` is extended communities value. The + `extcommunity` is compiled into extended community structure. We + can define multiple extcommunity-list under same name. In that case + match will happen user defined order. Once the extcommunity-list + matches to extended communities attribute in BGP updates it return + permit or deny based upon the extcommunity-list definition. When + there is no matched entry, deny will be returned. When + `extcommunity` is empty it matches to any routes. .. index:: ip extcommunity-list expanded NAME permit|deny LINE - .. clicmd:: ip extcommunity-list expanded NAME permit|deny LINE - This command defines a new expanded extcommunity-list. `line` is - a string expression of extended communities attribute. `line` can - be a regular expression (:ref:`BGP_Regular_Expressions`) to match an - extended communities attribute in BGP updates. + + This command defines a new expanded extcommunity-list. `line` is + a string expression of extended communities attribute. `line` can + be a regular expression (:ref:`BGP_Regular_Expressions`) to match an + extended communities attribute in BGP updates. .. index:: no ip extcommunity-list NAME - .. clicmd:: no ip extcommunity-list NAME + .. index:: no ip extcommunity-list standard NAME - .. clicmd:: no ip extcommunity-list standard NAME -.. index:: no ip extcommunity-list expanded NAME +.. index:: no ip extcommunity-list expanded NAME .. clicmd:: no ip extcommunity-list expanded NAME - These commands delete extended community lists specified by - `name`. All of extended community lists shares a single name - space. So extended community lists can be removed simpley specifying - the name. + + These commands delete extended community lists specified by + `name`. All of extended community lists shares a single name + space. So extended community lists can be removed simpley specifying + the name. .. index:: show ip extcommunity-list - .. clicmd:: show ip extcommunity-list -.. index:: show ip extcommunity-list NAME +.. index:: show ip extcommunity-list NAME .. clicmd:: show ip extcommunity-list NAME - This command displays current extcommunity-list information. When - `name` is specified the community list's information is shown. + + This command displays current extcommunity-list information. When + `name` is specified the community list's information is shown. :: @@ -1528,18 +1431,18 @@ BGP Extended Communities in Route Map ------------------------------------- .. index:: match extcommunity WORD - .. clicmd:: match extcommunity WORD -.. index:: set extcommunity rt EXTCOMMUNITY +.. index:: set extcommunity rt EXTCOMMUNITY .. clicmd:: set extcommunity rt EXTCOMMUNITY - This command set Route Target value. + + This command set Route Target value. .. index:: set extcommunity soo EXTCOMMUNITY - .. clicmd:: set extcommunity soo EXTCOMMUNITY - This command set Site of Origin value. + + This command set Site of Origin value. .. _BGP_Large_Communities_Attribute: @@ -1547,7 +1450,7 @@ BGP Large Communities Attribute =============================== The BGP Large Communities attribute was introduced in Feb 2017 with -:t:`RFC8092, BGP Large Communities Attribute`. +:rfc:`8092`. The BGP Large Communities Attribute is similar to the BGP Communities Attribute except that it has 3 components instead of two and each of @@ -1557,19 +1460,18 @@ the fact that the `GLOBAL` part below is now 4 octets wide allowing AS4 operators seamless use. - *GLOBAL:LOCAL1:LOCAL2* - This is the format to define Large Community values. Referencing - :t:`RFC8195, Use of BGP Large Communities` the values are commonly - referred to as follows. - The `GLOBAL` part is a 4 octet Global Administrator field, common - use of this field is the operators AS number. - The `LOCAL1` part is a 4 octet Local Data Part 1 subfield referred - to as a function. - The `LOCAL2` part is a 4 octet Local Data Part 2 field and referred - to as the parameter subfield. `65551:1:10` represents AS 65551 - function 1 and parameter 10. - The referenced RFC above gives some guidelines on recommended usage. + This is the format to define Large Community values. Referencing + :t:`RFC8195, Use of BGP Large Communities` the values are commonly + referred to as follows. + The `GLOBAL` part is a 4 octet Global Administrator field, common + use of this field is the operators AS number. + The `LOCAL1` part is a 4 octet Local Data Part 1 subfield referred + to as a function. + The `LOCAL2` part is a 4 octet Local Data Part 2 field and referred + to as the parameter subfield. `65551:1:10` represents AS 65551 + function 1 and parameter 10. + The referenced RFC above gives some guidelines on recommended usage. .. _BGP_Large_Community_Lists: @@ -1580,52 +1482,52 @@ Two types of large community lists are supported, namely `standard` and `expanded`. .. index:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY - .. clicmd:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY - This command defines a new standard large-community-list. - `large-community` is the Large Community value. We - can add multiple large communities under same name. In that case - the match will happen in the user defined order. Once the large-community-list - matches the Large Communities attribute in BGP updates it will return - permit or deny based upon the large-community-list definition. When - there is no matched entry, a deny will be returned. When `large-community` - is empty it matches any routes. + + This command defines a new standard large-community-list. + `large-community` is the Large Community value. We + can add multiple large communities under same name. In that case + the match will happen in the user defined order. Once the large-community-list + matches the Large Communities attribute in BGP updates it will return + permit or deny based upon the large-community-list definition. When + there is no matched entry, a deny will be returned. When `large-community` + is empty it matches any routes. .. index:: ip large-community-list expanded NAME permit|deny LINE - .. clicmd:: ip large-community-list expanded NAME permit|deny LINE - This command defines a new expanded large-community-list. Where `line` is - a string matching expression, it will be compared to the entire Large Communities - attribute as a string, with each large-community in order from lowest to highest. - `line` can also be a regular expression which matches this Large - Community attribute. + + This command defines a new expanded large-community-list. Where `line` is + a string matching expression, it will be compared to the entire Large Communities + attribute as a string, with each large-community in order from lowest to highest. + `line` can also be a regular expression which matches this Large + Community attribute. .. index:: no ip large-community-list NAME - .. clicmd:: no ip large-community-list NAME + .. index:: no ip large-community-list standard NAME - .. clicmd:: no ip large-community-list standard NAME -.. index:: no ip large-community-list expanded NAME +.. index:: no ip large-community-list expanded NAME .. clicmd:: no ip large-community-list expanded NAME - These commands delete Large Community lists specified by - `name`. All Large Community lists share a single namespace. - This means Large Community lists can be removed by simply specifying the name. + + These commands delete Large Community lists specified by + `name`. All Large Community lists share a single namespace. + This means Large Community lists can be removed by simply specifying the name. .. index:: show ip large-community-list - .. clicmd:: show ip large-community-list -.. index:: show ip large-community-list NAME +.. index:: show ip large-community-list NAME .. clicmd:: show ip large-community-list NAME - This command display current large-community-list information. When - `name` is specified the community list information is shown. + + This command display current large-community-list information. When + `name` is specified the community list information is shown. .. index:: show ip bgp large-community-info - .. clicmd:: show ip bgp large-community-info - This command displays the current large communities in use. + + This command displays the current large communities in use. .. _BGP_Large_Communities_in_Route_Map: @@ -1633,27 +1535,27 @@ BGP Large Communities in Route Map ---------------------------------- .. index:: match large-community LINE - .. clicmd:: match large-community LINE - Where `line` can be a simple string to match, or a regular expression. - It is very important to note that this match occurs on the entire - large-community string as a whole, where each large-community is ordered - from lowest to highest. + + Where `line` can be a simple string to match, or a regular expression. + It is very important to note that this match occurs on the entire + large-community string as a whole, where each large-community is ordered + from lowest to highest. .. index:: set large-community LARGE-COMMUNITY - .. clicmd:: set large-community LARGE-COMMUNITY + .. index:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY - .. clicmd:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY -.. index:: set large-community LARGE-COMMUNITY additive +.. index:: set large-community LARGE-COMMUNITY additive .. clicmd:: set large-community LARGE-COMMUNITY additive - These commands are used for setting large-community values. The first - command will overwrite any large-communities currently present. - The second specifies two large-communities, which overwrites the current - large-community list. The third will add a large-community value without - overwriting other values. Multiple large-community values can be specified. + + These commands are used for setting large-community values. The first + command will overwrite any large-communities currently present. + The second specifies two large-communities, which overwrites the current + large-community list. The third will add a large-community value without + overwriting other values. Multiple large-community values can be specified. .. _Displaying_BGP_information: @@ -1667,70 +1569,70 @@ Showing BGP information ----------------------- .. index:: show ip bgp - .. clicmd:: show ip bgp + .. index:: show ip bgp A.B.C.D - .. clicmd:: show ip bgp A.B.C.D + .. index:: show ip bgp X:X::X:X - .. clicmd:: show ip bgp X:X::X:X - This command displays BGP routes. When no route is specified it - display all of IPv4 BGP routes. -:: + This command displays BGP routes. When no route is specified it + display all of IPv4 BGP routes. + :: + BGP table version is 0, local router ID is 10.1.1.1 - Status codes: s suppressed, d damped, h history, * valid, > best, i - internal - Origin codes: i - IGP, e - EGP, ? - incomplete - - Network Next Hop Metric LocPrf Weight Path - *> 1.1.1.1/32 0.0.0.0 0 32768 i - - Total number of prefixes 1 + Status codes: s suppressed, d damped, h history, * valid, > best, i - internal + Origin codes: i - IGP, e - EGP, ? - incomplete + + Network Next Hop Metric LocPrf Weight Path + \*> 1.1.1.1/32 0.0.0.0 0 32768 i + + Total number of prefixes 1 .. index:: show ip bgp regexp LINE - .. clicmd:: show ip bgp regexp LINE - This command displays BGP routes using AS path regular expression - (:ref:`BGP_Regular_Expressions`). + + This command displays BGP routes using AS path regular expression + (:ref:`BGP_Regular_Expressions`). .. index:: show ip bgp community COMMUNITY - .. clicmd:: show ip bgp community COMMUNITY -.. index:: show ip bgp community COMMUNITY exact-match +.. index:: show ip bgp community COMMUNITY exact-match .. clicmd:: show ip bgp community COMMUNITY exact-match - This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). + + This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). .. index:: show ip bgp community-list WORD - .. clicmd:: show ip bgp community-list WORD -.. index:: show ip bgp community-list WORD exact-match +.. index:: show ip bgp community-list WORD exact-match .. clicmd:: show ip bgp community-list WORD exact-match - This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). + + This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). .. index:: show bgp ipv4|ipv6 summary - .. clicmd:: show bgp ipv4|ipv6 summary - Show a bgp peer summary for the specified address family. + + Show a bgp peer summary for the specified address family. .. index:: show bgp ipv4|ipv6 neighbor [PEER] - .. clicmd:: show bgp ipv4|ipv6 neighbor [PEER] - This command shows information on a specific BGP `peer`. + + This command shows information on a specific BGP `peer`. .. index:: show bgp ipv4|ipv6 dampening dampened-paths - .. clicmd:: show bgp ipv4|ipv6 dampening dampened-paths - Display paths suppressed due to dampening. + + Display paths suppressed due to dampening. .. index:: show bgp ipv4|ipv6 dampening flap-statistics - .. clicmd:: show bgp ipv4|ipv6 dampening flap-statistics - Display flap statistics of routes. + + Display flap statistics of routes. .. _Other_BGP_commands: @@ -1738,42 +1640,42 @@ Other BGP commands ------------------ .. index:: clear bgp ipv4|ipv6 \* - .. clicmd:: clear bgp ipv4|ipv6 \* - Clear all address family peers. + + Clear all address family peers. .. index:: clear bgp ipv4|ipv6 PEER - .. clicmd:: clear bgp ipv4|ipv6 PEER - Clear peers which have addresses of X.X.X.X + + Clear peers which have addresses of X.X.X.X .. index:: clear bgp ipv4|ipv6 PEER soft in - .. clicmd:: clear bgp ipv4|ipv6 PEER soft in - Clear peer using soft reconfiguration. + + Clear peer using soft reconfiguration. .. index:: show debug - .. clicmd:: show debug + .. index:: debug event - .. clicmd:: debug event + .. index:: debug update - .. clicmd:: debug update + .. index:: debug keepalive - .. clicmd:: debug keepalive + .. index:: no debug event - .. clicmd:: no debug event + .. index:: no debug update - .. clicmd:: no debug update -.. index:: no debug keepalive +.. index:: no debug keepalive .. clicmd:: no debug keepalive + .. _Capability_Negotiation: Capability Negotiation @@ -1813,72 +1715,62 @@ Unsupported Capability error and then resets the connection. If you want to completely match capabilities with remote peer. Please use *strict-capability-match* command. -.. index:: neighbor `peer` strict-capability-match +.. index:: neighbor PEER strict-capability-match +.. clicmd:: neighbor PEER strict-capability-match -.. clicmd:: neighbor `peer` strict-capability-match +.. index:: no neighbor PEER strict-capability-match +.. clicmd:: no neighbor PEER strict-capability-match -.. index:: no neighbor `peer` strict-capability-match + Strictly compares remote capabilities and local capabilities. If capabilities + are different, send Unsupported Capability error then reset connection. -.. clicmd:: no neighbor `peer` strict-capability-match + You may want to disable sending Capability Negotiation OPEN message + optional parameter to the peer when remote peer does not implement + Capability Negotiation. Please use *dont-capability-negotiate* + command to disable the feature. - Strictly compares remote capabilities and local capabilities. If capabilities - are different, send Unsupported Capability error then reset connection. +.. index:: neighbor PEER dont-capability-negotiate +.. clicmd:: neighbor PEER dont-capability-negotiate - You may want to disable sending Capability Negotiation OPEN message - optional parameter to the peer when remote peer does not implement - Capability Negotiation. Please use *dont-capability-negotiate* - command to disable the feature. +.. index:: no neighbor PEER dont-capability-negotiate +.. clicmd:: no neighbor PEER dont-capability-negotiate -.. index:: neighbor `peer` dont-capability-negotiate + Suppress sending Capability Negotiation as OPEN message optional + parameter to the peer. This command only affects the peer is configured + other than IPv4 unicast configuration. -.. clicmd:: neighbor `peer` dont-capability-negotiate + When remote peer does not have capability negotiation feature, remote + peer will not send any capabilities at all. In that case, bgp + configures the peer with configured capabilities. -.. index:: no neighbor `peer` dont-capability-negotiate + You may prefer locally configured capabilities more than the negotiated + capabilities even though remote peer sends capabilities. If the peer + is configured by *override-capability*, *bgpd* ignores + received capabilities then override negotiated capabilities with + configured values. -.. clicmd:: no neighbor `peer` dont-capability-negotiate +.. index:: neighbor PEER override-capability +.. clicmd:: neighbor PEER override-capability - Suppress sending Capability Negotiation as OPEN message optional - parameter to the peer. This command only affects the peer is configured - other than IPv4 unicast configuration. +.. index:: no neighbor PEER override-capability +.. clicmd:: no neighbor PEER override-capability - When remote peer does not have capability negotiation feature, remote - peer will not send any capabilities at all. In that case, bgp - configures the peer with configured capabilities. - - You may prefer locally configured capabilities more than the negotiated - capabilities even though remote peer sends capabilities. If the peer - is configured by *override-capability*, *bgpd* ignores - received capabilities then override negotiated capabilities with - configured values. - -.. index:: neighbor `peer` override-capability - -.. clicmd:: neighbor `peer` override-capability - -.. index:: no neighbor `peer` override-capability - -.. clicmd:: no neighbor `peer` override-capability - - Override the result of Capability Negotiation with local configuration. - Ignore remote peer's capability value. + Override the result of Capability Negotiation with local configuration. + Ignore remote peer's capability value. .. _Route_Reflector: Route Reflector =============== -.. index:: bgp cluster-id `a.b.c.d` +.. index:: bgp cluster-id A.B.C.D +.. clicmd:: bgp cluster-id A.B.C.D -.. clicmd:: bgp cluster-id `a.b.c.d` +.. index:: neighbor PEER route-reflector-client +.. clicmd:: neighbor PEER route-reflector-client - -.. index:: neighbor `peer` route-reflector-client - -.. clicmd:: neighbor `peer` route-reflector-client - -.. index:: no neighbor `peer` route-reflector-client - -.. clicmd:: no neighbor `peer` route-reflector-client +.. index:: no neighbor PEER route-reflector-client +.. clicmd:: no neighbor PEER route-reflector-client .. _Route_Server: @@ -1886,48 +1778,47 @@ Route Reflector Route Server ============ -At an Internet Exchange point, many ISPs are connected to each other by -external BGP peering. Normally these external BGP connection are done by -.. clicmd:: full mesh method. As with internal BGP full mesh formation, +At an Internet Exchange point, many ISPs are connected to each other by the +"full mesh method". As with internal BGP full mesh formation, + this method has a scaling problem. -This scaling problem is well known. Route Server is a method to resolve -the problem. Each ISP's BGP router only peers to Route Server. Route -Server serves as BGP information exchange to other BGP routers. By -applying this method, numbers of BGP connections is reduced from -O(n*(n-1)/2) to O(n). +This scaling problem is well known. Route Server is a method to resolve the +problem. Each ISP's BGP router only peers to Route Server. Route Server serves +as BGP information exchange to other BGP routers. By applying this method, +numbers of BGP connections is reduced from O(n*(n-1)/2) to O(n). -Unlike normal BGP router, Route Server must have several routing tables -for managing different routing policies for each BGP speaker. We call the -routing tables as different ``view`` s. *bgpd* can work as -normal BGP router or Route Server or both at the same time. +Unlike normal BGP router, Route Server must have several routing tables for +managing different routing policies for each BGP speaker. We call the routing +tables as different "views". *bgpd* can work as normal BGP router or Route +Server or both at the same time. .. _Multiple_instance: Multiple instance ----------------- -To enable multiple view function of `bgpd`, you must turn on -multiple instance feature beforehand. +To enable multiple view function of *bgpd*, you must turn on multiple instance +feature beforehand. .. index:: bgp multiple-instance - .. clicmd:: bgp multiple-instance - Enable BGP multiple instance feature. After this feature is enabled, - you can make multiple BGP instances or multiple BGP views. + + Enable BGP multiple instance feature. After this feature is enabled, + you can make multiple BGP instances or multiple BGP views. .. index:: no bgp multiple-instance - .. clicmd:: no bgp multiple-instance - Disable BGP multiple instance feature. You can not disable this feature - when BGP multiple instances or views exist. + + Disable BGP multiple instance feature. You can not disable this feature + when BGP multiple instances or views exist. When you want to make configuration more Cisco like one, .. index:: bgp config-type cisco - .. clicmd:: bgp config-type cisco - Cisco compatible BGP configuration output. + + Cisco compatible BGP configuration output. When bgp config-type cisco is specified, @@ -1949,29 +1840,27 @@ attribute are sent to neighbor. When user manually disable the feature community attribute is not sent to the neighbor. In case of *bgp config-type cisco* is specified, community attribute is not sent to the neighbor by default. To send community attribute user has -to specify *neighbor A.B.C.D send-community* command. +to specify *neighbor A.B.C.D send-community* command.:: -:: - - ! - router bgp 1 - neighbor 10.0.0.1 remote-as 1 - address-family ipv4 unicast - no neighbor 10.0.0.1 send-community - exit-address-family - ! - router bgp 1 - neighbor 10.0.0.1 remote-as 1 - address-family ipv4 unicast - neighbor 10.0.0.1 send-community - exit-address-family - ! + ! + router bgp 1 + neighbor 10.0.0.1 remote-as 1 + address-family ipv4 unicast + no neighbor 10.0.0.1 send-community + exit-address-family + ! + router bgp 1 + neighbor 10.0.0.1 remote-as 1 + address-family ipv4 unicast + neighbor 10.0.0.1 send-community + exit-address-family + ! .. index:: bgp config-type zebra - .. clicmd:: bgp config-type zebra - FRR style BGP configuration. This is default. + + FRR style BGP configuration. This is default. .. _BGP_instance_and_view: @@ -1983,21 +1872,21 @@ goes to the kernel routing table. You can setup different AS at the same time when BGP multiple instance feature is enabled. .. index:: router bgp AS-NUMBER - .. clicmd:: router bgp AS-NUMBER - Make a new BGP instance. You can use arbitrary word for the `name`. -:: + Make a new BGP instance. You can use arbitrary word for the `name`. - bgp multiple-instance - ! - router bgp 1 - neighbor 10.0.0.1 remote-as 2 - neighbor 10.0.0.2 remote-as 3 - ! - router bgp 2 - neighbor 10.0.0.3 remote-as 4 - neighbor 10.0.0.4 remote-as 5 + :: + + bgp multiple-instance + ! + router bgp 1 + neighbor 10.0.0.1 remote-as 2 + neighbor 10.0.0.2 remote-as 3 + ! + router bgp 2 + neighbor 10.0.0.3 remote-as 4 + neighbor 10.0.0.4 remote-as 5 BGP view is almost same as normal BGP process. The result of @@ -2005,24 +1894,24 @@ route selection does not go to the kernel routing table. BGP view is only for exchanging BGP routing information. .. index:: router bgp AS-NUMBER view NAME - .. clicmd:: router bgp AS-NUMBER view NAME - Make a new BGP view. You can use arbitrary word for the `name`. This - view's route selection result does not go to the kernel routing table. -With this command, you can setup Route Server like below. + Make a new BGP view. You can use arbitrary word for the `name`. This view's + route selection result does not go to the kernel routing table. -:: + With this command, you can setup Route Server like below. - bgp multiple-instance - ! - router bgp 1 view 1 - neighbor 10.0.0.1 remote-as 2 - neighbor 10.0.0.2 remote-as 3 - ! - router bgp 2 view 2 - neighbor 10.0.0.3 remote-as 4 - neighbor 10.0.0.4 remote-as 5 + :: + + bgp multiple-instance + ! + router bgp 1 view 1 + neighbor 10.0.0.1 remote-as 2 + neighbor 10.0.0.2 remote-as 3 + ! + router bgp 2 view 2 + neighbor 10.0.0.3 remote-as 4 + neighbor 10.0.0.4 remote-as 5 .. _Routing_policy: @@ -2031,23 +1920,21 @@ Routing policy -------------- You can set different routing policy for a peer. For example, you can -set different filter for a peer. +set different filter for a peer.:: -:: - - bgp multiple-instance - ! - router bgp 1 view 1 - neighbor 10.0.0.1 remote-as 2 - address-family ipv4 unicast - neighbor 10.0.0.1 distribute-list 1 in - exit-address-family - ! - router bgp 1 view 2 - neighbor 10.0.0.1 remote-as 2 - address-family ipv4 unicast - neighbor 10.0.0.1 distribute-list 2 in - exit-address-family + bgp multiple-instance + ! + router bgp 1 view 1 + neighbor 10.0.0.1 remote-as 2 + address-family ipv4 unicast + neighbor 10.0.0.1 distribute-list 1 in + exit-address-family + ! + router bgp 1 view 2 + neighbor 10.0.0.1 remote-as 2 + address-family ipv4 unicast + neighbor 10.0.0.1 distribute-list 2 in + exit-address-family This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view @@ -2063,9 +1950,9 @@ Viewing the view To display routing table of BGP view, you must specify view name. .. index:: show ip bgp view NAME - .. clicmd:: show ip bgp view NAME - Display routing table of BGP view `name`. + + Display routing table of BGP view ``NAME``. .. _BGP_Regular_Expressions: @@ -2078,32 +1965,30 @@ expressions. The following description is just a quick subset of the '_' is added. - -*.* - Matches any single character. +.* + Matches any single character. * - Matches 0 or more occurrences of pattern. + Matches 0 or more occurrences of pattern. + - Matches 1 or more occurrences of pattern. + Matches 1 or more occurrences of pattern. ? - Match 0 or 1 occurrences of pattern. + Match 0 or 1 occurrences of pattern. ^ - Matches the beginning of the line. + Matches the beginning of the line. $ - Matches the end of the line. + Matches the end of the line. _ - Character `_` has special meanings in BGP regular expressions. - It matches to space and comma , and AS set delimiter { and } and AS - confederation delimiter `(` and `)`. And it also matches to - the beginning of the line and the end of the line. So `_` can be - used for AS value boundaries match. This character technically evaluates - to `(^|[,{}() ]|$)`. + Character `_` has special meanings in BGP regular expressions. It matches + to space and comma , and AS set delimiter { and } and AS confederation + delimiter `(` and `)`. And it also matches to the beginning of the line and + the end of the line. So `_` can be used for AS value boundaries match. This + character technically evaluates to `(^|[,{}() ]|$)`. .. _How_to_set_up_a_6-Bone_connection: @@ -2112,46 +1997,46 @@ How to set up a 6-Bone connection :: - zebra configuration - =================== - ! - ! Actually there is no need to configure zebra - ! + zebra configuration + =================== + ! + ! Actually there is no need to configure zebra + ! - bgpd configuration - ================== - ! - ! This means that routes go through zebra and into the kernel. - ! - router zebra - ! - ! MP-BGP configuration - ! - router bgp 7675 - bgp router-id 10.0.0.1 - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number` - ! - address-family ipv6 - network 3ffe:506::/32 - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out - neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number` - neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out - exit-address-family - ! - ipv6 access-list all permit any - ! - ! Set output nexthop address. - ! - route-map set-nexthop permit 10 - match ipv6 address all - set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 - set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 - ! - ! logfile FILENAME is obsolete. Please use log file FILENAME + bgpd configuration + ================== + ! + ! This means that routes go through zebra and into the kernel. + ! + router zebra + ! + ! MP-BGP configuration + ! + router bgp 7675 + bgp router-id 10.0.0.1 + neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number` + ! + address-family ipv6 + network 3ffe:506::/32 + neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate + neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out + neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number` + neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out + exit-address-family + ! + ipv6 access-list all permit any + ! + ! Set output nexthop address. + ! + route-map set-nexthop permit 10 + match ipv6 address all + set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 + set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 + ! + ! logfile FILENAME is obsolete. Please use log file FILENAME - log file bgpd.log - ! + log file bgpd.log + ! .. _Dump_BGP_packets_and_table: @@ -2160,73 +2045,71 @@ Dump BGP packets and table ========================== .. index:: dump bgp all PATH [INTERVAL] - .. clicmd:: dump bgp all PATH [INTERVAL] + .. index:: dump bgp all-et PATH [INTERVAL] - .. clicmd:: dump bgp all-et PATH [INTERVAL] -.. index:: no dump bgp all [PATH] [INTERVAL] +.. index:: no dump bgp all [PATH] [INTERVAL] .. clicmd:: no dump bgp all [PATH] [INTERVAL] - Dump all BGP packet and events to `path` file. - If `interval` is set, a new file will be created for echo `interval` of seconds. - The path `path` can be set with date and time formatting (strftime). - The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). - (:ref:`Packet_Binary_Dump_Format`) + + Dump all BGP packet and events to `path` file. + If `interval` is set, a new file will be created for echo `interval` of seconds. + The path `path` can be set with date and time formatting (strftime). + The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). + (:ref:`Packet_Binary_Dump_Format`) .. index:: dump bgp updates PATH [INTERVAL] - .. clicmd:: dump bgp updates PATH [INTERVAL] + .. index:: dump bgp updates-et PATH [INTERVAL] - .. clicmd:: dump bgp updates-et PATH [INTERVAL] -.. index:: no dump bgp updates [PATH] [INTERVAL] +.. index:: no dump bgp updates [PATH] [INTERVAL] .. clicmd:: no dump bgp updates [PATH] [INTERVAL] - Dump only BGP updates messages to `path` file. - If `interval` is set, a new file will be created for echo `interval` of seconds. - The path `path` can be set with date and time formatting (strftime). - The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). + + Dump only BGP updates messages to `path` file. + If `interval` is set, a new file will be created for echo `interval` of seconds. + The path `path` can be set with date and time formatting (strftime). + The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). .. index:: dump bgp routes-mrt PATH - .. clicmd:: dump bgp routes-mrt PATH + .. index:: dump bgp routes-mrt PATH INTERVAL - .. clicmd:: dump bgp routes-mrt PATH INTERVAL + .. index:: no dump bgp route-mrt [PATH] [INTERVAL] - .. clicmd:: no dump bgp route-mrt [PATH] [INTERVAL] - Dump whole BGP routing table to `path`. This is heavy process. - The path `path` can be set with date and time formatting (strftime). - If `interval` is set, a new file will be created for echo `interval` of seconds. - Note: the interval variable can also be set using hours and minutes: 04h20m00. + Dump whole BGP routing table to `path`. This is heavy process. + The path `path` can be set with date and time formatting (strftime). + If `interval` is set, a new file will be created for echo `interval` of seconds. + + Note: the interval variable can also be set using hours and minutes: 04h20m00. + +.. _bgp-configuration-examples: BGP Configuration Examples ========================== -Example of a session to an upstream, advertising only one prefix to it. - -:: - - router bgp 64512 - bgp router-id 10.236.87.1 - neighbor upstream peer-group - neighbor upstream remote-as 64515 - neighbor upstream capability dynamic - neighbor 10.1.1.1 peer-group upstream - neighbor 10.1.1.1 description ACME ISP - - address-family ipv4 unicast - network 10.236.87.0/24 - neighbor upstream prefix-list pl-allowed-adv out - exit-address-family - ! - ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 - ip prefix-list pl-allowed-adv seq 10 deny any +Example of a session to an upstream, advertising only one prefix to it.:: + router bgp 64512 + bgp router-id 10.236.87.1 + neighbor upstream peer-group + neighbor upstream remote-as 64515 + neighbor upstream capability dynamic + neighbor 10.1.1.1 peer-group upstream + neighbor 10.1.1.1 description ACME ISP + address-family ipv4 unicast + network 10.236.87.0/24 + neighbor upstream prefix-list pl-allowed-adv out + exit-address-family + ! + ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 + ip prefix-list pl-allowed-adv seq 10 deny any A more complex example. With upstream, peer and customer sessions. Advertising global prefixes and NO_EXPORT prefixes and providing @@ -2238,207 +2121,207 @@ flaws. :: - router bgp 64512 - bgp router-id 10.236.87.1 - neighbor upstream capability dynamic - neighbor cust capability dynamic - neighbor peer capability dynamic - neighbor 10.1.1.1 remote-as 64515 - neighbor 10.1.1.1 peer-group upstream - neighbor 10.2.1.1 remote-as 64516 - neighbor 10.2.1.1 peer-group upstream - neighbor 10.3.1.1 remote-as 64517 - neighbor 10.3.1.1 peer-group cust-default - neighbor 10.3.1.1 description customer1 - neighbor 10.4.1.1 remote-as 64518 - neighbor 10.4.1.1 peer-group cust - neighbor 10.4.1.1 description customer2 - neighbor 10.5.1.1 remote-as 64519 - neighbor 10.5.1.1 peer-group peer - neighbor 10.5.1.1 description peer AS 1 - neighbor 10.6.1.1 remote-as 64520 - neighbor 10.6.1.1 peer-group peer - neighbor 10.6.1.1 description peer AS 2 + router bgp 64512 + bgp router-id 10.236.87.1 + neighbor upstream capability dynamic + neighbor cust capability dynamic + neighbor peer capability dynamic + neighbor 10.1.1.1 remote-as 64515 + neighbor 10.1.1.1 peer-group upstream + neighbor 10.2.1.1 remote-as 64516 + neighbor 10.2.1.1 peer-group upstream + neighbor 10.3.1.1 remote-as 64517 + neighbor 10.3.1.1 peer-group cust-default + neighbor 10.3.1.1 description customer1 + neighbor 10.4.1.1 remote-as 64518 + neighbor 10.4.1.1 peer-group cust + neighbor 10.4.1.1 description customer2 + neighbor 10.5.1.1 remote-as 64519 + neighbor 10.5.1.1 peer-group peer + neighbor 10.5.1.1 description peer AS 1 + neighbor 10.6.1.1 remote-as 64520 + neighbor 10.6.1.1 peer-group peer + neighbor 10.6.1.1 description peer AS 2 - address-family ipv4 unicast - network 10.123.456.0/24 - network 10.123.456.128/25 route-map rm-no-export - neighbor upstream route-map rm-upstream-out out - neighbor cust route-map rm-cust-in in - neighbor cust route-map rm-cust-out out - neighbor cust send-community both - neighbor peer route-map rm-peer-in in - neighbor peer route-map rm-peer-out out - neighbor peer send-community both - neighbor 10.3.1.1 prefix-list pl-cust1-network in - neighbor 10.4.1.1 prefix-list pl-cust2-network in - neighbor 10.5.1.1 prefix-list pl-peer1-network in - neighbor 10.6.1.1 prefix-list pl-peer2-network in - exit-address-family - ! - ip prefix-list pl-default permit 0.0.0.0/0 - ! - ip prefix-list pl-upstream-peers permit 10.1.1.1/32 - ip prefix-list pl-upstream-peers permit 10.2.1.1/32 - ! - ip prefix-list pl-cust1-network permit 10.3.1.0/24 - ip prefix-list pl-cust1-network permit 10.3.2.0/24 - ! - ip prefix-list pl-cust2-network permit 10.4.1.0/24 - ! - ip prefix-list pl-peer1-network permit 10.5.1.0/24 - ip prefix-list pl-peer1-network permit 10.5.2.0/24 - ip prefix-list pl-peer1-network permit 192.168.0.0/24 - ! - ip prefix-list pl-peer2-network permit 10.6.1.0/24 - ip prefix-list pl-peer2-network permit 10.6.2.0/24 - ip prefix-list pl-peer2-network permit 192.168.1.0/24 - ip prefix-list pl-peer2-network permit 192.168.2.0/24 - ip prefix-list pl-peer2-network permit 172.16.1/24 - ! - ip as-path access-list asp-own-as permit ^$ - ip as-path access-list asp-own-as permit _64512_ - ! - ! ################################################################# - ! Match communities we provide actions for, on routes receives from - ! customers. Communities values of :X, with X, have actions: - ! - ! 100 - blackhole the prefix - ! 200 - set no_export - ! 300 - advertise only to other customers - ! 400 - advertise only to upstreams - ! 500 - set no_export when advertising to upstreams - ! 2X00 - set local_preference to X00 - ! - ! blackhole the prefix of the route - ip community-list standard cm-blackhole permit 64512:100 - ! - ! set no-export community before advertising - ip community-list standard cm-set-no-export permit 64512:200 - ! - ! advertise only to other customers - ip community-list standard cm-cust-only permit 64512:300 - ! - ! advertise only to upstreams - ip community-list standard cm-upstream-only permit 64512:400 - ! - ! advertise to upstreams with no-export - ip community-list standard cm-upstream-noexport permit 64512:500 - ! - ! set local-pref to least significant 3 digits of the community - ip community-list standard cm-prefmod-100 permit 64512:2100 - ip community-list standard cm-prefmod-200 permit 64512:2200 - ip community-list standard cm-prefmod-300 permit 64512:2300 - ip community-list standard cm-prefmod-400 permit 64512:2400 - ip community-list expanded cme-prefmod-range permit 64512:2... - ! - ! Informational communities - ! - ! 3000 - learned from upstream - ! 3100 - learned from customer - ! 3200 - learned from peer - ! - ip community-list standard cm-learnt-upstream permit 64512:3000 - ip community-list standard cm-learnt-cust permit 64512:3100 - ip community-list standard cm-learnt-peer permit 64512:3200 - ! - ! ################################################################### - ! Utility route-maps - ! - ! These utility route-maps generally should not used to permit/deny - ! routes, i.e. they do not have meaning as filters, and hence probably - ! should be used with 'on-match next'. These all finish with an empty - ! permit entry so as not interfere with processing in the caller. - ! - route-map rm-no-export permit 10 - set community additive no-export - route-map rm-no-export permit 20 - ! - route-map rm-blackhole permit 10 - description blackhole, up-pref and ensure it cant escape this AS - set ip next-hop 127.0.0.1 - set local-preference 10 - set community additive no-export - route-map rm-blackhole permit 20 - ! - ! Set local-pref as requested - route-map rm-prefmod permit 10 - match community cm-prefmod-100 - set local-preference 100 - route-map rm-prefmod permit 20 - match community cm-prefmod-200 - set local-preference 200 - route-map rm-prefmod permit 30 - match community cm-prefmod-300 - set local-preference 300 - route-map rm-prefmod permit 40 - match community cm-prefmod-400 - set local-preference 400 - route-map rm-prefmod permit 50 - ! - ! Community actions to take on receipt of route. - route-map rm-community-in permit 10 - description check for blackholing, no point continuing if it matches. - match community cm-blackhole - call rm-blackhole - route-map rm-community-in permit 20 - match community cm-set-no-export - call rm-no-export - on-match next - route-map rm-community-in permit 30 - match community cme-prefmod-range - call rm-prefmod - route-map rm-community-in permit 40 - ! - ! ##################################################################### - ! Community actions to take when advertising a route. - ! These are filtering route-maps, - ! - ! Deny customer routes to upstream with cust-only set. - route-map rm-community-filt-to-upstream deny 10 - match community cm-learnt-cust - match community cm-cust-only - route-map rm-community-filt-to-upstream permit 20 - ! - ! Deny customer routes to other customers with upstream-only set. - route-map rm-community-filt-to-cust deny 10 - match community cm-learnt-cust - match community cm-upstream-only - route-map rm-community-filt-to-cust permit 20 - ! - ! ################################################################### - ! The top-level route-maps applied to sessions. Further entries could - ! be added obviously.. - ! - ! Customers - route-map rm-cust-in permit 10 - call rm-community-in - on-match next - route-map rm-cust-in permit 20 - set community additive 64512:3100 - route-map rm-cust-in permit 30 - ! - route-map rm-cust-out permit 10 - call rm-community-filt-to-cust - on-match next - route-map rm-cust-out permit 20 - ! - ! Upstream transit ASes - route-map rm-upstream-out permit 10 - description filter customer prefixes which are marked cust-only - call rm-community-filt-to-upstream - on-match next - route-map rm-upstream-out permit 20 - description only customer routes are provided to upstreams/peers - match community cm-learnt-cust - ! - ! Peer ASes - ! outbound policy is same as for upstream - route-map rm-peer-out permit 10 - call rm-upstream-out - ! - route-map rm-peer-in permit 10 - set community additive 64512:3200 + address-family ipv4 unicast + network 10.123.456.0/24 + network 10.123.456.128/25 route-map rm-no-export + neighbor upstream route-map rm-upstream-out out + neighbor cust route-map rm-cust-in in + neighbor cust route-map rm-cust-out out + neighbor cust send-community both + neighbor peer route-map rm-peer-in in + neighbor peer route-map rm-peer-out out + neighbor peer send-community both + neighbor 10.3.1.1 prefix-list pl-cust1-network in + neighbor 10.4.1.1 prefix-list pl-cust2-network in + neighbor 10.5.1.1 prefix-list pl-peer1-network in + neighbor 10.6.1.1 prefix-list pl-peer2-network in + exit-address-family + ! + ip prefix-list pl-default permit 0.0.0.0/0 + ! + ip prefix-list pl-upstream-peers permit 10.1.1.1/32 + ip prefix-list pl-upstream-peers permit 10.2.1.1/32 + ! + ip prefix-list pl-cust1-network permit 10.3.1.0/24 + ip prefix-list pl-cust1-network permit 10.3.2.0/24 + ! + ip prefix-list pl-cust2-network permit 10.4.1.0/24 + ! + ip prefix-list pl-peer1-network permit 10.5.1.0/24 + ip prefix-list pl-peer1-network permit 10.5.2.0/24 + ip prefix-list pl-peer1-network permit 192.168.0.0/24 + ! + ip prefix-list pl-peer2-network permit 10.6.1.0/24 + ip prefix-list pl-peer2-network permit 10.6.2.0/24 + ip prefix-list pl-peer2-network permit 192.168.1.0/24 + ip prefix-list pl-peer2-network permit 192.168.2.0/24 + ip prefix-list pl-peer2-network permit 172.16.1/24 + ! + ip as-path access-list asp-own-as permit ^$ + ip as-path access-list asp-own-as permit _64512_ + ! + ! ################################################################# + ! Match communities we provide actions for, on routes receives from + ! customers. Communities values of :X, with X, have actions: + ! + ! 100 - blackhole the prefix + ! 200 - set no_export + ! 300 - advertise only to other customers + ! 400 - advertise only to upstreams + ! 500 - set no_export when advertising to upstreams + ! 2X00 - set local_preference to X00 + ! + ! blackhole the prefix of the route + ip community-list standard cm-blackhole permit 64512:100 + ! + ! set no-export community before advertising + ip community-list standard cm-set-no-export permit 64512:200 + ! + ! advertise only to other customers + ip community-list standard cm-cust-only permit 64512:300 + ! + ! advertise only to upstreams + ip community-list standard cm-upstream-only permit 64512:400 + ! + ! advertise to upstreams with no-export + ip community-list standard cm-upstream-noexport permit 64512:500 + ! + ! set local-pref to least significant 3 digits of the community + ip community-list standard cm-prefmod-100 permit 64512:2100 + ip community-list standard cm-prefmod-200 permit 64512:2200 + ip community-list standard cm-prefmod-300 permit 64512:2300 + ip community-list standard cm-prefmod-400 permit 64512:2400 + ip community-list expanded cme-prefmod-range permit 64512:2... + ! + ! Informational communities + ! + ! 3000 - learned from upstream + ! 3100 - learned from customer + ! 3200 - learned from peer + ! + ip community-list standard cm-learnt-upstream permit 64512:3000 + ip community-list standard cm-learnt-cust permit 64512:3100 + ip community-list standard cm-learnt-peer permit 64512:3200 + ! + ! ################################################################### + ! Utility route-maps + ! + ! These utility route-maps generally should not used to permit/deny + ! routes, i.e. they do not have meaning as filters, and hence probably + ! should be used with 'on-match next'. These all finish with an empty + ! permit entry so as not interfere with processing in the caller. + ! + route-map rm-no-export permit 10 + set community additive no-export + route-map rm-no-export permit 20 + ! + route-map rm-blackhole permit 10 + description blackhole, up-pref and ensure it cant escape this AS + set ip next-hop 127.0.0.1 + set local-preference 10 + set community additive no-export + route-map rm-blackhole permit 20 + ! + ! Set local-pref as requested + route-map rm-prefmod permit 10 + match community cm-prefmod-100 + set local-preference 100 + route-map rm-prefmod permit 20 + match community cm-prefmod-200 + set local-preference 200 + route-map rm-prefmod permit 30 + match community cm-prefmod-300 + set local-preference 300 + route-map rm-prefmod permit 40 + match community cm-prefmod-400 + set local-preference 400 + route-map rm-prefmod permit 50 + ! + ! Community actions to take on receipt of route. + route-map rm-community-in permit 10 + description check for blackholing, no point continuing if it matches. + match community cm-blackhole + call rm-blackhole + route-map rm-community-in permit 20 + match community cm-set-no-export + call rm-no-export + on-match next + route-map rm-community-in permit 30 + match community cme-prefmod-range + call rm-prefmod + route-map rm-community-in permit 40 + ! + ! ##################################################################### + ! Community actions to take when advertising a route. + ! These are filtering route-maps, + ! + ! Deny customer routes to upstream with cust-only set. + route-map rm-community-filt-to-upstream deny 10 + match community cm-learnt-cust + match community cm-cust-only + route-map rm-community-filt-to-upstream permit 20 + ! + ! Deny customer routes to other customers with upstream-only set. + route-map rm-community-filt-to-cust deny 10 + match community cm-learnt-cust + match community cm-upstream-only + route-map rm-community-filt-to-cust permit 20 + ! + ! ################################################################### + ! The top-level route-maps applied to sessions. Further entries could + ! be added obviously.. + ! + ! Customers + route-map rm-cust-in permit 10 + call rm-community-in + on-match next + route-map rm-cust-in permit 20 + set community additive 64512:3100 + route-map rm-cust-in permit 30 + ! + route-map rm-cust-out permit 10 + call rm-community-filt-to-cust + on-match next + route-map rm-cust-out permit 20 + ! + ! Upstream transit ASes + route-map rm-upstream-out permit 10 + description filter customer prefixes which are marked cust-only + call rm-community-filt-to-upstream + on-match next + route-map rm-upstream-out permit 20 + description only customer routes are provided to upstreams/peers + match community cm-learnt-cust + ! + ! Peer ASes + ! outbound policy is same as for upstream + route-map rm-peer-out permit 10 + call rm-upstream-out + ! + route-map rm-peer-in permit 10 + set community additive 64512:3200 .. _Configuring_FRR_as_a_Route_Server: @@ -2459,3 +2342,8 @@ model. And finally we will show a full example of FRR configured as Route Server. .. include:: rpki.rst + + +.. [bgp-route-osci-cond] McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation Condition", IETF RFC3345 +.. [stable-flexible-ibgp] Flavel, A. and M. Roughan, "Stable and flexible iBGP", ACM SIGCOMM 2009 +.. [ibgp-correctness] Griffin, T. and G. Wilfong, "On the correctness of IBGP configuration", ACM SIGCOMM 2002 diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index a3ad382a98..7c2c55d166 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -18,16 +18,14 @@ known topology. Starting and Stopping eigrpd ============================ -The default configuration file name of *eigrpd*'s is -:file:`eigrpd.conf`. When invocation *eigrpd* searches directory -|INSTALL_PREFIX_ETC|. If :file:`eigrpd.conf` is not there next -search current directory. If an integrated config is specified -configuration is written into frr.conf +The default configuration file name of *eigrpd*'s is :file:`eigrpd.conf`. When +invocation *eigrpd* searches directory |INSTALL_PREFIX_ETC|. If +:file:`eigrpd.conf` is not there next search current directory. If an +integrated config is specified configuration is written into :file:`frr.conf`. -The EIGRP protocol requires interface information -maintained by *zebra* daemon. So running *zebra* -is mandatory to run *eigrpd*. Thus minimum sequence for running -EIGRP is like below: +The EIGRP protocol requires interface information maintained by *zebra* daemon. +So running *zebra* is mandatory to run *eigrpd*. Thus minimum sequence for +running EIGRP is: :: @@ -37,8 +35,10 @@ EIGRP is like below: Please note that *zebra* must be invoked before *eigrpd*. -To stop *eigrpd*. Please use @command{kill `cat -/var/run/eigrpd.pid`}. Certain signals have special meanings to *eigrpd*. +To stop *eigrpd*, please use :: + kill `cat /var/run/eigrpd.pid` + +Certain signals have special meanings to *eigrpd*. +------------------+-----------------------------------------------------------+ | Signal | Meaning | @@ -65,23 +65,23 @@ EIGRP Configuration =================== .. index:: router eigrp (1-65535) - .. clicmd:: router eigrp (1-65535) + The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP, use the `no router eigrp (1-65535)` command. EIGRP must be enabled before carrying out any of the EIGRP commands. .. index:: no router eigrp (1-65535) - .. clicmd:: no router eigrp (1-65535) + Disable EIGRP. .. index:: network NETWORK - .. clicmd:: network NETWORK -.. index:: no network NETWORK +.. index:: no network NETWORK .. clicmd:: no network NETWORK + Set the EIGRP enable interface by `network`. The interfaces which have addresses matching with `network` are enabled. @@ -94,27 +94,25 @@ EIGRP Configuration Below is very simple EIGRP configuration. Interface `eth0` and interface which address match to `10.0.0.0/8` are EIGRP enabled. -:: + :: - ! - router eigrp 1 - network 10.0.0.0/8 - ! + ! + router eigrp 1 + network 10.0.0.0/8 + ! - Passive interface - .. index:: passive-interface (IFNAME|default) - .. clicmd:: passive-interface (IFNAME|default) -.. index:: no passive-interface IFNAME +.. index:: no passive-interface IFNAME .. clicmd:: no passive-interface IFNAME + This command sets the specified interface to passive mode. On passive mode - interface, all receiving packets are ignored and eigrpd does - not send either multicast or unicast EIGRP packets except to EIGRP neighbors - specified with `neighbor` command. The interface may be specified - as `default` to make eigrpd default to passive on all interfaces. + interface, all receiving packets are ignored and eigrpd does not send either + multicast or unicast EIGRP packets except to EIGRP neighbors specified with + `neighbor` command. The interface may be specified as `default` to make + eigrpd default to passive on all interfaces. The default is to be passive on all interfaces. @@ -124,70 +122,66 @@ How to Announce EIGRP route =========================== .. index:: redistribute kernel - .. clicmd:: redistribute kernel + .. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - .. clicmd:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. index:: no redistribute kernel +.. index:: no redistribute kernel .. clicmd:: no redistribute kernel - `redistribute kernel` redistributes routing information from - kernel route entries into the EIGRP tables. `no redistribute kernel` - disables the routes. + + `redistribute kernel` redistributes routing information from kernel route + entries into the EIGRP tables. `no redistribute kernel` disables the routes. .. index:: redistribute static - .. clicmd:: redistribute static + .. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - .. clicmd:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. index:: no redistribute static +.. index:: no redistribute static .. clicmd:: no redistribute static - `redistribute static` redistributes routing information from - static route entries into the EIGRP tables. `no redistribute static` - disables the routes. + + `redistribute static` redistributes routing information from static route + entries into the EIGRP tables. `no redistribute static` disables the routes. .. index:: redistribute connected - .. clicmd:: redistribute connected + .. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - .. clicmd:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. index:: no redistribute connected +.. index:: no redistribute connected .. clicmd:: no redistribute connected - Redistribute connected routes into the EIGRP tables. `no redistribute - connected` disables the connected routes in the EIGRP tables. This command - redistribute connected of the interface which EIGRP disabled. The connected - route on EIGRP enabled interface is announced by default. + + Redistribute connected routes into the EIGRP tables. `no redistribute + connected` disables the connected routes in the EIGRP tables. This command + redistribute connected of the interface which EIGRP disabled. The connected + route on EIGRP enabled interface is announced by default. .. index:: redistribute ospf - .. clicmd:: redistribute ospf + .. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - .. clicmd:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. index:: no redistribute ospf +.. index:: no redistribute ospf .. clicmd:: no redistribute ospf - `redistribute ospf` redistributes routing information from ospf route - entries into the EIGRP tables. `no redistribute ospf` disables the - routes. + + `redistribute ospf` redistributes routing information from ospf route + entries into the EIGRP tables. `no redistribute ospf` disables the routes. .. index:: redistribute bgp - .. clicmd:: redistribute bgp + .. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - .. clicmd:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. index:: no redistribute bgp +.. index:: no redistribute bgp .. clicmd:: no redistribute bgp - `redistribute bgp` redistributes routing information from - bgp route entries into the EIGRP tables. `no redistribute bgp` - disables the routes. + + `redistribute bgp` redistributes routing information from bgp route entries + into the EIGRP tables. `no redistribute bgp` disables the routes. .. _Show_EIGRP_Information: @@ -197,29 +191,29 @@ Show EIGRP Information To display EIGRP routes. .. index:: show ip eigrp topology - .. clicmd:: show ip eigrp topology - Show EIGRP routes. + + Show EIGRP routes. The command displays all EIGRP routes. .. index:: show ip eigrp topology - .. clicmd:: show ip eigrp topology - The command displays current EIGRP status -:: + The command displays current EIGRP status - eigrpd> **show ip eigrp topology** - # show ip eigrp topo + :: - EIGRP Topology Table for AS(4)/ID(0.0.0.0) + eigrpd> **show ip eigrp topology** + # show ip eigrp topo - Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply - r - reply Status, s - sia Status + EIGRP Topology Table for AS(4)/ID(0.0.0.0) - P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 - via Connected, enp0s3 + Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply + r - reply Status, s - sia Status + + P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0 + via Connected, enp0s3 EIGRP Debug Commands @@ -228,24 +222,25 @@ EIGRP Debug Commands Debug for EIGRP protocol. .. index:: debug eigrp packets - .. clicmd:: debug eigrp packets - Debug eigrp packets -`debug eigrp` will show EIGRP packets that are sent and recevied. + Debug eigrp packets + + ``debug eigrp`` will show EIGRP packets that are sent and recevied. .. index:: debug eigrp transmit - .. clicmd:: debug eigrp transmit - Debug eigrp transmit events -`debug eigrp transmit` will display detailed information about the EIGRP transmit events. + Debug eigrp transmit events + + ``debug eigrp transmit`` will display detailed information about the EIGRP + transmit events. .. index:: show debugging eigrp - .. clicmd:: show debugging eigrp - Display *eigrpd*'s debugging option. -`show debugging eigrp` will show all information currently set for eigrpd -debug. + Display *eigrpd*'s debugging option. + + ``show debugging eigrp`` will show all information currently set for eigrpd + debug. diff --git a/doc/user/filter.rst b/doc/user/filter.rst index 73ffba8f36..a99cc359c2 100644 --- a/doc/user/filter.rst +++ b/doc/user/filter.rst @@ -2,196 +2,177 @@ Filtering ********* -FRR provides many very flexible filtering features. Filtering is used -for both input and output of the routing information. Once filtering is +FRR provides many very flexible filtering features. Filtering is used +for both input and output of the routing information. Once filtering is defined, it can be applied in any direction. -@comment node-name, next, previous, up - IP Access List ============== -.. index:: {Command} {access-list `name` permit `ipv4-network`} {} +.. index:: access-list NAME permit IPV4-NETWORK +.. clicmd:: access-list NAME permit IPV4-NETWORK -{Command} {access-list `name` permit `ipv4-network`} {} -.. index:: {Command} {access-list `name` deny `ipv4-network`} {} +.. index:: access-list NAME deny IPV4-NETWORK +.. clicmd:: access-list NAME deny IPV4-NETWORK -{Command} {access-list `name` deny `ipv4-network`} {} + Basic filtering is done by `access-list` as shown in the + following example. - Basic filtering is done by `access-list` as shown in the - following example. + :: -:: + access-list filter deny 10.0.0.0/9 + access-list filter permit 10.0.0.0/8 - access-list filter deny 10.0.0.0/9 - access-list filter permit 10.0.0.0/8 - - - @comment node-name, next, previous, up IP Prefix List ============== *ip prefix-list* provides the most powerful prefix based -filtering mechanism. In addition to *access-list* functionality, +filtering mechanism. In addition to *access-list* functionality, *ip prefix-list* has prefix length range specification and -sequential number specification. You can add or delete prefix based +sequential number specification. You can add or delete prefix based filters to arbitrary points of prefix-list using sequential number specification. -If no ip prefix-list is specified, it acts as permit. If *ip prefix-list* +If no ip prefix-list is specified, it acts as permit. If *ip prefix-list* is defined, and no match is found, default deny is applied. -.. index:: {Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {} +.. index:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN] +.. clicmd:: ip prefix-list NAME (permit|deny) PREFIX [le LEN] [ge LEN] -{Command} {ip prefix-list `name` (permit|deny) `prefix` [le `len`] [ge `len`]} {} -.. index:: {Command} {ip prefix-list `name` seq `number` (permit|deny) `prefix` [le `len`] [ge `len`]} {} +.. index:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN] +.. clicmd:: ip prefix-list NAME seq NUMBER (permit|deny) PREFIX [le LEN] [ge LEN] -{Command} {ip prefix-list `name` seq `number` (permit|deny) `prefix` [le `len`] [ge `len`]} {} - You can create *ip prefix-list* using above commands. + You can create *ip prefix-list* using above commands. - - -*@asis{seq}* - seq `number` can be set either automatically or manually. In the + seq + seq `number` can be set either automatically or manually. In the case that sequential numbers are set manually, the user may pick any - number less than 4294967295. In the case that sequential number are set + number less than 4294967295. In the case that sequential number are set automatically, the sequential number will increase by a unit of five (5) - per list. If a list with no specified sequential number is created + per list. If a list with no specified sequential number is created after a list with a specified sequential number, the list will automatically pick the next multiple of five (5) as the list number. For example, if a list with number 2 already exists and a new list with - no specified number is created, the next list will be numbered 5. If + no specified number is created, the next list will be numbered 5. If lists 2 and 7 already exist and a new list with no specified number is created, the new list will be numbered 10. + le + Specifies prefix length. The prefix list will be applied if the prefix + length is less than or equal to the le prefix length. -*@asis{le}* - *le* command specifies prefix length. The prefix list will be - applied if the prefix length is less than or equal to the le prefix length. + ge + Specifies prefix length. The prefix list will be applied if the prefix + length is greater than or equal to the ge prefix length. -*@asis{ge}* - *ge* command specifies prefix length. The prefix list will be - applied if the prefix length is greater than or equal to the ge prefix length. + Less than or equal to prefix numbers and greater than or equal to + prefix numbers can be used together. The order of the le and ge + commands does not matter. + If a prefix list with a different sequential number but with the exact + same rules as a previous list is created, an error will result. + However, in the case that the sequential number and the rules are + exactly similar, no error will result. - Less than or equal to prefix numbers and greater than or equal to - prefix numbers can be used together. The order of the le and ge - commands does not matter. + If a list with the same sequential number as a previous list is created, + the new list will overwrite the old list. - If a prefix list with a different sequential number but with the exact - same rules as a previous list is created, an error will result. - However, in the case that the sequential number and the rules are - exactly similar, no error will result. + Matching of IP Prefix is performed from the smaller sequential number to the + larger. The matching will stop once any rule has been applied. - If a list with the same sequential number as a previous list is created, - the new list will overwrite the old list. + In the case of no le or ge command, the prefix length must match exactly the + length specified in the prefix list. - Matching of IP Prefix is performed from the smaller sequential number to the - larger. The matching will stop once any rule has been applied. - - In the case of no le or ge command, the prefix length must match exactly the - length specified in the prefix list. - -.. index:: {Command} {no ip prefix-list `name`} {} - -{Command} {no ip prefix-list `name`} {} +.. index:: no ip prefix-list NAME +.. clicmd:: no ip prefix-list NAME .. _ip_prefix-list_description: ip prefix-list description -------------------------- -.. index:: {Command} {ip prefix-list `name` description `desc`} {} +.. index:: ip prefix-list NAME description DESC +.. clicmd:: ip prefix-list NAME description DESC -{Command} {ip prefix-list `name` description `desc`} {} - Descriptions may be added to prefix lists. This command adds a - description to the prefix list. + Descriptions may be added to prefix lists. This command adds a + description to the prefix list. -.. index:: {Command} {no ip prefix-list `name` description [`desc`]} {} +.. index:: no ip prefix-list NAME description [DESC] +.. clicmd:: no ip prefix-list NAME description [DESC] -{Command} {no ip prefix-list `name` description [`desc`]} {} - Deletes the description from a prefix list. It is possible to use the - command without the full description. + Deletes the description from a prefix list. It is possible to use the + command without the full description. .. _ip_prefix-list_sequential_number_control: ip prefix-list sequential number control ---------------------------------------- -.. index:: {Command} {ip prefix-list sequence-number} {} +.. index:: ip prefix-list sequence-number +.. clicmd:: ip prefix-list sequence-number -{Command} {ip prefix-list sequence-number} {} - With this command, the IP prefix list sequential number is displayed. - This is the default behavior. + With this command, the IP prefix list sequential number is displayed. + This is the default behavior. -.. index:: {Command} {no ip prefix-list sequence-number} {} +.. index:: no ip prefix-list sequence-number +.. clicmd:: no ip prefix-list sequence-number -{Command} {no ip prefix-list sequence-number} {} - With this command, the IP prefix list sequential number is not - displayed. + With this command, the IP prefix list sequential number is not + displayed. .. _Showing_ip_prefix-list: Showing ip prefix-list ---------------------- -.. index:: {Command} {show ip prefix-list} {} +.. index:: show ip prefix-list +.. clicmd:: show ip prefix-list -{Command} {show ip prefix-list} {} - Display all IP prefix lists. + Display all IP prefix lists. -.. index:: {Command} {show ip prefix-list `name`} {} +.. index:: show ip prefix-list NAME +.. clicmd:: show ip prefix-list NAME -{Command} {show ip prefix-list `name`} {} - Show IP prefix list can be used with a prefix list name. + Show IP prefix list can be used with a prefix list name. -.. index:: {Command} {show ip prefix-list `name` seq `num`} {} +.. index:: show ip prefix-list NAME seq NUM +.. clicmd:: show ip prefix-list NAME seq NUM -{Command} {show ip prefix-list `name` seq `num`} {} - Show IP prefix list can be used with a prefix list name and sequential - number. + Show IP prefix list can be used with a prefix list name and sequential + number. -.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m`} {} +.. index:: show ip prefix-list NAME A.B.C.D/M +.. clicmd:: show ip prefix-list NAME A.B.C.D/M -{Command} {show ip prefix-list `name` `a.b.c.d/m`} {} - If the command longer is used, all prefix lists with prefix lengths equal to - or longer than the specified length will be displayed. - If the command first match is used, the first prefix length match will be - displayed. + If the command longer is used, all prefix lists with prefix lengths equal to + or longer than the specified length will be displayed. If the command first + match is used, the first prefix length match will be displayed. -.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m` longer} {} - -{Command} {show ip prefix-list `name` `a.b.c.d/m` longer} {} -.. index:: {Command} {show ip prefix-list `name` `a.b.c.d/m` first-match} {} - -{Command} {show ip prefix-list `name` `a.b.c.d/m` first-match} {} -.. index:: {Command} {show ip prefix-list summary} {} - -{Command} {show ip prefix-list summary} {} -.. index:: {Command} {show ip prefix-list summary `name`} {} - -{Command} {show ip prefix-list summary `name`} {} -.. index:: {Command} {show ip prefix-list detail} {} - -{Command} {show ip prefix-list detail} {} -.. index:: {Command} {show ip prefix-list detail `name`} {} - -{Command} {show ip prefix-list detail `name`} {} +.. index:: show ip prefix-list NAME A.B.C.D/M longer +.. clicmd:: show ip prefix-list NAME A.B.C.D/M longer +.. index:: show ip prefix-list NAME A.B.C.D/M first-match +.. clicmd:: show ip prefix-list NAME A.B.C.D/M first-match +.. index:: show ip prefix-list summary +.. clicmd:: show ip prefix-list summary +.. index:: show ip prefix-list summary NAME +.. clicmd:: show ip prefix-list summary NAME +.. index:: show ip prefix-list detail +.. clicmd:: show ip prefix-list detail +.. index:: show ip prefix-list detail NAME +.. clicmd:: show ip prefix-list detail NAME Clear counter of ip prefix-list ------------------------------- -.. index:: {Command} {clear ip prefix-list} {} +.. index:: clear ip prefix-list +.. clicmd:: clear ip prefix-list -{Command} {clear ip prefix-list} {} - Clears the counters of all IP prefix lists. Clear IP Prefix List can be - used with a specified name and prefix. + Clears the counters of all IP prefix lists. Clear IP Prefix List can be used + with a specified name and prefix. -.. index:: {Command} {clear ip prefix-list `name`} {} - -{Command} {clear ip prefix-list `name`} {} -.. index:: {Command} {clear ip prefix-list `name` `a.b.c.d/m`} {} - -{Command} {clear ip prefix-list `name` `a.b.c.d/m`} {} +.. index:: clear ip prefix-list NAME +.. clicmd:: clear ip prefix-list NAME +.. index:: clear ip prefix-list NAME A.B.C.D/M +.. clicmd:: clear ip prefix-list NAME A.B.C.D/M diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 43f7ddb4a2..094b8b4ce4 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -156,6 +156,9 @@ customize the build to include or exclude specific features and dependencies. Build without SNMP support. +.. option:: --disable-vtysh + + Build without VTYSH. You may specify any combination of the above options to the configure script. By default, the executables are placed in :file:`/usr/local/sbin` diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index d6b7d972ad..3780a6311f 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -4,11 +4,12 @@ IPv6 Support ************ -FRR fully supports IPv6 routing. As described so far, Frr supports -RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface -and configure static IPv6 routing information. FRR IPv6 also provides -automatic address configuration via a feature called ``address auto configuration``. To do it, the router must send router advertisement -messages to the all nodes that exist on the network. +FRR fully supports IPv6 routing. As described so far, Frr supports RIPng, +OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface and configure +static IPv6 routing information. FRR IPv6 also provides automatic address +configuration via a feature called ``address auto configuration``. To do it, +the router must send router advertisement messages to the all nodes that exist +on the network. Previous versions of FRR could be built without IPv6 support. This is no longer possible. @@ -17,177 +18,176 @@ Router Advertisement ==================== .. index:: no ipv6 nd suppress-ra - .. clicmd:: no ipv6 nd suppress-ra + Send router advertisment messages. .. index:: ipv6 nd suppress-ra - .. clicmd:: ipv6 nd suppress-ra + Don't send router advertisment messages. .. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] - .. clicmd:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] - Configuring the IPv6 prefix to include in router advertisements. Several prefix - specific optional parameters and flags may follow: - - ``valid-lifetime``: the length of time in seconds during what the prefix is - valid for the purpose of on-link determination. Value ``infinite`` represents - infinity (i.e. a value of all one bits (``0xffffffff``)). - Range: ``(0-4294967295)`` Default: ``2592000`` + Configuring the IPv6 prefix to include in router advertisements. Several prefix + specific optional parameters and flags may follow: - - ``preferred-lifetime``: the length of time in seconds during what addresses - generated from the prefix remain preferred. Value ``infinite`` represents - infinity. - Range: ``(0-4294967295)`` Default: ``604800`` + - ``valid-lifetime``: the length of time in seconds during what the prefix is + valid for the purpose of on-link determination. Value ``infinite`` represents + infinity (i.e. a value of all one bits (``0xffffffff``)). + Range: ``(0-4294967295)`` Default: ``2592000`` - - ``off-link``: indicates that advertisement makes no statement about on-link or - off-link properties of the prefix. - Default: not set, i.e. this prefix can be used for on-link determination. + - ``preferred-lifetime``: the length of time in seconds during what addresses + generated from the prefix remain preferred. Value ``infinite`` represents + infinity. + Range: ``(0-4294967295)`` Default: ``604800`` - - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix - cannot be used for IPv6 autoconfiguration. + - ``off-link``: indicates that advertisement makes no statement about on-link or + off-link properties of the prefix. + Default: not set, i.e. this prefix can be used for on-link determination. - Default: not set, i.e. prefix can be used for autoconfiguration. + - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix + cannot be used for IPv6 autoconfiguration. - - ``router-address``: indicates to hosts on the local link that the specified - prefix contains a complete IP address by setting R flag. + Default: not set, i.e. prefix can be used for autoconfiguration. - Default: not set, i.e. hosts do not assume a complete IP address is placed. + - ``router-address``: indicates to hosts on the local link that the specified + prefix contains a complete IP address by setting R flag. + + Default: not set, i.e. hosts do not assume a complete IP address is placed. .. index:: single: no ipv6 nd ra-interval [(1-1800)] single: no ipv6 nd ra-interval [(1-1800)] - .. clicmd:: [no] ipv6 nd ra-interval [(1-1800)] - The maximum time allowed between sending unsolicited multicast router - advertisements from the interface, in seconds. - Default: ``600`` + + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in seconds. + Default: ``600`` .. index:: ipv6 nd ra-interval msec (70-1800000) - - .. index:: single: no ipv6 nd ra-interval [msec (70-1800000)] single: ipv6 nd ra-interval msec (70-1800000) - .. clicmd:: [no] ipv6 nd ra-interval [msec (70-1800000)] - The maximum time allowed between sending unsolicited multicast router - advertisements from the interface, in milliseconds. - Default: ``600000`` + + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in milliseconds. + Default: ``600000`` .. index:: single: ipv6 nd ra-lifetime (0-9000) single: no ipv6 nd ra-lifetime [(0-9000)] - .. clicmd:: [no] ipv6 nd ra-lifetime [(0-9000)] - The value to be placed in the Router Lifetime field of router advertisements - sent from the interface, in seconds. Indicates the usefulness of the router - as a default router on this interface. Setting the value to zero indicates - that the router should not be considered a default router on this interface. - Must be either zero or between value specified with ``ipv6 nd ra-interval`` - (or default) and 9000 seconds. - Default: ``1800`` + + The value to be placed in the Router Lifetime field of router advertisements + sent from the interface, in seconds. Indicates the usefulness of the router + as a default router on this interface. Setting the value to zero indicates + that the router should not be considered a default router on this interface. + Must be either zero or between value specified with ``ipv6 nd ra-interval`` + (or default) and 9000 seconds. + Default: ``1800`` .. index:: single: no ipv6 nd reachable-time [(1-3600000)] single: ipv6 nd reachable-time (1-3600000) - .. clicmd:: [no] ipv6 nd reachable-time [(1-3600000)] - The value to be placed in the Reachable Time field in the Router Advertisement - messages sent by the router, in milliseconds. The configured time enables the - router to detect unavailable neighbors. The value zero means unspecified (by - this router). - Default: ``0`` + + The value to be placed in the Reachable Time field in the Router + Advertisement messages sent by the router, in milliseconds. The configured + time enables the router to detect unavailable neighbors. The value zero + means unspecified (by this router). + Default: ``0`` .. index:: single: ipv6 nd managed-config-flag single: no ipv6 nd managed-config-flag - .. clicmd:: [no] ipv6 nd managed-config-flag - Set/unset flag in IPv6 router advertisements which indicates to hosts that they - should use managed (stateful) protocol for addresses autoconfiguration in - addition to any addresses autoconfigured using stateless address - autoconfiguration. - Default: not set + + Set/unset flag in IPv6 router advertisements which indicates to hosts that + they should use managed (stateful) protocol for addresses autoconfiguration + in addition to any addresses autoconfigured using stateless address + autoconfiguration. + Default: not set .. index:: single: ipv6 nd other-config-flag single: no ipv6 nd other-config-flag - .. clicmd:: [no] ipv6 nd other-config-flag - Set/unset flag in IPv6 router advertisements which indicates to hosts that - they should use administered (stateful) protocol to obtain autoconfiguration - information other than addresses. - Default: not set + + Set/unset flag in IPv6 router advertisements which indicates to hosts that + they should use administered (stateful) protocol to obtain autoconfiguration + information other than addresses. + Default: not set .. index:: single: ipv6 nd home-agent-config-flag single: no ipv6 nd home-agent-config-flag - .. clicmd:: [no] ipv6 nd home-agent-config-flag - Set/unset flag in IPv6 router advertisements which indicates to hosts that - the router acts as a Home Agent and includes a Home Agent Option. - Default: not set + + Set/unset flag in IPv6 router advertisements which indicates to hosts that + the router acts as a Home Agent and includes a Home Agent Option. + Default: not set .. index:: ipv6 nd home-agent-preference (0-65535) .. index:: single: no ipv6 nd home-agent-preference [(0-65535)] single: ipv6 nd home-agent-preference (0-65535) - .. clicmd:: [no] ipv6 nd home-agent-preference [(0-65535)] - The value to be placed in Home Agent Option, when Home Agent config flag is set, - which indicates to hosts Home Agent preference. The default value of 0 stands - for the lowest preference possible. - Default: ``0`` + + The value to be placed in Home Agent Option, when Home Agent config flag is + set, which indicates to hosts Home Agent preference. The default value of 0 + stands for the lowest preference possible. + Default: ``0`` .. index:: single: ipv6 nd home-agent-lifetime (0-65520) single: no ipv6 nd home-agent-lifetime (0-65520) - .. clicmd:: [no] ipv6 nd home-agent-lifetime [(0-65520)] - The value to be placed in Home Agent Option, when Home Agent config flag is set, - which indicates to hosts Home Agent Lifetime. The default value of 0 means to - place the current Router Lifetime value. - Default: ``0`` + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent Lifetime. The default value of 0 means to + place the current Router Lifetime value. + + Default: ``0`` .. index:: single: ipv6 nd adv-interval-option single: no ipv6 nd adv-interval-option - .. clicmd:: [no] ipv6 nd adv-interval-option - Include an Advertisement Interval option which indicates to hosts the maximum time, - in milliseconds, between successive unsolicited Router Advertisements. - Default: not set + + Include an Advertisement Interval option which indicates to hosts the maximum time, + in milliseconds, between successive unsolicited Router Advertisements. + Default: not set .. index:: single: ipv6 nd router-preference (high|medium|low) single: no ipv6 nd router-preference (high|medium|low) - .. clicmd:: [no] ipv6 nd router-preference [(high|medium|low)] - Set default router preference in IPv6 router advertisements per RFC4191. - Default: medium + + Set default router preference in IPv6 router advertisements per RFC4191. + Default: medium .. index:: single: ipv6 nd mtu (1-65535) single: no ipv6 nd mtu [(1-65535)] - .. clicmd:: [no] ipv6 nd mtu [(1-65535)] - Include an MTU (type 5) option in each RA packet to assist the attached hosts - in proper interface configuration. The announced value is not verified to be - consistent with router interface MTU. - Default: don't advertise any MTU option.:: - interface eth0 - no ipv6 nd suppress-ra - ipv6 nd prefix 2001:0DB8:5009::/64 + Include an MTU (type 5) option in each RA packet to assist the attached + hosts in proper interface configuration. The announced value is not verified + to be consistent with router interface MTU. + + Default: don't advertise any MTU option.:: + interface eth0 + no ipv6 nd suppress-ra + ipv6 nd prefix 2001:0DB8:5009::/64 -For more information see -:t:`RFC2462 (IPv6 Stateless Address Autoconfiguration)`, -:t:`RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))`, -:t:`RFC6275 (Mobility Support in IPv6)` and -:t:`RFC4191 (Default Router Preferences and More-Specific Routes)`. +.. seealso:: + + - :rfc:`2462` (IPv6 Stateless Address Autoconfiguration) + - :rfc:`4861` (Neighbor Discovery for IP Version 6 (IPv6)) + - :rfc:`6275` (Mobility Support in IPv6) + - :rfc:`4191` (Default Router Preferences and More-Specific Routes) diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 7c2012687c..4b29c81639 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -5,8 +5,8 @@ ISIS **** :abbr:`ISIS (Intermediate System to Intermediate System)` is a routing protocol -which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an -:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`, +which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an +:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`, :abbr:`ISIS` can provide scalable network support and faster convergence times like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP (Internet Service Provider)` and carrier backbone networks. @@ -16,15 +16,14 @@ like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP Configuring isisd ================= -There are no *isisd* specific options. Common options can be -specified (:ref:`Common_Invocation_Options`) to *isisd*. -*isisd* needs to acquire interface information from -*zebra* in order to function. Therefore *zebra* must be -running before invoking *isisd*. Also, if *zebra* is -restarted then *isisd* must be too. +There are no *isisd* specific options. Common options can be specified +(:ref:`Common_Invocation_Options`) to *isisd*. *isisd* needs to acquire +interface information from *zebra* in order to function. Therefore *zebra* must +be running before invoking *isisd*. Also, if *zebra* is restarted then *isisd* +must be too. -Like other daemons, *isisd* configuration is done in :abbr:`ISIS` -specific configuration file :file:`isisd.conf`. +Like other daemons, *isisd* configuration is done in :abbr:`ISIS` specific +configuration file :file:`isisd.conf`. .. _ISIS_router: @@ -34,602 +33,596 @@ ISIS router To start ISIS process you have to specify the ISIS router. As of this writing, *isisd* does not support multiple ISIS processes. -.. index:: Command {router isis WORD} {} +.. index:: router isis WORD +.. clicmd:: router isis WORD -Command {router isis WORD} {} -.. index:: Command {no router isis WORD} {} +.. index:: no router isis WORD +.. clicmd:: no router isis WORD -Command {no router isis WORD} {} - .. _router_isis_WORD: + .. _router_isis_WORD: - Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'. - *isisd* does not yet support multiple ISIS processes but you must specify - the name of ISIS process. The ISIS process name 'WORD' is then used for interface - (see command :ref:`ip_router_isis_WORD`). + Enable or disable the ISIS process by specifying the ISIS domain with + 'WORD'. *isisd* does not yet support multiple ISIS processes but you must + specify the name of ISIS process. The ISIS process name 'WORD' is then used + for interface (see command :ref:`ip_router_isis_WORD`). -.. index:: {ISIS Command} {net XX.XXXX. ... .XXX.XX} {} +.. index:: net XX.XXXX. ... .XXX.XX +.. clicmd:: net XX.XXXX. ... .XXX.XX -{ISIS Command} {net XX.XXXX. ... .XXX.XX} {} -.. index:: {ISIS Command} {no net XX.XXXX. ... .XXX.XX} {} +.. index:: no net XX.XXXX. ... .XXX.XX +.. clicmd:: no net XX.XXXX. ... .XXX.XX -{ISIS Command} {no net XX.XXXX. ... .XXX.XX} {} - Set/Unset network entity title (NET) provided in ISO format. + Set/Unset network entity title (NET) provided in ISO format. -.. index:: {ISIS Command} {hostname dynamic} {} +.. index:: hostname dynamic +.. clicmd:: hostname dynamic -{ISIS Command} {hostname dynamic} {} -.. index:: {ISIS Command} {no hostname dynamic} {} +.. index:: no hostname dynamic +.. clicmd:: no hostname dynamic -{ISIS Command} {no hostname dynamic} {} - Enable support for dynamic hostname. + Enable support for dynamic hostname. -.. index:: {ISIS Command} {area-password [clear | md5] } {} +.. index:: area-password [clear | md5] +.. clicmd:: area-password [clear | md5] -{ISIS Command} {area-password [clear | md5] } {} -.. index:: {ISIS Command} {domain-password [clear | md5] } {} +.. index:: domain-password [clear | md5] +.. clicmd:: domain-password [clear | md5] -{ISIS Command} {domain-password [clear | md5] } {} -.. index:: {ISIS Command} {no area-password} {} +.. index:: no area-password +.. clicmd:: no area-password -{ISIS Command} {no area-password} {} -.. index:: {ISIS Command} {no domain-password} {} +.. index:: no domain-password +.. clicmd:: no domain-password -{ISIS Command} {no domain-password} {} - Configure the authentication password for an area, respectively a domain, - as clear text or md5 one. + Configure the authentication password for an area, respectively a domain, as + clear text or md5 one. -.. index:: {ISIS Command} {log-adjacency-changes} {} +.. index:: log-adjacency-changes +.. clicmd:: log-adjacency-changes -{ISIS Command} {log-adjacency-changes} {} -.. index:: {ISIS Command} {no log-adjacency-changes} {} +.. index:: no log-adjacency-changes +.. clicmd:: no log-adjacency-changes -{ISIS Command} {no log-adjacency-changes} {} - Log changes in adjacency state. + Log changes in adjacency state. -.. index:: {ISIS Command} {metric-style [narrow | transition | wide]} {} +.. index:: metric-style [narrow | transition | wide] +.. clicmd:: metric-style [narrow | transition | wide] -{ISIS Command} {metric-style [narrow | transition | wide]} {} -.. index:: {ISIS Command} {no metric-style} {} +.. index:: no metric-style +.. clicmd:: no metric-style -{ISIS Command} {no metric-style} {} - .. _metric-style: +.. _metric-style: - Set old-style (ISO 10589) or new-style packet formats: - - narrow Use old style of TLVs with narrow metric - - transition Send and accept both styles of TLVs during transition - - wide Use new style of TLVs to carry wider metric + Set old-style (ISO 10589) or new-style packet formats: -.. index:: {ISIS Command} {set-overload-bit} {} + - narrow + Use old style of TLVs with narrow metric + - transition + Send and accept both styles of TLVs during transition + - wide + Use new style of TLVs to carry wider metric -{ISIS Command} {set-overload-bit} {} -.. index:: {ISIS Command} {no set-overload-bit} {} +.. index:: set-overload-bit +.. clicmd:: set-overload-bit -{ISIS Command} {no set-overload-bit} {} - Set overload bit to avoid any transit traffic. +.. index:: no set-overload-bit +.. clicmd:: no set-overload-bit + + Set overload bit to avoid any transit traffic. .. _ISIS_Timer: ISIS Timer ========== -.. index:: {ISIS Command} {lsp-gen-interval (1-120)} {} +.. index:: lsp-gen-interval (1-120) +.. clicmd:: lsp-gen-interval (1-120) -{ISIS Command} {lsp-gen-interval (1-120)} {} -.. index:: {ISIS Command} {lsp-gen-interval [level-1 | level-2] (1-120)} {} +.. index:: lsp-gen-interval [level-1 | level-2] (1-120) +.. clicmd:: lsp-gen-interval [level-1 | level-2] (1-120) -{ISIS Command} {lsp-gen-interval [level-1 | level-2] (1-120)} {} -.. index:: {ISIS Command} {no lsp-gen-interval} {} +.. index:: no lsp-gen-interval +.. clicmd:: no lsp-gen-interval -{ISIS Command} {no lsp-gen-interval} {} -.. index:: {ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {} +.. index:: no lsp-gen-interval [level-1 | level-2] +.. clicmd:: no lsp-gen-interval [level-1 | level-2] -{ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {} - Set minimum interval in seconds between regenerating same LSP, - globally, for an area (level-1) or a domain (level-2). + Set minimum interval in seconds between regenerating same LSP, + globally, for an area (level-1) or a domain (level-2). -.. index:: {ISIS Command} {lsp-refresh-interval (1-65235)} {} +.. index:: lsp-refresh-interval [level-1 | level-2] (1-65235) +.. clicmd:: lsp-refresh-interval [level-1 | level-2] (1-65235) -{ISIS Command} {lsp-refresh-interval (1-65235)} {} -.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} +.. index:: no lsp-refresh-interval [level-1 | level-2] +.. clicmd:: no lsp-refresh-interval [level-1 | level-2] -{ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} -.. index:: {ISIS Command} {no lsp-refresh-interval} {} + Set LSP refresh interval in seconds, globally, for an area (level-1) or a + domain (level-2). -{ISIS Command} {no lsp-refresh-interval} {} -.. index:: {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} +.. index:: max-lsp-lifetime (360-65535) +.. clicmd:: max-lsp-lifetime (360-65535) -{ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} - Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). +.. index:: max-lsp-lifetime [level-1 | level-2] (360-65535) +.. clicmd:: max-lsp-lifetime [level-1 | level-2] (360-65535) -.. index:: {ISIS Command} {lsp-refresh-interval (1-65235)} {} +.. index:: no max-lsp-lifetime +.. clicmd:: no max-lsp-lifetime -{ISIS Command} {lsp-refresh-interval (1-65235)} {} -.. index:: {ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} +.. index:: no max-lsp-lifetime [level-1 | level-2] +.. clicmd:: no max-lsp-lifetime [level-1 | level-2] -{ISIS Command} {lsp-refresh-interval [level-1 | level-2] (1-65235)} {} -.. index:: {ISIS Command} {no lsp-refresh-interval} {} + Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or + a domain (level-2). -{ISIS Command} {no lsp-refresh-interval} {} -.. index:: {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} +.. index:: spf-interval (1-120) +.. clicmd:: spf-interval (1-120) -{ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} - Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). +.. index:: spf-interval [level-1 | level-2] (1-120) +.. clicmd:: spf-interval [level-1 | level-2] (1-120) -.. index:: {ISIS Command} {max-lsp-lifetime (360-65535)} {} +.. index:: no spf-interval +.. clicmd:: no spf-interval -{ISIS Command} {max-lsp-lifetime (360-65535)} {} -.. index:: {ISIS Command} {max-lsp-lifetime [level-1 | level-2] (360-65535)} {} +.. index:: no spf-interval [level-1 | level-2] +.. clicmd:: no spf-interval [level-1 | level-2] -{ISIS Command} {max-lsp-lifetime [level-1 | level-2] (360-65535)} {} -.. index:: {ISIS Command} {no max-lsp-lifetime} {} - -{ISIS Command} {no max-lsp-lifetime} {} -.. index:: {ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} - -{ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} - Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or a domain (level-2). - -.. index:: {ISIS Command} {spf-interval (1-120)} {} - -{ISIS Command} {spf-interval (1-120)} {} -.. index:: {ISIS Command} {spf-interval [level-1 | level-2] (1-120)} {} - -{ISIS Command} {spf-interval [level-1 | level-2] (1-120)} {} -.. index:: {ISIS Command} {no spf-interval} {} - -{ISIS Command} {no spf-interval} {} -.. index:: {ISIS Command} {no spf-interval [level-1 | level-2]} {} - -{ISIS Command} {no spf-interval [level-1 | level-2]} {} - Set minimum interval between consecutive SPF calculations in seconds. + Set minimum interval between consecutive SPF calculations in seconds. .. _ISIS_region: ISIS region =========== -.. index:: {ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {} +.. index:: is-type [level-1 | level-1-2 | level-2-only] +.. clicmd:: is-type [level-1 | level-1-2 | level-2-only] -{ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {} -.. index:: {ISIS Command} {no is-type} {} +.. index:: no is-type +.. clicmd:: no is-type -{ISIS Command} {no is-type} {} - Define the ISIS router behavior: - - level-1 Act as a station router only - - level-1-2 Act as both a station router and an area router - - level-2-only Act as an area router only + Define the ISIS router behavior: + + - level-1 + Act as a station router only + - level-1-2 + Act as both a station router and an area router + - level-2-only + Act as an area router only .. _ISIS_interface: ISIS interface ============== -.. index:: {Interface Command} {ip router isis WORD} {} +.. index:: ip router isis WORD +.. clicmd:: ip router isis WORD -{Interface Command} {ip router isis WORD} {} -.. index:: {Interface Command} {no ip router isis WORD} {} +.. index:: no ip router isis WORD +.. clicmd:: no ip router isis WORD -{Interface Command} {no ip router isis WORD} {} - .. _ip_router_isis_WORD: +.. _ip_router_isis_WORD: - Activate ISIS adjacency on this interface. Note that the name - of ISIS instance must be the same as the one used to configure the ISIS process - (see command :ref:`router_isis_WORD`). + Activate ISIS adjacency on this interface. Note that the name + of ISIS instance must be the same as the one used to configure the ISIS process + (see command :ref:`router_isis_WORD`). -.. index:: {Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {} +.. index:: isis circuit-type [level-1 | level-1-2 | level-2] +.. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2] -{Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {} -.. index:: {Interface Command} {no isis circuit-type} {} +.. index:: no isis circuit-type +.. clicmd:: no isis circuit-type -{Interface Command} {no isis circuit-type} {} - Configure circuit type for interface: - - level-1 Level-1 only adjacencies are formed - - level-1-2 Level-1-2 adjacencies are formed - - level-2-only Level-2 only adjacencies are formed + Configure circuit type for interface: -.. index:: {Interface Command} {isis csnp-interval (1-600)} {} + - level-1 + Level-1 only adjacencies are formed + - level-1-2 + Level-1-2 adjacencies are formed + - level-2-only + Level-2 only adjacencies are formed -{Interface Command} {isis csnp-interval (1-600)} {} -.. index:: {Interface Command} {isis csnp-interval (1-600) [level-1 | level-2]} {} +.. index:: isis csnp-interval (1-600) +.. clicmd:: isis csnp-interval (1-600) -{Interface Command} {isis csnp-interval (1-600) [level-1 | level-2]} {} -.. index:: {Interface Command} {no isis csnp-interval} {} +.. index:: isis csnp-interval (1-600) [level-1 | level-2] +.. clicmd:: isis csnp-interval (1-600) [level-1 | level-2] -{Interface Command} {no isis csnp-interval} {} -.. index:: {Interface Command} {no isis csnp-interval [level-1 | level-2]} {} +.. index:: no isis csnp-interval +.. clicmd:: no isis csnp-interval -{Interface Command} {no isis csnp-interval [level-1 | level-2]} {} - Set CSNP interval in seconds globally, for an area (level-1) or a domain (level-2). +.. index:: no isis csnp-interval [level-1 | level-2] +.. clicmd:: no isis csnp-interval [level-1 | level-2] -.. index:: {Interface Command} {isis hello padding} {} + Set CSNP interval in seconds globally, for an area (level-1) or a domain + (level-2). -{Interface Command} {isis hello padding} {} - Add padding to IS-IS hello packets. +.. index:: isis hello padding +.. clicmd:: isis hello padding -.. index:: {Interface Command} {isis hello-interval (1-600)} {} + Add padding to IS-IS hello packets. -{Interface Command} {isis hello-interval (1-600)} {} -.. index:: {Interface Command} {isis hello-interval (1-600) [level-1 | level-2]} {} +.. index:: isis hello-interval (1-600) +.. clicmd:: isis hello-interval (1-600) -{Interface Command} {isis hello-interval (1-600) [level-1 | level-2]} {} -.. index:: {Interface Command} {no isis hello-interval} {} +.. index:: isis hello-interval (1-600) [level-1 | level-2] +.. clicmd:: isis hello-interval (1-600) [level-1 | level-2] -{Interface Command} {no isis hello-interval} {} -.. index:: {Interface Command} {no isis hello-interval [level-1 | level-2]} {} +.. index:: no isis hello-interval +.. clicmd:: no isis hello-interval -{Interface Command} {no isis hello-interval [level-1 | level-2]} {} - Set Hello interval in seconds globally, for an area (level-1) or a domain (level-2). +.. index:: no isis hello-interval [level-1 | level-2] +.. clicmd:: no isis hello-interval [level-1 | level-2] -.. index:: {Interface Command} {isis hello-multiplier (2-100)} {} + Set Hello interval in seconds globally, for an area (level-1) or a domain + (level-2). -{Interface Command} {isis hello-multiplier (2-100)} {} -.. index:: {Interface Command} {isis hello-multiplier (2-100) [level-1 | level-2]} {} +.. index:: isis hello-multiplier (2-100) +.. clicmd:: isis hello-multiplier (2-100) -{Interface Command} {isis hello-multiplier (2-100) [level-1 | level-2]} {} -.. index:: {Interface Command} {no isis hello-multiplier} {} +.. index:: isis hello-multiplier (2-100) [level-1 | level-2] +.. clicmd:: isis hello-multiplier (2-100) [level-1 | level-2] -{Interface Command} {no isis hello-multiplier} {} -.. index:: {Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} +.. index:: no isis hello-multiplier +.. clicmd:: no isis hello-multiplier -{Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} - Set multiplier for Hello holding time globally, for an area (level-1) or a domain (level-2). +.. index:: no isis hello-multiplier [level-1 | level-2] +.. clicmd:: no isis hello-multiplier [level-1 | level-2] -.. index:: {Interface Command} {isis metric [(0-255) | (0-16777215)]} {} + Set multiplier for Hello holding time globally, for an area (level-1) or a + domain (level-2). -{Interface Command} {isis metric [(0-255) | (0-16777215)]} {} -.. index:: {Interface Command} {isis metric [(0-255) | (0-16777215)] [level-1 | level-2]} {} +.. index:: isis metric [(0-255) | (0-16777215)] +.. clicmd:: isis metric [(0-255) | (0-16777215)] -{Interface Command} {isis metric [(0-255) | (0-16777215)] [level-1 | level-2]} {} -.. index:: {Interface Command} {no isis metric} {} +.. index:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2] +.. clicmd:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2] -{Interface Command} {no isis metric} {} -.. index:: {Interface Command} {no isis metric [level-1 | level-2]} {} +.. index:: no isis metric +.. clicmd:: no isis metric -{Interface Command} {no isis metric [level-1 | level-2]} {} - Set default metric value globally, for an area (level-1) or a domain (level-2). - Max value depend if metric support narrow or wide value (see command :ref:`metric-style`). +.. index:: no isis metric [level-1 | level-2] +.. clicmd:: no isis metric [level-1 | level-2] -.. index:: {Interface Command} {isis network point-to-point} {} + Set default metric value globally, for an area (level-1) or a domain + (level-2). Max value depend if metric support narrow or wide value (see + command :ref:`metric-style`). -{Interface Command} {isis network point-to-point} {} -.. index:: {Interface Command} {no isis network point-to-point} {} +.. index:: isis network point-to-point +.. clicmd:: isis network point-to-point -{Interface Command} {no isis network point-to-point} {} - Set network type to 'Point-to-Point' (broadcast by default). +.. index:: no isis network point-to-point +.. clicmd:: no isis network point-to-point -.. index:: {Interface Command} {isis passive} {} + Set network type to 'Point-to-Point' (broadcast by default). -{Interface Command} {isis passive} {} -.. index:: {Interface Command} {no isis passive} {} +.. index:: isis passive +.. clicmd:: isis passive -{Interface Command} {no isis passive} {} - Configure the passive mode for this interface. +.. index:: no isis passive +.. clicmd:: no isis passive -.. index:: {Interface Command} {isis password [clear | md5] } {} + Configure the passive mode for this interface. -{Interface Command} {isis password [clear | md5] } {} -.. index:: {Interface Command} {no isis password} {} +.. index:: isis password [clear | md5] +.. clicmd:: isis password [clear | md5] -{Interface Command} {no isis password} {} - Configure the authentication password (clear or encoded text) for the interface. +.. index:: no isis password +.. clicmd:: no isis password -.. index:: {Interface Command} {isis priority (0-127)} {} + Configure the authentication password (clear or encoded text) for the + interface. -{Interface Command} {isis priority (0-127)} {} -.. index:: {Interface Command} {isis priority (0-127) [level-1 | level-2]} {} +.. index:: isis priority (0-127) +.. clicmd:: isis priority (0-127) -{Interface Command} {isis priority (0-127) [level-1 | level-2]} {} -.. index:: {Interface Command} {no isis priority} {} +.. index:: isis priority (0-127) [level-1 | level-2] +.. clicmd:: isis priority (0-127) [level-1 | level-2] -{Interface Command} {no isis priority} {} -.. index:: {Interface Command} {no isis priority [level-1 | level-2]} {} +.. index:: no isis priority +.. clicmd:: no isis priority -{Interface Command} {no isis priority [level-1 | level-2]} {} - Set priority for Designated Router election, globally, for the area (level-1) - or the domain (level-2). +.. index:: no isis priority [level-1 | level-2] +.. clicmd:: no isis priority [level-1 | level-2] -.. index:: {Interface Command} {isis psnp-interval (1-120)} {} + Set priority for Designated Router election, globally, for the area + (level-1) or the domain (level-2). -{Interface Command} {isis psnp-interval (1-120)} {} -.. index:: {Interface Command} {isis psnp-interval (1-120) [level-1 | level-2]} {} +.. index:: isis psnp-interval (1-120) +.. clicmd:: isis psnp-interval (1-120) -{Interface Command} {isis psnp-interval (1-120) [level-1 | level-2]} {} -.. index:: {Interface Command} {no isis psnp-interval} {} +.. index:: isis psnp-interval (1-120) [level-1 | level-2] +.. clicmd:: isis psnp-interval (1-120) [level-1 | level-2] -{Interface Command} {no isis psnp-interval} {} -.. index:: {Interface Command} {no isis psnp-interval [level-1 | level-2]} {} +.. index:: no isis psnp-interval +.. clicmd:: no isis psnp-interval -{Interface Command} {no isis psnp-interval [level-1 | level-2]} {} - Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2). +.. index:: no isis psnp-interval [level-1 | level-2] +.. clicmd:: no isis psnp-interval [level-1 | level-2] + + Set PSNP interval in seconds globally, for an area (level-1) or a domain + (level-2). .. _Showing_ISIS_information: Showing ISIS information ======================== -.. index:: {Command} {show isis summary} {} +.. index:: show isis summary +.. clicmd:: show isis summary -{Command} {show isis summary} {} - Show summary information about ISIS. + Show summary information about ISIS. -.. index:: {Command} {show isis hostname} {} +.. index:: show isis hostname +.. clicmd:: show isis hostname -{Command} {show isis hostname} {} - Show information about ISIS node. + Show information about ISIS node. -.. index:: {Command} {show isis interface} {} +.. index:: show isis interface +.. clicmd:: show isis interface -{Command} {show isis interface} {} -.. index:: {Command} {show isis interface detail} {} +.. index:: show isis interface detail +.. clicmd:: show isis interface detail -{Command} {show isis interface detail} {} -.. index:: {Command} {show isis interface } {} +.. index:: show isis interface +.. clicmd:: show isis interface -{Command} {show isis interface } {} - Show state and configuration of ISIS specified interface, or all - interfaces if no interface is given with or without details. + Show state and configuration of ISIS specified interface, or all interfaces + if no interface is given with or without details. -.. index:: {Command} {show isis neighbor} {} +.. index:: show isis neighbor +.. clicmd:: show isis neighbor -{Command} {show isis neighbor} {} -.. index:: {Command} {show isis neighbor } {} +.. index:: show isis neighbor +.. clicmd:: show isis neighbor -{Command} {show isis neighbor } {} -.. index:: {Command} {show isis neighbor detail} {} +.. index:: show isis neighbor detail +.. clicmd:: show isis neighbor detail -{Command} {show isis neighbor detail} {} - Show state and information of ISIS specified neighbor, or all - neighbors if no system id is given with or without details. + Show state and information of ISIS specified neighbor, or all neighbors if + no system id is given with or without details. -.. index:: {Command} {show isis database} {} +.. index:: show isis database +.. clicmd:: show isis database -{Command} {show isis database} {} -.. index:: {Command} {show isis database [detail]} {} +.. index:: show isis database [detail] +.. clicmd:: show isis database [detail] -{Command} {show isis database [detail]} {} -.. index:: {Command} {show isis database [detail]} {} +.. index:: show isis database [detail] +.. clicmd:: show isis database [detail] -{Command} {show isis database [detail]} {} -.. index:: {Command} {show isis database detail } {} +.. index:: show isis database detail +.. clicmd:: show isis database detail -{Command} {show isis database detail } {} - Show the ISIS database globally, for a specific LSP id without or with details. + Show the ISIS database globally, for a specific LSP id without or with + details. -.. index:: {Command} {show isis topology} {} +.. index:: show isis topology +.. clicmd:: show isis topology -{Command} {show isis topology} {} -.. index:: {Command} {show isis topology [level-1|level-2]} {} +.. index:: show isis topology [level-1|level-2] +.. clicmd:: show isis topology [level-1|level-2] -{Command} {show isis topology [level-1|level-2]} {} - Show topology IS-IS paths to Intermediate Systems, globally, - in area (level-1) or domain (level-2). + Show topology IS-IS paths to Intermediate Systems, globally, in area + (level-1) or domain (level-2). -.. index:: {Command} {show ip route isis} {} +.. index:: show ip route isis +.. clicmd:: show ip route isis -{Command} {show ip route isis} {} - Show the ISIS routing table, as determined by the most recent SPF calculation. + Show the ISIS routing table, as determined by the most recent SPF + calculation. -.. _Traffic_Engineering: +.. _ospf-traffic-engineering: Traffic Engineering =================== -.. index:: {ISIS Command} {mpls-te on} {} +.. index:: mpls-te on +.. clicmd:: mpls-te on -{ISIS Command} {mpls-te on} {} -.. index:: {ISIS Command} {no mpls-te} {} +.. index:: no mpls-te +.. clicmd:: no mpls-te -{ISIS Command} {no mpls-te} {} - Enable Traffic Engineering LSP flooding. + Enable Traffic Engineering LSP flooding. -.. index:: {ISIS Command} {mpls-te router-address } {} +.. index:: mpls-te router-address +.. clicmd:: mpls-te router-address -{ISIS Command} {mpls-te router-address } {} -.. index:: {ISIS Command} {no mpls-te router-address} {} +.. index:: no mpls-te router-address +.. clicmd:: no mpls-te router-address -{ISIS Command} {no mpls-te router-address} {} - Configure stable IP address for MPLS-TE. + Configure stable IP address for MPLS-TE. -.. index:: {Command} {show isis mpls-te interface} {} +.. index:: show isis mpls-te interface +.. clicmd:: show isis mpls-te interface -{Command} {show isis mpls-te interface} {} -.. index:: {Command} {show isis mpls-te interface `interface`} {} +.. index:: show isis mpls-te interface INTERFACE +.. clicmd:: show isis mpls-te interface INTERFACE -{Command} {show isis mpls-te interface `interface`} {} - Show MPLS Traffic Engineering parameters for all or specified interface. + Show MPLS Traffic Engineering parameters for all or specified interface. -.. index:: {Command} {show isis mpls-te router} {} +.. index:: show isis mpls-te router +.. clicmd:: show isis mpls-te router -{Command} {show isis mpls-te router} {} - Show Traffic Engineering router parameters. + Show Traffic Engineering router parameters. .. _Debugging_ISIS: Debugging ISIS ============== -.. index:: {Command} {debug isis adj-packets} {} +.. index:: debug isis adj-packets +.. clicmd:: debug isis adj-packets -{Command} {debug isis adj-packets} {} -.. index:: {Command} {no debug isis adj-packets} {} +.. index:: no debug isis adj-packets +.. clicmd:: no debug isis adj-packets -{Command} {no debug isis adj-packets} {} - IS-IS Adjacency related packets. + IS-IS Adjacency related packets. -.. index:: {Command} {debug isis checksum-errors} {} +.. index:: debug isis checksum-errors +.. clicmd:: debug isis checksum-errors -{Command} {debug isis checksum-errors} {} -.. index:: {Command} {no debug isis checksum-errors} {} +.. index:: no debug isis checksum-errors +.. clicmd:: no debug isis checksum-errors -{Command} {no debug isis checksum-errors} {} - IS-IS LSP checksum errors. + IS-IS LSP checksum errors. -.. index:: {Command} {debug isis events} {} +.. index:: debug isis events +.. clicmd:: debug isis events -{Command} {debug isis events} {} -.. index:: {Command} {no debug isis events} {} +.. index:: no debug isis events +.. clicmd:: no debug isis events -{Command} {no debug isis events} {} - IS-IS Events. + IS-IS Events. -.. index:: {Command} {debug isis local-updates} {} +.. index:: debug isis local-updates +.. clicmd:: debug isis local-updates -{Command} {debug isis local-updates} {} -.. index:: {Command} {no debug isis local-updates} {} +.. index:: no debug isis local-updates +.. clicmd:: no debug isis local-updates -{Command} {no debug isis local-updates} {} - IS-IS local update packets. + IS-IS local update packets. -.. index:: {Command} {debug isis packet-dump} {} +.. index:: debug isis packet-dump +.. clicmd:: debug isis packet-dump -{Command} {debug isis packet-dump} {} -.. index:: {Command} {no debug isis packet-dump} {} +.. index:: no debug isis packet-dump +.. clicmd:: no debug isis packet-dump -{Command} {no debug isis packet-dump} {} - IS-IS packet dump. + IS-IS packet dump. -.. index:: {Command} {debug isis protocol-errors} {} +.. index:: debug isis protocol-errors +.. clicmd:: debug isis protocol-errors -{Command} {debug isis protocol-errors} {} -.. index:: {Command} {no debug isis protocol-errors} {} +.. index:: no debug isis protocol-errors +.. clicmd:: no debug isis protocol-errors -{Command} {no debug isis protocol-errors} {} - IS-IS LSP protocol errors. + IS-IS LSP protocol errors. -.. index:: {Command} {debug isis route-events} {} +.. index:: debug isis route-events +.. clicmd:: debug isis route-events -{Command} {debug isis route-events} {} -.. index:: {Command} {no debug isis route-events} {} +.. index:: no debug isis route-events +.. clicmd:: no debug isis route-events -{Command} {no debug isis route-events} {} - IS-IS Route related events. + IS-IS Route related events. -.. index:: {Command} {debug isis snp-packets} {} +.. index:: debug isis snp-packets +.. clicmd:: debug isis snp-packets -{Command} {debug isis snp-packets} {} -.. index:: {Command} {no debug isis snp-packets} {} +.. index:: no debug isis snp-packets +.. clicmd:: no debug isis snp-packets -{Command} {no debug isis snp-packets} {} - IS-IS CSNP/PSNP packets. + IS-IS CSNP/PSNP packets. -.. index:: {Command} {debug isis spf-events} {} +.. index:: debug isis spf-events +.. clicmd:: debug isis spf-events -{Command} {debug isis spf-events} {} -.. index:: {Command} {debug isis spf-statistics} {} +.. index:: debug isis spf-statistics +.. clicmd:: debug isis spf-statistics -{Command} {debug isis spf-statistics} {} -.. index:: {Command} {debug isis spf-triggers} {} +.. index:: debug isis spf-triggers +.. clicmd:: debug isis spf-triggers -{Command} {debug isis spf-triggers} {} -.. index:: {Command} {no debug isis spf-events} {} +.. index:: no debug isis spf-events +.. clicmd:: no debug isis spf-events -{Command} {no debug isis spf-events} {} -.. index:: {Command} {no debug isis spf-statistics} {} +.. index:: no debug isis spf-statistics +.. clicmd:: no debug isis spf-statistics -{Command} {no debug isis spf-statistics} {} -.. index:: {Command} {no debug isis spf-triggers} {} +.. index:: no debug isis spf-triggers +.. clicmd:: no debug isis spf-triggers -{Command} {no debug isis spf-triggers} {} - IS-IS Shortest Path First Events, Timing and Statistic Data - and triggering events. + IS-IS Shortest Path First Events, Timing and Statistic Data and triggering + events. -.. index:: {Command} {debug isis update-packets} {} +.. index:: debug isis update-packets +.. clicmd:: debug isis update-packets -{Command} {debug isis update-packets} {} -.. index:: {Command} {no debug isis update-packets} {} +.. index:: no debug isis update-packets +.. clicmd:: no debug isis update-packets -{Command} {no debug isis update-packets} {} - Update related packets. + Update related packets. -.. index:: {Command} {show debugging isis} {} +.. index:: show debugging isis +.. clicmd:: show debugging isis -{Command} {show debugging isis} {} - Print which ISIS debug level is activate. + Print which ISIS debug level is activate. ISIS Configuration Examples =========================== -A simple example, with MD5 authentication enabled: +A simple example, with MD5 authentication enabled::: -:: - - ! - interface eth0 - ip router isis FOO - isis network point-to-point - isis circuit-type level-2-only - ! - router isis FOO - net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 - metric-style wide - is-type level-2-only + ! + interface eth0 + ip router isis FOO + isis network point-to-point + isis circuit-type level-2-only + ! + router isis FOO + net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 + metric-style wide + is-type level-2-only A Traffic Engineering configuration, with Inter-ASv2 support. -- First, the 'zebra.conf' part: +First, the 'zebra.conf' part::: -:: - - hostname HOSTNAME - password PASSWORD - log file /var/log/zebra.log - ! - interface eth0 - ip address 10.2.2.2/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - ! - interface eth1 - ip address 10.1.1.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - mpls-te neighbor 10.1.1.2 as 65000 - - -- Then the 'isisd.conf' itself: - -:: - - hostname HOSTNAME - password PASSWORD - log file /var/log/isisd.log - ! - ! - interface eth0 - ip router isis FOO - ! - interface eth1 - ip router isis FOO - ! - ! - router isis FOO - isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 + hostname HOSTNAME + password PASSWORD + log file /var/log/zebra.log + ! + interface eth0 + ip address 10.2.2.2/24 mpls-te on - mpls-te router-address 10.1.1.1 - ! - line vty + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + ! + interface eth1 + ip address 10.1.1.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + mpls-te neighbor 10.1.1.2 as 65000 +Then the 'isisd.conf' itself::: + + hostname HOSTNAME + password PASSWORD + log file /var/log/isisd.log + ! + ! + interface eth0 + ip router isis FOO + ! + interface eth1 + ip router isis FOO + ! + ! + router isis FOO + isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 + mpls-te on + mpls-te router-address 10.1.1.1 + ! + line vty diff --git a/doc/user/nhrpd.rst b/doc/user/nhrpd.rst index ba6011b44a..f69313144d 100644 --- a/doc/user/nhrpd.rst +++ b/doc/user/nhrpd.rst @@ -4,18 +4,17 @@ NHRP **** -*nhrpd* is a daemon to support Next Hop Routing Protocol (NHRP). -NHRP is described in RFC2332. +*nhrpd* is an implementation of the :abbr:NHRP `(Next Hop Routing Protocol)`. +NHRP is described in :rfc`2332`. -NHRP is used to improve the efficiency of routing computer network -traffic over Non-Broadcast, Multiple Access (NBMA) Networks. NHRP provides -an ARP-like solution that allows a system to dynamically learn the NBMA -address of the other systems that are part of that network, allowing -these systems to directly communicate without requiring traffic to use -an intermediate hop. +NHRP is used to improve the efficiency of routing computer network traffic over +:abbr:`NBMA (Non-Broadcast, Multiple Access)` networks. NHRP provides an +ARP-like solution that allows a system to dynamically learn the NBMA address of +the other systems that are part of that network, allowing these systems to +directly communicate without requiring traffic to use an intermediate hop. -Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and -|PACKAGE_NAME| nhrpd implements this scenario. +Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and |PACKAGE_NAME| nhrpd +implements this scenario. .. _Routing_Design: @@ -31,9 +30,8 @@ nhrpd does route NHRP domain addresses individually using per-host prefixes. This is similar to Cisco FlexVPN; but in contrast to opennhrp which uses a generic subnet route. -To create NBMA GRE tunnel you might use the following (linux terminal -commands): -:: +To create NBMA GRE tunnel you might use the following (Linux terminal +commands)::: ip tunnel add gre1 mode gre key 42 ttl 64 ip addr add 10.255.255.2/32 dev gre1 @@ -54,8 +52,7 @@ hub nodes, these routes should be internally redistributed using some routing protocol (e.g. iBGP) to allow hubs to be able to relay all traffic. This can be achieved in hubs with the following bgp configuration (network -command defines the GRE subnet): -:: +command defines the GRE subnet)::: router bgp 65555 address-family ipv4 unicast @@ -98,20 +95,16 @@ announce internal, add additional IP range matches, or rate limitation if needed. However, the above should be good in most cases. This kernel NFLOG target's nflog-group is configured in global nhrp config -with: -:: +with::: nhrp nflog-group 1 - To start sending these traffic notices out from hubs, use the nhrp -per-interface directive: -:: +per-interface directive::: interface gre1 ip nhrp redirect - .. _Integration_with_IKE: Integration with IKE diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index 651849d466..17caa089d2 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -4,82 +4,79 @@ OSPFv3 ****** -*ospf6d* is a daemon support OSPF version 3 for IPv6 network. -OSPF for IPv6 is described in RFC2740. +*ospf6d* is a daemon support OSPF version 3 for IPv6 network. OSPF for IPv6 is +described in :rfc:`2740`. .. _OSPF6_router: OSPF6 router ============ -.. index:: {Command} {router ospf6} {} +.. index:: router ospf6 +.. clicmd:: router ospf6 -{Command} {router ospf6} {} +.. index:: router-id A.B.C.D +.. clicmd:: router-id A.B.C.D -.. index:: {OSPF6 Command} {router-id `a.b.c.d`} {} + Set router's Router-ID. -{OSPF6 Command} {router-id `a.b.c.d`} {} - Set router's Router-ID. +.. index:: interface IFNAME area AREA +.. clicmd:: interface IFNAME area AREA -.. index:: {OSPF6 Command} {interface `ifname` area `area`} {} + Bind interface to specified area, and start sending OSPF packets. `area` can + be specified as 0. -{OSPF6 Command} {interface `ifname` area `area`} {} - Bind interface to specified area, and start sending OSPF packets. `area` can - be specified as 0. +.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME +.. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME -.. index:: {OSPF6 Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} +.. index:: no timers throttle spf +.. clicmd:: no timers throttle spf -{OSPF6 Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} -.. index:: {OSPF6 Command} {no timers throttle spf} {} + This command sets the initial `delay`, the `initial-holdtime` + and the `maximum-holdtime` between when SPF is calculated and the + event which triggered the calculation. The times are specified in + milliseconds and must be in the range of 0 to 600000 milliseconds. -{OSPF6 Command} {no timers throttle spf} {} - This command sets the initial `delay`, the `initial-holdtime` - and the `maximum-holdtime` between when SPF is calculated and the - event which triggered the calculation. The times are specified in - milliseconds and must be in the range of 0 to 600000 milliseconds. + The `delay` specifies the minimum amount of time to delay SPF + calculation (hence it affects how long SPF calculation is delayed after + an event which occurs outside of the holdtime of any previous SPF + calculation, and also serves as a minimum holdtime). - The `delay` specifies the minimum amount of time to delay SPF - calculation (hence it affects how long SPF calculation is delayed after - an event which occurs outside of the holdtime of any previous SPF - calculation, and also serves as a minimum holdtime). - - Consecutive SPF calculations will always be seperated by at least - 'hold-time' milliseconds. The hold-time is adaptive and initially is - set to the `initial-holdtime` configured with the above command. - Events which occur within the holdtime of the previous SPF calculation - will cause the holdtime to be increased by `initial-holdtime`, bounded - by the `maximum-holdtime` configured with this command. If the adaptive - hold-time elapses without any SPF-triggering event occuring then - the current holdtime is reset to the `initial-holdtime`. - -:: + Consecutive SPF calculations will always be seperated by at least + 'hold-time' milliseconds. The hold-time is adaptive and initially is + set to the `initial-holdtime` configured with the above command. + Events which occur within the holdtime of the previous SPF calculation + will cause the holdtime to be increased by `initial-holdtime`, bounded + by the `maximum-holdtime` configured with this command. If the adaptive + hold-time elapses without any SPF-triggering event occuring then + the current holdtime is reset to the `initial-holdtime`.:: router ospf6 timers throttle spf 200 400 10000 - In this example, the `delay` is set to 200ms, the @var{initial - holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence - there will always be at least 200ms between an event which requires SPF - calculation and the actual SPF calculation. Further consecutive SPF - calculations will always be seperated by between 400ms to 10s, the - hold-time increasing by 400ms each time an SPF-triggering event occurs - within the hold-time of the previous SPF calculation. + In this example, the `delay` is set to 200ms, the initial holdtime is set + to 400ms and the `maximum holdtime` to 10s. Hence there will always be at + least 200ms between an event which requires SPF calculation and the actual + SPF calculation. Further consecutive SPF calculations will always be + seperated by between 400ms to 10s, the hold-time increasing by 400ms each + time an SPF-triggering event occurs within the hold-time of the previous + SPF calculation. -.. index:: {OSPF6 Command} {auto-cost reference-bandwidth `cost`} {} +.. index:: auto-cost reference-bandwidth COST +.. clicmd:: auto-cost reference-bandwidth COST -{OSPF6 Command} {auto-cost reference-bandwidth `cost`} {} -.. index:: {OSPF6 Command} {no auto-cost reference-bandwidth} {} +.. index:: no auto-cost reference-bandwidth +.. clicmd:: no auto-cost reference-bandwidth -{OSPF6 Command} {no auto-cost reference-bandwidth} {} - This sets the reference bandwidth for cost calculations, where this - bandwidth is considered equivalent to an OSPF cost of 1, specified in - Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s - or higher will have a cost of 1. Cost of lower bandwidth links will be - scaled with reference to this cost). + This sets the reference bandwidth for cost calculations, where this + bandwidth is considered equivalent to an OSPF cost of 1, specified in + Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s + or higher will have a cost of 1. Cost of lower bandwidth links will be + scaled with reference to this cost). - This configuration setting MUST be consistent across all routers - within the OSPF domain. + This configuration setting MUST be consistent across all routers + within the OSPF domain. .. _OSPF6_area: @@ -93,97 +90,97 @@ Area support for OSPFv3 is not yet implemented. OSPF6 interface =============== -.. index:: {Interface Command} {ipv6 ospf6 cost COST} {} +.. index:: ipv6 ospf6 cost COST +.. clicmd:: ipv6 ospf6 cost COST -{Interface Command} {ipv6 ospf6 cost COST} {} - Sets interface's output cost. Default value depends on the interface - bandwidth and on the auto-cost reference bandwidth. + Sets interface's output cost. Default value depends on the interface + bandwidth and on the auto-cost reference bandwidth. -.. index:: {Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {} +.. index:: ipv6 ospf6 hello-interval HELLOINTERVAL +.. clicmd:: ipv6 ospf6 hello-interval HELLOINTERVAL -{Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {} - Sets interface's Hello Interval. Default 40 + Sets interface's Hello Interval. Default 40 -.. index:: {Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {} +.. index:: ipv6 ospf6 dead-interval DEADINTERVAL +.. clicmd:: ipv6 ospf6 dead-interval DEADINTERVAL -{Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {} - Sets interface's Router Dead Interval. Default value is 40. + Sets interface's Router Dead Interval. Default value is 40. -.. index:: {Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {} +.. index:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL +.. clicmd:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL -{Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {} - Sets interface's Rxmt Interval. Default value is 5. + Sets interface's Rxmt Interval. Default value is 5. -.. index:: {Interface Command} {ipv6 ospf6 priority PRIORITY} {} +.. index:: ipv6 ospf6 priority PRIORITY +.. clicmd:: ipv6 ospf6 priority PRIORITY -{Interface Command} {ipv6 ospf6 priority PRIORITY} {} - Sets interface's Router Priority. Default value is 1. + Sets interface's Router Priority. Default value is 1. -.. index:: {Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {} +.. index:: ipv6 ospf6 transmit-delay TRANSMITDELAY +.. clicmd:: ipv6 ospf6 transmit-delay TRANSMITDELAY -{Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {} - Sets interface's Inf-Trans-Delay. Default value is 1. + Sets interface's Inf-Trans-Delay. Default value is 1. -.. index:: {Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {} +.. index:: ipv6 ospf6 network (broadcast|point-to-point) +.. clicmd:: ipv6 ospf6 network (broadcast|point-to-point) -{Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {} - Set explicitly network type for specifed interface. + Set explicitly network type for specifed interface. .. _Redistribute_routes_to_OSPF6: Redistribute routes to OSPF6 ============================ -.. index:: {OSPF6 Command} {redistribute static} {} +.. index:: redistribute static +.. clicmd:: redistribute static -{OSPF6 Command} {redistribute static} {} -.. index:: {OSPF6 Command} {redistribute connected} {} +.. index:: redistribute connected +.. clicmd:: redistribute connected -{OSPF6 Command} {redistribute connected} {} -.. index:: {OSPF6 Command} {redistribute ripng} {} +.. index:: redistribute ripng +.. clicmd:: redistribute ripng -{OSPF6 Command} {redistribute ripng} {} .. _Showing_OSPF6_information: Showing OSPF6 information ========================= -.. index:: {Command} {show ipv6 ospf6 [INSTANCE_ID]} {} +.. index:: show ipv6 ospf6 [INSTANCE_ID] +.. clicmd:: show ipv6 ospf6 [INSTANCE_ID] -{Command} {show ipv6 ospf6 [INSTANCE_ID]} {} - INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF - instance ID, simply type "show ipv6 ospf6 ". + INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF + instance ID, simply type "show ipv6 ospf6 ". -.. index:: {Command} {show ipv6 ospf6 database} {} +.. index:: show ipv6 ospf6 database +.. clicmd:: show ipv6 ospf6 database -{Command} {show ipv6 ospf6 database} {} - This command shows LSA database summary. You can specify the type of LSA. + This command shows LSA database summary. You can specify the type of LSA. -.. index:: {Command} {show ipv6 ospf6 interface} {} +.. index:: show ipv6 ospf6 interface +.. clicmd:: show ipv6 ospf6 interface -{Command} {show ipv6 ospf6 interface} {} - To see OSPF interface configuration like costs. + To see OSPF interface configuration like costs. -.. index:: {Command} {show ipv6 ospf6 neighbor} {} +.. index:: show ipv6 ospf6 neighbor +.. clicmd:: show ipv6 ospf6 neighbor -{Command} {show ipv6 ospf6 neighbor} {} - Shows state and chosen (Backup) DR of neighbor. + Shows state and chosen (Backup) DR of neighbor. -.. index:: {Command} {show ipv6 ospf6 request-list A.B.C.D} {} +.. index:: show ipv6 ospf6 request-list A.B.C.D +.. clicmd:: show ipv6 ospf6 request-list A.B.C.D -{Command} {show ipv6 ospf6 request-list A.B.C.D} {} - Shows requestlist of neighbor. + Shows requestlist of neighbor. -.. index:: {Command} {show ipv6 route ospf6} {} +.. index:: show ipv6 route ospf6 +.. clicmd:: show ipv6 route ospf6 -{Command} {show ipv6 route ospf6} {} - This command shows internal routing table. + This command shows internal routing table. -.. index:: {Command} {show ipv6 ospf6 zebra} {} +.. index:: show ipv6 ospf6 zebra +.. clicmd:: show ipv6 ospf6 zebra -{Command} {show ipv6 ospf6 zebra} {} - Shows state about what is being redistributed between zebra and OSPF6 + Shows state about what is being redistributed between zebra and OSPF6 OSPF6 Configuration Examples ============================ @@ -192,13 +189,11 @@ Example of ospf6d configured on one interface and area: :: - interface eth0 - ipv6 ospf6 instance-id 0 - ! - router ospf6 - router-id 212.17.55.53 - area 0.0.0.0 range 2001:770:105:2::/64 - interface eth0 area 0.0.0.0 - ! - - + interface eth0 + ipv6 ospf6 instance-id 0 + ! + router ospf6 + router-id 212.17.55.53 + area 0.0.0.0 range 2001:770:105:2::/64 + interface eth0 area 0.0.0.0 + ! diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index c91c2ac8ff..ac9a343ad5 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -4,7 +4,6 @@ OSPF Fundamentals ================= .. index:: Link-state routing protocol - .. index:: Distance-vector routing protocol :abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast @@ -15,12 +14,9 @@ describe the state of their links to their immediate neighbouring routers. .. index:: Link State Announcement - .. index:: Link State Advertisement - .. index:: LSA flooding - -.. index:: Link State DataBase +.. index:: Link State Database Each router describes their link-state information in a message known as an :abbr:`LSA (Link State Advertisement)`, which is then propogated @@ -69,128 +65,118 @@ will nearly all be covered in greater detail further on. They may be broadly classed as: - .. index:: OSPF Hello Protocol overview +.. index:: OSPF Hello Protocol + +The Hello Protocol +^^^^^^^^^^^^^^^^^^ + +The OSPF Hello protocol allows OSPF to quickly detect changes in two-way +reachability between routers on a link. OSPF can additionally avail of other +sources of reachability information, such as link-state information provided by +hardware, or through dedicated reachability protocols such as :abbr:`BFD +(Bidirectional Forwarding Detection)`. + +OSPF also uses the Hello protocol to propagate certain state between routers +sharing a link, for example: + +- Hello protocol configured state, such as the dead-interval. +- Router priority, for DR/BDR election. +- DR/BDR election results. +- Any optional capabilities supported by each router. + +The Hello protocol is comparatively trivial and will not be explored in greater +detail than here. + +.. index:: OSPF LSA overview +.. _ospf-lsas: + +LSAs +^^^^ + +At the heart of :abbr:`OSPF` are :abbr:`LSA (Link State Advertisement)` +messages. Despite the name, some :abbr:`LSA` s do not, strictly speaking, +describe link-state information. Common :abbr:`LSA` s describe information +such as: + +- Routers, in terms of their links. +- Networks, in terms of attached routers. +- Routes, external to a link-state domain: + + External Routes + Routes entirely external to :abbr:`OSPF`. Routers originating such + routes are known as :abbr:`ASBR (Autonomous-System Border Router)` + routers. + + Summary Routes + Routes which summarise routing information relating to OSPF areas + external to the OSPF link-state area at hand, originated by + :abbr:`ABR (Area Boundary Router)` routers. + +.. _ospf-lsa-flooding: + +LSA Flooding +"""""""""""" + +OSPF defines several related mechanisms, used to manage synchronisation of +:abbr:`LSDB`s between neighbours as neighbours form adjacencies and the +propogation, or :term:`flooding` of new or updated :abbr:`LSA` s. + +:ref:`OSPF_Flooding`. -*The Hello Protocol* - .. index:: OSPF Hello Protocol +.. index:: OSPF Areas overview +.. _ospf-areas: - The OSPF Hello protocol allows OSPF to quickly detect changes in - two-way reachability between routers on a link. OSPF can additionally - avail of other sources of reachability information, such as link-state - information provided by hardware, or through dedicated reachability - protocols such as :abbr:`BFD (Bi-directional Forwarding Detection)`. +Areas +^^^^^ - OSPF also uses the Hello protocol to propagate certain state between - routers sharing a link, for example: +OSPF provides for the protocol to be broken up into multiple smaller and +independent link-state areas. Each area must be connected to a common backbone +area by an :abbr:`ABR (Area Boundary Router)`. These :abbr:`ABR` routers are +responsible for summarising the link-state routing information of an area into +:term:`Summary LSAs`, possibly in a condensed (i.e. aggregated) form, and then +originating these summaries into all other areas the :abbr:`ABR` is connected +to. - -*Hello protocol configured state, such as the dead-interval.* - -*Router priority, for DR/BDR election.* - -*DR/BDR election results.* - -*Any optional capabilities supported by each router.* - - The Hello protocol is comparatively trivial and will not be explored in - greater detail than here. - - .. index:: OSPF LSA overview - - -*LSAs* - At the heart of :abbr:`OSPF` are :abbr:`LSA (Link State Advertisement)` - messages. Despite the name, some :abbr:`LSA`s do not, strictly speaking, - describe link-state information. Common :abbr:`LSA`s describe information - such as: - - -** - Routers, in terms of their links. - -** - Networks, in terms of attached routers. - -** - Routes, external to a link-state domain: - - -*External Routes* - Routes entirely external to :abbr:`OSPF`. Routers originating such - routes are known as :abbr:`ASBR (Autonomous-System Border Router)` - routers. - - -*Summary Routes* - Routes which summarise routing information relating to OSPF areas - external to the OSPF link-state area at hand, originated by - :abbr:`ABR (Area Boundary Router)` routers. - - -*LSA Flooding* - OSPF defines several related mechanisms, used to manage synchronisation of - :abbr:`LSDB`s between neighbours as neighbours form adjacencies and - the propogation, or :term:`flooding` of new or updated :abbr:`LSA`s. - - :ref:`OSPF_Flooding`. - - .. index:: OSPF Areas overview - - -*Areas* - OSPF provides for the protocol to be broken up into multiple smaller - and independent link-state areas. Each area must be connected to a - common backbone area by an :abbr:`ABR (Area Boundary Router)`. These - :abbr:`ABR` routers are responsible for summarising the link-state - routing information of an area into :term:`Summary LSAs`, possibly in a - condensed (i.e. aggregated) form, and then originating these summaries - into all other areas the :abbr:`ABR` is connected to. - - Note that only summaries and external routes are passed between areas. - As these describe *paths*, rather than any router link-states, - routing between areas hence is by :term:`distance-vector`, **not** - link-state. - - :ref:`OSPF_Areas`. +Note that only summaries and external routes are passed between areas. As +these describe *paths*, rather than any router link-states, routing between +areas hence is by :term:`distance-vector`, **not** link-state. OSPF LSAs --------- -:abbr:`LSA`s are the core object in OSPF. Everything else in OSPF -revolves around detecting what to describe in LSAs, when to update -them, how to flood them throughout a network and how to calculate -routes from them. +The core objects in OSPF are :abbr:`LSA` s. Everything else in OSPF revolves +around detecting what to describe in LSAs, when to update them, how to flood +them throughout a network and how to calculate routes from them. -There are a variety of different :abbr:`LSA`s, for purposes such -as describing actual link-state information, describing paths (i.e. -routes), describing bandwidth usage of links for -:abbr:`TE (Traffic Engineering)` purposes, and even arbitrary data -by way of *Opaque* :abbr:`LSA`s. +There are a variety of different :abbr:`LSA` s, for purposes such as describing +actual link-state information, describing paths (i.e. routes), describing +bandwidth usage of links for :abbr:`TE (Traffic Engineering)` purposes, and +even arbitrary data by way of *Opaque* :abbr:`LSA` s. LSA Header ^^^^^^^^^^ All LSAs share a common header with the following information: -* Type +- Type - Different types of :abbr:`LSA`s describe different things in + Different types of :abbr:`LSA` s describe different things in :abbr:`OSPF`. Types include: - * Router LSA - * Network LSA - * Network Summary LSA - * Router Summary LSA - * AS-External LSA + - Router LSA + - Network LSA + - Network Summary LSA + - Router Summary LSA + - AS-External LSA The specifics of the different types of LSA are examined below. -* Advertising Router +- Advertising Router The Router ID of the router originating the LSA, see :ref:`ospf_router-id`. -* LSA ID +- LSA ID The ID of the LSA, which is typically derived in some way from the information the LSA describes, e.g. a Router LSA uses the Router ID as @@ -202,9 +188,9 @@ All LSAs share a common header with the following information: an LSA with the same Type, LSA ID and Advertising Router ID, see :ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`. -* Age +- Age - A number to allow stale :abbr:`LSA`s to, eventually, be purged by routers + A number to allow stale :abbr:`LSA` s to, eventually, be purged by routers from their :abbr:`LSDB`s. The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is @@ -222,96 +208,93 @@ All LSAs share a common header with the following information: .. _OSPF_LSA_sequence_number: -* Sequence Number +- Sequence Number A number used to distinguish newer instances of an LSA from older instances. Link-State LSAs ^^^^^^^^^^^^^^^ -Of all the various kinds of :abbr:`LSA`s, just two types comprise the -actual link-state part of :abbr:`OSPF`, Router :abbr:`LSA`s and -Network :abbr:`LSA`s. These LSA types are absolutely core to the +Of all the various kinds of :abbr:`LSA` s, just two types comprise the +actual link-state part of :abbr:`OSPF`, Router :abbr:`LSA` s and +Network :abbr:`LSA` s. These LSA types are absolutely core to the protocol. Instances of these LSAs are specific to the link-state area in which they are originated. Routes calculated from these two LSA types are called :term:`intra-area routes`. -* Router LSA +- Router LSA Each OSPF Router must originate a router :abbr:`LSA` to describe itself. In it, the router lists each of its :abbr:`OSPF` enabled interfaces, for the given link-state area, in terms of: - * Cost + Cost + The output cost of that interface, scaled inversely to some commonly known + reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`. - The output cost of that interface, scaled inversely to some commonly known - reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`. + Link Type + Transit Network - * Link Type + A link to a multi-access network, on which the router has at least one + Full adjacency with another router. - * Transit Network + :abbr:`PtP (Point-to-Point)` + A link to a single remote router, with a Full adjacency. No + :abbr:`DR (Designated Router)` is elected on such links; no network + LSA is originated for such a link. - A link to a multi-access network, on which the router has at least one - Full adjacency with another router. + Stub + A link with no adjacent neighbours, or a host route. - * :abbr:`PtP (Point-to-Point)` - - A link to a single remote router, with a Full adjacency. No - :abbr:`DR (Designated Router)` is elected on such links; no network - LSA is originated for such a link. - - * Stub - - A link with no adjacent neighbours, or a host route. - - * Link ID and Data + - Link ID and Data These values depend on the Link Type: - +----------------+-----------------------------------+------------------------------------------+ - | Link Type | Link ID | Link Data | - +================+===================================+==========================================+ - | Transit | Link IP address of the :abbr:`DR` | Interface IP address | - +----------------+-----------------------------------+------------------------------------------+ - | Point-to-Point | Router ID of the remote router | Local interface IP address, or the | - | | | :abbr:`ifindex (MIB-II interface index)` | - | | | for unnumbered links | - +----------------+-----------------------------------+------------------------------------------+ - | Stub | IP address | Subnet Mask | - +----------------+-----------------------------------+------------------------------------------+ + +----------------+-----------------------------------+------------------------------------------+ + | Link Type | Link ID | Link Data | + +================+===================================+==========================================+ + | Transit | Link IP address of the :abbr:`DR` | Interface IP address | + +----------------+-----------------------------------+------------------------------------------+ + | Point-to-Point | Router ID of the remote router | Local interface IP address, or the | + | | | :abbr:`ifindex (MIB-II interface index)` | + | | | for unnumbered links | + +----------------+-----------------------------------+------------------------------------------+ + | Stub | IP address | Subnet Mask | + +----------------+-----------------------------------+------------------------------------------+ - Links on a router may be listed multiple times in the Router LSA, e.g. - a :abbr:`PtP` interface on which OSPF is enabled must *always* - be described by a Stub link in the Router :abbr:`LSA`, in addition to - being listed as PtP link in the Router :abbr:`LSA` if the adjacency - with the remote router is Full. + Links on a router may be listed multiple times in the Router LSA, e.g. a + :abbr:`PtP` interface on which OSPF is enabled must *always* be described + by a Stub link in the Router :abbr:`LSA`, in addition to being listed as + PtP link in the Router :abbr:`LSA` if the adjacency with the remote router + is Full. - Stub links may also be used as a way to describe links on which OSPF is - *not* spoken, known as :term:`passive interfaces`, see :ref:`OSPF_passive-interface,,passive-interface`. + Stub links may also be used as a way to describe links on which OSPF is + *not* spoken, known as :term:`passive interfaces`, see + :ref:`OSPF_passive-interface,,passive-interface`. -* Network LSA +- Network LSA On multi-access links (e.g. ethernets, certain kinds of ATM and X.25 configurations), routers elect a :abbr:`DR`. The :abbr:`DR` is responsible for originating a Network :abbr:`LSA`, which helps reduce the information needed to describe multi-access networks with multiple routers attached. The :abbr:`DR` also acts as a hub for the flooding of - :abbr:`LSA`s on that link, thus reducing flooding overheads. + :abbr:`LSA` s on that link, thus reducing flooding overheads. The contents of the Network LSA describes the: - * Subnet Mask + - Subnet Mask As the :abbr:`LSA` ID of a Network LSA must be the IP address of the :abbr:`DR`, the Subnet Mask together with the :abbr:`LSA` ID gives you the network address. - * Attached Routers + - Attached Routers Each router fully-adjacent with the :abbr:`DR` is listed in the LSA, - by their Router-ID. This allows the corresponding Router :abbr:`LSA`s to be + by their Router-ID. This allows the corresponding Router :abbr:`LSA` s to be easily retrieved from the :abbr:`LSDB`. Summary of Link State LSAs: @@ -333,13 +316,14 @@ surprisingly, when OSPF routers build updated routing tables, the first stage of :abbr:`SPF` calculation concerns itself only with these two LSA types. +.. _ospf-link-state-lsa-examples: + Link-State LSA Examples ^^^^^^^^^^^^^^^^^^^^^^^ -The example below (:ref:`OSPF_Link-State_LSA_Example`) shows two -:abbr:`LSA`s, both originated by the same router (Router ID -192.168.0.49) and with the same :abbr:`LSA` ID (192.168.0.49), but of -different LSA types. +The example below shows two :abbr:`LSA` s, both originated by the same router +(Router ID 192.168.0.49) and with the same :abbr:`LSA` ID (192.168.0.49), but +of different LSA types. The first LSA being the router LSA describing 192.168.0.49's links: 2 links to multi-access networks with fully-adjacent neighbours (i.e. Transit @@ -349,8 +333,6 @@ The second LSA being a Network LSA, for which 192.168.0.49 is the :abbr:`DR`, listing the Router IDs of 4 routers on that network which are fully adjacent with 192.168.0.49. -.. _OSPF_Link-State_LSA_Example: - :: # show ip ospf database router 192.168.0.49 @@ -424,7 +406,7 @@ as their LSA ID, so you can then look up that Network LSA and from that find all the attached routers on that link, leading potentially to more links and Network and Router LSAs, etc. etc. -From just the above two :abbr:`LSA`s, one can already see the +From just the above two :abbr:`LSA` s, one can already see the following partial topology: :: @@ -458,66 +440,57 @@ reachable addresses (though, OSPF will calculate routes to Router IDs). External LSAs ^^^^^^^^^^^^^ -External, or "Type 5", :abbr:`LSA`s describe routing information which is +External, or "Type 5", :abbr:`LSA` s describe routing information which is entirely external to :abbr:`OSPF`, and is "injected" into :abbr:`OSPF`. Such routing information may have come from another routing protocol, such as RIP or BGP, they may represent static routes or they may represent a default route. -An :abbr:`OSPF` router which originates External :abbr:`LSA`s is known as an -:abbr:`ASBR (AS Boundary Router)`. Unlike the link-state :abbr:`LSA`s, and -most other :abbr:`LSA`s, which are flooded only within the area in -which they originate, External :abbr:`LSA`s are flooded through-out +An :abbr:`OSPF` router which originates External :abbr:`LSA` s is known as an +:abbr:`ASBR (AS Boundary Router)`. Unlike the link-state :abbr:`LSA` s, and +most other :abbr:`LSA` s, which are flooded only within the area in +which they originate, External :abbr:`LSA` s are flooded through-out the :abbr:`OSPF` network to all areas capable of carrying External -:abbr:`LSA`s (:ref:`OSPF_Areas`). +:abbr:`LSA` s (:ref:`OSPF_Areas`). Routes internal to OSPF (intra-area or inter-area) are always preferred over external routes. The External :abbr:`LSA` describes the following: -* IP Network number +IP Network number + The IP Network number of the route is described by the :abbr:`LSA` ID field. - The IP Network number of the route is described by the :abbr:`LSA` ID - field. +IP Network Mask + The body of the External LSA describes the IP Network Mask of the route. + This, together with the :abbr:`LSA` ID, describes the prefix of the IP route + concerned. -* IP Network Mask +Metric + The cost of the External Route. This cost may be an OSPF cost (also known as + a "Type 1" metric), i.e. equivalent to the normal OSPF costs, or an + externally derived cost ("Type 2" metric) which is not comparable to OSPF + costs and always considered larger than any OSPF cost. Where there are both + Type 1 and 2 External routes for a route, the Type 1 is always preferred. - The body of the External LSA describes the IP Network Mask of the - route. This, together with the :abbr:`LSA` ID, describes the prefix - of the IP route concerned. +Forwarding Address + The address of the router to forward packets to for the route. This may be, + and usually is, left as 0 to specify that the ASBR originating the External + :abbr:`LSA` should be used. There must be an internal OSPF route to the + forwarding address, for the forwarding address to be useable. -* Metric - - The cost of the External Route. This cost may be an OSPF cost (also - known as a "Type 1" metric), i.e. equivalent to the normal OSPF costs, - or an externally derived cost ("Type 2" metric) which is not comparable - to OSPF costs and always considered larger than any OSPF cost. Where - there are both Type 1 and 2 External routes for a route, the Type 1 is - always preferred. - -* Forwarding Address - - The address of the router to forward packets to for the route. This may - be, and usually is, left as 0 to specify that the ASBR originating the - External :abbr:`LSA` should be used. There must be an internal OSPF - route to the forwarding address, for the forwarding address to be - useable. - -* Tag - - An arbitrary 4-bytes of data, not interpreted by OSPF, which may - carry whatever information about the route which OSPF speakers desire. +Tag + An arbitrary 4-bytes of data, not interpreted by OSPF, which may carry + whatever information about the route which OSPF speakers desire. AS External LSA Example ^^^^^^^^^^^^^^^^^^^^^^^ To illustrate, below is an example of an External :abbr:`LSA` in the -:abbr:`LSDB` of an OSPF router. It describes a route to the IP prefix -of 192.168.165.0/24, originated by the ASBR with Router-ID -192.168.0.49. The metric of 20 is external to OSPF. The forwarding -address is 0, so the route should forward to the originating ASBR if -selected. +:abbr:`LSDB` of an OSPF router. It describes a route to the IP prefix of +192.168.165.0/24, originated by the ASBR with Router-ID 192.168.0.49. The +metric of 20 is external to OSPF. The forwarding address is 0, so the route +should forward to the originating ASBR if selected. :: @@ -540,44 +513,33 @@ selected. We can add this to our partial topology from above, which now looks -like: -:: +like::: - --------------------- Network: ...... - | Designated Router IP: 192.168.1.3 - | - IP: 192.168.1.3 /---- External route: 192.168.165.0/24 - (transit link) / Cost: 20 (External metric) - (cost: 10) / - Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32 - (cost: 10) (cost: 39063) - (transit link) - IP: 192.168.0.49 - | - | - ------------------------------ Network: 192.168.0.48/29 - | | | Designated Router IP: 192.168.0.49 - | | | - | | Router ID: 192.168.0.54 - | | - | Router ID: 192.168.0.53 - | - Router ID: 192.168.0.52 + --------------------- Network: ...... + | Designated Router IP: 192.168.1.3 + | + IP: 192.168.1.3 /---- External route: 192.168.165.0/24 + (transit link) / Cost: 20 (External metric) + (cost: 10) / + Router ID: 192.168.0.49(stub)---------- IP: 192.168.3.190/32 + (cost: 10) (cost: 39063) + (transit link) + IP: 192.168.0.49 + | + | + ------------------------------ Network: 192.168.0.48/29 + | | | Designated Router IP: 192.168.0.49 + | | | + | | Router ID: 192.168.0.54 + | | + | Router ID: 192.168.0.53 + | + Router ID: 192.168.0.52 Summary LSAs ^^^^^^^^^^^^ -Summary LSAs are created by :abbr:`ABR`s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or :abbr:`ASBR` routers. - -.. _OSPF_Flooding: - -OSPF Flooding -------------- - -.. _OSPF_Areas: - -OSPF Areas ----------- - - +Summary LSAs are created by :abbr:`ABR`s to summarise the destinations +available within one area to other areas. These LSAs may describe IP networks, +potentially in aggregated form, or :abbr:`ASBR` routers. diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index b87f75e138..d72d8a8665 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -4,283 +4,279 @@ OSPFv2 ****** -:abbr:`OSPF (Open Shortest Path First)` version 2 is a routing protocol -which is described in :rfc:`2328`. OSPF is an -:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`, -:abbr:`OSPF` can provide scalable network support and faster -convergence times. OSPF is widely used in large networks such as -:abbr:`ISP (Internet Service Provider)` backbone and enterprise -networks. +:abbr:`OSPF (Open Shortest Path First)` version 2 is a routing protocol which +is described in :rfc:`2328`. OSPF is an :abbr:`IGP (Interior Gateway +Protocol)`. Compared with :abbr:`RIP`, :abbr:`OSPF` can provide scalable +network support and faster convergence times. OSPF is widely used in large +networks such as :abbr:`ISP (Internet Service Provider)` backbone and +enterprise networks. -@include ospf_fundamentals.texi +.. include:: ospf_fundamentals.rst -.. _Configuring_ospfd: +.. _configuring-ospfd: Configuring ospfd ================= -There are no *ospfd* specific options. Common options can be -specified (:ref:`Common_Invocation_Options`) to *ospfd*. -*ospfd* needs to acquire interface information from -*zebra* in order to function. Therefore *zebra* must be -running before invoking *ospfd*. Also, if *zebra* is -restarted then *ospfd* must be too. +There are no *ospfd* specific options. Common options can be specified +(:ref:`Common_Invocation_Options`) to *ospfd*. *ospfd* needs to acquire +interface information from *zebra* in order to function. Therefore *zebra* must +be running before invoking *ospfd*. Also, if *zebra* is restarted then *ospfd* +must be too. -Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` -specific configuration file :file:`ospfd.conf`. +Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` specific +configuration file :file:`ospfd.conf`. .. _OSPF_router: OSPF router =========== -To start OSPF process you have to specify the OSPF router. As of this +To start OSPF process you have to specify the OSPF router. As of this writing, *ospfd* does not support multiple OSPF processes. -.. index:: Command {router ospf} {} +.. index:: router ospf +.. clicmd:: router ospf -Command {router ospf} {} -.. index:: Command {no router ospf} {} +.. index:: no router ospf +.. clicmd:: no router ospf -Command {no router ospf} {} - Enable or disable the OSPF process. *ospfd* does not yet - support multiple OSPF processes. So you can not specify an OSPF process - number. + Enable or disable the OSPF process. *ospfd* does not yet + support multiple OSPF processes. So you can not specify an OSPF process + number. -.. index:: {OSPF Command} {ospf router-id `a.b.c.d`} {} +.. index:: ospf router-id A.B.C.D +.. clicmd:: ospf router-id A.B.C.D -{OSPF Command} {ospf router-id `a.b.c.d`} {} -.. index:: {OSPF Command} {no ospf router-id} {} +.. index:: no ospf router-id +.. clicmd:: no ospf router-id -{OSPF Command} {no ospf router-id} {} - .. _ospf_router-id: +.. _ospf_router-id: - This sets the router-ID of the OSPF process. The - router-ID may be an IP address of the router, but need not be - it can - be any arbitrary 32bit number. However it MUST be unique within the - entire OSPF domain to the OSPF speaker - bad things will happen if - multiple OSPF speakers are configured with the same router-ID! If one - is not specified then *ospfd* will obtain a router-ID - automatically from *zebra*. + This sets the router-ID of the OSPF process. The + router-ID may be an IP address of the router, but need not be - it can + be any arbitrary 32bit number. However it MUST be unique within the + entire OSPF domain to the OSPF speaker - bad things will happen if + multiple OSPF speakers are configured with the same router-ID! If one + is not specified then *ospfd* will obtain a router-ID + automatically from *zebra*. -.. index:: {OSPF Command} {ospf abr-type `type`} {} +.. index:: ospf abr-type TYPE +.. clicmd:: ospf abr-type TYPE -{OSPF Command} {ospf abr-type `type`} {} -.. index:: {OSPF Command} {no ospf abr-type `type`} {} +.. index:: no ospf abr-type TYPE +.. clicmd:: no ospf abr-type TYPE -{OSPF Command} {no ospf abr-type `type`} {} - `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types - are equivalent. + `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types + are equivalent. - The OSPF standard for ABR behaviour does not allow an ABR to consider - routes through non-backbone areas when its links to the backbone are - down, even when there are other ABRs in attached non-backbone areas - which still can reach the backbone - this restriction exists primarily - to ensure routing-loops are avoided. + The OSPF standard for ABR behaviour does not allow an ABR to consider + routes through non-backbone areas when its links to the backbone are + down, even when there are other ABRs in attached non-backbone areas + which still can reach the backbone - this restriction exists primarily + to ensure routing-loops are avoided. - With the "Cisco" or "IBM" ABR type, the default in this release of - FRR, this restriction is lifted, allowing an ABR to consider - summaries learnt from other ABRs through non-backbone areas, and hence - route via non-backbone areas as a last resort when, and only when, - backbone links are down. + With the "Cisco" or "IBM" ABR type, the default in this release of + FRR, this restriction is lifted, allowing an ABR to consider + summaries learnt from other ABRs through non-backbone areas, and hence + route via non-backbone areas as a last resort when, and only when, + backbone links are down. - Note that areas with fully-adjacent virtual-links are considered to be - "transit capable" and can always be used to route backbone traffic, and - hence are unaffected by this setting (:ref:`OSPF_virtual-link`). + Note that areas with fully-adjacent virtual-links are considered to be + "transit capable" and can always be used to route backbone traffic, and + hence are unaffected by this setting (:ref:`OSPF_virtual-link`). - More information regarding the behaviour controlled by this command can - be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. + More information regarding the behaviour controlled by this command can + be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. - Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` - in the OSPF specification does not require a router with multiple - attached areas to have a backbone connection, it is actually - necessary to provide successful routing to the inter-area and - external destinations. If this requirement is not met, all traffic - destined for the areas not connected to such an ABR or out of the - OSPF domain, is dropped. This document describes alternative ABR - behaviors implemented in Cisco and IBM routers." + Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` + in the OSPF specification does not require a router with multiple + attached areas to have a backbone connection, it is actually + necessary to provide successful routing to the inter-area and + external destinations. If this requirement is not met, all traffic + destined for the areas not connected to such an ABR or out of the + OSPF domain, is dropped. This document describes alternative ABR + behaviors implemented in Cisco and IBM routers." -.. index:: {OSPF Command} {ospf rfc1583compatibility} {} +.. index:: ospf rfc1583compatibility +.. clicmd:: ospf rfc1583compatibility -{OSPF Command} {ospf rfc1583compatibility} {} -.. index:: {OSPF Command} {no ospf rfc1583compatibility} {} +.. index:: no ospf rfc1583compatibility +.. clicmd:: no ospf rfc1583compatibility -{OSPF Command} {no ospf rfc1583compatibility} {} - :rfc:`2328`, the sucessor to :rfc:`1583`, suggests according - to section G.2 (changes) in section 16.4 a change to the path - preference algorithm that prevents possible routing loops that were - possible in the old version of OSPFv2. More specifically it demands - that inter-area paths and intra-area backbone path are now of equal preference - but still both preferred to external paths. + :rfc:`2328`, the sucessor to :rfc:`1583`, suggests according + to section G.2 (changes) in section 16.4 a change to the path + preference algorithm that prevents possible routing loops that were + possible in the old version of OSPFv2. More specifically it demands + that inter-area paths and intra-area backbone path are now of equal preference + but still both preferred to external paths. - This command should NOT be set normally. + This command should NOT be set normally. -.. index:: {OSPF Command} {log-adjacency-changes [detail]} {} +.. index:: log-adjacency-changes [detail] +.. clicmd:: log-adjacency-changes [detail] -{OSPF Command} {log-adjacency-changes [detail]} {} -.. index:: {OSPF Command} {no log-adjacency-changes [detail]} {} +.. index:: no log-adjacency-changes [detail] +.. clicmd:: no log-adjacency-changes [detail] -{OSPF Command} {no log-adjacency-changes [detail]} {} - Configures ospfd to log changes in adjacency. With the optional - detail argument, all changes in adjacency status are shown. Without detail, - only changes to full or regressions are shown. + Configures ospfd to log changes in adjacency. With the optional + detail argument, all changes in adjacency status are shown. Without detail, + only changes to full or regressions are shown. -.. index:: {OSPF Command} {passive-interface `interface`} {} +.. index:: passive-interface INTERFACE +.. clicmd:: passive-interface INTERFACE -{OSPF Command} {passive-interface `interface`} {} -.. index:: {OSPF Command} {no passive-interface `interface`} {} +.. index:: no passive-interface INTERFACE +.. clicmd:: no passive-interface INTERFACE -{OSPF Command} {no passive-interface `interface`} {} - .. _OSPF_passive-interface: +.. _ospf_passive-interface: - Do not speak OSPF interface on the - given interface, but do advertise the interface as a stub link in the - router-:abbr:`LSA (Link State Advertisement)` for this router. This - allows one to advertise addresses on such connected interfaces without - having to originate AS-External/Type-5 LSAs (which have global flooding - scope) - as would occur if connected addresses were redistributed into - OSPF (:ref:`Redistribute_routes_to_OSPF`)@. This is the only way to - advertise non-OSPF links into stub areas. + Do not speak OSPF interface on the + given interface, but do advertise the interface as a stub link in the + router-:abbr:`LSA (Link State Advertisement)` for this router. This + allows one to advertise addresses on such connected interfaces without + having to originate AS-External/Type-5 LSAs (which have global flooding + scope) - as would occur if connected addresses were redistributed into + OSPF (:ref:`Redistribute_routes_to_OSPF`). This is the only way to + advertise non-OSPF links into stub areas. -.. index:: {OSPF Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} +.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME +.. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME -{OSPF Command} {timers throttle spf `delay` `initial-holdtime` `max-holdtime`} {} -.. index:: {OSPF Command} {no timers throttle spf} {} +.. index:: no timers throttle spf +.. clicmd:: no timers throttle spf -{OSPF Command} {no timers throttle spf} {} - This command sets the initial `delay`, the `initial-holdtime` - and the `maximum-holdtime` between when SPF is calculated and the - event which triggered the calculation. The times are specified in - milliseconds and must be in the range of 0 to 600000 milliseconds. + This command sets the initial `delay`, the `initial-holdtime` + and the `maximum-holdtime` between when SPF is calculated and the + event which triggered the calculation. The times are specified in + milliseconds and must be in the range of 0 to 600000 milliseconds. - The `delay` specifies the minimum amount of time to delay SPF - calculation (hence it affects how long SPF calculation is delayed after - an event which occurs outside of the holdtime of any previous SPF - calculation, and also serves as a minimum holdtime). + The `delay` specifies the minimum amount of time to delay SPF + calculation (hence it affects how long SPF calculation is delayed after + an event which occurs outside of the holdtime of any previous SPF + calculation, and also serves as a minimum holdtime). - Consecutive SPF calculations will always be seperated by at least - 'hold-time' milliseconds. The hold-time is adaptive and initially is - set to the `initial-holdtime` configured with the above command. - Events which occur within the holdtime of the previous SPF calculation - will cause the holdtime to be increased by `initial-holdtime`, bounded - by the `maximum-holdtime` configured with this command. If the adaptive - hold-time elapses without any SPF-triggering event occuring then - the current holdtime is reset to the `initial-holdtime`. The current - holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as - a multiplier of the `initial-holdtime`. + Consecutive SPF calculations will always be seperated by at least + 'hold-time' milliseconds. The hold-time is adaptive and initially is + set to the `initial-holdtime` configured with the above command. + Events which occur within the holdtime of the previous SPF calculation + will cause the holdtime to be increased by `initial-holdtime`, bounded + by the `maximum-holdtime` configured with this command. If the adaptive + hold-time elapses without any SPF-triggering event occuring then + the current holdtime is reset to the `initial-holdtime`. The current + holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as + a multiplier of the `initial-holdtime`. + + :: + + router ospf + timers throttle spf 200 400 10000 + + + In this example, the `delay` is set to 200ms, the initial holdtime is set to + 400ms and the `maximum holdtime` to 10s. Hence there will always be at least + 200ms between an event which requires SPF calculation and the actual SPF + calculation. Further consecutive SPF calculations will always be seperated + by between 400ms to 10s, the hold-time increasing by 400ms each time an + SPF-triggering event occurs within the hold-time of the previous SPF + calculation. + + This command supercedes the *timers spf* command in previous FRR + releases. + +.. index:: max-metric router-lsa [on-startup|on-shutdown] (5-86400) +.. clicmd:: max-metric router-lsa [on-startup|on-shutdown] (5-86400) + +.. index:: max-metric router-lsa administrative +.. clicmd:: max-metric router-lsa administrative + +.. index:: no max-metric router-lsa [on-startup|on-shutdown|administrative] +.. clicmd:: no max-metric router-lsa [on-startup|on-shutdown|administrative] + + This enables :rfc:`3137` support, where the OSPF process describes its + transit links in its router-LSA as having infinite distance so that other + routers will avoid calculating transit paths through the router while still + being able to reach networks through the router. + + This support may be enabled administratively (and indefinitely) or + conditionally. Conditional enabling of max-metric router-lsas can be for a + period of seconds after startup and/or for a period of seconds prior to + shutdown. + + Enabling this for a period after startup allows OSPF to converge fully first + without affecting any existing routes used by other routers, while still + allowing any connected stub links and/or redistributed routes to be + reachable. Enabling this for a period of time in advance of shutdown allows + the router to gracefully excuse itself from the OSPF domain. + + Enabling this feature administratively allows for administrative + intervention for whatever reason, for an indefinite period of time. Note + that if the configuration is written to file, this administrative form of + the stub-router command will also be written to file. If *ospfd* is + restarted later, the command will then take effect until manually + deconfigured. + + Configured state of this feature as well as current status, such as the + number of second remaining till on-startup or on-shutdown ends, can be + viewed with the :ref:`show_ip_ospf` command. + +.. index:: auto-cost reference-bandwidth (1-4294967) +.. clicmd:: auto-cost reference-bandwidth (1-4294967) + +.. index:: no auto-cost reference-bandwidth +.. clicmd:: no auto-cost reference-bandwidth + +.. _OSPF_auto-cost_reference-bandwidth: + + This sets the reference + bandwidth for cost calculations, where this bandwidth is considered + equivalent to an OSPF cost of 1, specified in Mbits/s. The default is + 100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a + cost of 1. Cost of lower bandwidth links will be scaled with reference + to this cost). + + This configuration setting MUST be consistent across all routers within the + OSPF domain. + +.. index:: network A.B.C.D/M area A.B.C.D +.. clicmd:: network A.B.C.D/M area A.B.C.D + +.. index:: network A.B.C.D/M area (0-4294967295) +.. clicmd:: network A.B.C.D/M area (0-4294967295) + +.. index:: no network A.B.C.D/M area A.B.C.D +.. clicmd:: no network A.B.C.D/M area A.B.C.D + +.. index:: no network A.B.C.D/M area (0-4294967295) +.. clicmd:: no network A.B.C.D/M area (0-4294967295) + +.. _OSPF_network_command: + + This command specifies the OSPF enabled interface(s). If the interface has + an address from range 192.168.1.0/24 then the command below enables ospf + on this interface so router can provide network information to the other + ospf routers via this interface. :: - router ospf - timers throttle spf 200 400 10000 + router ospf + network 192.168.1.0/24 area 0.0.0.0 - In this example, the `delay` is set to 200ms, the @var{initial - holdtime} is set to 400ms and the `maximum holdtime` to 10s. Hence - there will always be at least 200ms between an event which requires SPF - calculation and the actual SPF calculation. Further consecutive SPF - calculations will always be seperated by between 400ms to 10s, the - hold-time increasing by 400ms each time an SPF-triggering event occurs - within the hold-time of the previous SPF calculation. + Prefix length in interface must be equal or bigger (ie. smaller network) than + prefix length in network statement. For example statement above doesn't enable + ospf on interface with address 192.168.1.1/23, but it does on interface with + address 192.168.1.129/25. - This command supercedes the *timers spf* command in previous FRR - releases. + Note that the behavior when there is a peer address + defined on an interface changed after release 0.99.7. + Currently, if a peer prefix has been configured, + then we test whether the prefix in the network command contains + the destination prefix. Otherwise, we test whether the network command prefix + contains the local address prefix of the interface. -.. index:: {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] (5-86400)} {} - -{OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] (5-86400)} {} -.. index:: {OSPF Command} {max-metric router-lsa administrative} {} - -{OSPF Command} {max-metric router-lsa administrative} {} -.. index:: {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} - -{OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} - This enables :rfc:`3137` support, - where the OSPF process describes its transit links in its router-LSA as - having infinite distance so that other routers will avoid calculating - transit paths through the router while still being able to reach - networks through the router. - - This support may be enabled administratively (and indefinitely) or - conditionally. Conditional enabling of max-metric router-lsas can be - for a period of seconds after startup and/or for a period of seconds - prior to shutdown. - - Enabling this for a period after startup allows OSPF to converge fully - first without affecting any existing routes used by other routers, - while still allowing any connected stub links and/or redistributed - routes to be reachable. Enabling this for a period of time in advance - of shutdown allows the router to gracefully excuse itself from the OSPF - domain. - - Enabling this feature administratively allows for administrative - intervention for whatever reason, for an indefinite period of time. - Note that if the configuration is written to file, this administrative - form of the stub-router command will also be written to file. If - *ospfd* is restarted later, the command will then take effect - until manually deconfigured. - - Configured state of this feature as well as current status, such as the - number of second remaining till on-startup or on-shutdown ends, can be - viewed with the :ref:`show_ip_ospf` command. - -.. index:: {OSPF Command} {auto-cost reference-bandwidth (1-4294967)} {} - -{OSPF Command} {auto-cost reference-bandwidth (1-4294967)} {} -.. index:: {OSPF Command} {no auto-cost reference-bandwidth} {} - -{OSPF Command} {no auto-cost reference-bandwidth} {} - .. _OSPF_auto-cost_reference-bandwidth: - - This sets the reference - bandwidth for cost calculations, where this bandwidth is considered - equivalent to an OSPF cost of 1, specified in Mbits/s. The default is - 100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a - cost of 1. Cost of lower bandwidth links will be scaled with reference - to this cost). - - This configuration setting MUST be consistent across all routers within the - OSPF domain. - -.. index:: {OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {} - -{OSPF Command} {network `a.b.c.d/m` area `a.b.c.d`} {} -.. index:: {OSPF Command} {network `a.b.c.d/m` area `(0-4294967295)`} {} - -{OSPF Command} {network `a.b.c.d/m` area `(0-4294967295)`} {} -.. index:: {OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {} - -{OSPF Command} {no network `a.b.c.d/m` area `a.b.c.d`} {} -.. index:: {OSPF Command} {no network `a.b.c.d/m` area `(0-4294967295)`} {} - -{OSPF Command} {no network `a.b.c.d/m` area `(0-4294967295)`} {} - .. _OSPF_network_command: - - This command specifies the OSPF enabled interface(s). If the interface has - an address from range 192.168.1.0/24 then the command below enables ospf - on this interface so router can provide network information to the other - ospf routers via this interface. - -:: - - router ospf - network 192.168.1.0/24 area 0.0.0.0 - - - Prefix length in interface must be equal or bigger (ie. smaller network) than - prefix length in network statement. For example statement above doesn't enable - ospf on interface with address 192.168.1.1/23, but it does on interface with - address 192.168.1.129/25. - - Note that the behavior when there is a peer address - defined on an interface changed after release 0.99.7. - Currently, if a peer prefix has been configured, - then we test whether the prefix in the network command contains - the destination prefix. Otherwise, we test whether the network command prefix - contains the local address prefix of the interface. - - In some cases it may be more convenient to enable OSPF on a per - interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`). + In some cases it may be more convenient to enable OSPF on a per + interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`). .. _OSPF_area: @@ -288,828 +284,831 @@ Command {no router ospf} {} OSPF area ========= -.. index:: {OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {} +.. index:: area A.B.C.D range A.B.C.D/M +.. clicmd:: area A.B.C.D range A.B.C.D/M -{OSPF Command} {area `a.b.c.d` range `a.b.c.d/m`} {} -.. index:: {OSPF Command} {area (0-4294967295) range `a.b.c.d/m`} {} +.. index:: area (0-4294967295) range A.B.C.D/M +.. clicmd:: area (0-4294967295) range A.B.C.D/M -{OSPF Command} {area (0-4294967295) range `a.b.c.d/m`} {} -.. index:: {OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {} +.. index:: no area A.B.C.D range A.B.C.D/M +.. clicmd:: no area A.B.C.D range A.B.C.D/M -{OSPF Command} {no area `a.b.c.d` range `a.b.c.d/m`} {} -.. index:: {OSPF Command} {no area (0-4294967295) range `a.b.c.d/m`} {} +.. index:: no area (0-4294967295) range A.B.C.D/M +.. clicmd:: no area (0-4294967295) range A.B.C.D/M -{OSPF Command} {no area (0-4294967295) range `a.b.c.d/m`} {} - Summarize intra area paths from specified area into one Type-3 summary-LSA - announced to other areas. This command can be used only in ABR and ONLY - router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can - be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. - Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR. + Summarize intra area paths from specified area into one Type-3 summary-LSA + announced to other areas. This command can be used only in ABR and ONLY + router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can + be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. + Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR. :: - router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 range 10.0.0.0/8 + router ospf + network 192.168.1.0/24 area 0.0.0.0 + network 10.0.0.0/8 area 0.0.0.10 + area 0.0.0.10 range 10.0.0.0/8 - With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is - announced into backbone area if area 0.0.0.10 contains at least one intra-area - network (ie. described with router or network LSA) from this range. + With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is + announced into backbone area if area 0.0.0.10 contains at least one intra-area + network (ie. described with router or network LSA) from this range. -.. index:: {OSPF Command} {area `a.b.c.d` range IPV4_PREFIX not-advertise} {} +.. index:: area A.B.C.D range IPV4_PREFIX not-advertise +.. clicmd:: area A.B.C.D range IPV4_PREFIX not-advertise -{OSPF Command} {area `a.b.c.d` range IPV4_PREFIX not-advertise} {} -.. index:: {OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX not-advertise} {} +.. index:: no area A.B.C.D range IPV4_PREFIX not-advertise +.. clicmd:: no area A.B.C.D range IPV4_PREFIX not-advertise -{OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX not-advertise} {} - Instead of summarizing intra area paths filter them - ie. intra area paths from this - range are not advertised into other areas. - This command makes sense in ABR only. + Instead of summarizing intra area paths filter them - ie. intra area paths from this + range are not advertised into other areas. + This command makes sense in ABR only. -.. index:: {OSPF Command} {area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} +.. index:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX +.. clicmd:: area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX -{OSPF Command} {area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} -.. index:: {OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} +.. index:: no area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX +.. clicmd:: no area A.B.C.D range IPV4_PREFIX substitute IPV4_PREFIX -{OSPF Command} {no area `a.b.c.d` range IPV4_PREFIX substitute IPV4_PREFIX} {} - Substitute summarized prefix with another prefix. + Substitute summarized prefix with another prefix. :: - router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 + router ospf + network 192.168.1.0/24 area 0.0.0.0 + network 10.0.0.0/8 area 0.0.0.10 + area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 - One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if - area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or - network-LSA) from range 10.0.0.0/8. - This command makes sense in ABR only. + One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if + area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or + network-LSA) from range 10.0.0.0/8. + This command makes sense in ABR only. -.. index:: {OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {} +.. index:: area A.B.C.D virtual-link A.B.C.D +.. clicmd:: area A.B.C.D virtual-link A.B.C.D -{OSPF Command} {area `a.b.c.d` virtual-link `a.b.c.d`} {} -.. index:: {OSPF Command} {area (0-4294967295) virtual-link `a.b.c.d`} {} +.. index:: area (0-4294967295) virtual-link A.B.C.D +.. clicmd:: area (0-4294967295) virtual-link A.B.C.D -{OSPF Command} {area (0-4294967295) virtual-link `a.b.c.d`} {} -.. index:: {OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {} +.. index:: no area A.B.C.D virtual-link A.B.C.D +.. clicmd:: no area A.B.C.D virtual-link A.B.C.D -{OSPF Command} {no area `a.b.c.d` virtual-link `a.b.c.d`} {} -.. index:: {OSPF Command} {no area (0-4294967295) virtual-link `a.b.c.d`} {} +.. index:: no area (0-4294967295) virtual-link A.B.C.D +.. clicmd:: no area (0-4294967295) virtual-link A.B.C.D -{OSPF Command} {no area (0-4294967295) virtual-link `a.b.c.d`} {} - .. _OSPF_virtual-link: +.. _OSPF_virtual-link: -.. index:: {OSPF Command} {area `a.b.c.d` shortcut} {} +.. index:: area A.B.C.D shortcut +.. clicmd:: area A.B.C.D shortcut -{OSPF Command} {area `a.b.c.d` shortcut} {} -.. index:: {OSPF Command} {area (0-4294967295) shortcut} {} +.. index:: area (0-4294967295) shortcut +.. clicmd:: area (0-4294967295) shortcut -{OSPF Command} {area (0-4294967295) shortcut} {} -.. index:: {OSPF Command} {no area `a.b.c.d` shortcut} {} +.. index:: no area A.B.C.D shortcut +.. clicmd:: no area A.B.C.D shortcut -{OSPF Command} {no area `a.b.c.d` shortcut} {} -.. index:: {OSPF Command} {no area (0-4294967295) shortcut} {} +.. index:: no area (0-4294967295) shortcut +.. clicmd:: no area (0-4294967295) shortcut -{OSPF Command} {no area (0-4294967295) shortcut} {} - Configure the area as Shortcut capable. See :rfc:`3509`. This requires - that the 'abr-type' be set to 'shortcut'. + Configure the area as Shortcut capable. See :rfc:`3509`. This requires + that the 'abr-type' be set to 'shortcut'. -.. index:: {OSPF Command} {area `a.b.c.d` stub} {} +.. index:: area A.B.C.D stub +.. clicmd:: area A.B.C.D stub -{OSPF Command} {area `a.b.c.d` stub} {} -.. index:: {OSPF Command} {area (0-4294967295) stub} {} +.. index:: area (0-4294967295) stub +.. clicmd:: area (0-4294967295) stub -{OSPF Command} {area (0-4294967295) stub} {} -.. index:: {OSPF Command} {no area `a.b.c.d` stub} {} +.. index:: no area A.B.C.D stub +.. clicmd:: no area A.B.C.D stub -{OSPF Command} {no area `a.b.c.d` stub} {} -.. index:: {OSPF Command} {no area (0-4294967295) stub} {} +.. index:: no area (0-4294967295) stub +.. clicmd:: no area (0-4294967295) stub -{OSPF Command} {no area (0-4294967295) stub} {} - Configure the area to be a stub area. That is, an area where no router - originates routes external to OSPF and hence an area where all external - routes are via the ABR(s). Hence, ABRs for such an area do not need - to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the - area. They need only pass Network-Summary (type-3) LSAs into such an area, - along with a default-route summary. + Configure the area to be a stub area. That is, an area where no router + originates routes external to OSPF and hence an area where all external + routes are via the ABR(s). Hence, ABRs for such an area do not need + to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the + area. They need only pass Network-Summary (type-3) LSAs into such an area, + along with a default-route summary. -.. index:: {OSPF Command} {area `a.b.c.d` stub no-summary} {} +.. index:: area A.B.C.D stub no-summary +.. clicmd:: area A.B.C.D stub no-summary -{OSPF Command} {area `a.b.c.d` stub no-summary} {} -.. index:: {OSPF Command} {area (0-4294967295) stub no-summary} {} +.. index:: area (0-4294967295) stub no-summary +.. clicmd:: area (0-4294967295) stub no-summary -{OSPF Command} {area (0-4294967295) stub no-summary} {} -.. index:: {OSPF Command} {no area `a.b.c.d` stub no-summary} {} +.. index:: no area A.B.C.D stub no-summary +.. clicmd:: no area A.B.C.D stub no-summary -{OSPF Command} {no area `a.b.c.d` stub no-summary} {} -.. index:: {OSPF Command} {no area (0-4294967295) stub no-summary} {} +.. index:: no area (0-4294967295) stub no-summary +.. clicmd:: no area (0-4294967295) stub no-summary -{OSPF Command} {no area (0-4294967295) stub no-summary} {} - Prevents an *ospfd* ABR from injecting inter-area - summaries into the specified stub area. + Prevents an *ospfd* ABR from injecting inter-area + summaries into the specified stub area. -.. index:: {OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {} +.. index:: area A.B.C.D default-cost (0-16777215) +.. clicmd:: area A.B.C.D default-cost (0-16777215) -{OSPF Command} {area `a.b.c.d` default-cost (0-16777215)} {} -.. index:: {OSPF Command} {no area `a.b.c.d` default-cost (0-16777215)} {} +.. index:: no area A.B.C.D default-cost (0-16777215) +.. clicmd:: no area A.B.C.D default-cost (0-16777215) -{OSPF Command} {no area `a.b.c.d` default-cost (0-16777215)} {} - Set the cost of default-summary LSAs announced to stubby areas. + Set the cost of default-summary LSAs announced to stubby areas. -.. index:: {OSPF Command} {area `a.b.c.d` export-list NAME} {} +.. index:: area A.B.C.D export-list NAME +.. clicmd:: area A.B.C.D export-list NAME -{OSPF Command} {area `a.b.c.d` export-list NAME} {} -.. index:: {OSPF Command} {area (0-4294967295) export-list NAME} {} +.. index:: area (0-4294967295) export-list NAME +.. clicmd:: area (0-4294967295) export-list NAME -{OSPF Command} {area (0-4294967295) export-list NAME} {} -.. index:: {OSPF Command} {no area `a.b.c.d` export-list NAME} {} +.. index:: no area A.B.C.D export-list NAME +.. clicmd:: no area A.B.C.D export-list NAME -{OSPF Command} {no area `a.b.c.d` export-list NAME} {} -.. index:: {OSPF Command} {no area (0-4294967295) export-list NAME} {} +.. index:: no area (0-4294967295) export-list NAME +.. clicmd:: no area (0-4294967295) export-list NAME -{OSPF Command} {no area (0-4294967295) export-list NAME} {} - Filter Type-3 summary-LSAs announced to other areas originated from intra- - area paths from specified area. + Filter Type-3 summary-LSAs announced to other areas originated from intra- + area paths from specified area. :: - router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 export-list foo - ! - access-list foo permit 10.10.0.0/16 - access-list foo deny any + router ospf + network 192.168.1.0/24 area 0.0.0.0 + network 10.0.0.0/8 area 0.0.0.10 + area 0.0.0.10 export-list foo + ! + access-list foo permit 10.10.0.0/16 + access-list foo deny any - With example above any intra-area paths from area 0.0.0.10 and from range - 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into - other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16 - or 10.128.30.16/30) aren't. + With example above any intra-area paths from area 0.0.0.10 and from range + 10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into + other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16 + or 10.128.30.16/30) aren't. - This command is only relevant if the router is an ABR for the specified - area. + This command is only relevant if the router is an ABR for the specified + area. -.. index:: {OSPF Command} {area `a.b.c.d` import-list NAME} {} +.. index:: area A.B.C.D import-list NAME +.. clicmd:: area A.B.C.D import-list NAME -{OSPF Command} {area `a.b.c.d` import-list NAME} {} -.. index:: {OSPF Command} {area (0-4294967295) import-list NAME} {} +.. index:: area (0-4294967295) import-list NAME +.. clicmd:: area (0-4294967295) import-list NAME -{OSPF Command} {area (0-4294967295) import-list NAME} {} -.. index:: {OSPF Command} {no area `a.b.c.d` import-list NAME} {} +.. index:: no area A.B.C.D import-list NAME +.. clicmd:: no area A.B.C.D import-list NAME -{OSPF Command} {no area `a.b.c.d` import-list NAME} {} -.. index:: {OSPF Command} {no area (0-4294967295) import-list NAME} {} +.. index:: no area (0-4294967295) import-list NAME +.. clicmd:: no area (0-4294967295) import-list NAME -{OSPF Command} {no area (0-4294967295) import-list NAME} {} - Same as export-list, but it applies to paths announced into specified area as - Type-3 summary-LSAs. + Same as export-list, but it applies to paths announced into specified area as + Type-3 summary-LSAs. -.. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME in} {} +.. index:: area A.B.C.D filter-list prefix NAME in +.. clicmd:: area A.B.C.D filter-list prefix NAME in -{OSPF Command} {area `a.b.c.d` filter-list prefix NAME in} {} -.. index:: {OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {} +.. index:: area A.B.C.D filter-list prefix NAME out +.. clicmd:: area A.B.C.D filter-list prefix NAME out -{OSPF Command} {area `a.b.c.d` filter-list prefix NAME out} {} -.. index:: {OSPF Command} {area (0-4294967295) filter-list prefix NAME in} {} +.. index:: area (0-4294967295) filter-list prefix NAME in +.. clicmd:: area (0-4294967295) filter-list prefix NAME in -{OSPF Command} {area (0-4294967295) filter-list prefix NAME in} {} -.. index:: {OSPF Command} {area (0-4294967295) filter-list prefix NAME out} {} +.. index:: area (0-4294967295) filter-list prefix NAME out +.. clicmd:: area (0-4294967295) filter-list prefix NAME out -{OSPF Command} {area (0-4294967295) filter-list prefix NAME out} {} -.. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {} +.. index:: no area A.B.C.D filter-list prefix NAME in +.. clicmd:: no area A.B.C.D filter-list prefix NAME in -{OSPF Command} {no area `a.b.c.d` filter-list prefix NAME in} {} -.. index:: {OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {} +.. index:: no area A.B.C.D filter-list prefix NAME out +.. clicmd:: no area A.B.C.D filter-list prefix NAME out -{OSPF Command} {no area `a.b.c.d` filter-list prefix NAME out} {} -.. index:: {OSPF Command} {no area (0-4294967295) filter-list prefix NAME in} {} +.. index:: no area (0-4294967295) filter-list prefix NAME in +.. clicmd:: no area (0-4294967295) filter-list prefix NAME in -{OSPF Command} {no area (0-4294967295) filter-list prefix NAME in} {} -.. index:: {OSPF Command} {no area (0-4294967295) filter-list prefix NAME out} {} +.. index:: no area (0-4294967295) filter-list prefix NAME out +.. clicmd:: no area (0-4294967295) filter-list prefix NAME out -{OSPF Command} {no area (0-4294967295) filter-list prefix NAME out} {} - Filtering Type-3 summary-LSAs to/from area using prefix lists. This command - makes sense in ABR only. + Filtering Type-3 summary-LSAs to/from area using prefix lists. This command + makes sense in ABR only. -.. index:: {OSPF Command} {area `a.b.c.d` authentication} {} +.. index:: area A.B.C.D authentication +.. clicmd:: area A.B.C.D authentication -{OSPF Command} {area `a.b.c.d` authentication} {} -.. index:: {OSPF Command} {area (0-4294967295) authentication} {} +.. index:: area (0-4294967295) authentication +.. clicmd:: area (0-4294967295) authentication -{OSPF Command} {area (0-4294967295) authentication} {} -.. index:: {OSPF Command} {no area `a.b.c.d` authentication} {} +.. index:: no area A.B.C.D authentication +.. clicmd:: no area A.B.C.D authentication -{OSPF Command} {no area `a.b.c.d` authentication} {} -.. index:: {OSPF Command} {no area (0-4294967295) authentication} {} +.. index:: no area (0-4294967295) authentication +.. clicmd:: no area (0-4294967295) authentication -{OSPF Command} {no area (0-4294967295) authentication} {} - Specify that simple password authentication should be used for the given - area. + Specify that simple password authentication should be used for the given + area. -.. index:: {OSPF Command} {area `a.b.c.d` authentication message-digest} {} +.. index:: area A.B.C.D authentication message-digest +.. clicmd:: area A.B.C.D authentication message-digest -{OSPF Command} {area `a.b.c.d` authentication message-digest} {} -.. index:: {OSPF Command} {area (0-4294967295) authentication message-digest} {} +.. index:: area (0-4294967295) authentication message-digest +.. clicmd:: area (0-4294967295) authentication message-digest -{OSPF Command} {area (0-4294967295) authentication message-digest} {} - .. _area_authentication_message-digest: +.. _area_authentication_message-digest: - Specify that OSPF packets - must be authenticated with MD5 HMACs within the given area. Keying - material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`). + Specify that OSPF packets + must be authenticated with MD5 HMACs within the given area. Keying + material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`). - MD5 authentication may also be configured on a per-interface basis - (:ref:`ip_ospf_authentication_message-digest`). Such per-interface - settings will override any per-area authentication setting. + MD5 authentication may also be configured on a per-interface basis + (:ref:`ip_ospf_authentication_message-digest`). Such per-interface + settings will override any per-area authentication setting. .. _OSPF_interface: OSPF interface ============== -.. index:: {Interface Command} {ip ospf area `AREA` [`ADDR`]} {} +.. index:: ip ospf area AREA [ADDR] +.. clicmd:: ip ospf area AREA [ADDR] -{Interface Command} {ip ospf area `AREA` [`ADDR`]} {} -.. index:: {Interface Command} {no ip ospf area [`ADDR`]} {} +.. index:: no ip ospf area [ADDR] +.. clicmd:: no ip ospf area [ADDR] -{Interface Command} {no ip ospf area [`ADDR`]} {} - .. _OSPF_ip_ospf_area_command: +.. _OSPF_ip_ospf_area_command: - Enable OSPF on the interface, optionally restricted to just the IP address - given by `ADDR`, putting it in the `AREA` area. Per interface area - settings take precedence to network commands (:ref:`OSPF_network_command`). + Enable OSPF on the interface, optionally restricted to just the IP address + given by `ADDR`, putting it in the `AREA` area. Per interface area + settings take precedence to network commands (:ref:`OSPF_network_command`). - If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF - via this command may result in a slight performance improvement. + If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF + via this command may result in a slight performance improvement. -.. index:: {Interface Command} {ip ospf authentication-key `AUTH_KEY`} {} +.. index:: ip ospf authentication-key AUTH_KEY +.. clicmd:: ip ospf authentication-key AUTH_KEY -{Interface Command} {ip ospf authentication-key `AUTH_KEY`} {} -.. index:: {Interface Command} {no ip ospf authentication-key} {} +.. index:: no ip ospf authentication-key +.. clicmd:: no ip ospf authentication-key -{Interface Command} {no ip ospf authentication-key} {} - Set OSPF authentication key to a simple password. After setting `AUTH_KEY`, - all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars. + Set OSPF authentication key to a simple password. After setting `AUTH_KEY`, + all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars. - Simple text password authentication is insecure and deprecated in favour of - MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`). + Simple text password authentication is insecure and deprecated in favour of + MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`). -.. index:: {Interface Command} {ip ospf authentication message-digest} {} +.. index:: ip ospf authentication message-digest +.. clicmd:: ip ospf authentication message-digest -{Interface Command} {ip ospf authentication message-digest} {} - .. _ip_ospf_authentication_message-digest: +.. _ip_ospf_authentication_message-digest: - Specify that MD5 HMAC - authentication must be used on this interface. MD5 keying material must - also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any - authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`). + Specify that MD5 HMAC + authentication must be used on this interface. MD5 keying material must + also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any + authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`). - Note that OSPF MD5 authentication requires that time never go backwards - (correct time is NOT important, only that it never goes backwards), even - across resets, if ospfd is to be able to promptly reestabish adjacencies - with its neighbours after restarts/reboots. The host should have system - time be set at boot from an external or non-volatile source (eg battery backed clock, NTP, - etc.) or else the system clock should be periodically saved to non-volative - storage and restored at boot if MD5 authentication is to be expected to work - reliably. + Note that OSPF MD5 authentication requires that time never go backwards + (correct time is NOT important, only that it never goes backwards), even + across resets, if ospfd is to be able to promptly reestabish adjacencies + with its neighbours after restarts/reboots. The host should have system + time be set at boot from an external or non-volatile source (eg battery backed clock, NTP, + etc.) or else the system clock should be periodically saved to non-volative + storage and restored at boot if MD5 authentication is to be expected to work + reliably. -.. index:: {Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {} +.. index:: ip ospf message-digest-key KEYID md5 KEY +.. clicmd:: ip ospf message-digest-key KEYID md5 KEY -{Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {} -.. index:: {Interface Command} {no ip ospf message-digest-key} {} +.. index:: no ip ospf message-digest-key +.. clicmd:: no ip ospf message-digest-key -{Interface Command} {no ip ospf message-digest-key} {} - .. _ip_ospf_message-digest-key: +.. _ip_ospf_message-digest-key: - Set OSPF authentication key to a - cryptographic password. The cryptographic algorithm is MD5. + Set OSPF authentication key to a + cryptographic password. The cryptographic algorithm is MD5. - KEYID identifies secret key used to create the message digest. This ID - is part of the protocol and must be consistent across routers on a - link. + KEYID identifies secret key used to create the message digest. This ID + is part of the protocol and must be consistent across routers on a + link. - KEY is the actual message digest key, of up to 16 chars (larger strings - will be truncated), and is associated with the given KEYID. + KEY is the actual message digest key, of up to 16 chars (larger strings + will be truncated), and is associated with the given KEYID. -.. index:: {Interface Command} {ip ospf cost (1-65535)} {} +.. index:: ip ospf cost (1-65535) +.. clicmd:: ip ospf cost (1-65535) -{Interface Command} {ip ospf cost (1-65535)} {} -.. index:: {Interface Command} {no ip ospf cost} {} +.. index:: no ip ospf cost +.. clicmd:: no ip ospf cost -{Interface Command} {no ip ospf cost} {} - Set link cost for the specified interface. The cost value is set to router-LSA's - metric field and used for SPF calculation. + Set link cost for the specified interface. The cost value is set to router-LSA's + metric field and used for SPF calculation. -.. index:: {Interface Command} {ip ospf dead-interval (1-65535)} {} +.. index:: ip ospf dead-interval (1-65535) +.. clicmd:: ip ospf dead-interval (1-65535) -{Interface Command} {ip ospf dead-interval (1-65535)} {} -.. index:: {Interface Command} {ip ospf dead-interval minimal hello-multiplier (2-20)} {} +.. index:: ip ospf dead-interval minimal hello-multiplier (2-20) +.. clicmd:: ip ospf dead-interval minimal hello-multiplier (2-20) -{Interface Command} {ip ospf dead-interval minimal hello-multiplier (2-20)} {} -.. index:: {Interface Command} {no ip ospf dead-interval} {} +.. index:: no ip ospf dead-interval +.. clicmd:: no ip ospf dead-interval -{Interface Command} {no ip ospf dead-interval} {} - .. _ip_ospf_dead-interval_minimal: +.. _ip_ospf_dead-interval_minimal: - Set number of seconds for - RouterDeadInterval timer value used for Wait Timer and Inactivity - Timer. This value must be the same for all routers attached to a - common network. The default value is 40 seconds. + Set number of seconds for + RouterDeadInterval timer value used for Wait Timer and Inactivity + Timer. This value must be the same for all routers attached to a + common network. The default value is 40 seconds. - If 'minimal' is specified instead, then the dead-interval is set to 1 - second and one must specify a hello-multiplier. The hello-multiplier - specifies how many Hellos to send per second, from 2 (every 500ms) to - 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form - is specified, then the hello-interval advertised in Hello packets is set to - 0 and the hello-interval on received Hello packets is not checked, thus - the hello-multiplier need NOT be the same across multiple routers on a common - link. + If 'minimal' is specified instead, then the dead-interval is set to 1 + second and one must specify a hello-multiplier. The hello-multiplier + specifies how many Hellos to send per second, from 2 (every 500ms) to + 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form + is specified, then the hello-interval advertised in Hello packets is set to + 0 and the hello-interval on received Hello packets is not checked, thus + the hello-multiplier need NOT be the same across multiple routers on a common + link. -.. index:: {Interface Command} {ip ospf hello-interval (1-65535)} {} +.. index:: ip ospf hello-interval (1-65535) +.. clicmd:: ip ospf hello-interval (1-65535) -{Interface Command} {ip ospf hello-interval (1-65535)} {} -.. index:: {Interface Command} {no ip ospf hello-interval} {} +.. index:: no ip ospf hello-interval +.. clicmd:: no ip ospf hello-interval -{Interface Command} {no ip ospf hello-interval} {} - Set number of seconds for HelloInterval timer value. Setting this value, - Hello packet will be sent every timer value seconds on the specified interface. - This value must be the same for all routers attached to a common network. - The default value is 10 seconds. + Set number of seconds for HelloInterval timer value. Setting this value, + Hello packet will be sent every timer value seconds on the specified interface. + This value must be the same for all routers attached to a common network. + The default value is 10 seconds. - This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also - specified for the interface. + This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also + specified for the interface. -.. index:: {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} +.. index:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point) +.. clicmd:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point) -{Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} -.. index:: {Interface Command} {no ip ospf network} {} +.. index:: no ip ospf network +.. clicmd:: no ip ospf network -{Interface Command} {no ip ospf network} {} - Set explicitly network type for specifed interface. + Set explicitly network type for specifed interface. -.. index:: {Interface Command} {ip ospf priority (0-255)} {} +.. index:: ip ospf priority (0-255) +.. clicmd:: ip ospf priority (0-255) -{Interface Command} {ip ospf priority (0-255)} {} -.. index:: {Interface Command} {no ip ospf priority} {} +.. index:: no ip ospf priority +.. clicmd:: no ip ospf priority -{Interface Command} {no ip ospf priority} {} - Set RouterPriority integer value. The router with the highest priority - will be more eligible to become Designated Router. Setting the value - to 0, makes the router ineligible to become Designated Router. The - default value is 1. + Set RouterPriority integer value. The router with the highest priority + will be more eligible to become Designated Router. Setting the value + to 0, makes the router ineligible to become Designated Router. The + default value is 1. -.. index:: {Interface Command} {ip ospf retransmit-interval (1-65535)} {} +.. index:: ip ospf retransmit-interval (1-65535) +.. clicmd:: ip ospf retransmit-interval (1-65535) -{Interface Command} {ip ospf retransmit-interval (1-65535)} {} -.. index:: {Interface Command} {no ip ospf retransmit interval} {} +.. index:: no ip ospf retransmit interval +.. clicmd:: no ip ospf retransmit interval -{Interface Command} {no ip ospf retransmit interval} {} - Set number of seconds for RxmtInterval timer value. This value is used - when retransmitting Database Description and Link State Request packets. - The default value is 5 seconds. + Set number of seconds for RxmtInterval timer value. This value is used + when retransmitting Database Description and Link State Request packets. + The default value is 5 seconds. -.. index:: {Interface Command} {ip ospf transmit-delay} {} +.. index:: ip ospf transmit-delay +.. clicmd:: ip ospf transmit-delay -{Interface Command} {ip ospf transmit-delay} {} -.. index:: {Interface Command} {no ip ospf transmit-delay} {} +.. index:: no ip ospf transmit-delay +.. clicmd:: no ip ospf transmit-delay -{Interface Command} {no ip ospf transmit-delay} {} - Set number of seconds for InfTransDelay value. LSAs' age should be - incremented by this value when transmitting. - The default value is 1 seconds. + Set number of seconds for InfTransDelay value. LSAs' age should be + incremented by this value when transmitting. + The default value is 1 seconds. -.. index:: {Interface Command} {ip ospf area (A.B.C.D|(0-4294967295))} {} +.. index:: ip ospf area (A.B.C.D|(0-4294967295)) +.. clicmd:: ip ospf area (A.B.C.D|(0-4294967295)) -{Interface Command} {ip ospf area (A.B.C.D|(0-4294967295))} {} -.. index:: {Interface Command} {no ip ospf area} {} +.. index:: no ip ospf area +.. clicmd:: no ip ospf area -{Interface Command} {no ip ospf area} {} - Enable ospf on an interface and set associated area. + Enable ospf on an interface and set associated area. .. _Redistribute_routes_to_OSPF: Redistribute routes to OSPF =========================== -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) `route-map`} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) `route-map`} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map `word`} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214)} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map `word`} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map `word`} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214)} {} -.. index:: {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map `word`} {} +.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD +.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD -{OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map `word`} {} -.. index:: {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} +.. index:: no redistribute (kernel|connected|static|rip|bgp) +.. clicmd:: no redistribute (kernel|connected|static|rip|bgp) -{OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} - .. _OSPF_redistribute: +.. _OSPF_redistribute: - Redistribute routes of the specified protocol - or kind into OSPF, with the metric type and metric set if specified, - filtering the routes using the given route-map if specified. - Redistributed routes may also be filtered with distribute-lists, see - :ref:`ospf_distribute-list`. + Redistribute routes of the specified protocol + or kind into OSPF, with the metric type and metric set if specified, + filtering the routes using the given route-map if specified. + Redistributed routes may also be filtered with distribute-lists, see + :ref:`ospf_distribute-list`. - Redistributed routes are distributed as into OSPF as Type-5 External - LSAs into links to areas that accept external routes, Type-7 External LSAs - for NSSA areas and are not redistributed at all into Stub areas, where - external routes are not permitted. + Redistributed routes are distributed as into OSPF as Type-5 External + LSAs into links to areas that accept external routes, Type-7 External LSAs + for NSSA areas and are not redistributed at all into Stub areas, where + external routes are not permitted. - Note that for connected routes, one may instead use - :term:`passive-interface`, see :ref:`OSPF_passive-interface`. + Note that for connected routes, one may instead use + :term:`passive-interface`, see :ref:`OSPF_passive-interface`. -.. index:: {OSPF Command} {default-information originate} {} +.. index:: default-information originate +.. clicmd:: default-information originate -{OSPF Command} {default-information originate} {} -.. index:: {OSPF Command} {default-information originate metric (0-16777214)} {} +.. index:: default-information originate metric (0-16777214) +.. clicmd:: default-information originate metric (0-16777214) -{OSPF Command} {default-information originate metric (0-16777214)} {} -.. index:: {OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2)} {} +.. index:: default-information originate metric (0-16777214) metric-type (1|2) +.. clicmd:: default-information originate metric (0-16777214) metric-type (1|2) -{OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2)} {} -.. index:: {OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2) route-map `word`} {} +.. index:: default-information originate metric (0-16777214) metric-type (1|2) route-map WORD +.. clicmd:: default-information originate metric (0-16777214) metric-type (1|2) route-map WORD -{OSPF Command} {default-information originate metric (0-16777214) metric-type (1|2) route-map `word`} {} -.. index:: {OSPF Command} {default-information originate always} {} +.. index:: default-information originate always +.. clicmd:: default-information originate always -{OSPF Command} {default-information originate always} {} -.. index:: {OSPF Command} {default-information originate always metric (0-16777214)} {} +.. index:: default-information originate always metric (0-16777214) +.. clicmd:: default-information originate always metric (0-16777214) -{OSPF Command} {default-information originate always metric (0-16777214)} {} -.. index:: {OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2)} {} +.. index:: default-information originate always metric (0-16777214) metric-type (1|2) +.. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2) -{OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2)} {} -.. index:: {OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2) route-map `word`} {} +.. index:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD +.. clicmd:: default-information originate always metric (0-16777214) metric-type (1|2) route-map WORD -{OSPF Command} {default-information originate always metric (0-16777214) metric-type (1|2) route-map `word`} {} -.. index:: {OSPF Command} {no default-information originate} {} +.. index:: no default-information originate +.. clicmd:: no default-information originate -{OSPF Command} {no default-information originate} {} - Originate an AS-External (type-5) LSA describing a default route into - all external-routing capable areas, of the specified metric and metric - type. If the 'always' keyword is given then the default is always - advertised, even when there is no default present in the routing table. + Originate an AS-External (type-5) LSA describing a default route into + all external-routing capable areas, of the specified metric and metric + type. If the 'always' keyword is given then the default is always + advertised, even when there is no default present in the routing table. -.. index:: {OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {} +.. index:: distribute-list NAME out (kernel|connected|static|rip|ospf +.. clicmd:: distribute-list NAME out (kernel|connected|static|rip|ospf -{OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {} -.. index:: {OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {} +.. index:: no distribute-list NAME out (kernel|connected|static|rip|ospf +.. clicmd:: no distribute-list NAME out (kernel|connected|static|rip|ospf -{OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {} - .. _ospf_distribute-list: +.. _ospf_distribute-list: - Apply the access-list filter, NAME, to - redistributed routes of the given type before allowing the routes to - redistributed into OSPF (:ref:`OSPF_redistribute`). + Apply the access-list filter, NAME, to + redistributed routes of the given type before allowing the routes to + redistributed into OSPF (:ref:`OSPF_redistribute`). -.. index:: {OSPF Command} {default-metric (0-16777214)} {} +.. index:: default-metric (0-16777214) +.. clicmd:: default-metric (0-16777214) -{OSPF Command} {default-metric (0-16777214)} {} -.. index:: {OSPF Command} {no default-metric} {} +.. index:: no default-metric +.. clicmd:: no default-metric -{OSPF Command} {no default-metric} {} -.. index:: {OSPF Command} {distance (1-255)} {} +.. index:: distance (1-255) +.. clicmd:: distance (1-255) -{OSPF Command} {distance (1-255)} {} -.. index:: {OSPF Command} {no distance (1-255)} {} +.. index:: no distance (1-255) +.. clicmd:: no distance (1-255) -{OSPF Command} {no distance (1-255)} {} -.. index:: {OSPF Command} {distance ospf (intra-area|inter-area|external) (1-255)} {} +.. index:: distance ospf (intra-area|inter-area|external) (1-255) +.. clicmd:: distance ospf (intra-area|inter-area|external) (1-255) -{OSPF Command} {distance ospf (intra-area|inter-area|external) (1-255)} {} -.. index:: {OSPF Command} {no distance ospf} {} +.. index:: no distance ospf +.. clicmd:: no distance ospf -{OSPF Command} {no distance ospf} {} -.. index:: {Command} {router zebra} {} +.. index:: router zebra +.. clicmd:: router zebra -{Command} {router zebra} {} -.. index:: {Command} {no router zebra} {} +.. index:: no router zebra +.. clicmd:: no router zebra -{Command} {no router zebra} {} .. _Showing_OSPF_information: Showing OSPF information ======================== -.. index:: {Command} {show ip ospf} {} +.. _show_ip_ospf: -{Command} {show ip ospf} {} - .. _show_ip_ospf: +.. index:: show ip ospf +.. clicmd:: show ip ospf - Show information on a variety of general OSPF and - area state and configuration information. + Show information on a variety of general OSPF and area state and + configuration information. -.. index:: {Command} {show ip ospf interface [INTERFACE]} {} +.. index:: show ip ospf interface [INTERFACE] +.. clicmd:: show ip ospf interface [INTERFACE] -{Command} {show ip ospf interface [INTERFACE]} {} - Show state and configuration of OSPF the specified interface, or all - interfaces if no interface is given. + Show state and configuration of OSPF the specified interface, or all + interfaces if no interface is given. -.. index:: {Command} {show ip ospf neighbor} {} +.. index:: show ip ospf neighbor +.. clicmd:: show ip ospf neighbor -{Command} {show ip ospf neighbor} {} -.. index:: {Command} {show ip ospf neighbor INTERFACE} {} +.. index:: show ip ospf neighbor INTERFACE +.. clicmd:: show ip ospf neighbor INTERFACE -{Command} {show ip ospf neighbor INTERFACE} {} -.. index:: {Command} {show ip ospf neighbor detail} {} +.. index:: show ip ospf neighbor detail +.. clicmd:: show ip ospf neighbor detail -{Command} {show ip ospf neighbor detail} {} -.. index:: {Command} {show ip ospf neighbor INTERFACE detail} {} +.. index:: show ip ospf neighbor INTERFACE detail +.. clicmd:: show ip ospf neighbor INTERFACE detail -{Command} {show ip ospf neighbor INTERFACE detail} {} -.. index:: {Command} {show ip ospf database} {} +.. index:: show ip ospf database +.. clicmd:: show ip ospf database -{Command} {show ip ospf database} {} -.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {} +.. index:: show ip ospf database (asbr-summary|external|network|router|summary) +.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) -{Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {} -.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id`} {} +.. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID +.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID -{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id`} {} -.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` adv-router `adv-router`} {} +.. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID adv-router ADV-ROUTER +.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID adv-router ADV-ROUTER -{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` adv-router `adv-router`} {} -.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router `adv-router`} {} +.. index:: show ip ospf database (asbr-summary|external|network|router|summary) adv-router ADV-ROUTER +.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) adv-router ADV-ROUTER -{Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router `adv-router`} {} -.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` self-originate} {} +.. index:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID self-originate +.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) LINK-STATE-ID self-originate -{Command} {show ip ospf database (asbr-summary|external|network|router|summary) `link-state-id` self-originate} {} -.. index:: {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {} +.. index:: show ip ospf database (asbr-summary|external|network|router|summary) self-originate +.. clicmd:: show ip ospf database (asbr-summary|external|network|router|summary) self-originate -{Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {} -.. index:: {Command} {show ip ospf database max-age} {} +.. index:: show ip ospf database max-age +.. clicmd:: show ip ospf database max-age -{Command} {show ip ospf database max-age} {} -.. index:: {Command} {show ip ospf database self-originate} {} +.. index:: show ip ospf database self-originate +.. clicmd:: show ip ospf database self-originate -{Command} {show ip ospf database self-originate} {} -.. index:: {Command} {show ip ospf route} {} +.. index:: show ip ospf route +.. clicmd:: show ip ospf route -{Command} {show ip ospf route} {} - Show the OSPF routing table, as determined by the most recent SPF calculation. + Show the OSPF routing table, as determined by the most recent SPF calculation. .. _Opaque_LSA: Opaque LSA ========== -.. index:: {OSPF Command} {ospf opaque-lsa} {} +.. index:: ospf opaque-lsa +.. clicmd:: ospf opaque-lsa -{OSPF Command} {ospf opaque-lsa} {} -.. index:: {OSPF Command} {capability opaque} {} +.. index:: capability opaque +.. clicmd:: capability opaque -{OSPF Command} {capability opaque} {} -.. index:: {OSPF Command} {no ospf opaque-lsa} {} +.. index:: no ospf opaque-lsa +.. clicmd:: no ospf opaque-lsa -{OSPF Command} {no ospf opaque-lsa} {} -.. index:: {OSPF Command} {no capability opaque} {} +.. index:: no capability opaque +.. clicmd:: no capability opaque -{OSPF Command} {no capability opaque} {} - *ospfd* support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration file. Alternate command could be "mpls-te on" (:ref:`OSPF_Traffic_Engineering`). + *ospfd* support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering + LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration + file. Alternate command could be "mpls-te on" + (:ref:`ospf-traffic-engineering`). -.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {} +.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) +.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) -{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {} -.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id`} {} +.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID +.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID -{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id`} {} -.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` adv-router `adv-router`} {} +.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID adv-router ADV-ROUTER +.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID adv-router ADV-ROUTER -{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` adv-router `adv-router`} {} -.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router `adv-router`} {} +.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router ADV-ROUTER +.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router ADV-ROUTER -{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router `adv-router`} {} -.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` self-originate} {} +.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID self-originate +.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) LINK-STATE-ID self-originate -{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) `link-state-id` self-originate} {} -.. index:: {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {} +.. index:: show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate +.. clicmd:: show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate -{Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {} - Show Opaque LSA from the database. + Show Opaque LSA from the database. -.. _Traffic_Engineering: +.. _ospf-traffic-engineering: Traffic Engineering =================== -.. index:: {OSPF Command} {mpls-te on} {} +.. index:: mpls-te on +.. clicmd:: mpls-te on -{OSPF Command} {mpls-te on} {} -.. index:: {OSPF Command} {no mpls-te} {} +.. index:: no mpls-te +.. clicmd:: no mpls-te -{OSPF Command} {no mpls-te} {} - Enable Traffic Engineering LSA flooding. + Enable Traffic Engineering LSA flooding. -.. index:: {OSPF Command} {mpls-te router-address } {} +.. index:: mpls-te router-address +.. clicmd:: mpls-te router-address -{OSPF Command} {mpls-te router-address } {} -.. index:: {OSPF Command} {no mpls-te} {} + Configure stable IP address for MPLS-TE. This IP address is then advertise + in Opaque LSA Type-10 TLV=1 (TE) option 1 (Router-Address). -{OSPF Command} {no mpls-te} {} - Configure stable IP address for MPLS-TE. This IP address is then advertise in Opaque LSA Type-10 TLV=1 (TE) - option 1 (Router-Address). +.. index:: mpls-te inter-as area |as +.. clicmd:: mpls-te inter-as area |as -.. index:: {OSPF Command} {mpls-te inter-as area |as} {} +.. index:: no mpls-te inter-as +.. clicmd:: no mpls-te inter-as -{OSPF Command} {mpls-te inter-as area |as} {} -.. index:: {OSPF Command} {no mpls-te inter-as} {} + Enable :rfc:`5392` support - Inter-AS TE v2 - to flood Traffic Engineering + parameters of Inter-AS link. 2 modes are supported: AREA and AS; LSA are + flood in AREA with Opaque Type-10, respectively in AS with Opaque + Type-11. In all case, Opaque-LSA TLV=6. -{OSPF Command} {no mpls-te inter-as} {} - Enable RFC5392 suuport - Inter-AS TE v2 - to flood Traffic Engineering parameters of Inter-AS link. - 2 modes are supported: AREA and AS; LSA are flood in AREA with Opaque Type-10, - respectively in AS with Opaque Type-11. In all case, Opaque-LSA TLV=6. +.. index:: show ip ospf mpls-te interface +.. clicmd:: show ip ospf mpls-te interface -.. index:: {Command} {show ip ospf mpls-te interface} {} +.. index:: show ip ospf mpls-te interface INTERFACE +.. clicmd:: show ip ospf mpls-te interface INTERFACE -{Command} {show ip ospf mpls-te interface} {} -.. index:: {Command} {show ip ospf mpls-te interface `interface`} {} + Show MPLS Traffic Engineering parameters for all or specified interface. -{Command} {show ip ospf mpls-te interface `interface`} {} - Show MPLS Traffic Engineering parameters for all or specified interface. +.. index:: show ip ospf mpls-te router +.. clicmd:: show ip ospf mpls-te router -.. index:: {Command} {show ip ospf mpls-te router} {} - -{Command} {show ip ospf mpls-te router} {} - Show Traffic Engineering router parameters. + Show Traffic Engineering router parameters. .. _Router_Information: Router Information ================== -.. index:: {OSPF Command} {router-info [as | area ]} {} +.. index:: router-info [as | area ] +.. clicmd:: router-info [as | area ] -{OSPF Command} {router-info [as | area ]} {} -.. index:: {OSPF Command} {no router-info} {} +.. index:: no router-info +.. clicmd:: no router-info -{OSPF Command} {no router-info} {} - Enable Router Information (RFC4970) LSA advertisement with AS scope (default) or Area scope flooding - when area is specified. + Enable Router Information (:rfc:`4970`) LSA advertisement with AS scope + (default) or Area scope flooding when area is specified. -.. index:: {OSPF Command} {pce address } {} +.. index:: pce address +.. clicmd:: pce address -{OSPF Command} {pce address } {} -.. index:: {OSPF Command} {no pce address} {} +.. index:: no pce address +.. clicmd:: no pce address -{OSPF Command} {no pce address} {} -.. index:: {OSPF Command} {pce domain as (0-65535)} {} +.. index:: pce domain as (0-65535) +.. clicmd:: pce domain as (0-65535) -{OSPF Command} {pce domain as (0-65535)} {} -.. index:: {OSPF Command} {no pce domain as (0-65535)} {} +.. index:: no pce domain as (0-65535) +.. clicmd:: no pce domain as (0-65535) -{OSPF Command} {no pce domain as (0-65535)} {} -.. index:: {OSPF Command} {pce neighbor as (0-65535)} {} +.. index:: pce neighbor as (0-65535) +.. clicmd:: pce neighbor as (0-65535) -{OSPF Command} {pce neighbor as (0-65535)} {} -.. index:: {OSPF Command} {no pce neighbor as (0-65535)} {} +.. index:: no pce neighbor as (0-65535) +.. clicmd:: no pce neighbor as (0-65535) -{OSPF Command} {no pce neighbor as (0-65535)} {} -.. index:: {OSPF Command} {pce flag BITPATTERN} {} +.. index:: pce flag BITPATTERN +.. clicmd:: pce flag BITPATTERN -{OSPF Command} {pce flag BITPATTERN} {} -.. index:: {OSPF Command} {no pce flag} {} +.. index:: no pce flag +.. clicmd:: no pce flag -{OSPF Command} {no pce flag} {} -.. index:: {OSPF Command} {pce scope BITPATTERN} {} +.. index:: pce scope BITPATTERN +.. clicmd:: pce scope BITPATTERN -{OSPF Command} {pce scope BITPATTERN} {} -.. index:: {OSPF Command} {no pce scope} {} +.. index:: no pce scope +.. clicmd:: no pce scope -{OSPF Command} {no pce scope} {} - The commands are conform to RFC 5088 and allow OSPF router announce Path Compuatation Elemenent (PCE) capabilities - through the Router Information (RI) LSA. Router Information must be enable prior to this. The command set/unset - respectively the PCE IP adress, Autonomous System (AS) numbers of controlled domains, neighbor ASs, flag and scope. - For flag and scope, please refer to RFC5088 for the BITPATTERN recognition. Multiple 'pce neighbor' command could - be specified in order to specify all PCE neighbours. + The commands are conform to :rfc:`5088` and allow OSPF router announce Path + Compuatation Elemenent (PCE) capabilities through the Router Information (RI) + LSA. Router Information must be enable prior to this. The command set/unset + respectively the PCE IP adress, Autonomous System (AS) numbers of controlled + domains, neighbor ASs, flag and scope. For flag and scope, please refer to + :rfc`5088` for the BITPATTERN recognition. Multiple 'pce neighbor' command + could be specified in order to specify all PCE neighbours. -.. index:: {Command} {show ip ospf router-info} {} +.. index:: show ip ospf router-info +.. clicmd:: show ip ospf router-info -{Command} {show ip ospf router-info} {} - Show Router Capabilities flag. -.. index:: {Command} {show ip ospf router-info pce} {} + Show Router Capabilities flag. +.. index:: show ip ospf router-info pce +.. clicmd:: show ip ospf router-info pce -{Command} {show ip ospf router-info pce} {} - Show Router Capabilities PCE parameters. + Show Router Capabilities PCE parameters. .. _Debugging_OSPF: Debugging OSPF ============== -.. index:: {Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} +.. index:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] +.. clicmd:: debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] -{Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} -.. index:: {Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} +.. index:: no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] +.. clicmd:: no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail] -{Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} - Dump Packet for debugging + Dump Packet for debugging -.. index:: {Command} {debug ospf ism} {} +.. index:: debug ospf ism +.. clicmd:: debug ospf ism -{Command} {debug ospf ism} {} -.. index:: {Command} {debug ospf ism (status|events|timers)} {} +.. index:: debug ospf ism (status|events|timers) +.. clicmd:: debug ospf ism (status|events|timers) -{Command} {debug ospf ism (status|events|timers)} {} -.. index:: {Command} {no debug ospf ism} {} +.. index:: no debug ospf ism +.. clicmd:: no debug ospf ism -{Command} {no debug ospf ism} {} -.. index:: {Command} {no debug ospf ism (status|events|timers)} {} +.. index:: no debug ospf ism (status|events|timers) +.. clicmd:: no debug ospf ism (status|events|timers) -{Command} {no debug ospf ism (status|events|timers)} {} - Show debug information of Interface State Machine + Show debug information of Interface State Machine -.. index:: {Command} {debug ospf nsm} {} +.. index:: debug ospf nsm +.. clicmd:: debug ospf nsm -{Command} {debug ospf nsm} {} -.. index:: {Command} {debug ospf nsm (status|events|timers)} {} +.. index:: debug ospf nsm (status|events|timers) +.. clicmd:: debug ospf nsm (status|events|timers) -{Command} {debug ospf nsm (status|events|timers)} {} -.. index:: {Command} {no debug ospf nsm} {} +.. index:: no debug ospf nsm +.. clicmd:: no debug ospf nsm -{Command} {no debug ospf nsm} {} -.. index:: {Command} {no debug ospf nsm (status|events|timers)} {} +.. index:: no debug ospf nsm (status|events|timers) +.. clicmd:: no debug ospf nsm (status|events|timers) -{Command} {no debug ospf nsm (status|events|timers)} {} - Show debug information of Network State Machine + Show debug information of Network State Machine -.. index:: {Command} {debug ospf event} {} +.. index:: debug ospf event +.. clicmd:: debug ospf event -{Command} {debug ospf event} {} -.. index:: {Command} {no debug ospf event} {} +.. index:: no debug ospf event +.. clicmd:: no debug ospf event -{Command} {no debug ospf event} {} - Show debug information of OSPF event + Show debug information of OSPF event -.. index:: {Command} {debug ospf nssa} {} +.. index:: debug ospf nssa +.. clicmd:: debug ospf nssa -{Command} {debug ospf nssa} {} -.. index:: {Command} {no debug ospf nssa} {} +.. index:: no debug ospf nssa +.. clicmd:: no debug ospf nssa -{Command} {no debug ospf nssa} {} - Show debug information about Not So Stub Area + Show debug information about Not So Stub Area -.. index:: {Command} {debug ospf lsa} {} +.. index:: debug ospf lsa +.. clicmd:: debug ospf lsa -{Command} {debug ospf lsa} {} -.. index:: {Command} {debug ospf lsa (generate|flooding|refresh)} {} +.. index:: debug ospf lsa (generate|flooding|refresh) +.. clicmd:: debug ospf lsa (generate|flooding|refresh) -{Command} {debug ospf lsa (generate|flooding|refresh)} {} -.. index:: {Command} {no debug ospf lsa} {} +.. index:: no debug ospf lsa +.. clicmd:: no debug ospf lsa -{Command} {no debug ospf lsa} {} -.. index:: {Command} {no debug ospf lsa (generate|flooding|refresh)} {} +.. index:: no debug ospf lsa (generate|flooding|refresh) +.. clicmd:: no debug ospf lsa (generate|flooding|refresh) -{Command} {no debug ospf lsa (generate|flooding|refresh)} {} - Show debug detail of Link State messages + Show debug detail of Link State messages -.. index:: {Command} {debug ospf te} {} +.. index:: debug ospf te +.. clicmd:: debug ospf te -{Command} {debug ospf te} {} -.. index:: {Command} {no debug ospf te} {} +.. index:: no debug ospf te +.. clicmd:: no debug ospf te -{Command} {no debug ospf te} {} - Show debug information about Traffic Engineering LSA + Show debug information about Traffic Engineering LSA -.. index:: {Command} {debug ospf zebra} {} +.. index:: debug ospf zebra +.. clicmd:: debug ospf zebra -{Command} {debug ospf zebra} {} -.. index:: {Command} {debug ospf zebra (interface|redistribute)} {} +.. index:: debug ospf zebra (interface|redistribute) +.. clicmd:: debug ospf zebra (interface|redistribute) -{Command} {debug ospf zebra (interface|redistribute)} {} -.. index:: {Command} {no debug ospf zebra} {} +.. index:: no debug ospf zebra +.. clicmd:: no debug ospf zebra -{Command} {no debug ospf zebra} {} -.. index:: {Command} {no debug ospf zebra (interface|redistribute)} {} +.. index:: no debug ospf zebra (interface|redistribute) +.. clicmd:: no debug ospf zebra (interface|redistribute) -{Command} {no debug ospf zebra (interface|redistribute)} {} - Show debug information of ZEBRA API + Show debug information of ZEBRA API -.. index:: {Command} {show debugging ospf} {} +.. index:: show debugging ospf +.. clicmd:: show debugging ospf -{Command} {show debugging ospf} {} OSPF Configuration Examples =========================== @@ -1118,14 +1117,14 @@ A simple example, with MD5 authentication enabled: :: - ! - interface bge0 - ip ospf authentication message-digest - ip ospf message-digest-key 1 md5 ABCDEFGHIJK - ! - router ospf - network 192.168.0.0/16 area 0.0.0.1 - area 0.0.0.1 authentication message-digest + ! + interface bge0 + ip ospf authentication message-digest + ip ospf message-digest-key 1 md5 ABCDEFGHIJK + ! + router ospf + network 192.168.0.0/16 area 0.0.0.1 + area 0.0.0.1 authentication message-digest An :abbr:`ABR` router, with MD5 authentication and performing summarisation @@ -1133,127 +1132,119 @@ of networks between the areas: :: - ! - password ABCDEF - log file /var/log/frr/ospfd.log - service advanced-vty - ! - interface eth0 - ip ospf authentication message-digest - ip ospf message-digest-key 1 md5 ABCDEFGHIJK - ! - interface ppp0 - ! - interface br0 - ip ospf authentication message-digest - ip ospf message-digest-key 2 md5 XYZ12345 - ! - router ospf - ospf router-id 192.168.0.1 - redistribute connected - passive interface ppp0 - network 192.168.0.0/24 area 0.0.0.0 - network 10.0.0.0/16 area 0.0.0.0 - network 192.168.1.0/24 area 0.0.0.1 - area 0.0.0.0 authentication message-digest - area 0.0.0.0 range 10.0.0.0/16 - area 0.0.0.0 range 192.168.0.0/24 - area 0.0.0.1 authentication message-digest - area 0.0.0.1 range 10.2.0.0/16 - ! + ! + password ABCDEF + log file /var/log/frr/ospfd.log + service advanced-vty + ! + interface eth0 + ip ospf authentication message-digest + ip ospf message-digest-key 1 md5 ABCDEFGHIJK + ! + interface ppp0 + ! + interface br0 + ip ospf authentication message-digest + ip ospf message-digest-key 2 md5 XYZ12345 + ! + router ospf + ospf router-id 192.168.0.1 + redistribute connected + passive interface ppp0 + network 192.168.0.0/24 area 0.0.0.0 + network 10.0.0.0/16 area 0.0.0.0 + network 192.168.1.0/24 area 0.0.0.1 + area 0.0.0.0 authentication message-digest + area 0.0.0.0 range 10.0.0.0/16 + area 0.0.0.0 range 192.168.0.0/24 + area 0.0.0.1 authentication message-digest + area 0.0.0.1 range 10.2.0.0/16 + ! A Traffic Engineering configuration, with Inter-ASv2 support. -- First, the 'zebra.conf' part: +First, the 'zebra.conf' part::: -:: - - hostname HOSTNAME - password PASSWORD - log file /var/log/zebra.log - ! - interface eth0 - ip address 198.168.1.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - ! - interface eth1 - ip address 192.168.2.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - mpls-te neighbor 192.168.2.2 as 65000 + hostname HOSTNAME + password PASSWORD + log file /var/log/zebra.log + ! + interface eth0 + ip address 198.168.1.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + ! + interface eth1 + ip address 192.168.2.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + mpls-te neighbor 192.168.2.2 as 65000 -- Then the 'ospfd.conf' itself: +Then the 'ospfd.conf' itself::: -:: - - hostname HOSTNAME - password PASSWORD - log file /var/log/ospfd.log - ! - ! - interface eth0 - ip ospf hello-interval 60 - ip ospf dead-interval 240 - ! - interface eth1 - ip ospf hello-interval 60 - ip ospf dead-interval 240 - ! - ! - router ospf - ospf router-id 192.168.1.1 - network 192.168.0.0/16 area 1 - ospf opaque-lsa + hostname HOSTNAME + password PASSWORD + log file /var/log/ospfd.log + ! + ! + interface eth0 + ip ospf hello-interval 60 + ip ospf dead-interval 240 + ! + interface eth1 + ip ospf hello-interval 60 + ip ospf dead-interval 240 + ! + ! + router ospf + ospf router-id 192.168.1.1 + network 192.168.0.0/16 area 1 + ospf opaque-lsa mpls-te mpls-te router-address 192.168.1.1 mpls-te inter-as area 1 - ! - line vty + ! + line vty -A router information example with PCE advsertisement: +A router information example with PCE advsertisement::: -:: - - ! - router ospf - ospf router-id 192.168.1.1 - network 192.168.0.0/16 area 1 - capability opaque + ! + router ospf + ospf router-id 192.168.1.1 + network 192.168.0.0/16 area 1 + capability opaque mpls-te mpls-te router-address 192.168.1.1 - router-info area 0.0.0.1 + router-info area 0.0.0.1 pce address 192.168.1.1 pce flag 0x80 pce domain as 65400 pce neighbor as 65500 pce neighbor as 65200 pce scope 0x80 - ! - - + ! diff --git a/doc/user/protocol.rst b/doc/user/protocol.rst index 475b9c69b2..d37b073b16 100644 --- a/doc/user/protocol.rst +++ b/doc/user/protocol.rst @@ -7,34 +7,30 @@ Zebra Protocol Overview of the Zebra Protocol ============================== -Zebra Protocol is used by protocol daemons to communicate with the -zebra daemon. +Zebra Protocol is used by protocol daemons to communicate with the zebra +daemon. -Each protocol daemon may request and send information to and from the -zebra daemon such as interface states, routing state, -nexthop-validation, and so on. Protocol daemons may also install routes -with zebra. The zebra daemon manages which route is installed into the -forwarding table with the kernel. +Each protocol daemon may request and send information to and from the zebra +daemon such as interface states, routing state, nexthop-validation, and so on. +Protocol daemons may also install routes with zebra. The zebra daemon manages +which route is installed into the forwarding table with the kernel. -Zebra Protocol is a streaming protocol, with a common header. Two -versions of the header are in use. Version 0 is implicitely versioned. -Version 1 has an explicit version field. Version 0 can be distinguished -from all other versions by examining the 3rd byte of the header, which -contains a marker value for all versions bar version 0. The marker byte -corresponds to the command field in version 0, and the marker value is -a reserved command in version 0. +Zebra Protocol is a streaming protocol, with a common header. Two versions of +the header are in use. Version 0 is implicitely versioned. Version 1 has an +explicit version field. Version 0 can be distinguished from all other versions +by examining the 3rd byte of the header, which contains a marker value for all +versions bar version 0. The marker byte corresponds to the command field in +version 0, and the marker value is a reserved command in version 0. -We do not anticipate there will be further versions of the header for -the foreseeable future, as the command field in version 1 is wide -enough to allow for future extensions to done compatibly through -seperate commands. +We do not anticipate there will be further versions of the header for the +foreseeable future, as the command field in version 1 is wide enough to allow +for future extensions to done compatibly through seperate commands. -Version 0 is used by all versions of GNU Zebra as of this writing, and -versions of Quagga up to and including Quagga 0.98. Version 2 was created -for 0.99.21 of Quagga. Version 3 designates VRF compatibility and was -released in 1.0. Version 4 will be used as of FRR 2.0 to indicate that -we are a different Routing Suite now and to hopefully prevent accidental -Quagga <-> FRR issues. +Version 0 is used by all versions of GNU Zebra as of this writing, and versions +of Quagga up to and including Quagga 0.98. Version 2 was created for 0.99.21 of +Quagga. Version 3 designates VRF compatibility and was released in 1.0. +Version 4 will be used as of FRR 2.0 to indicate that we are a different +Routing Suite now and to hopefully prevent accidental Quagga <-> FRR issues. Zebra Protocol Definition ========================= @@ -44,11 +40,11 @@ Zebra Protocol Header (version 0) :: - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 - +-------------------------------+---------------+ - | Length (2) | Command (1) | - +-------------------------------+---------------+ + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-------------------------------+---------------+ + | Length (2) | Command (1) | + +-------------------------------+---------------+ Zebra Protocol Common Header (version 1) @@ -56,73 +52,71 @@ Zebra Protocol Common Header (version 1) :: - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 - +-------------------------------+---------------+-------------+ - | Length (2) | Marker (1) | Version (1) | - +-------------------------------+---------------+-------------+ - | Command (2) | - +-------------------------------+ + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-------------------------------+---------------+-------------+ + | Length (2) | Marker (1) | Version (1) | + +-------------------------------+---------------+-------------+ + | Command (2) | + +-------------------------------+ Zebra Protocol Header Field Definitions --------------------------------------- -@table @samp -@item Length -Total packet length including this header. The minimum length is 3 -bytes for version 0 messages and 6 bytes for version 1 messages. +Length + Total packet length including this header. The minimum length is 3 bytes for + version 0 messages and 6 bytes for version 1 messages. -@item Marker -Static marker with a value of 255 always. This is to allow version 0 -Zserv headers (which do not include version explicitely) to be -distinguished from versioned headers. Not present in version 0 -messages. +Marker + Static marker with a value of 255 always. This is to allow version 0 Zserv + headers (which do not include version explicitly) to be distinguished from + versioned headers. Not present in version 0 messages. -@item Version -Version number of the Zserv message. Clients should not continue -processing messages past the version field for versions they do not -recognise. Not present in version 0 messages. +Version + Version number of the Zserv message. Clients should not continue processing + messages past the version field for versions they do not recognise. Not + present in version 0 messages. + +Command + The Zebra Protocol command. -@item Command -The Zebra Protocol command. -@end table Zebra Protocol Commands ----------------------- -@multitable {ZEBRA_REDISTRIBUTE_DEFAULT_DELETE_WHATEVER} {99999} -@headitem Command @tab Value -@item ZEBRA_INTERFACE_ADD -@tab 1 -@item ZEBRA_INTERFACE_DELETE -@tab 2 -@item ZEBRA_INTERFACE_ADDRESS_ADD -@tab 3 -@item ZEBRA_INTERFACE_ADDRESS_DELETE -@tab 4 -@item ZEBRA_INTERFACE_UP -@tab 5 -@item ZEBRA_INTERFACE_DOWN -@tab 6 -@item ZEBRA_IPV4_ROUTE_ADD -@tab 7 -@item ZEBRA_IPV4_ROUTE_DELETE -@tab 8 -@item ZEBRA_IPV6_ROUTE_ADD -@tab 9 -@item ZEBRA_IPV6_ROUTE_DELETE -@tab 10 -@item ZEBRA_REDISTRIBUTE_ADD -@tab 11 -@item ZEBRA_REDISTRIBUTE_DELETE -@tab 12 -@item ZEBRA_REDISTRIBUTE_DEFAULT_ADD -@tab 13 -@item ZEBRA_REDISTRIBUTE_DEFAULT_DELETE -@tab 14 -@item ZEBRA_IPV4_NEXTHOP_LOOKUP -@tab 15 -@item ZEBRA_IPV6_NEXTHOP_LOOKUP -@tab 16 -@end multitable ++-----------------------------------+-------+ +| Command | Value | ++===================================+=======+ +| ZEBRA_INTERFACE_ADD | 1 | ++-----------------------------------+-------+ +| ZEBRA_INTERFACE_DELETE | 2 | ++-----------------------------------+-------+ +| ZEBRA_INTERFACE_ADDRESS_ADD | 3 | ++-----------------------------------+-------+ +| ZEBRA_INTERFACE_ADDRESS_DELETE | 4 | ++-----------------------------------+-------+ +| ZEBRA_INTERFACE_UP | 5 | ++-----------------------------------+-------+ +| ZEBRA_INTERFACE_DOWN | 6 | ++-----------------------------------+-------+ +| ZEBRA_IPV4_ROUTE_ADD | 7 | ++-----------------------------------+-------+ +| ZEBRA_IPV4_ROUTE_DELETE | 8 | ++-----------------------------------+-------+ +| ZEBRA_IPV6_ROUTE_ADD | 9 | ++-----------------------------------+-------+ +| ZEBRA_IPV6_ROUTE_DELETE | 10 | ++-----------------------------------+-------+ +| ZEBRA_REDISTRIBUTE_ADD | 11 | ++-----------------------------------+-------+ +| ZEBRA_REDISTRIBUTE_DELETE | 12 | ++-----------------------------------+-------+ +| ZEBRA_REDISTRIBUTE_DEFAULT_ADD | 13 | ++-----------------------------------+-------+ +| ZEBRA_REDISTRIBUTE_DEFAULT_DELETE | 14 | ++-----------------------------------+-------+ +| ZEBRA_IPV4_NEXTHOP_LOOKUP | 15 | ++-----------------------------------+-------+ +| ZEBRA_IPV6_NEXTHOP_LOOKUP | 16 | ++-----------------------------------+-------+ diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index e28d215c6b..d456c30af6 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -5,11 +5,11 @@ RIP *** RIP -- Routing Information Protocol is widely deployed interior gateway -protocol. RIP was developed in the 1970s at Xerox Labs as part of the -XNS routing protocol. RIP is a :term:`distance-vector` protocol and is -based on the :term:`Bellman-Ford` algorithms. As a distance-vector +protocol. RIP was developed in the 1970s at Xerox Labs as part of the +XNS routing protocol. RIP is a :term:`distance-vector` protocol and is +based on the :term:`Bellman-Ford` algorithms. As a distance-vector protocol, RIP router send updates to its neighbors periodically, thus -allowing the convergence to a known topology. In each update, the +allowing the convergence to a known topology. In each update, the distance to any given network will be broadcasted to its neighboring router. @@ -21,17 +21,15 @@ version 1 as described in RFC1058. Starting and Stopping ripd ========================== -The default configuration file name of *ripd*'s is -:file:`ripd.conf`. When invocation *ripd* searches directory -|INSTALL_PREFIX_ETC|. If :file:`ripd.conf` is not there next -search current directory. +The default configuration file name of *ripd*'s is :file:`ripd.conf`. When +invocation *ripd* searches directory |INSTALL_PREFIX_ETC|. If :file:`ripd.conf` +is not there next search current directory. -RIP uses UDP port 520 to send and receive RIP packets. So the user must have -the capability to bind the port, generally this means that the user must -have superuser privileges. RIP protocol requires interface information -maintained by *zebra* daemon. So running *zebra* -is mandatory to run *ripd*. Thus minimum sequence for running -RIP is like below: +RIP uses UDP port 520 to send and receive RIP packets. So the user must have +the capability to bind the port, generally this means that the user must have +superuser privileges. RIP protocol requires interface information maintained by +*zebra* daemon. So running *zebra* is mandatory to run *ripd*. Thus minimum +sequence for running RIP is like below: :: @@ -41,8 +39,10 @@ RIP is like below: Please note that *zebra* must be invoked before *ripd*. -To stop *ripd*. Please use @command{kill `cat -/var/run/ripd.pid`}. Certain signals have special meaningss to *ripd*. +To stop *ripd*. Please use:: + kill `cat /var/run/ripd.pid` + +Certain signals have special meaningss to *ripd*. +-------------+------------------------------------------------------+ | Signal | Action | @@ -57,7 +57,7 @@ To stop *ripd*. Please use @command{kill `cat | ``SIGTERM`` | Sweep all installed routes and gracefully terminate. | +-------------+------------------------------------------------------+ -*ripd* invocation options. Common options that can be specified +*ripd* invocation options. Common options that can be specified (:ref:`Common_Invocation_Options`). .. option:: -r @@ -70,278 +70,270 @@ To stop *ripd*. Please use @command{kill `cat RIP netmask ----------- -The netmask features of *ripd* support both version 1 and version 2 of -RIP. Version 1 of RIP originally contained no netmask information. In -RIP version 1, network classes were originally used to determine the -size of the netmask. Class A networks use 8 bits of mask, Class B -networks use 16 bits of masks, while Class C networks use 24 bits of -mask. Today, the most widely used method of a network mask is assigned -to the packet on the basis of the interface that received the packet. -Version 2 of RIP supports a variable length subnet mask (VLSM). By -extending the subnet mask, the mask can be divided and reused. Each -subnet can be used for different purposes such as large to middle size -LANs and WAN links. FRR *ripd* does not support the non-sequential -netmasks that are included in RIP Version 2. +The netmask features of *ripd* support both version 1 and version 2 of RIP. +Version 1 of RIP originally contained no netmask information. In RIP version 1, +network classes were originally used to determine the size of the netmask. +Class A networks use 8 bits of mask, Class B networks use 16 bits of masks, +while Class C networks use 24 bits of mask. Today, the most widely used method +of a network mask is assigned to the packet on the basis of the interface that +received the packet. Version 2 of RIP supports a variable length subnet mask +(VLSM). By extending the subnet mask, the mask can be divided and reused. Each +subnet can be used for different purposes such as large to middle size LANs and +WAN links. FRR *ripd* does not support the non-sequential netmasks that are +included in RIP Version 2. -In a case of similar information with the same prefix and metric, the -old information will be suppressed. Ripd does not currently support -equal cost multipath routing. +In a case of similar information with the same prefix and metric, the old +information will be suppressed. Ripd does not currently support equal cost +multipath routing. .. _RIP_Configuration: RIP Configuration ================= -.. index:: Command {router rip} {} +.. index:: router rip +.. clicmd:: router rip -Command {router rip} {} - The `router rip` command is necessary to enable RIP. To disable - RIP, use the `no router rip` command. RIP must be enabled before - carrying out any of the RIP commands. + The `router rip` command is necessary to enable RIP. To disable RIP, use the + `no router rip` command. RIP must be enabled before carrying out any of the + RIP commands. -.. index:: Command {no router rip} {} +.. index:: no router rip +.. clicmd:: no router rip -Command {no router rip} {} - Disable RIP. + Disable RIP. -.. index:: {RIP Command} {network `network`} {} +.. index:: network NETWORK +.. clicmd:: network NETWORK -{RIP Command} {network `network`} {} -.. index:: {RIP Command} {no network `network`} {} +.. index:: no network NETWORK +.. clicmd:: no network NETWORK -{RIP Command} {no network `network`} {} - Set the RIP enable interface by `network`. The interfaces which - have addresses matching with `network` are enabled. + Set the RIP enable interface by NETWORK. The interfaces which have addresses + matching with NETWORK are enabled. - This group of commands either enables or disables RIP interfaces between - certain numbers of a specified network address. For example, if the - network for 10.0.0.0/24 is RIP enabled, this would result in all the - addresses from 10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will disable RIP for the specified network. + This group of commands either enables or disables RIP interfaces between + certain numbers of a specified network address. For example, if the network + for 10.0.0.0/24 is RIP enabled, this would result in all the addresses from + 10.0.0.0 to 10.0.0.255 being enabled for RIP. The `no network` command will + disable RIP for the specified network. -.. index:: {RIP Command} {network `ifname`} {} +.. index:: network IFNAME +.. clicmd:: network IFNAME -{RIP Command} {network `ifname`} {} -.. index:: {RIP Command} {no network `ifname`} {} +.. index:: no network IFNAME +.. clicmd:: no network IFNAME -{RIP Command} {no network `ifname`} {} - Set a RIP enabled interface by `ifname`. Both the sending and - receiving of RIP packets will be enabled on the port specified in the - `network ifname` command. The `no network ifname` command will disable - RIP on the specified interface. + Set a RIP enabled interface by IFNAME. Both the sending and + receiving of RIP packets will be enabled on the port specified in the + `network ifname` command. The `no network ifname` command will disable + RIP on the specified interface. -.. index:: {RIP Command} {neighbor `a.b.c.d`} {} +.. index:: neighbor A.B.C.D +.. clicmd:: neighbor A.B.C.D -{RIP Command} {neighbor `a.b.c.d`} {} -.. index:: {RIP Command} {no neighbor `a.b.c.d`} {} +.. index:: no neighbor A.B.C.D +.. clicmd:: no neighbor A.B.C.D -{RIP Command} {no neighbor `a.b.c.d`} {} - Specify RIP neighbor. When a neighbor doesn't understand multicast, - this command is used to specify neighbors. In some cases, not all - routers will be able to understand multicasting, where packets are sent - to a network or a group of addresses. In a situation where a neighbor - cannot process multicast packets, it is necessary to establish a direct - link between routers. The neighbor command allows the network - administrator to specify a router as a RIP neighbor. The `no neighbor a.b.c.d` command will disable the RIP neighbor. + Specify RIP neighbor. When a neighbor doesn't understand multicast, this + command is used to specify neighbors. In some cases, not all routers will be + able to understand multicasting, where packets are sent to a network or a + group of addresses. In a situation where a neighbor cannot process multicast + packets, it is necessary to establish a direct link between routers. The + neighbor command allows the network administrator to specify a router as a + RIP neighbor. The `no neighbor a.b.c.d` command will disable the RIP + neighbor. - Below is very simple RIP configuration. Interface `eth0` and - interface which address match to `10.0.0.0/8` are RIP enabled. + Below is very simple RIP configuration. Interface `eth0` and interface which + address match to `10.0.0.0/8` are RIP enabled. -:: + :: - ! - router rip - network 10.0.0.0/8 - network eth0 - ! + ! + router rip + network 10.0.0.0/8 + network eth0 + ! - Passive interface +.. index:: passive-interface (IFNAME|default) +.. clicmd:: passive-interface (IFNAME|default) -.. index:: {RIP command} {passive-interface (`IFNAME`|default)} {} +.. index:: no passive-interface IFNAME +.. clicmd:: no passive-interface IFNAME -{RIP command} {passive-interface (`IFNAME`|default)} {} -.. index:: {RIP command} {no passive-interface `IFNAME`} {} + This command sets the specified interface to passive mode. On passive mode + interface, all receiving packets are processed as normal and ripd does not + send either multicast or unicast RIP packets except to RIP neighbors + specified with `neighbor` command. The interface may be specified as + `default` to make ripd default to passive on all interfaces. -{RIP command} {no passive-interface `IFNAME`} {} - This command sets the specified interface to passive mode. On passive mode - interface, all receiving packets are processed as normal and ripd does - not send either multicast or unicast RIP packets except to RIP neighbors - specified with `neighbor` command. The interface may be specified - as `default` to make ripd default to passive on all interfaces. + The default is to be passive on all interfaces. - The default is to be passive on all interfaces. +.. index:: ip split-horizon +.. clicmd:: ip split-horizon - RIP split-horizon +.. index:: no ip split-horizon +.. clicmd:: no ip split-horizon -.. index:: {Interface command} {ip split-horizon} {} - -{Interface command} {ip split-horizon} {} -.. index:: {Interface command} {no ip split-horizon} {} - -{Interface command} {no ip split-horizon} {} - Control split-horizon on the interface. Default is `ip split-horizon`. If you don't perform split-horizon on the interface, - please specify `no ip split-horizon`. + Control split-horizon on the interface. Default is `ip split-horizon`. If + you don't perform split-horizon on the interface, please specify `no ip + split-horizon`. .. _RIP_Version_Control: RIP Version Control =================== -RIP can be configured to send either Version 1 or Version 2 packets. -The default is to send RIPv2 while accepting both RIPv1 and RIPv2 (and -replying with packets of the appropriate version for REQUESTS / -triggered updates). The version to receive and send can be specified -globally, and further overriden on a per-interface basis if needs be -for send and receive seperately (see below). +RIP can be configured to send either Version 1 or Version 2 packets. The +default is to send RIPv2 while accepting both RIPv1 and RIPv2 (and replying +with packets of the appropriate version for REQUESTS / triggered updates). The +version to receive and send can be specified globally, and further overriden on +a per-interface basis if needs be for send and receive seperately (see below). -It is important to note that RIPv1 can not be authenticated. Further, -if RIPv1 is enabled then RIP will reply to REQUEST packets, sending the -state of its RIP routing table to any remote routers that ask on -demand. For a more detailed discussion on the security implications of -RIPv1 see :ref:`RIP_Authentication`. +It is important to note that RIPv1 cannot be authenticated. Further, if RIPv1 +is enabled then RIP will reply to REQUEST packets, sending the state of its RIP +routing table to any remote routers that ask on demand. For a more detailed +discussion on the security implications of RIPv1 see :ref:`RIP_Authentication`. -.. index:: {RIP Command} {version `version`} {} +.. index:: version VERSION +.. clicmd:: version VERSION -{RIP Command} {version `version`} {} - Set RIP version to accept for reads and send. `version` - can be either `1'' or `2''. + Set RIP version to accept for reads and send. ``VERSION`` can be either 1 or + 1. - Disabling RIPv1 by specifying version 2 is STRONGLY encouraged, - :ref:`RIP_Authentication`. This may become the default in a future - release. + Disabling RIPv1 by specifying version 2 is STRONGLY encouraged, + :ref:`RIP_Authentication`. This may become the default in a future release. - Default: Send Version 2, and accept either version. + Default: Send Version 2, and accept either version. -.. index:: {RIP Command} {no version} {} +.. index:: no version +.. clicmd:: no version -{RIP Command} {no version} {} - Reset the global version setting back to the default. + Reset the global version setting back to the default. -.. index:: {Interface command} {ip rip send version `version`} {} +.. index:: ip rip send version VERSION +.. clicmd:: ip rip send version VERSION -{Interface command} {ip rip send version `version`} {} - `version` can be `1', `2' or `1 2'. + VERSION can be ``1``, ``2``, or ``1 2``. - This interface command overrides the global rip version setting, and - selects which version of RIP to send packets with, for this interface - specifically. Choice of RIP Version 1, RIP Version 2, or both versions. - In the latter case, where `1 2' is specified, packets will be both - broadcast and multicast. + This interface command overrides the global rip version setting, and selects + which version of RIP to send packets with, for this interface specifically. + Choice of RIP Version 1, RIP Version 2, or both versions. In the latter + case, where ``1 2`` is specified, packets will be both broadcast and + multicast. - Default: Send packets according to the global version (version 2) + Default: Send packets according to the global version (version 2) -.. index:: {Interface command} {ip rip receive version `version`} {} +.. index:: ip rip receive version VERSION +.. clicmd:: ip rip receive version VERSION -{Interface command} {ip rip receive version `version`} {} - `version` can be `1', `2' or `1 2'. + VERSION can be ``1``, ``2``, or ``1 2``. - This interface command overrides the global rip version setting, and - selects which versions of RIP packets will be accepted on this - interface. Choice of RIP Version 1, RIP Version 2, or both. + This interface command overrides the global rip version setting, and selects + which versions of RIP packets will be accepted on this interface. Choice of + RIP Version 1, RIP Version 2, or both. - Default: Accept packets according to the global setting (both 1 and 2). + Default: Accept packets according to the global setting (both 1 and 2). .. _How_to_Announce_RIP_route: How to Announce RIP route ========================= -.. index:: {RIP command} {redistribute kernel} {} +.. index:: redistribute kernel +.. clicmd:: redistribute kernel -{RIP command} {redistribute kernel} {} -.. index:: {RIP command} {redistribute kernel metric (0-16)} {} +.. index:: redistribute kernel metric (0-16) +.. clicmd:: redistribute kernel metric (0-16) -{RIP command} {redistribute kernel metric (0-16)} {} -.. index:: {RIP command} {redistribute kernel route-map `route-map`} {} +.. index:: redistribute kernel route-map ROUTE-MAP +.. clicmd:: redistribute kernel route-map ROUTE-MAP -{RIP command} {redistribute kernel route-map `route-map`} {} -.. index:: {RIP command} {no redistribute kernel} {} +.. index:: no redistribute kernel +.. clicmd:: no redistribute kernel -{RIP command} {no redistribute kernel} {} - `redistribute kernel` redistributes routing information from - kernel route entries into the RIP tables. `no redistribute kernel` - disables the routes. + `redistribute kernel` redistributes routing information from kernel route + entries into the RIP tables. `no redistribute kernel` disables the routes. -.. index:: {RIP command} {redistribute static} {} +.. index:: redistribute static +.. clicmd:: redistribute static -{RIP command} {redistribute static} {} -.. index:: {RIP command} {redistribute static metric (0-16)} {} +.. index:: redistribute static metric (0-16) +.. clicmd:: redistribute static metric (0-16) -{RIP command} {redistribute static metric (0-16)} {} -.. index:: {RIP command} {redistribute static route-map `route-map`} {} +.. index:: redistribute static route-map ROUTE-MAP +.. clicmd:: redistribute static route-map ROUTE-MAP -{RIP command} {redistribute static route-map `route-map`} {} -.. index:: {RIP command} {no redistribute static} {} +.. index:: no redistribute static +.. clicmd:: no redistribute static -{RIP command} {no redistribute static} {} - `redistribute static` redistributes routing information from - static route entries into the RIP tables. `no redistribute static` - disables the routes. + `redistribute static` redistributes routing information from static route + entries into the RIP tables. `no redistribute static` disables the routes. -.. index:: {RIP command} {redistribute connected} {} +.. index:: redistribute connected +.. clicmd:: redistribute connected -{RIP command} {redistribute connected} {} -.. index:: {RIP command} {redistribute connected metric (0-16)} {} +.. index:: redistribute connected metric (0-16) +.. clicmd:: redistribute connected metric (0-16) -{RIP command} {redistribute connected metric (0-16)} {} -.. index:: {RIP command} {redistribute connected route-map `route-map`} {} +.. index:: redistribute connected route-map ROUTE-MAP +.. clicmd:: redistribute connected route-map ROUTE-MAP -{RIP command} {redistribute connected route-map `route-map`} {} -.. index:: {RIP command} {no redistribute connected} {} +.. index:: no redistribute connected +.. clicmd:: no redistribute connected -{RIP command} {no redistribute connected} {} - Redistribute connected routes into the RIP tables. `no redistribute connected` disables the connected routes in the RIP tables. - This command redistribute connected of the interface which RIP disabled. - The connected route on RIP enabled interface is announced by default. + Redistribute connected routes into the RIP tables. `no redistribute + connected` disables the connected routes in the RIP tables. This command + redistribute connected of the interface which RIP disabled. The connected + route on RIP enabled interface is announced by default. -.. index:: {RIP command} {redistribute ospf} {} +.. index:: redistribute ospf +.. clicmd:: redistribute ospf -{RIP command} {redistribute ospf} {} -.. index:: {RIP command} {redistribute ospf metric (0-16)} {} +.. index:: redistribute ospf metric (0-16) +.. clicmd:: redistribute ospf metric (0-16) -{RIP command} {redistribute ospf metric (0-16)} {} -.. index:: {RIP command} {redistribute ospf route-map `route-map`} {} +.. index:: redistribute ospf route-map ROUTE-MAP +.. clicmd:: redistribute ospf route-map ROUTE-MAP -{RIP command} {redistribute ospf route-map `route-map`} {} -.. index:: {RIP command} {no redistribute ospf} {} +.. index:: no redistribute ospf +.. clicmd:: no redistribute ospf -{RIP command} {no redistribute ospf} {} - `redistribute ospf` redistributes routing information from - ospf route entries into the RIP tables. `no redistribute ospf` - disables the routes. + `redistribute ospf` redistributes routing information from ospf route + entries into the RIP tables. `no redistribute ospf` disables the routes. -.. index:: {RIP command} {redistribute bgp} {} +.. index:: redistribute bgp +.. clicmd:: redistribute bgp -{RIP command} {redistribute bgp} {} -.. index:: {RIP command} {redistribute bgp metric (0-16)} {} +.. index:: redistribute bgp metric (0-16) +.. clicmd:: redistribute bgp metric (0-16) -{RIP command} {redistribute bgp metric (0-16)} {} -.. index:: {RIP command} {redistribute bgp route-map `route-map`} {} +.. index:: redistribute bgp route-map ROUTE-MAP +.. clicmd:: redistribute bgp route-map ROUTE-MAP -{RIP command} {redistribute bgp route-map `route-map`} {} -.. index:: {RIP command} {no redistribute bgp} {} +.. index:: no redistribute bgp +.. clicmd:: no redistribute bgp -{RIP command} {no redistribute bgp} {} - `redistribute bgp` redistributes routing information from - bgp route entries into the RIP tables. `no redistribute bgp` - disables the routes. + `redistribute bgp` redistributes routing information from bgp route entries + into the RIP tables. `no redistribute bgp` disables the routes. - If you want to specify RIP only static routes: + If you want to specify RIP only static routes: -.. index:: {RIP command} {default-information originate} {} +.. index:: default-information originate +.. clicmd:: default-information originate -{RIP command} {default-information originate} {} -.. index:: {RIP command} {route `a.b.c.d/m`} {} +.. index:: route A.B.C.D/M +.. clicmd:: route A.B.C.D/M -{RIP command} {route `a.b.c.d/m`} {} -.. index:: {RIP command} {no route `a.b.c.d/m`} {} +.. index:: no route A.B.C.D/M +.. clicmd:: no route A.B.C.D/M -{RIP command} {no route `a.b.c.d/m`} {} - This command is specific to FRR. The `route` command makes a static - route only inside RIP. This command should be used only by advanced - users who are particularly knowledgeable about the RIP protocol. In - most cases, we recommend creating a static route in FRR and - redistributing it in RIP using `redistribute static`. + This command is specific to FRR. The `route` command makes a static route + only inside RIP. This command should be used only by advanced users who are + particularly knowledgeable about the RIP protocol. In most cases, we + recommend creating a static route in FRR and redistributing it in RIP using + `redistribute static`. .. _Filtering_RIP_Routes: @@ -350,103 +342,100 @@ Filtering RIP Routes RIP routes can be filtered by a distribute-list. -.. index:: Command {distribute-list `access_list` `direct` `ifname`} {} +.. index:: distribute-list ACCESS_LIST DIRECT IFNAME +.. clicmd:: distribute-list ACCESS_LIST DIRECT IFNAME -Command {distribute-list `access_list` `direct` `ifname`} {} - You can apply access lists to the interface with a `distribute-list` - command. `access_list` is the access list name. `direct` is - ``in`` or ``out``. If `direct` is ``in`` the access list - is applied to input packets. + You can apply access lists to the interface with a `distribute-list` command. + ACCESS_LIST is the access list name. DIRECT is ``in`` or ``out``. If DIRECT + is ``in`` the access list is applied to input packets. - The `distribute-list` command can be used to filter the RIP path. - `distribute-list` can apply access-lists to a chosen interface. - First, one should specify the access-list. Next, the name of the - access-list is used in the distribute-list command. For example, in the - following configuration ``eth0`` will permit only the paths that - match the route 10.0.0.0/8 + The `distribute-list` command can be used to filter the RIP path. + `distribute-list` can apply access-lists to a chosen interface. First, one + should specify the access-list. Next, the name of the access-list is used in + the distribute-list command. For example, in the following configuration + ``eth0`` will permit only the paths that match the route 10.0.0.0/8 -:: + :: - ! - router rip - distribute-list private in eth0 - ! - access-list private permit 10 10.0.0.0/8 - access-list private deny any - ! + ! + router rip + distribute-list private in eth0 + ! + access-list private permit 10 10.0.0.0/8 + access-list private deny any + ! -`distribute-list` can be applied to both incoming and outgoing data. + `distribute-list` can be applied to both incoming and outgoing data. -.. index:: Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {} +.. index:: distribute-list prefix PREFIX_LIST (in|out) IFNAME +.. clicmd:: distribute-list prefix PREFIX_LIST (in|out) IFNAME -Command {distribute-list prefix `prefix_list` (in|out) `ifname`} {} - You can apply prefix lists to the interface with a - `distribute-list` command. `prefix_list` is the prefix list - name. Next is the direction of ``in`` or ``out``. If - `direct` is ``in`` the access list is applied to input packets. + You can apply prefix lists to the interface with a `distribute-list` + command. PREFIX_LIST is the prefix list name. Next is the direction of + ``in`` or ``out``. If DIRECT is ``in`` the access list is applied to input + packets. .. _RIP_Metric_Manipulation: RIP Metric Manipulation ======================= -RIP metric is a value for distance for the network. Usually +RIP metric is a value for distance for the network. Usually *ripd* increment the metric when the network information is -received. Redistributed routes' metric is set to 1. +received. Redistributed routes' metric is set to 1. -.. index:: {RIP command} {default-metric (1-16)} {} +.. index:: default-metric (1-16) +.. clicmd:: default-metric (1-16) -{RIP command} {default-metric (1-16)} {} -.. index:: {RIP command} {no default-metric (1-16)} {} +.. index:: no default-metric (1-16) +.. clicmd:: no default-metric (1-16) -{RIP command} {no default-metric (1-16)} {} - This command modifies the default metric value for redistributed routes. The - default value is 1. This command does not affect connected route - even if it is redistributed by *redistribute connected*. To modify - connected route's metric value, please use @command{redistribute - connected metric} or *route-map*. *offset-list* also - affects connected routes. + This command modifies the default metric value for redistributed routes. + The default value is 1. This command does not affect connected route even if + it is redistributed by *redistribute connected*. To modify connected route's + metric value, please use ``redistribute connected metric`` or *route-map*. + *offset-list* also affects connected routes. -.. index:: {RIP command} {offset-list `access-list` (in|out)} {} +.. index:: offset-list ACCESS-LIST (in|out) +.. clicmd:: offset-list ACCESS-LIST (in|out) -{RIP command} {offset-list `access-list` (in|out)} {} -.. index:: {RIP command} {offset-list `access-list` (in|out) `ifname`} {} +.. index:: offset-list ACCESS-LIST (in|out) IFNAME +.. clicmd:: offset-list ACCESS-LIST (in|out) IFNAME -{RIP command} {offset-list `access-list` (in|out) `ifname`} {} .. _RIP_distance: RIP distance ============ -Distance value is used in zebra daemon. Default RIP distance is 120. +Distance value is used in zebra daemon. Default RIP distance is 120. -.. index:: {RIP command} {distance (1-255)} {} +.. index:: distance (1-255) +.. clicmd:: distance (1-255) -{RIP command} {distance (1-255)} {} -.. index:: {RIP command} {no distance (1-255)} {} +.. index:: no distance (1-255) +.. clicmd:: no distance (1-255) -{RIP command} {no distance (1-255)} {} - Set default RIP distance to specified value. + Set default RIP distance to specified value. -.. index:: {RIP command} {distance (1-255) `A.B.C.D/M`} {} +.. index:: distance (1-255) A.B.C.D/M +.. clicmd:: distance (1-255) A.B.C.D/M -{RIP command} {distance (1-255) `A.B.C.D/M`} {} -.. index:: {RIP command} {no distance (1-255) `A.B.C.D/M`} {} +.. index:: no distance (1-255) A.B.C.D/M +.. clicmd:: no distance (1-255) A.B.C.D/M -{RIP command} {no distance (1-255) `A.B.C.D/M`} {} - Set default RIP distance to specified value when the route's source IP - address matches the specified prefix. + Set default RIP distance to specified value when the route's source IP + address matches the specified prefix. -.. index:: {RIP command} {distance (1-255) `A.B.C.D/M` `access-list`} {} +.. index:: distance (1-255) A.B.C.D/M ACCESS-LIST +.. clicmd:: distance (1-255) A.B.C.D/M ACCESS-LIST -{RIP command} {distance (1-255) `A.B.C.D/M` `access-list`} {} -.. index:: {RIP command} {no distance (1-255) `A.B.C.D/M` `access-list`} {} +.. index:: no distance (1-255) A.B.C.D/M ACCESS-LIST +.. clicmd:: no distance (1-255) A.B.C.D/M ACCESS-LIST -{RIP command} {no distance (1-255) `A.B.C.D/M` `access-list`} {} - Set default RIP distance to specified value when the route's source IP - address matches the specified prefix and the specified access-list. + Set default RIP distance to specified value when the route's source IP + address matches the specified prefix and the specified access-list. .. _RIP_route-map: @@ -465,64 +454,63 @@ statement. ..... -Cisco applies route-map _before_ routes will exported to rip route table. -In current FRR's test implementation, *ripd* applies route-map -after routes are listed in the route table and before routes will be -announced to an interface (something like output filter). I think it is not -so clear, but it is draft and it may be changed at future. +Cisco applies route-map _before_ routes will exported to rip route table. In +current FRR's test implementation, *ripd* applies route-map after routes are +listed in the route table and before routes will be announced to an interface +(something like output filter). I think it is not so clear, but it is draft and +it may be changed at future. Route-map statement (:ref:`Route_Map`) is needed to use route-map functionality. -.. index:: {Route Map} {match interface `word`} {} +.. index:: match interface WORD +.. clicmd:: match interface WORD -{Route Map} {match interface `word`} {} - This command match to incoming interface. Notation of this match is - different from Cisco. Cisco uses a list of interfaces - NAME1 NAME2 - ... NAMEN. Ripd allows only one name (maybe will change in the - future). Next - Cisco means interface which includes next-hop of - routes (it is somewhat similar to "ip next-hop" statement). Ripd - means interface where this route will be sent. This difference is - because "next-hop" of same routes which sends to different interfaces - must be different. Maybe it'd be better to made new matches - say - "match interface-out NAME" or something like that. + This command match to incoming interface. Notation of this match is + different from Cisco. Cisco uses a list of interfaces - NAME1 NAME2 ... + NAMEN. Ripd allows only one name (maybe will change in the future). Next - + Cisco means interface which includes next-hop of routes (it is somewhat + similar to "ip next-hop" statement). Ripd means interface where this route + will be sent. This difference is because "next-hop" of same routes which + sends to different interfaces must be different. Maybe it'd be better to + made new matches - say "match interface-out NAME" or something like that. -.. index:: {Route Map} {match ip address `word`} {} +.. index:: match ip address WORD +.. clicmd:: match ip address WORD -{Route Map} {match ip address `word`} {} -.. index:: {Route Map} {match ip address prefix-list `word`} {} +.. index:: match ip address prefix-list WORD +.. clicmd:: match ip address prefix-list WORD -{Route Map} {match ip address prefix-list `word`} {} - Match if route destination is permitted by access-list. + Match if route destination is permitted by access-list. -.. index:: {Route Map} {match ip next-hop `word`} {} +.. index:: match ip next-hop WORD +.. clicmd:: match ip next-hop WORD -{Route Map} {match ip next-hop `word`} {} -.. index:: {Route Map} {match ip next-hop prefix-list `word`} {} +.. index:: match ip next-hop prefix-list WORD +.. clicmd:: match ip next-hop prefix-list WORD -{Route Map} {match ip next-hop prefix-list `word`} {} - Match if route next-hop (meaning next-hop listed in the rip route-table - as displayed by "show ip rip") is permitted by access-list. + Match if route next-hop (meaning next-hop listed in the rip route-table as + displayed by "show ip rip") is permitted by access-list. -.. index:: {Route Map} {match metric (0-4294967295)} {} +.. index:: match metric (0-4294967295) +.. clicmd:: match metric (0-4294967295) -{Route Map} {match metric (0-4294967295)} {} - This command match to the metric value of RIP updates. For other - protocol compatibility metric range is shown as (0-4294967295). But - for RIP protocol only the value range (0-16) make sense. + This command match to the metric value of RIP updates. For other protocol + compatibility metric range is shown as (0-4294967295). But for RIP protocol + only the value range (0-16) make sense. -.. index:: {Route Map} {set ip next-hop A.B.C.D} {} +.. index:: set ip next-hop A.B.C.D +.. clicmd:: set ip next-hop A.B.C.D -{Route Map} {set ip next-hop A.B.C.D} {} - This command set next hop value in RIPv2 protocol. This command does - not affect RIPv1 because there is no next hop field in the packet. + This command set next hop value in RIPv2 protocol. This command does not + affect RIPv1 because there is no next hop field in the packet. -.. index:: {Route Map} {set metric (0-4294967295)} {} +.. index:: set metric (0-4294967295) +.. clicmd:: set metric (0-4294967295) -{Route Map} {set metric (0-4294967295)} {} - Set a metric for matched route when sending announcement. The metric - value range is very large for compatibility with other protocols. For - RIP, valid metric values are from 1 to 16. + Set a metric for matched route when sending announcement. The metric value + range is very large for compatibility with other protocols. For RIP, valid + metric values are from 1 to 16. .. _RIP_Authentication: @@ -552,50 +540,50 @@ on the internet, via RIPv1. To prevent such unauthenticated querying of routes disable RIPv1, :ref:`RIP_Version_Control`. -.. index:: {Interface command} {ip rip authentication mode md5} {} +.. index:: ip rip authentication mode md5 +.. clicmd:: ip rip authentication mode md5 -{Interface command} {ip rip authentication mode md5} {} -.. index:: {Interface command} {no ip rip authentication mode md5} {} +.. index:: no ip rip authentication mode md5 +.. clicmd:: no ip rip authentication mode md5 -{Interface command} {no ip rip authentication mode md5} {} - Set the interface with RIPv2 MD5 authentication. + Set the interface with RIPv2 MD5 authentication. -.. index:: {Interface command} {ip rip authentication mode text} {} +.. index:: ip rip authentication mode text +.. clicmd:: ip rip authentication mode text -{Interface command} {ip rip authentication mode text} {} -.. index:: {Interface command} {no ip rip authentication mode text} {} +.. index:: no ip rip authentication mode text +.. clicmd:: no ip rip authentication mode text -{Interface command} {no ip rip authentication mode text} {} - Set the interface with RIPv2 simple password authentication. + Set the interface with RIPv2 simple password authentication. -.. index:: {Interface command} {ip rip authentication string `string`} {} +.. index:: ip rip authentication string STRING +.. clicmd:: ip rip authentication string STRING -{Interface command} {ip rip authentication string `string`} {} -.. index:: {Interface command} {no ip rip authentication string `string`} {} +.. index:: no ip rip authentication string STRING +.. clicmd:: no ip rip authentication string STRING -{Interface command} {no ip rip authentication string `string`} {} - RIP version 2 has simple text authentication. This command sets - authentication string. The string must be shorter than 16 characters. + RIP version 2 has simple text authentication. This command sets + authentication string. The string must be shorter than 16 characters. -.. index:: {Interface command} {ip rip authentication key-chain `key-chain`} {} +.. index:: ip rip authentication key-chain KEY-CHAIN +.. clicmd:: ip rip authentication key-chain KEY-CHAIN -{Interface command} {ip rip authentication key-chain `key-chain`} {} -.. index:: {Interface command} {no ip rip authentication key-chain `key-chain`} {} +.. index:: no ip rip authentication key-chain KEY-CHAIN +.. clicmd:: no ip rip authentication key-chain KEY-CHAIN -{Interface command} {no ip rip authentication key-chain `key-chain`} {} - Specifiy Keyed MD5 chain. + Specifiy Keyed MD5 chain. :: - ! - key chain test - key 1 - key-string test - ! - interface eth1 - ip rip authentication mode md5 - ip rip authentication key-chain test - ! + ! + key chain test + key 1 + key-string test + ! + interface eth1 + ip rip authentication mode md5 + ip rip authentication key-chain test + ! .. _RIP_Timers: @@ -603,43 +591,34 @@ To prevent such unauthenticated querying of routes disable RIPv1, RIP Timers ========== -.. index:: {RIP command} {timers basic `update` `timeout` `garbage`} {} - -{RIP command} {timers basic `update` `timeout` `garbage`} {} - - RIP protocol has several timers. User can configure those timers' values - by `timers basic` command. - - The default settings for the timers are as follows: +.. index:: timers basic UPDATE TIMEOUT GARBAGE +.. clicmd:: timers basic UPDATE TIMEOUT GARBAGE -`` - The update timer is 30 seconds. Every update timer seconds, the RIP - process is awakened to send an unsolicited Response message containing - the complete routing table to all neighboring RIP routers. + RIP protocol has several timers. User can configure those timers' values + by `timers basic` command. + The default settings for the timers are as follows: -`` - The timeout timer is 180 seconds. Upon expiration of the timeout, the - route is no longer valid; however, it is retained in the routing table - for a short time so that neighbors can be notified that the route has - been dropped. + - The update timer is 30 seconds. Every update timer seconds, the RIP + process is awakened to send an unsolicited Response message containing + the complete routing table to all neighboring RIP routers. + - The timeout timer is 180 seconds. Upon expiration of the timeout, the + route is no longer valid; however, it is retained in the routing table + for a short time so that neighbors can be notified that the route has + been dropped. + - The garbage collect timer is 120 seconds. Upon expiration of the + garbage-collection timer, the route is finally removed from the routing + table. + The ``timers basic`` command allows the the default values of the timers + listed above to be changed. -`` - The garbage collect timer is 120 seconds. Upon expiration of the - garbage-collection timer, the route is finally removed from the routing - table. +.. index:: no timers basic +.. clicmd:: no timers basic - - The `timers basic` command allows the the default values of the timers - listed above to be changed. - -.. index:: {RIP command} {no timers basic} {} - -{RIP command} {no timers basic} {} - The `no timers basic` command will reset the timers to the default - settings listed above. + The `no timers basic` command will reset the timers to the default settings + listed above. .. _Show_RIP_Information: @@ -648,41 +627,41 @@ Show RIP Information To display RIP routes. -.. index:: Command {show ip rip} {} +.. index:: show ip rip +.. clicmd:: show ip rip -Command {show ip rip} {} - Show RIP routes. + Show RIP routes. The command displays all RIP routes. For routes that are received through RIP, this command will display the time the packet was sent and -the tag information. This command will also display this information +the tag information. This command will also display this information for routes redistributed into RIP. -.. index:: Command {show ip rip status} {} +.. index:: show ip rip status +.. clicmd:: show ip rip status -Command {show ip rip status} {} - The command displays current RIP status. It includes RIP timer, - filtering, version, RIP enabled interface and RIP peer inforation. + The command displays current RIP status. It includes RIP timer, + filtering, version, RIP enabled interface and RIP peer inforation. :: - ripd> **show ip rip status** - Routing Protocol is "rip" - Sending updates every 30 seconds with +/-50%, next due in 35 seconds - Timeout after 180 seconds, garbage collect after 120 seconds - Outgoing update filter list for all interface is not set - Incoming update filter list for all interface is not set - Default redistribution metric is 1 - Redistributing: kernel connected - Default version control: send version 2, receive version 2 - Interface Send Recv - Routing for Networks: - eth0 - eth1 - 1.1.1.1 - 203.181.89.241 - Routing Information Sources: - Gateway BadPackets BadRoutes Distance Last Update + ripd> **show ip rip status** + Routing Protocol is "rip" + Sending updates every 30 seconds with +/-50%, next due in 35 seconds + Timeout after 180 seconds, garbage collect after 120 seconds + Outgoing update filter list for all interface is not set + Incoming update filter list for all interface is not set + Default redistribution metric is 1 + Redistributing: kernel connected + Default version control: send version 2, receive version 2 + Interface Send Recv + Routing for Networks: + eth0 + eth1 + 1.1.1.1 + 203.181.89.241 + Routing Information Sources: + Gateway BadPackets BadRoutes Distance Last Update RIP Debug Commands @@ -690,37 +669,27 @@ RIP Debug Commands Debug for RIP protocol. -.. index:: Command {debug rip events} {} +.. index:: debug rip events +.. clicmd:: debug rip events -Command {debug rip events} {} - Debug rip events. + Shows RIP events. Sending and receiving packets, timers, and changes in + interfaces are events shown with *ripd*. -`debug rip` will show RIP events. Sending and receiving -packets, timers, and changes in interfaces are events shown with *ripd*. +.. index:: debug rip packet +.. clicmd:: debug rip packet -.. index:: Command {debug rip packet} {} + Shows display detailed information about the RIP packets. The origin and + port number of the packet as well as a packet dump is shown. -Command {debug rip packet} {} - Debug rip packet. +.. index:: debug rip zebra +.. clicmd:: debug rip zebra -`debug rip packet` will display detailed information about the RIP -packets. The origin and port number of the packet as well as a packet -dump is shown. + This command will show the communication between *ripd* and *zebra*. The + main information will include addition and deletion of paths to the kernel + and the sending and receiving of interface information. -.. index:: Command {debug rip zebra} {} +.. index:: show debugging rip +.. clicmd:: show debugging rip -Command {debug rip zebra} {} - Debug rip between zebra communication. - -This command will show the communication between *ripd* and -*zebra*. The main information will include addition and deletion of -paths to the kernel and the sending and receiving of interface information. - -.. index:: Command {show debugging rip} {} - -Command {show debugging rip} {} - Display *ripd*'s debugging option. - -`show debugging rip` will show all information currently set for ripd -debug. + Shows all information currently set for ripd debug. diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst index 46b78eb197..ab3dcf9591 100644 --- a/doc/user/ripngd.rst +++ b/doc/user/ripngd.rst @@ -4,16 +4,16 @@ RIPng ***** -*ripngd* supports the RIPng protocol as described in RFC2080. It's an -IPv6 reincarnation of the RIP protocol. +*ripngd* supports the RIPng protocol as described in :rfc:`2080`. It's an IPv6 +reincarnation of the RIP protocol. .. _Invoking_ripngd: Invoking ripngd =============== -There are no `ripngd` specific invocation options. Common options -can be specified (:ref:`Common_Invocation_Options`). +There are no `ripngd` specific invocation options. Common options can be +specified (:ref:`Common_Invocation_Options`). .. _ripngd_Configuration: @@ -22,72 +22,68 @@ ripngd Configuration Currently ripngd supports the following commands: -.. index:: Command {router ripng} {} +.. index:: router ripng +.. clicmd:: router ripng -Command {router ripng} {} - Enable RIPng. + Enable RIPng. -.. index:: {RIPng Command} {flush_timer `time`} {} +.. index:: flush_timer TIME +.. clicmd:: flush_timer TIME -{RIPng Command} {flush_timer `time`} {} - Set flush timer. + Set flush timer. -.. index:: {RIPng Command} {network `network`} {} +.. index:: network NETWORK +.. clicmd:: network NETWORK -{RIPng Command} {network `network`} {} - Set RIPng enabled interface by `network` + Set RIPng enabled interface by NETWORK. -.. index:: {RIPng Command} {network `ifname`} {} +.. index:: network IFNAME +.. clicmd:: network IFNAME -{RIPng Command} {network `ifname`} {} - Set RIPng enabled interface by `ifname` + Set RIPng enabled interface by IFNAME. -.. index:: {RIPng Command} {route `network`} {} +.. index:: route NETWORK +.. clicmd:: route NETWORK -{RIPng Command} {route `network`} {} - Set RIPng static routing announcement of `network`. + Set RIPng static routing announcement of NETWORK. -.. index:: Command {router zebra} {} +.. index:: router zebra +.. clicmd:: router zebra -Command {router zebra} {} - This command is the default and does not appear in the configuration. - With this statement, RIPng routes go to the *zebra* daemon. + This command is the default and does not appear in the configuration. With + this statement, RIPng routes go to the *zebra* daemon. .. _ripngd_Terminal_Mode_Commands: ripngd Terminal Mode Commands ============================= -.. index:: Command {show ip ripng} {} +.. index:: show ip ripng +.. clicmd:: show ip ripng -Command {show ip ripng} {} +.. index:: show debugging ripng +.. clicmd:: show debugging ripng -.. index:: Command {show debugging ripng} {} +.. index:: debug ripng events +.. clicmd:: debug ripng events -Command {show debugging ripng} {} -.. index:: Command {debug ripng events} {} +.. index:: debug ripng packet +.. clicmd:: debug ripng packet -Command {debug ripng events} {} -.. index:: Command {debug ripng packet} {} +.. index:: debug ripng zebra +.. clicmd:: debug ripng zebra -Command {debug ripng packet} {} -.. index:: Command {debug ripng zebra} {} - -Command {debug ripng zebra} {} ripngd Filtering Commands ========================= -.. index:: Command {distribute-list `access_list` (in|out) `ifname`} {} +.. index:: distribute-list ACCESS_LIST (in|out) IFNAME +.. clicmd:: distribute-list ACCESS_LIST (in|out) IFNAME -Command {distribute-list `access_list` (in|out) `ifname`} {} - You can apply an access-list to the interface using the - `distribute-list` command. `access_list` is an access-list - name. `direct` is ``in`` or ``out``. If `direct` is - ``in``, the access-list is applied only to incoming packets. - -:: - - distribute-list local-only out sit1 + You can apply an access-list to the interface using the `distribute-list` + command. ACCESS_LIST is an access-list name. `direct` is ``in`` or + ``out``. If `direct` is ``in``, the access-list is applied only to incoming + packets.:: + distribute-list local-only out sit1 diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 3a3afb99fd..8422153f93 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -269,6 +269,6 @@ A simple example of a route-map: This means that if a route matches ip access-list number 10 it's local-preference value is set to 200. -See :ref:`BGP_Configuration_Examples` for examples of more sophisticated +See :ref:`bgp-configuration-examples` for examples of more sophisticated useage of route-maps, including of the ``call`` action. diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index 59cae088a1..059b936491 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -3,33 +3,26 @@ Prefix Origin Validation Using RPKI =================================== -Prefix Origin Validation allows BGP routers to verify if the origin AS of -an IP prefix is legitimate to announce this IP prefix. The required -attestation objects are stored in the Resource Public Key Infrastructure -(:abbr:`RPKI`). However, RPKI-enabled routers do not store cryptographic -data itself but only validation information. The validation of the -cryptographic data (so called Route Origin Authorization, or short -:abbr:`ROA`, objects) will be performed by trusted cache servers. The -RPKI/RTR protocol defines a standard mechanism to maintain the exchange of -the prefix/origin AS mapping between the cache server and routers. -In combination with a BGP Prefix Origin Validation scheme a router is able -to verify received BGP updates without suffering from cryptographic -complexity. +Prefix Origin Validation allows BGP routers to verify if the origin AS of an IP +prefix is legitimate to announce this IP prefix. The required attestation +objects are stored in the Resource Public Key Infrastructure (:abbr:`RPKI`). +However, RPKI-enabled routers do not store cryptographic data itself but only +validation information. The validation of the cryptographic data (so called +Route Origin Authorization, or short :abbr:`ROA`, objects) will be performed by +trusted cache servers. The RPKI/RTR protocol defines a standard mechanism to +maintain the exchange of the prefix/origin AS mapping between the cache server +and routers. In combination with a BGP Prefix Origin Validation scheme a +router is able to verify received BGP updates without suffering from +cryptographic complexity. The RPKI/RTR protocol is defined in :rfc:`6810` and the validation scheme in :rfc:`6811`. The current version of Prefix Origin Validation in FRR implements both RFCs. -For a more detailed but still easy-to-read background, we suggest the -following two articles: +For a more detailed but still easy-to-read background, we suggest: -* @cite{Geoff Huston, Randy Bush: Securing BGP, In: The Internet - Protocol Journal, Volume 14, No. 2, 2011.} - `http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_14-2/142_bgp.html `_ - -* @cite{Geoff Huston: Resource Certification, In: The Internet Protocol - Journal, Volume 12, No.1, 2009.} - `http://www.cisco.com/web/about/ac123/ac147/archived_issues/ipj_12-1/121_resource.html `_ +- [Securing-BGP]_ +- [Resource-Certification]_ .. _Features_of_the_Current_Implementation: @@ -38,24 +31,19 @@ Features of the Current Implementation In a nutshell, the current implementation provides the following features -* The BGP router can connect to one or more RPKI cache servers to - receive validated prefix to origin AS mappings. - Advanced failover can be implemented by server sockets with different - preference values. - -* If no connection to an RPKI cache server can be established after a +- The BGP router can connect to one or more RPKI cache servers to receive + validated prefix to origin AS mappings. Advanced failover can be implemented + by server sockets with different preference values. +- If no connection to an RPKI cache server can be established after a pre-defined timeout, the router will process routes without prefix origin validation. It still will try to establish a connection to an RPKI cache server in the background. - -* By default, enabling RPKI does not change best path selection. In - particular, invalid prefixes will still be considered during best path - selection. However, the router can be configured to ignore all invalid - prefixes. - -* Route maps can be configured to match a specific RPKI validation - state. This allows the creation of local policies, which handle BGP routes - based on the outcome of the Prefix Origin Validation. +- By default, enabling RPKI does not change best path selection. In particular, + invalid prefixes will still be considered during best path selection. + However, the router can be configured to ignore all invalid prefixes. +- Route maps can be configured to match a specific RPKI validation state. This + allows the creation of local policies, which handle BGP routes based on the + outcome of the Prefix Origin Validation. .. _Enabling_RPKI: @@ -63,101 +51,96 @@ In a nutshell, the current implementation provides the following features Enabling RPKI ------------- -.. index:: {Command} {rpki} {} +.. index:: rpki +.. clicmd:: rpki -{Command} {rpki} {} - This command enables the RPKI configuration mode. Most commands that start - with *rpki* can only be used in this mode. + This command enables the RPKI configuration mode. Most commands that start + with *rpki* can only be used in this mode. - When it is used in a telnet session, leaving of this mode cause rpki to be initialized. + When it is used in a telnet session, leaving of this mode cause rpki to be initialized. - Executing this command alone does not activate prefix - validation. You need to configure at least one reachable cache server. See section - :ref:`Configuring_RPKI/RTR_Cache_Servers` for configuring a cache server. + Executing this command alone does not activate prefix validation. You need + to configure at least one reachable cache server. See section + :ref:`configuring-rpki-rtr-cache-servers` for configuring a cache server. -.. _Configuring_RPKI/RTR_Cache_Servers: +.. _configuring-rpki-rtr-cache-servers: Configuring RPKI/RTR Cache Servers ---------------------------------- The following commands are independent of a specific cache server. -.. index:: {RPKI Command} {rpki polling_period (1-3600)} {} +.. index:: rpki polling_period (1-3600) +.. clicmd:: rpki polling_period (1-3600) -{RPKI Command} {rpki polling_period (1-3600)} {} -.. index:: {RPKI Command} {no rpki polling_period} {} +.. index:: no rpki polling_period +.. clicmd:: no rpki polling_period -{RPKI Command} {no rpki polling_period} {} - Set the number of seconds the router waits until the router asks the cache again - for updated data. + Set the number of seconds the router waits until the router asks the cache + again for updated data. - The default value is 300 seconds. + The default value is 300 seconds. -.. index:: {RPKI Command} {rpki timeout <1-4,294,967,296>} {} +.. index:: rpki timeout <1-4,294,967,296> +.. clicmd:: rpki timeout <1-4,294,967,296> -{RPKI Command} {rpki timeout <1-4,294,967,296>} {} -.. index:: {RPKI Command} {no rpki timeout} {} +.. index:: no rpki timeout +.. clicmd:: no rpki timeout -{RPKI Command} {no rpki timeout} {} - Set the number of seconds the router waits for the cache reply. If the - cache server is not replying within this time period, the router deletes - all received prefix records from the prefix table. + Set the number of seconds the router waits for the cache reply. If the cache + server is not replying within this time period, the router deletes all + received prefix records from the prefix table. - The default value is 600 seconds. + The default value is 600 seconds. -.. index:: {RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {} +.. index:: rpki initial-synchronisation-timeout <1-4,294,967,296> +.. clicmd:: rpki initial-synchronisation-timeout <1-4,294,967,296> -{RPKI Command} {rpki initial-synchronisation-timeout <1-4,294,967,296>} {} -.. index:: {RPKI Command} {no rpki initial-synchronisation-timeout} {} +.. index:: no rpki initial-synchronisation-timeout +.. clicmd:: no rpki initial-synchronisation-timeout -{RPKI Command} {no rpki initial-synchronisation-timeout} {} - Set the number of seconds until the first synchronization with the cache - server needs to be completed. If the timeout expires, BGP routing is - started without RPKI. The router will try to establish the cache server - connection in the background. + Set the number of seconds until the first synchronization with the cache + server needs to be completed. If the timeout expires, BGP routing is started + without RPKI. The router will try to establish the cache server connection in + the background. - The default value is 30 seconds. + The default value is 30 seconds. - The following commands configure one or multiple cache servers. + The following commands configure one or multiple cache servers. -.. index:: {RPKI Socket Command} {rpki cache (`A.B.C.D`|`WORD`) `PORT` [`SSH_USERNAME`] [`SSH_PRIVKEY_PATH`] [`SSH_PUBKEY_PATH`] [`KNOWN_HOSTS_PATH`] `PREFERENCE`} {} +.. index:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE +.. clicmd:: rpki cache (A.B.C.D|WORD) PORT [SSH_USERNAME] [SSH_PRIVKEY_PATH] [SSH_PUBKEY_PATH] [KNOWN_HOSTS_PATH] PREFERENCE -{RPKI Socket Command} {rpki cache (`A.B.C.D`|`WORD`) `PORT` [`SSH_USERNAME`] [`SSH_PRIVKEY_PATH`] [`SSH_PUBKEY_PATH`] [`KNOWN_HOSTS_PATH`] `PREFERENCE`} {} -.. index:: {RPKI Socket Command} {no rpki cache (`A.B.C.D`|`WORD`) [`PORT`] `PREFERENCE`} {} +.. index:: no rpki cache (A.B.C.D|WORD) [PORT] PREFERENCE +.. clicmd:: no rpki cache (A.B.C.D|WORD) [PORT] PREFERENCE -{RPKI Socket Command} {no rpki cache (`A.B.C.D`|`WORD`) [`PORT`] `PREFERENCE`} {} - Add a cache server to the socket. By default, the connection between - router and cache server is based on plain TCP. Protecting the connection - between router and cache server by SSH is optional. - Deleting a socket removes the associated cache server and - terminates the existing connection. + Add a cache server to the socket. By default, the connection between router + and cache server is based on plain TCP. Protecting the connection between + router and cache server by SSH is optional. Deleting a socket removes the + associated cache server and terminates the existing connection. + + A.B.C.D|WORD + Address of the cache server. + + PORT + Port number to connect to the cache server + + SSH_USERNAME + SSH username to establish an SSH connection to the cache server. - -*`A.B.C.D`|`WORD`* - Address of the cache server. + SSH_PRIVKEY_PATH + Local path that includes the private key file of the router. -*`PORT`* - Port number to connect to the cache server + SSH_PUBKEY_PATH + Local path that includes the public key file of the router. -*`SSH_USERNAME`* - SSH username to establish an SSH connection to the cache server. - - -*`SSH_PRIVKEY_PATH`* - Local path that includes the private key file of the router. - - -*`SSH_PUBKEY_PATH`* - Local path that includes the public key file of the router. - - -*`KNOWN_HOSTS_PATH`* - Local path that includes the known hosts file. The default value depends on the - configuration of the operating system environment, usually - :file:`~/.ssh/known_hosts`. + KNOWN_HOSTS_PATH + Local path that includes the known hosts file. The default value depends + on the configuration of the operating system environment, usually + :file:`~/.ssh/known_hosts`. .. _Validating_BGP_Updates: @@ -165,35 +148,36 @@ The following commands are independent of a specific cache server. Validating BGP Updates ---------------------- -.. index:: {Route Map Command} {match rpki {notfound|invalid|valid}} {} +.. index:: match rpki notfound|invalid|valid +.. clicmd:: match rpki notfound|invalid|valid -{Route Map Command} {match rpki {notfound|invalid|valid}} {} -.. index:: {Route Map Command} {no match rpki {notfound|invalid|valid}} {} +.. index:: no match rpki notfound|invalid|valid +.. clicmd:: no match rpki notfound|invalid|valid -{Route Map Command} {no match rpki {notfound|invalid|valid}} {} - Create a clause for a route map to match prefixes with the specified RPKI state. + Create a clause for a route map to match prefixes with the specified RPKI + state. **Note** that the matching of invalid prefixes requires that invalid - prefixes are considered for best path selection, i.e., @command{bgp - bestpath prefix-validate disallow-invalid} is not enabled. + prefixes are considered for best path selection, i.e., + ``bgp bestpath prefix-validate disallow-invalid`` is not enabled. In the following example, the router prefers valid routes over invalid prefixes because invalid routes have a lower local preference. -:: - - ! Allow for invalid routes in route selection process - route bgp 60001 - ! - ! Set local preference of invalid prefixes to 10 - route-map rpki permit 10 - match rpki invalid - set local-preference 10 - ! - ! Set local preference of valid prefixes to 500 - route-map rpki permit 500 - match rpki valid - set local-preference 500 + :: + + ! Allow for invalid routes in route selection process + route bgp 60001 + ! + ! Set local preference of invalid prefixes to 10 + route-map rpki permit 10 + match rpki invalid + set local-preference 10 + ! + ! Set local preference of valid prefixes to 500 + route-map rpki permit 500 + match rpki valid + set local-preference 500 .. _Debugging: @@ -201,76 +185,77 @@ Validating BGP Updates Debugging --------- -.. index:: {Command} {debug rpki} {} +.. index:: debug rpki +.. clicmd:: debug rpki -{Command} {debug rpki} {} -.. index:: {Command} {no debug rpki} {} +.. index:: no debug rpki +.. clicmd:: no debug rpki -{Command} {no debug rpki} {} - Enable or disable debugging output for RPKI. + Enable or disable debugging output for RPKI. .. _Displaying_RPKI: Displaying RPKI --------------- -.. index:: {Command} {show rpki prefix-table} {} +.. index:: show rpki prefix-table +.. clicmd:: show rpki prefix-table -{Command} {show rpki prefix-table} {} - Display all validated prefix to origin AS mappings/records which have been - received from the cache servers and stored in the router. Based on this data, - the router validates BGP Updates. + Display all validated prefix to origin AS mappings/records which have been + received from the cache servers and stored in the router. Based on this data, + the router validates BGP Updates. -.. index:: {Command} {show rpki cache-connection} {} +.. index:: show rpki cache-connection +.. clicmd:: show rpki cache-connection -{Command} {show rpki cache-connection} {} - Display all configured cache servers, whether active or not. + Display all configured cache servers, whether active or not. RPKI Configuration Example -------------------------- :: - hostname bgpd1 - password zebra - ! log stdout - debug bgp updates - debug bgp keepalives - debug rpki - ! - rpki - rpki polling_period 1000 - rpki timeout 10 - ! SSH Example: - rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1 - ! TCP Example: - rpki cache rpki-validator.realmv6.org 8282 preference 2 - exit - ! - router bgp 60001 - bgp router-id 141.22.28.223 - network 192.168.0.0/16 - neighbor 123.123.123.0 remote-as 60002 - neighbor 123.123.123.0 route-map rpki in - ! - address-family ipv6 - neighbor 123.123.123.0 activate - neighbor 123.123.123.0 route-map rpki in - exit-address-family - ! - route-map rpki permit 10 - match rpki invalid - set local-preference 10 - ! - route-map rpki permit 20 - match rpki notfound - set local-preference 20 - ! - route-map rpki permit 30 - match rpki valid - set local-preference 30 - ! - route-map rpki permit 40 - ! - + hostname bgpd1 + password zebra + ! log stdout + debug bgp updates + debug bgp keepalives + debug rpki + ! + rpki + rpki polling_period 1000 + rpki timeout 10 + ! SSH Example: + rpki cache example.com 22 rtr-ssh ./ssh_key/id_rsa ./ssh_key/id_rsa.pub preference 1 + ! TCP Example: + rpki cache rpki-validator.realmv6.org 8282 preference 2 + exit + ! + router bgp 60001 + bgp router-id 141.22.28.223 + network 192.168.0.0/16 + neighbor 123.123.123.0 remote-as 60002 + neighbor 123.123.123.0 route-map rpki in + ! + address-family ipv6 + neighbor 123.123.123.0 activate + neighbor 123.123.123.0 route-map rpki in + exit-address-family + ! + route-map rpki permit 10 + match rpki invalid + set local-preference 10 + ! + route-map rpki permit 20 + match rpki notfound + set local-preference 20 + ! + route-map rpki permit 30 + match rpki valid + set local-preference 30 + ! + route-map rpki permit 40 + ! +.. [Securing-BGP] `Geoff Huston, Randy Bush: Securing BGP, In: The Internet Protocol Journal, Volume 14, No. 2, 2011. `_ +.. [Resource-Certification] `Geoff Huston: Resource Certification, In: The Internet Protocol Journal, Volume 12, No.1, 2009. `_ diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 9b82cf2967..916ab3a9f3 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -4,69 +4,68 @@ SNMP Support ************ -:abbr:`SNMP (Simple Network Managing Protocol)` is a widely implemented -feature for collecting network information from router and/or host. -FRR itself does not support SNMP agent (server daemon) functionality -but is able to connect to a SNMP agent using the SMUX protocol -(:rfc:`1227`) or the AgentX protocol (:rfc:`2741`) and make the -routing protocol MIBs available through it. +:abbr:`SNMP (Simple Network Managing Protocol)` is a widely implemented feature +for collecting network information from router and/or host. FRR itself does +not support SNMP agent (server daemon) functionality but is able to connect to +a SNMP agent using the SMUX protocol (:rfc:`1227`) or the AgentX protocol +(:rfc:`2741`) and make the routing protocol MIBs available through it. -Note that SNMP Support needs to be enabled at compile-time and loaded as -module on daemon startup. Refer to :ref:`Loadable_Module_Support` on -the latter. +Note that SNMP Support needs to be enabled at compile-time and loaded as module +on daemon startup. Refer to :ref:`Loadable_Module_Support` on the latter. .. _Getting_and_installing_an_SNMP_agent: Getting and installing an SNMP agent ==================================== -There are several SNMP agent which support SMUX or AgentX. We recommend to use the latest -version of `net-snmp` which was formerly known as `ucd-snmp`. -It is free and open software and available at `http://www.net-snmp.org/ `_ -and as binary package for most Linux distributions. -`net-snmp` has to be compiled with `--with-mib-modules=agentx` to -be able to accept connections from FRR using AgentX protocol or with -`--with-mib-modules=smux` to use SMUX protocol. +There are several SNMP agent which support SMUX or AgentX. We recommend to use +the latest version of `net-snmp` which was formerly known as `ucd-snmp`. It is +free and open software and available at `http://www.net-snmp.org/ `_ +and as binary package for most Linux distributions. `net-snmp` has to be +compiled with `--with-mib-modules=agentx` to be able to accept connections from +FRR using AgentX protocol or with `--with-mib-modules=smux` to use SMUX +protocol. -Nowadays, SMUX is a legacy protocol. The AgentX protocol should be -preferred for any new deployment. Both protocols have the same coverage. +Nowadays, SMUX is a legacy protocol. The AgentX protocol should be preferred +for any new deployment. Both protocols have the same coverage. .. _AgentX_configuration: AgentX configuration ==================== +.. program:: configure + To enable AgentX protocol support, FRR must have been build with the -`--enable-snmp` or `--enable-snmp=agentx` option. Both the -master SNMP agent (snmpd) and each of the FRR daemons must be -configured. In `/etc/snmp/snmpd.conf`, `master agentx` -directive should be added. In each of the FRR daemons, `agentx` -command will enable AgentX support. +:option:`--enable-snmp` or `--enable-snmp=agentx` option. Both the +master SNMP agent (snmpd) and each of the FRR daemons must be configured. In +:file:`/etc/snmp/snmpd.conf`, the ``master agentx`` directive should be added. +In each of the FRR daemons, ``agentx`` command will enable AgentX support. :: - /etc/snmp/snmpd.conf: - # - # example access restrictions setup - # - com2sec readonly default public - group MyROGroup v1 readonly - view all included .1 80 - access MyROGroup "" any noauth exact all none none - # - # enable master agent for AgentX subagents - # - master agentx + /etc/snmp/snmpd.conf: + # + # example access restrictions setup + # + com2sec readonly default public + group MyROGroup v1 readonly + view all included .1 80 + access MyROGroup "" any noauth exact all none none + # + # enable master agent for AgentX subagents + # + master agentx - /etc/frr/ospfd.conf: - ! ... the rest of ospfd.conf has been omitted for clarity ... - ! - agentx - ! + /etc/frr/ospfd.conf: + ! ... the rest of ospfd.conf has been omitted for clarity ... + ! + agentx + ! -Upon successful connection, you should get something like this in the -log of each FRR daemons: +Upon successful connection, you should get something like this in the log of +each FRR daemons: :: @@ -82,17 +81,17 @@ Then, you can use the following command to check everything works as expected: [...] -The AgentX protocol can be transported over a Unix socket or using TCP -or UDP. It usually defaults to a Unix socket and depends on how NetSNMP -was built. If need to configure FRR to use another transport, you can -configure it through `/etc/snmp/frr.conf`: +The AgentX protocol can be transported over a Unix socket or using TCP or UDP. +It usually defaults to a Unix socket and depends on how NetSNMP was built. If +need to configure FRR to use another transport, you can configure it through +:file:`/etc/snmp/frr.conf`: :: - /etc/snmp/frr.conf: - [snmpd] - # Use a remote master agent - agentXSocket tcp:192.168.15.12:705 + /etc/snmp/frr.conf: + [snmpd] + # Use a remote master agent + agentXSocket tcp:192.168.15.12:705 .. _SMUX_configuration: @@ -101,68 +100,66 @@ SMUX configuration ================== To enable SMUX protocol support, FRR must have been build with the -`--enable-snmp=smux` option. +:option:`--enable-snmp` option. -A separate connection has then to be established between the -SNMP agent (snmpd) and each of the FRR daemons. This connections -each use different OID numbers and passwords. Be aware that this OID -number is not the one that is used in queries by clients, it is solely -used for the intercommunication of the daemons. +A separate connection has then to be established between the SNMP agent (snmpd) +and each of the FRR daemons. This connections each use different OID numbers +and passwords. Be aware that this OID number is not the one that is used in +queries by clients, it is solely used for the intercommunication of the +daemons. -In the following example the ospfd daemon will be connected to the -snmpd daemon using the password "frr_ospfd". For testing it is -recommending to take exactly the below snmpd.conf as wrong access -restrictions can be hard to debug. +In the following example the ospfd daemon will be connected to the snmpd daemon +using the password "frr_ospfd". For testing it is recommending to take exactly +the below snmpd.conf as wrong access restrictions can be hard to debug. :: - /etc/snmp/snmpd.conf: - # - # example access restrictions setup - # - com2sec readonly default public - group MyROGroup v1 readonly - view all included .1 80 - access MyROGroup "" any noauth exact all none none - # - # the following line is relevant for FRR - # - smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd + /etc/snmp/snmpd.conf: + # + # example access restrictions setup + # + com2sec readonly default public + group MyROGroup v1 readonly + view all included .1 80 + access MyROGroup "" any noauth exact all none none + # + # the following line is relevant for FRR + # + smuxpeer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd - /etc/frr/ospf: - ! ... the rest of ospfd.conf has been omitted for clarity ... - ! - smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd - ! + /etc/frr/ospf: + ! ... the rest of ospfd.conf has been omitted for clarity ... + ! + smux peer .1.3.6.1.4.1.3317.1.2.5 frr_ospfd + ! -After restarting snmpd and frr, a successful connection can be verified in -the syslog and by querying the SNMP daemon: +After restarting snmpd and frr, a successful connection can be verified in the +syslog and by querying the SNMP daemon: :: - snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255 - snmpd[12300]: accepted smux peer: \\ - oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5 + snmpd[12300]: [smux_accept] accepted fd 12 from 127.0.0.1:36255 + snmpd[12300]: accepted smux peer: \\ + oid GNOME-PRODUCT-ZEBRA-MIB::ospfd, frr-0.96.5 - # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 - OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 + # snmpwalk -c public -v1 localhost .1.3.6.1.2.1.14.1.1 + OSPF-MIB::ospfRouterId.0 = IpAddress: 192.168.42.109 Be warned that the current version (5.1.1) of the Net-SNMP daemon writes a line for every SNMP connect to the syslog which can lead to enormous log file sizes. If that is a problem you should consider to patch snmpd and comment out the -troublesome `snmp_log()` line in the function -`netsnmp_agent_check_packet()` in `agent/snmp_agent.c`. +troublesome `snmp_log()` line in the function `netsnmp_agent_check_packet()` in +`agent/snmp_agent.c`. MIB and command reference ========================= The following OID numbers are used for the interprocess communication of snmpd and -the FRR daemons with SMUX only. -:: +the FRR daemons with SMUX only.:: - (OIDs below .iso.org.dod.internet.private.enterprises) + . (OIDs below .iso.org.dod.internet.private.enterprises) zebra .1.3.6.1.4.1.3317.1.2.1 .gnome.gnomeProducts.zebra.zserv bgpd .1.3.6.1.4.1.3317.1.2.2 .gnome.gnomeProducts.zebra.bgpd ripd .1.3.6.1.4.1.3317.1.2.3 .gnome.gnomeProducts.zebra.ripd @@ -171,8 +168,7 @@ the FRR daemons with SMUX only. Sadly, SNMP has not been implemented in all daemons yet. The following -OID numbers are used for querying the SNMP daemon by a client: -:: +OID numbers are used for querying the SNMP daemon by a client::: zebra .1.3.6.1.2.1.4.24 .iso.org.dot.internet.mgmt.mib-2.ip.ipForward ospfd .1.3.6.1.2.1.14 .iso.org.dot.internet.mgmt.mib-2.ospf @@ -181,26 +177,24 @@ OID numbers are used for querying the SNMP daemon by a client: ospf6d .1.3.6.1.3.102 .iso.org.dod.internet.experimental.ospfv3 -The following syntax is understood by the FRR daemons for configuring SNMP using SMUX: -.. index:: {Command} {smux peer `oid`} {} +The following syntax is understood by the FRR daemons for configuring SNMP +using SMUX: -{Command} {smux peer `oid`} {} -.. index:: {Command} {no smux peer `oid`} {} +.. index:: smux peer OID +.. clicmd:: smux peer OID +.. index:: no smux peer OID +.. clicmd:: no smux peer OID +.. index:: smux peer OID PASSWORD +.. clicmd:: smux peer OID PASSWORD +.. index:: no smux peer OID PASSWORD +.. clicmd:: no smux peer OID PASSWORD -{Command} {no smux peer `oid`} {} +Here is the syntax for using AgentX: -.. index:: {Command} {smux peer `oid` `password`} {} +.. index:: agentx +.. clicmd:: agentx +.. index:: no agentx +.. clicmd:: no agentx -{Command} {smux peer `oid` `password`} {} -.. index:: {Command} {no smux peer `oid` `password`} {} - -{Command} {no smux peer `oid` `password`} {} - Here is the syntax for using AgentX: -.. index:: {Command} {agentx} {} - -{Command} {agentx} {} -.. index:: {Command} {no agentx} {} - -{Command} {no agentx} {} .. include:: snmptrap.rst diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst index 28cc5fceca..9d6b12e0b4 100644 --- a/doc/user/snmptrap.rst +++ b/doc/user/snmptrap.rst @@ -1,18 +1,18 @@ Handling SNMP Traps =================== -To handle snmp traps make sure your snmp setup of frr works -correctly as described in the frr documentation in :ref:`SNMP_Support`. +To handle snmp traps make sure your snmp setup of frr works correctly as +described in the frr documentation in :ref:`SNMP_Support`. -The BGP4 mib will send traps on peer up/down events. These should be -visible in your snmp logs with a message similar to: +The BGP4 mib will send traps on peer up/down events. These should be visible in +your snmp logs with a message similar to: :: snmpd[13733]: Got trap from peer on fd 14 -To react on these traps they should be handled by a trapsink. Configure -your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: +To react on these traps they should be handled by a trapsink. Configure your +trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: :: @@ -20,9 +20,9 @@ your trapsink by adding the following lines to :file:`/etc/snmpd/snmpd.conf`: trapsink localhost -This will send all traps to an snmptrapd running on localhost. You can -of course also use a dedicated management station to catch traps. -Configure the snmptrapd daemon by adding the following line to +This will send all traps to an snmptrapd running on localhost. You can of +course also use a dedicated management station to catch traps. Configure the +snmptrapd daemon by adding the following line to :file:`/etc/snmpd/snmptrapd.conf`: :: @@ -32,15 +32,15 @@ Configure the snmptrapd daemon by adding the following line to This will use the bash script :file:`/etc/snmp/snmptrap_handle.sh` to handle the BGP4 traps. To add traps for other protocol daemons, lookup their -appropriate OID from their mib. (For additional information about which -traps are supported by your mib, lookup the mib on +appropriate OID from their mib. (For additional information about which traps +are supported by your mib, lookup the mib on `http://www.oidview.com/mibs/detail.html `_). -Make sure snmptrapd is started. +Make sure *snmptrapd* is started. -The snmptrap_handle.sh script I personally use for handling BGP4 traps -is below. You can of course do all sorts of things when handling traps, -like sound a siren, have your display flash, etc., be creative ;). +The snmptrap_handle.sh script I personally use for handling BGP4 traps is +below. You can of course do all sorts of things when handling traps, like sound +a siren, have your display flash, etc., be creative ;). :: diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 2f87308e86..b133b8c920 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -4,94 +4,81 @@ VNC and VNC-GW ************** -This chapter describes how to use -Virtual Network Control (:abbr:`VNC`) services, -including Network Virtualization Authority (:abbr:`NVA`) and -VNC Gateway (:abbr:`VNC-GW`) functions. -Background information on NVAs, -Network Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s), -and virtual networks (:abbr:`VN`s) is available from the +This chapter describes how to use Virtual Network Control (:abbr:`VNC`) +services, including Network Virtualization Authority (:abbr:`NVA`) and VNC +Gateway (:abbr:`VNC-GW`) functions. Background information on NVAs, Network +Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s), and +virtual networks (:abbr:`VN`s) is available from the `IETF Network Virtualization Overlays `_ -VNC Gateways (:abbr:`VNC-GW`s) support the import/export of routing -information between VNC and customer edge routers (:abbr:`CE`s) -operating within a VN. Both IP/Layer 3 (L3) VNs, and IP with -Ethernet/Layer 2 (L2) VNs are supported. +:abbr:`VNC-GW (VNC-Gateways)` support the import/export of routing information +between VNC and customer edge routers (:abbr:`CE` s) operating within a VN. +Both IP/Layer 3 (L3) VNs, and IP with Ethernet/Layer 2 (L2) VNs are supported. BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN -information between NVAs. BGP based IP VPN support is defined in -:rfc:`4364`, and -:rfc:`4659`. Both the Encapsulation Subsequent Address Family Identifier +information between NVAs. BGP based IP VPN support is defined in :rfc:`4364`, +and :rfc:`4659`. Both the Encapsulation Subsequent Address Family Identifier (SAFI) and the Tunnel Encapsulation Attribute, :rfc:`5512` are supported. -The protocol that is used to communicate routing and Ethernet / Layer 2 -(L2) forwarding information between NVAs and NVEs is referred to as the -Remote Forwarder Protocol (RFP). `OpenFlow` is an example -RFP. Specific RFP implementations may choose to implement either a -`hard-state` or `soft-state` prefix and address registration -model. To support a `soft-state` refresh model, a `lifetime` -in seconds is associated with all registrations and responses. +The protocol that is used to communicate routing and Ethernet / Layer 2 (L2) +forwarding information between NVAs and NVEs is referred to as the Remote +Forwarder Protocol (RFP). `OpenFlow` is an example RFP. Specific RFP +implementations may choose to implement either a `hard-state` or `soft-state` +prefix and address registration model. To support a `soft-state` refresh model, +a `lifetime` in seconds is associated with all registrations and responses. The chapter also provides sample configurations for basic example scenarios. -.. _Configuring_VNC: +.. _configuring-vnc: Configuring VNC =============== -Virtual Network Control (:abbr:`VNC`) service configuration commands -appear in the `router bgp` section of the BGPD configuration file -(:ref:`BGP_Configuration_Examples`). The commands are broken down into -the following areas: +Virtual Network Control (:abbr:`VNC`) service configuration commands appear in +the `router bgp` section of the BGPD configuration file +(:ref:`bgp-configuration-examples`). The commands are broken down into the +following areas: -`General VNC` configuration applies to general VNC operation and is -primarily used to control the method used to advertise tunnel -information. +- :dfn:`General VNC` configuration applies to general VNC operation and is + primarily used to control the method used to advertise tunnel information. + - :dfn:`Remote Forwarder Protocol (RFP)` configuration relates to the protocol + used between NVAs and NVEs. + - :dfn:`VNC Defaults` provides default parameters for registered NVEs. + - :dfn:`VNC NVE Group` provides for configuration of a specific set of + registered NVEs and overrides default parameters. + - :dfn:`Redistribution` and :dfn:`Export` control VNC-GW operation, i.e., the + import/export of routing information between VNC and customer edge routers + (:abbr:`CE`s) operating within a VN. -`Remote Forwarder Protocol (RFP)` configuration relates to the -protocol used between NVAs and NVEs. -`VNC Defaults` provides default parameters for registered NVEs. + .. _General_VNC_Configuration: -`VNC NVE Group` provides for configuration of a specific set of -registered NVEs and overrides default parameters. + General VNC Configuration + ------------------------- -`Redistribution` and `Export` control VNC-GW operation, i.e., -the import/export of routing -information between VNC and customer edge routers (:abbr:`CE`s) -operating within a VN. + .. clicmd:: vnc advertise-un-method encap-safi|encap-attr -.. _General_VNC_Configuration: - -General VNC Configuration -------------------------- - -.. index:: {VNC} {vnc advertise-un-method encap-safi|encap-attr} {} - -{VNC} {vnc advertise-un-method encap-safi|encap-attr} {} Advertise NVE underlay-network IP addresses using the encapsulation SAFI - (`encap-safi`) or the UN address sub-TLV of the Tunnel Encapsulation attribute - (`encap-attr`). When `encap-safi` is used, neighbors under - `address-family encap` and/or `address-family encapv6` must be - configured. The default is `encap-attr`. + (`encap-safi`) or the UN address sub-TLV of the Tunnel Encapsulation + attribute (`encap-attr`). When `encap-safi` is used, neighbors under + `address-family encap` and/or `address-family encapv6` must be configured. + The default is `encap-attr`. -.. _RFP_Related_Configuration: + .. _RFP_Related_Configuration: RFP Related Configuration ------------------------- -The protocol that is used to communicate routing and Ethernet / L2 -forwarding information between NVAs and NVEs is referred to as the -Remote Forwarder Protocol (RFP). Currently, only a simple example RFP -is included in FRR. Developers may use this example as a starting -point to integrate FRR with an RFP of their choosing, e.g., -`OpenFlow`. The example code includes the following sample -configuration: +The protocol that is used to communicate routing and Ethernet / L2 forwarding +information between NVAs and NVEs is referred to as the Remote Forwarder +Protocol (RFP). Currently, only a simple example RFP is included in FRR. +Developers may use this example as a starting point to integrate FRR with an +RFP of their choosing, e.g., `OpenFlow`. The example code includes the +following sample configuration: -.. index:: {RFP} {rfp example-config-value `VALUE`} +.. clicmd:: rfp example-config-value VALUE -{RFP} {rfp example-config-value `VALUE`} - This is a simple example configuration parameter included as part of the - RFP example code. `VALUE` must be in the range of 0 to 4294967295. +This is a simple example configuration parameter included as part of the RFP +example code. VALUE must be in the range of 0 to 4294967295. .. _VNC_Defaults_Configuration: @@ -102,130 +89,109 @@ The VNC Defaults section allows the user to specify default values for configuration parameters for all registered NVEs. Default values are overridden by :ref:`VNC_NVE_Group_Configuration`. -.. index:: {VNC} {vnc defaults} {} +.. clicmd:: vnc defaults -{VNC} {vnc defaults} {} - Enter VNC configuration mode for specifying VNC default behaviors. Use - `exit-vnc` to leave VNC configuration mode. `vnc defaults` is optional. +Enter VNC configuration mode for specifying VNC default behaviors. Use +`exit-vnc` to leave VNC configuration mode. `vnc defaults` is optional. :: - vnc defaults - ... various VNC defaults - exit-vnc +vnc defaults +... various VNC defaults +exit-vnc -These are the statements that can appear between `vnc defaults` -and `exit-vnc`. +These are the statements that can appear between ``vnc defaults`` and +``exit-vnc``. -.. index:: {VNC} {rt import `rt-list`} {} +.. index:: rt import RT-LIST +.. clicmd:: rt import RT-LIST -{VNC} {rt import `rt-list`} {} -.. index:: {VNC} {rt export `rt-list`} {} +.. index:: rt export RT-LIST +.. clicmd:: rt export RT-LIST -{VNC} {rt export `rt-list`} {} -.. index:: {VNC} {rt both `rt-list`} {} +.. index:: rt both RT-LIST +.. clicmd:: rt both RT-LIST -{VNC} {rt both `rt-list`} {} - Specify default route target import and export lists. `rt-list` is a - space-separated list of route targets, each element of which is - in one of the following forms: + Specify default route target import and export lists. `rt-list` is a + space-separated list of route targets, each element of which is + in one of the following forms: + - ``IPv4-address:two-byte-integer`` + - ``four-byte-autonomous-system-number:two-byte-integer`` + - ``two-byte-autonomous-system-number:four-byte-integer`` -`IPv4-address`:`two-byte-integer` + If no default import RT list is specified, then the default import RT list + is empty. If no default export RT list is specified, then the default export + RT list is empty. -`four-byte-autonomous-system-number`:`two-byte-integer` + A complete definition of these parameters is given below + (:ref:`VNC_NVE_Group_Configuration`). -`two-byte-autonomous-system-number`:`four-byte-integer` + .. index:: rd route-distinguisher + .. clicmd:: rd ROUTE-DISTINGUISHER - If no default import RT list is specified, then the default import RT - list is empty. - If no default export RT list is specified, then the default export RT - list is empty. + Specify the default route distinguisher (RD) for routes advertised via BGP + VPNs. The route distinguisher must be in one of four forms: - A complete definition of these parameters is - given below (:ref:`VNC_NVE_Group_Configuration`). + - ``IPv4-address:two-byte-integer`` + - ``four-byte-autonomous-system-number:two-byte-integer`` + - ``two-byte-autonomous-system-number:four-byte-integer`` + - ``auto:vn:two-byte-integer`` -.. index:: {VNC} {rd `route-distinguisher`} + If RD is specified in the defaults section, the default RD value is + `two-byte-autonomous-system-number=0`:`four-byte-integer=0`. -{VNC} {rd `route-distinguisher`} - Specify the default route distinguisher (RD) for routes advertised via BGP - VPNs. The route distinguisher must be in one of four forms: + A complete definition of this parameter is given below + (:ref:`VNC_NVE_Group_Configuration`). + .. index:: l2rd NVE-ID-VALUE -`IPv4-address`:`two-byte-integer` + .. clicmd:: l2rd NVE-ID-VALUE -`four-byte-autonomous-system-number`:`two-byte-integer` + Set the value used to distinguish NVEs connected to the same logical + Ethernet segment (i.e., L2VPN). A complete definition of this parameter is + given below (:ref:`VNC_NVE_Group_Configuration`). -`two-byte-autonomous-system-number`:`four-byte-integer` + .. index:: response-lifetime LIFETIME|infinite + .. clicmd:: response-lifetime LIFETIME|infinite -auto:vn:`two-byte-integer` + Specify the default lifetime to be included in RFP response messages sent to + NVEs. - If RD is specified in the defaults section, the default RD - value is `two-byte-autonomous-system-number=0`:`four-byte-integer=0`. + A complete definition of this parameter is given below + (:ref:`VNC_NVE_Group_Configuration`). - A complete definition of this parameter is - given below (:ref:`VNC_NVE_Group_Configuration`). +.. index:: export bgp|zebra route-map MAP-NAME -.. index:: {VNC} {l2rd `nve-id-value`} +.. clicmd:: export bgp|zebra route-map MAP-NAME -{VNC} {l2rd `nve-id-value`} - Set the value used to distinguish NVEs connected to the same logical - Ethernet segment (i.e., L2VPN). +Specify that the named route-map should be applied to routes being exported +to bgp or zebra. - A complete definition of this parameter is - given below (:ref:`VNC_NVE_Group_Configuration`). +.. index:: export bgp|zebra no route-map -.. index:: {VNC} {response-lifetime `lifetime`|infinite} {} +.. clicmd:: export bgp|zebra no route-map -{VNC} {response-lifetime `lifetime`|infinite} {} - Specify the default lifetime to be included in RFP - response messages sent to NVEs. +Specify that no route-map should be applied to routes being exported to bgp +or zebra. - A complete definition of this parameter is - given below (:ref:`VNC_NVE_Group_Configuration`). +.. index:: exit-vnc +.. clicmd:: exit-vnc -.. index:: {VNC} {export bgp|zebra route-map MAP-NAME} + Exit VNC configuration mode. -{VNC} {export bgp|zebra route-map MAP-NAME} - Specify that the named route-map should be applied to routes - being exported to bgp or zebra. - -.. index:: {VNC} {export bgp|zebra no route-map} - -{VNC} {export bgp|zebra no route-map} - Specify that no route-map should be applied to routes - being exported to bgp or zebra. - -.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} - -{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} - Specify that the named prefix-list filter should be applied to - routes being exported to bgp or zebra. - Prefix-lists for ipv4 and ipv6 are independent of each other. - -.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} - -{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} - Specify that no prefix-list filter should be applied to - routes being exported to bgp or zebra. - -.. index:: {VNC} {exit-vnc} {} - -{VNC} {exit-vnc} {} - Exit VNC configuration mode. - -.. _VNC_NVE_Group_Configuration: + .. _VNC_NVE_Group_Configuration: VNC NVE Group Configuration --------------------------- -A NVE Group corresponds to a specific set of NVEs. A Client NVE is +A NVE Group corresponds to a specific set of NVEs. A Client NVE is assigned to an NVE Group based on whether there is a match for either its virtual or underlay network address against the VN and/or UN address -prefixes specified in the NVE Group definition. When an NVE Group +prefixes specified in the NVE Group definition. When an NVE Group definition specifies both VN and UN address prefixes, then an NVE must -match both prefixes in order to be assigned to the NVE Group. In the +match both prefixes in order to be assigned to the NVE Group. In the event that multiple NVE Groups match based on VN and/or UN addresses, the NVE is assigned to the first NVE Group listed in the configuration. If an NVE is not assigned to an NVE Group, its messages will be ignored. @@ -234,290 +200,259 @@ Configuration values specified for an NVE group apply to all member NVEs and override configuration values specified in the VNC Defaults section. -@strong{At least one `nve-group` is mandatory for useful VNC -operation.} +**At least one `nve-group` is mandatory for useful VNC operation.** -.. index:: {VNC} {vnc nve-group `name`} {} +.. index:: vnc nve-group NAME +.. clicmd:: vnc nve-group NAME -{VNC} {vnc nve-group `name`} {} Enter VNC configuration mode for defining the NVE group `name`. Use `exit` or `exit-vnc` to exit group configuration mode. -:: + :: - vnc nve-group group1 - ... configuration commands - exit-vnc + vnc nve-group group1 + ... configuration commands + exit-vnc -.. index:: {VNC} {no vnc nve-group `name`} {} +.. index:: no vnc nve-group NAME +.. clicmd:: no vnc nve-group NAME -{VNC} {no vnc nve-group `name`} {} - Delete the NVE group named `name`. + Delete the NVE group named `name`. -The following statements are valid in an NVE group definition: + The following statements are valid in an NVE group definition: -.. index:: {VNC} {l2rd `nve-id-value`} + .. index:: l2rd NVE-ID-VALUE + .. clicmd:: l2rd NVE-ID-VALUE -{VNC} {l2rd `nve-id-value`} - Set the value used to distinguish NVEs connected to the same physical - Ethernet segment (i.e., at the same location)@footnote{The nve-id is - carried in the route - distinguisher. It is the second octet of the eight-octet route - distinguisher generated for Ethernet / L2 advertisements. - The first octet is a constant 0xFF, and the third through eighth - octets are set to the L2 ethernet address being advertised.} +Set the value used to distinguish NVEs connected to the same physical +Ethernet segment (i.e., at the same location) [#]_. - The nve-id subfield may be specified as either a literal value - in the range 1-255, or it may be specified as `auto:vn`, which - means to use the least-significant octet of the originating - NVE's VN address. +The nve-id subfield may be specified as either a literal value in the range +1-255, or it may be specified as `auto:vn`, which means to use the +least-significant octet of the originating NVE's VN address. -.. index:: {VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {} +.. index:: prefix vn|un A.B.C.D/M|X:X::X:X/M +.. clicmd:: prefix vn|un A.B.C.D/M|X:X::X:X/M -{VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {} - .. _prefix: + Specify the matching prefix for this NVE group by either virtual-network + address (`vn`) or underlay-network address (`un`). Either or both + virtual-network and underlay-network prefixes may be specified. Subsequent + virtual-network or underlay-network values within a `vnc nve-group` + `exit-vnc` block override their respective previous values. - Specify the matching prefix for this NVE group by either virtual-network address - (`vn`) or underlay-network address (`un`). Either or both virtual-network - and underlay-network prefixes may be specified. Subsequent virtual-network or - underlay-network values within a `vnc nve-group` `exit-vnc` - block override their respective previous values. + These prefixes are used only for determining assignments of NVEs to NVE + Groups. - These prefixes are used only for determining assignments of NVEs - to NVE Groups. + .. index:: rd ROUTE-DISTINGUISHER + .. clicmd:: rd ROUTE-DISTINGUISHER -.. index:: {VNC} {rd `route-distinguisher`} + Specify the route distinguisher for routes advertised via BGP + VPNs. The route distinguisher must be in one of these forms: -{VNC} {rd `route-distinguisher`} - Specify the route distinguisher for routes advertised via BGP - VPNs. The route distinguisher must be in one of these forms: + - ``IPv4-address:two-byte-integer`` + - ``four-byte-autonomous-system-number:two-byte-integer`` + - ``two-byte-autonomous-system-number:four-byte-integer`` + - ``auto:vn:`two-byte-integer` + Routes originated by NVEs in the NVE group will use the group's specified + `route-distinguisher` when they are advertised via BGP. If the `auto` form + is specified, it means that a matching NVE has its RD set to + ``rd_type=IP=1:IPv4-address=VN-address:two-byte-integer``, for IPv4 VN + addresses and + ``rd_type=IP=1`:`IPv4-address=Last-four-bytes-of-VN-address:two-byte-integer``, + for IPv6 VN addresses. -`IPv4-address`:`two-byte-integer` + If the NVE group definition does not specify a `route-distinguisher`, then + the default `route-distinguisher` is used. If neither a group nor a default + `route-distinguisher` is configured, then the advertised RD is set to + ``two-byte-autonomous-system-number=0:four-byte-integer=0``. -`four-byte-autonomous-system-number`:`two-byte-integer` + .. index:: response-lifetime LIFETIME|infinite + .. clicmd:: response-lifetime LIFETIME|infinite -`two-byte-autonomous-system-number`:`four-byte-integer` + Specify the response lifetime, in seconds, to be included in RFP response + messages sent to NVEs. If the value 'infinite' is given, an infinite + lifetime will be used. -auto:vn:`two-byte-integer` + Note that this parameter is not the same as the lifetime supplied by NVEs in + RFP registration messages. This parameter does not affect the lifetime value + attached to routes sent by this server via BGP. - Routes originated by NVEs in the NVE group will use - the group's specified `route-distinguisher` when they are - advertised via BGP. - If the `auto` form is specified, it means that a matching NVE has - its RD set to - `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer`, - for IPv4 VN addresses and - `rd_type=IP=1`:`IPv4-address=Last-four-bytes-of-VN-address`:`two-byte-integer`, - for IPv6 VN addresses. + If the NVE group definition does not specify a `response-lifetime`, the + default `response-lifetime` will be used. If neither a group nor a default + `response-lifetime` is configured, the value 3600 will be used. The maximum + response lifetime is 2147483647. - If the NVE group definition does not specify a `route-distinguisher`, - then the default `route-distinguisher` is used. - If neither a group nor a default `route-distinguisher` is - configured, then the advertised RD is set to - `two-byte-autonomous-system-number=0`:`four-byte-integer=0`. + .. index:: rt export RT-LIST + .. clicmd:: rt export RT-LIST -.. index:: {VNC} {response-lifetime `lifetime`|infinite} {} + .. index:: rt import RT-LIST + .. clicmd:: rt import RT-LIST -{VNC} {response-lifetime `lifetime`|infinite} {} - Specify the response lifetime, in seconds, to be included in RFP - response messages sent to NVEs. If the value - 'infinite' is given, an infinite lifetime will be used. +.. index:: rt both RT-LIST +.. clicmd:: rt both RT-LIST - Note that this parameter is not the same as the lifetime supplied by - NVEs in RFP registration messages. This parameter does not affect - the lifetime value attached to routes sent by this server via BGP. + Specify route target import and export lists. `rt-list` is a + space-separated list of route targets, each element of which is + in one of the following forms: - If the NVE group definition does not specify a `response-lifetime`, - the default `response-lifetime` will be used. - If neither a group nor a default `response-lifetime` is configured, - the value 3600 will be used. The maximum response lifetime is 2147483647. + ``IPv4-address:two-byte-integer`` + ``four-byte-autonomous-system-number:two-byte-integer`` + ``two-byte-autonomous-system-number:four-byte-integer`` -.. index:: {VNC} {rt export `rt-list`} {} + The first form, `rt export`, specifies an `export rt-list`. The `export + rt-list` will be attached to routes originated by NVEs in the NVE group + when they are advertised via BGP. If the NVE group definition does not + specify an `export rt-list`, then the default `export rt-list` is used. + If neither a group nor a default `export rt-list` is configured, then no + RT list will be sent; in turn, these routes will probably not be + processed by receiving NVAs. -{VNC} {rt export `rt-list`} {} -.. index:: {VNC} {rt import `rt-list`} {} + The second form, `rt import` specifies an `import rt-list`, which is a + filter for incoming routes. In order to be made available to NVEs in the + group, incoming BGP VPN and `ENCAP` `SAFI` (when `vnc advertise-un-method + encap-safi` is set) routes must have RT lists that have at least one + route target in common with the group's `import rt-list`. -{VNC} {rt import `rt-list`} {} -.. index:: {VNC} {rt both `rt-list`} {} + If the NVE group definition does not specify an import filter, then the + default `import rt-list` is used. If neither a group nor a default + `import rt-list` is configured, there can be no RT intersections when + receiving BGP routes and therefore no incoming BGP routes will be + processed for the group. -{VNC} {rt both `rt-list`} {} - Specify route target import and export lists. `rt-list` is a - space-separated list of route targets, each element of which is - in one of the following forms: + The third, `rt both`, is a shorthand way of specifying both lists + simultaneously, and is equivalent to `rt export `rt-list`` followed by + `rt import `rt-list``. +.. index:: export bgp|zebra route-map MAP-NAME +.. clicmd:: export bgp|zebra route-map MAP-NAME -`IPv4-address`:`two-byte-integer` + Specify that the named route-map should be applied to routes being exported + to bgp or zebra. This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + is optional. -`four-byte-autonomous-system-number`:`two-byte-integer` +.. index:: export bgp|zebra no route-map +.. clicmd:: export bgp|zebra no route-map -`two-byte-autonomous-system-number`:`four-byte-integer` + Specify that no route-map should be applied to routes being exported to bgp + or zebra. This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + is optional. - The first form, `rt export`, specifies an `export rt-list`. - The `export rt-list` will be attached to routes originated by - NVEs in the NVE group when they are advertised via BGP. - If the NVE group definition does not specify an `export rt-list`, - then the default `export rt-list` is used. - If neither a group nor a default `export rt-list` is configured, - then no RT list will be sent; in turn, these routes will probably - not be processed - by receiving NVAs. +.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME +.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME - The second form, `rt import` specifies an `import rt-list`, - which is a filter for incoming routes. - In order to be made available to NVEs in the group, - incoming BGP VPN and @w{ENCAP} @w{SAFI} (when `vnc advertise-un-method encap-safi` is set) routes must have - RT lists that have at least one route target in common with the - group's `import rt-list`. + Specify that the named prefix-list filter should be applied to routes being + exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of + each other. This paramter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + is optional. - If the NVE group definition does not specify an import filter, - then the default `import rt-list` is used. - If neither a group nor a default `import rt-list` is configured, - there can be no RT intersections when receiving BGP routes and - therefore no incoming BGP routes will be processed for the group. +.. index:: export bgp|zebra no ipv4|ipv6 prefix-list +.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list - The third, `rt both`, is a shorthand way of specifying both - lists simultaneously, and is equivalent to `rt export `rt-list`` - followed by `rt import `rt-list``. - -.. index:: {VNC} {export bgp|zebra route-map MAP-NAME} - -{VNC} {export bgp|zebra route-map MAP-NAME} - Specify that the named route-map should be applied to routes - being exported to bgp or zebra. - This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. - This item is optional. - -.. index:: {VNC} {export bgp|zebra no route-map} - -{VNC} {export bgp|zebra no route-map} - Specify that no route-map should be applied to routes - being exported to bgp or zebra. - This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. - This item is optional. - -.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} - -{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} - Specify that the named prefix-list filter should be applied to - routes being exported to bgp or zebra. - Prefix-lists for ipv4 and ipv6 are independent of each other. - This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. - This item is optional. - -.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} - -{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} - Specify that no prefix-list filter should be applied to - routes being exported to bgp or zebra. - This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. - This item is optional. + Specify that no prefix-list filter should be applied to routes being + exported to bgp or zebra. This parameter is used in conjunction with + :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + is optional. .. _VNC_L2_Group_Configuration: VNC L2 Group Configuration -------------------------- -The route targets advertised with prefixes and addresses registered by -an NVE are determined based on the NVE's associated VNC NVE Group -Configuration, :ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups -are used to override the route targets for an NVE's Ethernet -registrations based on the Logical Network Identifier and label value. -A Logical Network Identifier is used to uniquely identify a logical -Ethernet segment and is conceptually similar to the Ethernet Segment -Identifier defined in :rfc:`7432`. Both -the Logical Network Identifier and Label are passed to VNC via RFP -prefix and address registration. +The route targets advertised with prefixes and addresses registered by an NVE +are determined based on the NVE's associated VNC NVE Group Configuration, +:ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups are used to override +the route targets for an NVE's Ethernet registrations based on the Logical +Network Identifier and label value. A Logical Network Identifier is used to +uniquely identify a logical Ethernet segment and is conceptually similar to the +Ethernet Segment Identifier defined in :rfc:`7432`. Both the Logical Network +Identifier and Label are passed to VNC via RFP prefix and address registration. -Note that a corresponding NVE group configuration must be present, and -that other NVE associated configuration information, notably RD, is -not impacted by L2 Group Configuration. +Note that a corresponding NVE group configuration must be present, and that +other NVE associated configuration information, notably RD, is not impacted by +L2 Group Configuration. -.. index:: {VNC} {vnc l2-group `name`} {} +.. index:: vnc l2-group NAME +.. clicmd:: vnc l2-group NAME -{VNC} {vnc l2-group `name`} {} - Enter VNC configuration mode for defining the L2 group `name`. - Use `exit` or `exit-vnc` to exit group configuration mode. + Enter VNC configuration mode for defining the L2 group `name`. + Use `exit` or `exit-vnc` to exit group configuration mode. -:: + :: - vnc l2-group group1 - ... configuration commands - exit-vnc + vnc l2-group group1 + ... configuration commands + exit-vnc -.. index:: {VNC} {no vnc l2-group `name`} {} +.. index:: no vnc l2-group NAME +.. clicmd:: no vnc l2-group NAME -{VNC} {no vnc l2-group `name`} {} - Delete the L2 group named `name`. + Delete the L2 group named `name`. The following statements are valid in a L2 group definition: -.. index:: {VNC} {logical-network-id `VALUE`} +.. index:: logical-network-id VALUE +.. clicmd:: logical-network-id VALUE -{VNC} {logical-network-id `VALUE`} - Define the Logical Network Identifier with a value in the range of - 0-4294967295 that identifies the logical Ethernet segment. + Define the Logical Network Identifier with a value in the range of + 0-4294967295 that identifies the logical Ethernet segment. -.. index:: {VNC} {labels `label-list`} +.. index:: labels LABEL-LIST +.. clicmd:: labels LABEL-LIST -{VNC} {labels `label-list`} -.. index:: {VNC} {no labels `label-list`} +.. index:: no labels LABEL-LIST +.. clicmd:: no labels LABEL-LIST -{VNC} {no labels `label-list`} - Add or remove labels associated with the group. `label-list` is a - space separated list of label values in the range of 0-1048575. + Add or remove labels associated with the group. `label-list` is a + space separated list of label values in the range of 0-1048575. -.. index:: {VNC} {rt import `rt-target`} {} +.. index:: rt import RT-TARGET +.. clicmd:: rt import RT-TARGET -{VNC} {rt import `rt-target`} {} -.. index:: {VNC} {rt export `rt-target`} {} +.. index:: rt export RT-TARGET +.. clicmd:: rt export RT-TARGET -{VNC} {rt export `rt-target`} {} -.. index:: {VNC} {rt both `rt-target`} {} +.. index:: rt both RT-TARGET +.. clicmd:: rt both RT-TARGET -{VNC} {rt both `rt-target`} {} - Specify the route target import and export value associated with the - group. A complete definition of these parameters is given above, - :ref:`VNC_NVE_Group_Configuration`. + Specify the route target import and export value associated with the group. + A complete definition of these parameters is given above, + :ref:`VNC_NVE_Group_Configuration`. .. _Configuring_Redistribution_of_Routes_from_Other_Routing_Protocols: Configuring Redistribution of Routes from Other Routing Protocols ----------------------------------------------------------------- -Routes from other protocols (including BGP) can be provided to VNC (both -for RFP and for redistribution via BGP) -from three sources: the zebra kernel routing process; -directly from the main (default) unicast BGP RIB; or directly +Routes from other protocols (including BGP) can be provided to VNC (both for +RFP and for redistribution via BGP) from three sources: the zebra kernel +routing process; directly from the main (default) unicast BGP RIB; or directly from a designated BGP unicast exterior routing RIB instance. -The protocol named in the `vnc redistribute` command indicates -the route source: -`bgp-direct` routes come directly from the main (default) -unicast BGP RIB and are available for RFP and are redistributed via BGP; -`bgp-direct-to-nve-groups` routes come directly from a designated -BGP unicast routing RIB and are made available only to RFP; -and routes from other protocols come from the zebra kernel -routing process. +The protocol named in the `vnc redistribute` command indicates the route +source: `bgp-direct` routes come directly from the main (default) unicast BGP +RIB and are available for RFP and are redistributed via BGP; +`bgp-direct-to-nve-groups` routes come directly from a designated BGP unicast +routing RIB and are made available only to RFP; and routes from other protocols +come from the zebra kernel routing process. Note that the zebra process does not need to be active if only `bgp-direct` or `bgp-direct-to-nve-groups` routes are used. -`zebra` routes -^^^^^^^^^^^^^^ +zebra routes +^^^^^^^^^^^^ Routes originating from protocols other than BGP must be obtained via the zebra routing process. Redistribution of these routes into VNC does not support policy mechanisms such as prefix-lists or route-maps. -`bgp-direct` routes -^^^^^^^^^^^^^^^^^^^ +bgp-direct routes +^^^^^^^^^^^^^^^^^ `bgp-direct` redistribution supports policy via prefix lists and route-maps. This policy is applied to incoming @@ -534,487 +469,451 @@ In `plain` mode, the route's next hop is unchanged and the RD is set based on the next hop. For `bgp-direct` redistribution, the following translations are performed: -* - The VN address is set to the original unicast route's next hop address. -* - The UN address is NOT set. (VN->UN mapping will occur via +- The VN address is set to the original unicast route's next hop address. +- The UN address is NOT set. (VN->UN mapping will occur via ENCAP route or attribute, based on `vnc advertise-un-method` setting, generated by the RFP registration of the actual NVE) -* - The RD is set to as if auto:vn:0 were specified (i.e., +- The RD is set to as if auto:vn:0 were specified (i.e., `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer=0`) -* - The RT list is included in the extended community list copied from the +- The RT list is included in the extended community list copied from the original unicast route (i.e., it must be set in the original unicast route). -In `nve-group` mode, routes are registered with VNC as -if they came from an NVE in the nve-group designated in the -`vnc redistribute nve-group` command. The following -translations are performed: +In `nve-group` mode, routes are registered with VNC as if they came from an NVE +in the nve-group designated in the `vnc redistribute nve-group` command. The +following translations are performed: -* - The next hop/VN address is set to the VN prefix configured for the +- The next hop/VN address is set to the VN prefix configured for the redistribute nve-group. -* - The UN address is set to the UN prefix configured for the - redistribute nve-group. -* - The RD is set to the RD configured for the redistribute nve-group. -* - The RT list is set to the RT list configured for the redistribute nve-group. - If `bgp-direct` routes are being redistributed, - any extended communities present in the original unicast route - will also be included. +- The UN address is set to the UN prefix configured for the redistribute + nve-group. +- The RD is set to the RD configured for the redistribute nve-group. +- The RT list is set to the RT list configured for the redistribute nve-group. + If `bgp-direct` routes are being redistributed, any extended communities + present in the original unicast route will also be included. -In `resolve-nve` mode, the next hop of the original BGP route is -typically the address of an NVE connected router (CE) connected by one or -more NVEs. -Each of the connected NVEs will register, via RFP, a VNC host route -to the CE. -This mode may be though of as a mechanism to proxy RFP registrations -of BGP unicast routes on behalf of registering NVEs. +In `resolve-nve` mode, the next hop of the original BGP route is typically the +address of an NVE connected router (CE) connected by one or more NVEs. +Each of the connected NVEs will register, via RFP, a VNC host route to the CE. +This mode may be though of as a mechanism to proxy RFP registrations of BGP +unicast routes on behalf of registering NVEs. Multiple copies of the BGP route, one per matching NVE host route, will be -added to VNC. -In other words, for a given BGP unicast route, each instance of a -RFP-registered host route to the unicast route's next hop will result -in an instance of an imported VNC route. -Each such imported VNC route will have a prefix equal to the original -BGP unicast route's prefix, and a next hop equal to the next hop of the -matching RFP-registered host route. -If there is no RFP-registered host route to the next hop of the BGP unicast -route, no corresponding VNC route will be imported. +added to VNC. In other words, for a given BGP unicast route, each instance of +a RFP-registered host route to the unicast route's next hop will result in an +instance of an imported VNC route. Each such imported VNC route will have a +prefix equal to the original BGP unicast route's prefix, and a next hop equal +to the next hop of the matching RFP-registered host route. If there is no +RFP-registered host route to the next hop of the BGP unicast route, no +corresponding VNC route will be imported. The following translations are applied: -* - The Next Hop is set to the next hop of the NVE route (i.e., the +- The Next Hop is set to the next hop of the NVE route (i.e., the VN address of the NVE). -* - The extended community list in the new route is set to the +- The extended community list in the new route is set to the union of: - * - Any extended communities in the original BGP route - * - Any extended communities in the NVE route - * - An added route-origin extended community with the next hop of the +- Any extended communities in the original BGP route + + - Any extended communities in the NVE route + - An added route-origin extended community with the next hop of the original BGP route is added to the new route. The value of the local administrator field defaults 5226 but may be configured by the user via the `roo-ec-local-admin` parameter. -* - The Tunnel Encapsulation attribute is set to the value of the Tunnel +- The Tunnel Encapsulation attribute is set to the value of the Tunnel Encapsulation attribute of the NVE route, if any. -`bgp-direct-to-nve-groups` routes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +bgp-direct-to-nve-groups routes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Unicast routes from the main or a designated instance of BGP -may be redistributed to VNC as bgp-direct-to-nve-groups routes. These -routes are NOT announced via BGP, -but they are made available for local RFP lookup in response to -queries from NVEs. +Unicast routes from the main or a designated instance of BGP may be +redistributed to VNC as bgp-direct-to-nve-groups routes. These routes are NOT +announced via BGP, but they are made available for local RFP lookup in response +to queries from NVEs. -A non-main/default BGP instance is configured using the -`bgp multiple-instance` and `router bgp AS view NAME` -commands as described elsewhere in this document. +A non-main/default BGP instance is configured using the `bgp multiple-instance` +and `router bgp AS view NAME` commands as described elsewhere in this document. -In order for a route in the unicast BGP RIB to be made -available to a querying NVE, there must already be, available to -that NVE, an (interior) VNC route matching the next hop address -of the unicast route. -When the unicast route is provided to the NVE, its next hop -is replaced by the next hop of the corresponding -NVE. If there are multiple longest-prefix-match VNC routes, -the unicast route will be replicated for each. +In order for a route in the unicast BGP RIB to be made available to a querying +NVE, there must already be, available to that NVE, an (interior) VNC route +matching the next hop address of the unicast route. When the unicast route is +provided to the NVE, its next hop is replaced by the next hop of the +corresponding NVE. If there are multiple longest-prefix-match VNC routes, the +unicast route will be replicated for each. -There is currently no policy (prefix-list or route-map) support -for `bgp-direct-to-nve-groups` routes. +There is currently no policy (prefix-list or route-map) support for +`bgp-direct-to-nve-groups` routes. Redistribution Command Syntax ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. index:: {VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} +.. index:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static +.. clicmd:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static -{VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} -.. index:: {VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view `VIEWNAME`} {} +.. index:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME +.. clicmd:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME -{VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view `VIEWNAME`} {} -.. index:: {VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} +.. index:: no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static +.. clicmd:: no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static -{VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} - Import (or do not import) prefixes from another routing - protocols. Specify both the address family to import (`ipv4` or - `ipv6`) and the protocol (`bgp`, `bgp-direct`, - `bgp-direct-to-nve-groups`, `connected`, - `kernel`, `ospf`, `rip`, or `static`). Repeat - this statement as needed for each combination of address family and - routing protocol. - Prefixes from protocol `bgp-direct` are imported from unicast BGP - in the same bgpd process. - Prefixes from all other protocols (including `bgp`) are imported - via the `zebra` kernel routing process. -.. index:: {VNC} {vnc redistribute mode plain|nve-group|resolve-nve} + Import (or do not import) prefixes from another routing protocols. Specify + both the address family to import (`ipv4` or `ipv6`) and the protocol + (`bgp`, `bgp-direct`, `bgp-direct-to-nve-groups`, `connected`, `kernel`, + `ospf`, `rip`, or `static`). Repeat this statement as needed for each + combination of address family and routing protocol. Prefixes from protocol + `bgp-direct` are imported from unicast BGP in the same bgpd process. + Prefixes from all other protocols (including `bgp`) are imported via the + `zebra` kernel routing process. -{VNC} {vnc redistribute mode plain|nve-group|resolve-nve} - Redistribute routes from other protocols into VNC using the - specified mode. - Not all combinations of modes and protocols are supported. +.. index:: vnc redistribute mode plain|nve-group|resolve-nve +.. clicmd:: vnc redistribute mode plain|nve-group|resolve-nve -.. index:: {VNC} {vnc redistribute nve-group `group-name`} {} -{VNC} {vnc redistribute nve-group `group-name`} {} -.. index:: {VNC} {no vnc redistribute nve-group `group-name`} {} + Redistribute routes from other protocols into VNC using the specified mode. + Not all combinations of modes and protocols are supported. -{VNC} {no vnc redistribute nve-group `group-name`} {} - When using `nve-group` mode, - assign (or do not assign) the NVE group `group-name` to routes - redistributed from another routing protocol. `group-name` - must be configured using `vnc nve-group`. +.. index:: vnc redistribute nve-group GROUP-NAME +.. clicmd:: vnc redistribute nve-group GROUP-NAME - The VN and UN prefixes of the nve-group must both be configured, - and each prefix must be specified as a full-length (/32 for IPv4, - /128 for IPv6) prefix. +.. index:: no vnc redistribute nve-group GROUP-NAME +.. clicmd:: no vnc redistribute nve-group GROUP-NAME -.. index:: {VNC} {vnc redistribute lifetime `lifetime`|infinite} {} -{VNC} {vnc redistribute lifetime `lifetime`|infinite} {} - Assign a registration lifetime, either `lifetime` seconds or - `infinite`, to prefixes redistributed from other routing - protocols as if they had been received via RFP registration messages - from an NVE. `lifetime` can be any integer between 1 and - 4294967295, inclusive. + When using `nve-group` mode, assign (or do not assign) the NVE group + `group-name` to routes redistributed from another routing protocol. + `group-name` must be configured using `vnc nve-group`. -.. index:: {VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`} + The VN and UN prefixes of the nve-group must both be configured, and each + prefix must be specified as a full-length (/32 for IPv4, /128 for IPv6) + prefix. -{VNC} {vnc redistribute resolve-nve roo-ec-local-admin `0-65536`} - Assign a value to the local-administrator subfield used in the - Route Origin extended community that is assigned to routes exported - under the `resolve-nve` mode. The default value is `5226`. +.. index:: vnc redistribute lifetime LIFETIME|infinite +.. clicmd:: vnc redistribute lifetime LIFETIME|infinite - The following four `prefix-list` and `route-map` commands - may be specified in the context of an nve-group or not. - If they are specified in the context of an nve-group, they - apply only if the redistribution mode is `nve-group`, - and then only for routes being redistributed from - `bgp-direct`. - If they are specified outside the context of an nve-group, then - they apply only for redistribution modes `plain` and `resolve-nve`, - and then only for routes being redistributed from `bgp-direct`. -.. index:: {VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list `LIST-NAME`} + Assign a registration lifetime, either `lifetime` seconds or `infinite`, to + prefixes redistributed from other routing protocols as if they had been + received via RFP registration messages from an NVE. `lifetime` can be any + integer between 1 and 4294967295, inclusive. -{VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list `LIST-NAME`} - When redistributing `bgp-direct` routes, - specifies that the named prefix-list should be applied. +.. index:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536 +.. clicmd:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536 -.. index:: {VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list} -{VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list} - When redistributing `bgp-direct` routes, - specifies that no prefix-list should be applied. + Assign a value to the local-administrator subfield used in the + Route Origin extended community that is assigned to routes exported + under the `resolve-nve` mode. The default value is `5226`. -.. index:: {VNC} {vnc redistribute bgp-direct route-map `MAP-NAME`} +The following four `prefix-list` and `route-map` commands may be specified +in the context of an nve-group or not. If they are specified in the context +of an nve-group, they apply only if the redistribution mode is `nve-group`, +and then only for routes being redistributed from `bgp-direct`. If they are +specified outside the context of an nve-group, then they apply only for +redistribution modes `plain` and `resolve-nve`, and then only for routes +being redistributed from `bgp-direct`. -{VNC} {vnc redistribute bgp-direct route-map `MAP-NAME`} - When redistributing `bgp-direct` routes, - specifies that the named route-map should be applied. +.. index:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME +.. clicmd:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME -.. index:: {VNC} {vnc redistribute bgp-direct no route-map} + When redistributing `bgp-direct` routes, + specifies that the named prefix-list should be applied. -{VNC} {vnc redistribute bgp-direct no route-map} - When redistributing `bgp-direct` routes, - specifies that no route-map should be applied. +.. index:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list +.. clicmd:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list + + When redistributing `bgp-direct` routes, + specifies that no prefix-list should be applied. + +.. index:: vnc redistribute bgp-direct route-map MAP-NAME +.. clicmd:: vnc redistribute bgp-direct route-map MAP-NAME + + When redistributing `bgp-direct` routes, + specifies that the named route-map should be applied. + +.. index:: vnc redistribute bgp-direct no route-map +.. clicmd:: vnc redistribute bgp-direct no route-map + + When redistributing `bgp-direct` routes, + specifies that no route-map should be applied. .. _Configuring_Export_of_Routes_to_Other_Routing_Protocols: Configuring Export of Routes to Other Routing Protocols ------------------------------------------------------- -Routes from VNC (both for RFP and for redistribution via BGP) can be -provided to other protocols, either via zebra or directly to BGP. +Routes from VNC (both for RFP and for redistribution via BGP) can be provided +to other protocols, either via zebra or directly to BGP. -It is important to note that when exporting routes to other protocols, -the downstream protocol must also be configured to import the routes. -For example, when VNC routes are exported to unicast BGP, the BGP -configuration must include a corresponding `redistribute vnc-direct` -statement. +It is important to note that when exporting routes to other protocols, the +downstream protocol must also be configured to import the routes. For example, +when VNC routes are exported to unicast BGP, the BGP configuration must include +a corresponding `redistribute vnc-direct` statement. -.. index:: {VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce} +.. index:: export bgp|zebra mode none|group-nve|registering-nve|ce +.. clicmd:: export bgp|zebra mode none|group-nve|registering-nve|ce -{VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce} - Specify how routes should be exported to bgp or zebra. - If the mode is `none`, routes are not exported. - If the mode is `group-nve`, routes are exported according - to nve-group or vrf-policy group configuration (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to - allow export, then each prefix visible to the group is exported - with next hops set to the currently-registered NVEs. - If the mode is `registering-nve`, then all VNC routes are - exported with their original next hops. - If the mode is `ce`, only VNC routes that have an NVE connected CE Router - encoded in a Route Origin Extended Community are exported. - This extended community must have an administrative value that - matches the configured `roo-ec-local-admin` value. - The next hop of the exported route is set to the encoded - NVE connected CE Router. + + Specify how routes should be exported to bgp or zebra. If the mode is + `none`, routes are not exported. If the mode is `group-nve`, routes are + exported according to nve-group or vrf-policy group configuration + (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to allow + export, then each prefix visible to the group is exported with next hops set + to the currently-registered NVEs. If the mode is `registering-nve`, then all + VNC routes are exported with their original next hops. If the mode is `ce`, + only VNC routes that have an NVE connected CE Router encoded in a Route + Origin Extended Community are exported. This extended community must have an + administrative value that matches the configured `roo-ec-local-admin` value. + The next hop of the exported route is set to the encoded NVE connected CE + Router. The default for both bgp and zebra is mode `none`. -.. index:: {VNC} {vnc export bgp|zebra group-nve group `group-name`} +.. index:: vnc export bgp|zebra group-nve group GROUP-NAME +.. clicmd:: vnc export bgp|zebra group-nve group GROUP-NAME -{VNC} {vnc export bgp|zebra group-nve group `group-name`} -.. index:: {VNC} {vnc export bgp|zebra group-nve no group `group-name`} +.. index:: vnc export bgp|zebra group-nve no group GROUP-NAME +.. clicmd:: vnc export bgp|zebra group-nve no group GROUP-NAME -{VNC} {vnc export bgp|zebra group-nve no group `group-name`} - When export mode is `group-nve`, - export (or do not export) prefixes from the specified nve-group or - vrf-policy group - to unicast BGP or to zebra. - Repeat this statement as needed for each nve-group to be exported. - Each VNC prefix that is exported will result in N exported routes to the - prefix, each with a next hop corresponding to one of the N NVEs currently - associated with the nve-group. + When export mode is `group-nve`, export (or do not export) prefixes from the + specified nve-group or vrf-policy group to unicast BGP or to zebra. Repeat + this statement as needed for each nve-group to be exported. Each VNC prefix + that is exported will result in N exported routes to the prefix, each with a + next hop corresponding to one of the N NVEs currently associated with the + nve-group. -.. index:: {VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME +.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME +.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME -{VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME - When export mode is `ce` or `registering-nve`, - specifies that the named prefix-list should be applied to routes - being exported to bgp or zebra. - Prefix-lists for ipv4 and ipv6 are independent of each other. + When export mode is `ce` or `registering-nve`, + specifies that the named prefix-list should be applied to routes + being exported to bgp or zebra. + Prefix-lists for ipv4 and ipv6 are independent of each other. -.. index:: {VNC} export bgp|zebra no ipv4|ipv6 prefix-list +.. index:: export bgp|zebra no ipv4|ipv6 prefix-list +.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list -{VNC} export bgp|zebra no ipv4|ipv6 prefix-list When export mode is `ce` or `registering-nve`, specifies that no prefix-list should be applied to routes being exported to bgp or zebra. -.. index:: {VNC} export bgp|zebra route-map MAP-NAME +.. index:: export bgp|zebra route-map MAP-NAME +.. clicmd:: export bgp|zebra route-map MAP-NAME -{VNC} export bgp|zebra route-map MAP-NAME - When export mode is `ce` or `registering-nve`, - specifies that the named route-map should be applied to routes - being exported to bgp or zebra. -.. index:: {VNC} export bgp|zebra no route-map + When export mode is `ce` or `registering-nve`, specifies that the named + route-map should be applied to routes being exported to bgp or zebra. -{VNC} export bgp|zebra no route-map - When export mode is `ce` or `registering-nve`, - specifies that no route-map should be applied to routes - being exported to bgp or zebra. +.. index:: export bgp|zebra no route-map +.. clicmd:: export bgp|zebra no route-map - When the export mode is `group-nve`, policy for exported - routes is specified per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block - via the following commands(:ref:`VNC_NVE_Group_Configuration`): + When export mode is `ce` or `registering-nve`, specifies that no route-map + should be applied to routes being exported to bgp or zebra. -.. index:: {VNC} {export bgp|zebra route-map MAP-NAME} + When the export mode is `group-nve`, policy for exported routes is specified + per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block via + the following commands(:ref:`VNC_NVE_Group_Configuration`): -{VNC} {export bgp|zebra route-map MAP-NAME} - This command is valid inside a `nve-group` `RFG-NAME` block. - It specifies that the named route-map should be applied to routes - being exported to bgp or zebra. +.. index:: export bgp|zebra route-map MAP-NAME +.. clicmd:: export bgp|zebra route-map MAP-NAME -.. index:: {VNC} {export bgp|zebra no route-map} + This command is valid inside a `nve-group` `RFG-NAME` block. It specifies + that the named route-map should be applied to routes being exported to bgp + or zebra. -{VNC} {export bgp|zebra no route-map} - This command is valid inside a `nve-group` `RFG-NAME` block. - It specifies that no route-map should be applied to routes - being exported to bgp or zebra. +.. index:: export bgp|zebra no route-map +.. clicmd:: export bgp|zebra no route-map -.. index:: {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} + This command is valid inside a `nve-group` `RFG-NAME` block. It specifies + that no route-map should be applied to routes being exported to bgp or + zebra. -{VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} - This command is valid inside a `nve-group` `RFG-NAME` block. - It specifies that the named prefix-list filter should be applied to - routes being exported to bgp or zebra. - Prefix-lists for ipv4 and ipv6 are independent of each other. +.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME +.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME -.. index:: {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} + This command is valid inside a `nve-group` `RFG-NAME` block. It specifies + that the named prefix-list filter should be applied to routes being exported + to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of each + other. -{VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} - This command is valid inside a `nve-group` `RFG-NAME` block. - It specifies that no prefix-list filter should be applied to - routes being exported to bgp or zebra. +.. index:: export bgp|zebra no ipv4|ipv6 prefix-list + +.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list + + This command is valid inside a `nve-group` `RFG-NAME` block. It specifies + that no prefix-list filter should be applied to routes being exported to + bgp or zebra. .. _Manual_Address_Control: Manual Address Control ====================== -The commands in this section can be used to augment normal dynamic VNC. -The `add vnc` commands can be used to manually add IP prefix or -Ethernet MAC address forwarding information. The `clear vnc` -commands can be used to remove manually and dynamically added -information. +The commands in this section can be used to augment normal dynamic VNC. The +`add vnc` commands can be used to manually add IP prefix or Ethernet MAC +address forwarding information. The `clear vnc` commands can be used to remove +manually and dynamically added information. -.. index:: {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]} {} +.. clicmd:: add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]] -{Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]} {} - Register an IP prefix on behalf of the NVE identified by the VN and UN - addresses. The `cost` parameter provides the administrative - preference of the forwarding information for remote advertisement. If - omitted, it defaults to 255 (lowest preference). The `lifetime` - parameter identifies the period, in seconds, that the information - remains valid. If omitted, it defaults to `infinite`. The optional - `local-next-hop` parameter is used to configure a nexthop to be - used by an NVE to reach the prefix via a locally connected CE router. - This information remains local to the NVA, i.e., not passed to other - NVAs, and is only passed to registered NVEs. When specified, it is also - possible to provide a `local-cost` parameter to provide a - forwarding preference. If omitted, it defaults to 255 (lowest - preference). + Register an IP prefix on behalf of the NVE identified by the VN and UN + addresses. The `cost` parameter provides the administrative preference of + the forwarding information for remote advertisement. If omitted, it defaults + to 255 (lowest preference). The `lifetime` parameter identifies the period, + in seconds, that the information remains valid. If omitted, it defaults to + `infinite`. The optional `local-next-hop` parameter is used to configure a + nexthop to be used by an NVE to reach the prefix via a locally connected CE + router. This information remains local to the NVA, i.e., not passed to other + NVAs, and is only passed to registered NVEs. When specified, it is also + possible to provide a `local-cost` parameter to provide a forwarding + preference. If omitted, it defaults to 255 (lowest preference). -.. index:: {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]} {} +.. clicmd:: add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))] -{Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]} {} - Register a MAC address for a logical Ethernet (L2VPN) on behalf of the - NVE identified by the VN and UN addresses. - The optional `prefix` parameter is to support enable IP address - mediation for the given prefix. The `cost` parameter provides the administrative - preference of the forwarding information. If omitted, it defaults to - 255. The `lifetime` parameter identifies the period, in seconds, - that the information remains valid. If omitted, it defaults to - `infinite`. + Register a MAC address for a logical Ethernet (L2VPN) on behalf of the NVE + identified by the VN and UN addresses. The optional `prefix` parameter is to + support enable IP address mediation for the given prefix. The `cost` + parameter provides the administrative preference of the forwarding + information. If omitted, it defaults to 255. The `lifetime` parameter + identifies the period, in seconds, that the information remains valid. If + omitted, it defaults to `infinite`. -.. index:: {Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} +.. clicmd:: clear vnc prefix (\*|A.B.C.D/M|X:X::X:X/M) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)]) -{Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} - Delete the information identified by prefix, VN address, and UN address. - Any or all of these parameters may be wilcarded to (potentially) match - more than one registration. - The optional `mac` parameter specifies a layer-2 MAC address - that must match the registration(s) to be deleted. - The optional `local-next-hop` parameter is used to - delete specific local nexthop information. + Delete the information identified by prefix, VN address, and UN address. + Any or all of these parameters may be wilcarded to (potentially) match more + than one registration. The optional `mac` parameter specifies a layer-2 MAC + address that must match the registration(s) to be deleted. The optional + `local-next-hop` parameter is used to delete specific local nexthop + information. -.. index:: {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|(1-4294967295)) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} +.. index:: clear vnc mac (\\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\\*|(1-4294967295)) (\\*|[(vn|un) (A.B.C.D|X:X::X:X|\\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\\*|A.B.C.D/M|X:X::X:X/M)]) +.. clicmd:: clear vnc mac (\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\*|(1-4294967295)) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\*|A.B.C.D/M|X:X::X:X/M)]) -{Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|(1-4294967295)) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} - Delete mac forwarding information. - Any or all of these parameters may be wilcarded to (potentially) match - more than one registration. - The default value for the `prefix` parameter is the wildcard value `*`. + Delete mac forwarding information. Any or all of these parameters may be + wilcarded to (potentially) match more than one registration. The default + value for the `prefix` parameter is the wildcard value `*`. -.. index:: {Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {} +.. index:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) +.. clicmd:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) -{Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {} - Delete prefixes associated with the NVE specified by the given VN and UN - addresses. - It is permissible to specify only one of VN or UN, in which case - any matching registration will be deleted. - It is also permissible to specify `*` in lieu of any VN or UN - address, in which case all registrations will match. + Delete prefixes associated with the NVE specified by the given VN and UN + addresses. It is permissible to specify only one of VN or UN, in which case + any matching registration will be deleted. It is also permissible to specify + `*` in lieu of any VN or UN address, in which case all registrations will + match. .. _Other_VNC-Related_Commands: Other VNC-Related Commands ========================== -Note: VNC-Related configuration can be obtained via the `show running-configuration` command when in `enable` mode. +Note: VNC-Related configuration can be obtained via the `show +running-configuration` command when in `enable` mode. -The following commands are used to clear and display -Virtual Network Control related information: +The following commands are used to clear and display Virtual Network Control +related information: -.. index:: {COMMAND} {clear vnc counters} {} +.. index:: clear vnc counters +.. clicmd:: clear vnc counters -{COMMAND} {clear vnc counters} {} - Reset the counter values stored by the NVA. Counter - values can be seen using the `show vnc` commands listed above. This - command is only available in `enable` mode. + Reset the counter values stored by the NVA. Counter + values can be seen using the `show vnc` commands listed above. This + command is only available in `enable` mode. -.. index:: {Command} {show vnc summary} {} +.. index:: show vnc summary +.. clicmd:: show vnc summary -{Command} {show vnc summary} {} - Print counter values and other general information - about the NVA. Counter values can be reset - using the `clear vnc counters` command listed below. + Print counter values and other general information + about the NVA. Counter values can be reset + using the `clear vnc counters` command listed below. -.. index:: {Command} {show vnc nves} {} +.. index:: show vnc nves +.. clicmd:: show vnc nves -{Command} {show vnc nves} {} -.. index:: {Command} {show vnc nves vn|un `address`} {} +.. index:: show vnc nves vn|un ADDRESS +.. clicmd:: show vnc nves vn|un ADDRESS -{Command} {show vnc nves vn|un `address`} {} - Display the NVA's current clients. Specifying `address` - limits the output to the NVEs whose addresses match `address`. - The time since the NVA last communicated with the NVE, per-NVE - summary counters and each NVE's addresses will be displayed. + Display the NVA's current clients. Specifying `address` limits the output to + the NVEs whose addresses match `address`. The time since the NVA last + communicated with the NVE, per-NVE summary counters and each NVE's addresses + will be displayed. -.. index:: {Command} {show vnc queries} {} +.. index:: show vnc queries +.. clicmd:: show vnc queries -{Command} {show vnc queries} {} -.. index:: {Command} {show vnc queries `prefix`} {} +.. index:: show vnc queries PREFIX +.. clicmd:: show vnc queries PREFIX -{Command} {show vnc queries `prefix`} {} - Display active Query information. Queries remain valid for the default - Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group - Response Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying - `prefix` limits the output to Query Targets that fall within - `prefix`. + Display active Query information. Queries remain valid for the default + Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group Response + Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying `prefix` limits + the output to Query Targets that fall within `prefix`. - Query information is provided for each querying NVE, and includes the - Query Target and the time remaining before the information is removed. + Query information is provided for each querying NVE, and includes the Query + Target and the time remaining before the information is removed. -.. index:: {Command} {show vnc registrations [all|local|remote|holddown|imported]} {} +.. index:: show vnc registrations [all|local|remote|holddown|imported] +.. clicmd:: show vnc registrations [all|local|remote|holddown|imported] -{Command} {show vnc registrations [all|local|remote|holddown|imported]} {} -.. index:: {Command} {show vnc registrations [all|local|remote|holddown|imported] `prefix`} {} +.. index:: show vnc registrations [all|local|remote|holddown|imported] PREFIX +.. clicmd:: show vnc registrations [all|local|remote|holddown|imported] PREFIX -{Command} {show vnc registrations [all|local|remote|holddown|imported] `prefix`} {} - Display local, remote, holddown, and/or imported registration information. - Local registrations are routes received via RFP, which are present in the - NVA Registrations Cache. - Remote registrations are routes received via BGP (VPN SAFIs), which - are present in the NVE-group import tables. - Holddown registrations are local and remote routes that have been - withdrawn but whose holddown timeouts have not yet elapsed. - Imported information represents routes that are imported into NVA and - are made available to querying NVEs. Depending on configuration, - imported routes may also be advertised via BGP. - Specifying `prefix` limits the output to the registered prefixes that - fall within `prefix`. + Display local, remote, holddown, and/or imported registration information. + Local registrations are routes received via RFP, which are present in the + NVA Registrations Cache. Remote registrations are routes received via BGP + (VPN SAFIs), which are present in the NVE-group import tables. Holddown + registrations are local and remote routes that have been withdrawn but whose + holddown timeouts have not yet elapsed. Imported information represents + routes that are imported into NVA and are made available to querying NVEs. + Depending on configuration, imported routes may also be advertised via BGP. + Specifying `prefix` limits the output to the registered prefixes that fall + within `prefix`. - Registration information includes the registered prefix, the registering - NVE addresses, the registered administrative cost, the registration - lifetime and the time since the information was registered or, in the - case of Holddown registrations, the amount of time remaining before the - information is removed. + Registration information includes the registered prefix, the registering NVE + addresses, the registered administrative cost, the registration lifetime and + the time since the information was registered or, in the case of Holddown + registrations, the amount of time remaining before the information is + removed. -.. index:: {Command} {show vnc responses [active|removed]} {} +.. index:: show vnc responses [active|removed] +.. clicmd:: show vnc responses [active|removed] -{Command} {show vnc responses [active|removed]} {} -.. index:: {Command} {show vnc responses [active|removed] `prefix`} {} +.. index:: show vnc responses [active|removed] PREFIX +.. clicmd:: show vnc responses [active|removed] PREFIX -{Command} {show vnc responses [active|removed] `prefix`} {} - Display all, active and/or removed response information which are - present in the NVA Responses Cache. Responses remain valid for the - default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or - NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.) - When Removal Responses are enabled (:ref:`General_VNC_Configuration`), - such responses are listed for the Response Lifetime. Specifying - `prefix` limits the output to the addresses that fall within - `prefix`. + Display all, active and/or removed response information which are + present in the NVA Responses Cache. Responses remain valid for the + default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or + NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.) + When Removal Responses are enabled (:ref:`General_VNC_Configuration`), + such responses are listed for the Response Lifetime. Specifying + `prefix` limits the output to the addresses that fall within + `prefix`. - Response information is provided for each querying NVE, and includes - the response prefix, the prefix-associated registering NVE addresses, - the administrative cost, the provided response lifetime and the time - remaining before the information is to be removed or will become inactive. + Response information is provided for each querying NVE, and includes + the response prefix, the prefix-associated registering NVE addresses, + the administrative cost, the provided response lifetime and the time + remaining before the information is to be removed or will become inactive. -.. index:: {Command} {show memory vnc} {} +.. index:: show memory vnc +.. clicmd:: show memory vnc -{Command} {show memory vnc} {} - Print the number of memory items allocated by the NVA. + + Print the number of memory items allocated by the NVA. .. _Example_VNC_and_VNC-GW_Configurations: Example VNC and VNC-GW Configurations ===================================== +.. [#] The nve-id is carriedin the route distinguisher. It is the second octet + of the eight-octet route distinguisher generated for Ethernet / L2 + advertisements. The first octet is a constant 0xFF, and the third + through eighth octets are set to the L2 + ethernet address being advertised. diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst index d94eba110e..eeb856cbd4 100644 --- a/doc/user/vtysh.rst +++ b/doc/user/vtysh.rst @@ -4,56 +4,58 @@ VTY shell ********* -*vtysh* provides a combined frontend to all FRR daemons in a -single combined session. It is enabled by default at build time, but can -be disabled through the *--disable-vtysh* option to -*./configure*. +.. program:: configure -*vtysh* has a configuration file, :file:`vtysh.conf`. The location -of that file cannot be changed from :file:`|INSTALL_PREFIX_ETC|` since -it contains options controlling authentication behavior. This file will -also not be written by configuration-save commands, it is intended to be -updated manually by an administrator with an external editor. +*vtysh* provides a combined frontend to all FRR daemons in a single combined +session. It is enabled by default at build time, but can be disabled through +the :option:`--disable-vtysh` option to the configure script. + +*vtysh* has a configuration file, :file:`vtysh.conf`. The location of that +file cannot be changed from |INSTALL_PREFIX_ETC| since it contains options +controlling authentication behavior. This file will also not be written by +configuration-save commands, it is intended to be updated manually by an +administrator with an external editor. + +.. warning:: + + This also means the ``hostname`` and ``banner motd`` commands (which both do + have effect for vtysh) need to be manually updated in :file:`vtysh.conf`. -@quotation Warning -This also means the *hostname* and *banner motd* commands -(which both do have effect for vtysh) need to be manually updated in -:file:`vtysh.conf`. -@end quotation Permissions and setup requirements ================================== *vtysh* connects to running daemons through Unix sockets located in -:file:`|INSTALL_PREFIX_STATE|`. Running vtysh thus requires access to -that directory, plus membership in the *|INSTALL_VTY_GROUP|* -group (which is the group that the daemons will change ownership of their -sockets to). +|INSTALL_PREFIX_STATE|. Running vtysh thus requires access to that directory, +plus membership in the |INSTALL_VTY_GROUP| group (which is the group that the +daemons will change ownership of their sockets to). -To restrict access to FRR configuration, make sure no unauthorized users -are members of the *|INSTALL_VTY_GROUP|* group. +To restrict access to FRR configuration, make sure no unauthorized users are +members of the |INSTALL_VTY_GROUP| group. PAM support (experimental) -------------------------- -vtysh has working (but rather useless) PAM support. It will perform -an "authenticate" PAM call using *|PACKAGE_NAME|* as service -name. No other (accounting, session, password change) calls will be -performed by vtysh. +vtysh has working (but rather useless) PAM support. It will perform an +"authenticate" PAM call using |PACKAGE_NAME| as service name. No other +(accounting, session, password change) calls will be performed by vtysh. -Users using vtysh still need to have appropriate access to the daemons' -VTY sockets, usually by being member of the *|INSTALL_VTY_GROUP|* -group. If they have this membership, PAM support is useless since they can -connect to daemons and issue commands using some other tool. Alternatively, -the *vtysh* binary could be made SGID (set group ID) to the -*|INSTALL_VTY_GROUP|* group. @strong{No security guarantees are -made for this configuration}. +Users using vtysh still need to have appropriate access to the daemons' VTY +sockets, usually by being member of the |INSTALL_VTY_GROUP| group. If they +have this membership, PAM support is useless since they can connect to daemons +and issue commands using some other tool. Alternatively, the *vtysh* binary +could be made SGID (set group ID) to the |INSTALL_VTY_GROUP| group. -.. index:: {Command} {username `username` nopassword} {} +.. warning:: + + No security guarantees are made for this configuration. + + +.. index:: username USERNAME nopassword +.. clicmd:: username USERNAME nopassword -{Command} {username `username` nopassword} {} If PAM support is enabled at build-time, this command allows disabling the - use of PAM on a per-user basis. If vtysh finds that an user is trying to + use of PAM on a per-user basis. If vtysh finds that an user is trying to use vtysh and a "nopassword" entry is found, no calls to PAM will be made at all. @@ -64,108 +66,98 @@ Integrated configuration mode ============================= Integrated configuration mode uses a single configuration file, -:file:`frr.conf`, for all daemons. This replaces the individual files like +:file:`frr.conf`, for all daemons. This replaces the individual files like :file:`zebra.conf` or :file:`bgpd.conf`. -:file:`frr.conf` is located in :file:`|INSTALL_PREFIX_ETC|`. All -daemons check for the existence of this file at startup, and if it exists -will not load their individual configuration files. Instead, -*vtysh -b* must be invoked to process :file:`frr.conf` and apply -its settings to the individual daemons. +:file:`frr.conf` is located in |INSTALL_PREFIX_ETC|. All daemons check for the +existence of this file at startup, and if it exists will not load their +individual configuration files. Instead, ``vtysh -b`` must be invoked to +process :file:`frr.conf` and apply its settings to the individual daemons. + +.. warning:: + + *vtysh -b* must also be executed after restarting any daemon. -@quotation Warning -*vtysh -b* must also be executed after restarting any daemon. -@end quotation Configuration saving, file ownership and permissions ---------------------------------------------------- -The :file:`frr.conf` file is not written by any of the daemons; instead -*vtysh* contains the neccessary logic to collect configuration from -all of the daemons, combine it and write it out. +The :file:`frr.conf` file is not written by any of the daemons; instead *vtysh* +contains the neccessary logic to collect configuration from all of the daemons, +combine it and write it out. -@quotation Warning -Daemons must be running for *vtysh* to be able to collect their -configuration. Any configuration from non-running daemons is permanently -lost after doing a configuration save. -@end quotation +.. warning:: -Since the *vtysh* command may be running as ordinary user on the -system, configuration writes will be tried through *watchfrr*, -using the *write integrated* command internally. Since -*watchfrr* is running as superuser, *vtysh* is able to -ensure correct ownership and permissions on :file:`frr.conf`. + Daemons must be running for *vtysh* to be able to collect their + configuration. Any configuration from non-running daemons is permanently + lost after doing a configuration save. -If *watchfrr* is not running or the configuration write fails, -*vtysh* will attempt to directly write to the file. This is likely -to fail if running as unprivileged user; alternatively it may leave the -file with incorrect owner or permissions. +Since the *vtysh* command may be running as ordinary user on the system, +configuration writes will be tried through *watchfrr*, using the ``write +integrated`` command internally. Since *watchfrr* is running as superuser, +*vtysh* is able to ensure correct ownership and permissions on +:file:`frr.conf`. -Writing the configuration can be triggered directly by invoking -*vtysh -w*. This may be useful for scripting. Note this command -should be run as either the superuser or the FRR user. +If *watchfrr* is not running or the configuration write fails, *vtysh* will +attempt to directly write to the file. This is likely to fail if running as +unprivileged user; alternatively it may leave the file with incorrect owner or +permissions. -We recommend you do not mix the use of the two types of files. Further, it -is better not to use the integrated frr.conf file, as any syntax error in -it can lead to /all/ of your daemons being unable to start up. Per daemon -files are more robust as impact of errors in configuration are limited to -the daemon in whose file the error is made. +Writing the configuration can be triggered directly by invoking *vtysh -w*. +This may be useful for scripting. Note this command should be run as either the +superuser or the FRR user. -.. index:: {Command} {service integrated-vtysh-config} {} +We recommend you do not mix the use of the two types of files. Further, it is +better not to use the integrated :file:`frr.conf` file, as any syntax error in +it can lead to /all/ of your daemons being unable to start up. Per daemon files +are more robust as impact of errors in configuration are limited to the daemon +in whose file the error is made. -{Command} {service integrated-vtysh-config} {} -.. index:: {Command} {no service integrated-vtysh-config} {} +.. index:: service integrated-vtysh-config +.. clicmd:: service integrated-vtysh-config -{Command} {no service integrated-vtysh-config} {} - Control whether integrated :file:`frr.conf` file is written when - 'write file' is issued. +.. index:: no service integrated-vtysh-config +.. clicmd:: no service integrated-vtysh-config - These commands need to be placed in :file:`vtysh.conf` to have any effect. - Note that since :file:`vtysh.conf` is not written by FRR itself, they - therefore need to be manually placed in that file. + Control whether integrated :file:`frr.conf` file is written when + 'write file' is issued. - This command has 3 states: + These commands need to be placed in :file:`vtysh.conf` to have any effect. + Note that since :file:`vtysh.conf` is not written by FRR itself, they + therefore need to be manually placed in that file. + + This command has 3 states: -`` - *service integrated-vtysh-config* - + service integrated-vtysh-config *vtysh* will always write :file:`frr.conf`. -`` - *no service integrated-vtysh-config* - + no service integrated-vtysh-config *vtysh* will never write :file:`frr.conf`; instead it will ask daemons to write their individual configuration files. - -`` - Neither option present (default) - - *vtysh* will check whether :file:`frr.conf` exists. If it does, - configuration writes will update that file. Otherwise, writes are performed + Neither option present (default) + *vtysh* will check whether :file:`frr.conf` exists. If it does, + configuration writes will update that file. Otherwise, writes are performed through the individual daemons. - This command is primarily intended for packaging/distribution purposes, to - preset one of the two operating modes and ensure consistent operation across - installations. + This command is primarily intended for packaging/distribution purposes, to + preset one of the two operating modes and ensure consistent operation across + installations. -.. index:: {Command} {write integrated} {} +.. index:: write integrated +.. clicmd:: write integrated -{Command} {write integrated} {} - Unconditionally (regardless of *service integrated-vtysh-config* - setting) write out integrated :file:`frr.conf` file through - *watchfrr*. If *watchfrr* is not running, this command - is unavailable. + Unconditionally (regardless of ``service integrated-vtysh-config`` setting) + write out integrated :file:`frr.conf` file through *watchfrr*. If *watchfrr* + is not running, this command is unavailable. +.. warning:: -Caveats -======= - -Configuration changes made while some daemon is not running will be invisible -to that daemon. The daemon will start up with its saved configuration -(either in its individual configuration file, or in :file:`frr.conf`). -This is particularly troublesome for route-maps and prefix lists, which would -otherwise be synchronized between daemons. - + Configuration changes made while some daemon is not running will be + invisible to that daemon. The daemon will start up with its saved + configuration (either in its individual configuration file, or in + :file:`frr.conf`). This is particularly troublesome for route-maps and + prefix lists, which would otherwise be synchronized between daemons. + From a5a48dbf209fa2628704ad15cefe8d1ae8187737 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 30 Jan 2018 15:52:16 -0500 Subject: [PATCH 037/148] doc: additional merging Manually merged: 6347ca161f94af4baa853bf09be7fff076e75491 Signed-off-by: Quentin Young --- doc/user/installation.rst | 6 ++++++ doc/user/routemap.rst | 16 ++++++++++++++++ doc/user/rpki.rst | 4 ++-- doc/user/vnc.rst | 30 +++++++++++++++--------------- 4 files changed, 39 insertions(+), 17 deletions(-) diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 094b8b4ce4..356d243e47 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -122,6 +122,12 @@ customize the build to include or exclude specific features and dependencies. Enable support for Equal Cost Multipath. `ARG` is the maximum number of ECMP paths to allow, set to 0 to allow unlimited number of paths. +.. option:: --enable-realms + + Enable the support of Linux Realms. Convert tag values from 1-255 into a + realm value when inserting into the Linux kernel. Then routing policy can be + assigned to the realm. See the tc man page. + .. option:: --disable-rtadv Disable support IPV6 router advertisement in zebra. diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 8422153f93..735838b0e6 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -148,6 +148,12 @@ Route Map Match Command Matches the specified `metric`. +.. index:: match tag TAG +.. clicmd:: match tag TAG + + Matches the specified tag value associated with the route. This tag value + can be in the range of (1-4294967295). + .. index:: match local-preference METRIC .. clicmd:: match local-preference METRIC @@ -182,6 +188,16 @@ Route Map Match Command Route Map Set Command ===================== +.. index:: set tag TAG +.. clicmd:: set tag TAG + +.. program:: configure + + Set a tag on the matched route. This tag value can be from (1-4294967295). + Additionally if you have compiled with the :option:`--enable-realms` + configure option. Tag values from (1-255) are sent to the Linux kernel as a + realm value. Then route policy can be applied. See the tc man page. + .. index:: set ip next-hop IPV4_ADDRESS .. clicmd:: set ip next-hop IPV4_ADDRESS diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index 059b936491..f3e8a85bb7 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -257,5 +257,5 @@ RPKI Configuration Example route-map rpki permit 40 ! -.. [Securing-BGP] `Geoff Huston, Randy Bush: Securing BGP, In: The Internet Protocol Journal, Volume 14, No. 2, 2011. `_ -.. [Resource-Certification] `Geoff Huston: Resource Certification, In: The Internet Protocol Journal, Volume 12, No.1, 2009. `_ +.. [Securing-BGP] Geoff Huston, Randy Bush: Securing BGP, In: The Internet Protocol Journal, Volume 14, No. 2, 2011. +.. [Resource-Certification] Geoff Huston: Resource Certification, In: The Internet Protocol Journal, Volume 12, No.1, 2009. diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 7cd2153dc3..bd2fdb34f1 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -4,15 +4,15 @@ VNC and VNC-GW ************** -This chapter describes how to use Virtual Network Control (:abbr:`VNC`) -services, including Network Virtualization Authority (:abbr:`NVA`) and VNC -Gateway (:abbr:`VNC-GW`) functions. Background information on NVAs, Network -Virtualization Edges (:abbr:`NVE`s), underlay networks (:abbr:`UN`s), and -virtual networks (:abbr:`VN`s) is available from the -`IETF Network Virtualization Overlays `_ -:abbr:`VNC-GW (VNC-Gateways)` support the import/export of routing information -between VNC and customer edge routers (:abbr:`CE` s) operating within a VN. -Both IP/Layer 3 (L3) VNs, and IP with Ethernet/Layer 2 (L2) VNs are supported. +This chapter describes how to use :abbr:`VNC (Virtual Network Control)` +services, including :abbr:`NVA (Network Virtualization Authority)` and +:abbr:`VNC-GW (VNC Gateway)` functions. Background information on NVAs, +:abbr:`NVE (Network Virtualization Edge)` s, :abbr:`UN (Underlay Network)` s, +and :abbr:`VN (Virtual Network)` is available from the +`IETF `_. :abbr:`VNC-GW (VNC Gateway)` s +support the import/export of routing information between VNC and :abbr:`CE +(customer edge)` routers operating within a VN. Both IP/Layer 3 (L3) VNs, and +IP with Ethernet/Layer 2 (L2) VNs are supported. BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN information between NVAs. BGP based IP VPN support is defined in :rfc:`4364`, @@ -902,7 +902,7 @@ Mesh NVA Configuration This example includes three NVAs, nine NVEs, and two NVE groups. Note that while not shown, a single physical device may support multiple logical NVEs. -:figure:`fig-vnc-mesh` shows ``code NVA-1`` (192.168.1.100), ``NVA 2`` +:ref:`fig-vnc-mesh` shows ``code NVA-1`` (192.168.1.100), ``NVA 2`` (192.168.1.101), and ``NVA 3`` (192.168.1.102), which are connected in a full mesh. Each is a member of the autonomous system 64512. Each NVA provides VNC services to three NVE clients in the 172.16.0.0/16 virtual-network address @@ -919,7 +919,7 @@ Each NVA advertises NVE underlay-network IP addresses using the Tunnel Encapsulation Attribute. .. _vnc-fig-vnc-mesh: -.. figure:: ../figure/fig-vnc-mesh.png +.. figure:: ../figures/fig-vnc-mesh.png :align: center :alt: Three-way Mesh @@ -1021,7 +1021,7 @@ and combine NVA and VNC-GW functions in a single FRR instance. Meshed NVEs and VNC-GWs -As shown in :figure:`fig-vnc-gw`, NVAs and VNC-GWs are connected in a full iBGP +As shown in :ref:`vnc-fig-vnc-gw`, NVAs and VNC-GWs are connected in a full iBGP mesh. The VNC-GWs each have two CEs configured as route-reflector clients. Each client provides BGP updates with unicast routes that the VNC-GW reflects to the other client. The VNC-GW also imports these unicast routes into VPN @@ -1130,7 +1130,7 @@ VNC with FRR Route Reflector Configuration ------------------------------------------ A route reflector eliminates the need for a fully meshed NVA network by acting -as the hub between NVAs. :figure:`vnc-fig-vnc-frr-route-reflector` shows BGP +as the hub between NVAs. :ref:`vnc-fig-vnc-frr-route-reflector` shows BGP route reflector ``BGP Route Reflector 1`` (192.168.1.100) as a route reflector for NVAs ``NVA 2``(192.168.1.101) and ``NVA 3`` (192.168.1.102). @@ -1238,7 +1238,7 @@ This example is identical to :ref:`vnc-with-frr-route-reflector-configuration` with the exception that the route reflector is a commercial router. Only the VNC-relevant configuration is provided. -.. figure:: ../figures/fig-vnc-commercial-route-reflector +.. figure:: ../figures/fig-vnc-commercial-route-reflector.png :align: center :alt: Commercial Route Reflector @@ -1349,7 +1349,7 @@ reflector configuration. BGP route reflectors ``BGP Route Reflector 1`` and ``Commercial Router`` are the route reflectors for NVAs ``NVA 2`` and ``NVA 3``. The two NVAs have connections to both route reflectors. -.. figure:: ../fig-vnc-redundant-route-reflectors.png +.. figure:: ../figures/fig-vnc-redundant-route-reflectors.png :align: center :alt: Redundant Route Reflectors From e3c1296cb4c6f5161d2447b194c853ae423c7467 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 30 Jan 2018 16:08:10 -0500 Subject: [PATCH 038/148] doc: add pim.rst Manually merged: 42642babdd1bb3a350affb459f56a4494461c203 Signed-off-by: Quentin Young --- doc/user/index.rst | 1 + doc/user/pim.rst | 409 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 410 insertions(+) create mode 100644 doc/user/pim.rst diff --git a/doc/user/index.rst b/doc/user/index.rst index 2e4636ec8c..0929fb51ad 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -24,4 +24,5 @@ Welcome to FRR's documentation! kernel snmp protocol + pim diff --git a/doc/user/pim.rst b/doc/user/pim.rst new file mode 100644 index 0000000000..80fa0cdeb3 --- /dev/null +++ b/doc/user/pim.rst @@ -0,0 +1,409 @@ +.. _PIM: + +*** +PIM +*** + +PIM -- Protocol Independent Multicast + +*pimd* supports pim-sm as well as igmp v2 and v3. pim is +vrf aware and can work within the context of vrf's in order to +do S,G mrouting. + +.. _Starting_and_Stopping_pimd: + +Starting and Stopping pimd +========================== + +The default configuration file name of *pimd*'s is :file:`pimd.conf`. When +invoked *pimd* searches directory |INSTALL_PREFIX_ETC|. If +:file:`pimd.conf` is not there then next search current directory. + +*pimd* requires zebra for proper operation. Additionally *pimd* depends on +routing properly setup and working in the network that it is working on. + +:: + + # zebra -d + # pimd -d + + +Please note that *zebra* must be invoked before *pimd*. + +To stop *pimd* please use:: + + kill `cat /var/run/pimd.pid` + +Certain signals have special meanings to *pimd*. + ++---------+---------------------------------------------------------------------+ +| Signal | Meaning | ++=========+=====================================================================+ +| SIGUSR1 | Rotate the *pimd* logfile | ++---------+---------------------------------------------------------------------+ +| SIGINT | *pimd* sweeps all installed PIM mroutes then terminates gracefully. | +| SIGTERM | | ++---------+---------------------------------------------------------------------+ + +*pimd* invocation options. Common options that can be specified +(:ref:`Common_Invocation_Options`). + +.. index:: ip pim rp A.B.C.D A.B.C.D/M +.. clicmd:: ip pim rp A.B.C.D A.B.C.D/M + + In order to use pim, it is necessary to configure a RP for join messages to + be sent to. Currently the only methodology to do this is via static rp + commands. All routers in the pim network must agree on these values. The + first ip address is the RP's address and the second value is the matching + prefix of group ranges covered. This command is vrf aware, to configure for + a vrf, enter the vrf submode. + +.. index:: ip pim spt-switchover infinity-and-beyond +.. clicmd:: ip pim spt-switchover infinity-and-beyond + + On the last hop router if it is desired to not switch over to the SPT tree. + Configure this command. This command is vrf aware, to configure for a vrf, + enter the vrf submode. + +.. index:: ip pim ecmp +.. clicmd:: ip pim ecmp + + If pim has the a choice of ECMP nexthops for a particular RPF, pim will + cause S,G flows to be spread out amongst the nexthops. If this command is + not specified then the first nexthop found will be used. This command is vrf + aware, to configure for a vrf, enter the vrf submode. + +.. index:: ip pim ecmp rebalance +.. clicmd:: ip pim ecmp rebalance + + If pim is using ECMP and an interface goes down, cause pim to rebalance all + S,G flows aross the remaining nexthops. If this command is not configured + pim only modifies those S,G flows that were using the interface that went + down. This command is vrf aware, to configure for a vrf, enter the vrf + submode. + +.. index:: ip pim join-prune-interval (60-600) +.. clicmd:: ip pim join-prune-interval (60-600) + + Modify the join/prune interval that pim uses to the new value. Time is + specified in seconds. This command is vrf aware, to configure for a vrf, + enter the vrf submode. + +.. index:: ip pim keep-alive-timer (31-60000) +.. clicmd:: ip pim keep-alive-timer (31-60000) + + Modify the time out value for a S,G flow from 31-60000 seconds. 31 seconds + is choosen for a lower bound because some hardware platforms cannot see data + flowing in better than 30 second chunks. This comand is vrf aware, to + configure for a vrf, enter the vrf submode. + +.. index:: ip pim packets (1-100) +.. clicmd:: ip pim packets (1-100) + + When processing packets from a neighbor process the number of packets + incoming at one time before moving on to the next task. The default value is + 3 packets. This command is only useful at scale when you can possibly have + a large number of pim control packets flowing. This command is vrf aware, to + configure for a vrf, enter the vrf submode. + +.. index:: ip pim register-suppress-time (5-60000) +.. clicmd:: ip pim register-suppress-time (5-60000) + + Modify the time that pim will register suppress a FHR will send register + notifications to the kernel. This command is vrf aware, to configure for a + vrf, enter the vrf submode. + +.. index:: ip pim send-v6-secondary +.. clicmd:: ip pim send-v6-secondary + + When sending pim hello packets tell pim to send any v6 secondary addresses + on the interface. This information is used to allow pim to use v6 nexthops + in it's decision for RPF lookup. This command is vrf aware, to configure for + a vrf, enter the vrf submode. + +.. index:: ip pim ssm prefix-list WORD +.. clicmd:: ip pim ssm prefix-list WORD + + Specify a range of group addresses via a prefix-list that forces pim to + never do SM over. This command is vrf aware, to configure for a vrf, enter + the vrf submode. + +.. index:: ip multicast rpf-lookup-mode WORD +.. clicmd:: ip multicast rpf-lookup-mode WORD + + Modify how PIM does RPF lookups in the zebra routing table. You can use + these choices: + + longer-prefix + Lookup the RPF in both tables using the longer prefix as a match + + lower-distance + Lookup the RPF in both tables using the lower distance as a match + + mrib-only + Lookup in the Multicast RIB only + + mrib-then-urib + Lookup in the Multicast RIB then the Unicast Rib, returning first found. + This is the default value for lookup if this command is not entered + + urib-only + Lookup in the Unicast Rib only. + + +.. _PIM_Interface_Configuration: + +PIM Interface Configuration +=========================== + +PIM interface commands allow you to configure an interface as either a Receiver +or a interface that you would like to form pim neighbors on. If the interface +is in a vrf, enter the interface command with the vrf keyword at the end. + +.. index:: ip pim bfd +.. clicmd:: ip pim bfd + + Turns on BFD support for PIM for this interface. + +.. index:: ip pim drpriority (1-4294967295) +.. clicmd:: ip pim drpriority (1-4294967295) + + Set the DR Priority for the interface. This command is useful to allow the + user to influence what node becomes the DR for a lan segment. + +.. index:: ip pim hello (1-180) (1-180) +.. clicmd:: ip pim hello (1-180) (1-180) + + Set the pim hello and hold interval for a interface. + +.. index:: ip pim sm +.. clicmd:: ip pim sm + + Tell pim that we would like to use this interface to form pim neighbors + over. Please note we will *not* accept igmp reports over this interface with + this command. + +.. index:: ip igmp +.. clicmd:: ip igmp + + Tell pim to receive IGMP reports and Query on this interface. The default + version is v3. This command is useful on the LHR. + +.. index:: ip igmp query-interval (1-1800) +.. clicmd:: ip igmp query-interval (1-1800) + + Set the IGMP query interval that PIM will use. + +.. index:: ip igmp query-max-response-time (10-250) +.. clicmd:: ip igmp query-max-response-time (10-250) + + Set the IGMP query response timeout value. If an report is not returned in + the specified time we will assume the S,G or \*,G has timed out. + +.. index:: ip igmp version (2-3) +.. clicmd:: ip igmp version (2-3) + + Set the IGMP version used on this interface. The default value is 3. + +.. index:: ip multicat boundary oil WORD +.. clicmd:: ip multicat boundary oil WORD + + Set a pim multicast boundary, based upon the WORD prefix-list. If a pim join + or IGMP report is received on this interface and the Group is denyed by the + prefix-list, PIM will ignore the join or report. + +.. _PIM_Multicast_RIB_insertion: + +PIM Multicast RIB insertion:: +============================= + +In order to influence Multicast RPF lookup, it is possible to insert +into zebra routes for the Multicast RIB. These routes are only +used for RPF lookup and will not be used by zebra for insertion +into the kernel *or* for normal rib processing. As such it is +possible to create weird states with these commands. Use with +caution. Most of the time this will not be necessary. + +.. index:: ip mroute A.B.C.D/M A.B.C.D (1-255) +.. clicmd:: ip mroute A.B.C.D/M A.B.C.D (1-255) + + Insert into the Multicast Rib Route A.B.C.D/M with specified nexthop. The + distance can be specified as well if desired. + +.. index:: ip mroute A.B.C.D/M INTERFACE (1-255) +.. clicmd:: ip mroute A.B.C.D/M INTERFACE (1-255) + + Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE. + The distance can be specified as well if desired. + +.. _Show_PIM_Information: + +Show PIM Information +==================== + +All PIM show commands are vrf aware and typically allow you to insert a +specified vrf command if information is desired about a specific vrf. If no +vrf is specified then the default vrf is assumed. Finally the special keyword +'all' allows you to look at all vrfs for the command. Naming a vrf 'all' will +cause great confusion. + +.. index:: show ip multicast +.. clicmd:: show ip multicast + + Display various information about the interfaces used in this pim instance. + +.. index:: show ip mroute +.. clicmd:: show ip mroute + + Display information about installed into the kernel S,G mroutes. + +.. index:: show ip mroute count +.. clicmd:: show ip mroute count + + Display information about installed into the kernel S,G mroutes and in + addition display data about packet flow for the mroutes. + +.. index:: show ip pim assert +.. clicmd:: show ip pim assert + + Display information about asserts in the PIM system for S,G mroutes. + +.. index:: show ip pim assert-internal +.. clicmd:: show ip pim assert-internal + + Display internal assert state for S,G mroutes + +.. index:: show ip pim assert-metric +.. clicmd:: show ip pim assert-metric + + Display metric information about assert state for S,G mroutes + +.. index:: show ip pim assert-winner-metric +.. clicmd:: show ip pim assert-winner-metric + + Display winner metric for assert state for S,G mroutes + +.. index:: show ip pim group-type +.. clicmd:: show ip pim group-type + + Display SSM group ranges. + +.. index:: show ip pim interface +.. clicmd:: show ip pim interface + + Display information about interfaces PIM is using. + +.. index:: show ip pim join +.. clicmd:: show ip pim join + + Display information about PIM joins received. + +.. index:: show ip pim local-membership +.. clicmd:: show ip pim local-membership + + Display information about PIM interface local-membership. + +.. index:: show ip pim neighbor +.. clicmd:: show ip pim neighbor + + Display information about PIM neighbors. + +.. index:: show ip pim nexthop +.. clicmd:: show ip pim nexthop + + Display information about pim nexthops that are being used. + +.. index:: show ip pim nexthop-lookup +.. clicmd:: show ip pim nexthop-lookup + + Display information about a S,G pair and how the RPF would be choosen. This + is especially useful if there are ECMP's available from the RPF lookup. + +.. index:: show ip pim rp-info +.. clicmd:: show ip pim rp-info + + Display information about RP's that are configured on this router. + +.. index:: show ip pim rpf +.. clicmd:: show ip pim rpf + + Display information about currently being used S,G's and their RPF lookup + information. Additionally display some statistics about what has been + happening on the router. + +.. index:: show ip pim secondary +.. clicmd:: show ip pim secondary + + Display information about an interface and all the secondary addresses + associated with it. + +.. index:: show ip pim state +.. clicmd:: show ip pim state + + Display information about known S,G's and incoming interface as well as the + OIL and how they were choosen. + +.. index:: show ip pim upstream +.. clicmd:: show ip pim upstream + + Display upstream information about a S,G mroute. + +.. index:: show ip pim upstream-join-desired +.. clicmd:: show ip pim upstream-join-desired + +{show PIM Information} {show ip pim upstream-join-desired} {} + Display upstream information for S,G's and if we desire to + join the mcast tree + +.. index:: show ip pim upstream-rpf +.. clicmd:: show ip pim upstream-rpf + + Display upstream information for S,G's and the RPF data associated with them. + +.. index:: show ip rpf +.. clicmd:: show ip rpf + + Display the multicast RIB created in zebra. + +PIM Debug Commands +================== + +The debugging subsystem for PIM behaves in accordance with how FRR handles +debugging. You can specify debugging at the enable cli mode as well as the +configure cli mode. If you specify debug commands in the configuration cli +mode, the debug commands can be persistent across restarts of the FRR pimd if +the config was written out. + +.. index:: debug pim events +.. clicmd:: debug pim events + + This turns on debugging for PIM system events. Especially timers. + +.. index:: debug pim nht +.. clicmd:: debug pim nht + + This turns on debugging for PIM nexthop tracking. It will display + information about RPF lookups and information about when a nexthop changes. + +.. index:: debug pim packet-dump +.. clicmd:: debug pim packet-dump + + This turns on an extraordinary amount of data. Each pim packet sent and + received is dumped for debugging purposes. This should be considered a + developer only command. + +.. index:: debug pim packets +.. clicmd:: debug pim packets + + This turns on information about packet generation for sending and about + packet handling from a received packet. + +.. index:: debug pim trace +.. clicmd:: debug pim trace + + This traces pim code and how it is running. + +.. index:: debug pim zebra +.. clicmd:: debug pim zebra + + This gathers data about events from zebra that come up through the zapi. From cb39e63e59ab338eb1edb40df4af6e55a5ecd9a9 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 30 Jan 2018 16:12:26 -0500 Subject: [PATCH 039/148] doc: manually merge isis.rst Manually merged: ee65c55e2a923dd9499baa3207d629a09600ba64 Signed-off-by: Quentin Young --- doc/user/isisd.rst | 53 +++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 27 deletions(-) diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 4b29c81639..1dffc2cf8f 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -574,36 +574,35 @@ First, the 'zebra.conf' part::: ! interface eth0 ip address 10.2.2.2/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab + link-params + max-bw 1.25e+07 + max-rsv-bw 1.25e+06 + unrsv-bw 0 1.25e+06 + unrsv-bw 1 1.25e+06 + unrsv-bw 2 1.25e+06 + unrsv-bw 3 1.25e+06 + unrsv-bw 4 1.25e+06 + unrsv-bw 5 1.25e+06 + unrsv-bw 6 1.25e+06 + unrsv-bw 7 1.25e+06 + admin-grp 0xab ! interface eth1 ip address 10.1.1.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - mpls-te neighbor 10.1.1.2 as 65000 + link-params + enable + metric 100 + max-bw 1.25e+07 + max-rsv-bw 1.25e+06 + unrsv-bw 0 1.25e+06 + unrsv-bw 1 1.25e+06 + unrsv-bw 2 1.25e+06 + unrsv-bw 3 1.25e+06 + unrsv-bw 4 1.25e+06 + unrsv-bw 5 1.25e+06 + unrsv-bw 6 1.25e+06 + unrsv-bw 7 1.25e+06 + neighbor 10.1.1.2 as 65000 Then the 'isisd.conf' itself::: From 3eb7a2f08bc8ee3b3f69ae0fda37a662fdb752a1 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 30 Jan 2018 16:14:24 -0500 Subject: [PATCH 040/148] doc: reorganize * Move all developer related docs into developer/ * Move all figures into their own directory * Move manpages to own directory Signed-off-by: Quentin Young --- doc/{ => developer}/BGP-TypeCode | 0 doc/{ => developer}/OSPF-API.md | 0 doc/{ => developer}/dev-modules.md | 0 doc/{ => developer}/draft-zebra-00.ms | 0 doc/{ => developer}/ldpd-basic-test-setup.md | 0 doc/{ => figures}/fig-normal-processing.dia | 0 doc/{ => figures}/fig-normal-processing.png | Bin doc/{ => figures}/fig-normal-processing.txt | 0 doc/{ => figures}/fig-rs-processing.dia | 0 doc/{ => figures}/fig-rs-processing.png | Bin doc/{ => figures}/fig-rs-processing.txt | 0 .../fig-vnc-commercial-route-reflector.dia | 0 .../fig-vnc-commercial-route-reflector.png | Bin .../fig-vnc-commercial-route-reflector.txt | 0 .../fig-vnc-frr-route-reflector.dia | 0 .../fig-vnc-frr-route-reflector.png | Bin .../fig-vnc-frr-route-reflector.txt | 0 doc/{ => figures}/fig-vnc-gw-rr.dia | 0 doc/{ => figures}/fig-vnc-gw-rr.png | Bin doc/{ => figures}/fig-vnc-gw-rr.txt | 0 doc/{ => figures}/fig-vnc-gw.dia | 0 doc/{ => figures}/fig-vnc-gw.png | Bin doc/{ => figures}/fig-vnc-gw.txt | 0 doc/{ => figures}/fig-vnc-mesh.dia | 0 doc/{ => figures}/fig-vnc-mesh.png | Bin doc/{ => figures}/fig-vnc-mesh.txt | 0 .../fig-vnc-redundant-route-reflectors.dia | 0 .../fig-vnc-redundant-route-reflectors.png | Bin .../fig-vnc-redundant-route-reflectors.txt | 0 doc/{ => figures}/fig_topologies_full.dia | 0 doc/{ => figures}/fig_topologies_full.png | Bin doc/{ => figures}/fig_topologies_full.txt | 0 doc/{ => figures}/fig_topologies_rs.dia | 0 doc/{ => figures}/fig_topologies_rs.png | Bin doc/{ => figures}/fig_topologies_rs.txt | 0 doc/{ => figures}/git_branches.svg | 0 doc/{ => figures}/ospf_api_architecture.png | Bin doc/{ => figures}/ospf_api_msghdr.png | Bin doc/{ => figures}/ospf_api_msgs1.png | Bin doc/{ => figures}/ospf_api_msgs2.png | Bin doc/frr.1.in | 65 -------- doc/frr.texi | 140 ------------------ doc/index.rst | 0 doc/{ => manpages}/bgpd.8.in | 0 doc/{ => manpages}/eigrpd.8.in | 0 doc/{ => manpages}/frr-args.8.in | 0 doc/{ => manpages}/isisd.8.in | 0 doc/{ => manpages}/ldpd.8.in | 0 doc/{ => manpages}/nhrpd.8.in | 0 doc/{ => manpages}/ospf6d.8.in | 0 doc/{ => manpages}/ospfclient.8.in | 0 doc/{ => manpages}/ospfd.8.in | 0 doc/{ => manpages}/pimd.8.in | 0 doc/{ => manpages}/ripd.8.in | 0 doc/{ => manpages}/ripngd.8.in | 0 doc/{ => manpages}/watchfrr.8.in | 0 doc/{ => manpages}/zebra.8.in | 0 doc/{ => user}/Useful_Sysctl_Settings.md | 0 doc/vtysh.1.in | 103 ------------- 59 files changed, 308 deletions(-) rename doc/{ => developer}/BGP-TypeCode (100%) rename doc/{ => developer}/OSPF-API.md (100%) rename doc/{ => developer}/dev-modules.md (100%) rename doc/{ => developer}/draft-zebra-00.ms (100%) rename doc/{ => developer}/ldpd-basic-test-setup.md (100%) rename doc/{ => figures}/fig-normal-processing.dia (100%) rename doc/{ => figures}/fig-normal-processing.png (100%) rename doc/{ => figures}/fig-normal-processing.txt (100%) rename doc/{ => figures}/fig-rs-processing.dia (100%) rename doc/{ => figures}/fig-rs-processing.png (100%) rename doc/{ => figures}/fig-rs-processing.txt (100%) rename doc/{ => figures}/fig-vnc-commercial-route-reflector.dia (100%) rename doc/{ => figures}/fig-vnc-commercial-route-reflector.png (100%) rename doc/{ => figures}/fig-vnc-commercial-route-reflector.txt (100%) rename doc/{ => figures}/fig-vnc-frr-route-reflector.dia (100%) rename doc/{ => figures}/fig-vnc-frr-route-reflector.png (100%) rename doc/{ => figures}/fig-vnc-frr-route-reflector.txt (100%) rename doc/{ => figures}/fig-vnc-gw-rr.dia (100%) rename doc/{ => figures}/fig-vnc-gw-rr.png (100%) rename doc/{ => figures}/fig-vnc-gw-rr.txt (100%) rename doc/{ => figures}/fig-vnc-gw.dia (100%) rename doc/{ => figures}/fig-vnc-gw.png (100%) rename doc/{ => figures}/fig-vnc-gw.txt (100%) rename doc/{ => figures}/fig-vnc-mesh.dia (100%) rename doc/{ => figures}/fig-vnc-mesh.png (100%) rename doc/{ => figures}/fig-vnc-mesh.txt (100%) rename doc/{ => figures}/fig-vnc-redundant-route-reflectors.dia (100%) rename doc/{ => figures}/fig-vnc-redundant-route-reflectors.png (100%) rename doc/{ => figures}/fig-vnc-redundant-route-reflectors.txt (100%) rename doc/{ => figures}/fig_topologies_full.dia (100%) rename doc/{ => figures}/fig_topologies_full.png (100%) rename doc/{ => figures}/fig_topologies_full.txt (100%) rename doc/{ => figures}/fig_topologies_rs.dia (100%) rename doc/{ => figures}/fig_topologies_rs.png (100%) rename doc/{ => figures}/fig_topologies_rs.txt (100%) rename doc/{ => figures}/git_branches.svg (100%) rename doc/{ => figures}/ospf_api_architecture.png (100%) rename doc/{ => figures}/ospf_api_msghdr.png (100%) rename doc/{ => figures}/ospf_api_msgs1.png (100%) rename doc/{ => figures}/ospf_api_msgs2.png (100%) delete mode 100644 doc/frr.1.in delete mode 100644 doc/frr.texi delete mode 100644 doc/index.rst rename doc/{ => manpages}/bgpd.8.in (100%) rename doc/{ => manpages}/eigrpd.8.in (100%) rename doc/{ => manpages}/frr-args.8.in (100%) rename doc/{ => manpages}/isisd.8.in (100%) rename doc/{ => manpages}/ldpd.8.in (100%) rename doc/{ => manpages}/nhrpd.8.in (100%) rename doc/{ => manpages}/ospf6d.8.in (100%) rename doc/{ => manpages}/ospfclient.8.in (100%) rename doc/{ => manpages}/ospfd.8.in (100%) rename doc/{ => manpages}/pimd.8.in (100%) rename doc/{ => manpages}/ripd.8.in (100%) rename doc/{ => manpages}/ripngd.8.in (100%) rename doc/{ => manpages}/watchfrr.8.in (100%) rename doc/{ => manpages}/zebra.8.in (100%) rename doc/{ => user}/Useful_Sysctl_Settings.md (100%) delete mode 100644 doc/vtysh.1.in diff --git a/doc/BGP-TypeCode b/doc/developer/BGP-TypeCode similarity index 100% rename from doc/BGP-TypeCode rename to doc/developer/BGP-TypeCode diff --git a/doc/OSPF-API.md b/doc/developer/OSPF-API.md similarity index 100% rename from doc/OSPF-API.md rename to doc/developer/OSPF-API.md diff --git a/doc/dev-modules.md b/doc/developer/dev-modules.md similarity index 100% rename from doc/dev-modules.md rename to doc/developer/dev-modules.md diff --git a/doc/draft-zebra-00.ms b/doc/developer/draft-zebra-00.ms similarity index 100% rename from doc/draft-zebra-00.ms rename to doc/developer/draft-zebra-00.ms diff --git a/doc/ldpd-basic-test-setup.md b/doc/developer/ldpd-basic-test-setup.md similarity index 100% rename from doc/ldpd-basic-test-setup.md rename to doc/developer/ldpd-basic-test-setup.md diff --git a/doc/fig-normal-processing.dia b/doc/figures/fig-normal-processing.dia similarity index 100% rename from doc/fig-normal-processing.dia rename to doc/figures/fig-normal-processing.dia diff --git a/doc/fig-normal-processing.png b/doc/figures/fig-normal-processing.png similarity index 100% rename from doc/fig-normal-processing.png rename to doc/figures/fig-normal-processing.png diff --git a/doc/fig-normal-processing.txt b/doc/figures/fig-normal-processing.txt similarity index 100% rename from doc/fig-normal-processing.txt rename to doc/figures/fig-normal-processing.txt diff --git a/doc/fig-rs-processing.dia b/doc/figures/fig-rs-processing.dia similarity index 100% rename from doc/fig-rs-processing.dia rename to doc/figures/fig-rs-processing.dia diff --git a/doc/fig-rs-processing.png b/doc/figures/fig-rs-processing.png similarity index 100% rename from doc/fig-rs-processing.png rename to doc/figures/fig-rs-processing.png diff --git a/doc/fig-rs-processing.txt b/doc/figures/fig-rs-processing.txt similarity index 100% rename from doc/fig-rs-processing.txt rename to doc/figures/fig-rs-processing.txt diff --git a/doc/fig-vnc-commercial-route-reflector.dia b/doc/figures/fig-vnc-commercial-route-reflector.dia similarity index 100% rename from doc/fig-vnc-commercial-route-reflector.dia rename to doc/figures/fig-vnc-commercial-route-reflector.dia diff --git a/doc/fig-vnc-commercial-route-reflector.png b/doc/figures/fig-vnc-commercial-route-reflector.png similarity index 100% rename from doc/fig-vnc-commercial-route-reflector.png rename to doc/figures/fig-vnc-commercial-route-reflector.png diff --git a/doc/fig-vnc-commercial-route-reflector.txt b/doc/figures/fig-vnc-commercial-route-reflector.txt similarity index 100% rename from doc/fig-vnc-commercial-route-reflector.txt rename to doc/figures/fig-vnc-commercial-route-reflector.txt diff --git a/doc/fig-vnc-frr-route-reflector.dia b/doc/figures/fig-vnc-frr-route-reflector.dia similarity index 100% rename from doc/fig-vnc-frr-route-reflector.dia rename to doc/figures/fig-vnc-frr-route-reflector.dia diff --git a/doc/fig-vnc-frr-route-reflector.png b/doc/figures/fig-vnc-frr-route-reflector.png similarity index 100% rename from doc/fig-vnc-frr-route-reflector.png rename to doc/figures/fig-vnc-frr-route-reflector.png diff --git a/doc/fig-vnc-frr-route-reflector.txt b/doc/figures/fig-vnc-frr-route-reflector.txt similarity index 100% rename from doc/fig-vnc-frr-route-reflector.txt rename to doc/figures/fig-vnc-frr-route-reflector.txt diff --git a/doc/fig-vnc-gw-rr.dia b/doc/figures/fig-vnc-gw-rr.dia similarity index 100% rename from doc/fig-vnc-gw-rr.dia rename to doc/figures/fig-vnc-gw-rr.dia diff --git a/doc/fig-vnc-gw-rr.png b/doc/figures/fig-vnc-gw-rr.png similarity index 100% rename from doc/fig-vnc-gw-rr.png rename to doc/figures/fig-vnc-gw-rr.png diff --git a/doc/fig-vnc-gw-rr.txt b/doc/figures/fig-vnc-gw-rr.txt similarity index 100% rename from doc/fig-vnc-gw-rr.txt rename to doc/figures/fig-vnc-gw-rr.txt diff --git a/doc/fig-vnc-gw.dia b/doc/figures/fig-vnc-gw.dia similarity index 100% rename from doc/fig-vnc-gw.dia rename to doc/figures/fig-vnc-gw.dia diff --git a/doc/fig-vnc-gw.png b/doc/figures/fig-vnc-gw.png similarity index 100% rename from doc/fig-vnc-gw.png rename to doc/figures/fig-vnc-gw.png diff --git a/doc/fig-vnc-gw.txt b/doc/figures/fig-vnc-gw.txt similarity index 100% rename from doc/fig-vnc-gw.txt rename to doc/figures/fig-vnc-gw.txt diff --git a/doc/fig-vnc-mesh.dia b/doc/figures/fig-vnc-mesh.dia similarity index 100% rename from doc/fig-vnc-mesh.dia rename to doc/figures/fig-vnc-mesh.dia diff --git a/doc/fig-vnc-mesh.png b/doc/figures/fig-vnc-mesh.png similarity index 100% rename from doc/fig-vnc-mesh.png rename to doc/figures/fig-vnc-mesh.png diff --git a/doc/fig-vnc-mesh.txt b/doc/figures/fig-vnc-mesh.txt similarity index 100% rename from doc/fig-vnc-mesh.txt rename to doc/figures/fig-vnc-mesh.txt diff --git a/doc/fig-vnc-redundant-route-reflectors.dia b/doc/figures/fig-vnc-redundant-route-reflectors.dia similarity index 100% rename from doc/fig-vnc-redundant-route-reflectors.dia rename to doc/figures/fig-vnc-redundant-route-reflectors.dia diff --git a/doc/fig-vnc-redundant-route-reflectors.png b/doc/figures/fig-vnc-redundant-route-reflectors.png similarity index 100% rename from doc/fig-vnc-redundant-route-reflectors.png rename to doc/figures/fig-vnc-redundant-route-reflectors.png diff --git a/doc/fig-vnc-redundant-route-reflectors.txt b/doc/figures/fig-vnc-redundant-route-reflectors.txt similarity index 100% rename from doc/fig-vnc-redundant-route-reflectors.txt rename to doc/figures/fig-vnc-redundant-route-reflectors.txt diff --git a/doc/fig_topologies_full.dia b/doc/figures/fig_topologies_full.dia similarity index 100% rename from doc/fig_topologies_full.dia rename to doc/figures/fig_topologies_full.dia diff --git a/doc/fig_topologies_full.png b/doc/figures/fig_topologies_full.png similarity index 100% rename from doc/fig_topologies_full.png rename to doc/figures/fig_topologies_full.png diff --git a/doc/fig_topologies_full.txt b/doc/figures/fig_topologies_full.txt similarity index 100% rename from doc/fig_topologies_full.txt rename to doc/figures/fig_topologies_full.txt diff --git a/doc/fig_topologies_rs.dia b/doc/figures/fig_topologies_rs.dia similarity index 100% rename from doc/fig_topologies_rs.dia rename to doc/figures/fig_topologies_rs.dia diff --git a/doc/fig_topologies_rs.png b/doc/figures/fig_topologies_rs.png similarity index 100% rename from doc/fig_topologies_rs.png rename to doc/figures/fig_topologies_rs.png diff --git a/doc/fig_topologies_rs.txt b/doc/figures/fig_topologies_rs.txt similarity index 100% rename from doc/fig_topologies_rs.txt rename to doc/figures/fig_topologies_rs.txt diff --git a/doc/git_branches.svg b/doc/figures/git_branches.svg similarity index 100% rename from doc/git_branches.svg rename to doc/figures/git_branches.svg diff --git a/doc/ospf_api_architecture.png b/doc/figures/ospf_api_architecture.png similarity index 100% rename from doc/ospf_api_architecture.png rename to doc/figures/ospf_api_architecture.png diff --git a/doc/ospf_api_msghdr.png b/doc/figures/ospf_api_msghdr.png similarity index 100% rename from doc/ospf_api_msghdr.png rename to doc/figures/ospf_api_msghdr.png diff --git a/doc/ospf_api_msgs1.png b/doc/figures/ospf_api_msgs1.png similarity index 100% rename from doc/ospf_api_msgs1.png rename to doc/figures/ospf_api_msgs1.png diff --git a/doc/ospf_api_msgs2.png b/doc/figures/ospf_api_msgs2.png similarity index 100% rename from doc/ospf_api_msgs2.png rename to doc/figures/ospf_api_msgs2.png diff --git a/doc/frr.1.in b/doc/frr.1.in deleted file mode 100644 index 528358a8d0..0000000000 --- a/doc/frr.1.in +++ /dev/null @@ -1,65 +0,0 @@ -.TH Frr 1 "27 July 2006" "@PACKAGE_FULLNAME@ Systemd Script" "Version @PACKAGE_VERSION@" -.SH NAME -frr \- a systemd interaction script -.SH SYNOPSIS -.B frr -[ -.B start -] -.br -.B frr -[ -.B stop -] -.br -.B frr -[ -.B reload -] -.br -.B frr -[ -.B restart -] -.br -.B frr -[ -.B status -] -.br -.SH DESCRIPTION -.B @PACKAGE_NAME@ -is a systemd interaction script for the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B frr -command: -.IP start -Start enabled Frr daemons -.IP stop -Stop enabled Frr daemons -.IP reload -Reload modified configuration files -.IP restart -Stop all running daemons and then restart them -.IP status -Status of all the daemons -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8) -.SH BUGS -.B frr -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/frr.texi b/doc/frr.texi deleted file mode 100644 index d268b4b981..0000000000 --- a/doc/frr.texi +++ /dev/null @@ -1,140 +0,0 @@ -\input texinfo @c -*- texinfo -*- - -@c Set variables - sourced from defines.texi -@include defines.texi - -@c %**start of header -@setfilename frr.info -@c Set variables - sourced from defines.texi -@include defines.texi -@settitle @uref{@value{PACKAGE_URL},,@value{PACKAGE_NAME}} -@c %**end of header - -@copying -@value{COPYRIGHT_STR} -@quotation - -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. - -@end quotation -@end copying - -@c Info entry -@dircategory Routing Software: -@direntry -* @value{PACKAGE_NAME}: (frr). The Frr Suite -@end direntry - -@c @smallbook - -@ifinfo -This file documents the @uref{@value{PACKAGE_URL},,Frr Software Routing Suite} -which manages common TCP/IP routing protocols. - -This document was generated for version @value{PACKAGE_VERSION}. - -@insertcopying -@end ifinfo - -@titlepage -@title @uref{@value{PACKAGE_URL},,Frr} -@subtitle A routing software package for TCP/IP networks -@subtitle @uref{@value{PACKAGE_URL},,@value{PACKAGE_NAME}} @value{PACKAGE_VERSION} -@author @value{AUTHORS} - -@page -@vskip 0pt plus 1filll - -@insertcopying -@end titlepage -@page - -@ifnottex -@node Top -@top Frr -- With Virtual Network Control - -@uref{@value{PACKAGE_URL},,Frr} is an advanced routing software package -that provides a suite of TCP/IP based routing protocols. This is the Manual -for @value{PACKAGE_STRING}. @uref{@value{PACKAGE_URL},,Frr} is a fork of -@uref{http://www.quagga.net,,Quagga}. - -@insertcopying -@end ifnottex - -@menu -* Overview:: -* Installation:: -* Basic commands:: -* Zebra:: -* RIP:: -* RIPng:: -* OSPFv2:: -* OSPFv3:: -* ISIS:: -* NHRP:: -* BGP:: -* Configuring Frr as a Route Server:: -* VNC and VNC-GW:: -* VTY shell:: -* Filtering:: -* Route Map:: -* IPv6 Support:: -* Kernel Interface:: -* SNMP Support:: -* Zebra Protocol:: -* Packet Binary Dump Format:: -* Command Index:: -* VTY Key Index:: -* Index:: -@end menu -@contents - -@include overview.texi -@include install.texi -@include basic.texi -@include main.texi -@include ripd.texi -@include ripngd.texi -@include ospfd.texi -@include ospf6d.texi -@include isisd.texi -@include nhrpd.texi -@include bgpd.texi -@include routeserver.texi -@include vnc.texi -@include vtysh.texi -@include filter.texi -@include routemap.texi -@include ipv6.texi -@include kernel.texi -@include snmp.texi -@include protocol.texi -@include appendix.texi - -@node Command Index -@unnumbered Command Index - -@printindex fn - -@node VTY Key Index -@unnumbered VTY Key Index - -@printindex ky - -@node Index -@unnumbered Index - -@printindex cp -@bye diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/bgpd.8.in b/doc/manpages/bgpd.8.in similarity index 100% rename from doc/bgpd.8.in rename to doc/manpages/bgpd.8.in diff --git a/doc/eigrpd.8.in b/doc/manpages/eigrpd.8.in similarity index 100% rename from doc/eigrpd.8.in rename to doc/manpages/eigrpd.8.in diff --git a/doc/frr-args.8.in b/doc/manpages/frr-args.8.in similarity index 100% rename from doc/frr-args.8.in rename to doc/manpages/frr-args.8.in diff --git a/doc/isisd.8.in b/doc/manpages/isisd.8.in similarity index 100% rename from doc/isisd.8.in rename to doc/manpages/isisd.8.in diff --git a/doc/ldpd.8.in b/doc/manpages/ldpd.8.in similarity index 100% rename from doc/ldpd.8.in rename to doc/manpages/ldpd.8.in diff --git a/doc/nhrpd.8.in b/doc/manpages/nhrpd.8.in similarity index 100% rename from doc/nhrpd.8.in rename to doc/manpages/nhrpd.8.in diff --git a/doc/ospf6d.8.in b/doc/manpages/ospf6d.8.in similarity index 100% rename from doc/ospf6d.8.in rename to doc/manpages/ospf6d.8.in diff --git a/doc/ospfclient.8.in b/doc/manpages/ospfclient.8.in similarity index 100% rename from doc/ospfclient.8.in rename to doc/manpages/ospfclient.8.in diff --git a/doc/ospfd.8.in b/doc/manpages/ospfd.8.in similarity index 100% rename from doc/ospfd.8.in rename to doc/manpages/ospfd.8.in diff --git a/doc/pimd.8.in b/doc/manpages/pimd.8.in similarity index 100% rename from doc/pimd.8.in rename to doc/manpages/pimd.8.in diff --git a/doc/ripd.8.in b/doc/manpages/ripd.8.in similarity index 100% rename from doc/ripd.8.in rename to doc/manpages/ripd.8.in diff --git a/doc/ripngd.8.in b/doc/manpages/ripngd.8.in similarity index 100% rename from doc/ripngd.8.in rename to doc/manpages/ripngd.8.in diff --git a/doc/watchfrr.8.in b/doc/manpages/watchfrr.8.in similarity index 100% rename from doc/watchfrr.8.in rename to doc/manpages/watchfrr.8.in diff --git a/doc/zebra.8.in b/doc/manpages/zebra.8.in similarity index 100% rename from doc/zebra.8.in rename to doc/manpages/zebra.8.in diff --git a/doc/Useful_Sysctl_Settings.md b/doc/user/Useful_Sysctl_Settings.md similarity index 100% rename from doc/Useful_Sysctl_Settings.md rename to doc/user/Useful_Sysctl_Settings.md diff --git a/doc/vtysh.1.in b/doc/vtysh.1.in deleted file mode 100644 index ba8f3df720..0000000000 --- a/doc/vtysh.1.in +++ /dev/null @@ -1,103 +0,0 @@ -.TH VTYSH 1 "27 July 2006" "@PACKAGE_FULLNAME@ VTY shell" "Version @PACKAGE_VERSION@" -.SH NAME -vtysh \- a integrated shell for @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B vtysh -[ -.B \-b -] -.br -.B vtysh -[ -.B \-E -] [ -.B \-d -.I daemon -] -] [ -.B \-c -.I command -] -.SH DESCRIPTION -.B vtysh -is a integrated shell for -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B vtysh -command: -.IP "\fB\-b, \-\-boot\fP" -Execute boot startup configuration. It makes sense only if integrated config -file is in use (not default in @PACKAGE_FULLNAME@). See Info file -\fB@PACKAGE_NAME@\fR for more info. -.IP "\fB\-c, \-\-command \fIcommand\fP" -Specify command to be executed under batch mode. It behaves like -c option in -any other shell - -.I command -is executed and -.B vtysh -exits. - -It's useful for gathering info from @PACKAGE_FULLNAME@ daemons or reconfiguring -daemons from inside shell scripts, etc. -Note that multiple commands may be executed by using more than one --c option and/or embedding linefeed characters inside the -.I command -string. -.IP "\fB\-d, \-\-daemon \fIdaemon_name\fP" -Specify which daemon to connect to. By default, -.B vtysh -attempts to connect to all @PACKAGE_FULLNAME@ daemons running on the system. With this -flag, one can specify a single daemon to connect to instead. For example, -specifying '-d ospfd' will connect only to ospfd. This can be particularly -useful inside scripts with -c where the command is targeted for a single daemon. -.IP "\fB\-e, \-\-execute \fIcommand\fP" -Alias for -c. It's here only for compatibility with Zebra routing software and -older Frr versions. This will be removed in future. -.IP "\fB\-E, \-\-echo\fP" -When the -c option is being used, this flag will cause the standard -.B vtysh -prompt and command to be echoed prior to displaying the results. -This is particularly useful to separate the results -when executing multiple commands. -.IP "\fB\-h, \-\-help\fP" -Display a usage message on standard output and exit. -.SH ENVIRONMENT VARIABLES -.IP "\fBVTYSH_PAGER\fR" -This should be the name of the pager to use. Default is \fBmore\fR. -.SH FILES -.TP -.BI @CFG_SYSCONF@/vtysh.conf -The default location of the -.B vtysh -config file. -.TP -.BI @CFG_SYSCONF@/frr.conf -The default location of the integrated @PACKAGE_FULLNAME@ routing engine config file -if integrated config file is in use (not default). -.TP -.BI ${HOME}/.history_frr -Location of history of commands entered via cli -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8) -.SH BUGS -.B vtysh -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - From 612b3314f2277a751e917d1e36f267809fc01a49 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 30 Jan 2018 16:20:00 -0500 Subject: [PATCH 041/148] doc: remove extraneous texi files Took the changes from these and applied in previous commits. Bye bye. Signed-off-by: Quentin Young --- doc/bgpd.texi | 2142 -------------------------------------------- doc/install.texi | 291 ------ doc/isisd.texi | 433 --------- doc/ospfd.texi | 930 ------------------- doc/pimd.texi | 366 -------- doc/routemap.texi | 285 ------ doc/user/ospfd.rst | 96 +- doc/vnc.texi | 1593 -------------------------------- 8 files changed, 64 insertions(+), 6072 deletions(-) delete mode 100644 doc/bgpd.texi delete mode 100644 doc/install.texi delete mode 100644 doc/isisd.texi delete mode 100644 doc/ospfd.texi delete mode 100644 doc/pimd.texi delete mode 100644 doc/routemap.texi delete mode 100644 doc/vnc.texi diff --git a/doc/bgpd.texi b/doc/bgpd.texi deleted file mode 100644 index 83483f5697..0000000000 --- a/doc/bgpd.texi +++ /dev/null @@ -1,2142 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c Portions: -@c Copyright @copyright{} 2015 Hewlett Packard Enterprise Development LP -@c See file frr.texi for copying conditions. -@node BGP -@chapter BGP - -@acronym{BGP} stands for a Border Gateway Protocol. The lastest BGP version -is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway -Protocols and de-fact standard of Inter Domain routing protocol. -BGP-4 is described in @cite{RFC1771, A Border Gateway Protocol -4 (BGP-4)}. - -Many extensions have been added to @cite{RFC1771}. @cite{RFC2858, -Multiprotocol Extensions for BGP-4} provides multiprotocol support to -BGP-4. - -@menu -* Starting BGP:: -* BGP router:: -* BGP MED:: -* BGP network:: -* BGP Peer:: -* BGP Peer Group:: -* BGP Address Family:: -* Autonomous System:: -* BGP Communities Attribute:: -* BGP Extended Communities Attribute:: -* BGP Large Communities Attribute:: -* Displaying BGP information:: -* Capability Negotiation:: -* Route Reflector:: -* Route Server:: -* BGP Regular Expressions:: -* How to set up a 6-Bone connection:: -* Dump BGP packets and table:: -* BGP Configuration Examples:: -* Prefix Origin Validation Using RPKI:: -@end menu - -@node Starting BGP -@section Starting BGP - -Default configuration file of @command{bgpd} is @file{bgpd.conf}. -@command{bgpd} searches the current directory first then -@value{INSTALL_PREFIX_ETC}/bgpd.conf. All of bgpd's command must be -configured in @file{bgpd.conf}. - -@command{bgpd} specific invocation options are described below. Common -options may also be specified (@pxref{Common Invocation Options}). - -@table @samp -@item -p @var{PORT} -@itemx --bgp_port=@var{PORT} -Set the bgp protocol's port number. - -@item -r -@itemx --retain -When program terminates, retain BGP routes added by zebra. - -@item -l -@itemx --listenon -Specify a specific IP address for bgpd to listen on, rather than its -default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd -to an internal address, or to run multiple bgpd processes on one host. - -@end table - -@node BGP router -@section BGP router - - First of all you must configure BGP router with @command{router bgp} -command. To configure BGP router, you need AS number. AS number is an -identification of autonomous system. BGP protocol uses the AS number -for detecting whether the BGP connection is internal one or external one. - -@deffn Command {router bgp @var{asn}} {} -Enable a BGP protocol process with the specified @var{asn}. After -this statement you can input any @code{BGP Commands}. You can not -create different BGP process under different @var{asn} without -specifying @code{multiple-instance} (@pxref{Multiple instance}). -@end deffn - -@deffn Command {no router bgp @var{asn}} {} -Destroy a BGP protocol process with the specified @var{asn}. -@end deffn - -@deffn {BGP} {bgp router-id @var{A.B.C.D}} {} -This command specifies the router-ID. If @command{bgpd} connects to @command{zebra} it gets -interface and address information. In that case default router ID value -is selected as the largest IP Address of the interfaces. When -@code{router zebra} is not enabled @command{bgpd} can't get interface information -so @code{router-id} is set to 0.0.0.0. So please set router-id by hand. -@end deffn - -@menu -* BGP distance:: -* BGP decision process:: -* BGP route flap dampening:: -@end menu - -@node BGP distance -@subsection BGP distance - -@deffn {BGP} {distance bgp <1-255> <1-255> <1-255>} {} -This command change distance value of BGP. Each argument is distance -value for external routes, internal routes and local routes. -@end deffn - -@deffn {BGP} {distance <1-255> @var{A.B.C.D/M}} {} -@deffnx {BGP} {distance <1-255> @var{A.B.C.D/M} @var{word}} {} -This command set distance value to -@end deffn - -@node BGP decision process -@subsection BGP decision process - -The decision process Frr BGP uses to select routes is as follows: - -@table @asis -@item 1. Weight check -prefer higher local weight routes to lower routes. - -@item 2. Local preference check -prefer higher local preference routes to lower. - -@item 3. Local route check -Prefer local routes (statics, aggregates, redistributed) to received routes. - -@item 4. AS path length check -Prefer shortest hop-count AS_PATHs. - -@item 5. Origin check -Prefer the lowest origin type route. That is, prefer IGP origin routes to -EGP, to Incomplete routes. - -@item 6. MED check -Where routes with a MED were received from the same AS, -prefer the route with the lowest MED. @xref{BGP MED}. - -@item 7. External check -Prefer the route received from an external, eBGP peer -over routes received from other types of peers. - -@item 8. IGP cost check -Prefer the route with the lower IGP cost. - -@item 9. Multi-path check -If multi-pathing is enabled, then check whether -the routes not yet distinguished in preference may be considered equal. If -@ref{bgp bestpath as-path multipath-relax} is set, all such routes are -considered equal, otherwise routes received via iBGP with identical AS_PATHs -or routes received from eBGP neighbours in the same AS are considered equal. - -@item 10 Already-selected external check - -Where both routes were received from eBGP peers, then prefer the route which -is already selected. Note that this check is not applied if @ref{bgp -bestpath compare-routerid} is configured. This check can prevent some cases -of oscillation. - -@item 11. Router-ID check -Prefer the route with the lowest @w{router-ID}. If the -route has an @w{ORIGINATOR_ID} attribute, through iBGP reflection, then that -router ID is used, otherwise the @w{router-ID} of the peer the route was -received from is used. - -@item 12. Cluster-List length check -The route with the shortest cluster-list -length is used. The cluster-list reflects the iBGP reflection path the -route has taken. - -@item 13. Peer address -Prefer the route received from the peer with the higher -transport layer address, as a last-resort tie-breaker. - -@end table - -@deffn {BGP} {bgp bestpath as-path confed} {} -This command specifies that the length of confederation path sets and -sequences should should be taken into account during the BGP best path -decision process. -@end deffn - -@deffn {BGP} {bgp bestpath as-path multipath-relax} {} -@anchor{bgp bestpath as-path multipath-relax} -This command specifies that BGP decision process should consider paths -of equal AS_PATH length candidates for multipath computation. Without -the knob, the entire AS_PATH must match for multipath computation. -@end deffn - -@deffn {BGP} {bgp bestpath compare-routerid} {} -@anchor{bgp bestpath compare-routerid} - -Ensure that when comparing routes where both are equal on most metrics, -including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken -based on router-ID. - -If this option is enabled, then the already-selected check, where -already selected eBGP routes are preferred, is skipped. - -If a route has an @w{ORIGINATOR_ID} attribute because it has been reflected, -that @w{ORIGINATOR_ID} will be used. Otherwise, the router-ID of the peer the -route was received from will be used. - -The advantage of this is that the route-selection (at this point) will be -more deterministic. The disadvantage is that a few or even one lowest-ID -router may attract all trafic to otherwise-equal paths because of this -check. It may increase the possibility of MED or IGP oscillation, unless -other measures were taken to avoid these. The exact behaviour will be -sensitive to the iBGP and reflection topology. - -@end deffn - - -@node BGP route flap dampening -@subsection BGP route flap dampening - -@deffn {BGP} {bgp dampening @var{<1-45>} @var{<1-20000>} @var{<1-20000>} @var{<1-255>}} {} -This command enables BGP route-flap dampening and specifies dampening parameters. - -@table @asis -@item @asis{half-life} -Half-life time for the penalty -@item @asis{reuse-threshold} -Value to start reusing a route -@item @asis{suppress-threshold} -Value to start suppressing a route -@item @asis{max-suppress} -Maximum duration to suppress a stable route -@end table - -The route-flap damping algorithm is compatible with @cite{RFC2439}. The use of this command -is not recommended nowadays, see @uref{http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378}. -@end deffn - -@node BGP MED -@section BGP MED - -The BGP MED (Multi_Exit_Discriminator) attribute has properties which can -cause subtle convergence problems in BGP. These properties and problems -have proven to be hard to understand, at least historically, and may still -not be widely understood. The following attempts to collect together and -present what is known about MED, to help operators and Frr users in -designing and configuring their networks. - -The BGP @acronym{MED, Multi_Exit_Discriminator} attribute is intended to -allow one AS to indicate its preferences for its ingress points to another -AS. The MED attribute will not be propagated on to another AS by the -receiving AS - it is `non-transitive' in the BGP sense. - -E.g., if AS X and AS Y have 2 different BGP peering points, then AS X -might set a MED of 100 on routes advertised at one and a MED of 200 at the -other. When AS Y selects between otherwise equal routes to or via -AS X, AS Y should prefer to take the path via the lower MED peering of 100 with -AS X. Setting the MED allows an AS to influence the routing taken to it -within another, neighbouring AS. - -In this use of MED it is not really meaningful to compare the MED value on -routes where the next AS on the paths differs. E.g., if AS Y also had a -route for some destination via AS Z in addition to the routes from AS X, and -AS Z had also set a MED, it wouldn't make sense for AS Y to compare AS Z's -MED values to those of AS X. The MED values have been set by different -administrators, with different frames of reference. - -The default behaviour of BGP therefore is to not compare MED values across -routes received from different neighbouring ASes. In Frr this is done by -comparing the neighbouring, left-most AS in the received AS_PATHs of the -routes and only comparing MED if those are the same. - -@c TeXInfo uses the old, non-UTF-8 capable, pdftex, and so -@c doesn't render TeX the unicode precedes character correctly in PDF, etc. -@c Using a TeX code on the other hand doesn't work for non-TeX outputs -@c (plaintext, e.g.). So, use an output-conditional macro. - -@iftex -@macro mprec{} -@math{\\prec} -@end macro -@end iftex - -@ifnottex -@macro mprec{} -@math{≺} -@end macro -@end ifnottex - -Unfortunately, this behaviour of MED, of sometimes being compared across -routes and sometimes not, depending on the properties of those other routes, -means MED can cause the order of preference over all the routes to be -undefined. That is, given routes A, B, and C, if A is preferred to B, and B -is preferred to C, then a well-defined order should mean the preference is -transitive (in the sense of orders @footnote{For some set of objects to have -an order, there @emph{must} be some binary ordering relation that is defined -for @emph{every} combination of those objects, and that relation @emph{must} -be transitive. I.e.@:, if the relation operator is @mprec{}, and if -a @mprec{} b and b @mprec{} c then that relation must carry over -and it @emph{must} be that a @mprec{} c for the objects to have an -order. The ordering relation may allow for equality, i.e. -a @mprec{} b and b @mprec{} a may both be true amd imply that -a and b are equal in the order and not distinguished by it, in -which case the set has a partial order. Otherwise, if there is an order, -all the objects have a distinct place in the order and the set has a total -order.}) and that A would be preferred to C. - -However, when MED is involved this need not be the case. With MED it is -possible that C is actually preferred over A. So A is preferred to B, B is -preferred to C, but C is preferred to A. This can be true even where BGP -defines a deterministic ``most preferred'' route out of the full set of -A,B,C. With MED, for any given set of routes there may be a -deterministically preferred route, but there need not be any way to arrange -them into any order of preference. With unmodified MED, the order of -preference of routes literally becomes undefined. - -That MED can induce non-transitive preferences over routes can cause issues. -Firstly, it may be perceived to cause routing table churn locally at -speakers; secondly, and more seriously, it may cause routing instability in -iBGP topologies, where sets of speakers continually oscillate between -different paths. - -The first issue arises from how speakers often implement routing decisions. -Though BGP defines a selection process that will deterministically select -the same route as best at any given speaker, even with MED, that process -requires evaluating all routes together. For performance and ease of -implementation reasons, many implementations evaluate route preferences in a -pair-wise fashion instead. Given there is no well-defined order when MED is -involved, the best route that will be chosen becomes subject to -implementation details, such as the order the routes are stored in. That -may be (locally) non-deterministic, e.g.@: it may be the order the routes -were received in. - -This indeterminism may be considered undesirable, though it need not cause -problems. It may mean additional routing churn is perceived, as sometimes -more updates may be produced than at other times in reaction to some event . - -This first issue can be fixed with a more deterministic route selection that -ensures routes are ordered by the neighbouring AS during selection. -@xref{bgp deterministic-med}. This may reduce the number of updates as -routes are received, and may in some cases reduce routing churn. Though, it -could equally deterministically produce the largest possible set of updates -in response to the most common sequence of received updates. - -A deterministic order of evaluation tends to imply an additional overhead of -sorting over any set of n routes to a destination. The implementation of -deterministic MED in Frr scales significantly worse than most sorting -algorithms at present, with the number of paths to a given destination. -That number is often low enough to not cause any issues, but where there are -many paths, the deterministic comparison may quickly become increasingly -expensive in terms of CPU. - -Deterministic local evaluation can @emph{not} fix the second, more major, -issue of MED however. Which is that the non-transitive preference of routes -MED can cause may lead to routing instability or oscillation across multiple -speakers in iBGP topologies. This can occur with full-mesh iBGP, but is -particularly problematic in non-full-mesh iBGP topologies that further -reduce the routing information known to each speaker. This has primarily -been documented with iBGP route-reflection topologies. However, any -route-hiding technologies potentially could also exacerbate oscillation with -MED. - -This second issue occurs where speakers each have only a subset of routes, -and there are cycles in the preferences between different combinations of -routes - as the undefined order of preference of MED allows - and the routes -are distributed in a way that causes the BGP speakers to 'chase' those -cycles. This can occur even if all speakers use a deterministic order of -evaluation in route selection. - -E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and -from speaker 3 in AS Y; while speaker 5 in AS A might receive that route -from speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 -at speaker 3. I.e, using ASN:ID:MED to label the speakers: - -@example - - /---------------\ - X:2------|--A:4-------A:5--|-Y:1:200 - Y:3:100--|-/ | - \---------------/ - -@end example - -Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then -based on the RFC4271 decision process speaker 4 will choose X:2 over -Y:3:100, based on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. -Speaker 5 will continue to prefer Y:1:200 based on the ID, and advertise -this to speaker 4. Speaker 4 will now have the full set of routes, and the -Y:1:200 it receives from 5 will beat X:2, but when speaker 4 compares -Y:1:200 to Y:3:100 the MED check now becomes active as the ASes match, and -now Y:3:100 is preferred. Speaker 4 therefore now advertises Y:3:100 to 5, -which will also agrees that Y:3:100 is preferred to Y:1:200, and so -withdraws the latter route from 4. Speaker 4 now has only X:2 and Y:3:100, -and X:2 beats Y:3:100, and so speaker 4 implicitly updates its route to -speaker 5 to X:2. Speaker 5 sees that Y:1:200 beats X:2 based on the ID, -and advertises Y:1:200 to speaker 4, and the cycle continues. - -The root cause is the lack of a clear order of preference caused by how MED -sometimes is and sometimes is not compared, leading to this cycle in the -preferences between the routes: - -@example - - /---> X:2 ---beats---> Y:3:100 --\ - | | - | | - \---beats--- Y:1:200 <---beats---/ - -@end example - -This particular type of oscillation in full-mesh iBGP topologies can be -avoided by speakers preferring already selected, external routes rather than -choosing to update to new a route based on a post-MED metric (e.g. -router-ID), at the cost of a non-deterministic selection process. Frr -implements this, as do many other implementations, so long as it is not -overridden by setting @ref{bgp bestpath compare-routerid}, and see also -@ref{BGP decision process}, . - -However, more complex and insidious cycles of oscillation are possible with -iBGP route-reflection, which are not so easily avoided. These have been -documented in various places. See, e.g., @cite{McPherson, D. and Gill, V. -and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation -Condition", IETF RFC3345}, and @cite{Flavel, A. and M. Roughan, "Stable -and flexible iBGP", ACM SIGCOMM 2009}, and @cite{Griffin, T. and G. Wilfong, -"On the correctness of IBGP configuration", ACM SIGCOMM 2002} for concrete -examples and further references. - -There is as of this writing @emph{no} known way to use MED for its original -purpose; @emph{and} reduce routing information in iBGP topologies; -@emph{and} be sure to avoid the instability problems of MED due the -non-transitive routing preferences it can induce; in general on arbitrary -networks. - -There may be iBGP topology specific ways to reduce the instability risks, -even while using MED, e.g.@: by constraining the reflection topology and by -tuning IGP costs between route-reflector clusters, see RFC3345 for details. -In the near future, the Add-Path extension to BGP may also solve MED -oscillation while still allowing MED to be used as intended, by distributing -"best-paths per neighbour AS". This would be at the cost of distributing at -least as many routes to all speakers as a full-mesh iBGP would, if not more, -while also imposing similar CPU overheads as the "Deterministic MED" feature -at each Add-Path reflector. - -More generally, the instability problems that MED can introduce on more -complex, non-full-mesh, iBGP topologies may be avoided either by: - -@itemize - -@item -Setting @ref{bgp always-compare-med}, however this allows MED to be compared -across values set by different neighbour ASes, which may not produce -coherent desirable results, of itself. - -@item -Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using -@ref{routemap set metric} on all received routes, in combination with -setting @ref{bgp always-compare-med} on all speakers. This is the simplest -and most performant way to avoid MED oscillation issues, where an AS is happy -not to allow neighbours to inject this problematic metric. - -@end itemize - -As MED is evaluated after the AS_PATH length check, another possible use for -MED is for intra-AS steering of routes with equal AS_PATH length, as an -extension of the last case above. As MED is evaluated before IGP metric, -this can allow cold-potato routing to be implemented to send traffic to -preferred hand-offs with neighbours, rather than the closest hand-off -according to the IGP metric. - -Note that even if action is taken to address the MED non-transitivity -issues, other oscillations may still be possible. E.g., on IGP cost if -iBGP and IGP topologies are at cross-purposes with each other - see the -Flavel and Roughan paper above for an example. Hence the guideline that the -iBGP topology should follow the IGP topology. - -@deffn {BGP} {bgp deterministic-med} {} -@anchor{bgp deterministic-med} - -Carry out route-selection in way that produces deterministic answers -locally, even in the face of MED and the lack of a well-defined order of -preference it can induce on routes. Without this option the preferred route -with MED may be determined largely by the order that routes were received -in. - -Setting this option will have a performance cost that may be noticeable when -there are many routes for each destination. Currently in Frr it is -implemented in a way that scales poorly as the number of routes per -destination increases. - -The default is that this option is not set. -@end deffn - -Note that there are other sources of indeterminism in the route selection -process, specifically, the preference for older and already selected routes -from eBGP peers, @xref{BGP decision process}. - -@deffn {BGP} {bgp always-compare-med} {} -@anchor{bgp always-compare-med} - -Always compare the MED on routes, even when they were received from -different neighbouring ASes. Setting this option makes the order of -preference of routes more defined, and should eliminate MED induced -oscillations. - -If using this option, it may also be desirable to use @ref{routemap set -metric} to set MED to 0 on routes received from external neighbours. - -This option can be used, together with @ref{routemap set metric} to use MED -as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired -exit points. -@end deffn - - - -@node BGP network -@section BGP network - -@menu -* BGP route:: -* Route Aggregation:: -* Redistribute to BGP:: -@end menu - -@node BGP route -@subsection BGP route - -@deffn {BGP} {network @var{A.B.C.D/M}} {} -This command adds the announcement network. -@example -@group -router bgp 1 - address-family ipv4 unicast - network 10.0.0.0/8 - exit-address-family -@end group -@end example -This configuration example says that network 10.0.0.0/8 will be -announced to all neighbors. Some vendors' routers don't advertise -routes if they aren't present in their IGP routing tables; @code{bgpd} -doesn't care about IGP routes when announcing its routes. -@end deffn - -@deffn {BGP} {no network @var{A.B.C.D/M}} {} -@end deffn - -@node Route Aggregation -@subsection Route Aggregation - -@deffn {BGP} {aggregate-address @var{A.B.C.D/M}} {} -This command specifies an aggregate address. -@end deffn - -@deffn {BGP} {aggregate-address @var{A.B.C.D/M} as-set} {} -This command specifies an aggregate address. Resulting routes include -AS set. -@end deffn - -@deffn {BGP} {aggregate-address @var{A.B.C.D/M} summary-only} {} -This command specifies an aggregate address. Aggreated routes will -not be announce. -@end deffn - -@deffn {BGP} {no aggregate-address @var{A.B.C.D/M}} {} -@end deffn - -@node Redistribute to BGP -@subsection Redistribute to BGP - -@deffn {BGP} {redistribute kernel} {} -Redistribute kernel route to BGP process. -@end deffn - -@deffn {BGP} {redistribute static} {} -Redistribute static route to BGP process. -@end deffn - -@deffn {BGP} {redistribute connected} {} -Redistribute connected route to BGP process. -@end deffn - -@deffn {BGP} {redistribute rip} {} -Redistribute RIP route to BGP process. -@end deffn - -@deffn {BGP} {redistribute ospf} {} -Redistribute OSPF route to BGP process. -@end deffn - -@deffn {BGP} {redistribute vpn} {} -Redistribute VNC routes to BGP process. -@end deffn - -@deffn {BGP} {update-delay @var{max-delay}} {} -@deffnx {BGP} {update-delay @var{max-delay} @var{establish-wait}} {} -This feature is used to enable read-only mode on BGP process restart or when -BGP process is cleared using 'clear ip bgp *'. When applicable, read-only mode -would begin as soon as the first peer reaches Established status and a timer -for max-delay seconds is started. - -During this mode BGP doesn't run any best-path or generate any updates to its -peers. This mode continues until: -1. All the configured peers, except the shutdown peers, have sent explicit EOR -(End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached -Established is considered an implicit-EOR. - If the establish-wait optional value is given, then BGP will wait for - peers to reach established from the begining of the update-delay till the - establish-wait period is over, i.e. the minimum set of established peers for - which EOR is expected would be peers established during the establish-wait - window, not necessarily all the configured neighbors. -2. max-delay period is over. -On hitting any of the above two conditions, BGP resumes the decision process -and generates updates to its peers. - -Default max-delay is 0, i.e. the feature is off by default. -@end deffn - -@deffn {BGP} {table-map @var{route-map-name}} {} -This feature is used to apply a route-map on route updates from BGP to Zebra. -All the applicable match operations are allowed, such as match on prefix, -next-hop, communities, etc. Set operations for this attach-point are limited -to metric and next-hop only. Any operation of this feature does not affect -BGPs internal RIB. - -Supported for ipv4 and ipv6 address families. It works on multi-paths as well, -however, metric setting is based on the best-path only. -@end deffn - -@node BGP Peer -@section BGP Peer - -@menu -* Defining Peer:: -* BGP Peer commands:: -* Peer filtering:: -@end menu - -@node Defining Peer -@subsection Defining Peer - -@deffn {BGP} {neighbor @var{peer} remote-as @var{asn}} {} -Creates a new neighbor whose remote-as is @var{asn}. @var{peer} -can be an IPv4 address or an IPv6 address. -@example -@group -router bgp 1 - neighbor 10.0.0.1 remote-as 2 -@end group -@end example -In this case my router, in AS-1, is trying to peer with AS-2 at -10.0.0.1. - -This command must be the first command used when configuring a neighbor. -If the remote-as is not specified, @command{bgpd} will complain like this: -@example -can't find neighbor 10.0.0.1 -@end example -@end deffn - -@node BGP Peer commands -@subsection BGP Peer commands - -In a @code{router bgp} clause there are neighbor specific configurations -required. - -@deffn {BGP} {neighbor @var{peer} shutdown} {} -@deffnx {BGP} {no neighbor @var{peer} shutdown} {} -Shutdown the peer. We can delete the neighbor's configuration by -@code{no neighbor @var{peer} remote-as @var{as-number}} but all -configuration of the neighbor will be deleted. When you want to -preserve the configuration, but want to drop the BGP peer, use this -syntax. -@end deffn - -@deffn {BGP} {neighbor @var{peer} ebgp-multihop} {} -@deffnx {BGP} {no neighbor @var{peer} ebgp-multihop} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} description ...} {} -@deffnx {BGP} {no neighbor @var{peer} description ...} {} -Set description of the peer. -@end deffn - -@deffn {BGP} {neighbor @var{peer} version @var{version}} {} -Set up the neighbor's BGP version. @var{version} can be @var{4}, -@var{4+} or @var{4-}. BGP version @var{4} is the default value used for -BGP peering. BGP version @var{4+} means that the neighbor supports -Multiprotocol Extensions for BGP-4. BGP version @var{4-} is similar but -the neighbor speaks the old Internet-Draft revision 00's Multiprotocol -Extensions for BGP-4. Some routing software is still using this -version. -@end deffn - -@deffn {BGP} {neighbor @var{peer} interface @var{ifname}} {} -@deffnx {BGP} {no neighbor @var{peer} interface @var{ifname}} {} -When you connect to a BGP peer over an IPv6 link-local address, you -have to specify the @var{ifname} of the interface used for the -connection. To specify IPv4 session addresses, see the -@code{neighbor @var{peer} update-source} command below. - -This command is deprecated and may be removed in a future release. Its -use should be avoided. -@end deffn - -@deffn {BGP} {neighbor @var{peer} next-hop-self [all]} {} -@deffnx {BGP} {no neighbor @var{peer} next-hop-self [all]} {} -This command specifies an announced route's nexthop as being equivalent -to the address of the bgp router if it is learned via eBGP. -If the optional keyword @code{all} is specified the modifiation is done -also for routes learned via iBGP. -@end deffn - -@deffn {BGP} {neighbor @var{peer} update-source @var{}} {} -@deffnx {BGP} {no neighbor @var{peer} update-source} {} -Specify the IPv4 source address to use for the @acronym{BGP} session to this -neighbour, may be specified as either an IPv4 address directly or -as an interface name (in which case the @command{zebra} daemon MUST be running -in order for @command{bgpd} to be able to retrieve interface state). -@example -@group -router bgp 64555 - neighbor foo update-source 192.168.0.1 - neighbor bar update-source lo0 -@end group -@end example -@end deffn - -@deffn {BGP} {neighbor @var{peer} default-originate} {} -@deffnx {BGP} {no neighbor @var{peer} default-originate} {} -@command{bgpd}'s default is to not announce the default route (0.0.0.0/0) even it -is in routing table. When you want to announce default routes to the -peer, use this command. -@end deffn - -@deffn {BGP} {neighbor @var{peer} port @var{port}} {} -@deffnx {BGP} {neighbor @var{peer} port @var{port}} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} send-community} {} -@deffnx {BGP} {neighbor @var{peer} send-community} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} weight @var{weight}} {} -@deffnx {BGP} {no neighbor @var{peer} weight @var{weight}} {} -This command specifies a default @var{weight} value for the neighbor's -routes. -@end deffn - -@deffn {BGP} {neighbor @var{peer} maximum-prefix @var{number}} {} -@deffnx {BGP} {no neighbor @var{peer} maximum-prefix @var{number}} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} local-as @var{as-number}} {} -@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend} {} -@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend replace-as} {} -@deffnx {BGP} {no neighbor @var{peer} local-as} {} -Specify an alternate AS for this BGP process when interacting with the -specified peer. With no modifiers, the specified local-as is prepended to -the received AS_PATH when receiving routing updates from the peer, and -prepended to the outgoing AS_PATH (after the process local AS) when -transmitting local routes to the peer. - -If the no-prepend attribute is specified, then the supplied local-as is not -prepended to the received AS_PATH. - -If the replace-as attribute is specified, then only the supplied local-as is -prepended to the AS_PATH when transmitting local-route updates to this peer. - -Note that replace-as can only be specified if no-prepend is. - -This command is only allowed for eBGP peers. -@end deffn - -@deffn {BGP} {neighbor @var{peer} ttl-security hops @var{number}} {} -@deffnx {BGP} {no neighbor @var{peer} ttl-security hops @var{number}} {} -This command enforces Generalized TTL Security Mechanism (GTSM), as -specified in RFC 5082. With this command, only neighbors that are the -specified number of hops away will be allowed to become neighbors. This -command is mututally exclusive with @command{ebgp-multihop}. -@end deffn - -@node Peer filtering -@subsection Peer filtering - -@deffn {BGP} {neighbor @var{peer} distribute-list @var{name} [in|out]} {} -This command specifies a distribute-list for the peer. @var{direct} is -@samp{in} or @samp{out}. -@end deffn - -@deffn {BGP command} {neighbor @var{peer} prefix-list @var{name} [in|out]} {} -@end deffn - -@deffn {BGP command} {neighbor @var{peer} filter-list @var{name} [in|out]} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} route-map @var{name} [in|out]} {} -Apply a route-map on the neighbor. @var{direct} must be @code{in} or -@code{out}. -@end deffn - -@deffn {BGP} {bgp route-reflector allow-outbound-policy} {} -By default, attribute modification via route-map policy out is not reflected -on reflected routes. This option allows the modifications to be reflected as -well. Once enabled, it affects all reflected routes. -@end deffn - -@c ----------------------------------------------------------------------- -@node BGP Peer Group -@section BGP Peer Group - -@deffn {BGP} {neighbor @var{word} peer-group} {} -This command defines a new peer group. -@end deffn - -@deffn {BGP} {neighbor @var{peer} peer-group @var{word}} {} -This command bind specific peer to peer group @var{word}. -@end deffn - -@node BGP Address Family -@section BGP Address Family - -Multiprotocol BGP enables BGP to carry routing information for multiple -Network Layer protocols. BGP supports multiple Address Family -Identifier (AFI), namely IPv4 and IPv6. Support is also provided for -multiple sets of per-AFI information via Subsequent Address Family -Identifiers (SAFI). In addition to unicast information, VPN information -@cite{RFC4364} and @cite{RFC4659}, and Encapsulation attribute -@cite{RFC5512} is supported. - -@deffn {Command} {show ip bgp ipv4 vpn} {} -@deffnx {Command} {show ipv6 bgp ipv6 vpn} {} -Print active IPV4 or IPV6 routes advertised via the VPN SAFI. -@end deffn - -@deffn {Command} {show bgp ipv4 vpn summary} {} -@deffnx {Command} {show bgp ipv6 vpn summary} {} -Print a summary of neighbor connections for the specified AFI/SAFI combination. -@end deffn - -@c ----------------------------------------------------------------------- -@node Autonomous System -@section Autonomous System - -The @acronym{AS,Autonomous System} number is one of the essential -element of BGP. BGP is a distance vector routing protocol, and the -AS-Path framework provides distance vector metric and loop detection to -BGP. @cite{RFC1930, Guidelines for creation, selection, and -registration of an Autonomous System (AS)} provides some background on -the concepts of an AS. - -The AS number is a two octet value, ranging in value from 1 to 65535. -The AS numbers 64512 through 65535 are defined as private AS numbers. -Private AS numbers must not to be advertised in the global Internet. - -@menu -* Display BGP Routes by AS Path:: -* AS Path Access List:: -* Using AS Path in Route Map:: -* Private AS Numbers:: -@end menu - -@node Display BGP Routes by AS Path -@subsection Display BGP Routes by AS Path - -To show BGP routes which has specific AS path information @code{show -ip bgp} command can be used. - -@deffn Command {show bgp @{ipv4|ipv6@} regexp @var{line}} {} -This commands displays BGP routes that matches a regular -expression @var{line} (@pxref{BGP Regular Expressions}). -@end deffn - -@node AS Path Access List -@subsection AS Path Access List - -AS path access list is user defined AS path. - -@deffn {Command} {ip as-path access-list @var{word} @{permit|deny@} @var{line}} {} -This command defines a new AS path access list. -@end deffn - -@deffn {Command} {no ip as-path access-list @var{word}} {} -@deffnx {Command} {no ip as-path access-list @var{word} @{permit|deny@} @var{line}} {} -@end deffn - -@node Using AS Path in Route Map -@subsection Using AS Path in Route Map - -@deffn {Route Map} {match as-path @var{word}} {} -@end deffn - -@deffn {Route Map} {set as-path prepend @var{as-path}} {} -Prepend the given string of AS numbers to the AS_PATH. -@end deffn - -@deffn {Route Map} {set as-path prepend last-as @var{num}} {} -Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. -@end deffn - -@node Private AS Numbers -@subsection Private AS Numbers - -@c ----------------------------------------------------------------------- -@node BGP Communities Attribute -@section BGP Communities Attribute - -BGP communities attribute is widely used for implementing policy -routing. Network operators can manipulate BGP communities attribute -based on their network policy. BGP communities attribute is defined -in @cite{RFC1997, BGP Communities Attribute} and -@cite{RFC1998, An Application of the BGP Community Attribute -in Multi-home Routing}. It is an optional transitive attribute, -therefore local policy can travel through different autonomous system. - -Communities attribute is a set of communities values. Each -communities value is 4 octet long. The following format is used to -define communities value. - -@table @code -@item AS:VAL -This format represents 4 octet communities value. @code{AS} is high -order 2 octet in digit format. @code{VAL} is low order 2 octet in -digit format. This format is useful to define AS oriented policy -value. For example, @code{7675:80} can be used when AS 7675 wants to -pass local policy value 80 to neighboring peer. -@item internet -@code{internet} represents well-known communities value 0. -@item no-export -@code{no-export} represents well-known communities value @code{NO_EXPORT}@* -@r{(0xFFFFFF01)}. All routes carry this value must not be advertised -to outside a BGP confederation boundary. If neighboring BGP peer is -part of BGP confederation, the peer is considered as inside a BGP -confederation boundary, so the route will be announced to the peer. -@item no-advertise -@code{no-advertise} represents well-known communities value -@code{NO_ADVERTISE}@*@r{(0xFFFFFF02)}. All routes carry this value -must not be advertise to other BGP peers. -@item local-AS -@code{local-AS} represents well-known communities value -@code{NO_EXPORT_SUBCONFED} @r{(0xFFFFFF03)}. All routes carry this -value must not be advertised to external BGP peers. Even if the -neighboring router is part of confederation, it is considered as -external BGP peer, so the route will not be announced to the peer. -@end table - - When BGP communities attribute is received, duplicated communities -value in the communities attribute is ignored and each communities -values are sorted in numerical order. - -@menu -* BGP Community Lists:: -* Numbered BGP Community Lists:: -* BGP Community in Route Map:: -* Display BGP Routes by Community:: -* Using BGP Communities Attribute:: -@end menu - -@node BGP Community Lists -@subsection BGP Community Lists - - BGP community list is a user defined BGP communites attribute list. -BGP community list can be used for matching or manipulating BGP -communities attribute in updates. - -There are two types of community list. One is standard community -list and another is expanded community list. Standard community list -defines communities attribute. Expanded community list defines -communities attribute string with regular expression. Standard -community list is compiled into binary format when user define it. -Standard community list will be directly compared to BGP communities -attribute in BGP updates. Therefore the comparison is faster than -expanded community list. - -@deffn Command {ip community-list standard @var{name} @{permit|deny@} @var{community}} {} -This command defines a new standard community list. @var{community} -is communities value. The @var{community} is compiled into community -structure. We can define multiple community list under same name. In -that case match will happen user defined order. Once the -community list matches to communities attribute in BGP updates it -return permit or deny by the community list definition. When there is -no matched entry, deny will be returned. When @var{community} is -empty it matches to any routes. -@end deffn - -@deffn Command {ip community-list expanded @var{name} @{permit|deny@} @var{line}} {} -This command defines a new expanded community list. @var{line} is a -string expression of communities attribute. @var{line} can be a -regular expression (@pxref{BGP Regular Expressions}) to match -the communities attribute in BGP updates. -@end deffn - -@deffn Command {no ip community-list @var{name}} {} -@deffnx Command {no ip community-list standard @var{name}} {} -@deffnx Command {no ip community-list expanded @var{name}} {} -These commands delete community lists specified by @var{name}. All of -community lists shares a single name space. So community lists can be -removed simpley specifying community lists name. -@end deffn - -@deffn {Command} {show ip community-list} {} -@deffnx {Command} {show ip community-list @var{name}} {} -This command displays current community list information. When -@var{name} is specified the specified community list's information is -shown. - -@example -# show ip community-list -Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet -Named Community expanded list EXPAND - permit : - -# show ip community-list CLIST -Named Community standard list CLIST - permit 7675:80 7675:100 no-export - deny internet -@end example -@end deffn - -@node Numbered BGP Community Lists -@subsection Numbered BGP Community Lists - -When number is used for BGP community list name, the number has -special meanings. Community list number in the range from 1 and 99 is -standard community list. Community list number in the range from 100 -to 199 is expanded community list. These community lists are called -as numbered community lists. On the other hand normal community lists -is called as named community lists. - -@deffn Command {ip community-list <1-99> @{permit|deny@} @var{community}} {} -This command defines a new community list. <1-99> is standard -community list number. Community list name within this range defines -standard community list. When @var{community} is empty it matches to -any routes. -@end deffn - -@deffn Command {ip community-list <100-199> @{permit|deny@} @var{community}} {} -This command defines a new community list. <100-199> is expanded -community list number. Community list name within this range defines -expanded community list. -@end deffn - -@deffn Command {ip community-list @var{name} @{permit|deny@} @var{community}} {} -When community list type is not specifed, the community list type is -automatically detected. If @var{community} can be compiled into -communities attribute, the community list is defined as a standard -community list. Otherwise it is defined as an expanded community -list. This feature is left for backward compability. Use of this -feature is not recommended. -@end deffn - -@node BGP Community in Route Map -@subsection BGP Community in Route Map - -In Route Map (@pxref{Route Map}), we can match or set BGP -communities attribute. Using this feature network operator can -implement their network policy based on BGP communities attribute. - -Following commands can be used in Route Map. - -@deffn {Route Map} {match community @var{word}} {} -@deffnx {Route Map} {match community @var{word} exact-match} {} -This command perform match to BGP updates using community list -@var{word}. When the one of BGP communities value match to the one of -communities value in community list, it is match. When -@code{exact-match} keyword is spcified, match happen only when BGP -updates have completely same communities value specified in the -community list. -@end deffn - -@deffn {Route Map} {set community none} {} -@deffnx {Route Map} {set community @var{community}} {} -@deffnx {Route Map} {set community @var{community} additive} {} -This command manipulate communities value in BGP updates. When -@code{none} is specified as communities value, it removes entire -communities attribute from BGP updates. When @var{community} is not -@code{none}, specified communities value is set to BGP updates. If -BGP updates already has BGP communities value, the existing BGP -communities value is replaced with specified @var{community} value. -When @code{additive} keyword is specified, @var{community} is appended -to the existing communities value. -@end deffn - -@deffn {Route Map} {set comm-list @var{word} delete} {} -This command remove communities value from BGP communities attribute. -The @var{word} is community list name. When BGP route's communities -value matches to the community list @var{word}, the communities value -is removed. When all of communities value is removed eventually, the -BGP update's communities attribute is completely removed. -@end deffn - -@node Display BGP Routes by Community -@subsection Display BGP Routes by Community - -To show BGP routes which has specific BGP communities attribute, -@code{show bgp @{ipv4|ipv6@}} command can be used. The -@var{community} and @var{community-list} subcommand can be used. - -@deffn Command {show bgp @{ipv4|ipv6@} community} {} -@deffnx Command {show bgp @{ipv4|ipv6@} community @var{community}} {} -@deffnx Command {show bgp @{ipv4|ipv6@} community @var{community} exact-match} {} -@code{show bgp @{ipv4|ipv6@} community} displays BGP routes which has communities -attribute. Where the address family can be IPv4 or IPv6 among others. When -@var{community} is specified, BGP routes that matches @var{community} value is -displayed. For this command, @code{internet} keyword can't be used for -@var{community} value. When @code{exact-match} is specified, it display only -routes that have an exact match. -@end deffn - -@deffn Command {show bgp @{ipv4|ipv6@} community-list @var{word}} {} -@deffnx Command {show bgp @{ipv4|ipv6@} community-list @var{word} exact-match} {} -This commands display BGP routes for the address family specified that matches -community list @var{word}. When @code{exact-match} is specified, display only -routes that have an exact match. -@end deffn - -@node Using BGP Communities Attribute -@subsection Using BGP Communities Attribute - -Following configuration is the most typical usage of BGP communities -attribute. AS 7675 provides upstream Internet connection to AS 100. -When following configuration exists in AS 7675, AS 100 networks -operator can set local preference in AS 7675 network by setting BGP -communities attribute to the updates. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list 70 permit 7675:70 -ip community-list 70 deny -ip community-list 80 permit 7675:80 -ip community-list 80 deny -ip community-list 90 permit 7675:90 -ip community-list 90 deny -! -route-map RMAP permit 10 - match community 70 - set local-preference 70 -! -route-map RMAP permit 20 - match community 80 - set local-preference 80 -! -route-map RMAP permit 30 - match community 90 - set local-preference 90 -@end example - -Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675. -The route has communities value 7675:80 so when above configuration -exists in AS 7675, announced route's local preference will be set to -value 80. - -@example -router bgp 100 - network 10.0.0.0/8 - neighbor 192.168.0.2 remote-as 7675 - address-family ipv4 unicast - neighbor 192.168.0.2 route-map RMAP out - exit-address-family -! -ip prefix-list PLIST permit 10.0.0.0/8 -! -route-map RMAP permit 10 - match ip address prefix-list PLIST - set community 7675:80 -@end example - -Following configuration is an example of BGP route filtering using -communities attribute. This configuration only permit BGP routes -which has BGP communities value 0:80 or 0:90. Network operator can -put special internal communities value at BGP border router, then -limit the BGP routes announcement into the internal network. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list 1 permit 0:80 0:90 -! -route-map RMAP permit in - match community 1 -@end example - -Following exmaple filter BGP routes which has communities value 1:1. -When there is no match community-list returns deny. To avoid -filtering all of routes, we need to define permit any at last. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list standard FILTER deny 1:1 -ip community-list standard FILTER permit -! -route-map RMAP permit 10 - match community FILTER -@end example - -Communities value keyword @code{internet} has special meanings in -standard community lists. In below example @code{internet} act as -match any. It matches all of BGP routes even if the route does not -have communities attribute at all. So community list @code{INTERNET} -is same as above example's @code{FILTER}. - -@example -ip community-list standard INTERNET deny 1:1 -ip community-list standard INTERNET permit internet -@end example - -Following configuration is an example of communities value deletion. -With this configuration communities value 100:1 and 100:2 is removed -from BGP updates. For communities value deletion, only @code{permit} -community-list is used. @code{deny} community-list is ignored. - -@example -router bgp 7675 - neighbor 192.168.0.1 remote-as 100 - address-family ipv4 unicast - neighbor 192.168.0.1 route-map RMAP in - exit-address-family -! -ip community-list standard DEL permit 100:1 100:2 -! -route-map RMAP permit 10 - set comm-list DEL delete -@end example - -@c ----------------------------------------------------------------------- -@node BGP Extended Communities Attribute -@section BGP Extended Communities Attribute - -BGP extended communities attribute is introduced with MPLS VPN/BGP -technology. MPLS VPN/BGP expands capability of network infrastructure -to provide VPN functionality. At the same time it requires a new -framework for policy routing. With BGP Extended Communities Attribute -we can use Route Target or Site of Origin for implementing network -policy for MPLS VPN/BGP. - -BGP Extended Communities Attribute is similar to BGP Communities -Attribute. It is an optional transitive attribute. BGP Extended -Communities Attribute can carry multiple Extended Community value. -Each Extended Community value is eight octet length. - -BGP Extended Communities Attribute provides an extended range -compared with BGP Communities Attribute. Adding to that there is a -type field in each value to provides community space structure. - -There are two format to define Extended Community value. One is AS -based format the other is IP address based format. - -@table @code -@item AS:VAL -This is a format to define AS based Extended Community value. -@code{AS} part is 2 octets Global Administrator subfield in Extended -Community value. @code{VAL} part is 4 octets Local Administrator -subfield. @code{7675:100} represents AS 7675 policy value 100. -@item IP-Address:VAL -This is a format to define IP address based Extended Community value. -@code{IP-Address} part is 4 octets Global Administrator subfield. -@code{VAL} part is 2 octets Local Administrator subfield. -@code{10.0.0.1:100} represents -@end table - -@menu -* BGP Extended Community Lists:: -* BGP Extended Communities in Route Map:: -@end menu - -@node BGP Extended Community Lists -@subsection BGP Extended Community Lists - -Expanded Community Lists is a user defined BGP Expanded Community -Lists. - -@deffn Command {ip extcommunity-list standard @var{name} @{permit|deny@} @var{extcommunity}} {} -This command defines a new standard extcommunity-list. -@var{extcommunity} is extended communities value. The -@var{extcommunity} is compiled into extended community structure. We -can define multiple extcommunity-list under same name. In that case -match will happen user defined order. Once the extcommunity-list -matches to extended communities attribute in BGP updates it return -permit or deny based upon the extcommunity-list definition. When -there is no matched entry, deny will be returned. When -@var{extcommunity} is empty it matches to any routes. -@end deffn - -@deffn Command {ip extcommunity-list expanded @var{name} @{permit|deny@} @var{line}} {} -This command defines a new expanded extcommunity-list. @var{line} is -a string expression of extended communities attribute. @var{line} can -be a regular expression (@pxref{BGP Regular Expressions}) to match an -extended communities attribute in BGP updates. -@end deffn - -@deffn Command {no ip extcommunity-list @var{name}} {} -@deffnx Command {no ip extcommunity-list standard @var{name}} {} -@deffnx Command {no ip extcommunity-list expanded @var{name}} {} -These commands delete extended community lists specified by -@var{name}. All of extended community lists shares a single name -space. So extended community lists can be removed simpley specifying -the name. -@end deffn - -@deffn {Command} {show ip extcommunity-list} {} -@deffnx {Command} {show ip extcommunity-list @var{name}} {} -This command displays current extcommunity-list information. When -@var{name} is specified the community list's information is shown. - -@example -# show ip extcommunity-list -@end example -@end deffn - -@node BGP Extended Communities in Route Map -@subsection BGP Extended Communities in Route Map - -@deffn {Route Map} {match extcommunity @var{word}} {} -@end deffn - -@deffn {Route Map} {set extcommunity rt @var{extcommunity}} {} -This command set Route Target value. -@end deffn - -@deffn {Route Map} {set extcommunity soo @var{extcommunity}} {} -This command set Site of Origin value. -@end deffn - -@c ----------------------------------------------------------------------- -@node BGP Large Communities Attribute -@section BGP Large Communities Attribute - -The BGP Large Communities attribute was introduced in Feb 2017 with -@cite{RFC8092, BGP Large Communities Attribute}. - -The BGP Large Communities Attribute is similar to the BGP Communities -Attribute except that it has 3 components instead of two and each of -which are 4 octets in length. Large Communities bring additional -functionality and convenience over traditional communities, specifically -the fact that the @code{GLOBAL} part below is now 4 octets wide allowing -AS4 operators seamless use. - -@table @code -@item GLOBAL:LOCAL1:LOCAL2 -This is the format to define Large Community values. Referencing -@cite{RFC8195, Use of BGP Large Communities} the values are commonly -referred to as follows. -The @code{GLOBAL} part is a 4 octet Global Administrator field, common -use of this field is the operators AS number. -The @code{LOCAL1} part is a 4 octet Local Data Part 1 subfield referred -to as a function. -The @code{LOCAL2} part is a 4 octet Local Data Part 2 field and referred -to as the parameter subfield. @code{65551:1:10} represents AS 65551 -function 1 and parameter 10. -The referenced RFC above gives some guidelines on recommended usage. -@end table - -@menu -* BGP Large Community Lists:: -* BGP Large Communities in Route Map:: -@end menu - -@node BGP Large Community Lists -@subsection BGP Large Community Lists - -Two types of large community lists are supported, namely @code{standard} and -@code{expanded}. - -@deffn Command {ip large-community-list standard @var{name} @{permit|deny@} @var{large-community}} {} -This command defines a new standard large-community-list. -@var{large-community} is the Large Community value. We -can add multiple large communities under same name. In that case -the match will happen in the user defined order. Once the large-community-list -matches the Large Communities attribute in BGP updates it will return -permit or deny based upon the large-community-list definition. When -there is no matched entry, a deny will be returned. When @var{large-community} -is empty it matches any routes. -@end deffn - -@deffn Command {ip large-community-list expanded @var{name} @{permit|deny@} @var{line}} {} -This command defines a new expanded large-community-list. Where @var{line} is -a string matching expression, it will be compared to the entire Large Communities -attribute as a string, with each large-community in order from lowest to highest. -@var{line} can also be a regular expression which matches this Large -Community attribute. -@end deffn - -@deffn Command {no ip large-community-list @var{name}} {} -@deffnx Command {no ip large-community-list standard @var{name}} {} -@deffnx Command {no ip large-community-list expanded @var{name}} {} -These commands delete Large Community lists specified by -@var{name}. All Large Community lists share a single namespace. -This means Large Community lists can be removed by simply specifying the name. -@end deffn - -@deffn {Command} {show ip large-community-list} {} -@deffnx {Command} {show ip large-community-list @var{name}} {} -This command display current large-community-list information. When -@var{name} is specified the community list information is shown. -@end deffn - -@deffn {Command} {show ip bgp large-community-info} {} -This command displays the current large communities in use. -@end deffn - -@node BGP Large Communities in Route Map -@subsection BGP Large Communities in Route Map - -@deffn {Route Map} {match large-community @var{line}} {} -Where @var{line} can be a simple string to match, or a regular expression. -It is very important to note that this match occurs on the entire -large-community string as a whole, where each large-community is ordered -from lowest to highest. -@end deffn - -@deffn {Route Map} {set large-community @var{large-community}} {} -@deffnx {Route Map} {set large-community @var{large-community} @var{large-community}} {} -@deffnx {Route Map} {set large-community @var{large-community} additive} {} -These commands are used for setting large-community values. The first -command will overwrite any large-communities currently present. -The second specifies two large-communities, which overwrites the current -large-community list. The third will add a large-community value without -overwriting other values. Multiple large-community values can be specified. -@end deffn - -@c ----------------------------------------------------------------------- - -@node Displaying BGP information -@section Displaying BGP information - -@menu -* Showing BGP information:: -* Other BGP commands:: -@end menu - -@node Showing BGP information -@subsection Showing BGP information - -@deffn {Command} {show ip bgp} {} -@deffnx {Command} {show ip bgp @var{A.B.C.D}} {} -@deffnx {Command} {show ip bgp @var{X:X::X:X}} {} -This command displays BGP routes. When no route is specified it -display all of IPv4 BGP routes. -@end deffn - -@example -BGP table version is 0, local router ID is 10.1.1.1 -Status codes: s suppressed, d damped, h history, * valid, > best, i - internal -Origin codes: i - IGP, e - EGP, ? - incomplete - - Network Next Hop Metric LocPrf Weight Path -*> 1.1.1.1/32 0.0.0.0 0 32768 i - -Total number of prefixes 1 -@end example - -@deffn {Command} {show ip bgp regexp @var{line}} {} -This command displays BGP routes using AS path regular expression -(@pxref{BGP Regular Expressions}). -@end deffn - -@deffn Command {show ip bgp community @var{community}} {} -@deffnx Command {show ip bgp community @var{community} exact-match} {} -This command displays BGP routes using @var{community} (@pxref{Display -BGP Routes by Community}). -@end deffn - -@deffn Command {show ip bgp community-list @var{word}} {} -@deffnx Command {show ip bgp community-list @var{word} exact-match} {} -This command displays BGP routes using community list (@pxref{Display -BGP Routes by Community}). -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} summary} {} -Show a bgp peer summary for the specified address family. -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} neighbor [@var{peer}]} {} -This command shows information on a specific BGP @var{peer}. -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} dampening dampened-paths} {} -Display paths suppressed due to dampening. -@end deffn - -@deffn {Command} {show bgp @{ipv4|ipv6@} dampening flap-statistics} {} -Display flap statistics of routes. -@end deffn - -@node Other BGP commands -@subsection Other BGP commands - -@deffn {Command} {clear bgp @{ipv4|ipv6@} *} {} -Clear all address family peers. -@end deffn - -@deffn {Command} {clear bgp @{ipv4|ipv6@} @var{peer}} {} -Clear peers which have addresses of X.X.X.X -@end deffn - -@deffn {Command} {clear bgp @{ipv4|ipv6@} @var{peer} soft in} {} -Clear peer using soft reconfiguration. -@end deffn - -@deffn {Command} {show debug} {} -@end deffn - -@deffn {Command} {debug event} {} -@end deffn - -@deffn {Command} {debug update} {} -@end deffn - -@deffn {Command} {debug keepalive} {} -@end deffn - -@deffn {Command} {no debug event} {} -@end deffn - -@deffn {Command} {no debug update} {} -@end deffn - -@deffn {Command} {no debug keepalive} {} -@end deffn - -@node Capability Negotiation -@section Capability Negotiation - -When adding IPv6 routing information exchange feature to BGP. There -were some proposals. @acronym{IETF,Internet Engineering Task Force} -@acronym{IDR, Inter Domain Routing} @acronym{WG, Working group} adopted -a proposal called Multiprotocol Extension for BGP. The specification -is described in @cite{RFC2283}. The protocol does not define new protocols. -It defines new attributes to existing BGP. When it is used exchanging -IPv6 routing information it is called BGP-4+. When it is used for -exchanging multicast routing information it is called MBGP. - -@command{bgpd} supports Multiprotocol Extension for BGP. So if remote -peer supports the protocol, @command{bgpd} can exchange IPv6 and/or -multicast routing information. - -Traditional BGP did not have the feature to detect remote peer's -capabilities, e.g. whether it can handle prefix types other than IPv4 -unicast routes. This was a big problem using Multiprotocol Extension -for BGP to operational network. @cite{RFC2842, Capabilities -Advertisement with BGP-4} adopted a feature called Capability -Negotiation. @command{bgpd} use this Capability Negotiation to detect -the remote peer's capabilities. If the peer is only configured as IPv4 -unicast neighbor, @command{bgpd} does not send these Capability -Negotiation packets (at least not unless other optional BGP features -require capability negotation). - -By default, Frr will bring up peering with minimal common capability -for the both sides. For example, local router has unicast and -multicast capabilitie and remote router has unicast capability. In -this case, the local router will establish the connection with unicast -only capability. When there are no common capabilities, Frr sends -Unsupported Capability error and then resets the connection. - -If you want to completely match capabilities with remote peer. Please -use @command{strict-capability-match} command. - -@deffn {BGP} {neighbor @var{peer} strict-capability-match} {} -@deffnx {BGP} {no neighbor @var{peer} strict-capability-match} {} -Strictly compares remote capabilities and local capabilities. If capabilities -are different, send Unsupported Capability error then reset connection. -@end deffn - -You may want to disable sending Capability Negotiation OPEN message -optional parameter to the peer when remote peer does not implement -Capability Negotiation. Please use @command{dont-capability-negotiate} -command to disable the feature. - -@deffn {BGP} {neighbor @var{peer} dont-capability-negotiate} {} -@deffnx {BGP} {no neighbor @var{peer} dont-capability-negotiate} {} -Suppress sending Capability Negotiation as OPEN message optional -parameter to the peer. This command only affects the peer is configured -other than IPv4 unicast configuration. -@end deffn - -When remote peer does not have capability negotiation feature, remote -peer will not send any capabilities at all. In that case, bgp -configures the peer with configured capabilities. - -You may prefer locally configured capabilities more than the negotiated -capabilities even though remote peer sends capabilities. If the peer -is configured by @command{override-capability}, @command{bgpd} ignores -received capabilities then override negotiated capabilities with -configured values. - -@deffn {BGP} {neighbor @var{peer} override-capability} {} -@deffnx {BGP} {no neighbor @var{peer} override-capability} {} -Override the result of Capability Negotiation with local configuration. -Ignore remote peer's capability value. -@end deffn - -@node Route Reflector -@section Route Reflector - -@deffn {BGP} {bgp cluster-id @var{a.b.c.d}} {} -@end deffn - -@deffn {BGP} {neighbor @var{peer} route-reflector-client} {} -@deffnx {BGP} {no neighbor @var{peer} route-reflector-client} {} -@end deffn - -@node Route Server -@section Route Server - -At an Internet Exchange point, many ISPs are connected to each other by -external BGP peering. Normally these external BGP connection are done by -@samp{full mesh} method. As with internal BGP full mesh formation, -this method has a scaling problem. - -This scaling problem is well known. Route Server is a method to resolve -the problem. Each ISP's BGP router only peers to Route Server. Route -Server serves as BGP information exchange to other BGP routers. By -applying this method, numbers of BGP connections is reduced from -O(n*(n-1)/2) to O(n). - -Unlike normal BGP router, Route Server must have several routing tables -for managing different routing policies for each BGP speaker. We call the -routing tables as different @code{view}s. @command{bgpd} can work as -normal BGP router or Route Server or both at the same time. - -@menu -* Multiple instance:: -* BGP instance and view:: -* Routing policy:: -* Viewing the view:: -@end menu - -@node Multiple instance -@subsection Multiple instance - -To enable multiple view function of @code{bgpd}, you must turn on -multiple instance feature beforehand. - -@deffn {Command} {bgp multiple-instance} {} -Enable BGP multiple instance feature. After this feature is enabled, -you can make multiple BGP instances or multiple BGP views. -@end deffn - -@deffn {Command} {no bgp multiple-instance} {} -Disable BGP multiple instance feature. You can not disable this feature -when BGP multiple instances or views exist. -@end deffn - -When you want to make configuration more Cisco like one, - -@deffn {Command} {bgp config-type cisco} {} -Cisco compatible BGP configuration output. -@end deffn - -When bgp config-type cisco is specified, - -``no synchronization'' is displayed. -``no auto-summary'' is displayed. - -``network'' and ``aggregate-address'' argument is displayed as -``A.B.C.D M.M.M.M'' - -Frr: network 10.0.0.0/8 -Cisco: network 10.0.0.0 - -Frr: aggregate-address 192.168.0.0/24 -Cisco: aggregate-address 192.168.0.0 255.255.255.0 - -Community attribute handling is also different. If there is no -configuration is specified community attribute and extended community -attribute are sent to neighbor. When user manually disable the -feature community attribute is not sent to the neighbor. In case of -@command{bgp config-type cisco} is specified, community attribute is not -sent to the neighbor by default. To send community attribute user has -to specify @command{neighbor A.B.C.D send-community} command. - -@example -! -router bgp 1 - neighbor 10.0.0.1 remote-as 1 - address-family ipv4 unicast - no neighbor 10.0.0.1 send-community - exit-address-family -! -router bgp 1 - neighbor 10.0.0.1 remote-as 1 - address-family ipv4 unicast - neighbor 10.0.0.1 send-community - exit-address-family -! -@end example - -@deffn {Command} {bgp config-type zebra} {} -Frr style BGP configuration. This is default. -@end deffn - -@node BGP instance and view -@subsection BGP instance and view - -BGP instance is a normal BGP process. The result of route selection -goes to the kernel routing table. You can setup different AS at the -same time when BGP multiple instance feature is enabled. - -@deffn {Command} {router bgp @var{as-number}} {} -Make a new BGP instance. You can use arbitrary word for the @var{name}. -@end deffn - -@example -@group -bgp multiple-instance -! -router bgp 1 - neighbor 10.0.0.1 remote-as 2 - neighbor 10.0.0.2 remote-as 3 -! -router bgp 2 - neighbor 10.0.0.3 remote-as 4 - neighbor 10.0.0.4 remote-as 5 -@end group -@end example - -BGP view is almost same as normal BGP process. The result of -route selection does not go to the kernel routing table. BGP view is -only for exchanging BGP routing information. - -@deffn {Command} {router bgp @var{as-number} view @var{name}} {} -Make a new BGP view. You can use arbitrary word for the @var{name}. This -view's route selection result does not go to the kernel routing table. -@end deffn - -With this command, you can setup Route Server like below. - -@example -@group -bgp multiple-instance -! -router bgp 1 view 1 - neighbor 10.0.0.1 remote-as 2 - neighbor 10.0.0.2 remote-as 3 -! -router bgp 2 view 2 - neighbor 10.0.0.3 remote-as 4 - neighbor 10.0.0.4 remote-as 5 -@end group -@end example - -@node Routing policy -@subsection Routing policy - -You can set different routing policy for a peer. For example, you can -set different filter for a peer. - -@example -@group -bgp multiple-instance -! -router bgp 1 view 1 - neighbor 10.0.0.1 remote-as 2 - address-family ipv4 unicast - neighbor 10.0.0.1 distribute-list 1 in - exit-address-family -! -router bgp 1 view 2 - neighbor 10.0.0.1 remote-as 2 - address-family ipv4 unicast - neighbor 10.0.0.1 distribute-list 2 in - exit-address-family -@end group -@end example - -This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view -2. When the update is inserted into view 1, distribute-list 1 is -applied. On the other hand, when the update is inserted into view 2, -distribute-list 2 is applied. - -@node Viewing the view -@subsection Viewing the view - -To display routing table of BGP view, you must specify view name. - -@deffn {Command} {show ip bgp view @var{name}} {} -Display routing table of BGP view @var{name}. -@end deffn - -@node BGP Regular Expressions -@section BGP Regular Expressions - -BGP regular expressions are based on @code{POSIX 1003.2} regular -expressions. The following description is just a quick subset of the -@code{POSIX} regular expressions. Adding to that, the special character -'_' is added. - -@table @code -@item . -Matches any single character. -@item * -Matches 0 or more occurrences of pattern. -@item + -Matches 1 or more occurrences of pattern. -@item ? -Match 0 or 1 occurrences of pattern. -@item ^ -Matches the beginning of the line. -@item $ -Matches the end of the line. -@item _ -Character @code{_} has special meanings in BGP regular expressions. -It matches to space and comma , and AS set delimiter @{ and @} and AS -confederation delimiter @code{(} and @code{)}. And it also matches to -the beginning of the line and the end of the line. So @code{_} can be -used for AS value boundaries match. This character technically evaluates -to @code{(^|[,@{@}() ]|$)}. -@end table - -@node How to set up a 6-Bone connection -@section How to set up a 6-Bone connection - - -@example -@group -zebra configuration -=================== -! -! Actually there is no need to configure zebra -! - -bgpd configuration -================== -! -! This means that routes go through zebra and into the kernel. -! -router zebra -! -! MP-BGP configuration -! -router bgp 7675 - bgp router-id 10.0.0.1 - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as @var{as-number} -! - address-family ipv6 - network 3ffe:506::/32 - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate - neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out - neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as @var{as-number} - neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out - exit-address-family -! -ipv6 access-list all permit any -! -! Set output nexthop address. -! -route-map set-nexthop permit 10 - match ipv6 address all - set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 - set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 -! -! logfile FILENAME is obsolete. Please use log file FILENAME - -log file bgpd.log -! -@end group -@end example - -@node Dump BGP packets and table -@section Dump BGP packets and table - -@deffn Command {dump bgp all @var{path} [@var{interval}]} {} -@deffnx Command {dump bgp all-et @var{path} [@var{interval}]} {} -@deffnx Command {no dump bgp all [@var{path}] [@var{interval}]} {} -Dump all BGP packet and events to @var{path} file. -If @var{interval} is set, a new file will be created for echo @var{interval} of seconds. -The path @var{path} can be set with date and time formatting (strftime). -The type ‘all-et’ enables support for Extended Timestamp Header (@pxref{Packet Binary Dump Format}). -(@pxref{Packet Binary Dump Format}) -@end deffn - -@deffn Command {dump bgp updates @var{path} [@var{interval}]} {} -@deffnx Command {dump bgp updates-et @var{path} [@var{interval}]} {} -@deffnx Command {no dump bgp updates [@var{path}] [@var{interval}]} {} -Dump only BGP updates messages to @var{path} file. -If @var{interval} is set, a new file will be created for echo @var{interval} of seconds. -The path @var{path} can be set with date and time formatting (strftime). -The type ‘updates-et’ enables support for Extended Timestamp Header (@pxref{Packet Binary Dump Format}). -@end deffn - -@deffn Command {dump bgp routes-mrt @var{path}} {} -@deffnx Command {dump bgp routes-mrt @var{path} @var{interval}} {} -@deffnx Command {no dump bgp route-mrt [@var{path}] [@var{interval}]} {} -Dump whole BGP routing table to @var{path}. This is heavy process. -The path @var{path} can be set with date and time formatting (strftime). -If @var{interval} is set, a new file will be created for echo @var{interval} of seconds. -@end deffn - -Note: the interval variable can also be set using hours and minutes: 04h20m00. - - -@node BGP Configuration Examples -@section BGP Configuration Examples - -Example of a session to an upstream, advertising only one prefix to it. - -@example -router bgp 64512 - bgp router-id 10.236.87.1 - neighbor upstream peer-group - neighbor upstream remote-as 64515 - neighbor upstream capability dynamic - neighbor 10.1.1.1 peer-group upstream - neighbor 10.1.1.1 description ACME ISP - - address-family ipv4 unicast - network 10.236.87.0/24 - neighbor upstream prefix-list pl-allowed-adv out - exit-address-family -! -ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 -ip prefix-list pl-allowed-adv seq 10 deny any - -@end example - -A more complex example. With upstream, peer and customer sessions. -Advertising global prefixes and NO_EXPORT prefixes and providing -actions for customer routes based on community values. Extensive use of -route-maps and the 'call' feature to support selective advertising of -prefixes. This example is intended as guidance only, it has NOT been -tested and almost certainly containts silly mistakes, if not serious -flaws. - -@example -router bgp 64512 - bgp router-id 10.236.87.1 - neighbor upstream capability dynamic - neighbor cust capability dynamic - neighbor peer capability dynamic - neighbor 10.1.1.1 remote-as 64515 - neighbor 10.1.1.1 peer-group upstream - neighbor 10.2.1.1 remote-as 64516 - neighbor 10.2.1.1 peer-group upstream - neighbor 10.3.1.1 remote-as 64517 - neighbor 10.3.1.1 peer-group cust-default - neighbor 10.3.1.1 description customer1 - neighbor 10.4.1.1 remote-as 64518 - neighbor 10.4.1.1 peer-group cust - neighbor 10.4.1.1 description customer2 - neighbor 10.5.1.1 remote-as 64519 - neighbor 10.5.1.1 peer-group peer - neighbor 10.5.1.1 description peer AS 1 - neighbor 10.6.1.1 remote-as 64520 - neighbor 10.6.1.1 peer-group peer - neighbor 10.6.1.1 description peer AS 2 - - address-family ipv4 unicast - network 10.123.456.0/24 - network 10.123.456.128/25 route-map rm-no-export - neighbor upstream route-map rm-upstream-out out - neighbor cust route-map rm-cust-in in - neighbor cust route-map rm-cust-out out - neighbor cust send-community both - neighbor peer route-map rm-peer-in in - neighbor peer route-map rm-peer-out out - neighbor peer send-community both - neighbor 10.3.1.1 prefix-list pl-cust1-network in - neighbor 10.4.1.1 prefix-list pl-cust2-network in - neighbor 10.5.1.1 prefix-list pl-peer1-network in - neighbor 10.6.1.1 prefix-list pl-peer2-network in - exit-address-family -! -ip prefix-list pl-default permit 0.0.0.0/0 -! -ip prefix-list pl-upstream-peers permit 10.1.1.1/32 -ip prefix-list pl-upstream-peers permit 10.2.1.1/32 -! -ip prefix-list pl-cust1-network permit 10.3.1.0/24 -ip prefix-list pl-cust1-network permit 10.3.2.0/24 -! -ip prefix-list pl-cust2-network permit 10.4.1.0/24 -! -ip prefix-list pl-peer1-network permit 10.5.1.0/24 -ip prefix-list pl-peer1-network permit 10.5.2.0/24 -ip prefix-list pl-peer1-network permit 192.168.0.0/24 -! -ip prefix-list pl-peer2-network permit 10.6.1.0/24 -ip prefix-list pl-peer2-network permit 10.6.2.0/24 -ip prefix-list pl-peer2-network permit 192.168.1.0/24 -ip prefix-list pl-peer2-network permit 192.168.2.0/24 -ip prefix-list pl-peer2-network permit 172.16.1/24 -! -ip as-path access-list asp-own-as permit ^$ -ip as-path access-list asp-own-as permit _64512_ -! -! ################################################################# -! Match communities we provide actions for, on routes receives from -! customers. Communities values of :X, with X, have actions: -! -! 100 - blackhole the prefix -! 200 - set no_export -! 300 - advertise only to other customers -! 400 - advertise only to upstreams -! 500 - set no_export when advertising to upstreams -! 2X00 - set local_preference to X00 -! -! blackhole the prefix of the route -ip community-list standard cm-blackhole permit 64512:100 -! -! set no-export community before advertising -ip community-list standard cm-set-no-export permit 64512:200 -! -! advertise only to other customers -ip community-list standard cm-cust-only permit 64512:300 -! -! advertise only to upstreams -ip community-list standard cm-upstream-only permit 64512:400 -! -! advertise to upstreams with no-export -ip community-list standard cm-upstream-noexport permit 64512:500 -! -! set local-pref to least significant 3 digits of the community -ip community-list standard cm-prefmod-100 permit 64512:2100 -ip community-list standard cm-prefmod-200 permit 64512:2200 -ip community-list standard cm-prefmod-300 permit 64512:2300 -ip community-list standard cm-prefmod-400 permit 64512:2400 -ip community-list expanded cme-prefmod-range permit 64512:2... -! -! Informational communities -! -! 3000 - learned from upstream -! 3100 - learned from customer -! 3200 - learned from peer -! -ip community-list standard cm-learnt-upstream permit 64512:3000 -ip community-list standard cm-learnt-cust permit 64512:3100 -ip community-list standard cm-learnt-peer permit 64512:3200 -! -! ################################################################### -! Utility route-maps -! -! These utility route-maps generally should not used to permit/deny -! routes, i.e. they do not have meaning as filters, and hence probably -! should be used with 'on-match next'. These all finish with an empty -! permit entry so as not interfere with processing in the caller. -! -route-map rm-no-export permit 10 - set community additive no-export -route-map rm-no-export permit 20 -! -route-map rm-blackhole permit 10 - description blackhole, up-pref and ensure it cant escape this AS - set ip next-hop 127.0.0.1 - set local-preference 10 - set community additive no-export -route-map rm-blackhole permit 20 -! -! Set local-pref as requested -route-map rm-prefmod permit 10 - match community cm-prefmod-100 - set local-preference 100 -route-map rm-prefmod permit 20 - match community cm-prefmod-200 - set local-preference 200 -route-map rm-prefmod permit 30 - match community cm-prefmod-300 - set local-preference 300 -route-map rm-prefmod permit 40 - match community cm-prefmod-400 - set local-preference 400 -route-map rm-prefmod permit 50 -! -! Community actions to take on receipt of route. -route-map rm-community-in permit 10 - description check for blackholing, no point continuing if it matches. - match community cm-blackhole - call rm-blackhole -route-map rm-community-in permit 20 - match community cm-set-no-export - call rm-no-export - on-match next -route-map rm-community-in permit 30 - match community cme-prefmod-range - call rm-prefmod -route-map rm-community-in permit 40 -! -! ##################################################################### -! Community actions to take when advertising a route. -! These are filtering route-maps, -! -! Deny customer routes to upstream with cust-only set. -route-map rm-community-filt-to-upstream deny 10 - match community cm-learnt-cust - match community cm-cust-only -route-map rm-community-filt-to-upstream permit 20 -! -! Deny customer routes to other customers with upstream-only set. -route-map rm-community-filt-to-cust deny 10 - match community cm-learnt-cust - match community cm-upstream-only -route-map rm-community-filt-to-cust permit 20 -! -! ################################################################### -! The top-level route-maps applied to sessions. Further entries could -! be added obviously.. -! -! Customers -route-map rm-cust-in permit 10 - call rm-community-in - on-match next -route-map rm-cust-in permit 20 - set community additive 64512:3100 -route-map rm-cust-in permit 30 -! -route-map rm-cust-out permit 10 - call rm-community-filt-to-cust - on-match next -route-map rm-cust-out permit 20 -! -! Upstream transit ASes -route-map rm-upstream-out permit 10 - description filter customer prefixes which are marked cust-only - call rm-community-filt-to-upstream - on-match next -route-map rm-upstream-out permit 20 - description only customer routes are provided to upstreams/peers - match community cm-learnt-cust -! -! Peer ASes -! outbound policy is same as for upstream -route-map rm-peer-out permit 10 - call rm-upstream-out -! -route-map rm-peer-in permit 10 - set community additive 64512:3200 -@end example - -@include rpki.texi diff --git a/doc/install.texi b/doc/install.texi deleted file mode 100644 index d0d56804b0..0000000000 --- a/doc/install.texi +++ /dev/null @@ -1,291 +0,0 @@ -@node Installation -@chapter Installation - -@cindex How to install Frr -@cindex Installation -@cindex Installing Frr -@cindex Building the system -@cindex Making Frr - -There are three steps for installing the software: configuration, -compilation, and installation. - -@menu -* Configure the Software:: -* Build the Software:: -* Install the Software:: -@end menu - -The easiest way to get Frr running is to issue the following -commands: - -@example -% configure -% make -% make install -@end example - -@node Configure the Software -@section Configure the Software - -@menu -* The Configure script and its options:: -* Least-Privilege support:: -* Linux notes:: -@end menu - -@node The Configure script and its options -@subsection The Configure script and its options - -@cindex Configuration options -@cindex Options for configuring -@cindex Build options -@cindex Distribution configuration -@cindex Options to @code{./configure} - -Frr has an excellent configure script which automatically detects most -host configurations. There are several additional configure options to -customize the build to include or exclude specific features and dependencies. - -@table @option -@item --disable-zebra -Do not build zebra daemon. -@item --disable-ripd -Do not build ripd. -@item --disable-ripngd -Do not build ripngd. -@item --disable-ospfd -Do not build ospfd. -@item --disable-ospf6d -Do not build ospf6d. -@item --disable-bgpd -Do not build bgpd. -@item --disable-bgp-announce -Make @command{bgpd} which does not make bgp announcements at all. This -feature is good for using @command{bgpd} as a BGP announcement listener. -@item --enable-datacenter -Enable system defaults to work as if in a Data Center. See defaults.h -for what is changed by this configure option. -@item --enable-snmp -Enable SNMP support. By default, SNMP support is disabled. -@item --disable-ospfapi -Disable support for OSPF-API, an API to interface directly with ospfd. -OSPF-API is enabled if --enable-opaque-lsa is set. -@item --disable-ospfclient -Disable building of the example OSPF-API client. -@item --disable-ospf-ri -Disable support for OSPF Router Information (RFC4970 & RFC5088) this -requires support for Opaque LSAs and Traffic Engineering. -@item --disable-isisd -Do not build isisd. -@item --enable-isis-topology -Enable IS-IS topology generator. -@item --enable-isis-te -Enable Traffic Engineering Extension for ISIS (RFC5305) -@item --enable-multipath=@var{ARG} -Enable support for Equal Cost Multipath. @var{ARG} is the maximum number -of ECMP paths to allow, set to 0 to allow unlimited number of paths. -@item --enable-realms -Enable the support of linux Realms. Convert tag values from 1-255 -into a realm value when inserting into the linux kernel. Then -routing policy can be assigned to the realm. See the tc man page. -@item --disable-rtadv -Disable support IPV6 router advertisement in zebra. -@item --enable-gcc-rdynamic -Pass the @command{-rdynamic} option to the linker driver. This is in most -cases neccessary for getting usable backtraces. This option defaults to on -if the compiler is detected as gcc, but giving an explicit enable/disable is -suggested. -@item --disable-backtrace -Controls backtrace support for the crash handlers. This is autodetected by -default. Using the switch will enforce the requested behaviour, failing with -an error if support is requested but not available. On BSD systems, this -needs libexecinfo, while on glibc support for this is part of libc itself. -@item --enable-dev-build -Turn on some options for compiling FRR within a development environment in -mind. Specifically turn on -g3 -O0 for compiling options and add inclusion -of grammar sandbox. -@item --enable-fuzzing -Turn on some compile options to allow you to run fuzzing tools -against the system. This tools is intended as a developer -only tool and should not be used for normal operations -@end table - -You may specify any combination of the above options to the configure -script. By default, the executables are placed in @file{/usr/local/sbin} -and the configuration files in @file{/usr/local/etc}. The @file{/usr/local/} -installation prefix and other directories may be changed using the following -options to the configuration script. - -@table @option -@item --prefix=@var{prefix} -Install architecture-independent files in @var{prefix} [/usr/local]. -@item --sysconfdir=@var{dir} -Look for configuration files in @var{dir} [@var{prefix}/etc]. Note -that sample configuration files will be installed here. -@item --localstatedir=@var{dir} -Configure zebra to use @var{dir} for local state files, such -as pid files and unix sockets. -@end table - -@example -% ./configure --disable-snmp -@end example - -This command will configure zebra and the routing daemons. - -@node Least-Privilege support -@subsection Least-Privilege support - -@cindex Frr Least-Privileges -@cindex Frr Privileges - -Additionally, you may configure zebra to drop its elevated privileges -shortly after startup and switch to another user. The configure script will -automatically try to configure this support. There are three configure -options to control the behaviour of Frr daemons. - -@table @option -@item --enable-user=@var{user} -Switch to user @var{ARG} shortly after startup, and run as user @var{ARG} -in normal operation. -@item --enable-group=@var{group} -Switch real and effective group to @var{group} shortly after -startup. -@item --enable-vty-group=@var{group} -Create Unix Vty sockets (for use with vtysh) with group owndership set to -@var{group}. This allows one to create a seperate group which is -restricted to accessing only the Vty sockets, hence allowing one to -delegate this group to individual users, or to run vtysh setgid to -this group. -@end table - -The default user and group which will be configured is 'frr' if no user -or group is specified. Note that this user or group requires write access to -the local state directory (see --localstatedir) and requires at least read -access, and write access if you wish to allow daemons to write out their -configuration, to the configuration directory (see --sysconfdir). - -On systems which have the 'libcap' capabilities manipulation library -(currently only linux), the frr system will retain only minimal -capabilities required, further it will only raise these capabilities for -brief periods. On systems without libcap, frr will run as the user -specified and only raise its uid back to uid 0 for brief periods. - -@node Linux notes -@subsection Linux Notes - -@cindex Configuring Frr -@cindex Building on Linux boxes -@cindex Linux configurations - -There are several options available only to @sc{gnu}/Linux systems: -@footnote{@sc{gnu}/Linux has very flexible kernel configuration features}. If -you use @sc{gnu}/Linux, make sure that the current kernel configuration is -what you want. Frr will run with any kernel configuration but some -recommendations do exist. - -@table @var - -@item CONFIG_NETLINK -Kernel/User netlink socket. This is a brand new feature which enables an -advanced interface between the Linux kernel and zebra (@pxref{Kernel Interface}). - -@item CONFIG_RTNETLINK -Routing messages. -This makes it possible to receive netlink routing messages. If you -specify this option, @command{zebra} can detect routing information -updates directly from the kernel (@pxref{Kernel Interface}). - -@item CONFIG_IP_MULTICAST -IP: multicasting. -This option should be specified when you use @command{ripd} (@pxref{RIP}) or -@command{ospfd} (@pxref{OSPFv2}) because these protocols use multicast. - -@end table - -IPv6 support has been added in @sc{gnu}/Linux kernel version 2.2. If you -try to use the Frr IPv6 feature on a @sc{gnu}/Linux kernel, please -make sure the following libraries have been installed. Please note that -these libraries will not be needed when you uses @sc{gnu} C library 2.1 -or upper. - -@table @code - -@item inet6-apps -The @code{inet6-apps} package includes basic IPv6 related libraries such -as @code{inet_ntop} and @code{inet_pton}. Some basic IPv6 programs such -as @command{ping}, @command{ftp}, and @command{inetd} are also -included. The @code{inet-apps} can be found at -@uref{ftp://ftp.inner.net/pub/ipv6/}. - -@item net-tools -The @code{net-tools} package provides an IPv6 enabled interface and -routing utility. It contains @command{ifconfig}, @command{route}, -@command{netstat}, and other tools. @code{net-tools} may be found at -@uref{http://www.tazenda.demon.co.uk/phil/net-tools/}. - -@end table -@c A - end of footnote - -@node Build the Software -@section Build the Software - -After configuring the software, you will need to compile it for your -system. Simply issue the command @command{make} in the root of the source -directory and the software will be compiled. Cliff Note versions of -different compilation examples can be found in the doc/Building_FRR_on_XXX.md -files. If you have *any* problems at this stage, be certain to send a -bug report @xref{Bug Reports}. - -@example -% ./bootstrap.sh -% ./configure -% make -@end example -@c A - End of node, Building the Software - - -@node Install the Software -@comment node-name, next, previous, up -@section Install the Software - -Installing the software to your system consists of copying the compiled -programs and supporting files to a standard location. After the -installation process has completed, these files have been copied -from your work directory to @file{/usr/local/bin}, and @file{/usr/local/etc}. - -To install the Frr suite, issue the following command at your shell -prompt: @command{make install}. - -@example -% -% make install -% -@end example - -Frr daemons have their own terminal interface or VTY. After -installation, you have to setup each beast's port number to connect to -them. Please add the following entries to @file{/etc/services}. - -@example -zebrasrv 2600/tcp # zebra service -zebra 2601/tcp # zebra vty -ripd 2602/tcp # RIPd vty -ripngd 2603/tcp # RIPngd vty -ospfd 2604/tcp # OSPFd vty -bgpd 2605/tcp # BGPd vty -ospf6d 2606/tcp # OSPF6d vty -ospfapi 2607/tcp # ospfapi -isisd 2608/tcp # ISISd vty -nhrpd 2610/tcp # nhrpd vty -pimd 2611/tcp # PIMd vty -@end example - -If you use a FreeBSD newer than 2.2.8, the above entries are already -added to @file{/etc/services} so there is no need to add it. If you -specify a port number when starting the daemon, these entries may not be -needed. - -You may need to make changes to the config files in -@file{@value{INSTALL_PREFIX_ETC}/*.conf}. @xref{Config Commands}. diff --git a/doc/isisd.texi b/doc/isisd.texi deleted file mode 100644 index 404698d805..0000000000 --- a/doc/isisd.texi +++ /dev/null @@ -1,433 +0,0 @@ -@cindex ISIS -@node ISIS -@chapter ISIS - -@acronym{ISIS,Intermediate System to Intermediate System} is a routing protocol -which is described in @cite{ISO10589, RFC1195, RFC5308}. ISIS is an -@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, -@acronym{ISIS} can provide scalable network support and faster -convergence times like @acronym{OSPF}. ISIS is widely used in large networks such as -@acronym{ISP,Internet Service Provider} and carrier backbone networks. - -@menu -* Configuring isisd:: -* ISIS router:: -* ISIS Timer:: -* ISIS region:: -* ISIS interface:: -* Showing ISIS information:: -* ISIS Traffic Engineering:: -* Debugging ISIS:: -* ISIS Configuration Examples:: -@end menu - -@node Configuring isisd -@section Configuring isisd - -There are no @command{isisd} specific options. Common options can be -specified (@pxref{Common Invocation Options}) to @command{isisd}. -@command{isisd} needs to acquire interface information from -@command{zebra} in order to function. Therefore @command{zebra} must be -running before invoking @command{isisd}. Also, if @command{zebra} is -restarted then @command{isisd} must be too. - -Like other daemons, @command{isisd} configuration is done in @acronym{ISIS} -specific configuration file @file{isisd.conf}. - -@node ISIS router -@section ISIS router - -To start ISIS process you have to specify the ISIS router. As of this -writing, @command{isisd} does not support multiple ISIS processes. - -@deffn Command {router isis WORD} {} -@deffnx Command {no router isis WORD} {} -@anchor{router isis WORD}Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'. -@command{isisd} does not yet support multiple ISIS processes but you must specify -the name of ISIS process. The ISIS process name 'WORD' is then used for interface -(see command @ref{ip router isis WORD}). -@end deffn - -@deffn {ISIS Command} {net XX.XXXX. ... .XXX.XX} {} -@deffnx {ISIS Command} {no net XX.XXXX. ... .XXX.XX} {} -Set/Unset network entity title (NET) provided in ISO format. -@end deffn - -@deffn {ISIS Command} {hostname dynamic} {} -@deffnx {ISIS Command} {no hostname dynamic} {} -Enable support for dynamic hostname. -@end deffn - -@deffn {ISIS Command} {area-password [clear | md5] } {} -@deffnx {ISIS Command} {domain-password [clear | md5] } {} -@deffnx {ISIS Command} {no area-password} {} -@deffnx {ISIS Command} {no domain-password} {} -Configure the authentication password for an area, respectively a domain, -as clear text or md5 one. -@end deffn - -@deffn {ISIS Command} {log-adjacency-changes} {} -@deffnx {ISIS Command} {no log-adjacency-changes} {} -Log changes in adjacency state. -@end deffn - -@deffn {ISIS Command} {metric-style [narrow | transition | wide]} {} -@deffnx {ISIS Command} {no metric-style} {} -@anchor{metric-style}Set old-style (ISO 10589) or new-style packet formats: - - narrow Use old style of TLVs with narrow metric - - transition Send and accept both styles of TLVs during transition - - wide Use new style of TLVs to carry wider metric -@end deffn - -@deffn {ISIS Command} {set-overload-bit} {} -@deffnx {ISIS Command} {no set-overload-bit} {} -Set overload bit to avoid any transit traffic. -@end deffn - -@node ISIS Timer -@section ISIS Timer - -@deffn {ISIS Command} {lsp-gen-interval <1-120>} {} -@deffnx {ISIS Command} {lsp-gen-interval [level-1 | level-2] <1-120>} {} -@deffnx {ISIS Command} {no lsp-gen-interval} {} -@deffnx {ISIS Command} {no lsp-gen-interval [level-1 | level-2]} {} -Set minimum interval in seconds between regenerating same LSP, -globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {lsp-refresh-interval <1-65235>} {} -@deffnx {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} -@deffnx {ISIS Command} {no lsp-refresh-interval} {} -@deffnx {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} -Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {lsp-refresh-interval <1-65235>} {} -@deffnx {ISIS Command} {lsp-refresh-interval [level-1 | level-2] <1-65235>} {} -@deffnx {ISIS Command} {no lsp-refresh-interval} {} -@deffnx {ISIS Command} {no lsp-refresh-interval [level-1 | level-2]} {} -Set LSP refresh interval in seconds, globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {max-lsp-lifetime <360-65535>} {} -@deffnx {ISIS Command} {max-lsp-lifetime [level-1 | level-2] <360-65535>} {} -@deffnx {ISIS Command} {no max-lsp-lifetime} {} -@deffnx {ISIS Command} {no max-lsp-lifetime [level-1 | level-2]} {} -Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {ISIS Command} {spf-interval <1-120>} {} -@deffnx {ISIS Command} {spf-interval [level-1 | level-2] <1-120>} {} -@deffnx {ISIS Command} {no spf-interval} {} -@deffnx {ISIS Command} {no spf-interval [level-1 | level-2]} {} -Set minimum interval between consecutive SPF calculations in seconds. -@end deffn - -@node ISIS region -@section ISIS region - -@deffn {ISIS Command} {is-type [level-1 | level-1-2 | level-2-only]} {} -@deffnx {ISIS Command} {no is-type} {} -Define the ISIS router behavior: - - level-1 Act as a station router only - - level-1-2 Act as both a station router and an area router - - level-2-only Act as an area router only -@end deffn - -@node ISIS interface -@section ISIS interface - -@deffn {Interface Command} {ip router isis WORD} {} -@deffnx {Interface Command} {no ip router isis WORD} {} -@anchor{ip router isis WORD}Activate ISIS adjacency on this interface. Note that the name -of ISIS instance must be the same as the one used to configure the ISIS process -(see command @ref{router isis WORD}). -@end deffn - -@deffn {Interface Command} {isis circuit-type [level-1 | level-1-2 | level-2]} {} -@deffnx {Interface Command} {no isis circuit-type} {} -Configure circuit type for interface: - - level-1 Level-1 only adjacencies are formed - - level-1-2 Level-1-2 adjacencies are formed - - level-2-only Level-2 only adjacencies are formed -@end deffn - -@deffn {Interface Command} {isis csnp-interval <1-600>} {} -@deffnx {Interface Command} {isis csnp-interval <1-600> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis csnp-interval} {} -@deffnx {Interface Command} {no isis csnp-interval [level-1 | level-2]} {} -Set CSNP interval in seconds globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {Interface Command} {isis hello padding} {} -Add padding to IS-IS hello packets. -@end deffn - -@deffn {Interface Command} {isis hello-interval <1-600>} {} -@deffnx {Interface Command} {isis hello-interval <1-600> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis hello-interval} {} -@deffnx {Interface Command} {no isis hello-interval [level-1 | level-2]} {} -Set Hello interval in seconds globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {Interface Command} {isis hello-multiplier <2-100>} {} -@deffnx {Interface Command} {isis hello-multiplier <2-100> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis hello-multiplier} {} -@deffnx {Interface Command} {no isis hello-multiplier [level-1 | level-2]} {} -Set multiplier for Hello holding time globally, for an area (level-1) or a domain (level-2). -@end deffn - -@deffn {Interface Command} {isis metric [<0-255> | <0-16777215>]} {} -@deffnx {Interface Command} {isis metric [<0-255> | <0-16777215>] [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis metric} {} -@deffnx {Interface Command} {no isis metric [level-1 | level-2]} {} -Set default metric value globally, for an area (level-1) or a domain (level-2). -Max value depend if metric support narrow or wide value (see command @ref{metric-style}). -@end deffn - -@deffn {Interface Command} {isis network point-to-point} {} -@deffnx {Interface Command} {no isis network point-to-point} {} -Set network type to 'Point-to-Point' (broadcast by default). -@end deffn - -@deffn {Interface Command} {isis passive} {} -@deffnx {Interface Command} {no isis passive} {} -Configure the passive mode for this interface. -@end deffn - -@deffn {Interface Command} {isis password [clear | md5] } {} -@deffnx {Interface Command} {no isis password} {} -Configure the authentication password (clear or encoded text) for the interface. -@end deffn - -@deffn {Interface Command} {isis priority <0-127>} {} -@deffnx {Interface Command} {isis priority <0-127> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis priority} {} -@deffnx {Interface Command} {no isis priority [level-1 | level-2]} {} -Set priority for Designated Router election, globally, for the area (level-1) -or the domain (level-2). -@end deffn - -@deffn {Interface Command} {isis psnp-interval <1-120>} {} -@deffnx {Interface Command} {isis psnp-interval <1-120> [level-1 | level-2]} {} -@deffnx {Interface Command} {no isis psnp-interval} {} -@deffnx {Interface Command} {no isis psnp-interval [level-1 | level-2]} {} -Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2). -@end deffn - -@node Showing ISIS information -@section Showing ISIS information - -@deffn {Command} {show isis summary} {} -Show summary information about ISIS. -@end deffn - -@deffn {Command} {show isis hostname} {} -Show information about ISIS node. -@end deffn - -@deffn {Command} {show isis interface} {} -@deffnx {Command} {show isis interface detail} {} -@deffnx {Command} {show isis interface } {} -Show state and configuration of ISIS specified interface, or all -interfaces if no interface is given with or without details. -@end deffn - -@deffn {Command} {show isis neighbor} {} -@deffnx {Command} {show isis neighbor } {} -@deffnx {Command} {show isis neighbor detail} {} -Show state and information of ISIS specified neighbor, or all -neighbors if no system id is given with or without details. -@end deffn - -@deffn {Command} {show isis database} {} -@deffnx {Command} {show isis database [detail]} {} -@deffnx {Command} {show isis database [detail]} {} -@deffnx {Command} {show isis database detail } {} -Show the ISIS database globally, for a specific LSP id without or with details. -@end deffn - -@deffn {Command} {show isis topology} {} -@deffnx {Command} {show isis topology [level-1|level-2]} {} -Show topology IS-IS paths to Intermediate Systems, globally, -in area (level-1) or domain (level-2). -@end deffn - -@deffn {Command} {show ip route isis} {} -Show the ISIS routing table, as determined by the most recent SPF calculation. -@end deffn - -@node ISIS Traffic Engineering -@section Traffic Engineering - -@deffn {ISIS Command} {mpls-te on} {} -@deffnx {ISIS Command} {no mpls-te} {} -Enable Traffic Engineering LSP flooding. -@end deffn - -@deffn {ISIS Command} {mpls-te router-address } {} -@deffnx {ISIS Command} {no mpls-te router-address} {} -Configure stable IP address for MPLS-TE. -@end deffn - -@deffn {Command} {show isis mpls-te interface} {} -@deffnx {Command} {show isis mpls-te interface @var{interface}} {} -Show MPLS Traffic Engineering parameters for all or specified interface. -@end deffn - -@deffn {Command} {show isis mpls-te router} {} -Show Traffic Engineering router parameters. -@end deffn - -@node Debugging ISIS -@section Debugging ISIS - -@deffn {Command} {debug isis adj-packets} {} -@deffnx {Command} {no debug isis adj-packets} {} -IS-IS Adjacency related packets. -@end deffn - -@deffn {Command} {debug isis checksum-errors} {} -@deffnx {Command} {no debug isis checksum-errors} {} -IS-IS LSP checksum errors. -@end deffn - -@deffn {Command} {debug isis events} {} -@deffnx {Command} {no debug isis events} {} -IS-IS Events. -@end deffn - -@deffn {Command} {debug isis local-updates} {} -@deffnx {Command} {no debug isis local-updates} {} -IS-IS local update packets. -@end deffn - -@deffn {Command} {debug isis packet-dump} {} -@deffnx {Command} {no debug isis packet-dump} {} -IS-IS packet dump. -@end deffn - -@deffn {Command} {debug isis protocol-errors} {} -@deffnx {Command} {no debug isis protocol-errors} {} -IS-IS LSP protocol errors. -@end deffn - -@deffn {Command} {debug isis route-events} {} -@deffnx {Command} {no debug isis route-events} {} -IS-IS Route related events. -@end deffn - -@deffn {Command} {debug isis snp-packets} {} -@deffnx {Command} {no debug isis snp-packets} {} -IS-IS CSNP/PSNP packets. -@end deffn - -@deffn {Command} {debug isis spf-events} {} -@deffnx {Command} {debug isis spf-statistics} {} -@deffnx {Command} {debug isis spf-triggers} {} -@deffnx {Command} {no debug isis spf-events} {} -@deffnx {Command} {no debug isis spf-statistics} {} -@deffnx {Command} {no debug isis spf-triggers} {} -IS-IS Shortest Path First Events, Timing and Statistic Data -and triggering events. -@end deffn - -@deffn {Command} {debug isis update-packets} {} -@deffnx {Command} {no debug isis update-packets} {} -Update related packets. -@end deffn - -@deffn {Command} {show debugging isis} {} -Print which ISIS debug level is activate. -@end deffn - -@node ISIS Configuration Examples -@section ISIS Configuration Examples -A simple example, with MD5 authentication enabled: - -@example -@group -! -interface eth0 - ip router isis FOO - isis network point-to-point - isis circuit-type level-2-only -! -router isis FOO -net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 - metric-style wide - is-type level-2-only -@end group -@end example - - -A Traffic Engineering configuration, with Inter-ASv2 support. - - - First, the 'zebra.conf' part: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/zebra.log -! -interface eth0 - ip address 10.2.2.2/24 - link-params - enable - metric 100 - max-bw 1.25e+07 - max-rsv-bw 1.25e+06 - unrsv-bw 0 1.25e+06 - unrsv-bw 1 1.25e+06 - unrsv-bw 2 1.25e+06 - unrsv-bw 3 1.25e+06 - unrsv-bw 4 1.25e+06 - unrsv-bw 5 1.25e+06 - unrsv-bw 6 1.25e+06 - unrsv-bw 7 1.25e+06 - admin-grp 0xab -! -interface eth1 - ip address 10.1.1.1/24 - link-params - enable - metric 100 - max-bw 1.25e+07 - max-rsv-bw 1.25e+06 - unrsv-bw 0 1.25e+06 - unrsv-bw 1 1.25e+06 - unrsv-bw 2 1.25e+06 - unrsv-bw 3 1.25e+06 - unrsv-bw 4 1.25e+06 - unrsv-bw 5 1.25e+06 - unrsv-bw 6 1.25e+06 - unrsv-bw 7 1.25e+06 - neighbor 10.1.1.2 as 65000 -@end group -@end example - - - Then the 'isisd.conf' itself: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/isisd.log -! -! -interface eth0 - ip router isis FOO -! -interface eth1 - ip router isis FOO -! -! -router isis FOO - isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00 - mpls-te on - mpls-te router-address 10.1.1.1 -! -line vty -@end group -@end example diff --git a/doc/ospfd.texi b/doc/ospfd.texi deleted file mode 100644 index 26a7637048..0000000000 --- a/doc/ospfd.texi +++ /dev/null @@ -1,930 +0,0 @@ - -@cindex OSPFv2 -@node OSPFv2 -@chapter OSPFv2 - -@acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol -which is described in @cite{RFC2328, OSPF Version 2}. OSPF is an -@acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, -@acronym{OSPF} can provide scalable network support and faster -convergence times. OSPF is widely used in large networks such as -@acronym{ISP,Internet Service Provider} backbone and enterprise -networks. - -@menu -* OSPF Fundamentals:: -* Configuring ospfd:: -* OSPF router:: -* OSPF area:: -* OSPF interface:: -* Redistribute routes to OSPF:: -* Showing OSPF information:: -* Opaque LSA:: -* OSPF Traffic Engineering:: -* Router Information:: -* Debugging OSPF:: -* OSPF Configuration Examples:: -@end menu - -@include ospf_fundamentals.texi - -@node Configuring ospfd -@section Configuring ospfd - -There are no @command{ospfd} specific options. Common options can be -specified (@pxref{Common Invocation Options}) to @command{ospfd}. -@command{ospfd} needs to acquire interface information from -@command{zebra} in order to function. Therefore @command{zebra} must be -running before invoking @command{ospfd}. Also, if @command{zebra} is -restarted then @command{ospfd} must be too. - -Like other daemons, @command{ospfd} configuration is done in @acronym{OSPF} -specific configuration file @file{ospfd.conf}. - -@node OSPF router -@section OSPF router - -To start OSPF process you have to specify the OSPF router. As of this -writing, @command{ospfd} does not support multiple OSPF processes. - -@deffn Command {router ospf} {} -@deffnx Command {no router ospf} {} -Enable or disable the OSPF process. @command{ospfd} does not yet -support multiple OSPF processes. So you can not specify an OSPF process -number. -@end deffn - -@deffn {OSPF Command} {ospf router-id @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no ospf router-id} {} -@anchor{ospf router-id}This sets the router-ID of the OSPF process. The -router-ID may be an IP address of the router, but need not be - it can -be any arbitrary 32bit number. However it MUST be unique within the -entire OSPF domain to the OSPF speaker - bad things will happen if -multiple OSPF speakers are configured with the same router-ID! If one -is not specified then @command{ospfd} will obtain a router-ID -automatically from @command{zebra}. -@end deffn - -@deffn {OSPF Command} {ospf abr-type @var{type}} {} -@deffnx {OSPF Command} {no ospf abr-type @var{type}} {} -@var{type} can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types -are equivalent. - -The OSPF standard for ABR behaviour does not allow an ABR to consider -routes through non-backbone areas when its links to the backbone are -down, even when there are other ABRs in attached non-backbone areas -which still can reach the backbone - this restriction exists primarily -to ensure routing-loops are avoided. - -With the "Cisco" or "IBM" ABR type, the default in this release of -Frr, this restriction is lifted, allowing an ABR to consider -summaries learnt from other ABRs through non-backbone areas, and hence -route via non-backbone areas as a last resort when, and only when, -backbone links are down. - -Note that areas with fully-adjacent virtual-links are considered to be -"transit capable" and can always be used to route backbone traffic, and -hence are unaffected by this setting (@pxref{OSPF virtual-link}). - -More information regarding the behaviour controlled by this command can -be found in @cite{RFC 3509, Alternative Implementations of OSPF Area -Border Routers}, and @cite{draft-ietf-ospf-shortcut-abr-02.txt}. - -Quote: "Though the definition of the @acronym{ABR,Area Border Router} -in the OSPF specification does not require a router with multiple -attached areas to have a backbone connection, it is actually -necessary to provide successful routing to the inter-area and -external destinations. If this requirement is not met, all traffic -destined for the areas not connected to such an ABR or out of the -OSPF domain, is dropped. This document describes alternative ABR -behaviors implemented in Cisco and IBM routers." -@end deffn - -@deffn {OSPF Command} {ospf rfc1583compatibility} {} -@deffnx {OSPF Command} {no ospf rfc1583compatibility} {} -@cite{RFC2328}, the sucessor to @cite{RFC1583}, suggests according -to section G.2 (changes) in section 16.4 a change to the path -preference algorithm that prevents possible routing loops that were -possible in the old version of OSPFv2. More specifically it demands -that inter-area paths and intra-area backbone path are now of equal preference -but still both preferred to external paths. - -This command should NOT be set normally. -@end deffn - -@deffn {OSPF Command} {log-adjacency-changes [detail]} {} -@deffnx {OSPF Command} {no log-adjacency-changes [detail]} {} -Configures ospfd to log changes in adjacency. With the optional -detail argument, all changes in adjacency status are shown. Without detail, -only changes to full or regressions are shown. -@end deffn - -@deffn {OSPF Command} {passive-interface @var{interface}} {} -@deffnx {OSPF Command} {no passive-interface @var{interface}} {} -@anchor{OSPF passive-interface} Do not speak OSPF interface on the -given interface, but do advertise the interface as a stub link in the -router-@acronym{LSA,Link State Advertisement} for this router. This -allows one to advertise addresses on such connected interfaces without -having to originate AS-External/Type-5 LSAs (which have global flooding -scope) - as would occur if connected addresses were redistributed into -OSPF (@pxref{Redistribute routes to OSPF})@. This is the only way to -advertise non-OSPF links into stub areas. -@end deffn - -@deffn {OSPF Command} {timers throttle spf @var{delay} @var{initial-holdtime} @var{max-holdtime}} {} -@deffnx {OSPF Command} {no timers throttle spf} {} -This command sets the initial @var{delay}, the @var{initial-holdtime} -and the @var{maximum-holdtime} between when SPF is calculated and the -event which triggered the calculation. The times are specified in -milliseconds and must be in the range of 0 to 600000 milliseconds. - -The @var{delay} specifies the minimum amount of time to delay SPF -calculation (hence it affects how long SPF calculation is delayed after -an event which occurs outside of the holdtime of any previous SPF -calculation, and also serves as a minimum holdtime). - -Consecutive SPF calculations will always be seperated by at least -'hold-time' milliseconds. The hold-time is adaptive and initially is -set to the @var{initial-holdtime} configured with the above command. -Events which occur within the holdtime of the previous SPF calculation -will cause the holdtime to be increased by @var{initial-holdtime}, bounded -by the @var{maximum-holdtime} configured with this command. If the adaptive -hold-time elapses without any SPF-triggering event occuring then -the current holdtime is reset to the @var{initial-holdtime}. The current -holdtime can be viewed with @ref{show ip ospf}, where it is expressed as -a multiplier of the @var{initial-holdtime}. - -@example -@group -router ospf - timers throttle spf 200 400 10000 -@end group -@end example - -In this example, the @var{delay} is set to 200ms, the @var{initial -holdtime} is set to 400ms and the @var{maximum holdtime} to 10s. Hence -there will always be at least 200ms between an event which requires SPF -calculation and the actual SPF calculation. Further consecutive SPF -calculations will always be seperated by between 400ms to 10s, the -hold-time increasing by 400ms each time an SPF-triggering event occurs -within the hold-time of the previous SPF calculation. - -This command supercedes the @command{timers spf} command in previous Frr -releases. -@end deffn - -@deffn {OSPF Command} {max-metric router-lsa [on-startup|on-shutdown] <5-86400>} {} -@deffnx {OSPF Command} {max-metric router-lsa administrative} {} -@deffnx {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} -This enables @cite{RFC3137, OSPF Stub Router Advertisement} support, -where the OSPF process describes its transit links in its router-LSA as -having infinite distance so that other routers will avoid calculating -transit paths through the router while still being able to reach -networks through the router. - -This support may be enabled administratively (and indefinitely) or -conditionally. Conditional enabling of max-metric router-lsas can be -for a period of seconds after startup and/or for a period of seconds -prior to shutdown. - -Enabling this for a period after startup allows OSPF to converge fully -first without affecting any existing routes used by other routers, -while still allowing any connected stub links and/or redistributed -routes to be reachable. Enabling this for a period of time in advance -of shutdown allows the router to gracefully excuse itself from the OSPF -domain. - -Enabling this feature administratively allows for administrative -intervention for whatever reason, for an indefinite period of time. -Note that if the configuration is written to file, this administrative -form of the stub-router command will also be written to file. If -@command{ospfd} is restarted later, the command will then take effect -until manually deconfigured. - -Configured state of this feature as well as current status, such as the -number of second remaining till on-startup or on-shutdown ends, can be -viewed with the @ref{show ip ospf} command. -@end deffn - -@deffn {OSPF Command} {auto-cost reference-bandwidth <1-4294967>} {} -@deffnx {OSPF Command} {no auto-cost reference-bandwidth} {} -@anchor{OSPF auto-cost reference-bandwidth}This sets the reference -bandwidth for cost calculations, where this bandwidth is considered -equivalent to an OSPF cost of 1, specified in Mbits/s. The default is -100Mbit/s (i.e. a link of bandwidth 100Mbit/s or higher will have a -cost of 1. Cost of lower bandwidth links will be scaled with reference -to this cost). - -This configuration setting MUST be consistent across all routers within the -OSPF domain. -@end deffn - -@deffn {OSPF Command} {network @var{a.b.c.d/m} area @var{a.b.c.d}} {} -@deffnx {OSPF Command} {network @var{a.b.c.d/m} area @var{<0-4294967295>}} {} -@deffnx {OSPF Command} {no network @var{a.b.c.d/m} area @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no network @var{a.b.c.d/m} area @var{<0-4294967295>}} {} -@anchor{OSPF network command} -This command specifies the OSPF enabled interface(s). If the interface has -an address from range 192.168.1.0/24 then the command below enables ospf -on this interface so router can provide network information to the other -ospf routers via this interface. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 -@end group -@end example - -Prefix length in interface must be equal or bigger (ie. smaller network) than -prefix length in network statement. For example statement above doesn't enable -ospf on interface with address 192.168.1.1/23, but it does on interface with -address 192.168.1.129/25. - -Note that the behavior when there is a peer address -defined on an interface changed after release 0.99.7. -Currently, if a peer prefix has been configured, -then we test whether the prefix in the network command contains -the destination prefix. Otherwise, we test whether the network command prefix -contains the local address prefix of the interface. - -In some cases it may be more convenient to enable OSPF on a per -interface/subnet basis (@pxref{OSPF ip ospf area command}). - -@end deffn - -@node OSPF area -@section OSPF area - -@deffn {OSPF Command} {area @var{a.b.c.d} range @var{a.b.c.d/m}} {} -@deffnx {OSPF Command} {area <0-4294967295> range @var{a.b.c.d/m}} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} range @var{a.b.c.d/m}} {} -@deffnx {OSPF Command} {no area <0-4294967295> range @var{a.b.c.d/m}} {} -Summarize intra area paths from specified area into one Type-3 summary-LSA -announced to other areas. This command can be used only in ABR and ONLY -router-LSAs (Type-1) and network-LSAs (Type-2) (ie. LSAs with scope area) can -be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS. -Summarizing Type-7 AS-external-LSAs isn't supported yet by Frr. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 range 10.0.0.0/8 -@end group -@end example - -With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is -announced into backbone area if area 0.0.0.10 contains at least one intra-area -network (ie. described with router or network LSA) from this range. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} range IPV4_PREFIX not-advertise} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} range IPV4_PREFIX not-advertise} {} -Instead of summarizing intra area paths filter them - ie. intra area paths from this -range are not advertised into other areas. -This command makes sense in ABR only. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} range IPV4_PREFIX substitute IPV4_PREFIX} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} range IPV4_PREFIX substitute IPV4_PREFIX} {} -Substitute summarized prefix with another prefix. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8 -@end group -@end example - -One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if -area 0.0.0.10 contains at least one intra-area network (ie. described with router-LSA or -network-LSA) from range 10.0.0.0/8. -This command makes sense in ABR only. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} virtual-link @var{a.b.c.d}} {} -@deffnx {OSPF Command} {area <0-4294967295> virtual-link @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} virtual-link @var{a.b.c.d}} {} -@deffnx {OSPF Command} {no area <0-4294967295> virtual-link @var{a.b.c.d}} {} -@anchor{OSPF virtual-link} -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} shortcut} {} -@deffnx {OSPF Command} {area <0-4294967295> shortcut} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} shortcut} {} -@deffnx {OSPF Command} {no area <0-4294967295> shortcut} {} -Configure the area as Shortcut capable. See @cite{RFC3509}. This requires -that the 'abr-type' be set to 'shortcut'. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} stub} {} -@deffnx {OSPF Command} {area <0-4294967295> stub} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} stub} {} -@deffnx {OSPF Command} {no area <0-4294967295> stub} {} -Configure the area to be a stub area. That is, an area where no router -originates routes external to OSPF and hence an area where all external -routes are via the ABR(s). Hence, ABRs for such an area do not need -to pass AS-External LSAs (type-5s) or ASBR-Summary LSAs (type-4) into the -area. They need only pass Network-Summary (type-3) LSAs into such an area, -along with a default-route summary. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} stub no-summary} {} -@deffnx {OSPF Command} {area <0-4294967295> stub no-summary} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} stub no-summary} {} -@deffnx {OSPF Command} {no area <0-4294967295> stub no-summary} {} -Prevents an @command{ospfd} ABR from injecting inter-area -summaries into the specified stub area. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} default-cost <0-16777215>} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} default-cost <0-16777215>} {} -Set the cost of default-summary LSAs announced to stubby areas. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} export-list NAME} {} -@deffnx {OSPF Command} {area <0-4294967295> export-list NAME} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} export-list NAME} {} -@deffnx {OSPF Command} {no area <0-4294967295> export-list NAME} {} -Filter Type-3 summary-LSAs announced to other areas originated from intra- -area paths from specified area. - -@example -@group -router ospf - network 192.168.1.0/24 area 0.0.0.0 - network 10.0.0.0/8 area 0.0.0.10 - area 0.0.0.10 export-list foo -! -access-list foo permit 10.10.0.0/16 -access-list foo deny any -@end group -@end example - -With example above any intra-area paths from area 0.0.0.10 and from range -10.10.0.0/16 (for example 10.10.1.0/24 and 10.10.2.128/30) are announced into -other areas as Type-3 summary-LSA's, but any others (for example 10.11.0.0/16 -or 10.128.30.16/30) aren't. - -This command is only relevant if the router is an ABR for the specified -area. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} import-list NAME} {} -@deffnx {OSPF Command} {area <0-4294967295> import-list NAME} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} import-list NAME} {} -@deffnx {OSPF Command} {no area <0-4294967295> import-list NAME} {} -Same as export-list, but it applies to paths announced into specified area as -Type-3 summary-LSAs. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} filter-list prefix NAME in} {} -@deffnx {OSPF Command} {area @var{a.b.c.d} filter-list prefix NAME out} {} -@deffnx {OSPF Command} {area <0-4294967295> filter-list prefix NAME in} {} -@deffnx {OSPF Command} {area <0-4294967295> filter-list prefix NAME out} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} filter-list prefix NAME in} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} filter-list prefix NAME out} {} -@deffnx {OSPF Command} {no area <0-4294967295> filter-list prefix NAME in} {} -@deffnx {OSPF Command} {no area <0-4294967295> filter-list prefix NAME out} {} -Filtering Type-3 summary-LSAs to/from area using prefix lists. This command -makes sense in ABR only. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} authentication} {} -@deffnx {OSPF Command} {area <0-4294967295> authentication} {} -@deffnx {OSPF Command} {no area @var{a.b.c.d} authentication} {} -@deffnx {OSPF Command} {no area <0-4294967295> authentication} {} -Specify that simple password authentication should be used for the given -area. -@end deffn - -@deffn {OSPF Command} {area @var{a.b.c.d} authentication message-digest} {} -@deffnx {OSPF Command} {area <0-4294967295> authentication message-digest} {} - -@anchor{area authentication message-digest}Specify that OSPF packets -must be authenticated with MD5 HMACs within the given area. Keying -material must also be configured on a per-interface basis (@pxref{ip -ospf message-digest-key}). - -MD5 authentication may also be configured on a per-interface basis -(@pxref{ip ospf authentication message-digest}). Such per-interface -settings will override any per-area authentication setting. -@end deffn - -@node OSPF interface -@section OSPF interface - -@deffn {Interface Command} {ip ospf area @var{AREA} [@var{ADDR}]} {} -@deffnx {Interface Command} {no ip ospf area [@var{ADDR}]} {} -@anchor{OSPF ip ospf area command} - -Enable OSPF on the interface, optionally restricted to just the IP address -given by @var{ADDR}, putting it in the @var{AREA} area. Per interface area -settings take precedence to network commands (@pxref{OSPF network command}). - -If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF -via this command may result in a slight performance improvement. - -@end deffn - -@deffn {Interface Command} {ip ospf authentication-key @var{AUTH_KEY}} {} -@deffnx {Interface Command} {no ip ospf authentication-key} {} -Set OSPF authentication key to a simple password. After setting @var{AUTH_KEY}, -all OSPF packets are authenticated. @var{AUTH_KEY} has length up to 8 chars. - -Simple text password authentication is insecure and deprecated in favour of -MD5 HMAC authentication (@pxref{ip ospf authentication message-digest}). -@end deffn - -@deffn {Interface Command} {ip ospf authentication message-digest} {} -@anchor{ip ospf authentication message-digest}Specify that MD5 HMAC -authentication must be used on this interface. MD5 keying material must -also be configured (@pxref{ip ospf message-digest-key}). Overrides any -authentication enabled on a per-area basis (@pxref{area -authentication message-digest}). - -Note that OSPF MD5 authentication requires that time never go backwards -(correct time is NOT important, only that it never goes backwards), even -across resets, if ospfd is to be able to promptly reestabish adjacencies -with its neighbours after restarts/reboots. The host should have system -time be set at boot from an external or non-volatile source (eg battery backed clock, NTP, -etc.) or else the system clock should be periodically saved to non-volative -storage and restored at boot if MD5 authentication is to be expected to work -reliably. -@end deffn - -@deffn {Interface Command} {ip ospf message-digest-key KEYID md5 KEY} {} -@deffnx {Interface Command} {no ip ospf message-digest-key} {} -@anchor{ip ospf message-digest-key}Set OSPF authentication key to a -cryptographic password. The cryptographic algorithm is MD5. - -KEYID identifies secret key used to create the message digest. This ID -is part of the protocol and must be consistent across routers on a -link. - -KEY is the actual message digest key, of up to 16 chars (larger strings -will be truncated), and is associated with the given KEYID. -@end deffn - -@deffn {Interface Command} {ip ospf cost <1-65535>} {} -@deffnx {Interface Command} {no ip ospf cost} {} -Set link cost for the specified interface. The cost value is set to router-LSA's -metric field and used for SPF calculation. -@end deffn - -@deffn {Interface Command} {ip ospf dead-interval <1-65535>} {} -@deffnx {Interface Command} {ip ospf dead-interval minimal hello-multiplier <2-20>} {} -@deffnx {Interface Command} {no ip ospf dead-interval} {} -@anchor{ip ospf dead-interval minimal} Set number of seconds for -RouterDeadInterval timer value used for Wait Timer and Inactivity -Timer. This value must be the same for all routers attached to a -common network. The default value is 40 seconds. - -If 'minimal' is specified instead, then the dead-interval is set to 1 -second and one must specify a hello-multiplier. The hello-multiplier -specifies how many Hellos to send per second, from 2 (every 500ms) to -20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form -is specified, then the hello-interval advertised in Hello packets is set to -0 and the hello-interval on received Hello packets is not checked, thus -the hello-multiplier need NOT be the same across multiple routers on a common -link. -@end deffn - -@deffn {Interface Command} {ip ospf hello-interval <1-65535>} {} -@deffnx {Interface Command} {no ip ospf hello-interval} {} -Set number of seconds for HelloInterval timer value. Setting this value, -Hello packet will be sent every timer value seconds on the specified interface. -This value must be the same for all routers attached to a common network. -The default value is 10 seconds. - -This command has no effect if @ref{ip ospf dead-interval minimal} is also -specified for the interface. -@end deffn - -@deffn {Interface Command} {ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point)} {} -@deffnx {Interface Command} {no ip ospf network} {} -Set explicitly network type for specifed interface. -@end deffn - -@deffn {Interface Command} {ip ospf priority <0-255>} {} -@deffnx {Interface Command} {no ip ospf priority} {} -Set RouterPriority integer value. The router with the highest priority -will be more eligible to become Designated Router. Setting the value -to 0, makes the router ineligible to become Designated Router. The -default value is 1. -@end deffn - -@deffn {Interface Command} {ip ospf retransmit-interval <1-65535>} {} -@deffnx {Interface Command} {no ip ospf retransmit interval} {} -Set number of seconds for RxmtInterval timer value. This value is used -when retransmitting Database Description and Link State Request packets. -The default value is 5 seconds. -@end deffn - -@deffn {Interface Command} {ip ospf transmit-delay} {} -@deffnx {Interface Command} {no ip ospf transmit-delay} {} -Set number of seconds for InfTransDelay value. LSAs' age should be -incremented by this value when transmitting. -The default value is 1 seconds. -@end deffn - -@deffn {Interface Command} {ip ospf area (A.B.C.D|<0-4294967295>)} {} -@deffnx {Interface Command} {no ip ospf area} {} -Enable ospf on an interface and set associated area. -@end deffn - -@node Redistribute routes to OSPF -@section Redistribute routes to OSPF - -@deffn {OSPF Command} {redistribute (kernel|connected|static|rip|bgp)} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) @var{route-map}} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2)} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map @var{word}} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214>} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric <0-16777214> route-map @var{word}} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214>} {} -@deffnx {OSPF Command} {redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric <0-16777214> route-map @var{word}} {} -@deffnx {OSPF Command} {no redistribute (kernel|connected|static|rip|bgp)} {} -@anchor{OSPF redistribute}Redistribute routes of the specified protocol -or kind into OSPF, with the metric type and metric set if specified, -filtering the routes using the given route-map if specified. -Redistributed routes may also be filtered with distribute-lists, see -@ref{ospf distribute-list}. - -Redistributed routes are distributed as into OSPF as Type-5 External -LSAs into links to areas that accept external routes, Type-7 External LSAs -for NSSA areas and are not redistributed at all into Stub areas, where -external routes are not permitted. - -Note that for connected routes, one may instead use -@dfn{passive-interface}, see @ref{OSPF passive-interface}. -@end deffn - -@deffn {OSPF Command} {default-information originate} {} -@deffnx {OSPF Command} {default-information originate metric <0-16777214>} {} -@deffnx {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2)} {} -@deffnx {OSPF Command} {default-information originate metric <0-16777214> metric-type (1|2) route-map @var{word}} {} -@deffnx {OSPF Command} {default-information originate always} {} -@deffnx {OSPF Command} {default-information originate always metric <0-16777214>} {} -@deffnx {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2)} {} -@deffnx {OSPF Command} {default-information originate always metric <0-16777214> metric-type (1|2) route-map @var{word}} {} -@deffnx {OSPF Command} {no default-information originate} {} -Originate an AS-External (type-5) LSA describing a default route into -all external-routing capable areas, of the specified metric and metric -type. If the 'always' keyword is given then the default is always -advertised, even when there is no default present in the routing table. -@end deffn - -@deffn {OSPF Command} {distribute-list NAME out (kernel|connected|static|rip|ospf} {} -@deffnx {OSPF Command} {no distribute-list NAME out (kernel|connected|static|rip|ospf} {} -@anchor{ospf distribute-list}Apply the access-list filter, NAME, to -redistributed routes of the given type before allowing the routes to -redistributed into OSPF (@pxref{OSPF redistribute}). -@end deffn - -@deffn {OSPF Command} {default-metric <0-16777214>} {} -@deffnx {OSPF Command} {no default-metric} {} -@end deffn - -@deffn {OSPF Command} {distance <1-255>} {} -@deffnx {OSPF Command} {no distance <1-255>} {} -@end deffn - -@deffn {OSPF Command} {distance ospf (intra-area|inter-area|external) <1-255>} {} -@deffnx {OSPF Command} {no distance ospf} {} -@end deffn - -@deffn {Command} {router zebra} {} -@deffnx {Command} {no router zebra} {} -@end deffn - -@node Showing OSPF information -@section Showing OSPF information - -@deffn {Command} {show ip ospf} {} -@anchor{show ip ospf}Show information on a variety of general OSPF and -area state and configuration information. -@end deffn - -@deffn {Command} {show ip ospf interface [INTERFACE]} {} -Show state and configuration of OSPF the specified interface, or all -interfaces if no interface is given. -@end deffn - -@deffn {Command} {show ip ospf neighbor} {} -@deffnx {Command} {show ip ospf neighbor INTERFACE} {} -@deffnx {Command} {show ip ospf neighbor detail} {} -@deffnx {Command} {show ip ospf neighbor INTERFACE detail} {} -@end deffn - -@deffn {Command} {show ip ospf database} {} -@end deffn - -@deffn {Command} {show ip ospf database (asbr-summary|external|network|router|summary)} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id}} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) @var{link-state-id} self-originate} {} -@deffnx {Command} {show ip ospf database (asbr-summary|external|network|router|summary) self-originate} {} -@end deffn - -@deffn {Command} {show ip ospf database max-age} {} -@end deffn - -@deffn {Command} {show ip ospf database self-originate} {} -@end deffn - -@deffn {Command} {show ip ospf route} {} -Show the OSPF routing table, as determined by the most recent SPF calculation. -@end deffn - -@node Opaque LSA -@section Opaque LSA - -@deffn {OSPF Command} {ospf opaque-lsa} {} -@deffnx {OSPF Command} {capability opaque} {} -@deffnx {OSPF Command} {no ospf opaque-lsa} {} -@deffnx {OSPF Command} {no capability opaque} {} -@command{ospfd} support Opaque LSA (RFC2370) as fondment for MPLS Traffic Engineering LSA. Prior to used MPLS TE, opaque-lsa must be enable in the configuration file. Alternate command could be "mpls-te on" (@ref{OSPF Traffic Engineering}). -@end deffn - -@deffn {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external)} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id}} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id} adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) adv-router @var{adv-router}} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) @var{link-state-id} self-originate} {} -@deffnx {Command} {show ip ospf database (opaque-link|opaque-area|opaque-external) self-originate} {} -Show Opaque LSA from the database. -@end deffn - -@node OSPF Traffic Engineering -@section Traffic Engineering - -@deffn {OSPF Command} {mpls-te on} {} -@deffnx {OSPF Command} {no mpls-te} {} -Enable Traffic Engineering LSA flooding. -@end deffn - -@deffn {OSPF Command} {mpls-te router-address } {} -@deffnx {OSPF Command} {no mpls-te} {} -Configure stable IP address for MPLS-TE. This IP address is then advertise in Opaque LSA Type-10 TLV=1 (TE) -option 1 (Router-Address). -@end deffn - -@deffn {OSPF Command} {mpls-te inter-as area |as} {} -@deffnx {OSPF Command} {no mpls-te inter-as} {} -Enable RFC5392 suuport - Inter-AS TE v2 - to flood Traffic Engineering parameters of Inter-AS link. -2 modes are supported: AREA and AS; LSA are flood in AREA with Opaque Type-10, -respectively in AS with Opaque Type-11. In all case, Opaque-LSA TLV=6. -@end deffn - -@deffn {Command} {show ip ospf mpls-te interface} {} -@deffnx {Command} {show ip ospf mpls-te interface @var{interface}} {} -Show MPLS Traffic Engineering parameters for all or specified interface. -@end deffn - -@deffn {Command} {show ip ospf mpls-te router} {} -Show Traffic Engineering router parameters. -@end deffn - -@node Router Information -@section Router Information - -@deffn {OSPF Command} {router-info [as | area ]} {} -@deffnx {OSPF Command} {no router-info} {} -Enable Router Information (RFC4970) LSA advertisement with AS scope (default) or Area scope flooding -when area is specified. -@end deffn - -@deffn {OSPF Command} {pce address } {} -@deffnx {OSPF Command} {no pce address} {} -@deffnx {OSPF Command} {pce domain as <0-65535>} {} -@deffnx {OSPF Command} {no pce domain as <0-65535>} {} -@deffnx {OSPF Command} {pce neighbor as <0-65535>} {} -@deffnx {OSPF Command} {no pce neighbor as <0-65535>} {} -@deffnx {OSPF Command} {pce flag BITPATTERN} {} -@deffnx {OSPF Command} {no pce flag} {} -@deffnx {OSPF Command} {pce scope BITPATTERN} {} -@deffnx {OSPF Command} {no pce scope} {} -The commands are conform to RFC 5088 and allow OSPF router announce Path Compuatation Elemenent (PCE) capabilities -through the Router Information (RI) LSA. Router Information must be enable prior to this. The command set/unset -respectively the PCE IP adress, Autonomous System (AS) numbers of controlled domains, neighbor ASs, flag and scope. -For flag and scope, please refer to RFC5088 for the BITPATTERN recognition. Multiple 'pce neighbor' command could -be specified in order to specify all PCE neighbours. -@end deffn - -@deffn {Command} {show ip ospf router-info} {} -Show Router Capabilities flag. -@end deffn -@deffn {Command} {show ip ospf router-info pce} {} -Show Router Capabilities PCE parameters. -@end deffn - -@node Debugging OSPF -@section Debugging OSPF - -@deffn {Command} {debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} -@deffnx {Command} {no debug ospf packet (hello|dd|ls-request|ls-update|ls-ack|all) (send|recv) [detail]} {} -Dump Packet for debugging -@end deffn - -@deffn {Command} {debug ospf ism} {} -@deffnx {Command} {debug ospf ism (status|events|timers)} {} -@deffnx {Command} {no debug ospf ism} {} -@deffnx {Command} {no debug ospf ism (status|events|timers)} {} -Show debug information of Interface State Machine -@end deffn - -@deffn {Command} {debug ospf nsm} {} -@deffnx {Command} {debug ospf nsm (status|events|timers)} {} -@deffnx {Command} {no debug ospf nsm} {} -@deffnx {Command} {no debug ospf nsm (status|events|timers)} {} -Show debug information of Network State Machine -@end deffn - -@deffn {Command} {debug ospf event} {} -@deffnx {Command} {no debug ospf event} {} -Show debug information of OSPF event -@end deffn - -@deffn {Command} {debug ospf nssa} {} -@deffnx {Command} {no debug ospf nssa} {} -Show debug information about Not So Stub Area -@end deffn - -@deffn {Command} {debug ospf lsa} {} -@deffnx {Command} {debug ospf lsa (generate|flooding|refresh)} {} -@deffnx {Command} {no debug ospf lsa} {} -@deffnx {Command} {no debug ospf lsa (generate|flooding|refresh)} {} -Show debug detail of Link State messages -@end deffn - -@deffn {Command} {debug ospf te} {} -@deffnx {Command} {no debug ospf te} {} -Show debug information about Traffic Engineering LSA -@end deffn - -@deffn {Command} {debug ospf zebra} {} -@deffnx {Command} {debug ospf zebra (interface|redistribute)} {} -@deffnx {Command} {no debug ospf zebra} {} -@deffnx {Command} {no debug ospf zebra (interface|redistribute)} {} -Show debug information of ZEBRA API -@end deffn - -@deffn {Command} {show debugging ospf} {} -@end deffn - -@node OSPF Configuration Examples -@section OSPF Configuration Examples -A simple example, with MD5 authentication enabled: - -@example -@group -! -interface bge0 - ip ospf authentication message-digest - ip ospf message-digest-key 1 md5 ABCDEFGHIJK -! -router ospf - network 192.168.0.0/16 area 0.0.0.1 - area 0.0.0.1 authentication message-digest -@end group -@end example - -An @acronym{ABR} router, with MD5 authentication and performing summarisation -of networks between the areas: - -@example -@group -! -password ABCDEF -log file /var/log/frr/ospfd.log -service advanced-vty -! -interface eth0 - ip ospf authentication message-digest - ip ospf message-digest-key 1 md5 ABCDEFGHIJK -! -interface ppp0 -! -interface br0 - ip ospf authentication message-digest - ip ospf message-digest-key 2 md5 XYZ12345 -! -router ospf - ospf router-id 192.168.0.1 - redistribute connected - passive interface ppp0 - network 192.168.0.0/24 area 0.0.0.0 - network 10.0.0.0/16 area 0.0.0.0 - network 192.168.1.0/24 area 0.0.0.1 - area 0.0.0.0 authentication message-digest - area 0.0.0.0 range 10.0.0.0/16 - area 0.0.0.0 range 192.168.0.0/24 - area 0.0.0.1 authentication message-digest - area 0.0.0.1 range 10.2.0.0/16 -! -@end group -@end example - -A Traffic Engineering configuration, with Inter-ASv2 support. - - - First, the 'zebra.conf' part: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/zebra.log -! -interface eth0 - ip address 198.168.1.1/24 - link-params - enable - admin-grp 0xa1 - metric 100 - max-bw 1.25e+07 - max-rsv-bw 1.25e+06 - unrsv-bw 0 1.25e+06 - unrsv-bw 1 1.25e+06 - unrsv-bw 2 1.25e+06 - unrsv-bw 3 1.25e+06 - unrsv-bw 4 1.25e+06 - unrsv-bw 5 1.25e+06 - unrsv-bw 6 1.25e+06 - unrsv-bw 7 1.25e+06 -! -interface eth1 - ip address 192.168.2.1/24 - link-params - enable - metric 10 - max-bw 1.25e+07 - max-rsv-bw 1.25e+06 - unrsv-bw 0 1.25e+06 - unrsv-bw 1 1.25e+06 - unrsv-bw 2 1.25e+06 - unrsv-bw 3 1.25e+06 - unrsv-bw 4 1.25e+06 - unrsv-bw 5 1.25e+06 - unrsv-bw 6 1.25e+06 - unrsv-bw 7 1.25e+06 - neighbor 192.168.2.2 as 65000 -@end group -@end example - - - Then the 'ospfd.conf' itself: - -@example -@group -hostname HOSTNAME -password PASSWORD -log file /var/log/ospfd.log -! -! -interface eth0 - ip ospf hello-interval 60 - ip ospf dead-interval 240 -! -interface eth1 - ip ospf hello-interval 60 - ip ospf dead-interval 240 -! -! -router ospf - ospf router-id 192.168.1.1 - network 192.168.0.0/16 area 1 - ospf opaque-lsa - mpls-te - mpls-te router-address 192.168.1.1 - mpls-te inter-as area 1 -! -line vty -@end group -@end example - -A router information example with PCE advsertisement: - -@example -@group -! -router ospf - ospf router-id 192.168.1.1 - network 192.168.0.0/16 area 1 - capability opaque - mpls-te - mpls-te router-address 192.168.1.1 - router-info area 0.0.0.1 - pce address 192.168.1.1 - pce flag 0x80 - pce domain as 65400 - pce neighbor as 65500 - pce neighbor as 65200 - pce scope 0x80 -! -@end group -@end example diff --git a/doc/pimd.texi b/doc/pimd.texi deleted file mode 100644 index 30e85afbb0..0000000000 --- a/doc/pimd.texi +++ /dev/null @@ -1,366 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. -@node PIM -@chapter PIM - -PIM -- Protocol Independent Multicast - -@command{pimd} supports pim-sm as well as igmp v2 and v3. pim is -vrf aware and can work within the context of vrf's in order to -do S,G mrouting. - -@menu -* Starting and Stopping pimd:: -* PIM Configuration:: -* PIM Interface Configuration:: -* PIM Multicast RIB insertion:: -* Show PIM Information:: -* PIM Debug Commands:: -@end menu - -@node Starting and Stopping pimd -@section Starting and Stopping pimd - -The default configuration file name of @command{pimd}'s is -@file{pimd.conf}. When invocation @command{pimd} searches directory -@value{INSTALL_PREFIX_ETC}. If @file{pimd.conf} is not there -then next search current directory. - -@command{pimd} requires zebra for proper operation. Additionally -@command{pimd} depends on routing properly setup and working -in the network that it is working on. - -@example -@group -# zebra -d -# pimd -d -@end group -@end example - -Please note that @command{zebra} must be invoked before @command{pimd}. - -To stop @command{pimd}. Please use @command{kill `cat -/var/run/pimd.pid`}. Certain signals have special meanings to @command{pimd}. - -@table @samp -@item SIGUSR1 -Rotate @command{pimd} logfile. -@item SIGINT -@itemx SIGTERM -@command{pimd} sweeps all installed PIM mroutes then terminates properly. -@end table - -@command{pimd} invocation options. Common options that can be specified -(@pxref{Common Invocation Options}). - -@node PIM Configuration - -@deffn Command {ip pim rp A.B.C.D A.B.C.D/M} {} -In order to use pim, it is necessary to configure a RP for join -messages to be sent to. Currently the only methodology to -do this is via static rp commands. All routers in the -pim network must agree on these values. The first ip address -is the RP's address and the second value is the matching -prefix of group ranges covered. This command is vrf aware, -to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim spt-switchover infinity-and-beyond} {} -On the last hop router if it is desired to not switch over -to the SPT tree. Configure this command. This command is -vrf aware, to configure for a vrf, enter the vrf submode. -#end deffn - -@deffn Comand {ip pim ecmp} {} -If pim has the a choice of ECMP nexthops for a particular -RPF, pim will cause S,G flows to be spread out amongst -the nexthops. If this command is not specified then -the first nexthop found will be used. This command -is vrf aware, to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim ecmp rebalance} {} -If pim is using ECMP and an interface goes down, cause -pim to rebalance all S,G flows aross the remaining -nexthops. If this command is not configured pim only -modifies those S,G flows that were using the interface -that went down. This command is vrf aware, to configure -for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim join-prune-interval (60-600)} {} -Modify the join/prune interval that pim uses to the -new value. Time is specified in seconds. This command -is vrf aware, to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim keep-alive-timer (31-60000)} {} -Modify the time out value for a S,G flow from 31-60000 -seconds. 31 seconds is choosen for a lower bound -because some hardware platforms cannot see data flowing -in better than 30 second chunks. This comand is vrf -aware, to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim packets (1-100)} {} -When processing packets from a neighbor process the -number of packets incoming at one time before moving -on to the next task. The default value is 3 packets. -This command is only useful at scale when you can -possibly have a large number of pim control packets -flowing. This command is vrf aware, to configure for -a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim register-suppress-time (5-60000)} {} -Modify the time that pim will register suppress a FHR -will send register notifications to the kernel. This command -is vrf aware, to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim send-v6-secondary} {} -When sending pim hello packets tell pim to send -any v6 secondary addresses on the interface. This -information is used to allow pim to use v6 nexthops -in it's decision for RPF lookup. This command -is vrf aware, to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip pim ssm prefix-list WORD} {} -Specify a range of group addresses via a prefix-list -that forces pim to never do SM over. This command -is vrf aware, to configure for a vrf, enter the vrf submode. -@end deffn - -@deffn Command {ip multicast rpf-lookup-mode WORD} {} -Modify how PIM does RPF lookups in the zebra routing table. -You can use these choices: -@table @lookup_modes -@item longer-prefix -Lookup the RPF in both tables using the longer prefix as a match -@item lower-distance -Lookup the RPF in both tables using the lower distance as a match -@item mrib-only -Lookup in the Multicast RIB only -@item mrib-then-urib -Lookup in the Multicast RIB then the Unicast Rib, returning first found. -This is the default value for lookup if this command is not entered -@item urib-only -Lookup in the Unicast Rib only. -@end table -@end deffn - -@node PIM Interface Configuration -@section PIM Interface Configuration - -PIM interface commands allow you to configure an -interface as either a Receiver or a interface -that you would like to form pim neighbors on. If the -interface is in a vrf, enter the interface command with -the vrf keyword at the end. - -@deffn {PIM Interface Command] {ip pim bfd} {} -Turns on BFD support for PIM for this interface. -@end deffn - -@deffn {PIM Interface Command} {ip pim drpriority (1-4294967295)} {} -Set the DR Priority for the interface. This command is useful -to allow the user to influence what node becomes the DR for a -lan segment. -@end deffn - -@deffn {PIM Interface Command} {ip pim hello (1-180) (1-180)} {} -Set the pim hello and hold interval for a interface. -@end deffn - -@deffn {PIM Interface Command} {ip pim sm} {} -Tell pim that we would like to use this interface to form -pim neighbors over. Please note we will *not* accept -igmp reports over this interface with this command. -@end deffn - -@deffn {PIM Interface Command} {ip igmp} {} -Tell pim to receive IGMP reports and Query on this -interface. The default version is v3. This command -is useful on the LHR. -@end deffn - -@deffn {PIM Interface Command} {ip igmp query-interval (1-1800)} {} -Set the IGMP query interval that PIM will use. -@end deffn - -@deffn {PIM Interface Command} {ip igmp query-max-response-time (10-250)} {} -Set the IGMP query response timeout value. If an report is not returned -in the specified time we will assume the S,G or *,G has timed out. -@end deffn - -@deffn {PIM Interface Command} {ip igmp version (2-3)} {} -Set the IGMP version used on this interface. The default value -is 3. -@end deffn - -@deffn {PIM Interface Command} {ip multicat boundary oil WORD} {} -Set a pim multicast boundary, based upon the WORD prefix-list. If -a pim join or IGMP report is received on this interface and the Group -is denyed by the prefix-list, PIM will ignore the join or report. -@end deffn - -@node PIM Multicast RIB insertion:: -@section PIM Multicast RIB insertion:: - -In order to influence Multicast RPF lookup, it is possible to insert -into zebra routes for the Multicast RIB. These routes are only -used for RPF lookup and will not be used by zebra for insertion -into the kernel *or* for normal rib processing. As such it is -possible to create weird states with these commands. Use with -caution. Most of the time this will not be necessary. - -@deffn {PIM Multicast RIB insertion} {ip mroute A.B.C.D/M A.B.C.D (1-255)} {} -Insert into the Multicast Rib Route A.B.C.D/M with specified nexthop. The distance can be specified as well if desired. -@end deffn - -@deffn {PIM Multicast RIB insertion} {ip mroute A.B.C.D/M INTERFACE (1-255)} {} -Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE. -The distance can be specified as well if desired. -@end deffn - -@node Show PIM Information:: -@section Show PIM Information - -All PIM show commands are vrf aware and typically allow you to insert -a specified vrf command if information is desired about a specific vrf. -If no vrf is specified then the default vrf is assumed. Finally -the special keyword 'all' allows you to look at all vrfs for the command. -Naming a vrf 'all' will cause great confusion. - -@deffn {Show PIM Information} {show ip multicast} -Display various information about the interfaces used in this pim -instance. -@end deffn - -@deffn {Show PIM Information} {show ip mroute} -Display information about installed into the kernel S,G mroutes. -@end deffn - -@deffn {Show PIM Information} {show ip mroute count} -Display information about installed into the kernel S,G mroutes -and in addition display data about packet flow for the mroutes. -@end deffn - -@deffn {Show PIM Information} {show ip pim assert} -Display information about asserts in the PIM system for S,G mroutes. -@end deffn - -@deffn {Show PIM Information} {show ip pim assert-internal} -Display internal assert state for S,G mroutes -@end deffn - -@deffn {Show PIM Information} {show ip pim assert-metric} -Display metric information about assert state for S,G mroutes -@end deffn - -@deffn {Show PIM Information} {show ip pim assert-winner-metric} -Display winner metric for assert state for S,G mroutes -@end deffn - -@deffn {Show PIM Information} {show ip pim group-type} -Display SSM group ranges -@end deffn - -@deffn {Show PIM Information} {show ip pim interface} -Display information about interfaces PIM is using. -@end deffn - -@deffn {Show PIM Information} {show ip pim join} -Display information about PIM joins received. -@end deffn - -@deffn {Show PIM Information} {show ip pim local-membership} {} -Display information about PIM interface local-membership -@end deffn - -@deffn {Show PIM Information} {show ip pim neighbor} {} -Display information about PIM neighbors -@end deffn - -@deffn {Show PIM Information} {show ip pim nexthop} {} -Display information about pim nexthops that are being -used -@end deffn - -@deffn {Show PIM Information} {show ip pim nexthop-lookup} {} -Display information about a S,G pair and how the RPF would -be choosen. This is especially useful if there are ECMP's -available from the RPF lookup. -@end deffn - -@deffn {Show PIM Information} {show ip pim rp-info} {} -Display information about RP's that are configured on -this router -@end deffn - -@deffn {Show PIM Information} {show ip pim rpf} {} -Display information about currently being used S,G's -and their RPF lookup information. Additionally display -some statistics about what has been happening on the -router -@end deffn - -@deffn {show PIM Information} {show ip pim secondary} {} -Display information about an interface and all the -secondary addresses associated with it -@end deffn - -@deffn {show PIM Information} {show ip pim state} {} -Display information about known S,G's and incoming -interface as well as the OIL and how they were choosen -@end deffn - -@deffn {show PIM Information} {show ip pim upstream} {} -Display upstream information about a S,G mroute -@end deffn - -@deffn {show PIM Information} {show ip pim upstream-join-desired} {} -Display upstream information for S,G's and if we desire to -join the mcast tree -@end deffn - -@deffn {show PIM Information} {show ip pim upstream-rpf} {} -Display upstream information for S,G's and the RPF data -associated with them -@end deffn - -@deffn {show PIM Information} {show ip rpf} {} -Display the multicast RIB created in zebra -@end deffn - -@node PIM Debug Commands -@section PIM Debug Commands - -The debugging subsystem for PIM behaves in accordance with how FRR handles debugging. You can specify debugging at the enable cli mode as well as the configure cli mode. If you specify debug commands in the configuration cli mode, the debug commands can be persistent across restarts of the FRR pimd if the config was written out. - -@deffn {PIM Debug Commands} {debug pim events} -This turns on debugging for PIM system events. Especially timers. -@end deffn - -@deffn {PIM Debug Commands} {debug pim nht} -This turns on debugging for PIM nexthop tracking. It will display information about RPF lookups and information about when a nexthop changes. -@end deffn - -@deffn {PIM Debug Commands} {debug pim packet-dump} -This turns on an extraordinary amount of data. Each pim packet sent and received is dumped for debugging purposes. This should be considered a developer only command -@end deffn - -@deffn {PIM Debug Commands} {debug pim packets} -This turns on information about packet generation for sending and about packet handling from a received packet -@end deffn - -@deffn {PIM Debug Commands} {debug pim trace} -This traces pim code and how it is running. -@end deffn - -@deffn {PIM Debug Commands} {debug pim zebra} -This gathers data about events from zebra that come up through the zapi -@end deffn diff --git a/doc/routemap.texi b/doc/routemap.texi deleted file mode 100644 index 3e683f44d1..0000000000 --- a/doc/routemap.texi +++ /dev/null @@ -1,285 +0,0 @@ -@node Route Map -@chapter Route Map - -Route maps provide a means to both filter and/or apply actions to -route, hence allowing policy to be applied to routes. - -@menu -* Route Map Command:: -* Route Map Match Command:: -* Route Map Set Command:: -* Route Map Call Command:: -* Route Map Exit Action Command:: -* Route Map Examples:: -@end menu - -Route-maps are an ordered list of route-map entries. Each entry may -specify up to four distincts sets of clauses: - -@table @samp -@item Matching Policy - -This specifies the policy implied if the @samp{Matching Conditions} are -met or not met, and which actions of the route-map are to be taken, if -any. The two possibilities are: - -@itemize @minus -@item -@samp{permit}: If the entry matches, then carry out the @samp{Set -Actions}. Then finish processing the route-map, permitting the route, -unless an @samp{Exit Action} indicates otherwise. - -@item -@samp{deny}: If the entry matches, then finish processing the route-map and -deny the route (return @samp{deny}). -@end itemize - -The @samp{Matching Policy} is specified as part of the command which -defines the ordered entry in the route-map. See below. - -@item Matching Conditions - -A route-map entry may, optionally, specify one or more conditions which -must be matched if the entry is to be considered further, as governed -by the Match Policy. If a route-map entry does not explicitely specify -any matching conditions, then it always matches. - -@item Set Actions - -A route-map entry may, optionally, specify one or more @samp{Set -Actions} to set or modify attributes of the route. - -@item Call Action - -Call to another route-map, after any @samp{Set Actions} have been -carried out. If the route-map called returns @samp{deny} then -processing of the route-map finishes and the route is denied, -regardless of the @samp{Matching Policy} or the @samp{Exit Policy}. If -the called route-map returns @samp{permit}, then @samp{Matching Policy} -and @samp{Exit Policy} govern further behaviour, as normal. - -@item Exit Policy - -An entry may, optionally, specify an alternative @samp{Exit Policy} to -take if the entry matched, rather than the normal policy of exiting the -route-map and permitting the route. The two possibilities are: - -@itemize @minus -@item -@samp{next}: Continue on with processing of the route-map entries. - -@item -@samp{goto N}: Jump ahead to the first route-map entry whose order in -the route-map is >= N. Jumping to a previous entry is not permitted. -@end itemize -@end table - -The default action of a route-map, if no entries match, is to deny. -I.e. a route-map essentially has as its last entry an empty @samp{deny} -entry, which matches all routes. To change this behaviour, one must -specify an empty @samp{permit} entry as the last entry in the route-map. - -To summarise the above: - -@multitable {permit} {action} {No Match} -@headitem @tab Match @tab No Match -@item @emph{Permit} @tab action @tab cont -@item @emph{Deny} @tab deny @tab cont -@end multitable - -@table @samp - -@item action -@itemize @minus -@item -Apply @emph{set} statements - -@item -If @emph{call} is present, call given route-map. If that returns a @samp{deny}, finish -processing and return @samp{deny}. - -@item -If @samp{Exit Policy} is @emph{next}, goto next route-map entry - -@item -If @samp{Exit Policy} is @emph{goto}, goto first entry whose order in the list -is >= the given order. - -@item -Finish processing the route-map and permit the route. -@end itemize - -@item deny -@itemize @minus -@item -The route is denied by the route-map (return @samp{deny}). -@end itemize - -@item cont -@itemize @minus -@item -goto next route-map entry -@end itemize -@end table - -@node Route Map Command -@section Route Map Command - -@deffn {Command} {route-map @var{route-map-name} (permit|deny) @var{order}} {} - -Configure the @var{order}'th entry in @var{route-map-name} with -@samp{Match Policy} of either @emph{permit} or @emph{deny}. - -@end deffn - -@node Route Map Match Command -@section Route Map Match Command - -@deffn {Route-map Command} {match ip address @var{access_list}} {} -Matches the specified @var{access_list} -@end deffn - -@deffn {Route-map Command} {match ip address @var{prefix-list}} {} -Matches the specified @var{prefix-list} -@end deffn - -@deffn {Route-map Command} {match ip address prefix-len @var{0-32}} {} -Matches the specified @var{prefix-len}. This is a Zebra specific command. -@end deffn - -@deffn {Route-map Command} {match ipv6 address @var{access_list}} {} -Matches the specified @var{access_list} -@end deffn - -@deffn {Route-map Command} {match ipv6 address @var{prefix-list}} {} -Matches the specified @var{prefix-list} -@end deffn - -@deffn {Route-map Command} {match ipv6 address prefix-len @var{0-128}} {} -Matches the specified @var{prefix-len}. This is a Zebra specific command. -@end deffn - -@deffn {Route-map Command} {match ip next-hop @var{ipv4_addr}} {} -Matches the specified @var{ipv4_addr}. -@end deffn - -@deffn {Route-map Command} {match aspath @var{as_path}} {} -Matches the specified @var{as_path}. -@end deffn - -@deffn {Route-map Command} {match metric @var{metric}} {} -Matches the specified @var{metric}. -@end deffn - -@deffn {Route-map Command} {match tag @var{tag}} {} -Matches the specified tag value associated with the route. -This tag value can be in the range of (1-4294967295). -@end deffn - -@deffn {Route-map Command} {match local-preference @var{metric}} {} -Matches the specified @var{local-preference}. -@end deffn - -@deffn {Route-map Command} {match community @var{community_list}} {} -Matches the specified @var{community_list} -@end deffn - -@deffn {Route-map Command} {match peer @var{ipv4_addr}} {} -This is a BGP specific match command. Matches the peer ip address -if the neighbor was specified in this manner. -@end deffn - -@deffn {Route-map Command} {match peer @var{ipv6_addr}} {} -This is a BGP specific match command. Matches the peer ipv6 -address if the neighbor was specified in this manner. -@end deffn - -@deffn {Route-map Command} {match peer @var{interface_name}} {} -This is a BGP specific match command. Matches the peer -interface name specified if the neighbor was specified -in this manner. -@end deffn - -@node Route Map Set Command -@section Route Map Set Command - -@deffn {Route-map Command} {set tag @var{tag}} {} -Set a tag on the matched route. This tag value can be from -(1-4294967295). Additionally if you have compiled with -the --enable-realms configure option. Tag values from (1-255) -are sent to the linux kernel as a realm value. Then route -policy can be applied. See the tc man page. -@end deffn - -@deffn {Route-map Command} {set ip next-hop @var{ipv4_address}} {} -Set the BGP nexthop address. -@end deffn - -@deffn {Route-map Command} {set local-preference @var{local_pref}} {} -Set the BGP local preference to @var{local_pref}. -@end deffn - -@deffn {Route-map Command} {set weight @var{weight}} {} -Set the route's weight. -@end deffn - -@deffn {Route-map Command} {set metric @var{metric}} {} -@anchor{routemap set metric} -Set the BGP attribute MED. -@end deffn - -@deffn {Route-map Command} {set as-path prepend @var{as_path}} {} -Set the BGP AS path to prepend. -@end deffn - -@deffn {Route-map Command} {set community @var{community}} {} -Set the BGP community attribute. -@end deffn - -@deffn {Route-map Command} {set ipv6 next-hop global @var{ipv6_address}} {} -Set the BGP-4+ global IPv6 nexthop address. -@end deffn - -@deffn {Route-map Command} {set ipv6 next-hop local @var{ipv6_address}} {} -Set the BGP-4+ link local IPv6 nexthop address. -@end deffn - -@node Route Map Call Command -@section Route Map Call Command - -@deffn {Route-map Command} {call @var{name}} {} -Call route-map @var{name}. If it returns deny, deny the route and -finish processing the route-map. -@end deffn - -@node Route Map Exit Action Command -@section Route Map Exit Action Command - -@deffn {Route-map Command} {on-match next} {} -@deffnx {Route-map Command} {continue} {} -Proceed on to the next entry in the route-map. -@end deffn - -@deffn {Route-map Command} {on-match goto @var{N}} {} -@deffnx {Route-map Command} {continue @var{N}} {} -Proceed processing the route-map at the first entry whose order is >= N -@end deffn - -@node Route Map Examples -@section Route Map Examples - -A simple example of a route-map: - -@example -@group -route-map test permit 10 - match ip address 10 - set local-preference 200 -@end group -@end example - -This means that if a route matches ip access-list number 10 it's -local-preference value is set to 200. - -See @ref{BGP Configuration Examples} for examples of more sophisticated -useage of route-maps, including of the @samp{call} action. diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index d72d8a8665..eba1caea61 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -1166,43 +1166,75 @@ A Traffic Engineering configuration, with Inter-ASv2 support. First, the 'zebra.conf' part::: - hostname HOSTNAME - password PASSWORD - log file /var/log/zebra.log - ! interface eth0 ip address 198.168.1.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab + link-params + enable + admin-grp 0xa1 + metric 100 + max-bw 1.25e+07 + max-rsv-bw 1.25e+06 + unrsv-bw 0 1.25e+06 + unrsv-bw 1 1.25e+06 + unrsv-bw 2 1.25e+06 + unrsv-bw 3 1.25e+06 + unrsv-bw 4 1.25e+06 + unrsv-bw 5 1.25e+06 + unrsv-bw 6 1.25e+06 + unrsv-bw 7 1.25e+06 ! interface eth1 ip address 192.168.2.1/24 - mpls-te on - mpls-te link metric 10 - mpls-te link max-bw 1.25e+06 - mpls-te link max-rsv-bw 1.25e+06 - mpls-te link unrsv-bw 0 1.25e+06 - mpls-te link unrsv-bw 1 1.25e+06 - mpls-te link unrsv-bw 2 1.25e+06 - mpls-te link unrsv-bw 3 1.25e+06 - mpls-te link unrsv-bw 4 1.25e+06 - mpls-te link unrsv-bw 5 1.25e+06 - mpls-te link unrsv-bw 6 1.25e+06 - mpls-te link unrsv-bw 7 1.25e+06 - mpls-te link rsc-clsclr 0xab - mpls-te neighbor 192.168.2.2 as 65000 - + link-params + enable + metric 10 + max-bw 1.25e+07 + max-rsv-bw 1.25e+06 + unrsv-bw 0 1.25e+06 + unrsv-bw 1 1.25e+06 + unrsv-bw 2 1.25e+06 + unrsv-bw 3 1.25e+06 + unrsv-bw 4 1.25e+06 + unrsv-bw 5 1.25e+06 + unrsv-bw 6 1.25e+06 + unrsv-bw 7 1.25e+06 + neighbor 192.168.2.2 as 65000 + hostname HOSTNAME + password PASSWORD + log file /var/log/zebra.log + ! + interface eth0 + ip address 198.168.1.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + ! + interface eth1 + ip address 192.168.2.1/24 + mpls-te on + mpls-te link metric 10 + mpls-te link max-bw 1.25e+06 + mpls-te link max-rsv-bw 1.25e+06 + mpls-te link unrsv-bw 0 1.25e+06 + mpls-te link unrsv-bw 1 1.25e+06 + mpls-te link unrsv-bw 2 1.25e+06 + mpls-te link unrsv-bw 3 1.25e+06 + mpls-te link unrsv-bw 4 1.25e+06 + mpls-te link unrsv-bw 5 1.25e+06 + mpls-te link unrsv-bw 6 1.25e+06 + mpls-te link unrsv-bw 7 1.25e+06 + mpls-te link rsc-clsclr 0xab + mpls-te neighbor 192.168.2.2 as 65000 Then the 'ospfd.conf' itself::: diff --git a/doc/vnc.texi b/doc/vnc.texi deleted file mode 100644 index 6193d3c906..0000000000 --- a/doc/vnc.texi +++ /dev/null @@ -1,1593 +0,0 @@ -@c -*-texinfo-*- -@c This is part of the Frr Manual. -@c @value{COPYRIGHT_STR} -@c See file frr.texi for copying conditions. - -@node VNC and VNC-GW -@chapter VNC and VNC-GW -This chapter describes how to use -Virtual Network Control (@acronym{VNC}) services, -including Network Virtualization Authority (@acronym{NVA}) and -VNC Gateway (@acronym{VNC-GW}) functions. -Background information on NVAs, -Network Virtualization Edges (@acronym{NVE}s), underlay networks (@acronym{UN}s), -and virtual networks (@acronym{VN}s) is available from the -@url{https://datatracker.ietf.org/wg/nvo3,IETF Network Virtualization Overlays (@acronym{NVO3}) Working Group}. -VNC Gateways (@acronym{VNC-GW}s) support the import/export of routing -information between VNC and customer edge routers (@acronym{CE}s) -operating within a VN. Both IP/Layer 3 (L3) VNs, and IP with -Ethernet/Layer 2 (L2) VNs are supported. - -BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN -information between NVAs. BGP based IP VPN support is defined in -@cite{RFC4364, BGP/MPLS IP Virtual Private Networks (VPNs)}, and -@cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for -IPv6 VPN }. Encapsulation information is provided via -the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP -Encapsulation Subsequent Address Family Identifier (SAFI) and the BGP -Tunnel Encapsulation Attribute}, are supported. - -The protocol that is used to communicate routing and Ethernet / Layer 2 -(L2) forwarding information between NVAs and NVEs is referred to as the -Remote Forwarder Protocol (RFP). @code{OpenFlow} is an example -RFP. Specific RFP implementations may choose to implement either a -@code{hard-state} or @code{soft-state} prefix and address registration -model. To support a @code{soft-state} refresh model, a @var{lifetime} -in seconds is associated with all registrations and responses. - -The chapter also provides sample configurations for basic example scenarios. - -@menu -* Configuring VNC Services:: -* Manual Address Control:: -* Other VNC-Related Commands:: -* Example VNC and VNC-GW Configurations:: -* Release Notes:: -@end menu - -@node Configuring VNC Services -@section Configuring VNC - -Virtual Network Control (@acronym{VNC}) service configuration commands -appear in the @code{router bgp} section of the BGPD configuration file -(@pxref{BGP Configuration Examples}). The commands are broken down into -the following areas: - -@menu -* General VNC Configuration:: -* RFP Related Configuration:: -* VNC Defaults Configuration:: -* VNC NVE Group Configuration:: -* VNC L2 Group Configuration:: -* Configuring Redistribution of Routes from Other Routing Protocols:: -* Configuring Export of Routes to Other Routing Protocols:: -@end menu - -@code{General VNC} configuration applies to general VNC operation and is -primarily used to control the method used to advertise tunnel -information. - -@code{Remote Forwarder Protocol (RFP)} configuration relates to the -protocol used between NVAs and NVEs. - -@code{VNC Defaults} provides default parameters for registered NVEs. - -@code{VNC NVE Group} provides for configuration of a specific set of -registered NVEs and overrides default parameters. - -@code{Redistribution} and @code{Export} control VNC-GW operation, i.e., -the import/export of routing -information between VNC and customer edge routers (@acronym{CE}s) -operating within a VN. - -@node General VNC Configuration -@subsection General VNC Configuration - -@deffn {VNC} {vnc advertise-un-method encap-attr} {} -Advertise NVE underlay-network IP addresses using -the UN address sub-TLV of the Tunnel Encapsulation attribute -(@code{encap-attr}). The default is @code{encap-attr}. -@end deffn - -@node RFP Related Configuration -@subsection RFP Related Configuration - -The protocol that is used to communicate routing and Ethernet / L2 -forwarding information between NVAs and NVEs is referred to as the -Remote Forwarder Protocol (RFP). Currently, only a simple example RFP -is included in Frr. Developers may use this example as a starting -point to integrate Frr with an RFP of their choosing, e.g., -@code{OpenFlow}. The example code includes the following sample -configuration: - -@deffn {RFP} {rfp example-config-value @var{VALUE}} -This is a simple example configuration parameter included as part of the -RFP example code. @code{VALUE} must be in the range of 0 to 4294967295. -@end deffn - -@node VNC Defaults Configuration -@subsection VNC Defaults Configuration - -The VNC Defaults section allows the user to specify default values for -configuration parameters for all registered NVEs. -Default values are overridden by @ref{VNC NVE Group Configuration}. - -@deffn {VNC} {vnc defaults} {} -Enter VNC configuration mode for specifying VNC default behaviors. Use -@code{exit-vnc} to leave VNC configuration mode. @code{vnc -defaults} is optional. - -@example -vnc defaults - ... various VNC defaults -exit-vnc -@end example -@end deffn - -These are the statements that can appear between @code{vnc defaults} -and @code{exit-vnc}. - -@deffn {VNC} {rt import @var{rt-list}} {} -@deffnx {VNC} {rt export @var{rt-list}} {} -@deffnx {VNC} {rt both @var{rt-list}} {} - -Specify default route target import and export lists. @var{rt-list} is a -space-separated list of route targets, each element of which is -in one of the following forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@end itemize - -If no default import RT list is specified, then the default import RT -list is empty. -If no default export RT list is specified, then the default export RT -list is empty. - -A complete definition of these parameters is -given below (@pxref{VNC NVE Group Configuration}). - -@end deffn - -@deffn {VNC} {rd @var{route-distinguisher}} - -Specify the default route distinguisher (RD) for routes advertised via BGP -VPNs. The route distinguisher must be in one of four forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@item auto:vn:@var{two-byte-integer} -@end itemize - -If RD is specified in the defaults section, the default RD -value is @var{two-byte-autonomous-system-number=0}:@var{four-byte-integer=0}. - -A complete definition of this parameter is -given below (@pxref{VNC NVE Group Configuration}). -@end deffn - -@deffn {VNC} {l2rd @var{nve-id-value}} -Set the value used to distinguish NVEs connected to the same logical -Ethernet segment (i.e., L2VPN). - -A complete definition of this parameter is -given below (@pxref{VNC NVE Group Configuration}). -@end deffn - -@deffn {VNC} {response-lifetime @var{lifetime}|infinite} {} -Specify the default lifetime to be included in RFP -response messages sent to NVEs. - -A complete definition of this parameter is -given below (@pxref{VNC NVE Group Configuration}). - -@end deffn - -@deffn {VNC} {export bgp|zebra route-map MAP-NAME} -Specify that the named route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra no route-map} -Specify that no route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} -Specify that the named prefix-list filter should be applied to -routes being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -@end deffn - -@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} -Specify that no prefix-list filter should be applied to -routes being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {exit-vnc} {} -Exit VNC configuration mode. -@end deffn - -@c The following example @code{vnc defaults} defines a route target import-export -@c list for the route targets 1000:1 and 1000:2; a default route -@c distinguisher, 4444:10; and a default response lifetime of 500 -@c seconds. -@c -@c @example -@c vnc defaults -@c rt both 1000:1 1000:2 -@c rd 4444:10 -@c response-lifetime 500 -@c exit-vnc -@c @end example - -@node VNC NVE Group Configuration -@subsection VNC NVE Group Configuration - -A NVE Group corresponds to a specific set of NVEs. A Client NVE is -assigned to an NVE Group based on whether there is a match for either -its virtual or underlay network address against the VN and/or UN address -prefixes specified in the NVE Group definition. When an NVE Group -definition specifies both VN and UN address prefixes, then an NVE must -match both prefixes in order to be assigned to the NVE Group. In the -event that multiple NVE Groups match based on VN and/or UN addresses, -the NVE is assigned to the first NVE Group listed in the configuration. -If an NVE is not assigned to an NVE Group, its messages will be ignored. - -Configuration values specified for an NVE group apply to all -member NVEs and override configuration values specified in the VNC -Defaults section. - -@strong{At least one @code{nve-group} is mandatory for useful VNC -operation.} - -@deffn {VNC} {vnc nve-group @var{name}} {} -Enter VNC configuration mode for defining the NVE group @var{name}. -Use @code{exit} or @code{exit-vnc} to exit group configuration mode. - -@example -vnc nve-group group1 - ... configuration commands -exit-vnc -@end example -@end deffn - -@deffn {VNC} {no vnc nve-group @var{name}} {} -Delete the NVE group named @var{name}. -@end deffn - -The following statements are valid in an NVE group definition: - -@deffn {VNC} {l2rd @var{nve-id-value}} -Set the value used to distinguish NVEs connected to the same physical -Ethernet segment (i.e., at the same location)@footnote{The nve-id is -carried in the route -distinguisher. It is the second octet of the eight-octet route -distinguisher generated for Ethernet / L2 advertisements. -The first octet is a constant 0xFF, and the third through eighth -octets are set to the L2 ethernet address being advertised.} - -The nve-id subfield may be specified as either a literal value -in the range 1-255, or it may be specified as @code{auto:vn}, which -means to use the least-significant octet of the originating -NVE's VN address. -@end deffn - -@deffn {VNC} {prefix vn|un A.B.C.D/M|X:X::X:X/M} {} -@anchor{prefix} -Specify the matching prefix for this NVE group by either virtual-network address -(@code{vn}) or underlay-network address (@code{un}). Either or both virtual-network -and underlay-network prefixes may be specified. Subsequent virtual-network or -underlay-network values within a @code{vnc nve-group} @code{exit-vnc} -block override their respective previous values. - -These prefixes are used only for determining assignments of NVEs -to NVE Groups. -@end deffn - -@deffn {VNC} {rd @var{route-distinguisher}} -Specify the route distinguisher for routes advertised via BGP -VPNs. The route distinguisher must be in one of these forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@item auto:vn:@var{two-byte-integer} -@end itemize - -Routes originated by NVEs in the NVE group will use -the group's specified @var{route-distinguisher} when they are -advertised via BGP. -If the @code{auto} form is specified, it means that a matching NVE has -its RD set to -@var{rd_type=IP=1}:@var{IPv4-address=VN-address}:@var{two-byte-integer}, -for IPv4 VN addresses and -@var{rd_type=IP=1}:@var{IPv4-address=Last-four-bytes-of-VN-address}:@var{two-byte-integer}, -for IPv6 VN addresses. - -If the NVE group definition does not specify a @var{route-distinguisher}, -then the default @var{route-distinguisher} is used. -If neither a group nor a default @var{route-distinguisher} is -configured, then the advertised RD is set to -@var{two-byte-autonomous-system-number=0}:@var{four-byte-integer=0}. -@end deffn - -@deffn {VNC} {response-lifetime @var{lifetime}|infinite} {} -Specify the response lifetime, in seconds, to be included in RFP -response messages sent to NVEs. If the value -``infinite'' is given, an infinite lifetime will be used. - -Note that this parameter is not the same as the lifetime supplied by -NVEs in RFP registration messages. This parameter does not affect -the lifetime value attached to routes sent by this server via BGP. - -If the NVE group definition does not specify a @var{response-lifetime}, -the default @var{response-lifetime} will be used. -If neither a group nor a default @var{response-lifetime} is configured, -the value 3600 will be used. The maximum response lifetime is 2147483647. -@end deffn - -@deffn {VNC} {rt export @var{rt-list}} {} -@deffnx {VNC} {rt import @var{rt-list}} {} -@deffnx {VNC} {rt both @var{rt-list}} {} -Specify route target import and export lists. @var{rt-list} is a -space-separated list of route targets, each element of which is -in one of the following forms: -@itemize -@item @var{IPv4-address}:@var{two-byte-integer} -@item @var{four-byte-autonomous-system-number}:@var{two-byte-integer} -@item @var{two-byte-autonomous-system-number}:@var{four-byte-integer} -@end itemize - -The first form, @code{rt export}, specifies an @var{export rt-list}. -The @var{export rt-list} will be attached to routes originated by -NVEs in the NVE group when they are advertised via BGP. -If the NVE group definition does not specify an @var{export rt-list}, -then the default @var{export rt-list} is used. -If neither a group nor a default @var{export rt-list} is configured, -then no RT list will be sent; in turn, these routes will probably -not be processed -by receiving NVAs. - -The second form, @code{rt import} specifies an @var{import rt-list}, -which is a filter for incoming routes. -In order to be made available to NVEs in the group, -incoming BGP VPN @w{SAFI} routes must have -RT lists that have at least one route target in common with the -group's @var{import rt-list}. - -If the NVE group definition does not specify an import filter, -then the default @var{import rt-list} is used. -If neither a group nor a default @var{import rt-list} is configured, -there can be no RT intersections when receiving BGP routes and -therefore no incoming BGP routes will be processed for the group. - -The third, @code{rt both}, is a shorthand way of specifying both -lists simultaneously, and is equivalent to @code{rt export @var{rt-list}} -followed by @code{rt import @var{rt-list}}. -@end deffn - -@deffn {VNC} {export bgp|zebra route-map MAP-NAME} -Specify that the named route-map should be applied to routes -being exported to bgp or zebra. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@deffn {VNC} {export bgp|zebra no route-map} -Specify that no route-map should be applied to routes -being exported to bgp or zebra. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} -Specify that the named prefix-list filter should be applied to -routes being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} -Specify that no prefix-list filter should be applied to -routes being exported to bgp or zebra. -This paramter is used in conjunction with -@ref{Configuring Export of Routes to Other Routing Protocols}. -This item is optional. -@end deffn - -@c The following example shows two @code{vnc nve-group} definitions. The first one, -@c ``group1'', applies to the IPV4 virtual-network route prefix 172.16/16. It -@c sets the response lifetime to 200 seconds. It defines a route target -@c import-export filter for the route targets 1000:1 and 1000:2 -@c -@c The second @code{vnc nve-group} definition, ``group2'', applies to the IPV6 -@c underlay-network route prefix 10.0.2/24. It defines the same response -@c lifetime and import-export filter as ``group1''. -@c -@c @example -@c vnc nve-group group1 -@c prefix vn 172.16/16 -@c response-lifetime 200 -@c rt both 1000:1 1000:2 -@c exit-vnc -@c -@c vnc nve-group group2 -@c prefix un 10.0.2/24 -@c response-lifetime 200 -@c rt both 1000:1 1000:2 -@c exit-vnc -@c @end example - -@node VNC L2 Group Configuration -@subsection VNC L2 Group Configuration - -The route targets advertised with prefixes and addresses registered by -an NVE are determined based on the NVE's associated VNC NVE Group -Configuration, @pxref{VNC NVE Group Configuration}. Layer 2 (L2) Groups -are used to override the route targets for an NVE's Ethernet -registrations based on the Logical Network Identifier and label value. -A Logical Network Identifier is used to uniquely identify a logical -Ethernet segment and is conceptually similar to the Ethernet Segment -Identifier defined in @cite{RFC7432, BGP MPLS-Based Ethernet VPN}. Both -the Logical Network Identifier and Label are passed to VNC via RFP -prefix and address registration. - -Note that a corresponding NVE group configuration must be present, and -that other NVE associated configuration information, notably RD, is -not impacted by L2 Group Configuration. - -@deffn {VNC} {vnc l2-group @var{name}} {} -Enter VNC configuration mode for defining the L2 group @var{name}. -Use @code{exit} or @code{exit-vnc} to exit group configuration mode. - -@example -vnc l2-group group1 - ... configuration commands -exit-vnc -@end example -@end deffn - -@deffn {VNC} {no vnc l2-group @var{name}} {} -Delete the L2 group named @var{name}. -@end deffn - -The following statements are valid in a L2 group definition: - -@deffn {VNC} {logical-network-id @var{VALUE}} -Define the Logical Network Identifier with a value in the range of -0-4294967295 that identifies the logical Ethernet segment. -@end deffn - -@deffn {VNC} {labels @var{label-list}} -@deffnx {VNC} {no labels @var{label-list}} -Add or remove labels associated with the group. @var{label-list} is a -space separated list of label values in the range of 0-1048575. -@end deffn - -@deffn {VNC} {rt import @var{rt-target}} {} -@deffnx {VNC} {rt export @var{rt-target}} {} -@deffnx {VNC} {rt both @var{rt-target}} {} -Specify the route target import and export value associated with the -group. A complete definition of these parameters is given above, -@pxref{VNC NVE Group Configuration}. -@end deffn - - -@node Configuring Redistribution of Routes from Other Routing Protocols -@subsection Configuring Redistribution of Routes from Other Routing Protocols - -Routes from other protocols (including BGP) can be provided to VNC (both -for RFP and for redistribution via BGP) -from three sources: the zebra kernel routing process; -directly from the main (default) unicast BGP RIB; or directly -from a designated BGP unicast exterior routing RIB instance. - -The protocol named in the @code{vnc redistribute} command indicates -the route source: -@code{bgp-direct} routes come directly from the main (default) -unicast BGP RIB and are available for RFP and are redistributed via BGP; -@code{bgp-direct-to-nve-groups} routes come directly from a designated -BGP unicast routing RIB and are made available only to RFP; -and routes from other protocols come from the zebra kernel -routing process. -Note that the zebra process does not need to be active if -only @code{bgp-direct} or @code{bgp-direct-to-nve-groups} routes are used. - -@subsubsection @code{zebra} routes - -Routes originating from protocols other than BGP must be obtained -via the zebra routing process. -Redistribution of these routes into VNC does not support policy mechanisms -such as prefix-lists or route-maps. - -@subsubsection @code{bgp-direct} routes - -@code{bgp-direct} redistribution supports policy via -prefix lists and route-maps. This policy is applied to incoming -original unicast routes before the redistribution translations -(described below) are performed. - -Redistribution of @code{bgp-direct} routes is performed in one of three -possible modes: @code{plain}, @code{nve-group}, or @code{resolve-nve}. -The default mode is @code{plain}. -These modes indicate the kind of translations applied to routes before -they are added to the VNC RIB. - -In @code{plain} mode, the route's next hop is unchanged and the RD is set -based on the next hop. -For @code{bgp-direct} redistribution, the following translations are performed: -@itemize @bullet -@item -The VN address is set to the original unicast route's next hop address. -@item -The UN address is NOT set. (VN->UN mapping will occur via -ENCAP route or attribute, based on @code{vnc advertise-un-method} -setting, generated by the RFP registration of the actual NVE) -@item -The RD is set to as if auto:vn:0 were specified (i.e., -@var{rd_type=IP=1}:@var{IPv4-address=VN-address}:@var{two-byte-integer=0}) -@item -The RT list is included in the extended community list copied from the -original unicast route (i.e., it must be set in the original unicast route). -@end itemize - - - -In @code{nve-group} mode, routes are registered with VNC as -if they came from an NVE in the nve-group designated in the -@code{vnc redistribute nve-group} command. The following -translations are performed: - -@itemize @bullet -@item -The next hop/VN address is set to the VN prefix configured for the -redistribute nve-group. -@item -The UN address is set to the UN prefix configured for the -redistribute nve-group. -@item -The RD is set to the RD configured for the redistribute nve-group. -@item -The RT list is set to the RT list configured for the redistribute nve-group. -If @code{bgp-direct} routes are being redistributed, -any extended communities present in the original unicast route -will also be included. -@end itemize - - -In @code{resolve-nve} mode, the next hop of the original BGP route is -typically the address of an NVE connected router (CE) connected by one or -more NVEs. -Each of the connected NVEs will register, via RFP, a VNC host route -to the CE. -This mode may be though of as a mechanism to proxy RFP registrations -of BGP unicast routes on behalf of registering NVEs. - -Multiple copies of the BGP route, one per matching NVE host route, will be -added to VNC. -In other words, for a given BGP unicast route, each instance of a -RFP-registered host route to the unicast route's next hop will result -in an instance of an imported VNC route. -Each such imported VNC route will have a prefix equal to the original -BGP unicast route's prefix, and a next hop equal to the next hop of the -matching RFP-registered host route. -If there is no RFP-registered host route to the next hop of the BGP unicast -route, no corresponding VNC route will be imported. - -The following translations are applied: - -@itemize @bullet -@item -The Next Hop is set to the next hop of the NVE route (i.e., the -VN address of the NVE). - -@item -The extended community list in the new route is set to the -union of: -@itemize @minus -@item -Any extended communities in the original BGP route -@item -Any extended communities in the NVE route -@item -An added route-origin extended community with the next hop of the -original BGP route -is added to the new route. -The value of the local administrator field defaults 5226 but may -be configured by the user via the @code{roo-ec-local-admin} parameter. -@end itemize - -@item -The Tunnel Encapsulation attribute is set to the value of the Tunnel -Encapsulation attribute of the NVE route, if any. - -@end itemize - -@subsubsection @code{bgp-direct-to-nve-groups} routes - -Unicast routes from the main or a designated instance of BGP -may be redistributed to VNC as bgp-direct-to-nve-groups routes. These -routes are NOT announced via BGP, -but they are made available for local RFP lookup in response to -queries from NVEs. - -A non-main/default BGP instance is configured using the -@code{bgp multiple-instance} and @code{router bgp AS view NAME} -commands as described elsewhere in this document. - -In order for a route in the unicast BGP RIB to be made -available to a querying NVE, there must already be, available to -that NVE, an (interior) VNC route matching the next hop address -of the unicast route. -When the unicast route is provided to the NVE, its next hop -is replaced by the next hop of the corresponding -NVE. If there are multiple longest-prefix-match VNC routes, -the unicast route will be replicated for each. - -There is currently no policy (prefix-list or route-map) support -for @code{bgp-direct-to-nve-groups} routes. - -@subsubsection Redistribution Command Syntax - -@deffn {VNC} {vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} -@deffnx {VNC} {vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view @var{VIEWNAME}} {} -@deffnx {VNC} {no vnc redistribute ipv4|ipv6 bgp|bgp-direct|bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static} {} -Import (or do not import) prefixes from another routing -protocols. Specify both the address family to import (@code{ipv4} or -@code{ipv6}) and the protocol (@code{bgp}, @code{bgp-direct}, -@code{bgp-direct-to-nve-groups}, @code{connected}, -@code{kernel}, @code{ospf}, @code{rip}, or @code{static}). Repeat -this statement as needed for each combination of address family and -routing protocol. -Prefixes from protocol @code{bgp-direct} are imported from unicast BGP -in the same bgpd process. -Prefixes from all other protocols (including @code{bgp}) are imported -via the @code{zebra} kernel routing process. -@end deffn - -@deffn {VNC} {vnc redistribute mode plain|nve-group|resolve-nve} -Redistribute routes from other protocols into VNC using the -specified mode. -Not all combinations of modes and protocols are supported. -@end deffn - -@deffn {VNC} {vnc redistribute nve-group @var{group-name}} {} -@deffnx {VNC} {no vnc redistribute nve-group @var{group-name}} {} -When using @code{nve-group} mode, -assign (or do not assign) the NVE group @var{group-name} to routes -redistributed from another routing protocol. @var{group-name} -must be configured using @code{vnc nve-group}. - -The VN and UN prefixes of the nve-group must both be configured, -and each prefix must be specified as a full-length (/32 for IPv4, -/128 for IPv6) prefix. -@end deffn - -@deffn {VNC} {vnc redistribute lifetime @var{lifetime}|infinite} {} -Assign a registration lifetime, either @var{lifetime} seconds or -@code{infinite}, to prefixes redistributed from other routing -protocols as if they had been received via RFP registration messages -from an NVE. @var{lifetime} can be any integer between 1 and -4294967295, inclusive. -@end deffn - -@deffn {VNC} {vnc redistribute resolve-nve roo-ec-local-admin @var{0-65536}} -Assign a value to the local-administrator subfield used in the -Route Origin extended community that is assigned to routes exported -under the @code{resolve-nve} mode. The default value is @var{5226}. -@end deffn - -The following four @code{prefix-list} and @code{route-map} commands -may be specified in the context of an nve-group or not. -If they are specified in the context of an nve-group, they -apply only if the redistribution mode is @code{nve-group}, -and then only for routes being redistributed from -@code{bgp-direct}. -If they are specified outside the context of an nve-group, then -they apply only for redistribution modes @code{plain} and @code{resolve-nve}, -and then only for routes being redistributed from @code{bgp-direct}. - -@deffn {VNC} {vnc redistribute bgp-direct (ipv4|ipv6) prefix-list @var{LIST-NAME}} -When redistributing @code{bgp-direct} routes, -specifies that the named prefix-list should be applied. -@end deffn - -@deffn {VNC} {vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list} -When redistributing @code{bgp-direct} routes, -specifies that no prefix-list should be applied. -@end deffn - -@deffn {VNC} {vnc redistribute bgp-direct route-map @var{MAP-NAME}} -When redistributing @code{bgp-direct} routes, -specifies that the named route-map should be applied. -@end deffn - -@deffn {VNC} {vnc redistribute bgp-direct no route-map} -When redistributing @code{bgp-direct} routes, -specifies that no route-map should be applied. -@end deffn - -@node Configuring Export of Routes to Other Routing Protocols -@subsection Configuring Export of Routes to Other Routing Protocols - -Routes from VNC (both for RFP and for redistribution via BGP) can be -provided to other protocols, either via zebra or directly to BGP. - -It is important to note that when exporting routes to other protocols, -the downstream protocol must also be configured to import the routes. -For example, when VNC routes are exported to unicast BGP, the BGP -configuration must include a corresponding @code{redistribute vnc-direct} -statement. - -@deffn {VNC} {export bgp|zebra mode none|group-nve|registering-nve|ce} -Specify how routes should be exported to bgp or zebra. -If the mode is @code{none}, routes are not exported. -If the mode is @code{group-nve}, routes are exported according -to nve-group or vrf-policy group configuration (@pxref{VNC NVE Group Configuration}): if a group is configured to -allow export, then each prefix visible to the group is exported -with next hops set to the currently-registered NVEs. -If the mode is @code{registering-nve}, then all VNC routes are -exported with their original next hops. -If the mode is @code{ce}, only VNC routes that have an NVE connected CE Router -encoded in a Route Origin Extended Community are exported. -This extended community must have an administrative value that -matches the configured @code{roo-ec-local-admin} value. -The next hop of the exported route is set to the encoded -NVE connected CE Router. - -The default for both bgp and zebra is mode @code{none}. -@end deffn - -@deffn {VNC} {vnc export bgp|zebra group-nve group @var{group-name}} -@deffnx {VNC} {vnc export bgp|zebra group-nve no group @var{group-name}} -When export mode is @code{group-nve}, -export (or do not export) prefixes from the specified nve-group or -vrf-policy group -to unicast BGP or to zebra. -Repeat this statement as needed for each nve-group to be exported. -Each VNC prefix that is exported will result in N exported routes to the -prefix, each with a next hop corresponding to one of the N NVEs currently -associated with the nve-group. -@end deffn - -@deffn {VNC} export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME -When export mode is @code{ce} or @code{registering-nve}, -specifies that the named prefix-list should be applied to routes -being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -@end deffn - -@deffn {VNC} export bgp|zebra no ipv4|ipv6 prefix-list -When export mode is @code{ce} or @code{registering-nve}, -specifies that no prefix-list should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} export bgp|zebra route-map MAP-NAME -When export mode is @code{ce} or @code{registering-nve}, -specifies that the named route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} export bgp|zebra no route-map -When export mode is @code{ce} or @code{registering-nve}, -specifies that no route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -When the export mode is @code{group-nve}, policy for exported -routes is specified per-NVE-group or vrf-policy group inside a @code{nve-group} @var{RFG-NAME} block -via the following commands(@pxref{VNC NVE Group Configuration}): - -@deffn {VNC} {export bgp|zebra route-map MAP-NAME} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that the named route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra no route-map} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that no route-map should be applied to routes -being exported to bgp or zebra. -@end deffn - -@deffn {VNC} {export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that the named prefix-list filter should be applied to -routes being exported to bgp or zebra. -Prefix-lists for ipv4 and ipv6 are independent of each other. -@end deffn - -@deffn {VNC} {export bgp|zebra no ipv4|ipv6 prefix-list} -This command is valid inside a @code{nve-group} @var{RFG-NAME} block. -It specifies that no prefix-list filter should be applied to -routes being exported to bgp or zebra. -@end deffn - -@node Manual Address Control -@section Manual Address Control - -The commands in this section can be used to augment normal dynamic VNC. -The @code{add vnc} commands can be used to manually add IP prefix or -Ethernet MAC address forwarding information. The @code{clear vnc} -commands can be used to remove manually and dynamically added -information. - -@deffn {Command} {add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost <0-255>] [lifetime (infinite|<1-4294967295>)] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost <0-255>]]} {} -Register an IP prefix on behalf of the NVE identified by the VN and UN -addresses. The @code{cost} parameter provides the administrative -preference of the forwarding information for remote advertisement. If -omitted, it defaults to 255 (lowest preference). The @code{lifetime} -parameter identifies the period, in seconds, that the information -remains valid. If omitted, it defaults to @var{infinite}. The optional -@code{local-next-hop} parameter is used to configure a nexthop to be -used by an NVE to reach the prefix via a locally connected CE router. -This information remains local to the NVA, i.e., not passed to other -NVAs, and is only passed to registered NVEs. When specified, it is also -possible to provide a @code{local-cost} parameter to provide a -forwarding preference. If omitted, it defaults to 255 (lowest -preference). -@end deffn - - -@deffn {Command} {add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier <1-4294967295> vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost <0-255>] [lifetime (infinite|<1-4294967295>)]} {} -Register a MAC address for a logical Ethernet (L2VPN) on behalf of the -NVE identified by the VN and UN addresses. -The optional @code{prefix} parameter is to support enable IP address -mediation for the given prefix. The @code{cost} parameter provides the administrative -preference of the forwarding information. If omitted, it defaults to -255. The @code{lifetime} parameter identifies the period, in seconds, -that the information remains valid. If omitted, it defaults to -@var{infinite}. -@end deffn - -@deffn {Command} {clear vnc prefix (*|A.B.C.D/M|X:X::X:X/M) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])} {} -Delete the information identified by prefix, VN address, and UN address. -Any or all of these parameters may be wilcarded to (potentially) match -more than one registration. -The optional @code{mac} parameter specifies a layer-2 MAC address -that must match the registration(s) to be deleted. -The optional @code{local-next-hop} parameter is used to -delete specific local nexthop information. -@end deffn - -@deffn {Command} {clear vnc mac (*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (*|<1-4294967295>) (*|[(vn|un) (A.B.C.D|X:X::X:X|*) [(un|vn) (A.B.C.D|X:X::X:X|*)] [prefix (*|A.B.C.D/M|X:X::X:X/M)])} {} -Delete mac forwarding information. -Any or all of these parameters may be wilcarded to (potentially) match -more than one registration. -The default value for the @code{prefix} parameter is the wildcard value @var{*}. -@end deffn - -@deffn {Command} {clear vnc nve (*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)])) } {} -Delete prefixes associated with the NVE specified by the given VN and UN -addresses. -It is permissible to specify only one of VN or UN, in which case -any matching registration will be deleted. -It is also permissible to specify @code{*} in lieu of any VN or UN -address, in which case all registrations will match. -@end deffn - -@node Other VNC-Related Commands -@section Other VNC-Related Commands - -Note: VNC-Related configuration can be obtained via the @code{show -running-configuration} command when in @code{enable} mode. - -The following commands are used to clear and display -Virtual Network Control related information: - -@deffn {COMMAND} {clear vnc counters} {} -Reset the counter values stored by the NVA. Counter -values can be seen using the @code{show vnc} commands listed above. This -command is only available in @code{enable} mode. -@end deffn - -@deffn {Command} {show vnc summary} {} -Print counter values and other general information -about the NVA. Counter values can be reset -using the @code{clear vnc counters} command listed below. -@end deffn - -@deffn {Command} {show vnc nves} {} -@deffnx {Command} {show vnc nves vn|un @var{address}} {} -Display the NVA's current clients. Specifying @var{address} -limits the output to the NVEs whose addresses match @var{address}. -The time since the NVA last communicated with the NVE, per-NVE -summary counters and each NVE's addresses will be displayed. -@end deffn - -@deffn {Command} {show vnc queries} {} -@deffnx {Command} {show vnc queries @var{prefix}} {} -Display active Query information. Queries remain valid for the default -Response Lifetime (@pxref{VNC Defaults Configuration}) or NVE-group -Response Lifetime (@pxref{VNC NVE Group Configuration}). Specifying -@var{prefix} limits the output to Query Targets that fall within -@var{prefix}. - -Query information is provided for each querying NVE, and includes the -Query Target and the time remaining before the information is removed. -@end deffn - -@deffn {Command} {show vnc registrations [all|local|remote|holddown|imported]} {} -@deffnx {Command} {show vnc registrations [all|local|remote|holddown|imported] @var{prefix}} {} -Display local, remote, holddown, and/or imported registration information. -Local registrations are routes received via RFP, which are present in the -NVA Registrations Cache. -Remote registrations are routes received via BGP (VPN SAFIs), which -are present in the NVE-group import tables. -Holddown registrations are local and remote routes that have been -withdrawn but whose holddown timeouts have not yet elapsed. -Imported information represents routes that are imported into NVA and -are made available to querying NVEs. Depending on configuration, -imported routes may also be advertised via BGP. -Specifying @var{prefix} limits the output to the registered prefixes that -fall within @var{prefix}. - -Registration information includes the registered prefix, the registering -NVE addresses, the registered administrative cost, the registration -lifetime and the time since the information was registered or, in the -case of Holddown registrations, the amount of time remaining before the -information is removed. -@end deffn - -@deffn {Command} {show vnc responses [active|removed]} {} -@deffnx {Command} {show vnc responses [active|removed] @var{prefix}} {} -Display all, active and/or removed response information which are -present in the NVA Responses Cache. Responses remain valid for the -default Response Lifetime (@pxref{VNC Defaults Configuration}) or -NVE-group Response Lifetime (@pxref{VNC NVE Group Configuration}.) -When Removal Responses are enabled (@pxref{General VNC Configuration}), -such responses are listed for the Response Lifetime. Specifying -@var{prefix} limits the output to the addresses that fall within -@var{prefix}. - -Response information is provided for each querying NVE, and includes -the response prefix, the prefix-associated registering NVE addresses, -the administrative cost, the provided response lifetime and the time -remaining before the information is to be removed or will become inactive. -@end deffn - -@deffn {Command} {show memory vnc} {} -Print the number of memory items allocated by the NVA. -@end deffn - -@node Example VNC and VNC-GW Configurations -@section Example VNC and VNC-GW Configurations - -@menu -* Mesh NVA Configuration:: -* Mesh NVA and VNC-GW Configuration:: -* VNC with Frr Route Reflector Configuration:: -* VNC with Commercial Route Reflector Configuration:: -* VNC with Redundant Route Reflectors Configuration:: -@c * Interfacing VNC to an IGP:: -@end menu - -@node Mesh NVA Configuration -@subsection Mesh NVA Configuration - -This example includes three NVAs, nine NVEs, and two NVE groups. Note -that while not shown, a single physical device may support multiple -logical NVEs. @ref{fig:fig-vnc-mesh} shows @code{NVA 1} -(192.168.1.100), @code{NVA 2} (192.168.1.101), and @code{NVA 3} -(192.168.1.102), which are connected in a full mesh. Each is a -member of the autonomous system 64512. Each NVA provides VNC -services to three NVE clients in the 172.16.0.0/16 virtual-network -address range. The 172.16.0.0/16 address range is partitioned into -two NVE groups, @code{group1} (172.16.0.0/17) and @code{group2} -(172.16.128.0/17). - -Each NVE belongs to either NVE group @code{group1} or NVE group -@code{group2}. The NVEs @code{NVE 1}, @code{NVE 2}, @code{NVE -4}, @code{NVE 7}, and @code{NVE 8} are members of the NVE group -@code{group1}. The NVEs @code{NVE 3}, @code{NVE 5}, @code{NVE -6}, and @code{NVE 9} are members of the NVE group @code{group2}. - -Each NVA advertises NVE underlay-network IP addresses using the -Tunnel Encapsulation Attribute. - -@float Figure,fig:fig-vnc-mesh -@center @image{fig-vnc-mesh,400pt,,Three-way Mesh} -@caption{A three-way full mesh with three NVEs per NVA} -@end float - -@file{bgpd.conf} for @code{NVA 1} (192.168.1.100) -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.100 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rt both 1000:1 - exit-vnc - - vnc nve-group group2 - prefix vn 172.16.128.0/17 - rt both 1000:2 - exit-vnc - -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} (192.168.1.101): -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - neighbor 192.168.1.102 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 3} (192.168.1.102): -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - neighbor 192.168.1.101 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -@node Mesh NVA and VNC-GW Configuration -@subsection Mesh NVA and VNC-GW Configuration - -This example includes two NVAs, each with two associated NVEs, and two -VNC-GWs, each supporting two CE routers physically attached to the four -NVEs. Note that this example is showing a more complex configuration -where VNC-GW is separated from normal NVA functions; it is equally -possible to simplify the configuration and combine NVA and VNC-GW -functions in a single frr instance. - -@float Figure,fig:fig-vnc-gw -@center @image{fig-vnc-gw,400pt,,Frr VNC Gateway} -@caption{Meshed NVEs and VNC-GWs} -@end float - -As shown in @ref{fig:fig-vnc-gw}, NVAs and VNC-GWs are connected in a -full iBGP mesh. The VNC-GWs each have two CEs configured as -route-reflector clients. Each client provides BGP updates with unicast -routes that the VNC-GW reflects to the other client. The VNC-GW also -imports these unicast routes into VPN routes to be shared with the other -VNC-GW and the two NVAs. This route importation is controlled with the -@code{vnc redistribute} statements shown in the configuration. -Similarly, registrations sent by NVEs via RFP to the NVAs are exported -by the VNC-GWs to the route-reflector clients as unicast routes. RFP -registrations exported this way have a next-hop address of the CE behind -the connected (registering) NVE. Exporting VNC routes as IPv4 unicast -is enabled with the @code{vnc export} command below. - -The configuration for @code{VNC-GW 1} is shown below. -@verbatim -router bgp 64512 - bgp router-id 192.168.1.101 - bgp cluster-id 1.2.3.4 - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.103 remote-as 64512 - neighbor 192.168.1.104 remote-as 64512 - neighbor 172.16.1.2 remote-as 64512 - neighbor 172.16.2.2 remote-as 64512 - ! - address-family ipv4 unicast - redistribute vnc-direct - no neighbor 192.168.1.102 activate - no neighbor 192.168.1.103 activate - no neighbor 192.168.1.104 activate - neighbor 172.16.1.2 route-reflector-client - neighbor 172.16.2.2 route-reflector-client - exit-address-family - ! - address-family ipv4 vpn - neighbor 192.168.1.102 activate - neighbor 192.168.1.103 activate - neighbor 192.168.1.104 activate - exit-address-family - vnc export bgp mode ce - vnc redistribute mode resolve-nve - vnc redistribute ipv4 bgp-direct - exit -@end verbatim - -Note that in the VNC-GW configuration, the neighboring VNC-GW and -NVAs each have a statement disabling the IPv4 unicast address family. -IPv4 unicast is on by default and this prevents the other VNC-GW and -NVAs from learning unicast routes advertised by the route-reflector clients. - -Configuration for @code{NVA 2}: -@verbatim -router bgp 64512 - bgp router-id 192.168.1.104 - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.103 remote-as 64512 - ! - address-family ipv4 unicast - no neighbor 192.168.1.101 activate - no neighbor 192.168.1.102 activate - no neighbor 192.168.1.103 activate - exit-address-family - ! - address-family ipv4 vpn - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - neighbor 192.168.1.103 activate - exit-address-family - ! - vnc defaults - response-lifetime 3600 - exit-vnc - vnc nve-group nve1 - prefix vn 172.16.1.1/32 - response-lifetime 3600 - rt both 1000:1 1000:2 - exit-vnc - vnc nve-group nve2 - prefix vn 172.16.2.1/32 - response-lifetime 3600 - rt both 1000:1 1000:2 - exit-vnc - exit -@end verbatim - -@c TBD make this its own example: -@c -@c @float Figure,fig:fig-vnc-gw-rr -@c @center @image{fig-vnc-gw-rr,400pt,,Frr VNC Gateway with RR} -@c @end float -@c An NVA can also import unicast routes from BGP without advertising the -@c imported routes as VPN routes. Such imported routes, while not -@c distributed to other NVAs or VNC-GWs, are are available to NVEs via -@c RFP query messages sent to the NVA. @ref{fig:fig-vnc-gw-rr} -@c shows an example topology where unicast routes are imported into NVAs -@c from a Route Reflector. (@pxref{Route Reflector} for route reflector -@c configuration details.) The following three lines can be added to the -@c @code{NVA 1} and @code{NVA 2} configurations to import routes into VNC -@c for local VNC use: -@c -@c @verbatim -@c neighbor 192.168.1.105 remote-as 64512 -@c vnc redistribute mode plain -@c vnc redistribute ipv4 bgp-direct-to-nve-groups -@c @end verbatim - -@node VNC with Frr Route Reflector Configuration -@subsection VNC with Frr Route Reflector Configuration -A route reflector eliminates the need for a fully meshed NVA -network by acting as the hub between NVAs. -@ref{fig:fig-vnc-frr-route-reflector} shows BGP route reflector -@code{BGP Route Reflector 1} (192.168.1.100) as a route reflector for -NVAs @code{NVA 2}(192.168.1.101) and @code{NVA 3} -(192.168.1.102). - -@float Figure,fig:fig-vnc-frr-route-reflector -@center @image{fig-vnc-frr-route-reflector,400pt,,Frr Route Reflector} -@caption{Two NVAs and a BGP Route Reflector} -@end float - -@code{NVA 2} and @code{NVA 3} -advertise NVE underlay-network IP addresses using the Tunnel Encapsulation Attribute. -@code{BGP Route Reflector 1} ``reflects'' advertisements from -@code{NVA 2} to @code{NVA 3} and vice versa. - -As in the example of @ref{Mesh NVA Configuration}, there are two NVE groups. -The 172.16.0.0/16 address range is partitioned into two NVE groups, -@code{group1} (172.16.0.0/17) and @code{group2} (172.16.128.0/17). -The NVE @code{NVE 4}, @code{NVE 7}, and @code{NVE 8} are -members of the NVE group @code{group1}. The NVEs @code{NVE 5}, -@code{NVE 6}, and @code{NVE 9} are members of the NVE group -@code{group2}. - -@file{bgpd.conf} for @code{BGP Route Reflector 1} on 192.168.1.100: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.100 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.101 port 7179 - neighbor 192.168.1.101 description iBGP-client-192-168-1-101 - - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.102 port 7179 - neighbor 192.168.1.102 description iBGP-client-192-168-1-102 - - address-family ipv4 unicast - neighbor 192.168.1.101 route-reflector-client - neighbor 192.168.1.102 route-reflector-client - exit-address-family - - address-family ipv4 vpn - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - - neighbor 192.168.1.101 route-reflector-client - neighbor 192.168.1.102 route-reflector-client - exit-address-family - -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.102: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.100 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -While not shown, an NVA can also be configured as a route reflector. - -@node VNC with Commercial Route Reflector Configuration -@subsection VNC with Commercial Route Reflector Configuration -This example is identical to @ref{VNC with Frr Route Reflector -Configuration} with the exception that the route reflector is a -commercial router. Only the -VNC-relevant configuration is provided. - -@float Figure,fig:fig-vnc-commercial-route-reflector -@center @image{fig-vnc-commercial-route-reflector,400pt,,Commercial Route Reflector} -@caption{Two NVAs with a commercial route reflector} -@end float - -@file{bgpd.conf} for BGP route reflector @code{Commercial Router} on 192.168.1.104: -@verbatim -version 8.5R1.13; -routing-options { - rib inet.0 { - static { - route 172.16.0.0/16 next-hop 192.168.1.104; - } - } - autonomous-system 64512; - resolution { - rib inet.3 { - resolution-ribs inet.0; - } - rib bgp.l3vpn.0 { - resolution-ribs inet.0; - } - } -} -protocols { - bgp { - advertise-inactive; - family inet { - labeled-unicast; - } - group 1 { - type internal; - advertise-inactive; - advertise-peer-as; - import h; - family inet { - unicast; - } - family inet-vpn { - unicast; - } - cluster 192.168.1.104; - neighbor 192.168.1.101; - neighbor 192.168.1.102; - } - } -} -policy-options { - policy-statement h { - from protocol bgp; - then { - as-path-prepend 64512; - accept; - } - } -} -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 3} on 192.168.1.102: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.100 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -@node VNC with Redundant Route Reflectors Configuration -@subsection VNC with Redundant Route Reflectors Configuration -This example combines the previous two (@ref{VNC with Frr Route -Reflector Configuration} and @ref{VNC with Commercial Route Reflector -Configuration}) into a redundant route reflector configuration. BGP -route reflectors @code{BGP Route Reflector 1} and @code{Commercial Router} -are the route reflectors for NVAs @code{NVA 2} and -@code{NVA 3}. The two NVAs have connections to both -route reflectors. - -@float Figure,fig:fig-vnc-redundant-route-reflectors -@center @image{fig-vnc-redundant-route-reflectors,400pt,,Redundant Route Reflectors} -@caption{Frr-based NVA with redundant route reflectors} -@end float - -@file{bgpd.conf} for @code{Bgpd Route Reflector 1} on 192.168.1.100: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.100 - bgp cluster-id 192.168.1.100 - - neighbor 192.168.1.104 remote-as 64512 - - neighbor 192.168.1.101 remote-as 64512 - neighbor 192.168.1.101 description iBGP-client-192-168-1-101 - neighbor 192.168.1.101 route-reflector-client - - neighbor 192.168.1.102 remote-as 64512 - neighbor 192.168.1.102 description iBGP-client-192-168-1-102 - neighbor 192.168.1.102 route-reflector-client - - address-family ipv4 vpn - neighbor 192.168.1.101 activate - neighbor 192.168.1.102 activate - neighbor 192.168.1.104 activate - - neighbor 192.168.1.101 route-reflector-client - neighbor 192.168.1.102 route-reflector-client - exit-address-family -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 2} on 192.168.1.101: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.101 - - neighbor 192.168.1.100 remote-as 64512 - neighbor 192.168.1.104 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - neighbor 192.168.1.104 activate - exit-address-family - - vnc nve-group group1 - prefix vn 172.16.0.0/17 - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for @code{NVA 3} on 192.168.1.102: -@verbatim -router bgp 64512 - - bgp router-id 192.168.1.102 - - neighbor 192.168.1.100 remote-as 64512 - neighbor 192.168.1.104 remote-as 64512 - - address-family ipv4 vpn - neighbor 192.168.1.100 activate - neighbor 192.168.1.104 activate - exit-address-family - - vnc defaults - rd 64512:1 - response-lifetime 200 - rt both 1000:1 1000:2 - exit-vnc - - vnc nve-group group1 - prefix vn 172.16.128.0/17 - exit-vnc -exit -@end verbatim - -@file{bgpd.conf} for the Commercial Router route reflector on -192.168.1.104: -@verbatim -routing-options { - rib inet.0 { - static { - route 172.16.0.0/16 next-hop 192.168.1.104; - } - } - autonomous-system 64512; - resolution { - rib inet.3 { - resolution-ribs inet.0; - } - rib bgp.l3vpn.0 { - resolution-ribs inet.0; - } - } -} -protocols { - bgp { - advertise-inactive; - family inet { - labeled-unicast; - } - group 1 { - type internal; - advertise-inactive; - advertise-peer-as; - import h; - family inet { - unicast; - } - family inet-vpn { - unicast; - } - cluster 192.168.1.104; - neighbor 192.168.1.101; - neighbor 192.168.1.102; - } - - group 2 { - type internal; - advertise-inactive; - advertise-peer-as; - import h; - family inet { - unicast; - } - family inet-vpn { - unicast; - } - neighbor 192.168.1.100; - } - - } -} -policy-options { - policy-statement h { - from protocol bgp; - then { - as-path-prepend 64512; - accept; - } - } -} -@end verbatim - -@node Release Notes -@section Release Notes - -@c A paragraph that introduces our release notes. - -@c outer list, one item per VNC release, items preceded by bullet -@itemize @bullet -@item - -@c @item -@end itemize - -@evenheading @thispage@|@|@thistitle -@oddheading @thischapter@|@|@thispage -@everyfooting - From 05102ddc45c8f6ebdf93c9ade0ae2d77c5f2b520 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 31 Jan 2018 10:31:15 -0500 Subject: [PATCH 042/148] doc: move dev doc figures to figures/ Signed-off-by: Quentin Young --- doc/developer/git_branches.svg | 720 -------------------- doc/developer/workflow.rst | 6 +- doc/{developer => figures}/git_branches.png | Bin 3 files changed, 5 insertions(+), 721 deletions(-) delete mode 100644 doc/developer/git_branches.svg rename doc/{developer => figures}/git_branches.png (100%) diff --git a/doc/developer/git_branches.svg b/doc/developer/git_branches.svg deleted file mode 100644 index 0c2c96e39e..0000000000 --- a/doc/developer/git_branches.svg +++ /dev/null @@ -1,720 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - 1.0ReleaseBranch - - - - - - - - - - Master(Stable) - - - - - - - - - 1.1ReleaseBranch - Version 1.0.a1 - Version 1.1.a1 - Version 1.1.a2 - - - - - Version 1.1.b1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Patch Email (Patchwork) - Github Pull Request - Github Pull Request - Patch Email (Patchwork) - Patch Email (Patchwork) - Github Pull Request - Github Pull Request - Github Pull Request - Patch Email (Patchwork) - Github Pull Request - Github Pull Request - Github Pull Request - Github Pull Request - Github Pull Request - Github Pull Request - - - - - - - - - Version 1.0.a2 - Version 1.0.b1 - Version 1.0.0 - Version 1.1.0 - Version 1.1.1 - Version 1.1.2 - - - - - - - - - - - - - - - - - - diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index b5844d073b..88ae7ef761 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -17,7 +17,11 @@ Git Structure The master Git for FRR resides on `Github `__. -.. figure:: git_branches.png +.. figure:: ../figures/git_branches.png + :align: right + :alt: merging get branches into a central trunk + + Rough outline of FRR development workflow There is one main branch for development, ``master``. For each major release (2.0, 3.0 etc) a new release branch is created based on the master. Subsequent diff --git a/doc/developer/git_branches.png b/doc/figures/git_branches.png similarity index 100% rename from doc/developer/git_branches.png rename to doc/figures/git_branches.png From a1e276e1d328cf3cc871da409fa098ebc428a62a Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 31 Jan 2018 15:59:26 -0500 Subject: [PATCH 043/148] doc: overhaul manpages * Remove groff manpages * Rewrite manpages in RST * Clean up and standardize manpage content Signed-off-by: Quentin Young --- doc/.gitignore | 2 + doc/manpages/bgpd.8.in | 132 ------------ doc/manpages/bgpd.rst | 38 ++++ doc/manpages/common-options.rst | 165 +++++++++++++++ doc/manpages/conf.py | 347 ++++++++++++++++++++++++++++++++ doc/manpages/defines.txt | 3 + doc/manpages/eigrpd.8.in | 122 ----------- doc/manpages/eigrpd.rst | 38 ++++ doc/manpages/epilogue.rst | 16 ++ doc/manpages/frr-args.8.in | 248 ----------------------- doc/manpages/frr.rst | 42 ++++ doc/manpages/index.rst | 26 +++ doc/manpages/isisd.8.in | 119 ----------- doc/manpages/isisd.rst | 38 ++++ doc/manpages/ldpd.8.in | 117 ----------- doc/manpages/ldpd.rst | 38 ++++ doc/manpages/nhrpd.8.in | 113 ----------- doc/manpages/nhrpd.rst | 38 ++++ doc/manpages/ospf6d.8.in | 119 ----------- doc/manpages/ospf6d.rst | 39 ++++ doc/manpages/ospfclient.8.in | 42 ---- doc/manpages/ospfclient.rst | 41 ++++ doc/manpages/ospfd.8.in | 121 ----------- doc/manpages/ospfd.rst | 39 ++++ doc/manpages/pimd.8.in | 135 ------------- doc/manpages/pimd.rst | 38 ++++ doc/manpages/ripd.8.in | 121 ----------- doc/manpages/ripd.rst | 38 ++++ doc/manpages/ripngd.8.in | 122 ----------- doc/manpages/ripngd.rst | 38 ++++ doc/manpages/vtysh.rst | 72 +++++++ doc/manpages/watchfrr.8.in | 155 -------------- doc/manpages/watchfrr.rst | 119 +++++++++++ doc/manpages/zebra.8.in | 153 -------------- doc/manpages/zebra.rst | 54 +++++ 35 files changed, 1269 insertions(+), 1819 deletions(-) delete mode 100644 doc/manpages/bgpd.8.in create mode 100644 doc/manpages/bgpd.rst create mode 100644 doc/manpages/common-options.rst create mode 100644 doc/manpages/conf.py create mode 100644 doc/manpages/defines.txt delete mode 100644 doc/manpages/eigrpd.8.in create mode 100644 doc/manpages/eigrpd.rst create mode 100644 doc/manpages/epilogue.rst delete mode 100644 doc/manpages/frr-args.8.in create mode 100644 doc/manpages/frr.rst create mode 100644 doc/manpages/index.rst delete mode 100644 doc/manpages/isisd.8.in create mode 100644 doc/manpages/isisd.rst delete mode 100644 doc/manpages/ldpd.8.in create mode 100644 doc/manpages/ldpd.rst delete mode 100644 doc/manpages/nhrpd.8.in create mode 100644 doc/manpages/nhrpd.rst delete mode 100644 doc/manpages/ospf6d.8.in create mode 100644 doc/manpages/ospf6d.rst delete mode 100644 doc/manpages/ospfclient.8.in create mode 100644 doc/manpages/ospfclient.rst delete mode 100644 doc/manpages/ospfd.8.in create mode 100644 doc/manpages/ospfd.rst delete mode 100644 doc/manpages/pimd.8.in create mode 100644 doc/manpages/pimd.rst delete mode 100644 doc/manpages/ripd.8.in create mode 100644 doc/manpages/ripd.rst delete mode 100644 doc/manpages/ripngd.8.in create mode 100644 doc/manpages/ripngd.rst create mode 100644 doc/manpages/vtysh.rst delete mode 100644 doc/manpages/watchfrr.8.in create mode 100644 doc/manpages/watchfrr.rst delete mode 100644 doc/manpages/zebra.8.in create mode 100644 doc/manpages/zebra.rst diff --git a/doc/.gitignore b/doc/.gitignore index 8dada02288..fca8f3209b 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -36,3 +36,5 @@ stamp-vti *.loT refix _build +_static +_template diff --git a/doc/manpages/bgpd.8.in b/doc/manpages/bgpd.8.in deleted file mode 100644 index 0df1b1dcea..0000000000 --- a/doc/manpages/bgpd.8.in +++ /dev/null @@ -1,132 +0,0 @@ -.TH BGPD 8 "25 November 2004" "@PACKAGE_FULLNAME@ BGPD daemon" "Version @PACKAGE_VERSION@" -.SH NAME -bgpd \- a BGPv4, BGPv4\+, BGPv4\- routing engine for use with @PACKAGE_FULLNAME@. - -.SH SYNOPSIS -.B bgpd -[ -.B \-dhrSv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-p -.I bgp-port-number -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B bgpd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B bgpd -command: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/bgpd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When bgpd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart bgpd. The default is \fB\fI@CFG_STATE@/bgpd.pid\fR. -.TP -\fB\-p\fR, \fB\-\-bgp_port \fR\fIbgp-port-number\fR -Set the port that bgpd will listen to for bgp data. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the bgpd VTY will listen on. This defaults to -2605, as specified in \fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the bgpd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-r\fR, \fB\-\-retain\fR -When the program terminates, retain routes added by \fBbgpd\fR. -.TP -\fB\-S\fR, \fB\-\-skip_runas\fR -Skip setting the process effective user and group. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -The \fBsnmp\fR module may be available for -\fBbgpd\fR, if the package was built with SNMP support. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/bgpd -The default location of the -.B bgpd -binary. -.TP -.BI @CFG_SYSCONF@/bgpd.conf -The default location of the -.B bgpd -config file. -.TP -.BI $(PWD)/bgpd.log -If the -.B bgpd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBbgpd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The bgpd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBbgpd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR nhrpd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B bgpd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/bgpd.rst b/doc/manpages/bgpd.rst new file mode 100644 index 0000000000..73ca6b2351 --- /dev/null +++ b/doc/manpages/bgpd.rst @@ -0,0 +1,38 @@ +**** +BGPD +**** + +.. include:: defines.txt +.. |DAEMON| replace:: bgpd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/common-options.rst b/doc/manpages/common-options.rst new file mode 100644 index 0000000000..5b136f5e1a --- /dev/null +++ b/doc/manpages/common-options.rst @@ -0,0 +1,165 @@ +HELP AND VERSION +---------------- + +.. option:: -h, --help + + Print a short description of the daemon's command line options. + +.. option:: -v, --version + + Print version and build information for the daemon. + +Both of these options inhibit normal operation and will immediately exit. + +PROCESS CONTROL +--------------- +These options control background operation: + +.. option:: -d, --daemon + + Launches the process in background/daemon mode, forking and detaching from the terminal. + + The parent process will delay its exit until the daemon/child has finished its initialization and has entered its main loop. This is important for zebra startup because the other daemons will attempt to connect to zebra. A return from zebra -d guarantees its readiness to accept these connections. + +.. option:: -t, --terminal + + Opens an interactive VTY session on the terminal, allowing for both state and configuration operations. Note that the terminal starts operating after startup has completed and the configuration file has been loaded. + + The process will exit when end of file is detected on the terminal. It is possible to daemonize a process started with -t (but without -d) by sending SIGQUIT to the process (normally mapped to a ^\ keypress.) + + +The combination of :option:`--daemon` and :option:`--terminal` will delay the daemon from going into background until the terminal session ends (by end of file.) + +If the process receives SIGINT (e.g. a ^C keypress) in this mode, it will exit instead of daemonizing. + +It is safe to suspend (SIGTSTP / ^Z) the terminal session opened by the previous two options; this will only stop the terminal but not the protocol daemon itself (which runs in a separate second process.) + +CONFIGURATION AND PATHS +----------------------- +The following options control configuration and file system locations for frr processes: + +.. option:: -f, --config_file config-file + + Specify a configuration file to be used instead of the default /etc/frr/.conf file. + + Note that the daemon will attempt to write to this file if the write file command is issued on its VTY interface or through vtysh. + +.. option:: -C, --dryrun + + Load the configuration file and check its validity, then exit. + +.. option:: -i, --pid_file pid-file + + Output a pid file to a location other than the default /var/run/frr/.pid. + +.. option:: -z, --socket zclient-path + + Override the path of the ZAPI socket used to communicate between zebra and the various protocol daemons. The default is /var/run/frr/zserv.api. The value of this option must be the same across all daemons. + +.. option:: -N, --pathspace pathspace + + Insert pathspace into all default paths, changing the defaults to: + + /etc/frr/pathspace/.conf + /var/run/frr/pathspace/.pid + /var/run/frr/pathspace/.vty + /var/run/frr/pathspace/zserv.api + + ´.´ and ´/´ characters will not be accepted in pathspace, but the empty string will be accepted. + + Note that this only changes the respective defaults, it has no effect on the respective path if the -f, -i, -z or --vty_socket options are used. + + The purpose of this option is to easily group all file system related bits together for running multiple fully-separate "logical routers" on a system, particularly with Linux network namespaces. Groups of daemons running with distinct pathspace values will be completely unaware of each other and not interact in any way. + + This option does not do any system setup (like network namespaces.) This must be done by the user, for example by running: + + ip netns exec namespace -N namespace + + +PROCESS CREDENTIALS +------------------- +.. option:: -u, --user user + + (default: frr) + +.. option:: -g, --group group + + (default: frr) + + Change the user/group which the daemon will switch to. + +.. option:: -S, --skip_runas + + Skip setting the process effective user and group. + + +Note that there is an additional group, frrvty, which controls group ownership of the VTY sockets. The name of this group cannot currently be changed, and user must be a member of this group. + + +VTY SETUP +--------- +These following options control the daemon's VTY (interactive command line) interface. The interface is available over TCP, using the telnet protocol, as well as through the vtysh frontend. + +.. option:: -A, --vty_addr vty-addr + + Specify an IP/IPv6 address to bind the TCP VTY interface to. It is generally recommended to specify ::1 or 127.0.0.1. For reasons of backwards compatibility, the default is to listen on all interfaces. + +.. option:: -P, --vty_port vty-port + + Override the daemon's default TCP VTY port (each daemon has a different default value upwards of 2600, listed below.) Specifying 0 disables the TCP VTY interface. + + Default ports are::: + + zebra 2601 + ripd 2602 + ripngd 2603 + ospfd 2604 + bgpd 2605 + ospf6d 2606 + isisd 2608 + babeld 2609 + nhrpd 2610 + pimd 2611 + ldpd 2612 + eigrpd 2613 + + Port 2607 is used for ospfd's Opaque LSA API, while port 2600 is used for the (insecure) TCP-ZEBRA interface. + +.. option:: --vty_socket vty-path + + Overrides the directory used for the .vty sockets. vtysh connects to these sockets in order to access each daemon's VTY. + Default: /var/run/frr[/] + + NB: Unlike the other options, this option specifies a directory, not a full path. + + This option is primarily used by the SNAP packaging system, its semantics may change. It should not be neccessary in most other scenarios. + +MODULE LOADING +-------------- +frr supports optional dynamically loadable modules, although these can only be loaded at startup. The set of available modules may vary across distributions and packages, and modules may be available for installation as separate packages. + +.. option:: -M, --module module[:options] + + Load a module named module, optionally passing options to it. + + If there is a ´/´ character in module, the value is assumed to be a pathname to a module. + + If there is no ´/´ character, the module directory (see next option) is searched first for a module named "_.so", then for ".so". This allows for a module to exist in variations appropriate for particular daemons, e.g. zebra_snmp and bgp_snmp, with the correct one selected by -M snmp. + + The meaning of options is specific to the module being loaded. Most modules currently ignore it. + + Modules are loaded in the order as listed on the command line. This is not generally relevant. + +.. option:: --moduledir module-path + + Look for modules in the module-path directory instead of the default /usr/lib/frr/modules. (This path is not affected by the -N option.) + +The list of loaded modules can be inspected at runtime with the show modules VTY command. + +ROUTES +------ + +.. option:: -r, --retain + + When the program terminates, retain routes added by the daemon. + diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py new file mode 100644 index 0000000000..6aa8588039 --- /dev/null +++ b/doc/manpages/conf.py @@ -0,0 +1,347 @@ +# -*- coding: utf-8 -*- +# +# FRR documentation build configuration file, created by +# sphinx-quickstart on Tue Jan 31 16:00:52 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import re + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = '1.0' + +# prolog for various variable substitutions +rst_prolog = '' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.todo'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'FRR' +copyright = u'2017, FRR' +author = u'Kunihiro Ishiguro, et al.' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. + +# The short X.Y version. +version = u'?.?' +# The full version, including alpha/beta/rc tags. +release = u'?.?-?' + + +# ----------------------------------------------------------------------------- +# Extract values from codebase for substitution into docs. +# ----------------------------------------------------------------------------- + +# Various installation prefixes. Reasonable defaults are set where possible. +# Values are overridden by logic below. +replace_vars = { + 'AUTHORS': author, + 'COPYRIGHT_YEAR': '1999-2005', + 'COPYRIGHT_STR': None, + 'PACKAGE_NAME': project.lower(), + 'PACKAGE_TARNAME': project.lower(), + 'PACKAGE_STRING': None, + 'PACKAGE_URL': 'https://frrouting.org/', + 'PACKAGE_VERSION': None, + 'INSTALL_PREFIX_ETC': None, + 'INSTALL_PREFIX_SBIN': None, + 'INSTALL_PREFIX_STATE': None, + 'INSTALL_PREFIX_MODULES': None, + 'INSTALL_USER': None, + 'INSTALL_GROUP': None, + 'INSTALL_VTY_GROUP': None, + 'GROUP': 'frr', + 'USER': 'frr', +} + +# extract version information, installation location, other stuff we need to +# use when building final documents +val = re.compile('^S\["([^"]+)"\]="(.*)"$') +with open('../../config.status', 'r') as cfgstatus: + for ln in cfgstatus.readlines(): + m = val.match(ln) + if not m or m.group(1) not in replace_vars.keys(): continue + replace_vars[m.group(1)] = m.group(2) + +# manually fill out some of these we can't get from config.status +replace_vars['COPYRIGHT_STR'] = "Copyright (c)" +replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['COPYRIGHT_YEAR']) +replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['AUTHORS']) +release = replace_vars['PACKAGE_VERSION'] +version = release.split('-')[0] + +# add substitutions to prolog +for key, value in replace_vars.items(): + rst_prolog += '.. |{0}| replace:: {1}\n'.format(key, value) + + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'FRRdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'FRR.tex', u'FRR User Manual', + u'FRR', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). + +# If true, show URL addresses after external links. +#man_show_urls = False + +fwfrr = "{} routing engine for use with FRRouting." + +man_pages = [ + ('bgpd', 'bgpd', fwfrr.format("a BGPv4, BGPv4+, BGPv4- "), [], 8), + ('eigrpd', 'eigrpd', fwfrr.format("an EIGRP "), [], 8), + ('ospf6d', 'ospf6d', fwfrr.format("an OSPFv3 "), [], 8), + ('ospfd', 'ospfd', fwfrr.format("an OSPFv2 "), [], 8), + ('isisd', 'isisd', fwfrr.format("an IS-IS "), [], 8), + ('ospfclient', 'ospfclient', 'an example ospf-api client', [], 8), + ('ldpd', 'ldpd', fwfrr.format("an LDP "), [], 8), + ('nhrpd', 'nhrpd', fwfrr.format("a Next Hop Routing Protocol "), [], 8), + ('pimd', 'pimd', fwfrr.format("a PIM "), [], 8), + ('ripd', 'ripd', fwfrr.format("a RIP "), [], 8), + ('ripngd', 'ripngd', fwfrr.format("a RIPNG "), [], 8), + ('zebra', 'zebra', 'a routing manager for use with associated FRRouting components.', [], 8), + ('watchfrr', 'watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8), + ('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1), + ('frr', 'frr', 'a systemd interaction script', [], 1), +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +# custom extensions here diff --git a/doc/manpages/defines.txt b/doc/manpages/defines.txt new file mode 100644 index 0000000000..4b66d71b44 --- /dev/null +++ b/doc/manpages/defines.txt @@ -0,0 +1,3 @@ +.. |synopsis-options| replace:: [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir module-path] +.. |synopsis-options-hv| replace:: [-h] [-v] +.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8) diff --git a/doc/manpages/eigrpd.8.in b/doc/manpages/eigrpd.8.in deleted file mode 100644 index ecac972bc2..0000000000 --- a/doc/manpages/eigrpd.8.in +++ /dev/null @@ -1,122 +0,0 @@ -.TH EIGRPD 8 "6 May 2017" "@PACKAGE_FULLNAME@ EIGRP daemon" "Version @PACKAGE_VERSION@" -.SH NAME -eigrpd \- a EIGRP routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B eigrpd -[ -.B \-dhrv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B eigrpd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B eigrpd -command: -.SH OPTIONS -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/eigrpd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When eigrpd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart eigrpd. The default is \fB\fI@CFG_STATE@/eigrpd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the eigrpd VTY will listen on. This defaults to -2602, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the eigrpd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-r\fR, \fB\-\-retain\fR -When the program terminates, retain routes added by \fBeigrpd\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -The \fBsnmp\fR module may be available for -\fBeigrpd\fR, if the package was built with SNMP support. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/eigrpd -The default location of the -.B eigrpd -binary. -.TP -.BI @CFG_SYSCONF@/eigrpd.conf -The default location of the -.B eigrpd -config file. -.TP -.BI $(PWD)/eigrpd.log -If the -.B eigrpd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBeigrpd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The eigrpd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBeigrpd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B eigrpd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. diff --git a/doc/manpages/eigrpd.rst b/doc/manpages/eigrpd.rst new file mode 100644 index 0000000000..ef269b1151 --- /dev/null +++ b/doc/manpages/eigrpd.rst @@ -0,0 +1,38 @@ +****** +EIGRPD +****** + +.. include:: defines.txt +.. |DAEMON| replace:: eigrpd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/epilogue.rst b/doc/manpages/epilogue.rst new file mode 100644 index 0000000000..a4c1b897e3 --- /dev/null +++ b/doc/manpages/epilogue.rst @@ -0,0 +1,16 @@ +WARNING +======= +This man page is intended to be a quick reference for command line options. The definitive document is the info file |PACKAGE_STRING| or the documentation available on the project website at |PACKAGE_URL|. + +DIAGNOSTICS +=========== +The daemon may log to standard output, to a VTY, to a log file, or through syslog to the system logs. FRR supports many debugging options, see the Info file, web docs or source for details. + +SEE ALSO +======== +zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8) +|PACKAGE_URL| + +BUGS +==== +FRR eats bugs for breakfast. If you have food for the maintainers, please email . diff --git a/doc/manpages/frr-args.8.in b/doc/manpages/frr-args.8.in deleted file mode 100644 index 3dc84e1e22..0000000000 --- a/doc/manpages/frr-args.8.in +++ /dev/null @@ -1,248 +0,0 @@ -.TH frr-args 8 "28 August 2017" "@PACKAGE_FULLNAME@ general options" "Version @PACKAGE_VERSION@" -.SH NAME -frr-args \- common command line options for all @PACKAGE_FULLNAME@ daemons. -.SH SYNOPSIS -<\fBzebra\fR|\fBbgpd\fR|\fB...\fR> -[\fB\-h\fR] [\fB\-v\fR] - -<\fBzebra\fR|\fBbgpd\fR|\fB...\fR> -[\fB\-d\fR|\fB\-t\fR|\fB\-dt\fR] -[\fB\-C\fR] -[\fB\-f\fR \fIconfig-file\fR] -[\fB\-i\fR \fIpid-file\fR] -[\fB\-z\fR \fIzclient-path\fR] -[\fB\-u\fR \fIuser\fR] -[\fB\-g\fR \fIgroup\fR] -[\fB\-A\fR \fIvty-addr\fR] -[\fB\-P\fR \fIvty-port\fR] -[\fB\-M\fR \fImodule\fR[\fB:\fIoptions\fR]] -[\fB\-N\fR \fIpathspace\fR] -[\fB\-\-vty_socket\fR \fIvty-path\fR] -[\fB\-\-moduledir\fR \fImodule-path\fR] - -.SH DESCRIPTION -@PACKAGE_NAME@ daemons share a large part of their command line options; -this man page documents these. For options on specific daemons please refer -to their respective man pages. Most of the common options are related to -process control, configuration and common library functionality. - -.SH HELP AND VERSION -.TP -\fB\-h\fR, \fB\-\-help\fR -Print a short description of the daemon's command line options. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print version and build information for the daemon. -.PP -Both of these options inhibit normal operation and will immediately exit. - -.SH PROCESS CONTROL -These options control background operation: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Launches the process in background/daemon mode, forking and detaching from -the terminal. - -The parent process will delay its exit until the daemon/child has finished -its initialization and has entered its main loop. This is important for -\fBzebra\fR startup because the other daemons will attempt to connect to -\fBzebra\fR. A return from \fBzebra -d\fR guarantees its readiness to -accept these connections. -.TP -\fB\-t\fR, \fB\-\-terminal\fR -Opens an interactive VTY session on the terminal, allowing for both state -and configuration operations. Note that the terminal starts operating after -startup has completed and the configuration file has been loaded. - -The process will exit when end of file is detected on the terminal. It is -possible to daemonize a process started with \fB-t\fR (but without \fB-d\fR) -by sending \fISIGQUIT\fR to the process (normally mapped to a \fI^\\\fR -keypress.) -.TP -\fB\-dt\fR, \fB\-\-daemon \-\-terminal\fR -This combination of the previous two options will delay the daemon from -going into background until the terminal session ends (by end of file.) - -If the process receives \fISIGINT\fR (e.g. a \fI^C\fR keypress) in this -mode, it will exit instead of daemonizing. -.PP -It is safe to suspend (\fISIGTSTP\fR / \fI^Z\fR) the terminal session -opened by the previous two options; this will only stop the terminal but -not the protocol daemon itself (which runs in a separate second process.) - -.SH CONFIGURATION AND PATHS -The following options control configuration and file system locations for -@PACKAGE_NAME@ processes: -.TP -\fB\-f\fR, \fB\-\-config_file\fR \fIconfig-file\fR -Specify a configuration file to be used instead of the default -\fB\fI@CFG_SYSCONF@/.conf\fR file. - -Note that the daemon will attempt to write to this file if the -\fIwrite file\fR command is issued on its VTY interface or through -\fBvtysh\fR. -.TP -\fB\-C\fR, \fB\-\-dryrun\fR -Load the configuration file and check its validity, then exit. -.TP -\fB\-i\fR, \fB\-\-pid_file\fR \fIpid-file\fR -Output a pid file to a location other than the default -\fB\fI@CFG_STATE@/.pid\fR. -.TP -\fB\-z\fR, \fB\-\-socket\fR \fIzclient-path\fR -Override the path of the ZAPI socket used to communicate between \fBzebra\fR -and the various protocol daemons. The default is -\fB\fI@CFG_STATE@/zserv.api\fR. The value of this option must be the same -across all daemons. -.TP -\fB\-N\fR, \fB\-\-pathspace\fR \fIpathspace\fR -Insert \fIpathspace\fR into all default paths, changing the defaults to: -.IP -\fB@CFG_SYSCONF@/\fIpathspace\fB/.conf\fR -.br -\fB@CFG_STATE@/\fIpathspace\fB/.pid\fR -.br -\fB@CFG_STATE@/\fIpathspace\fB/.vty\fR -.br -\fB@CFG_STATE@/\fIpathspace\fB/zserv.api\fR - -\'.\' and \'/\' characters will not be accepted in \fIpathspace\fR, but the -empty string will be accepted. - -Note that this only changes the respective defaults, it has no effect on -the respective path if the \fB\-f\fR, \fB\-i\fR, \fB\-z\fR or -\fB\-\-vty_socket\fR options are used. - -The purpose of this option is to easily group all file system related -bits together for running multiple fully-separate "logical routers" on a -system, particularly with Linux network namespaces. Groups of daemons -running with distinct \fIpathspace\fR values will be completely unaware -of each other and not interact in any way. - -This option does not do any system setup (like network namespaces.) This -must be done by the user, for example by running: -.IP -\fBip netns exec \fInamespace \fB -N \fInamespace\fR - -.SH PROCESS CREDENTIALS -.TP -\fB\-u\fR, \fB\-\-user\fR \fIuser\fR -(default: \fB@enable_user@\fR) -.TP -\fB\-g\fR, \fB\-\-group\fR \fIgroup\fR -(default: \fB@enable_group@\fR) -.IP -Change the user/group which the daemon will switch to. -.PP -Note that there is an additional group, \fB@enable_vty_group@\fR, which -controls group ownership of the VTY sockets. The name of this group cannot -currently be changed, and \fIuser\fR must be a member of this group. - -.SH VTY SETUP -These following options control the daemon's VTY (interactive command line) -interface. The interface is available over TCP, using the telnet protocol, -as well as through the \fBvtysh\fR frontend. -.TP -\fB\-A\fR, \fB--vty_addr\fR \fIvty-addr\fR -Specify an IP/IPv6 address to bind the TCP VTY interface to. It is -generally recommended to specify \fI::1\fR or \fI127.0.0.1\fR. For reasons -of backwards compatibility, the default is to listen on all interfaces. -.TP -\fB\-P\fR, \fB--vty_port\fR \fIvty-port\fR -Override the daemon's default TCP VTY port (each daemon has a different -default value upwards of 2600, listed below.) Specifying \fI0\fR disables -the TCP VTY interface. - -Default ports are: - -.ta 16m -zebra 2601 -.br -ripd 2602 -.br -ripngd 2603 -.br -ospfd 2604 -.br -bgpd 2605 -.br -ospf6d 2606 -.br -isisd 2608 -.br -babeld 2609 -.br -nhrpd 2610 -.br -pimd 2611 -.br -ldpd 2612 -.br -eigrpd 2613 - -Port 2607 is used for ospfd's Opaque LSA API, while port 2600 is used for -the (insecure) TCP-ZEBRA interface. -.TP -\fB\-\-vty_socket\fR \fIvty-path\fR -Overrides the directory used for the \fB.vty\fR sockets. -\fBvtysh\fR connects to these sockets in order to access each daemon's -VTY. -.br -Default: \fB\fI@CFG_STATE@\fR[\fB/\fI\fR] - -NB: Unlike the other options, this option specifies a \fBdirectory\fR, -not a full path. - -This option is primarily used by the SNAP packaging system, its semantics -may change. It should not be neccessary in most other scenarios. - -.SH MODULE LOADING -@PACKAGE_NAME@ supports optional dynamically loadable modules, although -these can only be loaded at startup. The set of available modules may vary -across distributions and packages, and modules may be available for -installation as separate packages. -.TP -\fB\-M\fR, \fB\-\-module\fR \fImodule\fR[\fB:\fIoptions\fR] -Load a module named \fImodule\fR, optionally passing \fIoptions\fR to it. - -If there is a \'/\' character in \fImodule\fR, the value is assumed to be -a pathname to a module. - -If there is no \'/\' character, the module directory (see next option) -is searched first for a module named "\fI\fB_\fI\fB.so\fR", -then for "\fI\fB.so\fR". -This allows for a module to exist in variations appropriate for particular -daemons, e.g. \fIzebra_snmp\fR and \fIbgp_snmp\fR, with the correct one -selected by \fI\-M snmp\fR. - -The meaning of \fIoptions\fR is specific to the module being loaded. Most -modules currently ignore it. - -Modules are loaded in the order as listed on the command line. This is -not generally relevant. -.TP -\fB\-\-moduledir\fR \fImodule-path\fR -Look for modules in the \fImodule-path\fR directory instead of the default -\fI@CFG_MODULE@\fR. (This path is \fBnot\fR affected by the \fB\-N\fR -option.) -.PP -The list of loaded modules can be inspected at runtime with the -\fBshow modules\fR VTY command. - - -.SH "SEE ALSO" -.BR zebra (8), -.BR vtysh (1), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR bgpd (8), -.BR isisd (8), -.BR babeld (8), -.BR nhrpd (8), -.BR pimd (8), -.BR ldpd (8), -.BR eigrpd (8) - -\fIhttps://frrouting.org/ diff --git a/doc/manpages/frr.rst b/doc/manpages/frr.rst new file mode 100644 index 0000000000..37b90ac93b --- /dev/null +++ b/doc/manpages/frr.rst @@ -0,0 +1,42 @@ +*** +FRR +*** + +SYNOPSIS +======== +frr [ start ] + +frr [ stop ] + +frr [ reload ] + +frr [ restart ] + +frr [ status ] + + +DESCRIPTION +=========== +frr is a systemd interaction script for the FRRouting routing engine. + +OPTIONS +======= +Options available for the frr command: + +start + Start enabled FRR daemons + +stop + Stop enabled FRR daemons + +reload + Reload modified configuration files + +restart + Stop all running daemons and then restart them + +status + Status of all the daemon + +.. include:: epilogue.rst + diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst new file mode 100644 index 0000000000..a909e094d2 --- /dev/null +++ b/doc/manpages/index.rst @@ -0,0 +1,26 @@ +.. FRR documentation master file, created by + sphinx-quickstart on Wed Jan 31 12:00:55 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to FRR's documentation! +=============================== + +.. toctree:: + :maxdepth: 2 + + bgpd + eigrpd + isisd + ldpd + nhrpd + ospf6d + ospfclient + ospfd + pimd + ripd + ripngd + watchfrr + zebra + vtysh + frr diff --git a/doc/manpages/isisd.8.in b/doc/manpages/isisd.8.in deleted file mode 100644 index 542c289935..0000000000 --- a/doc/manpages/isisd.8.in +++ /dev/null @@ -1,119 +0,0 @@ -.TH IS-IS 8 "25 November 2004" "@PACKAGE_FULLNAME@ IS-IS daemon" "Version @PACKAGE_VERSION@" -.SH NAME -isisd \- an IS-IS routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B isisd -[ -.B \-dhv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B isisd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B isisd -command: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/isisd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When isisd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart isisd. The default is \fB\fI@CFG_STATE@/isisd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the isisd VTY will listen on. This defaults to -2608, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the isisd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -There are currently no such modules for -\fBisisd\fR in the base package. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/isisd -The default location of the -.B isisd -binary. -.TP -.BI @CFG_SYSCONF@/isisd.conf -The default location of the -.B isisd -config file. -.TP -.BI $(PWD)/isisd.log -If the -.B isisd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBisisd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The isisd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBisisd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -\fBisisd\fR is ALPHA quality at the moment and hasn't any way ready for -production use. - -.B isisd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://isisd.sourceforge.net -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/isisd.rst b/doc/manpages/isisd.rst new file mode 100644 index 0000000000..6926d56051 --- /dev/null +++ b/doc/manpages/isisd.rst @@ -0,0 +1,38 @@ +***** +ISISD +***** + +.. include:: defines.txt +.. |DAEMON| replace:: isisd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/ldpd.8.in b/doc/manpages/ldpd.8.in deleted file mode 100644 index 2d68a31a50..0000000000 --- a/doc/manpages/ldpd.8.in +++ /dev/null @@ -1,117 +0,0 @@ -.TH LDPD 8 "29 March 2016" "@PACKAGE_FULLNAME@ LDP daemon" "Version @PACKAGE_VERSION@" -.SH NAME -ldpd \- an LDP engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B ldpd -[ -.B \-dhv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B ldpd -is a component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B ldpd -command: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/ldpd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When ldpd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart ldpd. The default is \fB\fI@CFG_STATE@/ldpd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the ldpd VTY will listen on. This defaults to -2612, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the ldpd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -There are currently no such modules for -\fBldpd\fR in the base package. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/ldpd -The default location of the -.B ldpd -binary. -.TP -.BI @CFG_SYSCONF@/ldpd.conf -The default location of the -.B ldpd -config file. -.TP -.BI $(PWD)/ldpd.log -If the -.B ldpd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBldpd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The ldpd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBldpd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B ldpd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/ldpd.rst b/doc/manpages/ldpd.rst new file mode 100644 index 0000000000..e01027d1f7 --- /dev/null +++ b/doc/manpages/ldpd.rst @@ -0,0 +1,38 @@ +**** +LDPD +**** + +.. include:: defines.txt +.. |DAEMON| replace:: ldpd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/nhrpd.8.in b/doc/manpages/nhrpd.8.in deleted file mode 100644 index 09b662ae7c..0000000000 --- a/doc/manpages/nhrpd.8.in +++ /dev/null @@ -1,113 +0,0 @@ -.TH NHRP 8 "24 January 2017" "@PACKAGE_FULLNAME@ NHRP daemon" "Version @PACKAGE_VERSION@" -.SH NAME -nhrpd \- a Next Hop Routing Protocol routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B nhrpd -[ -.B \-dhv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B nhrpd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B nhrpd -command: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will likely default to \fB\fI@CFG_SYSCONF@/nhrpd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When nhrpd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart nhrpd. The likely default is \fB\fI@CFG_STATE@/nhrpd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the nhrpd VTY will listen on. This defaults to -2610, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the nhrpd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -There are currently no such modules for -\fBnhrpd\fR in the base package. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/nhrpd -The default location of the -.B nhrpd -binary. -.TP -.BI @CFG_SYSCONF@/nhrpd.conf -The default location of the -.B nhrpd -config file. -.TP -.BI $(PWD)/nhrpd.log -If the -.B nhrpd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBnhrpd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The nhrpd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBnhrpd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR zebra (8), -.BR vtysh (1) - -.B nhrpd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -Timo Teräs diff --git a/doc/manpages/nhrpd.rst b/doc/manpages/nhrpd.rst new file mode 100644 index 0000000000..8a2cb25611 --- /dev/null +++ b/doc/manpages/nhrpd.rst @@ -0,0 +1,38 @@ +***** +NHRPD +***** + +.. include:: defines.txt +.. |DAEMON| replace:: nhrpd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/ospf6d.8.in b/doc/manpages/ospf6d.8.in deleted file mode 100644 index 02d9d8083d..0000000000 --- a/doc/manpages/ospf6d.8.in +++ /dev/null @@ -1,119 +0,0 @@ -.TH OSPF6D 8 "25 November 2004" "@PACKAGE_FULLNAME@ OSPFv3 daemon" "Version @PACKAGE_VERSION@" -.SH NAME -ospf6d \- an OSPFv3 routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B ospf6d -[ -.B \-dhv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B ospf6d -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B ospf6d -command: -.SH OPTIONS -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/ospf6d.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When ospf6d starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart ospf6d. The default is \fB\fI@CFG_STATE@/ospf6d.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the ospf6d VTY will listen on. This defaults to -2606, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the ospf6d VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -The \fBsnmp\fR module may be available for -\fBospf6d\fR, if the package was built with SNMP support. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/ospf6d -The default location of the -.B ospf6d -binary. -.TP -.BI @CFG_SYSCONF@/ospf6d.conf -The default location of the -.B ospf6d -config file. -.TP -.BI $(PWD)/ospf6d.log -If the -.B ospf6d -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBospf6d\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The ospf6d process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBospf6d\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR isisd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B ospf6d -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/ospf6d.rst b/doc/manpages/ospf6d.rst new file mode 100644 index 0000000000..2328d240ae --- /dev/null +++ b/doc/manpages/ospf6d.rst @@ -0,0 +1,39 @@ +****** +OSPF6D +****** + +.. include:: defines.txt +.. |DAEMON| replace:: ospf6d + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/ospfclient.8.in b/doc/manpages/ospfclient.8.in deleted file mode 100644 index a304beffda..0000000000 --- a/doc/manpages/ospfclient.8.in +++ /dev/null @@ -1,42 +0,0 @@ -.\" This file was originally generated by help2man 1.36. -.TH OSPFCLIENT "8" "July 2010" -.SH NAME -ospfclient \- an example ospf-api client -.SH SYNOPSIS -.B ospfclient -.I ospfd -.I lsatype -.I opaquetype -.I opaqueid -.I ifaddr -.I areaid -.SH DESCRIPTION -.B ospfclient -is a an example ospf-api client to test the ospfd daemon. -.SH OPTIONS -.TP -.I ospfd -A router where the API\-enabled OSPF daemon is running. -.TP -.I lsatype -The value has to be either "9", "10", or "11", depending on the flooding -scope. -.TP -.I opaquetype -The value has to be in the range of 0\-255 (for example, experimental -applications use -.I opaquetype -larger than 128). -.TP -.I opaqueid -Arbitrary application instance (24 bits). -.TP -.I ifaddr -Interface IP address for type 9, otherwise it will be ignored. -.TP -.I areaid -Area in the IP address format for type 10, otherwise it will be ignored. -.SH "SEE ALSO" -.BR ospfd (8). -.SH AUTHORS -See the project homepage at <@PACKAGE_URL@>. diff --git a/doc/manpages/ospfclient.rst b/doc/manpages/ospfclient.rst new file mode 100644 index 0000000000..573a75f6a7 --- /dev/null +++ b/doc/manpages/ospfclient.rst @@ -0,0 +1,41 @@ +********** +OSPFCLIENT +********** + +SYNOPSIS +======== +ospfclient + +DESCRIPTION +=========== +ospfclient is an example ospf-api client to test the ospfd daemon. + +OPTIONS +======= + +.. option:: ospfd + + A router where the API-enabled OSPF daemon is running. + +.. option:: lsatype + + The value has to be either "9", "10", or "11", depending on the flooding scope. + +.. option:: opaquetype + + The value has to be in the range of 0-255 (for example, experimental applications might use opaquetype larger than 128). + +.. option:: opaqueid + + Arbitrary application instance (24 bits). + +.. option:: ifaddr + + Interface IP address for type 9, otherwise it will be ignored. + +.. option:: areaid + + Area in the IP address format for type 10, otherwise it will be ignored. + + +.. include:: epilogue.rst diff --git a/doc/manpages/ospfd.8.in b/doc/manpages/ospfd.8.in deleted file mode 100644 index 6bad777711..0000000000 --- a/doc/manpages/ospfd.8.in +++ /dev/null @@ -1,121 +0,0 @@ -.TH OSPFD 8 "25 November 2004" "@PACKAGE_FULLNAME@ OSPFv2 daemon" "Version @PACKAGE_VERSION@" -.SH NAME -ospfd \- an OSPFv2 routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B ospfd -[ -.B \-dhlv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B ospfd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B ospfd -command: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/ospfd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When ospfd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart ospfd. The default is \fB\fI@CFG_STATE@/ospfd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the ospfd VTY will listen on. This defaults to -2604, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the ospfd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-a\fR, \fB\-\-apiserver \fR -Enable OSPF apiserver. Default is disabled. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -The \fBsnmp\fR module may be available for -\fBospfd\fR, if the package was built with SNMP support. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/ospfd -The default location of the -.B ospfd -binary. -.TP -.BI @CFG_SYSCONF@/ospfd.conf -The default location of the -.B ospfd -config file. -.TP -.BI $(PWD)/ospfd.log -If the -.B ospfd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBospfd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The ospfd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBospfd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B ospfd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/ospfd.rst b/doc/manpages/ospfd.rst new file mode 100644 index 0000000000..50ee503730 --- /dev/null +++ b/doc/manpages/ospfd.rst @@ -0,0 +1,39 @@ +***** +OSPFD +***** + +.. include:: defines.txt +.. |DAEMON| replace:: ospfd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/pimd.8.in b/doc/manpages/pimd.8.in deleted file mode 100644 index 6db3418f8f..0000000000 --- a/doc/manpages/pimd.8.in +++ /dev/null @@ -1,135 +0,0 @@ -.TH PIM 8 "10 December 2008" "@PACKAGE_FULLNAME@ PIM daemon" "Version @PACKAGE_VERSION@" -.SH NAME -pimd \- a PIM routing for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B pimd -[ -.B \-dhvZ -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-z -.I path -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B pimd -is a protocol-independent multicast component that works with the -.B @PACKAGE_FULLNAME@ -Routing Suite. -.SH OPTIONS -Options available for the -.B pimd -command: -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/pimd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When pimd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart pimd. The default is \fB\fI@CFG_STATE@/pimd.pid\fR. -.TP -\fB\-z\fR, \fB\-\-socket \fR\fIpath\fR -Specify the socket path for contacting the zebra daemon. -The default is \fB\fI@CFG_STATE@/zserv.api\fR. The value of this option -must be the same as the one given when starting zebra. Refer to the \fBzebra -(8)\fR man page for more information. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the pimd VTY will listen on. This defaults to -2611, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the pimd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -There are currently no such modules for -\fBpimd\fR in the base package. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.TP -\fB\-Z\fR, \fB\-\-debug_zclient\fR -Enable logging information for zclient debugging. -.SH FILES -.TP -.BI @CFG_SBIN@/pimd -The default location of the -.B pimd -binary. -.TP -.BI @CFG_SYSCONF@/pimd.conf -The default location of the -.B pimd -config file. -.TP -.BI @CFG_STATE@/pimd.pid -The default location of the -.B pimd -pid file. -.TP -.BI @CFG_STATE@/zserv.api -The default location of the -.B zebra -unix socket file. -.TP -.BI $(PWD)/pimd.log -If the -.B pimd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBpimd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. -.SH DIAGNOSTICS -The pimd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. -.SH "SEE ALSO" -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -\fBpimd\fR is in early development at the moment and is not ready for -production use. - -.B pimd -eats bugs for breakfast. If you have food for the maintainers try -.BI https://github.com/udhos/qpimd -.SH AUTHORS -See -.BI https://github.com/udhos/qpimd -for an accurate list of authors. - diff --git a/doc/manpages/pimd.rst b/doc/manpages/pimd.rst new file mode 100644 index 0000000000..98fd3a5c92 --- /dev/null +++ b/doc/manpages/pimd.rst @@ -0,0 +1,38 @@ +**** +PIMD +**** + +.. include:: defines.txt +.. |DAEMON| replace:: pimd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/ripd.8.in b/doc/manpages/ripd.8.in deleted file mode 100644 index a84668e6dd..0000000000 --- a/doc/manpages/ripd.8.in +++ /dev/null @@ -1,121 +0,0 @@ -.TH RIPD 8 "25 November 2004" "@PACKAGE_FULLNAME@ RIP daemon" "Version @PACKAGE_VERSION@" -.SH NAME -ripd \- a RIP routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B ripd -[ -.B \-dhrv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B ripd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B ripd -command: -.SH OPTIONS -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/ripd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When ripd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart ripd. The default is \fB\fI@CFG_STATE@/ripd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the ripd VTY will listen on. This defaults to -2602, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the ripd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-r\fR, \fB\-\-retain\fR -When the program terminates, retain routes added by \fBripd\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -The \fBsnmp\fR module may be available for -\fBripd\fR, if the package was built with SNMP support. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/ripd -The default location of the -.B ripd -binary. -.TP -.BI @CFG_SYSCONF@/ripd.conf -The default location of the -.B ripd -config file. -.TP -.BI $(PWD)/ripd.log -If the -.B ripd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBripd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The ripd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBripd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B ripd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. diff --git a/doc/manpages/ripd.rst b/doc/manpages/ripd.rst new file mode 100644 index 0000000000..01b0223251 --- /dev/null +++ b/doc/manpages/ripd.rst @@ -0,0 +1,38 @@ +**** +RIPD +**** + +.. include:: defines.txt +.. |DAEMON| replace:: ripd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/ripngd.8.in b/doc/manpages/ripngd.8.in deleted file mode 100644 index 98039219a7..0000000000 --- a/doc/manpages/ripngd.8.in +++ /dev/null @@ -1,122 +0,0 @@ -.TH RIPNGD 8 "25 November 2004" "@PACKAGE_FULLNAME@ RIPNG daemon" "Version @PACKAGE_VERSION@" -.SH NAME -ripngd \- a RIPNG routing engine for use with @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B ripngd -[ -.B \-dhlrv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] -.SH DESCRIPTION -.B ripngd -is a routing component that works with the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B ripngd -command: -.SH OPTIONS -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/ripngd.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When ripngd starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart ripngd. The default is \fB\fI@CFG_STATE@/ripngd.pid\fR. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the ripngd VTY will listen on. This defaults to -2603, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the ripngd VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-r\fR, \fB\-\-retain\fR -When the program terminates, retain routes added by \fBripd\fR. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -There are currently no such modules for -\fBripngd\fR in the base package. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/ripngd -The default location of the -.B ripngd -binary. -.TP -.BI @CFG_SYSCONF@/ripngd.conf -The default location of the -.B ripngd -config file. -.TP -.BI $(PWD)/ripngd.log -If the -.B ripngd -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBripngd\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The ripngd process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBripngd\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8), -.BR vtysh (1) -.SH BUGS -.B ripngd -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/ripngd.rst b/doc/manpages/ripngd.rst new file mode 100644 index 0000000000..2a3e14ae6f --- /dev/null +++ b/doc/manpages/ripngd.rst @@ -0,0 +1,38 @@ +****** +RIPNGD +****** + +.. include:: defines.txt +.. |DAEMON| replace:: ripngd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/vtysh.rst b/doc/manpages/vtysh.rst new file mode 100644 index 0000000000..341d5eae44 --- /dev/null +++ b/doc/manpages/vtysh.rst @@ -0,0 +1,72 @@ +***** +VTYSH +***** + +.. include:: defines.txt +.. |DAEMON| replace:: eigrpd + +SYNOPSIS +======== +vtysh [ -b ] + +vtysh [ -E ] [ -d *daemon* ] [ -c *command* ] + +DESCRIPTION +=========== +vtysh is an integrated shell for the FRRouting suite of protocol daemons. + +OPTIONS +======= +OPTIONS available for the vtysh command: + +.. option:: -b, --boot + + Execute boot startup configuration. It makes sense only if integrated config file is in use (not default in FRRouting). See Info file frr for more info. + +.. option:: -c, --command command + + Specify command to be executed under batch mode. It behaves like -c option in any other shell - command is executed and vtysh exits. + + It's useful for gathering info from FRRouting daemons or reconfiguring daemons from inside shell scripts, etc. Note that multiple commands may be executed by using more than one -c option and/or embedding linefeed characters inside the command string. + +.. option:: -d, --daemon daemon_name + + Specify which daemon to connect to. By default, vtysh attempts to connect to all FRRouting daemons running on the system. With this flag, one can specify a single daemon to connect to instead. For example, specifying '-d ospfd' will connect only to ospfd. This can be particularly useful inside scripts with -c where the command is targeted for a single daemon. + +.. option:: -e, --execute command + + Alias for -c. It's here only for compatibility with Zebra routing software and older FRR versions. This will be removed in future. + +.. option:: -E, --echo + + When the -c option is being used, this flag will cause the standard vtysh prompt and command to be echoed prior to displaying the results. This is particularly useful to separate the results when executing multiple commands. + +.. option:: -h, --help + + Display a usage message on standard output and exit. + +ENVIRONMENT VARIABLES +===================== +VTYSH_PAGER + This should be the name of the pager to use. Default is more. + +FILES +===== +|INSTALL_PREFIX_SBIN|/vtysh + The default location of the vtysh binary. + +|INSTALL_PREFIX_ETC|/vtysh.conf + The default location of the vtysh config file. + +|INSTALL_PREFIX_ETC|/frr.conf + The default location of the integrated FRRouting routing engine config file if integrated config file is in use. + +${HOME}/.history_frr + Location of history of commands entered via cli + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/watchfrr.8.in b/doc/manpages/watchfrr.8.in deleted file mode 100644 index 782ac7b46e..0000000000 --- a/doc/manpages/watchfrr.8.in +++ /dev/null @@ -1,155 +0,0 @@ -.\" This file was originally generated by help2man 1.36. -.TH WATCHFRR 8 "July 2010" -.SH NAME -watchfrr \- a program to monitor the status of frr daemons -.SH SYNOPSIS -.B watchfrr -.RI [ option ...] -.IR daemon ... -.br -.B watchfrr -.BR \-h " | " \-v -.SH DESCRIPTION -.B watchfrr -is a watchdog program that monitors the status of supplied frr -.IR daemon s -and tries to restart them in case they become unresponsive or shut down. -.PP -To determine whether a daemon is running, it tries to connect to the -daemon's VTY UNIX stream socket, and send echo commands to ensure the -daemon responds. When the daemon crashes, EOF is received from the socket, -so that watchfrr can react immediately. -.PP -In order to avoid restarting the daemons in quick succession, you can -supply the -.B \-m -and -.B \-M -options to set the minimum and maximum delay between the restart commands. -The minimum restart delay is recalculated each time a restart is attempted. -If the time since the last restart attempt exceeds twice the value of -.BR \-M , -the restart delay is set to the value of -.BR \-m , -otherwise the interval is doubled (but capped at the value of -.BR \-M ). -.SH OPTIONS -The following 3 options specify scripts that -.B watchfrr -uses to perform start/stop/restart actions. These options are mandatory -unless the -.B --dry -option is used: -.TP -.BI \-s " command" "\fR, \fB\-\-start\-command " command -Supply a Bourne shell -.I command -to start a single daemon. The command string should contain the '%s' -placeholder to be substituted with the daemon name. -.TP -.BI \-k " command" "\fR, \fB\-\-kill\-command " command -Supply a Bourne shell -.I command -to stop a single daemon. The command string should contain the '%s' -placeholder to be substituted with the daemon name. -.TP -.BI \-r " command" "\fR, \fB\-\-restart " command -Supply a Bourne shell -.I command -to restart a single daemon. The command string should contain the '%s' -placeholder to be substituted with the daemon name. -.PP -Other options: -.TP -.BI \-\-dry -Run watchfrr in "dry-run" mode, only monitoring the specified daemons but not -performing any start/stop/restart actions. -.TP -.BR \-d ", " \-\-daemon -Run in daemon mode. When supplied, error messages are sent to Syslog -instead of standard output (stdout). -.TP -.BI \-S " directory" "\fR, \fB\-\-statedir " directory -Set the VTY socket -.I directory -(the default value is "/var/run/frr"). -.TP -.BI \-l " level" "\fR, \fB\-\-loglevel " level -Set the logging -.I level -(the default value is "6"). The value should range from 0 (LOG_EMERG) to 7 -(LOG_DEBUG), but higher number can be supplied if extra debugging messages -are required. -.TP -.BI \-\-min\-restart\-interval " number -Set the minimum -.I number -of seconds to wait between invocations of the daemon restart commands (the -default value is "60"). -.TP -.BI \-\-max\-restart\-interval " number -Set the maximum -.I number -of seconds to wait between invocations of the daemon restart commands (the -default value is "600"). -.TP -.BI \-i " number" "\fR, \fB\-\-interval " number -Set the status polling interval in seconds (the default value is "5"). -.TP -.BI \-t " number" "\fR, \fB\-\-timeout " number -Set the unresponsiveness timeout in seconds (the default value is "10"). -.TP -.BI \-T " number" "\fR, \fB\-\-restart\-timeout " number -Set the restart (kill) timeout in seconds (the default value is "20"). If -any background jobs are still running after this period has elapsed, they -will be killed. -.TP -.BI \-p " filename" "\fR, \fB\-\-pid\-file " filename -Set the process identifier -.I filename -(the default value is "/var/run/frr/watchfrr.pid"). -.TP -.BI \-b " string" "\fR, \fB\-\-blank\-string " string -When the supplied -.I string -is found in any of the command line option arguments (i.e., -.BR \-r , -.BR \-s , -or -.BR \-k ), -replace it with a space. -.IP -This is an ugly hack to circumvent problems with passing the command line -arguments containing embedded spaces. -.TP -.BR \-v ", " \-\-version -Display the version information and exit. -.TP -.BR \-h ", " \-\-help -Display the usage information and exit. -.SH PREVIOUS OPTIONS -Prior versions of \fBwatchfrr\fR supported some additional options that no -longer exist: -.IP -.BR \-a ,\ \-A ,\ \-e ,\ \-R ,\ \-z -.PP -The \fB-a\fR, \fB-A\fR and \fB-R\fR options were used to select alternate -monitoring modes that offered different patterns of restarting daemons. The -"correct" mode (phased restart) is now the default. The \fB-e\fR and \fB-z\fR -options used to disable some monitoring aspects, watchfrr now always has all -monitoring features enabled. -.PP -Removing these options should result in correct operation, if it does not -please file a bug report. -.SH SEE ALSO -.BR zebra (8), -.BR bgpd (8), -.BR isisd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR ripd (8), -.BR ripngd (8) -.PP -See the project homepage at <@PACKAGE_URL@>. -.SH AUTHORS -Copyright 2004 Andrew J. Schorr diff --git a/doc/manpages/watchfrr.rst b/doc/manpages/watchfrr.rst new file mode 100644 index 0000000000..5c18ac2e6a --- /dev/null +++ b/doc/manpages/watchfrr.rst @@ -0,0 +1,119 @@ +******** +WATCHFRR +******** + +.. include:: defines.txt +.. |DAEMON| replace:: watchfrr + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| [option...] ... + + +DESCRIPTION +=========== +|DAEMON| is a watchdog program that monitors the status of supplied frr daemons and tries to restart them in case they become unresponsive or shut down. + +To determine whether a daemon is running, it tries to connect to the daemon's VTY UNIX stream socket, and send echo commands to ensure the daemon responds. When the daemon crashes, EOF is received from the socket, so that |DAEMON| can react immediately. + +In order to avoid restarting the daemons in quick succession, you can supply the -m and -M options to set the minimum and maximum delay between the restart commands. The minimum restart delay is recalculated each time a restart is attempted. If the time since the last restart attempt exceeds twice the value of -M, the restart delay is set to the value of -m, otherwise the interval is doubled (but capped at the value of -M). + +OPTIONS +======= +The following 3 options specify scripts that |DAEMON| uses to perform start/stop/restart actions. These options are mandatory unless the --dry option is used: + +.. option:: -s command, --start-command command + + Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be sub‐ stituted with the daemon name. + +.. option:: -k command, --kill-command command + + Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name. + +.. option:: -r command, --restart command + + Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name. + +Other options: + +.. option:: --dry + + Run |DAEMON| in "dry-run" mode, only monitoring the specified daemons but not performing any start/stop/restart actions. + +.. option:: -d, --daemon + + Run in daemon mode. When supplied, error messages are sent to Syslog instead of standard output (stdout). + +.. option:: -S , --statedir + + Set the VTY socket directory (the default value is "/var/run/frr"). + +.. option:: -l , --loglevel + + Set the logging level (the default value is "6"). The value should range from 0 (LOG_EMERG) to 7 (LOG_DEBUG), but higher number can be supplied if extra debugging messages are required. + +.. option:: --min-restart-interval + + Set the minimum number of seconds to wait between invocations of the daemon restart commands (the default value is "60"). + +.. option:: --max-restart-interval + + Set the maximum number of seconds to wait between invocations of the daemon restart commands (the default value is "600"). + +.. option:: -i , --interval + + Set the status polling interval in seconds (the default value is "5"). + +.. option:: -t , --timeout + + Set the unresponsiveness timeout in seconds (the default value is "10"). + +.. option:: -T , --restart-timeout + + Set the restart (kill) timeout in seconds (the default value is "20"). If any background jobs are still running after this period has elapsed, they will be killed. + +.. option:: -p , --pid-file + + Set the process identifier filename (the default value is "/var/run/frr/|DAEMON|.pid"). + +.. option:: -b , --blank-string + + When the supplied string is found in any of the command line option arguments (i.e., -r, -s, or -k), replace it with a space. + + This is an ugly hack to circumvent problems with passing the command line arguments containing embedded spaces. + +.. option:: -v, --version + + Display the version information and exit. + +.. option:: -h, --help + + Display the usage information and exit. + +PREVIOUS OPTIONS +================ +Prior versions of |DAEMON| supported some additional options that no longer exist::: + + -a, -A, -e, -R, -z + +The ``-a``, ``-A`` and ``-R`` options were used to select alternate monitoring modes that offered different patterns of restarting daemons. The "correct" mode (phased restart) is now the default. The -e and -z options used to disable some monitoring aspects, |DAEMON| now always has all monitoring features enabled. + +Removing these options should result in correct operation, if it does not please file a bug report. + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + diff --git a/doc/manpages/zebra.8.in b/doc/manpages/zebra.8.in deleted file mode 100644 index 7f4a81b1a0..0000000000 --- a/doc/manpages/zebra.8.in +++ /dev/null @@ -1,153 +0,0 @@ -.TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version @PACKAGE_VERSION@" -.SH NAME -zebra \- a routing manager for use with associated @PACKAGE_FULLNAME@ components. -.SH SYNOPSIS -.B zebra -[ -.B \-bdhklrv -] [ -.B \-f -.I config-file -] [ -.B \-i -.I pid-file -] [ -.B \-P -.I port-number -] [ -.B \-A -.I vty-address -] [ -.B \-u -.I user -] [ -.B \-g -.I group -] [ -.B \-M -.I module:options -] [ -.B \-z -.I socketpath -] -.SH DESCRIPTION -.B zebra -is a routing manager that implements the -.B zebra -route engine. -.B zebra -supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-. -.SH OPTIONS -Options available for the -.B zebra -command: -.TP -\fB\-b\fR, \fB\-\-batch\fR -Runs in batch mode, \fBzebra\fR parses its config and exits. -.TP -\fB\-d\fR, \fB\-\-daemon\fR -Runs in daemon mode, forking and exiting from tty. -.TP -\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR -Specifies the config file to use for startup. If not specified this -option will default to \fB\fI@CFG_SYSCONF@/zebra.conf\fR. -.TP -\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR -Specify the group to run as. Default is \fI@enable_group@\fR. -.TP -\fB\-h\fR, \fB\-\-help\fR -A brief message. -.TP -\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR -When zebra starts its process identifier is written to -\fB\fIpid-file\fR. The init system uses the recorded PID to stop or -restart zebra. The default is \fB\fI@CFG_STATE@/zebra.pid\fR. -.TP -\fB\-k\fR, \fB\-\-keep_kernel\fR -On startup, don't delete self inserted routes. -.TP -\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR -Specify the port that the zebra VTY will listen on. This defaults to -2601, as specified in \fB\fI/etc/services\fR. -.TP -\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR -Specify the address that the zebra VTY will listen on. Default is all -interfaces. -.TP -\fB\-u\fR, \fB\-\-user \fR\fIuser\fR -Specify the user to run as. Default is \fI@enable_user@\fR. -.TP -\fB\-r\fR, \fB\-\-retain\fR -When the program terminates, retain routes added by \fBzebra\fR. -.TP -\fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR -Set netlink receive buffer size. There are cases where zebra daemon can't -handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" -messages in zebra log, you are in trouble. - -Solution is to increase receive buffer of netlink socket. Note that kernel -< 2.6.14 doesn't allow to increase it over maximum value defined in -\fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase -maximum before starting zebra. - -Note that this affects Linux only. -.TP -\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR -Load a module at startup. May be specified more than once. -The \fBsnmp\fR and \fBfpm\fR modules may be -available for \fBzebra\fR, if the package was built with SNMP and FPM support -respectively. The \fBfpm\fR module takes an additional colon-separated -argument specifying the encapsulation, either \fBnetlink\fR or \fBprotobuf\fR. -It should thus be loaded with \fB-M fpm:netlink\fR or \fB-M fpm:protobuf\fR. -.TP -\fB\-z\fR, \fB\-\-socket \fR\fIsocketpath\fR -Use the specified path to open the zebra API socket on. -The default is \fB\fI@CFG_STATE@/zserv.api\fR. This option must be given with -the same value to all FRR protocol daemons. -.TP -\fB\-v\fR, \fB\-\-version\fR -Print the version and exit. -.SH FILES -.TP -.BI @CFG_SBIN@/zebra -The default location of the -.B zebra -binary. -.TP -.BI @CFG_SYSCONF@/zebra.conf -The default location of the -.B zebra -config file. -.TP -.BI $(PWD)/zebra.log -If the -.B zebra -process is config'd to output logs to a file, then you will find this -file in the directory where you started \fBzebra\fR. -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH DIAGNOSTICS -The zebra process may log to standard output, to a VTY, to a log -file, or through syslog to the system logs. \fBzebra\fR supports many -debugging options, see the Info file, or the source for details. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR nhrpd (8), -.BR vtysh (1) -.SH BUGS -.B zebra -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/manpages/zebra.rst b/doc/manpages/zebra.rst new file mode 100644 index 0000000000..9e5d4deb07 --- /dev/null +++ b/doc/manpages/zebra.rst @@ -0,0 +1,54 @@ +***** +ZEBRA +***** + +.. include:: defines.txt +.. |DAEMON| replace:: zebra + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing manager that implements the zebra route engine. zebra supports all protocol daemons in the FRRouting suite. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +.. option:: -b, --batch + + Runs in batch mode, zebra parses its config and exits. + +.. option:: -k, --keep_kernel + + On startup, don't delete self inserted routes. + +.. option:: -s, --nl-bufsize + + Set netlink receive buffer size. There are cases where zebra daemon can't handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" messages in zebra log, you are in trouble. + + Solution is to increase receive buffer of netlink socket. Note that kernel < 2.6.14 doesn't allow to increase it over maximum value defined in /proc/sys/net/core/rmem_max. If you want to do it, you have to increase maximum before starting zebra. + + Note that this affects Linux only. + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you + will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + From 7bd01bd49b4d399ac6afbb2f127249e25305741d Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 31 Jan 2018 16:16:07 -0500 Subject: [PATCH 044/148] doc: copy conf.py for developer's docs Info extracted will probably prove useful here as well. Signed-off-by: Quentin Young --- doc/developer/conf.py | 64 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 55 insertions(+), 9 deletions(-) diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 233056666d..1eac6af763 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -24,7 +24,10 @@ import re # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.0' + +# prolog for various variable substitutions +rst_prolog = '' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -36,7 +39,7 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] +# source_suffix = ['.rst'] source_suffix = '.rst' # The encoding of source files. @@ -59,14 +62,51 @@ version = u'?.?' # The full version, including alpha/beta/rc tags. release = u'?.?-?' + +# ----------------------------------------------------------------------------- +# Extract values from codebase for substitution into docs. +# ----------------------------------------------------------------------------- + +# Various installation prefixes. Reasonable defaults are set where possible. +# Values are overridden by logic below. +replace_vars = { + 'AUTHORS': 'Kunihiro Ishiguro, et al.', + 'COPYRIGHT_YEAR': '1999-2005', + 'COPYRIGHT_STR': None, + 'PACKAGE_NAME': project.lower(), + 'PACKAGE_TARNAME': project.lower(), + 'PACKAGE_STRING': None, + 'PACKAGE_URL': 'https://frrouting.org/', + 'PACKAGE_VERSION': None, + 'INSTALL_PREFIX_ETC': None, + 'INSTALL_PREFIX_SBIN': None, + 'INSTALL_PREFIX_STATE': None, + 'INSTALL_PREFIX_MODULES': None, + 'INSTALL_USER': None, + 'INSTALL_GROUP': None, + 'INSTALL_VTY_GROUP': None, +} + +# extract version information, installation location, other stuff we need to +# use when building final documents val = re.compile('^S\["([^"]+)"\]="(.*)"$') with open('../../config.status', 'r') as cfgstatus: for ln in cfgstatus.readlines(): m = val.match(ln) - if m is None: continue - if m.group(1) == 'PACKAGE_VERSION': - release = m.group(2) - version = release.split('-')[0] + if not m or m.group(1) not in replace_vars.keys(): continue + replace_vars[m.group(1)] = m.group(2) + +# manually fill out some of these we can't get from config.status +replace_vars['COPYRIGHT_STR'] = "Copyright (c)" +replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['COPYRIGHT_YEAR']) +replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['AUTHORS']) +release = replace_vars['PACKAGE_VERSION'] +version = release.split('-')[0] + +# add substitutions to prolog +for key, value in replace_vars.items(): + rst_prolog += '.. |{0}| replace:: {1}\n'.format(key, value) + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -231,7 +271,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'FRR.tex', u'FRR Developer\'s Manual', + (master_doc, 'FRR.tex', u'FRR User Manual', u'FRR', 'manual'), ] @@ -261,7 +301,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'frr', u'FRR Developer\'s Manual', + (master_doc, 'frr', u'FRR User Manual', [author], 1) ] @@ -275,7 +315,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FRR', u'FRR Developer\'s Manual', + (master_doc, 'FRR', u'FRR User Manual', author, 'FRR', 'One line description of project.', 'Miscellaneous'), ] @@ -291,3 +331,9 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +# custom extensions here +def setup(app): + # object type for FRR CLI commands, can be extended to document parent CLI + # node later on + app.add_object_type('clicmd', 'clicmd') From 76bd149987eeee4840b13fd405e5138c97bc2a22 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 31 Jan 2018 16:43:53 -0500 Subject: [PATCH 045/148] doc: remove trailing whitespace Signed-off-by: Quentin Young --- doc/developer/Building_FRR_on_Debian8.rst | 4 +-- doc/developer/Building_FRR_on_Debian9.rst | 2 +- doc/developer/Building_FRR_on_Fedora24.rst | 2 +- doc/developer/Building_FRR_on_FreeBSD10.rst | 2 +- doc/developer/Building_FRR_on_FreeBSD11.rst | 2 +- doc/developer/Building_FRR_on_FreeBSD9.rst | 2 +- doc/developer/Building_FRR_on_NetBSD6.rst | 2 +- doc/developer/Building_FRR_on_NetBSD7.rst | 2 +- doc/developer/Building_FRR_on_OmniOS.rst | 6 ++--- doc/developer/Building_FRR_on_OpenBSD6.rst | 4 +-- doc/developer/Building_FRR_on_Ubuntu1204.rst | 22 +++++++-------- doc/developer/Building_FRR_on_Ubuntu1404.rst | 18 ++++++------- doc/developer/Building_FRR_on_Ubuntu1604.rst | 4 +-- doc/developer/memtypes.rst | 2 +- doc/developer/next-hop-tracking.rst | 28 ++++++++++---------- doc/user/bgp.rst | 22 +++++++-------- doc/user/rpki.rst | 2 +- doc/user/vtysh.rst | 2 +- 18 files changed, 64 insertions(+), 64 deletions(-) diff --git a/doc/developer/Building_FRR_on_Debian8.rst b/doc/developer/Building_FRR_on_Debian8.rst index af24539cb6..cde9df31ad 100644 --- a/doc/developer/Building_FRR_on_Debian8.rst +++ b/doc/developer/Building_FRR_on_Debian8.rst @@ -23,7 +23,7 @@ Install newer pytest (>3.0) from pip :: - sudo pip install pytest + sudo pip install pytest Get FRR, compile it and install it (from Git) --------------------------------------------- @@ -74,7 +74,7 @@ an example.) --enable-fpm \ --enable-ldpd \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion make make check sudo make install diff --git a/doc/developer/Building_FRR_on_Debian9.rst b/doc/developer/Building_FRR_on_Debian9.rst index a3e3d7ff97..f16cf12dc6 100644 --- a/doc/developer/Building_FRR_on_Debian9.rst +++ b/doc/developer/Building_FRR_on_Debian9.rst @@ -62,7 +62,7 @@ an example.) --enable-fpm \ --enable-ldpd \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion make make check sudo make install diff --git a/doc/developer/Building_FRR_on_Fedora24.rst b/doc/developer/Building_FRR_on_Fedora24.rst index 5ba4dd0e5f..29c7ee7b0a 100644 --- a/doc/developer/Building_FRR_on_Fedora24.rst +++ b/doc/developer/Building_FRR_on_Fedora24.rst @@ -69,7 +69,7 @@ an example.) --enable-eigrpd \ --enable-babeld \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion make make check sudo make install diff --git a/doc/developer/Building_FRR_on_FreeBSD10.rst b/doc/developer/Building_FRR_on_FreeBSD10.rst index 94f2f27282..83e4513636 100644 --- a/doc/developer/Building_FRR_on_FreeBSD10.rst +++ b/doc/developer/Building_FRR_on_FreeBSD10.rst @@ -70,7 +70,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check sudo gmake install diff --git a/doc/developer/Building_FRR_on_FreeBSD11.rst b/doc/developer/Building_FRR_on_FreeBSD11.rst index de118093e6..ccd4596a75 100644 --- a/doc/developer/Building_FRR_on_FreeBSD11.rst +++ b/doc/developer/Building_FRR_on_FreeBSD11.rst @@ -70,7 +70,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check sudo gmake install diff --git a/doc/developer/Building_FRR_on_FreeBSD9.rst b/doc/developer/Building_FRR_on_FreeBSD9.rst index 2ccf56be13..b40696a095 100644 --- a/doc/developer/Building_FRR_on_FreeBSD9.rst +++ b/doc/developer/Building_FRR_on_FreeBSD9.rst @@ -83,7 +83,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check sudo gmake install diff --git a/doc/developer/Building_FRR_on_NetBSD6.rst b/doc/developer/Building_FRR_on_NetBSD6.rst index b4476127e3..c4292d7733 100644 --- a/doc/developer/Building_FRR_on_NetBSD6.rst +++ b/doc/developer/Building_FRR_on_NetBSD6.rst @@ -83,7 +83,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check sudo gmake install diff --git a/doc/developer/Building_FRR_on_NetBSD7.rst b/doc/developer/Building_FRR_on_NetBSD7.rst index e4ff1df8a5..6ce61d3871 100644 --- a/doc/developer/Building_FRR_on_NetBSD7.rst +++ b/doc/developer/Building_FRR_on_NetBSD7.rst @@ -74,7 +74,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check sudo gmake install diff --git a/doc/developer/Building_FRR_on_OmniOS.rst b/doc/developer/Building_FRR_on_OmniOS.rst index bc4ff45715..cd89f14e3c 100644 --- a/doc/developer/Building_FRR_on_OmniOS.rst +++ b/doc/developer/Building_FRR_on_OmniOS.rst @@ -14,7 +14,7 @@ Enable IP & IPv6 forwarding :: routeadm -e ipv4-forwarding - routeadm -e ipv6-forwarding + routeadm -e ipv6-forwarding Install required packages ------------------------- @@ -37,7 +37,7 @@ Add packages: library/idnkit/header-idnkit \ system/header \ system/library/math/header-math \ - git libtool gawk pkg-config + git libtool gawk pkg-config Add additional Solaris packages: @@ -128,7 +128,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check sudo gmake install diff --git a/doc/developer/Building_FRR_on_OpenBSD6.rst b/doc/developer/Building_FRR_on_OpenBSD6.rst index 0e51c8660c..b9bc19c070 100644 --- a/doc/developer/Building_FRR_on_OpenBSD6.rst +++ b/doc/developer/Building_FRR_on_OpenBSD6.rst @@ -69,7 +69,7 @@ an example) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion gmake gmake check doas gmake install @@ -106,7 +106,7 @@ Add the following lines to the end of ``/etc/rc.conf``: :: - net.inet6.ip6.forwarding=1 # 1=Permit forwarding of IPv6 packets + net.inet6.ip6.forwarding=1 # 1=Permit forwarding of IPv6 packets net.inet6.ip6.mforwarding=1 # 1=Permit forwarding of IPv6 multicast packets net.inet6.ip6.multipath=1 # 1=Enable IPv6 multipath routing diff --git a/doc/developer/Building_FRR_on_Ubuntu1204.rst b/doc/developer/Building_FRR_on_Ubuntu1204.rst index 935d199842..0ecfbe7365 100644 --- a/doc/developer/Building_FRR_on_Ubuntu1204.rst +++ b/doc/developer/Building_FRR_on_Ubuntu1204.rst @@ -27,13 +27,13 @@ source is too old) wget http://archive.ubuntu.com/ubuntu/pool/main/b/bison/bison_3.0.2.dfsg-2.dsc wget http://archive.ubuntu.com/ubuntu/pool/main/b/bison/bison_3.0.2.dfsg.orig.tar.bz2 wget http://archive.ubuntu.com/ubuntu/pool/main/b/bison/bison_3.0.2.dfsg-2.debian.tar.gz - tar -jxvf bison_3.0.2.dfsg.orig.tar.bz2 + tar -jxvf bison_3.0.2.dfsg.orig.tar.bz2 cd bison-3.0.2.dfsg/ - tar xzf ../bison_3.0.2.dfsg-2.debian.tar.gz + tar xzf ../bison_3.0.2.dfsg-2.debian.tar.gz sudo apt-get build-dep bison debuild -b -uc -us cd .. - sudo dpkg -i ./libbison-dev_3.0.2.dfsg-2_amd64.deb ./bison_3.0.2.dfsg-2_amd64.deb + sudo dpkg -i ./libbison-dev_3.0.2.dfsg-2_amd64.deb ./bison_3.0.2.dfsg-2_amd64.deb cd .. rm -rf builddir @@ -110,7 +110,7 @@ an example.) --enable-rtadv \ --enable-fpm \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion make make check sudo make install @@ -172,13 +172,13 @@ Enable daemons :: - zebra=yes - bgpd=yes - ospfd=yes - ospf6d=yes - ripd=yes - ripngd=yes - isisd=yes + zebra=yes + bgpd=yes + ospfd=yes + ospf6d=yes + ripd=yes + ripngd=yes + isisd=yes Start the init.d service ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/developer/Building_FRR_on_Ubuntu1404.rst b/doc/developer/Building_FRR_on_Ubuntu1404.rst index 4a4e38ea30..6fc2f8d79a 100644 --- a/doc/developer/Building_FRR_on_Ubuntu1404.rst +++ b/doc/developer/Building_FRR_on_Ubuntu1404.rst @@ -65,7 +65,7 @@ an example.) --enable-fpm \ --enable-ldpd \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion make make check sudo make install @@ -86,7 +86,7 @@ Create empty FRR configuration files sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ripngd.conf sudo install -m 640 -o frr -g frr /dev/null /etc/frr/pimd.conf sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ldpd.conf - sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf + sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf Enable IP & IPv6 forwarding @@ -124,13 +124,13 @@ Enable daemons :: - zebra=yes - bgpd=yes - ospfd=yes - ospf6d=yes - ripd=yes - ripngd=yes - isisd=yes + zebra=yes + bgpd=yes + ospfd=yes + ospf6d=yes + ripd=yes + ripngd=yes + isisd=yes Start the init.d service ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/developer/Building_FRR_on_Ubuntu1604.rst b/doc/developer/Building_FRR_on_Ubuntu1604.rst index dccc37adcc..3c6e1ee96f 100644 --- a/doc/developer/Building_FRR_on_Ubuntu1604.rst +++ b/doc/developer/Building_FRR_on_Ubuntu1604.rst @@ -65,7 +65,7 @@ an example.) --enable-fpm \ --enable-systemd=yes \ --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion + --with-pkg-extra-version=-MyOwnFRRVersion make make check sudo make install @@ -86,7 +86,7 @@ Create empty FRR configuration files sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ripngd.conf sudo install -m 640 -o frr -g frr /dev/null /etc/frr/pimd.conf sudo install -m 640 -o frr -g frr /dev/null /etc/frr/ldpd.conf - sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf + sudo install -m 640 -o frr -g frr /dev/null /etc/frr/nhrpd.conf sudo install -m 640 -o frr -g frrvty /dev/null /etc/frr/vtysh.conf Enable IPv4 & IPv6 forwarding diff --git a/doc/developer/memtypes.rst b/doc/developer/memtypes.rst index 62d211e864..d40ebe31cd 100644 --- a/doc/developer/memtypes.rst +++ b/doc/developer/memtypes.rst @@ -81,7 +81,7 @@ Definition >80% of cases. .. todo:: - + Daemons currently have ``daemon_memory.[ch]`` files listing all of their MTYPEs. This is not how it should be, most of these types should be moved into the appropriate files where they are used. diff --git a/doc/developer/next-hop-tracking.rst b/doc/developer/next-hop-tracking.rst index 1d65956f8c..284db1ef53 100644 --- a/doc/developer/next-hop-tracking.rst +++ b/doc/developer/next-hop-tracking.rst @@ -155,7 +155,7 @@ The next hop registration control flow is the following: | | register() | | | | zebra_add_rnh() | | | - + The next hop notification control flow is the following: @@ -201,7 +201,7 @@ encoded in the following way: . Nexthop prefix . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - + ``ZEBRA_NEXTHOP_UPDATE`` message is encoded as follows: @@ -240,12 +240,12 @@ Legend: /\ struct bgp_node: a BGP destination/route/prefix \/ - + [ ] struct bgp_info: a BGP path (e.g. route received from a peer) - + _ (_) struct bgp_nexthop_cache: a BGP nexthop - + /\ NULL \/--+ ^ | : @@ -300,33 +300,33 @@ User interface changes resolved via kernel via 10.0.1.2, eth0 Client list: bgp(fd 12) - + frr# show ip bgp nexthop Current BGP nexthop cache: 3.3.3.3 valid [IGP metric 0], #paths 3 Last update: Wed Oct 16 04:43:49 2013 - + 11.0.0.10 valid [IGP metric 1], #paths 1 Last update: Wed Oct 16 04:43:51 2013 - + 11.0.0.18 valid [IGP metric 1], #paths 2 Last update: Wed Oct 16 04:43:47 2013 - + 11.11.11.11 valid [IGP metric 0], #paths 1 Last update: Wed Oct 16 04:43:47 2013 - + frr# show ipv6 nht frr# show ip bgp nexthop detail - + frr# debug bgp nht frr# debug zebra nht - + 6. Sample test cases - + r2----r3 / \ / r1----r4 - + - Verify that a change in IGP cost triggers NHT + shutdown the r1-r4 and r2-r4 links + no shut the r1-r4 and r2-r4 links and wait for OSPF to come back diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 06f124679f..a29f22bbde 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -639,15 +639,15 @@ Defining Peer Creates a new neighbor whose remote-as is ASN. PEER can be an IPv4 address or an IPv6 address.:: - + router bgp 1 neighbor 10.0.0.1 remote-as 2 - + In this case my router, in AS-1, is trying to peer with AS-2 at 10.0.0.1. - + This command must be the first command used when configuring a neighbor. If the remote-as is not specified, *bgpd* will complain like this::: - + can't find neighbor 10.0.0.1 @@ -1066,14 +1066,14 @@ expanded community list. specified the specified community list's information is shown. :: - + # show ip community-list Named Community standard list CLIST permit 7675:80 7675:100 no-export deny internet Named Community expanded list EXPAND permit : - + # show ip community-list CLIST Named Community standard list CLIST permit 7675:80 7675:100 no-export @@ -1567,14 +1567,14 @@ Showing BGP information display all of IPv4 BGP routes. :: - + BGP table version is 0, local router ID is 10.1.1.1 Status codes: s suppressed, d damped, h history, * valid, > best, i - internal Origin codes: i - IGP, e - EGP, ? - incomplete - + Network Next Hop Metric LocPrf Weight Path \*> 1.1.1.1/32 0.0.0.0 0 32768 i - + Total number of prefixes 1 @@ -1863,7 +1863,7 @@ same time when BGP multiple instance feature is enabled. Make a new BGP instance. You can use arbitrary word for the `name`. :: - + bgp multiple-instance ! router bgp 1 @@ -1888,7 +1888,7 @@ only for exchanging BGP routing information. With this command, you can setup Route Server like below. :: - + bgp multiple-instance ! router bgp 1 view 1 diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index f3e8a85bb7..0889d6966a 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -165,7 +165,7 @@ Validating BGP Updates prefixes because invalid routes have a lower local preference. :: - + ! Allow for invalid routes in route selection process route bgp 60001 ! diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst index eeb856cbd4..089540d589 100644 --- a/doc/user/vtysh.rst +++ b/doc/user/vtysh.rst @@ -160,4 +160,4 @@ in whose file the error is made. configuration (either in its individual configuration file, or in :file:`frr.conf`). This is particularly troublesome for route-maps and prefix lists, which would otherwise be synchronized between daemons. - + From 4b44467c9e3de149a94b504eb8a2e228d303ad2e Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 31 Jan 2018 16:55:12 -0500 Subject: [PATCH 046/148] doc: remove last bits of texinfo directives Signed-off-by: Quentin Young --- doc/user/bgp.rst | 69 +++++++++++++++++++------------------------- doc/user/defines.rst | 24 --------------- doc/user/vnc.rst | 13 +++------ 3 files changed, 33 insertions(+), 73 deletions(-) delete mode 100644 doc/user/defines.rst diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index a29f22bbde..a4c141fd32 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -279,16 +279,7 @@ and sometimes not, depending on the properties of those other routes, means MED can cause the order of preference over all the routes to be undefined. That is, given routes A, B, and C, if A is preferred to B, and B is preferred to C, then a well-defined order should mean the preference is transitive (in the sense of -orders @footnote{For some set of objects to have an order, there *must* be some -binary ordering relation that is defined for *every* combination of those -objects, and that relation *must* be transitive. I.e.@:, if the relation -operator is <, and if a < b and b < c then that relation -must carry over and it *must* be that a < c for the objects to have an -order. The ordering relation may allow for equality, i.e. a < b and b -< a may both be true amd imply that a and b are equal in the order and -not distinguished by it, in which case the set has a partial order. Otherwise, -if there is an order, all the objects have a distinct place in the order and -the set has a total order) and that A would be preferred to C. +orders [#med-transitivity-rant])_ and that A would be preferred to C. However, when MED is involved this need not be the case. With MED it is possible that C is actually preferred over A. So A is preferred to B, B is @@ -432,7 +423,7 @@ complex, non-full-mesh, iBGP topologies may be avoided either by: - Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared across values set by different neighbour ASes, which may not produce coherent desirable results, of itself. -- Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using +- Effectively ignoring MED by setting MED to the same value (e.g.: 0) using :ref:`routemap_set_metric` on all received routes, in combination with setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest and most performant way to avoid MED oscillation issues, where an AS is happy @@ -1667,39 +1658,36 @@ Other BGP commands Capability Negotiation ====================== -When adding IPv6 routing information exchange feature to BGP. There -were some proposals. :abbr:`IETF (Internet Engineering Task Force)` -:abbr:`IDR ( Inter Domain Routing)` :abbr:`IDR ( Inter Domain Routing)` adopted -a proposal called Multiprotocol Extension for BGP. The specification -is described in :rfc:`2283`. The protocol does not define new protocols. -It defines new attributes to existing BGP. When it is used exchanging -IPv6 routing information it is called BGP-4+. When it is used for -exchanging multicast routing information it is called MBGP. +When adding IPv6 routing information exchange feature to BGP. There were some +proposals. :abbr:`IETF (Internet Engineering Task Force)` :abbr:`IDR ( Inter +Domain Routing)` :abbr:`IDR ( Inter Domain Routing)` adopted a proposal called +Multiprotocol Extension for BGP. The specification is described in :rfc:`2283`. +The protocol does not define new protocols. It defines new attributes to +existing BGP. When it is used exchanging IPv6 routing information it is called +BGP-4+. When it is used for exchanging multicast routing information it is +called MBGP. -*bgpd* supports Multiprotocol Extension for BGP. So if remote -peer supports the protocol, *bgpd* can exchange IPv6 and/or -multicast routing information. +*bgpd* supports Multiprotocol Extension for BGP. So if remote peer supports the +protocol, *bgpd* can exchange IPv6 and/or multicast routing information. -Traditional BGP did not have the feature to detect remote peer's -capabilities, e.g. whether it can handle prefix types other than IPv4 -unicast routes. This was a big problem using Multiprotocol Extension -for BGP to operational network. @cite{RFC2842, Capabilities -Advertisement with BGP-4} adopted a feature called Capability -Negotiation. *bgpd* use this Capability Negotiation to detect -the remote peer's capabilities. If the peer is only configured as IPv4 -unicast neighbor, *bgpd* does not send these Capability -Negotiation packets (at least not unless other optional BGP features -require capability negotation). +Traditional BGP did not have the feature to detect remote peer's capabilities, +e.g. whether it can handle prefix types other than IPv4 unicast routes. This +was a big problem using Multiprotocol Extension for BGP to operational network. +:rfc:`2842` adopted a feature called Capability Negotiation. *bgpd* use this +Capability Negotiation to detect the remote peer's capabilities. If the peer is +only configured as IPv4 unicast neighbor, *bgpd* does not send these Capability +Negotiation packets (at least not unless other optional BGP features require +capability negotation). -By default, FRR will bring up peering with minimal common capability -for the both sides. For example, local router has unicast and -multicast capabilitie and remote router has unicast capability. In -this case, the local router will establish the connection with unicast -only capability. When there are no common capabilities, FRR sends -Unsupported Capability error and then resets the connection. +By default, FRR will bring up peering with minimal common capability for the +both sides. For example, local router has unicast and multicast capabilitie and +remote router has unicast capability. In this case, the local router will +establish the connection with unicast only capability. When there are no common +capabilities, FRR sends Unsupported Capability error and then resets the +connection. -If you want to completely match capabilities with remote peer. Please -use *strict-capability-match* command. +If you want to completely match capabilities with remote peer. Please use +*strict-capability-match* command. .. index:: neighbor PEER strict-capability-match .. clicmd:: neighbor PEER strict-capability-match @@ -2330,6 +2318,7 @@ Server. .. include:: rpki.rst +.. [#med-transitivity-rant] For some set of objects to have an order, there *must* be some binary ordering relation that is defined for *every* combination of those objects, and that relation *must* be transitive. I.e.:, if the relation operator is <, and if a < b and b < c then that relation must carry over and it *must* be that a < c for the objects to have an order. The ordering relation may allow for equality, i.e. a < b and b < a may both be true amd imply that a and b are equal in the order and not distinguished by it, in which case the set has a partial order. Otherwise, if there is an order, all the objects have a distinct place in the order and the set has a total order) .. [bgp-route-osci-cond] McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation Condition", IETF RFC3345 .. [stable-flexible-ibgp] Flavel, A. and M. Roughan, "Stable and flexible iBGP", ACM SIGCOMM 2009 .. [ibgp-correctness] Griffin, T. and G. Wilfong, "On the correctness of IBGP configuration", ACM SIGCOMM 2002 diff --git a/doc/user/defines.rst b/doc/user/defines.rst deleted file mode 100644 index 69766d3da4..0000000000 --- a/doc/user/defines.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. These are substitutions that were used in the original Texinfo docs. - They need to be recreated in RST by way of rst_prolog or a common include. - That, in turn, needs to be generated by make at compile time. - @c -*- texinfo -*- - @c doc/defines.texi. Generated from defines.texi.in by configure. - - @c Set variables - @set PACKAGE_NAME frr - @set PACKAGE_TARNAME frr - @set PACKAGE_STRING frr 3.1-dev - @set PACKAGE_URL https://frrouting.org/ - @set PACKAGE_VERSION 3.1-dev - @set AUTHORS Kunihiro Ishiguro, et al. - @set COPYRIGHT_YEAR 1999-2005 - @set COPYRIGHT_STR Copyright @copyright{} |COPYRIGHT_YEAR| |AUTHORS| - - @c These may vary with installation environment. - @set INSTALL_PREFIX_ETC /etc/frr - @set INSTALL_PREFIX_SBIN /usr/lib/frr - @set INSTALL_PREFIX_STATE /var/run/frr - @set INSTALL_PREFIX_MODULES /usr/lib/frr/modules - @set INSTALL_USER frr - @set INSTALL_GROUP frr - @set INSTALL_VTY_GROUP frrvty diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index bd2fdb34f1..62091822b9 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -909,11 +909,10 @@ services to three NVE clients in the 172.16.0.0/16 virtual-network address range. The 172.16.0.0/16 address range is partitioned into two NVE groups, ``group1`` (172.16.0.0/17) and ``group2`` (172.16.128.0/17). -Each NVE belongs to either NVE group ``group1`` or NVE group -``group2``. The NVEs ``NVE 1``, ``NVE 2``, @code{NVE -4}, ``NVE 7``, and ``NVE 8`` are members of the NVE group -``group1``. The NVEs ``NVE 3``, ``NVE 5``, @code{NVE -6}, and ``NVE 9`` are members of the NVE group ``group2``. +Each NVE belongs to either NVE group ``group1`` or NVE group ``group2``. The +NVEs ``NVE 1``, ``NVE 2``, ``NVE 4``, ``NVE 7``, and ``NVE 8`` are members of +the NVE group ``group1``. The NVEs ``NVE 3``, ``NVE 5``, ``NVE 6``, and ``NVE +9`` are members of the NVE group ``group2``. Each NVA advertises NVE underlay-network IP addresses using the Tunnel Encapsulation Attribute. @@ -1134,10 +1133,6 @@ as the hub between NVAs. :ref:`vnc-fig-vnc-frr-route-reflector` shows BGP route reflector ``BGP Route Reflector 1`` (192.168.1.100) as a route reflector for NVAs ``NVA 2``(192.168.1.101) and ``NVA 3`` (192.168.1.102). -@float Figure,fig:fig-vnc-frr-route-reflector @center -@image{fig-vnc-frr-route-reflector,400pt,,Frr Route Reflector} @caption{Two -NVAs and a BGP Route Reflector} @end float - .. _vnc-fig-vnc-frr-route-reflector: .. figure:: ../figures/fig-vnc-frr-route-reflector.png :align: center From 82b7ec1da7e7a491e1ef5b52bbf344d50ceb5507 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 31 Jan 2018 17:31:17 -0500 Subject: [PATCH 047/148] *: update configure.ac, Makefiles for new manpages Signed-off-by: Quentin Young --- configure.ac | 17 ---- doc/Makefile.am | 186 +++++++++------------------------------- doc/manpages/.gitignore | 3 + doc/manpages/Makefile | 25 ++++++ 4 files changed, 70 insertions(+), 161 deletions(-) create mode 100644 doc/manpages/.gitignore create mode 100644 doc/manpages/Makefile diff --git a/configure.ac b/configure.ac index a3b38559e5..0c96546c8e 100755 --- a/configure.ac +++ b/configure.ac @@ -1875,23 +1875,6 @@ AC_CONFIG_FILES([Makefile snapcraft/snapcraft.yaml lib/version.h tests/lib/cli/test_cli.refout - doc/defines.texi - doc/bgpd.8 - doc/isisd.8 - doc/ospf6d.8 - doc/ospfclient.8 - doc/ospfd.8 - doc/ldpd.8 - doc/ripd.8 - doc/eigrpd.8 - doc/ripngd.8 - doc/pimd.8 - doc/nhrpd.8 - doc/vtysh.1 - doc/watchfrr.8 - doc/zebra.8 - doc/frr.1 - doc/frr-args.8 pkgsrc/bgpd.sh pkgsrc/ospf6d.sh pkgsrc/ospfd.sh pkgsrc/ripd.sh pkgsrc/ripngd.sh pkgsrc/zebra.sh pkgsrc/eigrpd.sh]) diff --git a/doc/Makefile.am b/doc/Makefile.am index 7aaa36556f..8c7efed09b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,192 +1,90 @@ ## Process this file with automake to produce Makefile.in. -# Dia, the version i have at least, doesn't do very good EPS output -# (some of the text is scaled strangely). So this will work, but -# it is probably better to use something like gimp to convert the -# dia exported PNG files to EPS manually. -# -# Here we use 'convert' from the well known 'ImageMagick' package -# to do conversion from png to eps/pdf for figures. -# PDF form is required for frr.pdf, using PDFTex at least. -# -# TeX implementation, which we depend on already anyway. -# -# dia -> (dia) -> png -> (convert) -> eps -> (epstopdf) -> pdf -SUFFIXES = .png .eps .dia .pdf -DIATOPNG = dia -t png -e -DIATOEPS = dia -t eps -e -PNGTOEPS = convert -antialias -contrast -despeckle -PNGTOPDF = $(PNGTOEPS) -EPSTOPDF = epstopdf +# Tell Automake to invoke 'make' in the manpages directory with argument 'man' +SUBDIRS = manpages +AM_MAKEFLAGS = man -VNCFIGURES_PNG = -VNCFIGURES_DIA = -vnc-mesh -vnc-frr-route-reflector \ --vnc-commercial-route-reflector -vnc-redundant-route-reflectors \ --vnc-gw -vnc-gw-rr +MANPAGE_BUILDDIR = manpages/_build/man -# TODO: A target that creates an empty text file for each member of -# VNCFIGURES_TXT -VNCFIGURES_TXT = $(VNCFIGURES:%.png=%.txt) - -# The figure sources -figures_names_parts = -normal-processing -rs-processing \ - _topologies_full _topologies_rs \ - $(VNCFIGURES_DIA) - -figures_sources = $(figures_names_parts:%=fig%.dia) -figures_png = $(figures_names_parts:%=fig%.png) $(VNCFIGURES_PNG) -figures_pdf = $(figures_names_parts:%=fig%.pdf) $(VNCFIGURES_PNG:%.png=%.pdf) -figures_eps = $(figures_names_parts:%=fig%.eps) $(VNCFIGURES_PNG:%.png=%.eps) -figures_txt = $(figures_names_parts:%=fig%.txt) - -# rather twisted logic because we have to build PDFs of the EPS figures for -# PDFTex and yet build one PDF, frr.pdf, from texi source. Which means we -# cant rely on a single automatic rule for *.pdf, eg the one automatically -# provided by automake. If you are an automake wizard, please feel free to -# compact it somehow. - -info_TEXINFOS = frr.texi - -# Have to manually specify the frr.pdf rule in order to allow -# us to have a generic automatic .pdf rule to build the figure sources -# because it cant just work from the png's directly it seems - contrary -# to the documentation... -frr.pdf: $(info_TEXINFOS) $(figures_pdf) $(frr_TEXINFOS) defines.texi - $(TEXI2PDF) -o "$@" $< || true - -# don't ask me why the info file is in srcdir -$(srcdir)/frr.info: $(frr_TEXINFOS) defines.texi -frr.dvi: $(frr_TEXINFOS) defines.texi -frr.html: $(frr_TEXINFOS) defines.texi - -frr_TEXINFOS = \ - appendix.texi \ - basic.texi \ - bgpd.texi \ - isisd.texi \ - filter.texi \ - vnc.texi \ - babeld.texi \ - install.texi \ - ipv6.texi \ - kernel.texi \ - main.texi \ - nhrpd.texi \ - eigrpd.texi \ - ospf6d.texi \ - ospfd.texi \ - overview.texi \ - protocol.texi \ - ripd.texi \ - ripngd.texi \ - routemap.texi \ - snmp.texi \ - vtysh.texi \ - routeserver.texi \ - $(figures_png) \ - snmptrap.texi \ - ospf_fundamentals.texi \ - isisd.texi $(figures_txt) \ - rpki.texi \ - pimd.texi \ - #END - -.png.eps: - $(PNGTOEPS) $< "$@" - -.png.pdf: - $(PNGTOPDF) $< "$@" - -.dia.png: - $(DIATOPNG) "$@" $< - -man_MANS = frr.1 frr-args.8 +# Once that is done these will all exist +man_MANS = $(MANPAGE_BUILDDIR)/frr.1 if PIMD -man_MANS += pimd.8 +man_MANS += $(MANPAGE_BUILDDIR)/pimd.8 endif if BGPD -man_MANS += bgpd.8 +man_MANS += $(MANPAGE_BUILDDIR)/bgpd.8 endif if ISISD -man_MANS += isisd.8 +man_MANS += $(MANPAGE_BUILDDIR)/isisd.8 endif if OSPF6D -man_MANS += ospf6d.8 +man_MANS += $(MANPAGE_BUILDDIR)/ospf6d.8 endif if OSPFCLIENT -man_MANS += ospfclient.8 +man_MANS += $(MANPAGE_BUILDDIR)/ospfclient.8 endif if OSPFD -man_MANS += ospfd.8 +man_MANS += $(MANPAGE_BUILDDIR)/ospfd.8 endif if LDPD -man_MANS += ldpd.8 +man_MANS += $(MANPAGE_BUILDDIR)/ldpd.8 endif if RIPD -man_MANS += ripd.8 +man_MANS += $(MANPAGE_BUILDDIR)/ripd.8 endif if RIPNGD -man_MANS += ripngd.8 +man_MANS += $(MANPAGE_BUILDDIR)/ripngd.8 endif if NHRPD -man_MANS += nhrpd.8 +man_MANS += $(MANPAGE_BUILDDIR)/nhrpd.8 endif if VTYSH -man_MANS += vtysh.1 +man_MANS += $(MANPAGE_BUILDDIR)/vtysh.1 endif if WATCHFRR -man_MANS += watchfrr.8 +man_MANS += $(MANPAGE_BUILDDIR)/watchfrr.8 endif if ZEBRA -man_MANS += zebra.8 +man_MANS += $(MANPAGE_BUILDDIR)/zebra.8 endif if EIGRPD -man_MANS += eigrpd.8 +man_MANS += $(MANPAGE_BUILDDIR)/eigrpd.8 endif -EXTRA_DIST = BGP-TypeCode draft-zebra-00.ms draft-zebra-00.txt \ - \ - bgpd.8.in \ - isisd.8.in \ - ospf6d.8.in \ - ospfclient.8.in \ - ospfd.8.in \ - ldpd.8.in \ - ripd.8.in \ - ripngd.8.in \ - pimd.8.in \ - nhrpd.8.in \ - vtysh.1.in \ - watchfrr.8.in \ - zebra.8.in \ - frr.1.in \ - eigrpd.8.in \ - \ - mpls/ChangeLog.opaque.txt mpls/cli_summary.txt \ - mpls/opaque_lsa.txt mpls/ospfd.conf \ - $(figures_sources) $(figures_png) $(figures_txt) +# handled by subdir target +man: ; -draft-zebra-00.txt: draft-zebra-00.ms - groff -T ascii -ms $< > $@ - -# Ensure that all of the figures are copied into the html directory -html-local: $(HTMLS) - if test -d $(HTMLS) ; then \ - cp -p $(figures_png) $(HTMLS) ; \ - else \ - echo "$(HTMLS) is not a directory. Make it so, the rerun make."; \ - fi +# include sources for shipped docs +EXTRA_DIST = manpages/defines.txt \ + manpages/ldpd.rst \ + manpages/index.rst \ + manpages/bgpd.rst \ + manpages/watchfrr.rst \ + manpages/ospfclient.rst \ + manpages/ripd.rst \ + manpages/zebra.rst \ + manpages/epilogue.rst \ + manpages/eigrpd.rst \ + manpages/isisd.rst \ + manpages/ospf6d.rst \ + manpages/common-options.rst \ + manpages/ospfd.rst \ + manpages/vtysh.rst \ + manpages/nhrpd.rst \ + manpages/pimd.rst \ + manpages/ripngd.rst \ + manpages/frr.rst diff --git a/doc/manpages/.gitignore b/doc/manpages/.gitignore new file mode 100644 index 0000000000..0505537159 --- /dev/null +++ b/doc/manpages/.gitignore @@ -0,0 +1,3 @@ +/_templates +/_build +!/Makefile diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile new file mode 100644 index 0000000000..fa10577844 --- /dev/null +++ b/doc/manpages/Makefile @@ -0,0 +1,25 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = FRR +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile all check install + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + echo "invoking: $(SPHINXBUILD) -M $@ $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)" + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +all: ; +check: ; +install: ; From 7bed2c99762f1fca0cbae1b7179393bf0a1734d2 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Feb 2018 13:23:18 -0500 Subject: [PATCH 048/148] doc: add targets for user & developer pdf + html Signed-off-by: Quentin Young --- doc/Makefile.am | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/Makefile.am b/doc/Makefile.am index 8c7efed09b..a1f619ade7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -68,6 +68,18 @@ endif # handled by subdir target man: ; +FRR.pdf: + $(MAKE) -C user latexpdf + +developer.pdf: + $(MAKE) -C developer latexpdf + +FRR.html: + $(MAKE) -C user html + +developer.html: + $(MAKE) -C developer html + # include sources for shipped docs EXTRA_DIST = manpages/defines.txt \ manpages/ldpd.rst \ From 013f9762db7b5f9a4570971f917f4a0857188f42 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Feb 2018 16:10:11 -0500 Subject: [PATCH 049/148] doc: fixup some build warnings Signed-off-by: Quentin Young --- doc/user/bgp.rst | 15 +++---- doc/user/conf.py | 2 +- doc/user/eigrpd.rst | 11 +---- doc/user/index.rst | 22 +++++----- doc/user/installation.rst | 4 ++ doc/user/isisd.rst | 6 ++- doc/user/ospf_fundamentals.rst | 10 ++--- doc/user/overview.rst | 18 ++++----- doc/user/routemap.rst | 73 ++++++++++++++++------------------ doc/user/zebra.rst | 32 ++++++++------- 10 files changed, 96 insertions(+), 97 deletions(-) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index a4c141fd32..d02973f28d 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -279,7 +279,7 @@ and sometimes not, depending on the properties of those other routes, means MED can cause the order of preference over all the routes to be undefined. That is, given routes A, B, and C, if A is preferred to B, and B is preferred to C, then a well-defined order should mean the preference is transitive (in the sense of -orders [#med-transitivity-rant])_ and that A would be preferred to C. +orders [#med-transitivity-rant]_) and that A would be preferred to C. However, when MED is involved this need not be the case. With MED it is possible that C is actually preferred over A. So A is preferred to B, B is @@ -409,7 +409,7 @@ induce; in general on arbitrary networks. There may be iBGP topology specific ways to reduce the instability risks, even while using MED, e.g.: by constraining the reflection topology and by tuning -IGP costs between route-reflector clusters, see RFC3345 for details. In the +IGP costs between route-reflector clusters, see :rfc:`3345` for details. In the near future, the Add-Path extension to BGP may also solve MED oscillation while still allowing MED to be used as intended, by distributing "best-paths per neighbour AS". This would be at the cost of distributing at least as many @@ -420,12 +420,12 @@ Add-Path reflector. More generally, the instability problems that MED can introduce on more complex, non-full-mesh, iBGP topologies may be avoided either by: -- Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared +- Setting :clicmd:`bgp always-compare-med`, however this allows MED to be compared across values set by different neighbour ASes, which may not produce coherent desirable results, of itself. - Effectively ignoring MED by setting MED to the same value (e.g.: 0) using - :ref:`routemap_set_metric` on all received routes, in combination with - setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest + :clicmd:`set metric METRIC` on all received routes, in combination with + setting :clicmd:`bgp always-compare-med` on all speakers. This is the simplest and most performant way to avoid MED oscillation issues, where an AS is happy not to allow neighbours to inject this problematic metric. @@ -443,6 +443,7 @@ paper above for an example. Hence the guideline that the iBGP topology should follow the IGP topology. .. _bgp_deterministic-med: + .. index:: bgp deterministic-med .. clicmd:: bgp deterministic-med @@ -463,11 +464,11 @@ Note that there are other sources of indeterminism in the route selection process, specifically, the preference for older and already selected routes from eBGP peers, :ref:`BGP_decision_process`. +.. _bgp_always-compare-med: + .. index:: bgp always-compare-med .. clicmd:: bgp always-compare-med -.. _bgp_always-compare-med: - Always compare the MED on routes, even when they were received from different neighbouring ASes. Setting this option makes the order of preference of routes more defined, and should eliminate MED induced diff --git a/doc/user/conf.py b/doc/user/conf.py index 1eac6af763..b0bcb2ed43 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -123,7 +123,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', 'rpki.rst', 'ospf_fundamentals.rst'] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index 7c2c55d166..7c8109fa97 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -188,19 +188,10 @@ How to Announce EIGRP route Show EIGRP Information ====================== -To display EIGRP routes. - .. index:: show ip eigrp topology .. clicmd:: show ip eigrp topology - Show EIGRP routes. - -The command displays all EIGRP routes. - -.. index:: show ip eigrp topology -.. clicmd:: show ip eigrp topology - - The command displays current EIGRP status + Display current EIGRP status. :: diff --git a/doc/user/index.rst b/doc/user/index.rst index 0929fb51ad..036c87c86e 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -7,22 +7,24 @@ Welcome to FRR's documentation! overview installation basic - zebra - ripd - ripngd - ospfd - ospf6d - isisd - nhrpd - bgp - babeld - vnc vtysh filter routemap ipv6 kernel snmp + zebra protocol + bgp + babeld + eigrpd + isisd + nhrpd + ospfd + ospf6d pim + ripd + ripngd + vnc + appendix diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 356d243e47..471448d004 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -166,6 +166,10 @@ customize the build to include or exclude specific features and dependencies. Build without VTYSH. +.. option:: --enable-fpm + + Build with FPM module support. + You may specify any combination of the above options to the configure script. By default, the executables are placed in :file:`/usr/local/sbin` and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/` diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 1dffc2cf8f..50592cc21b 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -410,8 +410,6 @@ Showing ISIS information Show the ISIS routing table, as determined by the most recent SPF calculation. -.. _ospf-traffic-engineering: - Traffic Engineering =================== @@ -444,6 +442,10 @@ Traffic Engineering Show Traffic Engineering router parameters. +.. seealso:: + + :ref:`ospf-traffic-engineering` + .. _Debugging_ISIS: Debugging ISIS diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index ac9a343ad5..d01fd74984 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -73,8 +73,8 @@ The Hello Protocol The OSPF Hello protocol allows OSPF to quickly detect changes in two-way reachability between routers on a link. OSPF can additionally avail of other sources of reachability information, such as link-state information provided by -hardware, or through dedicated reachability protocols such as :abbr:`BFD -(Bidirectional Forwarding Detection)`. +hardware, or through dedicated reachability protocols such as +:abbr:`BFD (Bidirectional Forwarding Detection)`. OSPF also uses the Hello protocol to propagate certain state between routers sharing a link, for example: @@ -118,7 +118,7 @@ LSA Flooding """""""""""" OSPF defines several related mechanisms, used to manage synchronisation of -:abbr:`LSDB`s between neighbours as neighbours form adjacencies and the +:abbr:`LSDB` s between neighbours as neighbours form adjacencies and the propogation, or :term:`flooding` of new or updated :abbr:`LSA` s. :ref:`OSPF_Flooding`. @@ -191,7 +191,7 @@ All LSAs share a common header with the following information: - Age A number to allow stale :abbr:`LSA` s to, eventually, be purged by routers - from their :abbr:`LSDB`s. + from their :abbr:`LSDB` s. The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is called the :term:`MaxAge`. MaxAge LSAs are ignored in routing @@ -540,6 +540,6 @@ like::: Summary LSAs ^^^^^^^^^^^^ -Summary LSAs are created by :abbr:`ABR`s to summarise the destinations +Summary LSAs are created by :abbr:`ABR` s to summarise the destinations available within one area to other areas. These LSAs may describe IP networks, potentially in aggregated form, or :abbr:`ASBR` routers. diff --git a/doc/user/overview.rst b/doc/user/overview.rst index 2b5e2f9b2b..c3549417d7 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -262,13 +262,12 @@ Italicized lists are private. +--------------------------------+------------------------------+ The Development list is used to discuss and document general issues related to -project development and governance. The public `Slack instance -`_, and weekly technical meetings provide a higher -bandwidth channel for discussions. The results of such discussions are -reflected in updates, as appropriate, to code (i.e., merges), `GitHub -`_ tracked issues, and for governance -or process changes, updates to the Development list and either this file or -information posted at https://frrouting.org/. +project development and governance. The public `Slack`_ instance and weekly +technical meetings provide a higher bandwidth channel for discussions. The +results of such discussions are reflected in updates, as appropriate, to code +(i.e., merges), `GitHub issues`_ tracked issues, and for governance or process +changes, updates to the Development list and either this file or information +posted at `FRR`_. .. index:: Bug Reports .. index:: Bug hunting @@ -298,5 +297,6 @@ When you send a bug report, please be careful about the points below. Bug reports help us improve FRR and are very much appreciated. .. _FRR: |PACKAGE_URL| -.. _GitHub: http://github.com/frrouting/frr/ -.. _GitHub issues: http://github.com/frrouting/frr/ +.. _GitHub: https://github.com/frrouting/frr/ +.. _GitHub issues: https://github.com/frrouting/frr/issues +.. _Slack: https://frrouting.slack.com/ diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 735838b0e6..471a286283 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -10,52 +10,49 @@ allowing policy to be applied to routes. Route maps are an ordered list of route map entries. Each entry may specify up to four distincts sets of clauses: -- :dfn:`Matching Policy` +.. glossary:: - This specifies the policy implied if the *Matching Conditions* are - met or not met, and which actions of the route-map are to be taken, if - any. The two possibilities are: + Matching Conditions + A route-map entry may, optionally, specify one or more conditions which + must be matched if the entry is to be considered further, as governed by + the Match Policy. If a route-map entry does not explicitely specify any + matching conditions, then it always matches. - - :dfn:`permit`: If the entry matches, then carry out the :term:`Set - Actions`. Then finish processing the route-map, permitting the route, - unless an *Exit Action* indicates otherwise. + Set Actions + A route-map entry may, optionally, specify one or more Set Actions to set + or modify attributes of the route. - - :dfn:`deny`: If the entry matches, then finish processing the route-map and - deny the route (return ``deny``). + Matching Policy + This specifies the policy implied if the :term:`Matching Conditions` are + met or not met, and which actions of the route-map are to be taken, if + any. The two possibilities are: - The *Matching Policy* is specified as part of the command which - defines the ordered entry in the route-map. See below. + - :dfn:`permit`: If the entry matches, then carry out the + :term:`Set Actions`. Then finish processing the route-map, permitting + the route, unless an :term:`Exit Policy` action indicates otherwise. -- :dfn:`Matching Conditions` + - :dfn:`deny`: If the entry matches, then finish processing the route-map and + deny the route (return `deny`). - A route-map entry may, optionally, specify one or more conditions which must - be matched if the entry is to be considered further, as governed by the Match - Policy. If a route-map entry does not explicitely specify any matching - conditions, then it always matches. + The `Matching Policy` is specified as part of the command which defines + the ordered entry in the route-map. See below. -- :dfn:`Set Actions` + Call Action + Call to another route-map, after any :term:`Set Actions` have been carried out. + If the route-map called returns `deny` then processing of the route-map + finishes and the route is denied, regardless of the :term:Matching Policy` or + the :term:`Exit Policy`. If the called route-map returns `permit`, then + :term:`Matching Policy` and :term:`Exit Policy` govern further behaviour, as normal. - A route-map entry may, optionally, specify one or more *Set Actions* to - set or modify attributes of the route. + Exit Policy + An entry may, optionally, specify an alternative :dfn:`Exit Policy` to + take if the entry matched, rather than the normal policy of exiting the + route-map and permitting the route. The two possibilities are: -- :dfn:`Call Action` + - :dfn:`next`: Continue on with processing of the route-map entries. - Call to another route-map, after any *Set Actions* have been carried out. - If the route-map called returns *deny* then processing of the route-map - finishes and the route is denied, regardless of the *Matching Policy* or - the *Exit Policy*. If the called route-map returns *permit*, then - *Matching Policy* and *Exit Policy* govern further behaviour, as normal. - -- :dfn:`Exit Policy` - - An entry may, optionally, specify an alternative *Exit Policy* to - take if the entry matched, rather than the normal policy of exiting the - route-map and permitting the route. The two possibilities are: - - - :dfn:`next`: Continue on with processing of the route-map entries. - - - :dfn:`goto N`: Jump ahead to the first route-map entry whose order in - the route-map is >= N. Jumping to a previous entry is not permitted. + - :dfn:`goto N`: Jump ahead to the first route-map entry whose order in + the route-map is >= N. Jumping to a previous entry is not permitted. The default action of a route-map, if no entries match, is to deny. I.e. a route-map essentially has as its last entry an empty *deny* entry, which @@ -188,11 +185,11 @@ Route Map Match Command Route Map Set Command ===================== +.. program:: configure + .. index:: set tag TAG .. clicmd:: set tag TAG -.. program:: configure - Set a tag on the matched route. This tag value can be from (1-4294967295). Additionally if you have compiled with the :option:`--enable-realms` configure option. Tag values from (1-255) are sent to the Linux kernel as a diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index b04b8c7365..4f1692e58c 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -34,6 +34,8 @@ Besides the common invocation options (:ref:`Common_Invocation_Options`), the When program terminates, retain routes added by zebra. +.. program:: configure + .. _Interface_Commands: Interface Commands @@ -444,28 +446,28 @@ longer-prefix zebra Route Filtering ===================== -Zebra supports :dfn:`prefix-list`s and :ref:`Route_Map`s to match routes -received from other frr components. The permit/deny facilities provided by +Zebra supports :dfn:`prefix-list` s and :ref:`Route_Map` s to match routes +received from other FRR components. The permit/deny facilities provided by these commands can be used to filter which routes zebra will install in the kernel. .. index:: ip protocol PROTOCOL route-map ROUTEMAP .. clicmd:: ip protocol PROTOCOL route-map ROUTEMAP - Apply a route-map filter to routes for the specified protocol. PROTOCOL can - be **any** or one of + Apply a route-map filter to routes for the specified protocol. PROTOCOL can + be **any** or one of - - system, - - kernel, - - connected, - - static, - - rip, - - ripng, - - ospf, - - ospf6, - - isis, - - bgp, - - hsls. + - system, + - kernel, + - connected, + - static, + - rip, + - ripng, + - ospf, + - ospf6, + - isis, + - bgp, + - hsls. .. index:: set src ADDRESS .. clicmd:: set src ADDRESS From 0efdf0fe50965c31c0637208efcd5df45d654e3d Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Feb 2018 16:33:14 -0500 Subject: [PATCH 050/148] doc: clean up cross references Format reference directives and roles to match best practices. Signed-off-by: Quentin Young --- doc/user/babeld.rst | 12 +-- doc/user/basic.rst | 36 ++++----- doc/user/bgp.rst | 144 ++++++++++++++++----------------- doc/user/eigrpd.rst | 12 +-- doc/user/filter.rst | 6 +- doc/user/installation.rst | 24 +++--- doc/user/ipv6.rst | 2 +- doc/user/isisd.rst | 26 +++--- doc/user/kernel.rst | 2 +- doc/user/nhrpd.rst | 12 +-- doc/user/ospf6d.rst | 10 +-- doc/user/ospf_fundamentals.rst | 16 ++-- doc/user/ospfd.rst | 74 ++++++++--------- doc/user/overview.rst | 10 +-- doc/user/pim.rst | 12 +-- doc/user/protocol.rst | 2 +- doc/user/ripd.rst | 38 ++++----- doc/user/ripngd.rst | 10 +-- doc/user/routemap.rst | 12 +-- doc/user/rpki.rst | 12 +-- doc/user/snmp.rst | 10 +-- doc/user/snmptrap.rst | 2 +- doc/user/vnc.rst | 58 ++++++------- doc/user/vtysh.rst | 4 +- doc/user/zebra.rst | 26 +++--- 25 files changed, 286 insertions(+), 286 deletions(-) diff --git a/doc/user/babeld.rst b/doc/user/babeld.rst index 62ba8a26f2..d46550d974 100644 --- a/doc/user/babeld.rst +++ b/doc/user/babeld.rst @@ -1,4 +1,4 @@ -.. _Babel: +.. _babel: ***** Babel @@ -14,13 +14,13 @@ instance is able to perform routing for both IPv4 and IPv6. FRR implements Babel as described in :rfc:`6126`. -.. _Configuring_babeld: +.. _configuring-babeld: Configuring babeld ================== The *babeld* daemon can be invoked with any of the common -options (:ref:`Common_Invocation_Options`). +options (:ref:`common-invocation-options`). The *zebra* daemon must be running before *babeld* is invoked. Also, if *zebra* is restarted then *babeld* @@ -29,7 +29,7 @@ must be too. Configuration of *babeld* is done in its configuration file :file:`babeld.conf`. -.. _Babel_configuration: +.. _babel-configuration: Babel configuration =================== @@ -211,7 +211,7 @@ Babel configuration of very slightly increasing convergence time. The value 0 disables hysteresis, and is suitable for wired networks. The default is 4 s. -.. _Babel_redistribution: +.. _babel-redistribution: Babel redistribution ==================== @@ -224,7 +224,7 @@ Babel redistribution Specify which kind of routes should be redistributed into Babel. -.. _Show_Babel_information: +.. _show-babel-information: Show Babel information ====================== diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 7c6f97aed6..29d05abba7 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -1,4 +1,4 @@ -.. _Basic_commands: +.. _basic-commands: ************** Basic commands @@ -19,7 +19,7 @@ incoming VTY connections. The routing daemons are: The following sections discuss commands common to all the routing daemons. -.. _Config_Commands: +.. _config-commands: Config Commands =============== @@ -44,7 +44,7 @@ the default config file name. For example, zebra's default config file name is :file:`zebra.conf`. You can specify a config file using the :option:`-f` or :option:`--config-file` options when starting the daemon. -.. _Basic_Config_Commands: +.. _basic-config-commands: Basic Config Commands --------------------- @@ -254,7 +254,7 @@ Basic Config Commands Restrict vty connections with an access list. -.. _Sample_Config_File: +.. _sample-config-file: Sample Config File ------------------ @@ -287,7 +287,7 @@ If a comment character is not the first character of the word, it's a normal character. So in the above example '!' will not be regarded as a comment and the password is set to 'zebra!password'. -.. _Terminal_Mode_Commands: +.. _terminal-mode-commands: Terminal Mode Commands ====================== @@ -350,7 +350,7 @@ Terminal Mode Commands Send a message to all logging destinations that are enabled for messages of the given severity. -.. _Common_Invocation_Options: +.. _common-invocation-options: Common Invocation Options ========================= @@ -408,7 +408,7 @@ These options apply to all |PACKAGE_NAME| daemons. Print program version. -.. _Loadable_Module_Support: +.. _loadable-module-support: Loadable Module Support ======================= @@ -438,7 +438,7 @@ If SNMP is enabled during compile-time and installed as part of the package, the ``snmp`` module can be loaded for the *zebra*, *bgpd*, *ospfd*, *ospf6d* and *ripd* daemons. -The module ignores any options passed to it. Refer to :ref:`SNMP_Support` +The module ignores any options passed to it. Refer to :ref:`snmp-support` for information on its usage. The FPM Module @@ -451,9 +451,9 @@ Forwarding Plane Manager ("FPM") API. The module expects its argument to be either ``netlink`` or ``protobuf``, specifying the encapsulation to use. ``netlink`` is the default, and ``protobuf`` may not be available if the module was built without protobuf -support. Refer to :ref:`zebra_FIB_push_interface` for more information. +support. Refer to :ref:`zebra-fib-push-interface` for more information. -.. _Virtual_Terminal_Interfaces: +.. _virtual-terminal-interfaces: Virtual Terminal Interfaces =========================== @@ -461,7 +461,7 @@ Virtual Terminal Interfaces VTY -- Virtual Terminal [aka TeletYpe] Interface is a command line interface (CLI) for user interaction with the routing daemon. -.. _VTY_Overview: +.. _vty-overview: VTY Overview ------------ @@ -504,7 +504,7 @@ is no VTY password, one cannot connect to the VTY interface at all. :kbd:`?` and the ``find`` command are very useful for looking up commands. -.. _VTY_Modes: +.. _vty-modes: VTY Modes --------- @@ -513,7 +513,7 @@ There are three basic VTY modes: There are commands that may be restricted to specific VTY modes. -.. _VTY_View_Mode: +.. _vty-view-mode: VTY View Mode ^^^^^^^^^^^^^ @@ -521,7 +521,7 @@ VTY View Mode This mode is for read-only access to the CLI. One may exit the mode by leaving the system, or by entering `enable` mode. -.. _VTY_Enable_Mode: +.. _vty-enable-mode: VTY Enable Mode ^^^^^^^^^^^^^^^ @@ -529,14 +529,14 @@ VTY Enable Mode This mode is for read-write access to the CLI. One may exit the mode by leaving the system, or by escaping to view mode. -.. _VTY_Other_Modes: +.. _vty-other-modes: VTY Other Modes ^^^^^^^^^^^^^^^ This page is for describing other modes. -.. _VTY_CLI_Commands: +.. _vty-cli-commands: VTY CLI Commands ---------------- @@ -544,7 +544,7 @@ VTY CLI Commands Commands that you may use at the command-line are described in the following three subsubsections. -.. _CLI_Movement_Commands: +.. _cli-movement-commands: CLI Movement Commands ^^^^^^^^^^^^^^^^^^^^^ @@ -571,7 +571,7 @@ means press the Control Key. Move to the end of the line. -.. _CLI_Editing_Commands: +.. _cli-editing-commands: CLI Editing Commands ^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index d02973f28d..e80039a714 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -1,4 +1,4 @@ -.. _BGP: +.. _bgp: *** BGP @@ -12,7 +12,7 @@ de-fact standard of Inter Domain routing protocol. BGP-4 is described in Many extensions have been added to :rfc:`1771`. :rfc:`2858` provides multiprotocol support to BGP-4. -.. _Starting_BGP: +.. _starting-bgp: Starting BGP ============ @@ -22,7 +22,7 @@ current directory first then |INSTALL_PREFIX_ETC|/bgpd.conf. All of bgpd's command must be configured in :file:`bgpd.conf`. *bgpd* specific invocation options are described below. Common options may also -be specified (:ref:`Common_Invocation_Options`). +be specified (:ref:`common-invocation-options`). .. program:: bgpd @@ -44,7 +44,7 @@ be specified (:ref:`Common_Invocation_Options`). to an internal address, or to run multiple bgpd processes on one host. -.. _BGP_router: +.. _bgp-router: BGP router ========== @@ -60,7 +60,7 @@ BGP connection is internal one or external one. Enable a BGP protocol process with the specified ASN. After this statement you can input any `BGP Commands`. You can not create different BGP process under different ASN without - specifying `multiple-instance` (:ref:`Multiple_instance`). + specifying `multiple-instance` (:ref:`multiple-instance`). .. index:: no router bgp ASN .. clicmd:: no router bgp ASN @@ -76,7 +76,7 @@ BGP connection is internal one or external one. not enabled *bgpd* can't get interface information so `router-id` is set to 0.0.0.0. So please set router-id by hand. -.. _BGP_distance: +.. _bgp-distance: BGP distance ------------ @@ -93,7 +93,7 @@ BGP distance .. index:: distance (1-255) A.B.C.D/M word .. clicmd:: distance (1-255) A.B.C.D/M word -.. _BGP_decision_process: +.. _bgp-decision-process: BGP decision process -------------------- @@ -126,7 +126,7 @@ The decision process FRR BGP uses to select routes is as follows: 6. MED check Where routes with a MED were received from the same AS, prefer the route - with the lowest MED. :ref:`BGP_MED`. + with the lowest MED. :ref:`bgp-med`. 7. External check @@ -141,7 +141,7 @@ The decision process FRR BGP uses to select routes is as follows: If multi-pathing is enabled, then check whether the routes not yet distinguished in preference may be considered equal. If - :ref:`bgp_bestpath_as-path_multipath-relax` is set, all such routes are + :ref:`bgp-bestpath-as-path-multipath-relax` is set, all such routes are considered equal, otherwise routes received via iBGP with identical AS_PATHs or routes received from eBGP neighbours in the same AS are considered equal. @@ -149,7 +149,7 @@ The decision process FRR BGP uses to select routes is as follows: Where both routes were received from eBGP peers, then prefer the route which is already selected. Note that this check is not applied if - :ref:`bgp_bestpath_compare-routerid` is configured. This check can prevent + :ref:`bgp-bestpath-compare-routerid` is configured. This check can prevent some cases of oscillation. 11. Router-ID check @@ -178,7 +178,7 @@ The decision process FRR BGP uses to select routes is as follows: sequences should should be taken into account during the BGP best path decision process. -.. _bgp_bestpath_as-path_multipath-relax: +.. _bgp-bestpath-as-path-multipath-relax: .. index:: bgp bestpath as-path multipath-relax .. clicmd:: bgp bestpath as-path multipath-relax @@ -186,7 +186,7 @@ The decision process FRR BGP uses to select routes is as follows: of equal AS_PATH length candidates for multipath computation. Without the knob, the entire AS_PATH must match for multipath computation. -.. _bgp_bestpath_compare-routerid: +.. _bgp-bestpath-compare-routerid: .. clicmd:: bgp bestpath compare-routerid Ensure that when comparing routes where both are equal on most metrics, @@ -208,7 +208,7 @@ The decision process FRR BGP uses to select routes is as follows: sensitive to the iBGP and reflection topology. -.. _BGP_route_flap_dampening: +.. _bgp-route-flap-dampening: BGP route flap dampening ------------------------ @@ -238,7 +238,7 @@ BGP route flap dampening `http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378 `_ -.. _BGP_MED: +.. _bgp-med: BGP MED ======= @@ -312,7 +312,7 @@ updates may be produced than at other times in reaction to some event . This first issue can be fixed with a more deterministic route selection that ensures routes are ordered by the neighbouring AS during selection. -:ref:`bgp_deterministic-med`. This may reduce the number of updates as routes +:ref:`bgp-deterministic-med`. This may reduce the number of updates as routes are received, and may in some cases reduce routing churn. Though, it could equally deterministically produce the largest possible set of updates in response to the most common sequence of received updates. @@ -389,7 +389,7 @@ avoided by speakers preferring already selected, external routes rather than choosing to update to new a route based on a post-MED metric (e.g. router-ID), at the cost of a non-deterministic selection process. FRR implements this, as do many other implementations, so long as it is not overridden by setting -:ref:`bgp_bestpath_compare-routerid`, and see also :ref:`BGP_decision_process`, +:ref:`bgp-bestpath-compare-routerid`, and see also :ref:`bgp-decision-process`, . However, more complex and insidious cycles of oscillation are possible with @@ -442,7 +442,7 @@ topologies are at cross-purposes with each other - see the Flavel and Roughan paper above for an example. Hence the guideline that the iBGP topology should follow the IGP topology. -.. _bgp_deterministic-med: +.. _bgp-deterministic-med: .. index:: bgp deterministic-med .. clicmd:: bgp deterministic-med @@ -462,9 +462,9 @@ follow the IGP topology. Note that there are other sources of indeterminism in the route selection process, specifically, the preference for older and already selected routes -from eBGP peers, :ref:`BGP_decision_process`. +from eBGP peers, :ref:`bgp-decision-process`. -.. _bgp_always-compare-med: +.. _bgp-always-compare-med: .. index:: bgp always-compare-med .. clicmd:: bgp always-compare-med @@ -475,20 +475,20 @@ from eBGP peers, :ref:`BGP_decision_process`. oscillations. If using this option, it may also be desirable to use - :ref:`routemap_set_metric` to set MED to 0 on routes received from external + :ref:`routemap-set-metric` to set MED to 0 on routes received from external neighbours. - This option can be used, together with :ref:`routemap_set_metric` to use MED + This option can be used, together with :ref:`routemap-set-metric` to use MED as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired exit points. -.. _BGP_network: +.. _bgp-network: BGP network =========== -.. _BGP_route: +.. _bgp-route: BGP route --------- @@ -512,7 +512,7 @@ BGP route .. clicmd:: no network A.B.C.D/M -.. _Route_Aggregation: +.. _route-aggregation: Route Aggregation ----------------- @@ -539,7 +539,7 @@ Route Aggregation -.. _Redistribute_to_BGP: +.. _redistribute-to-bgp: Redistribute to BGP ------------------- @@ -615,12 +615,12 @@ Redistribute to BGP Supported for ipv4 and ipv6 address families. It works on multi-paths as well, however, metric setting is based on the best-path only. -.. _BGP_Peer: +.. _bgp-peer: BGP Peer ======== -.. _Defining_Peer: +.. _defining-peer: Defining Peer ------------- @@ -643,7 +643,7 @@ Defining Peer can't find neighbor 10.0.0.1 -.. _BGP_Peer_commands: +.. _bgp-peer-commands: BGP Peer commands ----------------- @@ -809,7 +809,7 @@ required. specified number of hops away will be allowed to become neighbors. This command is mututally exclusive with *ebgp-multihop*. -.. _Peer_filtering: +.. _peer-filtering: Peer filtering -------------- @@ -838,7 +838,7 @@ Peer filtering on reflected routes. This option allows the modifications to be reflected as well. Once enabled, it affects all reflected routes. -.. _BGP_Peer_Group: +.. _bgp-peer-group: BGP Peer Group ============== @@ -853,7 +853,7 @@ BGP Peer Group This command bind specific peer to peer group WORD. -.. _BGP_Address_Family: +.. _bgp-address-family: BGP Address Family ================== @@ -881,7 +881,7 @@ Encapsulation attribute :rfc:`5512` is supported. Print a summary of neighbor connections for the specified AFI/SAFI combination. -.. _Autonomous_System: +.. _autonomous-system: Autonomous System ================= @@ -895,7 +895,7 @@ The AS number is a two octet value, ranging in value from 1 to 65535. The AS numbers 64512 through 65535 are defined as private AS numbers. Private AS numbers must not to be advertised in the global Internet. -.. _Display_BGP_Routes_by_AS_Path: +.. _display-bgp-routes-by-as-path: Display BGP Routes by AS Path ----------------------------- @@ -907,9 +907,9 @@ can be used. .. clicmd:: show bgp ipv4|ipv6 regexp LINE This commands displays BGP routes that matches a regular - expression `line` (:ref:`BGP_Regular_Expressions`). + expression `line` (:ref:`bgp-regular-expressions`). -.. _AS_Path_Access_List: +.. _as-path-access-list: AS Path Access List ------------------- @@ -927,7 +927,7 @@ AS path access list is user defined AS path. .. index:: no ip as-path access-list WORD permit|deny LINE .. clicmd:: no ip as-path access-list WORD permit|deny LINE -.. _Using_AS_Path_in_Route_Map: +.. _using-as-path-in-route-map: Using AS Path in Route Map -------------------------- @@ -946,12 +946,12 @@ Using AS Path in Route Map Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. -.. _Private_AS_Numbers: +.. _private-as-numbers: Private AS Numbers ------------------ -.. _BGP_Communities_Attribute: +.. _bgp-communities-attribute: BGP Communities Attribute ========================= @@ -999,7 +999,7 @@ When BGP communities attribute is received, duplicated communities value in the communities attribute is ignored and each communities values are sorted in numerical order. -.. _BGP_Community_Lists: +.. _bgp-community-lists: BGP Community Lists ------------------- @@ -1032,7 +1032,7 @@ expanded community list. This command defines a new expanded community list. COMUNITY is a string expression of communities attribute. COMUNITY can be a - regular expression (:ref:`BGP_Regular_Expressions`) to match + regular expression (:ref:`bgp-regular-expressions`) to match the communities attribute in BGP updates. .. index:: no ip community-list NAME @@ -1072,7 +1072,7 @@ expanded community list. deny internet -.. _Numbered_BGP_Community_Lists: +.. _numbered-bgp-community-lists: Numbered BGP Community Lists ---------------------------- @@ -1108,12 +1108,12 @@ is called as named community lists. Otherwise it is defined as an expanded community list. This feature is left for backward compability. Use of this feature is not recommended. -.. _BGP_Community_in_Route_Map: +.. _bgp-community-in-route-map: BGP Community in Route Map -------------------------- -In Route Map (:ref:`Route_Map`), we can match or set BGP +In Route Map (:ref:`route-map`), we can match or set BGP communities attribute. Using this feature network operator can implement their network policy based on BGP communities attribute. @@ -1158,7 +1158,7 @@ Following commands can be used in Route Map. is removed. When all of communities value is removed eventually, the BGP update's communities attribute is completely removed. -.. _Display_BGP_Routes_by_Community: +.. _display-bgp-routes-by-community: Display BGP Routes by Community ------------------------------- @@ -1193,7 +1193,7 @@ To show BGP routes which has specific BGP communities attribute, community list `word`. When `exact-match` is specified, display only routes that have an exact match. -.. _Using_BGP_Communities_Attribute: +.. _using-bgp-communities-attribute: Using BGP Communities Attribute ------------------------------- @@ -1311,7 +1311,7 @@ community-list is used. `deny` community-list is ignored.:: set comm-list DEL delete -.. _BGP_Extended_Communities_Attribute: +.. _bgp-extended-communities-attribute: BGP Extended Communities Attribute ================================== @@ -1346,7 +1346,7 @@ the other is IP address based format. `VAL` part is 2 octets Local Administrator subfield. `10.0.0.1:100` represents -.. _BGP_Extended_Community_Lists: +.. _bgp-extended-community-lists: BGP Extended Community Lists ---------------------------- @@ -1372,7 +1372,7 @@ Lists. This command defines a new expanded extcommunity-list. `line` is a string expression of extended communities attribute. `line` can - be a regular expression (:ref:`BGP_Regular_Expressions`) to match an + be a regular expression (:ref:`bgp-regular-expressions`) to match an extended communities attribute in BGP updates. .. index:: no ip extcommunity-list NAME @@ -1403,7 +1403,7 @@ Lists. # show ip extcommunity-list -.. _BGP_Extended_Communities_in_Route_Map: +.. _bgp-extended-communities-in-route-map: BGP Extended Communities in Route Map ------------------------------------- @@ -1422,7 +1422,7 @@ BGP Extended Communities in Route Map This command set Site of Origin value. -.. _BGP_Large_Communities_Attribute: +.. _bgp-large-communities-attribute: BGP Large Communities Attribute =============================== @@ -1451,7 +1451,7 @@ AS4 operators seamless use. function 1 and parameter 10. The referenced RFC above gives some guidelines on recommended usage. -.. _BGP_Large_Community_Lists: +.. _bgp-large-community-lists: BGP Large Community Lists ------------------------- @@ -1507,7 +1507,7 @@ Two types of large community lists are supported, namely `standard` and This command displays the current large communities in use. -.. _BGP_Large_Communities_in_Route_Map: +.. _bgp-large-communities-in-route-map: BGP Large Communities in Route Map ---------------------------------- @@ -1535,13 +1535,13 @@ BGP Large Communities in Route Map large-community list. The third will add a large-community value without overwriting other values. Multiple large-community values can be specified. -.. _Displaying_BGP_information: +.. _displaying-bgp-information: Displaying BGP information ========================== -.. _Showing_BGP_information: +.. _showing-bgp-information: Showing BGP information ----------------------- @@ -1574,7 +1574,7 @@ Showing BGP information .. clicmd:: show ip bgp regexp LINE This command displays BGP routes using AS path regular expression - (:ref:`BGP_Regular_Expressions`). + (:ref:`bgp-regular-expressions`). .. index:: show ip bgp community COMMUNITY .. clicmd:: show ip bgp community COMMUNITY @@ -1582,7 +1582,7 @@ Showing BGP information .. index:: show ip bgp community COMMUNITY exact-match .. clicmd:: show ip bgp community COMMUNITY exact-match - This command displays BGP routes using `community` (:ref:`Display_BGP_Routes_by_Community`). + This command displays BGP routes using `community` (:ref:`display-bgp-routes-by-community`). .. index:: show ip bgp community-list WORD .. clicmd:: show ip bgp community-list WORD @@ -1590,7 +1590,7 @@ Showing BGP information .. index:: show ip bgp community-list WORD exact-match .. clicmd:: show ip bgp community-list WORD exact-match - This command displays BGP routes using community list (:ref:`Display_BGP_Routes_by_Community`). + This command displays BGP routes using community list (:ref:`display-bgp-routes-by-community`). .. index:: show bgp ipv4|ipv6 summary .. clicmd:: show bgp ipv4|ipv6 summary @@ -1612,7 +1612,7 @@ Showing BGP information Display flap statistics of routes. -.. _Other_BGP_commands: +.. _other-bgp-commands: Other BGP commands ------------------ @@ -1654,7 +1654,7 @@ Other BGP commands .. clicmd:: no debug keepalive -.. _Capability_Negotiation: +.. _capability-negotiation: Capability Negotiation ====================== @@ -1733,7 +1733,7 @@ If you want to completely match capabilities with remote peer. Please use Override the result of Capability Negotiation with local configuration. Ignore remote peer's capability value. -.. _Route_Reflector: +.. _route-reflector: Route Reflector =============== @@ -1748,7 +1748,7 @@ Route Reflector .. clicmd:: no neighbor PEER route-reflector-client -.. _Route_Server: +.. _route-server: Route Server ============ @@ -1768,7 +1768,7 @@ managing different routing policies for each BGP speaker. We call the routing tables as different "views". *bgpd* can work as normal BGP router or Route Server or both at the same time. -.. _Multiple_instance: +.. _multiple-instance: Multiple instance ----------------- @@ -1837,7 +1837,7 @@ to specify *neighbor A.B.C.D send-community* command.:: FRR style BGP configuration. This is default. -.. _BGP_instance_and_view: +.. _bgp-instance-and-view: BGP instance and view --------------------- @@ -1889,7 +1889,7 @@ only for exchanging BGP routing information. neighbor 10.0.0.4 remote-as 5 -.. _Routing_policy: +.. _routing-policy: Routing policy -------------- @@ -1917,7 +1917,7 @@ This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view applied. On the other hand, when the update is inserted into view 2, distribute-list 2 is applied. -.. _Viewing_the_view: +.. _viewing-the-view: Viewing the view ---------------- @@ -1929,7 +1929,7 @@ To display routing table of BGP view, you must specify view name. Display routing table of BGP view ``NAME``. -.. _BGP_Regular_Expressions: +.. _bgp-regular-expressions: BGP Regular Expressions ======================= @@ -1965,7 +1965,7 @@ _ the end of the line. So `_` can be used for AS value boundaries match. This character technically evaluates to `(^|[,{}() ]|$)`. -.. _How_to_set_up_a_6-Bone_connection: +.. _How-to-set-up-a-6-Bone-connection: How to set up a 6-Bone connection ================================= @@ -2014,7 +2014,7 @@ How to set up a 6-Bone connection ! -.. _Dump_BGP_packets_and_table: +.. _dump-bgp-packets-and-table: Dump BGP packets and table ========================== @@ -2031,8 +2031,8 @@ Dump BGP packets and table Dump all BGP packet and events to `path` file. If `interval` is set, a new file will be created for echo `interval` of seconds. The path `path` can be set with date and time formatting (strftime). - The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). - (:ref:`Packet_Binary_Dump_Format`) + The type ‘all-et’ enables support for Extended Timestamp Header (:ref:`packet-binary-dump-format`). + (:ref:`packet-binary-dump-format`) .. index:: dump bgp updates PATH [INTERVAL] .. clicmd:: dump bgp updates PATH [INTERVAL] @@ -2046,7 +2046,7 @@ Dump BGP packets and table Dump only BGP updates messages to `path` file. If `interval` is set, a new file will be created for echo `interval` of seconds. The path `path` can be set with date and time formatting (strftime). - The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`Packet_Binary_Dump_Format`). + The type ‘updates-et’ enables support for Extended Timestamp Header (:ref:`packet-binary-dump-format`). .. index:: dump bgp routes-mrt PATH .. clicmd:: dump bgp routes-mrt PATH @@ -2299,7 +2299,7 @@ flaws. set community additive 64512:3200 -.. _Configuring_FRR_as_a_Route_Server: +.. _configuring-frr-as-a-route-server: Configuring FRR as a Route Server ================================= diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index 7c8109fa97..e063b9a464 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -1,4 +1,4 @@ -.. _EIGRP: +.. _eigrp: ***** EIGRP @@ -13,7 +13,7 @@ known topology. *eigrpd* supports EIGRP as described in RFC7868 -.. _Starting_and_Stopping_eigrpd: +.. _starting-and-stopping-eigrpd: Starting and Stopping eigrpd ============================ @@ -50,7 +50,7 @@ Certain signals have special meanings to *eigrpd*. *eigrpd* invocation options. Common options that can be specified -(:ref:`Common_Invocation_Options`). +(:ref:`common-invocation-options`). .. program:: eigrpd @@ -59,7 +59,7 @@ Certain signals have special meanings to *eigrpd*. When the program terminates, retain routes added by *eigrpd*. -.. _EIGRP_Configuration: +.. _eigrp-configuration: EIGRP Configuration =================== @@ -116,7 +116,7 @@ EIGRP Configuration The default is to be passive on all interfaces. -.. _How_to_Announce_EIGRP_route: +.. _how-to-announce-eigrp-route: How to Announce EIGRP route =========================== @@ -183,7 +183,7 @@ How to Announce EIGRP route `redistribute bgp` redistributes routing information from bgp route entries into the EIGRP tables. `no redistribute bgp` disables the routes. -.. _Show_EIGRP_Information: +.. _show-eigrp-information: Show EIGRP Information ====================== diff --git a/doc/user/filter.rst b/doc/user/filter.rst index a99cc359c2..7b52d0a389 100644 --- a/doc/user/filter.rst +++ b/doc/user/filter.rst @@ -87,7 +87,7 @@ is defined, and no match is found, default deny is applied. .. index:: no ip prefix-list NAME .. clicmd:: no ip prefix-list NAME -.. _ip_prefix-list_description: +.. _ip-prefix-list-description: ip prefix-list description -------------------------- @@ -104,7 +104,7 @@ ip prefix-list description Deletes the description from a prefix list. It is possible to use the command without the full description. -.. _ip_prefix-list_sequential_number_control: +.. _ip-prefix-list-sequential-number-control: ip prefix-list sequential number control ---------------------------------------- @@ -121,7 +121,7 @@ ip prefix-list sequential number control With this command, the IP prefix list sequential number is not displayed. -.. _Showing_ip_prefix-list: +.. _Showing-ip-prefix-list: Showing ip prefix-list ---------------------- diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 471448d004..e09c679594 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -1,4 +1,4 @@ -.. _Installation: +.. _installation: ************ Installation @@ -26,13 +26,13 @@ issue the following commands: $ make install -.. _Configure_the_Software: +.. _configure-the-software: Configure the Software ====================== -.. _The_Configure_Script: +.. _the-configure-script: The Configure Script -------------------- @@ -190,7 +190,7 @@ options to the configuration script. Configure zebra to use `dir` for local state files, such as pid files and unix sockets. -.. _Least-Privilege_support: +.. _Least-Privilege-support: Least-Privilege Support ----------------------- @@ -231,7 +231,7 @@ only Linux), FRR will retain only minimal capabilities required and will only raise these capabilities for brief periods. On systems without libcap, FRR will run as the user specified and only raise its UID to 0 for brief periods. -.. _Linux_Notes: +.. _linux-notes: Linux Notes ----------- @@ -250,16 +250,16 @@ do exist. - :makevar:`CONFIG_NETLINK` Kernel/User netlink socket. This is a brand new feature which enables an - advanced interface between the Linux kernel and zebra (:ref:`Kernel_Interface`). + advanced interface between the Linux kernel and zebra (:ref:`kernel-interface`). - :makevar:`CONFIG_RTNETLINK` Routing messages. This makes it possible to receive netlink routing messages. If you specify this option, *zebra* can detect routing information - updates directly from the kernel (:ref:`Kernel_Interface`). + updates directly from the kernel (:ref:`kernel-interface`). - :makevar:`CONFIG_IP_MULTICAST` IP: multicasting. - This option should be specified when you use *ripd* (:ref:`RIP`) or - *ospfd* (:ref:`OSPFv2`) because these protocols use multicast. + This option should be specified when you use *ripd* (:ref:`rip`) or + *ospfd* (:ref:`ospfv2`) because these protocols use multicast. IPv6 support has been added in GNU/Linux kernel version 2.2. If you try to use the FRR IPv6 feature on a GNU/Linux kernel, please @@ -281,7 +281,7 @@ or upper. utility. It contains *ifconfig*, *route*, *netstat*, and other tools. `net-tools` may be found at http://www.tazenda.demon.co.uk/phil/net-tools/. -.. _Build_the_Software: +.. _build-the-software: Build the Software ================== @@ -290,7 +290,7 @@ After configuring the software, you will need to compile it for your system. Simply issue the command *make* in the root of the source directory and the software will be compiled. Cliff Notes versions of different compilation examples can be found in the Developer's Manual Appendix. If you have *any* -problems at this stage, please send a bug report :ref:`Bug-Reports`. +problems at this stage, please send a bug report :ref:`bug-reports`. :: @@ -337,6 +337,6 @@ specify a port number when starting the daemon, these entries may not be needed. You may need to make changes to the config files in -|INSTALL_PREFIX_ETC|. :ref:`Config_Commands`. +|INSTALL_PREFIX_ETC|. :ref:`config-commands`. .. [#] GNU/Linux has very flexible kernel configuration features. diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 3780a6311f..62457117c7 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -1,4 +1,4 @@ -.. _IPv6_Support: +.. _IPv6-Support: ************ IPv6 Support diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 50592cc21b..783bb5a454 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -1,4 +1,4 @@ -.. _ISIS: +.. _isis: **** ISIS @@ -11,13 +11,13 @@ which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP (Internet Service Provider)` and carrier backbone networks. -.. _Configuring_isisd: +.. _configuring-isisd: Configuring isisd ================= There are no *isisd* specific options. Common options can be specified -(:ref:`Common_Invocation_Options`) to *isisd*. *isisd* needs to acquire +(:ref:`common-invocation-options`) to *isisd*. *isisd* needs to acquire interface information from *zebra* in order to function. Therefore *zebra* must be running before invoking *isisd*. Also, if *zebra* is restarted then *isisd* must be too. @@ -25,7 +25,7 @@ must be too. Like other daemons, *isisd* configuration is done in :abbr:`ISIS` specific configuration file :file:`isisd.conf`. -.. _ISIS_router: +.. _isis-router: ISIS router =========== @@ -39,12 +39,12 @@ writing, *isisd* does not support multiple ISIS processes. .. index:: no router isis WORD .. clicmd:: no router isis WORD - .. _router_isis_WORD: + .. _router-isis-word: Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'. *isisd* does not yet support multiple ISIS processes but you must specify the name of ISIS process. The ISIS process name 'WORD' is then used - for interface (see command :ref:`ip_router_isis_WORD`). + for interface (see command :ref:`ip-router-isis-word`). .. index:: net XX.XXXX. ... .XXX.XX .. clicmd:: net XX.XXXX. ... .XXX.XX @@ -110,7 +110,7 @@ writing, *isisd* does not support multiple ISIS processes. Set overload bit to avoid any transit traffic. -.. _ISIS_Timer: +.. _isis-timer: ISIS Timer ========== @@ -168,7 +168,7 @@ ISIS Timer Set minimum interval between consecutive SPF calculations in seconds. -.. _ISIS_region: +.. _isis-region: ISIS region =========== @@ -188,7 +188,7 @@ ISIS region - level-2-only Act as an area router only -.. _ISIS_interface: +.. _isis-interface: ISIS interface ============== @@ -199,11 +199,11 @@ ISIS interface .. index:: no ip router isis WORD .. clicmd:: no ip router isis WORD -.. _ip_router_isis_WORD: +.. _ip-router-isis-word: Activate ISIS adjacency on this interface. Note that the name of ISIS instance must be the same as the one used to configure the ISIS process - (see command :ref:`router_isis_WORD`). + (see command :ref:`router-isis-word`). .. index:: isis circuit-type [level-1 | level-1-2 | level-2] .. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2] @@ -341,7 +341,7 @@ ISIS interface Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2). -.. _Showing_ISIS_information: +.. _showing-isis-information: Showing ISIS information ======================== @@ -446,7 +446,7 @@ Traffic Engineering :ref:`ospf-traffic-engineering` -.. _Debugging_ISIS: +.. _debugging-isis: Debugging ISIS ============== diff --git a/doc/user/kernel.rst b/doc/user/kernel.rst index 3020fd81d6..8c65901a00 100644 --- a/doc/user/kernel.rst +++ b/doc/user/kernel.rst @@ -1,4 +1,4 @@ -.. _Kernel_Interface: +.. _kernel-interface: **************** Kernel Interface diff --git a/doc/user/nhrpd.rst b/doc/user/nhrpd.rst index f69313144d..28e78f66fb 100644 --- a/doc/user/nhrpd.rst +++ b/doc/user/nhrpd.rst @@ -1,4 +1,4 @@ -.. _NHRP: +.. _nhrp: **** NHRP @@ -16,7 +16,7 @@ directly communicate without requiring traffic to use an intermediate hop. Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and |PACKAGE_NAME| nhrpd implements this scenario. -.. _Routing_Design: +.. _routing-design: Routing Design ============== @@ -61,14 +61,14 @@ command defines the GRE subnet)::: exit-address-family -.. _Configuring_NHRP: +.. _configuring-nhrp: Configuring NHRP ================ FIXME -.. _Hub_Functionality: +.. _hub-functionality: Hub Functionality ================= @@ -105,7 +105,7 @@ per-interface directive::: interface gre1 ip nhrp redirect -.. _Integration_with_IKE: +.. _integration-with-ike: Integration with IKE ==================== @@ -122,7 +122,7 @@ and `http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree `_ git repositories for the patches. -.. _NHRP_Events: +.. _nhrp-events: NHRP Events =========== diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index 17caa089d2..bd30fb67b0 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -7,7 +7,7 @@ OSPFv3 *ospf6d* is a daemon support OSPF version 3 for IPv6 network. OSPF for IPv6 is described in :rfc:`2740`. -.. _OSPF6_router: +.. _OSPF6-router: OSPF6 router ============ @@ -78,14 +78,14 @@ OSPF6 router This configuration setting MUST be consistent across all routers within the OSPF domain. -.. _OSPF6_area: +.. _OSPF6-area: OSPF6 area ========== Area support for OSPFv3 is not yet implemented. -.. _OSPF6_interface: +.. _OSPF6-interface: OSPF6 interface =============== @@ -126,7 +126,7 @@ OSPF6 interface Set explicitly network type for specifed interface. -.. _Redistribute_routes_to_OSPF6: +.. _Redistribute-routes-to-OSPF6: Redistribute routes to OSPF6 ============================ @@ -141,7 +141,7 @@ Redistribute routes to OSPF6 .. clicmd:: redistribute ripng -.. _Showing_OSPF6_information: +.. _Showing-OSPF6-information: Showing OSPF6 information ========================= diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index d01fd74984..b9c2139a20 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -1,4 +1,4 @@ -.. _OSPF_Fundamentals: +.. _ospf-fundamentals: OSPF Fundamentals ================= @@ -121,7 +121,7 @@ OSPF defines several related mechanisms, used to manage synchronisation of :abbr:`LSDB` s between neighbours as neighbours form adjacencies and the propogation, or :term:`flooding` of new or updated :abbr:`LSA` s. -:ref:`OSPF_Flooding`. +:ref:`ospf-flooding`. .. index:: OSPF Areas overview @@ -174,7 +174,7 @@ All LSAs share a common header with the following information: - Advertising Router - The Router ID of the router originating the LSA, see :ref:`ospf_router-id`. + The Router ID of the router originating the LSA, see :ref:`ospf-router-id`. - LSA ID @@ -186,7 +186,7 @@ All LSAs share a common header with the following information: The combination of the Type, ID and Advertising Router ID must uniquely identify the :abbr:`LSA`. There can however be multiple instances of an LSA with the same Type, LSA ID and Advertising Router ID, see - :ref:`OSPF_LSA_sequence_number,,LSA_Sequence_Number`. + :ref:`ospf-lsa-sequence-number,,lsa-sequence-number`. - Age @@ -206,7 +206,7 @@ All LSAs share a common header with the following information: a router has shutdown without flushing its LSA(s), e.g. where it has become disconnected from the network. Such LSAs do little harm. - .. _OSPF_LSA_sequence_number: + .. _ospf-lsa-sequence-number: - Sequence Number @@ -232,7 +232,7 @@ called :term:`intra-area routes`. Cost The output cost of that interface, scaled inversely to some commonly known - reference value, :ref:`OSPF_auto-cost_reference-bandwidth,,auto-cost_reference-bandwidth`. + reference value, :ref:`ospf-auto-cost-reference-bandwidth,,auto-cost-reference-bandwidth`. Link Type Transit Network @@ -272,7 +272,7 @@ called :term:`intra-area routes`. Stub links may also be used as a way to describe links on which OSPF is *not* spoken, known as :term:`passive interfaces`, see - :ref:`OSPF_passive-interface,,passive-interface`. + :ref:`ospf-passive-interface,,passive-interface`. - Network LSA @@ -451,7 +451,7 @@ An :abbr:`OSPF` router which originates External :abbr:`LSA` s is known as an most other :abbr:`LSA` s, which are flooded only within the area in which they originate, External :abbr:`LSA` s are flooded through-out the :abbr:`OSPF` network to all areas capable of carrying External -:abbr:`LSA` s (:ref:`OSPF_Areas`). +:abbr:`LSA` s (:ref:`ospf-areas`). Routes internal to OSPF (intra-area or inter-area) are always preferred over external routes. diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index eba1caea61..5b2b5abd48 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -19,7 +19,7 @@ Configuring ospfd ================= There are no *ospfd* specific options. Common options can be specified -(:ref:`Common_Invocation_Options`) to *ospfd*. *ospfd* needs to acquire +(:ref:`common-invocation-options`) to *ospfd*. *ospfd* needs to acquire interface information from *zebra* in order to function. Therefore *zebra* must be running before invoking *ospfd*. Also, if *zebra* is restarted then *ospfd* must be too. @@ -27,7 +27,7 @@ must be too. Like other daemons, *ospfd* configuration is done in :abbr:`OSPF` specific configuration file :file:`ospfd.conf`. -.. _OSPF_router: +.. _ospf-router: OSPF router =========== @@ -51,7 +51,7 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no ospf router-id .. clicmd:: no ospf router-id -.. _ospf_router-id: +.. _ospf-router-id: This sets the router-ID of the OSPF process. The router-ID may be an IP address of the router, but need not be - it can @@ -84,7 +84,7 @@ writing, *ospfd* does not support multiple OSPF processes. Note that areas with fully-adjacent virtual-links are considered to be "transit capable" and can always be used to route backbone traffic, and - hence are unaffected by this setting (:ref:`OSPF_virtual-link`). + hence are unaffected by this setting (:ref:`ospf-virtual-link`). More information regarding the behaviour controlled by this command can be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. @@ -129,7 +129,7 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no passive-interface INTERFACE .. clicmd:: no passive-interface INTERFACE -.. _ospf_passive-interface: +.. _ospf-passive-interface: Do not speak OSPF interface on the given interface, but do advertise the interface as a stub link in the @@ -137,7 +137,7 @@ writing, *ospfd* does not support multiple OSPF processes. allows one to advertise addresses on such connected interfaces without having to originate AS-External/Type-5 LSAs (which have global flooding scope) - as would occur if connected addresses were redistributed into - OSPF (:ref:`Redistribute_routes_to_OSPF`). This is the only way to + OSPF (:ref:`redistribute-routes-to-ospf`). This is the only way to advertise non-OSPF links into stub areas. .. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME @@ -164,7 +164,7 @@ writing, *ospfd* does not support multiple OSPF processes. by the `maximum-holdtime` configured with this command. If the adaptive hold-time elapses without any SPF-triggering event occuring then the current holdtime is reset to the `initial-holdtime`. The current - holdtime can be viewed with :ref:`show_ip_ospf`, where it is expressed as + holdtime can be viewed with :ref:`show-ip-ospf`, where it is expressed as a multiplier of the `initial-holdtime`. :: @@ -218,7 +218,7 @@ writing, *ospfd* does not support multiple OSPF processes. Configured state of this feature as well as current status, such as the number of second remaining till on-startup or on-shutdown ends, can be - viewed with the :ref:`show_ip_ospf` command. + viewed with the :ref:`show-ip-ospf` command. .. index:: auto-cost reference-bandwidth (1-4294967) .. clicmd:: auto-cost reference-bandwidth (1-4294967) @@ -226,7 +226,7 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no auto-cost reference-bandwidth .. clicmd:: no auto-cost reference-bandwidth -.. _OSPF_auto-cost_reference-bandwidth: +.. _OSPF-auto-cost-reference-bandwidth: This sets the reference bandwidth for cost calculations, where this bandwidth is considered @@ -250,7 +250,7 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no network A.B.C.D/M area (0-4294967295) .. clicmd:: no network A.B.C.D/M area (0-4294967295) -.. _OSPF_network_command: +.. _ospf-network-command: This command specifies the OSPF enabled interface(s). If the interface has an address from range 192.168.1.0/24 then the command below enables ospf @@ -276,10 +276,10 @@ writing, *ospfd* does not support multiple OSPF processes. contains the local address prefix of the interface. In some cases it may be more convenient to enable OSPF on a per - interface/subnet basis (:ref:`OSPF_ip_ospf_area_command`). + interface/subnet basis (:ref:`ospf-ip-ospf-area-command`). -.. _OSPF_area: +.. _ospf-area: OSPF area ========= @@ -357,7 +357,7 @@ OSPF area .. index:: no area (0-4294967295) virtual-link A.B.C.D .. clicmd:: no area (0-4294967295) virtual-link A.B.C.D -.. _OSPF_virtual-link: +.. _OSPF-virtual-link: .. index:: area A.B.C.D shortcut .. clicmd:: area A.B.C.D shortcut @@ -513,17 +513,17 @@ OSPF area .. index:: area (0-4294967295) authentication message-digest .. clicmd:: area (0-4294967295) authentication message-digest -.. _area_authentication_message-digest: +.. _area-authentication-message-digest: Specify that OSPF packets must be authenticated with MD5 HMACs within the given area. Keying - material must also be configured on a per-interface basis (:ref:`ip_ospf_message-digest-key`). + material must also be configured on a per-interface basis (:ref:`ip-ospf-message-digest-key`). MD5 authentication may also be configured on a per-interface basis - (:ref:`ip_ospf_authentication_message-digest`). Such per-interface + (:ref:`ip-ospf-authentication-message-digest`). Such per-interface settings will override any per-area authentication setting. -.. _OSPF_interface: +.. _ospf-interface: OSPF interface ============== @@ -534,11 +534,11 @@ OSPF interface .. index:: no ip ospf area [ADDR] .. clicmd:: no ip ospf area [ADDR] -.. _OSPF_ip_ospf_area_command: +.. _ospf-ip-ospf-area-command: Enable OSPF on the interface, optionally restricted to just the IP address given by `ADDR`, putting it in the `AREA` area. Per interface area - settings take precedence to network commands (:ref:`OSPF_network_command`). + settings take precedence to network commands (:ref:`ospf-network-command`). If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF via this command may result in a slight performance improvement. @@ -553,17 +553,17 @@ OSPF interface all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars. Simple text password authentication is insecure and deprecated in favour of - MD5 HMAC authentication (:ref:`ip_ospf_authentication_message-digest`). + MD5 HMAC authentication (:ref:`ip-ospf-authentication-message-digest`). .. index:: ip ospf authentication message-digest .. clicmd:: ip ospf authentication message-digest -.. _ip_ospf_authentication_message-digest: +.. _ip-ospf-authentication-message-digest: Specify that MD5 HMAC authentication must be used on this interface. MD5 keying material must - also be configured (:ref:`ip_ospf_message-digest-key`). Overrides any - authentication enabled on a per-area basis (:ref:`area_authentication_message-digest`). + also be configured (:ref:`ip-ospf-message-digest-key`). Overrides any + authentication enabled on a per-area basis (:ref:`area-authentication-message-digest`). Note that OSPF MD5 authentication requires that time never go backwards (correct time is NOT important, only that it never goes backwards), even @@ -580,7 +580,7 @@ OSPF interface .. index:: no ip ospf message-digest-key .. clicmd:: no ip ospf message-digest-key -.. _ip_ospf_message-digest-key: +.. _ip-ospf-message-digest-key: Set OSPF authentication key to a cryptographic password. The cryptographic algorithm is MD5. @@ -610,7 +610,7 @@ OSPF interface .. index:: no ip ospf dead-interval .. clicmd:: no ip ospf dead-interval -.. _ip_ospf_dead-interval_minimal: +.. _ip-ospf-dead-interval-minimal: Set number of seconds for RouterDeadInterval timer value used for Wait Timer and Inactivity @@ -637,7 +637,7 @@ OSPF interface This value must be the same for all routers attached to a common network. The default value is 10 seconds. - This command has no effect if :ref:`ip_ospf_dead-interval_minimal` is also + This command has no effect if :ref:`ip-ospf-dead-interval-minimal` is also specified for the interface. .. index:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point) @@ -687,7 +687,7 @@ OSPF interface Enable ospf on an interface and set associated area. -.. _Redistribute_routes_to_OSPF: +.. _redistribute-routes-to-ospf: Redistribute routes to OSPF =========================== @@ -719,13 +719,13 @@ Redistribute routes to OSPF .. index:: no redistribute (kernel|connected|static|rip|bgp) .. clicmd:: no redistribute (kernel|connected|static|rip|bgp) -.. _OSPF_redistribute: +.. _ospf-redistribute: Redistribute routes of the specified protocol or kind into OSPF, with the metric type and metric set if specified, filtering the routes using the given route-map if specified. Redistributed routes may also be filtered with distribute-lists, see - :ref:`ospf_distribute-list`. + :ref:`ospf-distribute-list`. Redistributed routes are distributed as into OSPF as Type-5 External LSAs into links to areas that accept external routes, Type-7 External LSAs @@ -733,7 +733,7 @@ Redistribute routes to OSPF external routes are not permitted. Note that for connected routes, one may instead use - :term:`passive-interface`, see :ref:`OSPF_passive-interface`. + :term:`passive-interface`, see :ref:`ospf-passive-interface`. .. index:: default-information originate .. clicmd:: default-information originate @@ -773,11 +773,11 @@ Redistribute routes to OSPF .. index:: no distribute-list NAME out (kernel|connected|static|rip|ospf .. clicmd:: no distribute-list NAME out (kernel|connected|static|rip|ospf -.. _ospf_distribute-list: +.. _ospf-distribute-list: Apply the access-list filter, NAME, to redistributed routes of the given type before allowing the routes to - redistributed into OSPF (:ref:`OSPF_redistribute`). + redistributed into OSPF (:ref:`ospf-redistribute`). .. index:: default-metric (0-16777214) .. clicmd:: default-metric (0-16777214) @@ -804,12 +804,12 @@ Redistribute routes to OSPF .. clicmd:: no router zebra -.. _Showing_OSPF_information: +.. _showing-ospf-information: Showing OSPF information ======================== -.. _show_ip_ospf: +.. _show-ip-ospf: .. index:: show ip ospf .. clicmd:: show ip ospf @@ -867,7 +867,7 @@ Showing OSPF information Show the OSPF routing table, as determined by the most recent SPF calculation. -.. _Opaque_LSA: +.. _opaque-lsa: Opaque LSA ========== @@ -952,7 +952,7 @@ Traffic Engineering Show Traffic Engineering router parameters. -.. _Router_Information: +.. _router-information: Router Information ================== @@ -1013,7 +1013,7 @@ Router Information Show Router Capabilities PCE parameters. -.. _Debugging_OSPF: +.. _debugging-ospf: Debugging OSPF ============== diff --git a/doc/user/overview.rst b/doc/user/overview.rst index c3549417d7..cc6bfa5068 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -1,4 +1,4 @@ -.. _Overview: +.. _overview: ******** Overview @@ -10,7 +10,7 @@ OSPFv2, OSPFv3, IS-IS, BGP-4, and BGP-4+ (:ref:`supported-rfcs`). FRR also supports special BGP Route Reflector and Route Server behavior. In addition to traditional IPv4 routing protocols, FRR also supports IPv6 routing protocols. With SNMP daemon which supports SMUX and AgentX protocol, FRR provides routing -protocol MIBs (:ref:`SNMP_Support`). +protocol MIBs (:ref:`snmp-support`). FRR uses an advanced software architecture to provide you with a high quality, multi server routing engine. FRR has an interactive user @@ -296,7 +296,7 @@ When you send a bug report, please be careful about the points below. Bug reports help us improve FRR and are very much appreciated. -.. _FRR: |PACKAGE_URL| -.. _GitHub: https://github.com/frrouting/frr/ +.. _frr: |PACKAGE-URL| +.. _github: https://github.com/frrouting/frr/ .. _GitHub issues: https://github.com/frrouting/frr/issues -.. _Slack: https://frrouting.slack.com/ +.. _slack: https://frrouting.slack.com/ diff --git a/doc/user/pim.rst b/doc/user/pim.rst index 80fa0cdeb3..b9945680cf 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -1,4 +1,4 @@ -.. _PIM: +.. _pim: *** PIM @@ -10,7 +10,7 @@ PIM -- Protocol Independent Multicast vrf aware and can work within the context of vrf's in order to do S,G mrouting. -.. _Starting_and_Stopping_pimd: +.. _starting-and-stopping-pimd: Starting and Stopping pimd ========================== @@ -46,7 +46,7 @@ Certain signals have special meanings to *pimd*. +---------+---------------------------------------------------------------------+ *pimd* invocation options. Common options that can be specified -(:ref:`Common_Invocation_Options`). +(:ref:`common-invocation-options`). .. index:: ip pim rp A.B.C.D A.B.C.D/M .. clicmd:: ip pim rp A.B.C.D A.B.C.D/M @@ -151,7 +151,7 @@ Certain signals have special meanings to *pimd*. Lookup in the Unicast Rib only. -.. _PIM_Interface_Configuration: +.. _pim-interface-configuration: PIM Interface Configuration =========================== @@ -212,7 +212,7 @@ is in a vrf, enter the interface command with the vrf keyword at the end. or IGMP report is received on this interface and the Group is denyed by the prefix-list, PIM will ignore the join or report. -.. _PIM_Multicast_RIB_insertion: +.. _pim-multicast-rib-insertion: PIM Multicast RIB insertion:: ============================= @@ -236,7 +236,7 @@ caution. Most of the time this will not be necessary. Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE. The distance can be specified as well if desired. -.. _Show_PIM_Information: +.. _show-pim-information: Show PIM Information ==================== diff --git a/doc/user/protocol.rst b/doc/user/protocol.rst index d37b073b16..bdd9c6b180 100644 --- a/doc/user/protocol.rst +++ b/doc/user/protocol.rst @@ -1,4 +1,4 @@ -.. _Zebra_Protocol +.. _Zebra-Protocol ************** Zebra Protocol diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index d456c30af6..dbeb07998f 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -1,4 +1,4 @@ -.. _RIP: +.. _rip: *** RIP @@ -16,7 +16,7 @@ router. *ripd* supports RIP version 2 as described in RFC2453 and RIP version 1 as described in RFC1058. -.. _Starting_and_Stopping_ripd: +.. _starting-and-stopping-ripd: Starting and Stopping ripd ========================== @@ -58,14 +58,14 @@ Certain signals have special meaningss to *ripd*. +-------------+------------------------------------------------------+ *ripd* invocation options. Common options that can be specified -(:ref:`Common_Invocation_Options`). +(:ref:`common-invocation-options`). .. option:: -r .. option:: --retain When the program terminates, retain routes added by *ripd*. -.. _RIP_netmask: +.. _rip-netmask: RIP netmask ----------- @@ -86,7 +86,7 @@ In a case of similar information with the same prefix and metric, the old information will be suppressed. Ripd does not currently support equal cost multipath routing. -.. _RIP_Configuration: +.. _rip-configuration: RIP Configuration ================= @@ -180,7 +180,7 @@ RIP Configuration you don't perform split-horizon on the interface, please specify `no ip split-horizon`. -.. _RIP_Version_Control: +.. _rip-version-control: RIP Version Control =================== @@ -194,7 +194,7 @@ a per-interface basis if needs be for send and receive seperately (see below). It is important to note that RIPv1 cannot be authenticated. Further, if RIPv1 is enabled then RIP will reply to REQUEST packets, sending the state of its RIP routing table to any remote routers that ask on demand. For a more detailed -discussion on the security implications of RIPv1 see :ref:`RIP_Authentication`. +discussion on the security implications of RIPv1 see :ref:`rip-authentication`. .. index:: version VERSION .. clicmd:: version VERSION @@ -203,7 +203,7 @@ discussion on the security implications of RIPv1 see :ref:`RIP_Authentication`. 1. Disabling RIPv1 by specifying version 2 is STRONGLY encouraged, - :ref:`RIP_Authentication`. This may become the default in a future release. + :ref:`rip-authentication`. This may become the default in a future release. Default: Send Version 2, and accept either version. @@ -236,7 +236,7 @@ discussion on the security implications of RIPv1 see :ref:`RIP_Authentication`. Default: Accept packets according to the global setting (both 1 and 2). -.. _How_to_Announce_RIP_route: +.. _how-to-announce-rip-route: How to Announce RIP route ========================= @@ -335,7 +335,7 @@ How to Announce RIP route recommend creating a static route in FRR and redistributing it in RIP using `redistribute static`. -.. _Filtering_RIP_Routes: +.. _filtering-rip-routes: Filtering RIP Routes ==================== @@ -376,7 +376,7 @@ RIP routes can be filtered by a distribute-list. ``in`` or ``out``. If DIRECT is ``in`` the access list is applied to input packets. -.. _RIP_Metric_Manipulation: +.. _rip-metric-manipulation: RIP Metric Manipulation ======================= @@ -404,7 +404,7 @@ received. Redistributed routes' metric is set to 1. .. clicmd:: offset-list ACCESS-LIST (in|out) IFNAME -.. _RIP_distance: +.. _rip-distance: RIP distance ============ @@ -437,7 +437,7 @@ Distance value is used in zebra daemon. Default RIP distance is 120. Set default RIP distance to specified value when the route's source IP address matches the specified prefix and the specified access-list. -.. _RIP_route-map: +.. _RIP-route-map: RIP route-map ============= @@ -460,7 +460,7 @@ listed in the route table and before routes will be announced to an interface (something like output filter). I think it is not so clear, but it is draft and it may be changed at future. -Route-map statement (:ref:`Route_Map`) is needed to use route-map +Route-map statement (:ref:`route-map`) is needed to use route-map functionality. .. index:: match interface WORD @@ -512,7 +512,7 @@ functionality. range is very large for compatibility with other protocols. For RIP, valid metric values are from 1 to 16. -.. _RIP_Authentication: +.. _rip-authentication: RIP Authentication ================== @@ -525,7 +525,7 @@ configured `ripd` will discard routing updates received via RIPv1 packets. However, unless RIPv1 reception is disabled entirely, -:ref:`RIP_Version_Control`, RIPv1 REQUEST packets which are received, +:ref:`rip-version-control`, RIPv1 REQUEST packets which are received, which query the router for routing information, will still be honoured by `ripd`, and `ripd` WILL reply to such packets. This allows `ripd` to honour such REQUESTs (which sometimes is used by old @@ -538,7 +538,7 @@ entire RIP routing table) to be queried remotely, potentially by anyone on the internet, via RIPv1. To prevent such unauthenticated querying of routes disable RIPv1, -:ref:`RIP_Version_Control`. +:ref:`rip-version-control`. .. index:: ip rip authentication mode md5 .. clicmd:: ip rip authentication mode md5 @@ -586,7 +586,7 @@ To prevent such unauthenticated querying of routes disable RIPv1, ! -.. _RIP_Timers: +.. _rip-timers: RIP Timers ========== @@ -620,7 +620,7 @@ RIP Timers The `no timers basic` command will reset the timers to the default settings listed above. -.. _Show_RIP_Information: +.. _show-rip-information: Show RIP Information ==================== diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst index ab3dcf9591..ae2400f0bb 100644 --- a/doc/user/ripngd.rst +++ b/doc/user/ripngd.rst @@ -1,4 +1,4 @@ -.. _RIPng: +.. _ripng: ***** RIPng @@ -7,15 +7,15 @@ RIPng *ripngd* supports the RIPng protocol as described in :rfc:`2080`. It's an IPv6 reincarnation of the RIP protocol. -.. _Invoking_ripngd: +.. _invoking-ripngd: Invoking ripngd =============== There are no `ripngd` specific invocation options. Common options can be -specified (:ref:`Common_Invocation_Options`). +specified (:ref:`common-invocation-options`). -.. _ripngd_Configuration: +.. _ripngd-configuration: ripngd Configuration ==================== @@ -53,7 +53,7 @@ Currently ripngd supports the following commands: This command is the default and does not appear in the configuration. With this statement, RIPng routes go to the *zebra* daemon. -.. _ripngd_Terminal_Mode_Commands: +.. _ripngd-terminal-mode-commands: ripngd Terminal Mode Commands ============================= diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst index 471a286283..acf63a6122 100644 --- a/doc/user/routemap.rst +++ b/doc/user/routemap.rst @@ -1,4 +1,4 @@ -.. _Route_Map: +.. _route-map: ********** Route Maps @@ -84,7 +84,7 @@ deny cont goto next route-map entry -.. _Route_Map_Command: +.. _route-map-command: Route Map Command ================= @@ -95,7 +95,7 @@ Route Map Command Configure the `order`'th entry in `route-map-name` with ``Match Policy`` of either *permit* or *deny*. -.. _Route_Map_Match_Command: +.. _route-map-match-command: Route Map Match Command ======================= @@ -180,7 +180,7 @@ Route Map Match Command interface name specified if the neighbor was specified in this manner. -.. _Route_Map_Set_Command: +.. _route-map-set-command: Route Map Set Command ===================== @@ -235,7 +235,7 @@ Route Map Set Command Set the BGP-4+ link local IPv6 nexthop address. -.. _Route_Map_Call_Command: +.. _route-map-call-command: Route Map Call Command ====================== @@ -246,7 +246,7 @@ Route Map Call Command Call route-map `name`. If it returns deny, deny the route and finish processing the route-map. -.. _Route_Map_Exit_Action_Command: +.. _route-map-exit-action-command: Route Map Exit Action Command ============================= diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index 0889d6966a..86d88dcf9b 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -1,4 +1,4 @@ -.. _Prefix_Origin_Validation_Using_RPKI: +.. _prefix-origin-validation-using-rpki: Prefix Origin Validation Using RPKI =================================== @@ -24,7 +24,7 @@ For a more detailed but still easy-to-read background, we suggest: - [Securing-BGP]_ - [Resource-Certification]_ -.. _Features_of_the_Current_Implementation: +.. _features-of-the-current-implementation: Features of the Current Implementation -------------------------------------- @@ -46,7 +46,7 @@ In a nutshell, the current implementation provides the following features outcome of the Prefix Origin Validation. -.. _Enabling_RPKI: +.. _enabling-rpki: Enabling RPKI ------------- @@ -143,7 +143,7 @@ The following commands are independent of a specific cache server. :file:`~/.ssh/known_hosts`. -.. _Validating_BGP_Updates: +.. _validating-bgp-updates: Validating BGP Updates ---------------------- @@ -180,7 +180,7 @@ Validating BGP Updates set local-preference 500 -.. _Debugging: +.. _debugging: Debugging --------- @@ -193,7 +193,7 @@ Debugging Enable or disable debugging output for RPKI. -.. _Displaying_RPKI: +.. _displaying-rpki: Displaying RPKI --------------- diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 916ab3a9f3..114f1f7dfc 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -1,4 +1,4 @@ -.. _SNMP_Support: +.. _snmp-support: ************ SNMP Support @@ -11,9 +11,9 @@ a SNMP agent using the SMUX protocol (:rfc:`1227`) or the AgentX protocol (:rfc:`2741`) and make the routing protocol MIBs available through it. Note that SNMP Support needs to be enabled at compile-time and loaded as module -on daemon startup. Refer to :ref:`Loadable_Module_Support` on the latter. +on daemon startup. Refer to :ref:`loadable-module-support` on the latter. -.. _Getting_and_installing_an_SNMP_agent: +.. _getting-and-installing-an-snmp-agent: Getting and installing an SNMP agent ==================================== @@ -29,7 +29,7 @@ protocol. Nowadays, SMUX is a legacy protocol. The AgentX protocol should be preferred for any new deployment. Both protocols have the same coverage. -.. _AgentX_configuration: +.. _agentx-configuration: AgentX configuration ==================== @@ -94,7 +94,7 @@ need to configure FRR to use another transport, you can configure it through agentXSocket tcp:192.168.15.12:705 -.. _SMUX_configuration: +.. _smux-configuration: SMUX configuration ================== diff --git a/doc/user/snmptrap.rst b/doc/user/snmptrap.rst index 9d6b12e0b4..9e642a5d4d 100644 --- a/doc/user/snmptrap.rst +++ b/doc/user/snmptrap.rst @@ -2,7 +2,7 @@ Handling SNMP Traps =================== To handle snmp traps make sure your snmp setup of frr works correctly as -described in the frr documentation in :ref:`SNMP_Support`. +described in the frr documentation in :ref:`snmp-support`. The BGP4 mib will send traps on peer up/down events. These should be visible in your snmp logs with a message similar to: diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 62091822b9..c7de34458d 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -1,4 +1,4 @@ -.. _VNC_and_VNC-GW: +.. _VNC-and-VNC-GW: ************** VNC and VNC-GW @@ -54,12 +54,12 @@ following areas: (:abbr:`CE` s) operating within a VN. -.. _General_VNC_Configuration: +.. _general-vnc-configuration: .. General VNC Configuration .. ------------------------- -.. _RFP_Related_Configuration: +.. _rfp-related-configuration: RFP Related Configuration ------------------------- @@ -76,14 +76,14 @@ following sample configuration: This is a simple example configuration parameter included as part of the RFP example code. VALUE must be in the range of 0 to 4294967295. -.. _VNC_Defaults_Configuration: +.. _vnc-defaults-configuration: VNC Defaults Configuration -------------------------- The VNC Defaults section allows the user to specify default values for configuration parameters for all registered NVEs. -Default values are overridden by :ref:`VNC_NVE_Group_Configuration`. +Default values are overridden by :ref:`vnc-nve-group-configuration`. .. clicmd:: vnc defaults @@ -122,7 +122,7 @@ These are the statements that can appear between ``vnc defaults`` and RT list is empty. A complete definition of these parameters is given below - (:ref:`VNC_NVE_Group_Configuration`). + (:ref:`vnc-nve-group-configuration`). .. index:: rd route-distinguisher .. clicmd:: rd ROUTE-DISTINGUISHER @@ -139,14 +139,14 @@ These are the statements that can appear between ``vnc defaults`` and `two-byte-autonomous-system-number=0:four-byte-integer=0`. A complete definition of this parameter is given below - (:ref:`VNC_NVE_Group_Configuration`). + (:ref:`vnc-nve-group-configuration`). .. index:: l2rd NVE-ID-VALUE .. clicmd:: l2rd NVE-ID-VALUE Set the value used to distinguish NVEs connected to the same logical Ethernet segment (i.e., L2VPN). A complete definition of this parameter is - given below (:ref:`VNC_NVE_Group_Configuration`). + given below (:ref:`vnc-nve-group-configuration`). .. index:: response-lifetime LIFETIME|infinite .. clicmd:: response-lifetime LIFETIME|infinite @@ -155,7 +155,7 @@ These are the statements that can appear between ``vnc defaults`` and NVEs. A complete definition of this parameter is given below - (:ref:`VNC_NVE_Group_Configuration`). + (:ref:`vnc-nve-group-configuration`). .. index:: export bgp|zebra route-map MAP-NAME .. clicmd:: export bgp|zebra route-map MAP-NAME @@ -174,7 +174,7 @@ These are the statements that can appear between ``vnc defaults`` and Exit VNC configuration mode. -.. _VNC_NVE_Group_Configuration: +.. _vnc-nve-group-configuration: VNC NVE Group Configuration --------------------------- @@ -322,7 +322,7 @@ Defaults section. Specify that the named route-map should be applied to routes being exported to bgp or zebra. This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item is optional. .. index:: export bgp|zebra no route-map @@ -330,7 +330,7 @@ Defaults section. Specify that no route-map should be applied to routes being exported to bgp or zebra. This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item is optional. .. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME @@ -339,7 +339,7 @@ Defaults section. Specify that the named prefix-list filter should be applied to routes being exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of each other. This paramter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item is optional. .. index:: export bgp|zebra no ipv4|ipv6 prefix-list @@ -347,17 +347,17 @@ Defaults section. Specify that no prefix-list filter should be applied to routes being exported to bgp or zebra. This parameter is used in conjunction with - :ref:`Configuring_Export_of_Routes_to_Other_Routing_Protocols`. This item + :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item is optional. -.. _VNC_L2_Group_Configuration: +.. _VNC-L2-Group-Configuration: VNC L2 Group Configuration -------------------------- The route targets advertised with prefixes and addresses registered by an NVE are determined based on the NVE's associated VNC NVE Group Configuration, -:ref:`VNC_NVE_Group_Configuration`. Layer 2 (L2) Groups are used to override +:ref:`vnc-nve-group-configuration`. Layer 2 (L2) Groups are used to override the route targets for an NVE's Ethernet registrations based on the Logical Network Identifier and label value. A Logical Network Identifier is used to uniquely identify a logical Ethernet segment and is conceptually similar to the @@ -414,9 +414,9 @@ The following statements are valid in a L2 group definition: Specify the route target import and export value associated with the group. A complete definition of these parameters is given above, - :ref:`VNC_NVE_Group_Configuration`. + :ref:`vnc-nve-group-configuration`. -.. _Configuring_Redistribution_of_Routes_from_Other_Routing_Protocols: +.. _configuring-redistribution-of-routes-from-other-routing-protocols: Configuring Redistribution of Routes from Other Routing Protocols ----------------------------------------------------------------- @@ -628,7 +628,7 @@ being redistributed from `bgp-direct`. When redistributing `bgp-direct` routes, specifies that no route-map should be applied. -.. _Configuring_Export_of_Routes_to_Other_Routing_Protocols: +.. _configuring-export-of-routes-to-other-routing-protocols: Configuring Export of Routes to Other Routing Protocols ------------------------------------------------------- @@ -647,7 +647,7 @@ a corresponding `redistribute vnc-direct` statement. Specify how routes should be exported to bgp or zebra. If the mode is `none`, routes are not exported. If the mode is `group-nve`, routes are exported according to nve-group or vrf-policy group configuration - (:ref:`VNC_NVE_Group_Configuration`): if a group is configured to allow + (:ref:`vnc-nve-group-configuration`): if a group is configured to allow export, then each prefix visible to the group is exported with next hops set to the currently-registered NVEs. If the mode is `registering-nve`, then all VNC routes are exported with their original next hops. If the mode is `ce`, @@ -701,7 +701,7 @@ a corresponding `redistribute vnc-direct` statement. When the export mode is `group-nve`, policy for exported routes is specified per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block via - the following commands(:ref:`VNC_NVE_Group_Configuration`): + the following commands(:ref:`vnc-nve-group-configuration`): .. index:: export bgp|zebra route-map MAP-NAME .. clicmd:: export bgp|zebra route-map MAP-NAME @@ -733,7 +733,7 @@ a corresponding `redistribute vnc-direct` statement. that no prefix-list filter should be applied to routes being exported to bgp or zebra. -.. _Manual_Address_Control: +.. _manual-address-control: Manual Address Control ====================== @@ -792,7 +792,7 @@ manually and dynamically added information. `*` in lieu of any VN or UN address, in which case all registrations will match. -.. _Other_VNC-Related_Commands: +.. _Other-VNC-Related-Commands: Other VNC-Related Commands ========================== @@ -835,8 +835,8 @@ related information: .. clicmd:: show vnc queries PREFIX Display active Query information. Queries remain valid for the default - Response Lifetime (:ref:`VNC_Defaults_Configuration`) or NVE-group Response - Lifetime (:ref:`VNC_NVE_Group_Configuration`). Specifying `prefix` limits + Response Lifetime (:ref:`vnc-defaults-configuration`) or NVE-group Response + Lifetime (:ref:`vnc-nve-group-configuration`). Specifying `prefix` limits the output to Query Targets that fall within `prefix`. Query information is provided for each querying NVE, and includes the Query @@ -873,9 +873,9 @@ related information: Display all, active and/or removed response information which are present in the NVA Responses Cache. Responses remain valid for the - default Response Lifetime (:ref:`VNC_Defaults_Configuration`) or - NVE-group Response Lifetime (:ref:`VNC_NVE_Group_Configuration`.) - When Removal Responses are enabled (:ref:`General_VNC_Configuration`), + default Response Lifetime (:ref:`vnc-defaults-configuration`) or + NVE-group Response Lifetime (:ref:`vnc-nve-group-configuration`.) + When Removal Responses are enabled (:ref:`general-vnc-configuration`), such responses are listed for the Response Lifetime. Specifying `prefix` limits the output to the addresses that fall within `prefix`. @@ -890,7 +890,7 @@ related information: Print the number of memory items allocated by the NVA. -.. _Example_VNC_and_VNC-GW_Configurations: +.. _Example-VNC-and-VNC-GW-Configurations: Example VNC and VNC-GW Configurations ===================================== diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst index 089540d589..52d54f4123 100644 --- a/doc/user/vtysh.rst +++ b/doc/user/vtysh.rst @@ -1,4 +1,4 @@ -.. _VTY_shell: +.. _vty-shell: ********* VTY shell @@ -60,7 +60,7 @@ could be made SGID (set group ID) to the |INSTALL_VTY_GROUP| group. at all. -.. _Integrated_configuration_mode: +.. _integrated-configuration-mode: Integrated configuration mode ============================= diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index 4f1692e58c..70a69cf0d4 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -1,4 +1,4 @@ -.. _Zebra: +.. _zebra: ***** Zebra @@ -8,12 +8,12 @@ Zebra table updates, interface lookups, and redistribution of routes between different routing protocols. -.. _Invoking_zebra: +.. _invoking-zebra: Invoking zebra ============== -Besides the common invocation options (:ref:`Common_Invocation_Options`), the +Besides the common invocation options (:ref:`common-invocation-options`), the *zebra* specific invocation options are listed below. .. program:: zebra @@ -36,12 +36,12 @@ Besides the common invocation options (:ref:`Common_Invocation_Options`), the .. program:: configure -.. _Interface_Commands: +.. _interface-commands: Interface Commands ================== -.. _Standard_Commands: +.. _standard-commands: Standard Commands ----------------- @@ -136,7 +136,7 @@ Standard Commands Linux and Solaris, and only where network interface drivers support reporting link-state via the ``IFF_RUNNING`` flag. -.. _Link_Parameters_Commands: +.. _link-parameters-commands: Link Parameters Commands ------------------------ @@ -150,7 +150,7 @@ Link Parameters Commands Enter into the link parameters sub node. At least 'enable' must be set to activate the link parameters, and consequently Traffic Engineering on this interface. MPLS-TE must be enable at the OSPF - (:ref:`OSPF_Traffic_Engineering`) or ISIS (:ref:`ISIS_Traffic_Engineering`) + (:ref:`ospf-traffic-engineering`) or ISIS (:ref:`isis-traffic-engineering`) router level in complement to this. Disable link parameters for this interface. @@ -225,7 +225,7 @@ Link Parameters Commands for InterASv2 link in OSPF (RFC5392). Note that this option is not yet supported for ISIS (RFC5316). -.. _Static_Route_Commands: +.. _static-route-commands: Static Route Commands ===================== @@ -351,7 +351,7 @@ default) should the specified gateways not be reachable. Eg: and later). After setting TABLENO with this command, static routes defined after this are added to the specified table. -.. _Multicast_RIB_Commands: +.. _multicast-rib-commands: Multicast RIB Commands ====================== @@ -441,12 +441,12 @@ longer-prefix ``ip route`` command, except that it inserts the route in the Multicast RIB instead of the Unicast RIB. -.. _zebra_Route_Filtering: +.. _zebra-route-filtering: zebra Route Filtering ===================== -Zebra supports :dfn:`prefix-list` s and :ref:`Route_Map` s to match routes +Zebra supports :dfn:`prefix-list` s and :ref:`route-map` s to match routes received from other FRR components. The permit/deny facilities provided by these commands can be used to filter which routes zebra will install in the kernel. @@ -490,7 +490,7 @@ that sets the preferred source address, and applies the route-map to all ip protocol rip route-map RM1 -.. _zebra_FIB_push_interface: +.. _zebra-fib-push-interface: zebra FIB push interface ======================== @@ -498,7 +498,7 @@ zebra FIB push interface Zebra supports a 'FIB push' interface that allows an external component to learn the forwarding information computed by the FRR routing suite. This is a loadable module that needs to be enabled -at startup as described in :ref:`Loadable_Module_Support`. +at startup as described in :ref:`loadable-module-support`. In FRR, the Routing Information Base (RIB) resides inside zebra. Routing protocols communicate their best routes to zebra, and From 9e146a818b52741d97ff3ae25caa1523c20e554d Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Feb 2018 17:38:05 -0500 Subject: [PATCH 051/148] doc: fix more broken refs, restore routeserver.rst At some point the routeserver docs got lost, converted those from texi and put them back. Also fixed some broken cli xrefs. Signed-off-by: Quentin Young --- doc/user/bgp.rst | 44 +--- doc/user/conf.py | 2 +- doc/user/isisd.rst | 2 + doc/user/routeserver.rst | 546 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 560 insertions(+), 34 deletions(-) create mode 100644 doc/user/routeserver.rst diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index e80039a714..ba4238b946 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -141,7 +141,7 @@ The decision process FRR BGP uses to select routes is as follows: If multi-pathing is enabled, then check whether the routes not yet distinguished in preference may be considered equal. If - :ref:`bgp-bestpath-as-path-multipath-relax` is set, all such routes are + :clicmd:`bgp bestpath as-path multipath-relax` is set, all such routes are considered equal, otherwise routes received via iBGP with identical AS_PATHs or routes received from eBGP neighbours in the same AS are considered equal. @@ -149,8 +149,8 @@ The decision process FRR BGP uses to select routes is as follows: Where both routes were received from eBGP peers, then prefer the route which is already selected. Note that this check is not applied if - :ref:`bgp-bestpath-compare-routerid` is configured. This check can prevent - some cases of oscillation. + :clicmd:`bgp bestpath compare-routerid` is configured. This check can + prevent some cases of oscillation. 11. Router-ID check @@ -178,7 +178,6 @@ The decision process FRR BGP uses to select routes is as follows: sequences should should be taken into account during the BGP best path decision process. -.. _bgp-bestpath-as-path-multipath-relax: .. index:: bgp bestpath as-path multipath-relax .. clicmd:: bgp bestpath as-path multipath-relax @@ -186,7 +185,6 @@ The decision process FRR BGP uses to select routes is as follows: of equal AS_PATH length candidates for multipath computation. Without the knob, the entire AS_PATH must match for multipath computation. -.. _bgp-bestpath-compare-routerid: .. clicmd:: bgp bestpath compare-routerid Ensure that when comparing routes where both are equal on most metrics, @@ -312,7 +310,7 @@ updates may be produced than at other times in reaction to some event . This first issue can be fixed with a more deterministic route selection that ensures routes are ordered by the neighbouring AS during selection. -:ref:`bgp-deterministic-med`. This may reduce the number of updates as routes +:clicmd:`bgp deterministic-med`. This may reduce the number of updates as routes are received, and may in some cases reduce routing churn. Though, it could equally deterministically produce the largest possible set of updates in response to the most common sequence of received updates. @@ -389,8 +387,8 @@ avoided by speakers preferring already selected, external routes rather than choosing to update to new a route based on a post-MED metric (e.g. router-ID), at the cost of a non-deterministic selection process. FRR implements this, as do many other implementations, so long as it is not overridden by setting -:ref:`bgp-bestpath-compare-routerid`, and see also :ref:`bgp-decision-process`, -. +:clicmd:`bgp bestpath compare-routerid`, and see also +:ref:`bgp-decision-process`. However, more complex and insidious cycles of oscillation are possible with iBGP route-reflection, which are not so easily avoided. These have been @@ -442,8 +440,6 @@ topologies are at cross-purposes with each other - see the Flavel and Roughan paper above for an example. Hence the guideline that the iBGP topology should follow the IGP topology. -.. _bgp-deterministic-med: - .. index:: bgp deterministic-med .. clicmd:: bgp deterministic-med @@ -464,8 +460,6 @@ Note that there are other sources of indeterminism in the route selection process, specifically, the preference for older and already selected routes from eBGP peers, :ref:`bgp-decision-process`. -.. _bgp-always-compare-med: - .. index:: bgp always-compare-med .. clicmd:: bgp always-compare-med @@ -475,12 +469,12 @@ from eBGP peers, :ref:`bgp-decision-process`. oscillations. If using this option, it may also be desirable to use - :ref:`routemap-set-metric` to set MED to 0 on routes received from external + :clicmd:`set metric METRIC` to set MED to 0 on routes received from external neighbours. - This option can be used, together with :ref:`routemap-set-metric` to use MED - as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., desired - exit points. + This option can be used, together with :clicmd:`set metric METRIC` to use + MED as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., + desired exit points. .. _bgp-network: @@ -2298,23 +2292,7 @@ flaws. route-map rm-peer-in permit 10 set community additive 64512:3200 - -.. _configuring-frr-as-a-route-server: - -Configuring FRR as a Route Server -================================= - -The purpose of a Route Server is to centralize the peerings between BGP -speakers. For example if we have an exchange point scenario with four BGP -speakers, each of which maintaining a BGP peering with the other three -(:ref:`fig:full-mesh`), we can convert it into a centralized scenario where -each of the four establishes a single BGP peering against the Route Server -(:ref:`fig:route-server`). - -We will first describe briefly the Route Server model implemented by FRR. -We will explain the commands that have been added for configuring that -model. And finally we will show a full example of FRR configured as Route -Server. +.. include:: routeserver.rst .. include:: rpki.rst diff --git a/doc/user/conf.py b/doc/user/conf.py index b0bcb2ed43..e79dea0bdf 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -123,7 +123,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build', 'rpki.rst', 'ospf_fundamentals.rst'] +exclude_patterns = ['_build', 'rpki.rst', 'routeserver.rst', 'ospf_fundamentals.rst'] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 783bb5a454..23b1af57ab 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -410,6 +410,8 @@ Showing ISIS information Show the ISIS routing table, as determined by the most recent SPF calculation. +.. _isis-traffic-engineering: + Traffic Engineering =================== diff --git a/doc/user/routeserver.rst b/doc/user/routeserver.rst new file mode 100644 index 0000000000..86fab0249f --- /dev/null +++ b/doc/user/routeserver.rst @@ -0,0 +1,546 @@ +.. _configuring-frr-as-a-route-server: + +Configuring FRR as a Route Server +================================= + +The purpose of a Route Server is to centralize the peerings between BGP +speakers. For example if we have an exchange point scenario with four BGP +speakers, each of which maintaining a BGP peering with the other three +(:ref:`fig-topologies-full`), we can convert it into a centralized scenario where +each of the four establishes a single BGP peering against the Route Server +(:ref:`fig-topologies-rs`). + +We will first describe briefly the Route Server model implemented by FRR. +We will explain the commands that have been added for configuring that +model. And finally we will show a full example of FRR configured as Route +Server. + +.. _description-of-the-route-server-model: + +Description of the Route Server model +------------------------------------- + +First we are going to describe the normal processing that BGP announcements +suffer inside a standard BGP speaker, as shown in :ref:`fig-normal-processing`, +it consists of three steps: + +- When an announcement is received from some peer, the `In` filters configured + for that peer are applied to the announcement. These filters can reject the + announcement, accept it unmodified, or accept it with some of its attributes + modified. + +- The announcements that pass the `In` filters go into the Best Path Selection + process, where they are compared to other announcements referred to the same + destination that have been received from different peers (in case such other + announcements exist). For each different destination, the announcement which + is selected as the best is inserted into the BGP speaker's Loc-RIB. + +- The routes which are inserted in the Loc-RIB are considered for announcement + to all the peers (except the one from which the route came). This is done by + passing the routes in the Loc-RIB through the `Out` filters corresponding to + each peer. These filters can reject the route, accept it unmodified, or + accept it with some of its attributes modified. Those routes which are + accepted by the `Out` filters of a peer are announced to that peer. + +.. _fig-normal-processing: +.. figure:: ../figures/fig-normal-processing.png + :alt: Normal announcement processing + :align: center + + Announcement processing inside a 'normal' BGP speaker + +.. _fig-topologies-full: +.. figure:: ../figures/fig_topologies_full.png + :alt: Full Mesh BGP Topology + :align: center + + Full Mesh + +.. _fig-topologies-rs: +.. figure:: ../figures/fig_topologies_rs.png + :alt: Route Server BGP Topology + :align: center + + Route server and clients + +Of course we want that the routing tables obtained in each of the routers are +the same when using the route server than when not. But as a consequence of +having a single BGP peering (against the route server), the BGP speakers can no +longer distinguish from/to which peer each announce comes/goes. + +.. _filter-delegation: +This means that the routers connected to the route server are not able to apply +by themselves the same input/output filters as in the full mesh scenario, so +they have to delegate those functions to the route server. + +Even more, the 'best path' selection must be also performed inside the route +server on behalf of its clients. The reason is that if, after applying the +filters of the announcer and the (potential) receiver, the route server decides +to send to some client two or more different announcements referred to the same +destination, the client will only retain the last one, considering it as an +implicit withdrawal of the previous announcements for the same destination. +This is the expected behavior of a BGP speaker as defined in :rfc:`1771`, +and even though there are some proposals of mechanisms that permit multiple +paths for the same destination to be sent through a single BGP peering, none +are currently supported by most existing BGP implementations. + +As a consequence a route server must maintain additional information and +perform additional tasks for a RS-client that those necessary for common BGP +peerings. Essentially a route server must: + +.. _route-server-tasks: + +- Maintain a separated Routing Information Base (Loc-RIB) + for each peer configured as RS-client, containing the routes + selected as a result of the 'Best Path Selection' process + that is performed on behalf of that RS-client. + +- Whenever it receives an announcement from a RS-client, + it must consider it for the Loc-RIBs of the other RS-clients. + + - This means that for each of them the route server must pass the + announcement through the appropriate `Out` filter of the + announcer. + + - Then through the appropriate `In` filter of the potential receiver. + + - Only if the announcement is accepted by both filters it will be passed + to the 'Best Path Selection' process. + + - Finally, it might go into the Loc-RIB of the receiver. + +When we talk about the 'appropriate' filter, both the announcer and the +receiver of the route must be taken into account. Suppose that the route server +receives an announcement from client A, and the route server is considering it +for the Loc-RIB of client B. The filters that should be applied are the same +that would be used in the full mesh scenario, i.e., first the `Out` filter of +router A for announcements going to router B, and then the `In` filter of +router B for announcements coming from router A. + +We call 'Export Policy' of a RS-client to the set of `Out` filters that the +client would use if there was no route server. The same applies for the 'Import +Policy' of a RS-client and the set of `In` filters of the client if there was +no route server. + +It is also common to demand from a route server that it does not modify some +BGP attributes (next-hop, as-path and MED) that are usually modified by +standard BGP speakers before announcing a route. + +The announcement processing model implemented by Frr is shown in +:ref:`fig-rs-processing`. The figure shows a mixture of RS-clients (B, C and D) +with normal BGP peers (A). There are some details that worth additional +comments: + +- Announcements coming from a normal BGP peer are also considered for the + Loc-RIBs of all the RS-clients. But logically they do not pass through any + export policy. + +- Those peers that are configured as RS-clients do not receive any announce + from the `Main` Loc-RIB. + +- Apart from import and export policies, `In` and `Out` filters can also be set + for RS-clients. `In` filters might be useful when the route server has also + normal BGP peers. On the other hand, `Out` filters for RS-clients are + probably unnecessary, but we decided not to remove them as they do not hurt + anybody (they can always be left empty). + +.. _fig-rs-processing: +.. figure:: ../figures/fig-rs-processing.png + :align: center + :alt: Route Server Processing Model + + Announcement processing model implemented by the Route Server + +.. _commands-for-configuring-a-route-server: + +Commands for configuring a Route Server +--------------------------------------- + +Now we will describe the commands that have been added to frr +in order to support the route server features. + +.. index:: neighbor PEER-GROUP route-server-client +.. clicmd:: neighbor PEER-GROUP route-server-client + +.. index:: neighbor A.B.C.D route-server-client +.. clicmd:: neighbor A.B.C.D route-server-client + +.. index:: neighbor X:X::X:X route-server-client +.. clicmd:: neighbor X:X::X:X route-server-client + + This command configures the peer given by `peer`, `A.B.C.D` or `X:X::X:X` as + an RS-client. + + Actually this command is not new, it already existed in standard Frr. It + enables the transparent mode for the specified peer. This means that some + BGP attributes (as-path, next-hop and MED) of the routes announced to that + peer are not modified. + + With the route server patch, this command, apart from setting the + transparent mode, creates a new Loc-RIB dedicated to the specified peer + (those named `Loc-RIB for X` in :ref:`fig-rs-processing`.). Starting from + that moment, every announcement received by the route server will be also + considered for the new Loc-RIB. + +.. index:: neigbor A.B.C.D|X.X::X.X|peer-group route-map WORD import|export +.. clicmd:: neigbor A.B.C.D|X.X::X.X|peer-group route-map WORD import|export + + This set of commands can be used to specify the route-map that represents + the Import or Export policy of a peer which is configured as a RS-client + (with the previous command). + +.. index:: match peer A.B.C.D|X:X::X:X +.. clicmd:: match peer A.B.C.D|X:X::X:X + + This is a new *match* statement for use in route-maps, enabling them to + describe import/export policies. As we said before, an import/export policy + represents a set of input/output filters of the RS-client. This statement + makes possible that a single route-map represents the full set of filters + that a BGP speaker would use for its different peers in a non-RS scenario. + + The *match peer* statement has different semantics whether it is used inside + an import or an export route-map. In the first case the statement matches if + the address of the peer who sends the announce is the same that the address + specified by {A.B.C.D|X:X::X:X}. For export route-maps it matches when + {A.B.C.D|X:X::X:X} is the address of the RS-Client into whose Loc-RIB the + announce is going to be inserted (how the same export policy is applied + before different Loc-RIBs is shown in :ref:`fig-rs-processing`.). + +.. index:: call WORD +.. clicmd:: call WORD + + This command (also used inside a route-map) jumps into a different + route-map, whose name is specified by `WORD`. When the called + route-map finishes, depending on its result the original route-map + continues or not. Apart from being useful for making import/export + route-maps easier to write, this command can also be used inside + any normal (in or out) route-map. + +.. _example-of-route-server-configuration: + +Example of Route Server Configuration +------------------------------------- + +Finally we are going to show how to configure a Frr daemon to act as a +Route Server. For this purpose we are going to present a scenario without +route server, and then we will show how to use the configurations of the BGP +routers to generate the configuration of the route server. + +All the configuration files shown in this section have been taken +from scenarios which were tested using the VNUML tool +`http://www.dit.upm.es/vnuml,VNUML `_. + +.. _configuration-of-the-bgp-routers-without-route-server: + +Configuration of the BGP routers without Route Server +----------------------------------------------------- + +We will suppose that our initial scenario is an exchange point with three +BGP capable routers, named RA, RB and RC. Each of the BGP speakers generates +some routes (with the `network` command), and establishes BGP peerings +against the other two routers. These peerings have In and Out route-maps +configured, named like 'PEER-X-IN' or 'PEER-X-OUT'. For example the +configuration file for router RA could be the following: + +:: + + #Configuration for router 'RA' + ! + hostname RA + password **** + ! + router bgp 65001 + no bgp default ipv4-unicast + neighbor 2001:0DB8::B remote-as 65002 + neighbor 2001:0DB8::C remote-as 65003 + ! + address-family ipv6 + network 2001:0DB8:AAAA:1::/64 + network 2001:0DB8:AAAA:2::/64 + network 2001:0DB8:0000:1::/64 + network 2001:0DB8:0000:2::/64 + neighbor 2001:0DB8::B activate + neighbor 2001:0DB8::B soft-reconfiguration inbound + neighbor 2001:0DB8::B route-map PEER-B-IN in + neighbor 2001:0DB8::B route-map PEER-B-OUT out + neighbor 2001:0DB8::C activate + neighbor 2001:0DB8::C soft-reconfiguration inbound + neighbor 2001:0DB8::C route-map PEER-C-IN in + neighbor 2001:0DB8::C route-map PEER-C-OUT out + exit-address-family + ! + ipv6 prefix-list COMMON-PREFIXES seq 5 permit 2001:0DB8:0000::/48 ge 64 le 64 + ipv6 prefix-list COMMON-PREFIXES seq 10 deny any + ! + ipv6 prefix-list PEER-A-PREFIXES seq 5 permit 2001:0DB8:AAAA::/48 ge 64 le 64 + ipv6 prefix-list PEER-A-PREFIXES seq 10 deny any + ! + ipv6 prefix-list PEER-B-PREFIXES seq 5 permit 2001:0DB8:BBBB::/48 ge 64 le 64 + ipv6 prefix-list PEER-B-PREFIXES seq 10 deny any + ! + ipv6 prefix-list PEER-C-PREFIXES seq 5 permit 2001:0DB8:CCCC::/48 ge 64 le 64 + ipv6 prefix-list PEER-C-PREFIXES seq 10 deny any + ! + route-map PEER-B-IN permit 10 + match ipv6 address prefix-list COMMON-PREFIXES + set metric 100 + route-map PEER-B-IN permit 20 + match ipv6 address prefix-list PEER-B-PREFIXES + set community 65001:11111 + ! + route-map PEER-C-IN permit 10 + match ipv6 address prefix-list COMMON-PREFIXES + set metric 200 + route-map PEER-C-IN permit 20 + match ipv6 address prefix-list PEER-C-PREFIXES + set community 65001:22222 + ! + route-map PEER-B-OUT permit 10 + match ipv6 address prefix-list PEER-A-PREFIXES + ! + route-map PEER-C-OUT permit 10 + match ipv6 address prefix-list PEER-A-PREFIXES + ! + line vty + ! + + +.. _configuration-of-the-bgp-routers-with-route-server: + +Configuration of the BGP routers with Route Server +-------------------------------------------------- + +To convert the initial scenario into one with route server, first we must +modify the configuration of routers RA, RB and RC. Now they must not peer +between them, but only with the route server. For example, RA's +configuration would turn into: + +:: + + # Configuration for router 'RA' + ! + hostname RA + password **** + ! + router bgp 65001 + no bgp default ipv4-unicast + neighbor 2001:0DB8::FFFF remote-as 65000 + ! + address-family ipv6 + network 2001:0DB8:AAAA:1::/64 + network 2001:0DB8:AAAA:2::/64 + network 2001:0DB8:0000:1::/64 + network 2001:0DB8:0000:2::/64 + + neighbor 2001:0DB8::FFFF activate + neighbor 2001:0DB8::FFFF soft-reconfiguration inbound + exit-address-family + ! + line vty + ! + + +Which is logically much simpler than its initial configuration, as it now +maintains only one BGP peering and all the filters (route-maps) have +disappeared. + +.. _configuration-of-the-route-server-itself: + +Configuration of the Route Server itself +---------------------------------------- + +As we said when we described the functions of a route server +(:ref:`description-of-the-route-server-model`), it is in charge of all the +route filtering. To achieve that, the In and Out filters from the RA, RB and RC +configurations must be converted into Import and Export policies in the route +server. + +This is a fragment of the route server configuration (we only show +the policies for client RA): + +:: + + # Configuration for Route Server ('RS') + ! + hostname RS + password ix + ! + bgp multiple-instance + ! + router bgp 65000 view RS + no bgp default ipv4-unicast + neighbor 2001:0DB8::A remote-as 65001 + neighbor 2001:0DB8::B remote-as 65002 + neighbor 2001:0DB8::C remote-as 65003 + ! + address-family ipv6 + neighbor 2001:0DB8::A activate + neighbor 2001:0DB8::A route-server-client + neighbor 2001:0DB8::A route-map RSCLIENT-A-IMPORT import + neighbor 2001:0DB8::A route-map RSCLIENT-A-EXPORT export + neighbor 2001:0DB8::A soft-reconfiguration inbound + + neighbor 2001:0DB8::B activate + neighbor 2001:0DB8::B route-server-client + neighbor 2001:0DB8::B route-map RSCLIENT-B-IMPORT import + neighbor 2001:0DB8::B route-map RSCLIENT-B-EXPORT export + neighbor 2001:0DB8::B soft-reconfiguration inbound + + neighbor 2001:0DB8::C activate + neighbor 2001:0DB8::C route-server-client + neighbor 2001:0DB8::C route-map RSCLIENT-C-IMPORT import + neighbor 2001:0DB8::C route-map RSCLIENT-C-EXPORT export + neighbor 2001:0DB8::C soft-reconfiguration inbound + exit-address-family + ! + ipv6 prefix-list COMMON-PREFIXES seq 5 permit 2001:0DB8:0000::/48 ge 64 le 64 + ipv6 prefix-list COMMON-PREFIXES seq 10 deny any + ! + ipv6 prefix-list PEER-A-PREFIXES seq 5 permit 2001:0DB8:AAAA::/48 ge 64 le 64 + ipv6 prefix-list PEER-A-PREFIXES seq 10 deny any + ! + ipv6 prefix-list PEER-B-PREFIXES seq 5 permit 2001:0DB8:BBBB::/48 ge 64 le 64 + ipv6 prefix-list PEER-B-PREFIXES seq 10 deny any + ! + ipv6 prefix-list PEER-C-PREFIXES seq 5 permit 2001:0DB8:CCCC::/48 ge 64 le 64 + ipv6 prefix-list PEER-C-PREFIXES seq 10 deny any + ! + route-map RSCLIENT-A-IMPORT permit 10 + match peer 2001:0DB8::B + call A-IMPORT-FROM-B + route-map RSCLIENT-A-IMPORT permit 20 + match peer 2001:0DB8::C + call A-IMPORT-FROM-C + ! + route-map A-IMPORT-FROM-B permit 10 + match ipv6 address prefix-list COMMON-PREFIXES + set metric 100 + route-map A-IMPORT-FROM-B permit 20 + match ipv6 address prefix-list PEER-B-PREFIXES + set community 65001:11111 + ! + route-map A-IMPORT-FROM-C permit 10 + match ipv6 address prefix-list COMMON-PREFIXES + set metric 200 + route-map A-IMPORT-FROM-C permit 20 + match ipv6 address prefix-list PEER-C-PREFIXES + set community 65001:22222 + ! + route-map RSCLIENT-A-EXPORT permit 10 + match peer 2001:0DB8::B + match ipv6 address prefix-list PEER-A-PREFIXES + route-map RSCLIENT-A-EXPORT permit 20 + match peer 2001:0DB8::C + match ipv6 address prefix-list PEER-A-PREFIXES + ! + ... + ... + ... + + +If you compare the initial configuration of RA with the route server +configuration above, you can see how easy it is to generate the Import and +Export policies for RA from the In and Out route-maps of RA's original +configuration. + +When there was no route server, RA maintained two peerings, one with RB and +another with RC. Each of this peerings had an In route-map configured. To +build the Import route-map for client RA in the route server, simply add +route-map entries following this scheme: + +:: + + route-map permit 10 + match peer + call + route-map permit 20 + match peer + call + + +This is exactly the process that has been followed to generate the route-map +RSCLIENT-A-IMPORT. The route-maps that are called inside it (A-IMPORT-FROM-B +and A-IMPORT-FROM-C) are exactly the same than the In route-maps from the +original configuration of RA (PEER-B-IN and PEER-C-IN), only the name is +different. + +The same could have been done to create the Export policy for RA (route-map +RSCLIENT-A-EXPORT), but in this case the original Out route-maps where so +simple that we decided not to use the `call WORD` commands, and we +integrated all in a single route-map (RSCLIENT-A-EXPORT). + +The Import and Export policies for RB and RC are not shown, but +the process would be identical. + +Further considerations about Import and Export route-maps +--------------------------------------------------------- + +The current version of the route server patch only allows to specify a +route-map for import and export policies, while in a standard BGP speaker +apart from route-maps there are other tools for performing input and output +filtering (access-lists, community-lists, ...). But this does not represent +any limitation, as all kinds of filters can be included in import/export +route-maps. For example suppose that in the non-route-server scenario peer +RA had the following filters configured for input from peer B: + +:: + + neighbor 2001:0DB8::B prefix-list LIST-1 in + neighbor 2001:0DB8::B filter-list LIST-2 in + neighbor 2001:0DB8::B route-map PEER-B-IN in + ... + ... + route-map PEER-B-IN permit 10 + match ipv6 address prefix-list COMMON-PREFIXES + set local-preference 100 + route-map PEER-B-IN permit 20 + match ipv6 address prefix-list PEER-B-PREFIXES + set community 65001:11111 + + +It is posible to write a single route-map which is equivalent to +the three filters (the community-list, the prefix-list and the +route-map). That route-map can then be used inside the Import +policy in the route server. Lets see how to do it: + +:: + + neighbor 2001:0DB8::A route-map RSCLIENT-A-IMPORT import + ... + ! + ... + route-map RSCLIENT-A-IMPORT permit 10 + match peer 2001:0DB8::B + call A-IMPORT-FROM-B + ... + ... + ! + route-map A-IMPORT-FROM-B permit 1 + match ipv6 address prefix-list LIST-1 + match as-path LIST-2 + on-match goto 10 + route-map A-IMPORT-FROM-B deny 2 + route-map A-IMPORT-FROM-B permit 10 + match ipv6 address prefix-list COMMON-PREFIXES + set local-preference 100 + route-map A-IMPORT-FROM-B permit 20 + match ipv6 address prefix-list PEER-B-PREFIXES + set community 65001:11111 + ! + ... + ... + + +The route-map A-IMPORT-FROM-B is equivalent to the three filters (LIST-1, +LIST-2 and PEER-B-IN). The first entry of route-map A-IMPORT-FROM-B (sequence +number 1) matches if and only if both the prefix-list LIST-1 and the +filter-list LIST-2 match. If that happens, due to the 'on-match goto 10' +statement the next route-map entry to be processed will be number 10, and as of +that point route-map A-IMPORT-FROM-B is identical to PEER-B-IN. If the first +entry does not match, `on-match goto 10`' will be ignored and the next +processed entry will be number 2, which will deny the route. + +Thus, the result is the same that with the three original filters, i.e., if +either LIST-1 or LIST-2 rejects the route, it does not reach the route-map +PEER-B-IN. In case both LIST-1 and LIST-2 accept the route, it passes to +PEER-B-IN, which can reject, accept or modify the route. From 6ee602cd137b63c2a3913d76d79819c5da9f9ccb Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 12:19:28 -0500 Subject: [PATCH 052/148] doc: fixup more broken xrefs Signed-off-by: Quentin Young --- doc/user/appendix.rst | 10 +- doc/user/isisd.rst | 10 +- doc/user/ospf_fundamentals.rst | 18 ++-- doc/user/ospfd.rst | 179 +++++++++++++++------------------ doc/user/protocol.rst | 2 +- doc/user/routeserver.rst | 4 + doc/user/vnc.rst | 11 +- 7 files changed, 110 insertions(+), 124 deletions(-) diff --git a/doc/user/appendix.rst b/doc/user/appendix.rst index 8f0343da58..6120c3b989 100644 --- a/doc/user/appendix.rst +++ b/doc/user/appendix.rst @@ -3,10 +3,7 @@ Packet Binary Dump Format ========================= -Packet Binary Dump Format -------------------------- - -FRR can dump routing protocol packet into file with a binary format. +FRR can dump routing protocol packets into a file with a binary format. It seems to be better that we share the MRT's header format for backward compatibility with MRT's dump logs. We should also define the @@ -211,12 +208,13 @@ The file specified in "File Name" contains all routing entries, which are in the format of ``subtype == BGP4MP_ENTRY``. :: + Constants: - /* type value */ + /\* type value \*/ #define MSG_PROTOCOL_BGP4MP 16 #define MSG_PROTOCOL_BGP4MP_ET 17 - /* subtype value */ + /\* subtype value \*/ #define BGP4MP_STATE_CHANGE 0 #define BGP4MP_MESSAGE 1 #define BGP4MP_ENTRY 2 diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 23b1af57ab..139d024e4f 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -39,12 +39,10 @@ writing, *isisd* does not support multiple ISIS processes. .. index:: no router isis WORD .. clicmd:: no router isis WORD - .. _router-isis-word: - Enable or disable the ISIS process by specifying the ISIS domain with 'WORD'. *isisd* does not yet support multiple ISIS processes but you must specify the name of ISIS process. The ISIS process name 'WORD' is then used - for interface (see command :ref:`ip-router-isis-word`). + for interface (see command :clicmd:`ip router isis WORD`). .. index:: net XX.XXXX. ... .XXX.XX .. clicmd:: net XX.XXXX. ... .XXX.XX @@ -91,8 +89,6 @@ writing, *isisd* does not support multiple ISIS processes. .. index:: no metric-style .. clicmd:: no metric-style -.. _metric-style: - Set old-style (ISO 10589) or new-style packet formats: - narrow @@ -203,7 +199,7 @@ ISIS interface Activate ISIS adjacency on this interface. Note that the name of ISIS instance must be the same as the one used to configure the ISIS process - (see command :ref:`router-isis-word`). + (see command :clicmd:`router isis WORD`). .. index:: isis circuit-type [level-1 | level-1-2 | level-2] .. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2] @@ -284,7 +280,7 @@ ISIS interface Set default metric value globally, for an area (level-1) or a domain (level-2). Max value depend if metric support narrow or wide value (see - command :ref:`metric-style`). + command :clicmd:`metric-style [narrow | transition | wide]`). .. index:: isis network point-to-point .. clicmd:: isis network point-to-point diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index b9c2139a20..479b53a73c 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -121,10 +121,8 @@ OSPF defines several related mechanisms, used to manage synchronisation of :abbr:`LSDB` s between neighbours as neighbours form adjacencies and the propogation, or :term:`flooding` of new or updated :abbr:`LSA` s. -:ref:`ospf-flooding`. - - .. index:: OSPF Areas overview + .. _ospf-areas: Areas @@ -174,7 +172,11 @@ All LSAs share a common header with the following information: - Advertising Router - The Router ID of the router originating the LSA, see :ref:`ospf-router-id`. + The Router ID of the router originating the LSA. + +.. seealso:: + + :clicmd:`ospf router-id A.B.C.D`. - LSA ID @@ -186,7 +188,7 @@ All LSAs share a common header with the following information: The combination of the Type, ID and Advertising Router ID must uniquely identify the :abbr:`LSA`. There can however be multiple instances of an LSA with the same Type, LSA ID and Advertising Router ID, see - :ref:`ospf-lsa-sequence-number,,lsa-sequence-number`. + :ref:`Sequence Number `. - Age @@ -206,7 +208,7 @@ All LSAs share a common header with the following information: a router has shutdown without flushing its LSA(s), e.g. where it has become disconnected from the network. Such LSAs do little harm. - .. _ospf-lsa-sequence-number: +.. _ospf-lsa-sequence-number: - Sequence Number @@ -232,7 +234,7 @@ called :term:`intra-area routes`. Cost The output cost of that interface, scaled inversely to some commonly known - reference value, :ref:`ospf-auto-cost-reference-bandwidth,,auto-cost-reference-bandwidth`. + reference value, :clicmd:`auto-cost reference-bandwidth (1-4294967`. Link Type Transit Network @@ -272,7 +274,7 @@ called :term:`intra-area routes`. Stub links may also be used as a way to describe links on which OSPF is *not* spoken, known as :term:`passive interfaces`, see - :ref:`ospf-passive-interface,,passive-interface`. + :clicmd:`passive-interface INTERFACE`. - Network LSA diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 5b2b5abd48..430b32af1c 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -51,8 +51,6 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no ospf router-id .. clicmd:: no ospf router-id -.. _ospf-router-id: - This sets the router-ID of the OSPF process. The router-ID may be an IP address of the router, but need not be - it can be any arbitrary 32bit number. However it MUST be unique within the @@ -67,36 +65,36 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no ospf abr-type TYPE .. clicmd:: no ospf abr-type TYPE - `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types - are equivalent. + `type` can be cisco|ibm|shortcut|standard. The "Cisco" and "IBM" types + are equivalent. - The OSPF standard for ABR behaviour does not allow an ABR to consider - routes through non-backbone areas when its links to the backbone are - down, even when there are other ABRs in attached non-backbone areas - which still can reach the backbone - this restriction exists primarily - to ensure routing-loops are avoided. + The OSPF standard for ABR behaviour does not allow an ABR to consider + routes through non-backbone areas when its links to the backbone are + down, even when there are other ABRs in attached non-backbone areas + which still can reach the backbone - this restriction exists primarily + to ensure routing-loops are avoided. - With the "Cisco" or "IBM" ABR type, the default in this release of - FRR, this restriction is lifted, allowing an ABR to consider - summaries learnt from other ABRs through non-backbone areas, and hence - route via non-backbone areas as a last resort when, and only when, - backbone links are down. + With the "Cisco" or "IBM" ABR type, the default in this release of + FRR, this restriction is lifted, allowing an ABR to consider + summaries learnt from other ABRs through non-backbone areas, and hence + route via non-backbone areas as a last resort when, and only when, + backbone links are down. - Note that areas with fully-adjacent virtual-links are considered to be - "transit capable" and can always be used to route backbone traffic, and - hence are unaffected by this setting (:ref:`ospf-virtual-link`). + Note that areas with fully-adjacent virtual-links are considered to be + "transit capable" and can always be used to route backbone traffic, and + hence are unaffected by this setting (:clicmd:`area A.B.C.D virtual-link A.B.C.D`). - More information regarding the behaviour controlled by this command can - be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. + More information regarding the behaviour controlled by this command can + be found in :rfc:`3509`, and :t:`draft-ietf-ospf-shortcut-abr-02.txt`. - Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` - in the OSPF specification does not require a router with multiple - attached areas to have a backbone connection, it is actually - necessary to provide successful routing to the inter-area and - external destinations. If this requirement is not met, all traffic - destined for the areas not connected to such an ABR or out of the - OSPF domain, is dropped. This document describes alternative ABR - behaviors implemented in Cisco and IBM routers." + Quote: "Though the definition of the :abbr:`ABR (Area Border Router)` + in the OSPF specification does not require a router with multiple + attached areas to have a backbone connection, it is actually + necessary to provide successful routing to the inter-area and + external destinations. If this requirement is not met, all traffic + destined for the areas not connected to such an ABR or out of the + OSPF domain, is dropped. This document describes alternative ABR + behaviors implemented in Cisco and IBM routers." .. index:: ospf rfc1583compatibility .. clicmd:: ospf rfc1583compatibility @@ -129,16 +127,14 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no passive-interface INTERFACE .. clicmd:: no passive-interface INTERFACE -.. _ospf-passive-interface: - - Do not speak OSPF interface on the - given interface, but do advertise the interface as a stub link in the - router-:abbr:`LSA (Link State Advertisement)` for this router. This - allows one to advertise addresses on such connected interfaces without - having to originate AS-External/Type-5 LSAs (which have global flooding - scope) - as would occur if connected addresses were redistributed into - OSPF (:ref:`redistribute-routes-to-ospf`). This is the only way to - advertise non-OSPF links into stub areas. + Do not speak OSPF interface on the + given interface, but do advertise the interface as a stub link in the + router-:abbr:`LSA (Link State Advertisement)` for this router. This + allows one to advertise addresses on such connected interfaces without + having to originate AS-External/Type-5 LSAs (which have global flooding + scope) - as would occur if connected addresses were redistributed into + OSPF (:ref:`redistribute-routes-to-ospf`). This is the only way to + advertise non-OSPF links into stub areas. .. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME .. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME @@ -164,7 +160,7 @@ writing, *ospfd* does not support multiple OSPF processes. by the `maximum-holdtime` configured with this command. If the adaptive hold-time elapses without any SPF-triggering event occuring then the current holdtime is reset to the `initial-holdtime`. The current - holdtime can be viewed with :ref:`show-ip-ospf`, where it is expressed as + holdtime can be viewed with :clicmd:`show ip ospf`, where it is expressed as a multiplier of the `initial-holdtime`. :: @@ -218,7 +214,7 @@ writing, *ospfd* does not support multiple OSPF processes. Configured state of this feature as well as current status, such as the number of second remaining till on-startup or on-shutdown ends, can be - viewed with the :ref:`show-ip-ospf` command. + viewed with the :clicmd:`show ip ospf` command. .. index:: auto-cost reference-bandwidth (1-4294967) .. clicmd:: auto-cost reference-bandwidth (1-4294967) @@ -226,8 +222,6 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no auto-cost reference-bandwidth .. clicmd:: no auto-cost reference-bandwidth -.. _OSPF-auto-cost-reference-bandwidth: - This sets the reference bandwidth for cost calculations, where this bandwidth is considered equivalent to an OSPF cost of 1, specified in Mbits/s. The default is @@ -250,8 +244,6 @@ writing, *ospfd* does not support multiple OSPF processes. .. index:: no network A.B.C.D/M area (0-4294967295) .. clicmd:: no network A.B.C.D/M area (0-4294967295) -.. _ospf-network-command: - This command specifies the OSPF enabled interface(s). If the interface has an address from range 192.168.1.0/24 then the command below enables ospf on this interface so router can provide network information to the other @@ -276,7 +268,7 @@ writing, *ospfd* does not support multiple OSPF processes. contains the local address prefix of the interface. In some cases it may be more convenient to enable OSPF on a per - interface/subnet basis (:ref:`ospf-ip-ospf-area-command`). + interface/subnet basis (:clicmd:`ip ospf area AREA [ADDR]`). .. _ospf-area: @@ -357,8 +349,6 @@ OSPF area .. index:: no area (0-4294967295) virtual-link A.B.C.D .. clicmd:: no area (0-4294967295) virtual-link A.B.C.D -.. _OSPF-virtual-link: - .. index:: area A.B.C.D shortcut .. clicmd:: area A.B.C.D shortcut @@ -513,15 +503,13 @@ OSPF area .. index:: area (0-4294967295) authentication message-digest .. clicmd:: area (0-4294967295) authentication message-digest -.. _area-authentication-message-digest: + Specify that OSPF packets must be authenticated with MD5 HMACs within the + given area. Keying material must also be configured on a per-interface basis + (:clicmd:`ip ospf message-digest-key`). - Specify that OSPF packets - must be authenticated with MD5 HMACs within the given area. Keying - material must also be configured on a per-interface basis (:ref:`ip-ospf-message-digest-key`). - - MD5 authentication may also be configured on a per-interface basis - (:ref:`ip-ospf-authentication-message-digest`). Such per-interface - settings will override any per-area authentication setting. + MD5 authentication may also be configured on a per-interface basis + (:clicmd:`ip ospf authentication message-digest`). Such per-interface + settings will override any per-area authentication setting. .. _ospf-interface: @@ -534,11 +522,10 @@ OSPF interface .. index:: no ip ospf area [ADDR] .. clicmd:: no ip ospf area [ADDR] -.. _ospf-ip-ospf-area-command: - Enable OSPF on the interface, optionally restricted to just the IP address - given by `ADDR`, putting it in the `AREA` area. Per interface area - settings take precedence to network commands (:ref:`ospf-network-command`). + given by `ADDR`, putting it in the `AREA` area. Per interface area settings + take precedence to network commands + (:clicmd:`network A.B.C.D/M area A.B.C.D`). If you have a lot of interfaces, and/or a lot of subnets, then enabling OSPF via this command may result in a slight performance improvement. @@ -553,26 +540,24 @@ OSPF interface all OSPF packets are authenticated. `AUTH_KEY` has length up to 8 chars. Simple text password authentication is insecure and deprecated in favour of - MD5 HMAC authentication (:ref:`ip-ospf-authentication-message-digest`). + MD5 HMAC authentication. .. index:: ip ospf authentication message-digest .. clicmd:: ip ospf authentication message-digest -.. _ip-ospf-authentication-message-digest: - - Specify that MD5 HMAC - authentication must be used on this interface. MD5 keying material must - also be configured (:ref:`ip-ospf-message-digest-key`). Overrides any - authentication enabled on a per-area basis (:ref:`area-authentication-message-digest`). + Specify that MD5 HMAC authentication must be used on this interface. MD5 + keying material must also be configured. Overrides any authentication + enabled on a per-area basis + (:clicmd:`area A.B.C.D authentication message-digest`) Note that OSPF MD5 authentication requires that time never go backwards (correct time is NOT important, only that it never goes backwards), even across resets, if ospfd is to be able to promptly reestabish adjacencies - with its neighbours after restarts/reboots. The host should have system - time be set at boot from an external or non-volatile source (eg battery backed clock, NTP, - etc.) or else the system clock should be periodically saved to non-volative - storage and restored at boot if MD5 authentication is to be expected to work - reliably. + with its neighbours after restarts/reboots. The host should have system time + be set at boot from an external or non-volatile source (eg battery backed + clock, NTP, etc.) or else the system clock should be periodically saved to + non-volative storage and restored at boot if MD5 authentication is to be + expected to work reliably. .. index:: ip ospf message-digest-key KEYID md5 KEY .. clicmd:: ip ospf message-digest-key KEYID md5 KEY @@ -580,17 +565,15 @@ OSPF interface .. index:: no ip ospf message-digest-key .. clicmd:: no ip ospf message-digest-key -.. _ip-ospf-message-digest-key: + Set OSPF authentication key to a cryptographic password. The cryptographic + algorithm is MD5. - Set OSPF authentication key to a - cryptographic password. The cryptographic algorithm is MD5. + KEYID identifies secret key used to create the message digest. This ID + is part of the protocol and must be consistent across routers on a + link. - KEYID identifies secret key used to create the message digest. This ID - is part of the protocol and must be consistent across routers on a - link. - - KEY is the actual message digest key, of up to 16 chars (larger strings - will be truncated), and is associated with the given KEYID. + KEY is the actual message digest key, of up to 16 chars (larger strings + will be truncated), and is associated with the given KEYID. .. index:: ip ospf cost (1-65535) .. clicmd:: ip ospf cost (1-65535) @@ -610,21 +593,18 @@ OSPF interface .. index:: no ip ospf dead-interval .. clicmd:: no ip ospf dead-interval -.. _ip-ospf-dead-interval-minimal: + Set number of seconds for RouterDeadInterval timer value used for Wait Timer + and Inactivity Timer. This value must be the same for all routers attached + to a common network. The default value is 40 seconds. - Set number of seconds for - RouterDeadInterval timer value used for Wait Timer and Inactivity - Timer. This value must be the same for all routers attached to a - common network. The default value is 40 seconds. - - If 'minimal' is specified instead, then the dead-interval is set to 1 - second and one must specify a hello-multiplier. The hello-multiplier - specifies how many Hellos to send per second, from 2 (every 500ms) to - 20 (every 50ms). Thus one can have 1s convergence time for OSPF. If this form - is specified, then the hello-interval advertised in Hello packets is set to - 0 and the hello-interval on received Hello packets is not checked, thus - the hello-multiplier need NOT be the same across multiple routers on a common - link. + If 'minimal' is specified instead, then the dead-interval is set to 1 second + and one must specify a hello-multiplier. The hello-multiplier specifies how + many Hellos to send per second, from 2 (every 500ms) to 20 (every 50ms). + Thus one can have 1s convergence time for OSPF. If this form is specified, + then the hello-interval advertised in Hello packets is set to 0 and the + hello-interval on received Hello packets is not checked, thus the + hello-multiplier need NOT be the same across multiple routers on a common + link. .. index:: ip ospf hello-interval (1-65535) .. clicmd:: ip ospf hello-interval (1-65535) @@ -637,7 +617,8 @@ OSPF interface This value must be the same for all routers attached to a common network. The default value is 10 seconds. - This command has no effect if :ref:`ip-ospf-dead-interval-minimal` is also + This command has no effect if + :clicmd:`ip ospf dead-interval minimal hello-multiplier (2-20)` is also specified for the interface. .. index:: ip ospf network (broadcast|non-broadcast|point-to-multipoint|point-to-point) @@ -725,7 +706,7 @@ Redistribute routes to OSPF or kind into OSPF, with the metric type and metric set if specified, filtering the routes using the given route-map if specified. Redistributed routes may also be filtered with distribute-lists, see - :ref:`ospf-distribute-list`. + :ref:`OSPF distribute-list configuration `. Redistributed routes are distributed as into OSPF as Type-5 External LSAs into links to areas that accept external routes, Type-7 External LSAs @@ -733,7 +714,11 @@ Redistribute routes to OSPF external routes are not permitted. Note that for connected routes, one may instead use - :term:`passive-interface`, see :ref:`ospf-passive-interface`. + :term:`passive-interface`; + +.. seealso:: + + clicmd:`passive-interface INTERFACE`. .. index:: default-information originate .. clicmd:: default-information originate @@ -777,7 +762,7 @@ Redistribute routes to OSPF Apply the access-list filter, NAME, to redistributed routes of the given type before allowing the routes to - redistributed into OSPF (:ref:`ospf-redistribute`). + redistributed into OSPF (:ref:`OSPF redistribution `). .. index:: default-metric (0-16777214) .. clicmd:: default-metric (0-16777214) diff --git a/doc/user/protocol.rst b/doc/user/protocol.rst index bdd9c6b180..d35177962c 100644 --- a/doc/user/protocol.rst +++ b/doc/user/protocol.rst @@ -1,4 +1,4 @@ -.. _Zebra-Protocol +.. _Zebra-Protocol: ************** Zebra Protocol diff --git a/doc/user/routeserver.rst b/doc/user/routeserver.rst index 86fab0249f..890897bb62 100644 --- a/doc/user/routeserver.rst +++ b/doc/user/routeserver.rst @@ -43,6 +43,7 @@ it consists of three steps: accepted by the `Out` filters of a peer are announced to that peer. .. _fig-normal-processing: + .. figure:: ../figures/fig-normal-processing.png :alt: Normal announcement processing :align: center @@ -50,6 +51,7 @@ it consists of three steps: Announcement processing inside a 'normal' BGP speaker .. _fig-topologies-full: + .. figure:: ../figures/fig_topologies_full.png :alt: Full Mesh BGP Topology :align: center @@ -57,6 +59,7 @@ it consists of three steps: Full Mesh .. _fig-topologies-rs: + .. figure:: ../figures/fig_topologies_rs.png :alt: Route Server BGP Topology :align: center @@ -69,6 +72,7 @@ having a single BGP peering (against the route server), the BGP speakers can no longer distinguish from/to which peer each announce comes/goes. .. _filter-delegation: + This means that the routers connected to the route server are not able to apply by themselves the same input/output filters as in the full mesh scenario, so they have to delegate those functions to the route server. diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index c7de34458d..e3bff68d8a 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -56,8 +56,8 @@ following areas: .. _general-vnc-configuration: -.. General VNC Configuration -.. ------------------------- +General VNC Configuration +------------------------- .. _rfp-related-configuration: @@ -246,7 +246,7 @@ Defaults section. - ``IPv4-address:two-byte-integer`` - ``four-byte-autonomous-system-number:two-byte-integer`` - ``two-byte-autonomous-system-number:four-byte-integer`` - - ``auto:vn:`two-byte-integer` + - ``auto:vn:two-byte-integer`` Routes originated by NVEs in the NVE group will use the group's specified `route-distinguisher` when they are advertised via BGP. If the `auto` form @@ -902,7 +902,7 @@ Mesh NVA Configuration This example includes three NVAs, nine NVEs, and two NVE groups. Note that while not shown, a single physical device may support multiple logical NVEs. -:ref:`fig-vnc-mesh` shows ``code NVA-1`` (192.168.1.100), ``NVA 2`` +:ref:`vnc-fig-vnc-mesh` shows ``code NVA-1`` (192.168.1.100), ``NVA 2`` (192.168.1.101), and ``NVA 3`` (192.168.1.102), which are connected in a full mesh. Each is a member of the autonomous system 64512. Each NVA provides VNC services to three NVE clients in the 172.16.0.0/16 virtual-network address @@ -918,6 +918,7 @@ Each NVA advertises NVE underlay-network IP addresses using the Tunnel Encapsulation Attribute. .. _vnc-fig-vnc-mesh: + .. figure:: ../figures/fig-vnc-mesh.png :align: center :alt: Three-way Mesh @@ -1229,7 +1230,7 @@ While not shown, an NVA can also be configured as a route reflector. VNC with Commercial Route Reflector Configuration ------------------------------------------------- -This example is identical to :ref:`vnc-with-frr-route-reflector-configuration` +This example is identical to :ref:`vnc-with-frr-route-reflector-config` with the exception that the route reflector is a commercial router. Only the VNC-relevant configuration is provided. From 9bea107f2d0f19dea004136d973b92807e833a62 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 12:52:50 -0500 Subject: [PATCH 053/148] doc: fixup vnc.rst to only define commands once Replaced stub definitions of CLI with references to their full definitions so that Sphinx can properly cross reference them. Signed-off-by: Quentin Young --- doc/user/vnc.rst | 112 ++++++++--------------------------------------- 1 file changed, 19 insertions(+), 93 deletions(-) diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index e3bff68d8a..04b4593b79 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -98,76 +98,17 @@ Enter VNC configuration mode for specifying VNC default behaviors. Use These are the statements that can appear between ``vnc defaults`` and -``exit-vnc``. +``exit-vnc``. Documentation for these statements is given in +:ref:`vnc-nve-group-configuration`. -.. index:: rt import RT-LIST -.. clicmd:: rt import RT-LIST - -.. index:: rt export RT-LIST -.. clicmd:: rt export RT-LIST - -.. index:: rt both RT-LIST -.. clicmd:: rt both RT-LIST - - Specify default route target import and export lists. `rt-list` is a - space-separated list of route targets, each element of which is - in one of the following forms: - - - ``IPv4-address:two-byte-integer`` - - ``four-byte-autonomous-system-number:two-byte-integer`` - - ``two-byte-autonomous-system-number:four-byte-integer`` - - If no default import RT list is specified, then the default import RT list - is empty. If no default export RT list is specified, then the default export - RT list is empty. - - A complete definition of these parameters is given below - (:ref:`vnc-nve-group-configuration`). - -.. index:: rd route-distinguisher -.. clicmd:: rd ROUTE-DISTINGUISHER - - Specify the default route distinguisher (RD) for routes advertised via BGP - VPNs. The route distinguisher must be in one of four forms: - - - ``IPv4-address:two-byte-integer`` - - ``four-byte-autonomous-system-number:two-byte-integer`` - - ``two-byte-autonomous-system-number:four-byte-integer`` - - ``auto:vn:two-byte-integer`` - - If RD is specified in the defaults section, the default RD value is - `two-byte-autonomous-system-number=0:four-byte-integer=0`. - - A complete definition of this parameter is given below - (:ref:`vnc-nve-group-configuration`). - -.. index:: l2rd NVE-ID-VALUE -.. clicmd:: l2rd NVE-ID-VALUE - - Set the value used to distinguish NVEs connected to the same logical - Ethernet segment (i.e., L2VPN). A complete definition of this parameter is - given below (:ref:`vnc-nve-group-configuration`). - -.. index:: response-lifetime LIFETIME|infinite -.. clicmd:: response-lifetime LIFETIME|infinite - - Specify the default lifetime to be included in RFP response messages sent to - NVEs. - - A complete definition of this parameter is given below - (:ref:`vnc-nve-group-configuration`). - -.. index:: export bgp|zebra route-map MAP-NAME -.. clicmd:: export bgp|zebra route-map MAP-NAME - - Specify that the named route-map should be applied to routes being exported - to bgp or zebra. - -.. index:: export bgp|zebra no route-map -.. clicmd:: export bgp|zebra no route-map - - Specify that no route-map should be applied to routes being exported to bgp - or zebra. +- :clicmd:`rt import RT-LIST` +- :clicmd:`rt export RT-LIST` +- :clicmd:`rt both RT-LIST` +- :clicmd:`rd ROUTE-DISTINGUISHER` +- :clicmd:`l2rd NVE-ID-VALUE` +- :clicmd:`response-lifetime LIFETIME|infinite` +- :clicmd:`export bgp|zebra route-map MAP-NAME` +- :clicmd:`export bgp|zebra no route-map` .. index:: exit-vnc .. clicmd:: exit-vnc @@ -672,30 +613,24 @@ a corresponding `redistribute vnc-direct` statement. next hop corresponding to one of the N NVEs currently associated with the nve-group. -.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME -.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME +Some commands have a special meaning under certain export modes. +:clicmd:`export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME` When export mode is `ce` or `registering-nve`, specifies that the named prefix-list should be applied to routes being exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of each other. -.. index:: export bgp|zebra no ipv4|ipv6 prefix-list -.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list - +:clicmd:`export bgp|zebra no ipv4|ipv6 prefix-list` When export mode is `ce` or `registering-nve`, specifies that no prefix-list should be applied to routes being exported to bgp or zebra. -.. index:: export bgp|zebra route-map MAP-NAME -.. clicmd:: export bgp|zebra route-map MAP-NAME - +:clicmd:`export bgp|zebra route-map MAP-NAME` When export mode is `ce` or `registering-nve`, specifies that the named route-map should be applied to routes being exported to bgp or zebra. -.. index:: export bgp|zebra no route-map -.. clicmd:: export bgp|zebra no route-map - +:clicmd:`export bgp|zebra no route-map` When export mode is `ce` or `registering-nve`, specifies that no route-map should be applied to routes being exported to bgp or zebra. @@ -703,32 +638,23 @@ a corresponding `redistribute vnc-direct` statement. per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block via the following commands(:ref:`vnc-nve-group-configuration`): -.. index:: export bgp|zebra route-map MAP-NAME -.. clicmd:: export bgp|zebra route-map MAP-NAME - +:clicmd:`export bgp|zebra route-map MAP-NAME` This command is valid inside a `nve-group` `RFG-NAME` block. It specifies that the named route-map should be applied to routes being exported to bgp or zebra. -.. index:: export bgp|zebra no route-map -.. clicmd:: export bgp|zebra no route-map - +:clicmd:`export bgp|zebra no route-map` This command is valid inside a `nve-group` `RFG-NAME` block. It specifies that no route-map should be applied to routes being exported to bgp or zebra. -.. index:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME -.. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME - +:clicmd:`export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME` This command is valid inside a `nve-group` `RFG-NAME` block. It specifies that the named prefix-list filter should be applied to routes being exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of each other. -.. index:: export bgp|zebra no ipv4|ipv6 prefix-list - -.. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list - +:clicmd:`export bgp|zebra no ipv4|ipv6 prefix-list` This command is valid inside a `nve-group` `RFG-NAME` block. It specifies that no prefix-list filter should be applied to routes being exported to bgp or zebra. From 623333072e3cd32e66debfeb970b67c94520e1c9 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 13:33:41 -0500 Subject: [PATCH 054/148] doc: add glossary Glossary of some common terms, fixes non-existing glossary definition warnings. Signed-off-by: Quentin Young --- doc/user/eigrpd.rst | 8 ++++++- doc/user/glossary.rst | 37 ++++++++++++++++++++++++++++++++ doc/user/index.rst | 1 + doc/user/ospf_fundamentals.rst | 39 +++++++++++++++++----------------- doc/user/ospfd.rst | 10 ++++----- 5 files changed, 69 insertions(+), 26 deletions(-) create mode 100644 doc/user/glossary.rst diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index e063b9a464..309ee27cc4 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -4,9 +4,15 @@ EIGRP ***** +.. glossary:: + + DUAL + The *Diffusing Update ALgorithm*, a :term:`Bellman-Ford` based routing + algorithm used by EIGRP. + EIGRP -- Routing Information Protocol is widely deployed interior gateway routing protocol. EIGRP was developed in the 1990's. EIGRP is a -:term:`distance-vector` protocol and is based on the :term:`dual` algorithms. +:term:`distance-vector` protocol and is based on the :term:`DUAL` algorithms. As a distance-vector protocol, the EIGRP router send updates to its neighbors as networks change, thus allowing the convergence to a known topology. diff --git a/doc/user/glossary.rst b/doc/user/glossary.rst new file mode 100644 index 0000000000..af52857932 --- /dev/null +++ b/doc/user/glossary.rst @@ -0,0 +1,37 @@ +.. glossary:: + + distance-vector + A distance-vector routing protocol in data networks determines the best + route for data packets based on distance. Distance-vector routing + protocols measure the distance by the number of routers a packet has to + pass. Some distance-vector protocols also take into account network + latency and other factors that influence traffic on a given route. To + determine the best route across a network, routers on which a + distance-vector protocol is implemented exchange information with one + another, usually routing tables plus hop counts for destination networks + and possibly other traffic information. Distance-vector routing protocols + also require that a router informs its neighbours of network topology + changes periodically. [distance-vector-rp]_ + + link-state + Link-state algorithms (also known as shortest path first algorithms) + flood routing information to all nodes in the internetwork. Each router, + however, sends only the portion of the routing table that describes the + state of its own links. In link-state algorithms, each router builds a + picture of the entire network in its routing tables. Distance vector + algorithms (also known as Bellman-Ford algorithms) call for each router + to send all or some portion of its routing table, but only to its + neighbors. In essence, link-state algorithms send small updates + everywhere, while distance vector algorithms send larger updates only to + neighboring routers. Distance vector algorithms know only about their + neighbors. [link-state-rp]_ + + Bellman-Ford + The Bellman–Ford algorithm is an algorithm that computes shortest paths + from a single source vertex to all of the other vertices in a weighted + digraph. [bellman-ford]_ + + +.. [distance-vector-rp] https://en.wikipedia.org/wiki/Distance-vector_routing_protocol +.. [link-state-rp] https://en.wikipedia.org/wiki/Link-state_routing_protocol +.. [bellman-ford] https://en.wikipedia.org/wiki/Bellman-Ford_algorithm diff --git a/doc/user/index.rst b/doc/user/index.rst index 036c87c86e..54ee8b12f8 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -26,5 +26,6 @@ Welcome to FRR's documentation! ripd ripngd vnc + glossary appendix diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index 479b53a73c..b0c6f69f7b 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -6,26 +6,25 @@ OSPF Fundamentals .. index:: Link-state routing protocol .. index:: Distance-vector routing protocol -:abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast -to :term:`distance-vector` protocols, such as :abbr:`RIP` or -:abbr:`BGP`, where routers describe available :term:`paths` (i.e. routes) -to each other, in :term:`link-state` protocols routers instead -describe the state of their links to their immediate neighbouring -routers. +:abbr:`OSPF` is, mostly, a link-state routing protocol. In contrast to +:term:`distance-vector` protocols, such as :abbr:`RIP` or :abbr:`BGP`, where +routers describe available `paths` (i.e. routes) to each other, in +:term:`link-state` protocols routers instead describe the state of their links +to their immediate neighbouring routers. .. index:: Link State Announcement .. index:: Link State Advertisement .. index:: LSA flooding .. index:: Link State Database -Each router describes their link-state information in a message known -as an :abbr:`LSA (Link State Advertisement)`, which is then propogated -through to all other routers in a link-state routing domain, by a -process called :term:`flooding`. Each router thus builds up an -:abbr:`LSDB (Link State Database)` of all the link-state messages. From -this collection of LSAs in the LSDB, each router can then calculate the -shortest path to any other router, based on some common metric, by using an -algorithm such as `Edgar Djikstra's `_ +Each router describes their link-state information in a message known as an +:abbr:`LSA (Link State Advertisement)`, which is then propogated through to all +other routers in a link-state routing domain, by a process called `flooding`. +Each router thus builds up an :abbr:`LSDB (Link State Database)` of all the +link-state messages. From this collection of LSAs in the LSDB, each router can +then calculate the shortest path to any other router, based on some common +metric, by using an algorithm such as +`Edgar Djikstra's `_ :abbr:`SPF (Shortest Path First)` algorithm. .. index:: Link-state routing protocol advantages @@ -119,7 +118,7 @@ LSA Flooding OSPF defines several related mechanisms, used to manage synchronisation of :abbr:`LSDB` s between neighbours as neighbours form adjacencies and the -propogation, or :term:`flooding` of new or updated :abbr:`LSA` s. +propogation, or `flooding` of new or updated :abbr:`LSA` s. .. index:: OSPF Areas overview @@ -132,7 +131,7 @@ OSPF provides for the protocol to be broken up into multiple smaller and independent link-state areas. Each area must be connected to a common backbone area by an :abbr:`ABR (Area Boundary Router)`. These :abbr:`ABR` routers are responsible for summarising the link-state routing information of an area into -:term:`Summary LSAs`, possibly in a condensed (i.e. aggregated) form, and then +`Summary LSAs`, possibly in a condensed (i.e. aggregated) form, and then originating these summaries into all other areas the :abbr:`ABR` is connected to. @@ -196,13 +195,13 @@ All LSAs share a common header with the following information: from their :abbr:`LSDB` s. The value nominally is one of seconds. An age of 3600, i.e. 1 hour, is - called the :term:`MaxAge`. MaxAge LSAs are ignored in routing + called the `MaxAge`. MaxAge LSAs are ignored in routing calculations. LSAs must be periodically refreshed by their Advertising Router before reaching MaxAge if they are to remain valid. Routers may deliberately flood LSAs with the age artificially set to 3600 to indicate an LSA is no longer valid. This is called - :term:`flushing` of an LSA. + `flushing` of an LSA. It is not abnormal to see stale LSAs in the LSDB, this can occur where a router has shutdown without flushing its LSA(s), e.g. where it has @@ -224,7 +223,7 @@ protocol. Instances of these LSAs are specific to the link-state area in which they are originated. Routes calculated from these two LSA types are -called :term:`intra-area routes`. +called `intra-area routes`. - Router LSA @@ -273,7 +272,7 @@ called :term:`intra-area routes`. is Full. Stub links may also be used as a way to describe links on which OSPF is - *not* spoken, known as :term:`passive interfaces`, see + *not* spoken, known as `passive interfaces`, see :clicmd:`passive-interface INTERFACE`. - Network LSA diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 430b32af1c..771182024c 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -713,8 +713,8 @@ Redistribute routes to OSPF for NSSA areas and are not redistributed at all into Stub areas, where external routes are not permitted. - Note that for connected routes, one may instead use - :term:`passive-interface`; + Note that for connected routes, one may instead use the `passive-interface` + configuration. .. seealso:: @@ -760,9 +760,9 @@ Redistribute routes to OSPF .. _ospf-distribute-list: - Apply the access-list filter, NAME, to - redistributed routes of the given type before allowing the routes to - redistributed into OSPF (:ref:`OSPF redistribution `). + Apply the access-list filter, NAME, to + redistributed routes of the given type before allowing the routes to + redistributed into OSPF (:ref:`OSPF redistribution `). .. index:: default-metric (0-16777214) .. clicmd:: default-metric (0-16777214) From 11ab5329e0b42ca3632f7cd6b57bff62e3d2c8f5 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 13:45:12 -0500 Subject: [PATCH 055/148] doc: reference style cleanup Signed-off-by: Quentin Young --- doc/user/bgp.rst | 2 +- doc/user/filter.rst | 2 +- doc/user/installation.rst | 2 +- doc/user/ipv6.rst | 2 +- doc/user/ospf6d.rst | 12 ++++++------ doc/user/ospf_fundamentals.rst | 2 +- doc/user/ospfd.rst | 6 +++--- doc/user/overview.rst | 8 ++++---- doc/user/protocol.rst | 2 +- doc/user/ripd.rst | 2 +- doc/user/vnc.rst | 8 ++++---- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index ba4238b946..0cc2c511c3 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -1959,7 +1959,7 @@ _ the end of the line. So `_` can be used for AS value boundaries match. This character technically evaluates to `(^|[,{}() ]|$)`. -.. _How-to-set-up-a-6-Bone-connection: +.. _how-to-set-up-a-6-bone-connection: How to set up a 6-Bone connection ================================= diff --git a/doc/user/filter.rst b/doc/user/filter.rst index 7b52d0a389..57f9fbe426 100644 --- a/doc/user/filter.rst +++ b/doc/user/filter.rst @@ -121,7 +121,7 @@ ip prefix-list sequential number control With this command, the IP prefix list sequential number is not displayed. -.. _Showing-ip-prefix-list: +.. _showing-ip-prefix-list: Showing ip prefix-list ---------------------- diff --git a/doc/user/installation.rst b/doc/user/installation.rst index e09c679594..f9405ac792 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -190,7 +190,7 @@ options to the configuration script. Configure zebra to use `dir` for local state files, such as pid files and unix sockets. -.. _Least-Privilege-support: +.. _least-privilege-support: Least-Privilege Support ----------------------- diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 62457117c7..9d079028ca 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -1,4 +1,4 @@ -.. _IPv6-Support: +.. _ipv6-support: ************ IPv6 Support diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index bd30fb67b0..b0823f21e7 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -1,4 +1,4 @@ -.. _OSPFv3: +.. _ospfv3: ****** OSPFv3 @@ -7,7 +7,7 @@ OSPFv3 *ospf6d* is a daemon support OSPF version 3 for IPv6 network. OSPF for IPv6 is described in :rfc:`2740`. -.. _OSPF6-router: +.. _ospf6-router: OSPF6 router ============ @@ -78,14 +78,14 @@ OSPF6 router This configuration setting MUST be consistent across all routers within the OSPF domain. -.. _OSPF6-area: +.. _ospf6-area: OSPF6 area ========== Area support for OSPFv3 is not yet implemented. -.. _OSPF6-interface: +.. _ospf6-interface: OSPF6 interface =============== @@ -126,7 +126,7 @@ OSPF6 interface Set explicitly network type for specifed interface. -.. _Redistribute-routes-to-OSPF6: +.. _redistribute-routes-to-ospf6: Redistribute routes to OSPF6 ============================ @@ -141,7 +141,7 @@ Redistribute routes to OSPF6 .. clicmd:: redistribute ripng -.. _Showing-OSPF6-information: +.. _showing-ospf6-information: Showing OSPF6 information ========================= diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst index b0c6f69f7b..5a4f7095ed 100644 --- a/doc/user/ospf_fundamentals.rst +++ b/doc/user/ospf_fundamentals.rst @@ -187,7 +187,7 @@ All LSAs share a common header with the following information: The combination of the Type, ID and Advertising Router ID must uniquely identify the :abbr:`LSA`. There can however be multiple instances of an LSA with the same Type, LSA ID and Advertising Router ID, see - :ref:`Sequence Number `. + :ref:`sequence number `. - Age diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 771182024c..574d925495 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -1,4 +1,4 @@ -.. _OSPFv2: +.. _ospfv2: ****** OSPFv2 @@ -706,7 +706,7 @@ Redistribute routes to OSPF or kind into OSPF, with the metric type and metric set if specified, filtering the routes using the given route-map if specified. Redistributed routes may also be filtered with distribute-lists, see - :ref:`OSPF distribute-list configuration `. + :ref:`ospf distribute-list configuration `. Redistributed routes are distributed as into OSPF as Type-5 External LSAs into links to areas that accept external routes, Type-7 External LSAs @@ -762,7 +762,7 @@ Redistribute routes to OSPF Apply the access-list filter, NAME, to redistributed routes of the given type before allowing the routes to - redistributed into OSPF (:ref:`OSPF redistribution `). + redistributed into OSPF (:ref:`ospf redistribution `). .. index:: default-metric (0-16777214) .. clicmd:: default-metric (0-16777214) diff --git a/doc/user/overview.rst b/doc/user/overview.rst index cc6bfa5068..064dc436ea 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -20,7 +20,7 @@ can use FRR library as your program's client user interface. FRR is distributed under the GNU General Public License. -.. _About-FRR: +.. _about-frr: About FRR ========= @@ -276,7 +276,7 @@ posted at `FRR`_. .. index:: Reporting software errors .. index:: Errors in the software -.. _Bug-Reports: +.. _bug-reports: Bug Reports =========== @@ -296,7 +296,7 @@ When you send a bug report, please be careful about the points below. Bug reports help us improve FRR and are very much appreciated. -.. _frr: |PACKAGE-URL| +.. _frr: |package-url| .. _github: https://github.com/frrouting/frr/ -.. _GitHub issues: https://github.com/frrouting/frr/issues +.. _github issues: https://github.com/frrouting/frr/issues .. _slack: https://frrouting.slack.com/ diff --git a/doc/user/protocol.rst b/doc/user/protocol.rst index d35177962c..b474c126bb 100644 --- a/doc/user/protocol.rst +++ b/doc/user/protocol.rst @@ -1,4 +1,4 @@ -.. _Zebra-Protocol: +.. _zebra-protocol: ************** Zebra Protocol diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index dbeb07998f..b8cbd161c6 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -437,7 +437,7 @@ Distance value is used in zebra daemon. Default RIP distance is 120. Set default RIP distance to specified value when the route's source IP address matches the specified prefix and the specified access-list. -.. _RIP-route-map: +.. _rip-route-map: RIP route-map ============= diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 04b4593b79..8be4ff62de 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -1,4 +1,4 @@ -.. _VNC-and-VNC-GW: +.. _vnc-and-vnc-gw: ************** VNC and VNC-GW @@ -291,7 +291,7 @@ Defaults section. :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item is optional. -.. _VNC-L2-Group-Configuration: +.. _vnc-l2-group-configuration: VNC L2 Group Configuration -------------------------- @@ -718,7 +718,7 @@ manually and dynamically added information. `*` in lieu of any VN or UN address, in which case all registrations will match. -.. _Other-VNC-Related-Commands: +.. _other-vnc-related-commands: Other VNC-Related Commands ========================== @@ -816,7 +816,7 @@ related information: Print the number of memory items allocated by the NVA. -.. _Example-VNC-and-VNC-GW-Configurations: +.. _example-vnc-and-vnc-gw-configurations: Example VNC and VNC-GW Configurations ===================================== From 9de103f0c9b27e2942437978e8854813c55cd128 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 15:19:04 -0500 Subject: [PATCH 056/148] doc: document documentation Signed-off-by: Quentin Young --- doc/developer/conf.py | 6 +- doc/developer/workflow.rst | 367 +++++++++++++++++++++++-------------- 2 files changed, 234 insertions(+), 139 deletions(-) diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 1eac6af763..c3295f88bd 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -271,7 +271,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'FRR.tex', u'FRR User Manual', + (master_doc, 'FRR.tex', u"FRR Developer's Manual", u'FRR', 'manual'), ] @@ -301,7 +301,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'frr', u'FRR User Manual', + (master_doc, 'frr', u"FRR Developer's Manual", [author], 1) ] @@ -315,7 +315,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FRR', u'FRR User Manual', + (master_doc, 'FRR', u"FRR Developer's Manual", author, 'FRR', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 88ae7ef761..1f33a51adc 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -1,53 +1,21 @@ +.. _process-and-workflow: + +******************* Process & Workflow -======================== +******************* FRR is a large project developed by many different groups. This section documents standards for code style & quality, commit messages, pull requests and best practices that all contributors are asked to follow. -This section is "descriptive/post-factual" in that it documents pratices that -are in use; it is not "definitive/pre-factual" in prescribing practices. This +This chapter is "descriptive/post-factual" in that it documents pratices that +are in use; it is not "definitive/pre-factual" in prescribing practices. This means that when a procedure changes, it is agreed upon, then put into practice, and then documented here. If this document doesn't match reality, it's the document that needs to be updated, not reality. -Git Structure -------------- - -The master Git for FRR resides on `Github -`__. - -.. figure:: ../figures/git_branches.png - :align: right - :alt: merging get branches into a central trunk - - Rough outline of FRR development workflow - -There is one main branch for development, ``master``. For each major release -(2.0, 3.0 etc) a new release branch is created based on the master. Subsequent -point releases based on a major branch are marked by tagging. - -Programming language, Tools and Libraries ------------------------------------------ - -The core of FRR is written in C (gcc or clang supported) and makes -use of GNU compiler extensions. A few non-essential scripts are -implemented in Perl and Python. FRR requires the following tools -to build distribution packages: automake, autoconf, texinfo, libtool and -gawk and various libraries (i.e. libpam and libjson-c). - -If your contribution requires a new library or other tool, then please -highlight this in your description of the change. Also make sure it’s -supported by all FRR platform OSes or provide a way to build -without the library (potentially without the new feature) on the other -platforms. - -Documentation should be written in reStructuredText. Sphinx extensions may be -utilized but pure ReST is preferred where possible. See `Documentation -<#documentation>`__. - -Mailing lists -------------- +Mailing Lists +============= The FRR development group maintains multiple mailing lists for use by the community. Italicized lists are private. @@ -66,19 +34,17 @@ community. Italicized lists are private. | *Technical Steering Committee* | tsc@lists.frrouting.org | +----------------------------------+--------------------------------+ -The Development list is used to discuss and document general issues -related to project development and governance. The public Slack -instance, frrouting.slack.com, and weekly technical meetings provide a -higher bandwidth channel for discussions. The results of such -discussions must be reflected in updates, as appropriate, to code (i.e., -merges), `Github <#https://github.com/FRRouting/frr/issues`__ tracked -issues, and for governance or process changes, updates to the -Development list and either this file or information posted at -`https://frrouting.org/ <#https://frrouting.org/>`__. +The Development list is used to discuss and document general issues related to +project development and governance. The public Slack instance, +frrouting.slack.com, and weekly technical meetings provide a higher bandwidth +channel for discussions. The results of such discussions must be reflected in +updates, as appropriate, to code (i.e., merges), `Github issues`_, and for +governance or process changes, updates to the Development list and either this +file or information posted at https://frrouting.org/. Changelog -~~~~~~~~~ +========= The changelog will be the base for the release notes. A changelog entry for your changes is usually not required and will be added based on your commit @@ -86,7 +52,7 @@ messages by the maintainers. However, you are free to include an update to the changelog with some better description. Submitting Patches and Enhancements ------------------------------------ +=================================== FRR accepts patches from two sources: @@ -102,7 +68,7 @@ The base branch for new contributions and non-critical bug fixes should be submit it. Pre-submission Checklist -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ - Format code (see `Code Formatting <#developers-guidelines>`__) - Verify and acknowledge license (see `License for @@ -125,14 +91,14 @@ Pre-submission Checklist feature License for contributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- FRR is under a “GPLv2 or later” license. Any code submitted must be released under the same license (preferred) or any license which allows redistribution under this GPLv2 license (eg MIT License). Signing Off -~~~~~~~~~~~ +----------- Code submitted to FRR must be signed off. We have the same requirements for using the signed-off-by process as the Linux kernel. In @@ -181,7 +147,7 @@ all of the following: this project or the open source license(s) involved. What do I submit my changes against? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------ We've documented where we would like to have the different fixes applied at @@ -190,7 +156,7 @@ If you are unsure where your submission goes, look at that document or ask a project maintainer. Github pull requests -~~~~~~~~~~~~~~~~~~~~ +-------------------- The preferred method of submitting changes is a Github pull request. Code submitted by pull request will be automatically tested by one or @@ -200,7 +166,7 @@ resolved, your code will be merged into the branch it was submitted against. Patch submission via mailing list -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------- As an alternative submission method, a patch can be mailed to the development mailing list. Patches received on the mailing list will be @@ -264,11 +230,47 @@ After submitting your changes community members. - Your submission is done once it is merged to the master branch. +Git Structure +============= + +.. figure:: ../figures/git_branches.png + :align: center + :scale: 55% + :alt: Merging Git branches into a central trunk + + Rough outline of FRR development workflow + +The master Git for FRR resides on `GitHub`_. + +There is one main branch for development, ``master``. For each major release +(2.0, 3.0 etc) a new release branch is created based on the master. Subsequent +point releases based on a major branch are marked by tagging. + +Programming Languages, Tools and Libraries +========================================== + +The core of FRR is written in C (gcc or clang supported) and makes +use of GNU compiler extensions. A few non-essential scripts are +implemented in Perl and Python. FRR requires the following tools +to build distribution packages: automake, autoconf, texinfo, libtool and +gawk and various libraries (i.e. libpam and libjson-c). + +If your contribution requires a new library or other tool, then please +highlight this in your description of the change. Also make sure it’s +supported by all FRR platform OSes or provide a way to build +without the library (potentially without the new feature) on the other +platforms. + +Documentation should be written in reStructuredText. Sphinx extensions may be +utilized but pure ReST is preferred where possible. See +:ref:`documentation`. + + Coding Practices & Style ------------------------- +======================== Commit messages -~~~~~~~~~~~~~~~ +--------------- Commit messages should be formatted in the same way as Linux kernel commit messages. The format is roughly @@ -280,15 +282,15 @@ commit messages. The format is roughly extended summary ``dir`` should be the top level source directory under which the change -was made. For example, a change in bgpd/rfapi would be formatted as: +was made. For example, a change in bgpd/rfapi would be formatted as::: -``bgpd: short summary`` + bgpd: short summary The first line should be no longer than 50 characters. Subsequent lines should be wrapped to 72 characters. Source file header -~~~~~~~~~~~~~~~~~~ +------------------ New files need to have a Copyright header (see `License for contributions <#license-for-contributions>`__ above) added to the file. @@ -318,7 +320,7 @@ Preferred form of the header is as follows: #include Adding copyright claims to existing files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------------- When adding copyright claims for modifications to an existing file, please preface the claim with "Portions: " on a line before it and @@ -332,7 +334,7 @@ your indented claim immediately after. E.g.: Copyright (C) 2016 Your name [optional brief change description] Code formatting -~~~~~~~~~~~~~~~ +--------------- FRR uses Linux kernel style except where noted below. Code which does not comply with these style guidelines will not be accepted. @@ -350,9 +352,6 @@ in patches that change actual code.** To change/fix formatting issues, please create a separate patch that only does formatting changes and nothing else. -Style documentation -^^^^^^^^^^^^^^^^^^^ - Kernel and BSD styles are documented externally: - https://www.kernel.org/doc/html/latest/process/coding-style.html @@ -370,7 +369,8 @@ Exceptions FRR project code comes from a variety of sources, so there are some stylistic exceptions in place. They are organized here by branch. -**For ``master``:** +For ``master`` +"""""""""""""" BSD coding style applies to: @@ -382,7 +382,8 @@ BSD coding style applies to: - Indents are 4 spaces - Function return types are on their own line -**For ``stable/3.0`` and ``stable/2.0``:** +For ``stable/3.0`` and ``stable/2.0`` +""""""""""""""""""""""""""""""""""""" GNU coding style apply to the following parts: @@ -400,70 +401,8 @@ BSD coding style applies to: - ``ldpd/`` -Documentation -~~~~~~~~~~~~~ - -FRR is a large and complex software project developed by many different people -over a long period of time. Without adequate documentation, it can be -exceedingly difficult to understand code segments, APIs and other interfaces. -In the interest of keeping the project healthy and maintainable, you should -make every effort to document your code so that other people can understand -what it does without needing to closely read the code itself. - -Some specific guidelines that contributors should follow are: - -- Functions exposed in header files should have descriptive comments - above their signatures in the header file. At a minimum, a function - comment should contain information about the return value, - parameters, and a general summary of the function's purpose. - Documentation on parameter values can be omitted if it is (very) - obvious what they are used for. - -Function comments must follow the style for multiline comments laid out -in the kernel style guide. - -Example: - -:: - - /* - * Determines whether or not a string is cool. - * - * @param text - the string to check for coolness - * @param is_clccfc - whether capslock is cruise control for cool - * @return 7 if the text is cool, 0 otherwise - */ - int check_coolness(const char *text, bool is_clccfc); - -The Javadoc-style annotations are not required, but you should still -strive to make it equally clear what parameters and return values are -used for. - -- Static functions should have descriptive comments in the same form as - above if what they do is not immediately obvious. Use good - engineering judgement when deciding whether a comment is necessary. - If you are unsure, document your code. - -- Global variables, static or not, should have a comment describing - their use. - -- **For new code in ``lib/``, these guidelines are hard requirements.** - -If you are contributing code that adds significant user-visible -functionality please document it in ``doc/``. If you make significant changes -to portions of the codebase covered in the Developer's Manual, please -update the relevant sections. If you add a major feature or introduce a new -API, please document the architecture and API to the best of your abilities in -the Developer's Manual. - -Documentation should be in reStructuredText. - -Finally, if you come across some code that is undocumented and feel like -going above and beyond, document it! We absolutely appreciate and accept -patches that document previously undocumented code. - Compile-time conditional code -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------- Many users access FRR via binary packages from 3rd party sources; compile-time code puts inclusion/exclusion in the hands of the package @@ -495,7 +434,7 @@ Note that the former approach requires ensuring that ``SOME_SYMBOL`` will be defined (watch your ``AC_DEFINE``\ s). Debug-guards in code -~~~~~~~~~~~~~~~~~~~~ +-------------------- Debugging statements are an important methodology to allow developers to fix issues found in the code after it has been released. The caveat here @@ -507,7 +446,7 @@ CLI and it is expected that the developer will use this convention to allow control of their debugs. CLI changes -~~~~~~~~~~~ +----------- CLI's are a complicated ugly beast. Additions or changes to the CLI should use a DEFUN to encapsulate one setting as much as is possible. @@ -515,7 +454,7 @@ Additionally as new DEFUN's are added to the system, documentation should be provided for the new commands. Backwards Compatibility -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- As a general principle, changes to CLI and code in the lib/ directory should be made in a backwards compatible fashion. This means that @@ -551,7 +490,163 @@ pointing to the appropriate update path. A ``-Werror`` build should fail if compatibility bits are used. Miscellaneous -~~~~~~~~~~~~~ +------------- When in doubt, follow the guidelines in the Linux kernel style guide, or ask on the development mailing list / public Slack instance. + + +.. _documentation: + +Documentation +============= + +FRR uses Sphinx+RST as its documentation system. The document you are currently +reading was generated by Sphinx from RST source in +:file:`doc/developer/workflow.rst`. The documentation is structured as follows: + ++-----------------------+--------------------------------------------------------------+ +| Directory | Contents | ++=======================+==============================================================+ +| :file:`doc/user` | User documentation; configuration guides; protocol overviews | ++-----------------------+--------------------------------------------------------------+ +| :file:`doc/developer` | Developer's documentation; API specs; datastructures; | +| | architecture overviews; project management procedure | ++-----------------------+--------------------------------------------------------------+ +| :file:`doc/manpages` | Source for manpages | ++-----------------------+--------------------------------------------------------------+ +| :file:`doc/figures` | Images and diagrams | ++-----------------------+--------------------------------------------------------------+ + +Each of these directories, with the exception of :file:`doc/figures`, contains +a Sphinx-generated Makefile and configuration script :file:`conf.py` used to +set various document parameters. The makefile can be used for a variety of +targets; invoke `make help` in any of these directories for a listing of +available output formats. For convenience, there is a top-level +:file:`Makefile.am` that has targets for PDF and HTML documentation for both +developer and user documentation, respectively. That makefile is also +responsible for building manual pages packed with distribution builds. + +Indent and styling should follow existing conventions: + +- 3 spaces for indents under directives +- Cross references may contain only lowercase alphanumeric characters and + hyphens ('-') +- Lines wrapped to 80 characters where possible + +Characters for header levels should follow Python documentation guide: + +- ``#`` with overline, for parts +- ``*`` with overline, for chapters +- ``=``, for sections +- ``-``, for subsections +- ``^``, for subsubsections +- ``"``, for paragraphs + +After you have made your changes, please make sure that you can invoke +``make latexpdf`` and ``make html`` with no warnings. + +The documentation is currently incomplete and needs love. If you find a broken +cross-reference, figure, dead hyperlink, style issue or any other nastiness we +gladly accept documentation patches. + +Code +---- + +FRR is a large and complex software project developed by many different people +over a long period of time. Without adequate documentation, it can be +exceedingly difficult to understand code segments, APIs and other interfaces. +In the interest of keeping the project healthy and maintainable, you should +make every effort to document your code so that other people can understand +what it does without needing to closely read the code itself. + +Some specific guidelines that contributors should follow are: + +- Functions exposed in header files should have descriptive comments above + their signatures in the header file. At a minimum, a function comment should + contain information about the return value, parameters, and a general summary + of the function's purpose. Documentation on parameter values can be omitted + if it is (very) obvious what they are used for. + + Function comments must follow the style for multiline comments laid out in + the kernel style guide. + + Example: + + .. code-block:: c + + /* + * Determines whether or not a string is cool. + * + * @param text - the string to check for coolness + * @param is_clccfc - whether capslock is cruise control for cool + * @return 7 if the text is cool, 0 otherwise + */ + int check_coolness(const char *text, bool is_clccfc); + + The Javadoc-style annotations are not required, but you should still strive + to make it equally clear what parameters and return values are used for. + +- Static functions should have descriptive comments in the same form as above + if what they do is not immediately obvious. Use good engineering judgement + when deciding whether a comment is necessary. If you are unsure, document + your code. +- Global variables, static or not, should have a comment describing their use. +- **For new code in lib/, these guidelines are hard requirements.** + +If you make significant changes to portions of the codebase covered in the +Developer's Manual, add a major subsystem or feature, or gain arcane mastery of +some undocumented or poorly documented part of the codebase, please document +your work so others can benefit. If you add a major feature or introduce a new +API, please document the architecture and API to the best of your abilities in +the Developer's Manual, using good judgement when choosing where to place it. + +Finally, if you come across some code that is undocumented and feel like +going above and beyond, document it! We absolutely appreciate and accept +patches that document previously undocumented code. + +User +---- + +If you are contributing code that adds significant user-visible functionality +please document how to use it in :file:`doc/user`. Use good judgement when +choosing where to place documentation. For example, instructions on how to use +your implementation of a new BGP draft should go in the BGP chapter instead of +being its own chapter. If you are adding a new protocol daemon, please create a +new chapter. + +When documenting CLI please use a combination of the ``.. index::`` and +``.. clicmd::`` directives. For example, the command :clicmd:`show pony` would +be documented as follows: + +.. code-block:: rest + + .. index:: show pony + .. clicmd:: show pony + + Prints an ASCII pony. Example output::: + + >>\. + /_ )`. + / _)`^)`. _.---. _ + (_,' \ `^-)"" `.\ + | | \ + \ / | + / \ /.___.'\ (\ (_ + < ,"|| \ |`. \`-' + \\ () )| )/ + hjw |_>|> /_] // + /_] /_] + +When documented this way, CLI commands can be cross referenced with the +``:clicmd:`` inline markup like so: + +.. code-block:: rest + + :clicmd:`show pony` + +This is very helpful for users who want to quickly remind themselves what a +particular command does. + +.. _GitHub: https://github.com/frrouting/frr +.. _GitHub issues: https://github.com/frrouting/frr/issues From 061dd548ee17ba096f6e8369561d3bbca18ae668 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 15:24:57 -0500 Subject: [PATCH 057/148] doc: fixup glossary for html build Signed-off-by: Quentin Young --- doc/user/glossary.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/user/glossary.rst b/doc/user/glossary.rst index af52857932..6b49336d41 100644 --- a/doc/user/glossary.rst +++ b/doc/user/glossary.rst @@ -1,3 +1,7 @@ +******** +Glossary +******** + .. glossary:: distance-vector From 5a32c42459ea04b7a8b666745e55528edc57b302 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 16:27:00 -0500 Subject: [PATCH 058/148] doc: add logos Branding! Signed-off-by: Quentin Young --- doc/developer/conf.py | 6 +++--- doc/figures/frr-logo-icon.png | Bin 0 -> 1609 bytes doc/figures/frr-logo-medium.png | Bin 0 -> 13129 bytes doc/figures/frr-logo-small.png | Bin 0 -> 6175 bytes doc/figures/frr-logo.png | Bin 0 -> 26502 bytes doc/user/conf.py | 6 +++--- 6 files changed, 6 insertions(+), 6 deletions(-) create mode 100644 doc/figures/frr-logo-icon.png create mode 100644 doc/figures/frr-logo-medium.png create mode 100644 doc/figures/frr-logo-small.png create mode 100644 doc/figures/frr-logo.png diff --git a/doc/developer/conf.py b/doc/developer/conf.py index c3295f88bd..e4c56f54c3 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -176,12 +176,12 @@ html_theme = 'sphinx_rtd_theme' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = '../figures/frr-logo-medium.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = '../figures/frr-logo-icon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -277,7 +277,7 @@ latex_documents = [ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +latex_logo = '../figures/frr-logo-medium.png' # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. diff --git a/doc/figures/frr-logo-icon.png b/doc/figures/frr-logo-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..37973fcf2d36a6f38f1afc67792888ad5e070fec GIT binary patch literal 1609 zcmV-P2DbT$P)VM< zzu)awXA!zD%}%{*Vmx-Uk3g>(NG01}D`0Bjl&-RE9E763FH zp|+~h+0y8H0W2Q}Fn$10ldxwka@HQ``%eI()uq{p_cbuf71pO70B1nTE~vIowEE_g z|CtA(zT!n}#`gl85L9d)m%pW9piKPu0rBS-4Loh_r#z+rQIGp|W^keAVC4{=n6$q`w_=&x`*ByvQ_M2e2 z2H-gWvHo0T3I}8!~ktIWjBH4CIBG2qrkcGXju2U7s`0=IRI*!{q`$Rq_hGAX7fQd zVi$Bz;pSlj=#@o6#(MSv0Fe@O)g3+&ttu&jl;5VT6-37&lxIQWF2$B*0)Q3_ZBd=K zs37HefCy}?)+_S14=V|Eulrs|^BWMI)`F2)0H9ao{R&{};6$Z963S{B34tm7%A>xbhjdT= zX}u!PmJHymZ;n8*7Xx6H=G*#)J2OGHaR7b-@iT)$pnKh=U{*k6Xo1$%@LaA|WJQlf7S?tg&^4q~YyT3gRQ0`~u_qw~gyB>b@5gPyqd&c8d z6T3Tcj=BxNg5)Gz41gKDGa<{Xl8opq=z|aW z@WDgh9Q@%xN0M(Q0m#%n1?Q}IzAJL3U+Vu?y=LY1E3`e0J8VN|0QE8euo0Uu(lQ&Z zEG}mwrdl`c`l#3aCy1__^u%T(WhtJtYG-W75G2iOt%N!~QUErM-PTXTIxB~zY`?JK zj*00fBBDQ%2q(yi3RF-oiZHQ*el-@rnh!)D>ts8ub<51vWPUbiQBSRe$7kN&v+% z={SH`QW%PLU*XzB(~0;hztq}t1em}nZW>Rxw4!V|~7qKxcJkXQ^*e@3g8)myZN$OKpYk)L(1yUy&n zbOIzk)`H>tM>G@ao`OAK`Cy9Kyb(m}v_R-kQrwrYG(Jzb(RQ=uZ#f(F7ABZk|a1_g}EN>x-VT5+Zd1 zRSN+lHGII@!6-K_TaGHNgm?rUGp^ZOQ(sMs7&1_@5U(ID34WHn&5UB~$N)>L8h=}W zO;rVf1AyTORB2$)tjp7aO^px(aK;P5#f_#*x0Qo4({mnuxFdT2OGloEi8u z000Ar*)&xU2yxKopwvpy6XwphiX^Y)hh-vUsBD%8bjViWp}G;AsI{olU)ynkojD?Q zZ$tz@Yo~&i8`4jWi{aRa=D~%R_SV>UH0>D`4;5@Ft%ObBQczR#oH`y6LfqT^;4Pf4 z2E1vXZh4HXlnw~hL-g809dBpTbaPJ-g`gtI5!=s<1|nxNM!GxycFi2H_AID5HU0eC zM7g3+vvJ3=Jf!7LPgwb%5#_ZY40eE1FDNrs0Y{cc!VCrT)*XOU2h%B1!2 zfQy<&`q#L9SG!^b=L5L6m;O~DrweIgThVyBYD*_8OQitNlXQSgT!dp%Y&x4f(A0M1 zgArEn_Rb7bTb7?>FVR;F1yD;)R2HRzr1YaUS|~l4I)0iYvcdfMDYaV&rb9HI(g7*9 z>q#lY`Q(~ad>50BGk6J+PK;z>#F7kSUB(!UF`tCDyo)Gh?H8Y(NkSTIHWmi}>9HV< z``$B{4Jad{mGs9N2kTu0Vazt?4u;vywb5k2!H zX$mOIdZ* zk1SK@2JJ`7n$l0GwMN+Y{S>+KVpw0cOwKY}?LS;pOPB-V;-!!5ZaZc0%I{CCLgOkw z|8>U|-lfU&4%Mp)i#je{bzps=(s^<7=_((q-Qc)AM^mn``&T;>NXi%k9hJ+D52uYV zUn*03W0Uu?C}z@V&d)dX%88zC-0F1j%`|hB1<&ZM&8NymTVGzqg?K4YAwtjCm2Fmd zP$4|(kYJ%+YcCV6lW{}<_;s%C9$)yoFKGqy6KN?Yvh)~KgR$9;=OT`};wPdcGkkNs z-u>;z+^9E&+$4UDN#*4}nmdW1c3>TvMxFYZa7b0|O(4BT~LU#TBQ9?H- zvZO`79_qOVII{qNj9&QFTwn0RtLJgI3)Yf%!gW{xJ>C^vKR#knlU!_|kVZ7Q>l+G) zxZ7-dI$f~|;_ad!m!;8`B`Jc8FA{}WdGwE+UE}6MVgn3}=XJ{|X$Q30(EP3A?=&#o zzXj-4G0Ar7%fAK!1pqqL?<`ZDYSMH! zD`vcq;P8#G2&cC#4HYxuofXd$vjZs#97L!7$LH~1x#%A_IE>y|QJS%<3uE<*Gx=BB zgL7Q=1WhHs!%kV9#9{)=(-x)GeM%)aJ{t{J%7qz>6d8Th%==FD)NoM&FBwl=+#9Kj zJp1w|IM&aa+|q|_KgtLIs3@1cK-288ZMh<+p{9ZoeytvUM4`q#eBr-@`Q_WiQ7z)A z8#js-y$o--QUk9XHhW3ypRju?DPwJiU*~vS;N`|R?K}afZ@P5jp}6HtQw-NYY~zSi z;e4f$aadZ)!7GpqIX9i-x6#%0ESvaoq=%;R zVQktuu%&)34RnqQeK!p_7xm@Ep`V8&9;)9 z^ARuk~|LYYz~$#^Xd~ zrjFeYJQvdPYK(nC@AndYEGCTZT7`zxmMZ)>X>SJa3$jBzrg5(7b^@yHZktCllS9d> zBrD1?9Z|EN;C`FDv$J+k9N0_v1>SQ7mnNjIywq?@JzTSb+O6|EYP0Cm0!7lp59Lp< zT?uVVksT|a;BY_X?QJd+8+*t)%Dv_-y6@lZd=;R1e!|*^&qOe0``d47K$_K@<+6_r zL&nlcM-&Ud<@Eo$_AK0B+(x?cW)yz#kD=q6FkC>gXEy1mcdm>8oM1=r-b&w2rD?8C zs927FPfGLFVt=Ep06{!hO%ZBEp_dWQ@_9Mz1H$1D(d)aU?ZHxas9+vepaK~HIDS!d z;>`WkmKM8^^kmg>cmF+Gnh&2kg=_Q7!>sa5QeMXU)@*#HJ}*X)^$wL(!^g5`d6)Lj zyuh^MplQldjIPSwMw^Adq?aV8ExsbjAGA@?^q1Vq%lGh93Z$i4&jP~7EsUFQD_@Bj zkUZh;z-FZpjy6cbp!IMztPG!~am=L@R@IxvNQTo*-0{aQ2kq1vPu|b(kh9|YT!v`e zul*YsLj2meKKI^Oss9(>&q5Ka`B1Y2INPda+a=z}Ukq2IPC|EBcy{i%ik)_pdePMw zq9fsiCIZ6RX@xTk?Y7JI_a3!hPAe&}V^0E{Rn|FnoZxl@cgz~1FUxte1QU;KHf+@W_;4~TgW~Ib z4~&M>9QyEo*(%0i1dr-b^P)UI?w7OS-3Yr{|4M~cdHqGttP(%WrCLP>^H5=<5T2~L# z>EV1j?ihuP%07a1hADXjS@cvEkwcooFNa=t(SAv}f!P#)CGJ44a1gg43E!{6L8pjl zFKYOPcn$+Z{C>vGcu@o5+b7m1A{h}jmH2IzkYebE(=`@zc`;$eh_&bkhQ8zD* z(j}ZFVu1^`X+@>i`1x*JgE!`b8{5N=UtnUw2ILP{qj~)AEkAi+*Xq5zdl>LkAo6I) zP6$%dAWIdUqn6v23oXvsuh93IGt5Z-2B>#~YY?7m`wM@JVz}GE-kT|gEBgL>2J}=B z?Cl(BS@<#93lbirrI?H0F0-?xQUWJyenZ4k+)4m&`CKbGi7iDrWwQ<0TK8SX^JQ9O zrr9INtFakDn;P(>u3CHfR()?i0c&oRxRIijUQc#f5? zsXV*E!qiMn!tu2NrjI5{vrFTzBpdsZP6Y2n+%2<~fW-r`o1+ISd=GZ(Qt{$nAwjd) z)}nD(yXt`@+bTW^xUGoiOdY?oskn(!X7~5wpJIJj-0o)L(7BB@0KVL^D}GKyw^VC9 zoD^Dp1tLRm%Pe(6(D;k`{VZ0e{^*Sxk_Oykp)`NqAD>UJ#Z+O&Z1*kfdi6)Pj7Hoo z+xit7{5eQV92L69VH_&|=!g@TL=mNx=L>SyiFEfZXma3S{+R6h2-HAml|2tf1CRAL zl&i-q_G;<-(35VnLAP#3p3WJZKFvUBy3-C!368G6bw(1Kbwiw*KX#b}Up0`mcA%*@ z*v!ZsRxbNj>GBf5X)tm)q-36`)%tVYDjOZ~x&9EX;z_t`zMs(Xc{1m^Pb~kls>ZP} zTQtxT99D|ZlP2gVsu>WyI)Mrc3U9jbF$pzL&)KXwICnFO)oM73;$y+_zVRzV09uGZ z#Li3Bs#o>#M(*i8^`ELGkMW1f=t!4+p_Jp4U`Q#-PQ|0eYg*mo>4Kbqgj2JxV_z(a z@}|NH6!$@naKiNGkr@%Dhrxz)-_IE1WMiIXhCL>^q>O5uR6kb9mLl4ULrQ#OIIM5a zrAmhYDVSmK$Qackw3v@$#_B>aeIw)jxfvcxEW-={%J*c_-k&iH``;5`q^LRZ;qmr zuWsJbH?$pp$Q+D$s}P|X!Fc}xgyDS64SM$l6r>lCm7FM1HQ0wzJE!SC4}bQ1`6Acr z$QRGyv2jeZ3Xv$;U2+h(yH&r=Ed27K&l-z#YLeKvGbXktMbPbzWAVLi2*I{0(q_!r z=6rEW!51mz3mqj|U9<5|9g6>I>3;qdw|1B3{=Q16=vQT!2p6#n9&+V*c+J4jXQp8G zwtNn%0>>B(a7|3}@$;v5s7;ZGh>+>tHkhIL1q z`vq4lv`My|bh zwEfJnhWSyaF+Gq2E_h~D&n3z_U5Y2da|0fIfUuMrEXebYE^=h`a{G!?2WGqAYLr>M$?)4>8M? ztFh#N+@7gZ9T6IRkaOCGWUIKEf#Cs735*M6oEmtqQq!zIa1E*mIegbbMVB|~<2&eX zJIp4Z${DM3b2@X1>6-zrJItk+a+&an*Cj318r$Uj|gAN8mA|A1sUd)GXc-L)+&hf7@(XC=cFINXEWC zt2GEyM5Y0%)UygYg89A-Qn)k>^mW8~s%69Ba&87Lc2sEl&C6?ec=gk3Z=b{z_pa;j)4!)>f;=!};wRx{CyfzrVU z0%5iHD>zB9GmJ*uy*wf8?&Z~3+QF^D-0W*lBTIHhLrqp;+LzrxM&FmWC7o^p*m@Y% zw^85zc&tl6dt9>y;RoC4k}4R1(0BGcZZcykQTq8mwdZS3_I%Ea{@4pRIo@1sw3)4) zcz$|~OshK%R=sudnMbi`B2NFe!+w%Q{|=P)FOYIP<5S_{l$gjgAO_e=FbteXnX-+m zU%{WI$&I`Ijc2yHOP|&|UX%l<DCv9HaIqyTb9JT};E8}5p$#Ge?FVf}*xh`W@i82~qPd1&x7y#gN zwSWB9`haJ!BwOU4=?g6FuFoqRhw>T`*!wHnanK0IGZ)NvA!!=0q$o8$*?zoKO!jYC zL9JM8};tg)>HMv^CT;Z!jI27%M3$31-CP=ukqLY0yq->{JY=nbE9lY=%P1komXdnUIxgaUtDv!yzkVnoEdHDtE9 z*^|*gXtv76QF-L~{U+;Rj5I{&EPZ6;>oM@$Y_=MBo^b4k4BcY>KsYD0XE9xd7TnHd zgEcuWI|4yWJSZsNnkD0QQB;6MFT*pZt-%Nk;YU%2P)-rXN@*EST?f5g!aE zllpwoDEX)IKM{_Bjoq zIK4&Y*rtpgqyKJU@3liW%)IU?gV-g7nIa*V>hpxG`z@M!>)*xEFgw9eI!a=X2GP$e zI*bNyd$-YtQEPPqzcz0W5XiI|wz#R%n+;mLs9;8YX*2!it$Wfi$*$%$kouMEYhTQ| zI}+Yl93N-o}s~VEhYLl>=nF;oYrA)JxSIWLAbJKN%LMv zh**LU%lyprqDiMHd9&y77xpV2Vv!coC`Cnq+WUhyBkso+DszD+Lm{_&NSfviz8Dl5 zyyFDyFQ4%OEv8p`uZMJ@5{cgH*1m>FApD7%Lb1$rt}2O^OfM%n3Led;?ks(7h){>MOUIBqM;0pG7#S~18Xl2wVDUbst**a~HO zl5`sAZlfi;zdCN0s_2@?6nQ9YsY1+jz$Uv@R#^O_R~K2y91znC3Sq7=M$toE@#)iZ zZ@ZB%BsptW!mh5Rx8t^9NG~a)lDZ2%G<^s@Ge)AVV2Z1K~AKc)9};aY3Qm>ZP6%AM3~zLHkN zae)(ny7dksK?G`EdbHz1Ohprg^{TQGQ z?`lT@71CPQZ{BZF9)09o^3Ov*3_U$T1m<-qY2x%V;TuqS$<=~TdmVU2m-)_{85cOB zPYn-8Ia=%-f-G^g?*=98B*57?k-X*_fhwYRdgDc#s_Bj$F1VQwZYI7GvD%qpLJz7t ztTFV<02M~^{<)-Jp>*GJEkDo6|55!!cW8Ff!x@U$ozeCC_DVrKI z^yprjrvJ$#d)H*NyUaa8da?3By}=&-xAC*eNo;a*m&m2l)OXF|cq96U`3xix5t0Ae zwHsr|K~~M+B9A2(ME{5r1IKEU{I{R`#gldT1e1J_>SCM3W*ENVIFpHCi6zeKPu#p0 zKsCBn_3rXM_|E0Acylxy1uG9%k{6f)#4Tg?!zlyO-ktw6=e7Iy69E48?%ez+gjyak z5O-hF!mAAh@=)S`b_^;jH`q~vgwav1cZQW-W~E9V1PH>P7+|=}j^1w!EV9&dJ#Gq| zF8;dOp2G=z2}v5qND9nGd`?V>n5UBjb?oC<2_}Vsp-U=p)U&pjG#=fyf*BB5hPIi; zjvCqrDbKt7F{^fd+0XVoKF+uE&NorX9X!cRhnMa)5))j!7cojCv`kY{zA>Y{IHsaclJhL_T(vmd%IJ_YGHzvJb{T5 z`XmTF$kcXX!FKjYX9**7kRPx;TjT$p!*9>hrO?nN*b%a6$On%c&_2NU%6`IeOta~j zXC_JHS@G&Iu=-K0iw^s-*b4Neq}STxi6B-@VyT?|pXv({9XR~w$G%fyjwE-;YuD2C zHs9}Ni5p1_{d9Y3_?C-g5ruqlMPNESdptzUPTt1Px;{l7xFbe~0D{-t@ljbXI+7d+ zZ*h;~K)0Ye7gxy=&W>?Q(fu+7r6jZN`2$l8(Ni6YD@;#HAt&(ZJ0HsnUu*wk7n__W zE~0QZw+t#5S~?r?HNjy9&+I@u*HFytkXI{9>*bm8!Kt`|aH>QE9lh|$aR5iWB+nf& zD*?nlaIWod+Gh6efk)rwbn9J-oMn`Tu?dL6^KKo{F}Y;K_S840x0Ey*cI@Wvv3u?$ zKukMJ>r8A2mp>{fK)g>HeZe_oT4nuUp}kY#Q5Oht>}CXsC8HltE~D?`4Yn|MUE=jT ztosj+BtbXQuTfXru3OT)&JZW1)@P-GCc=IEF|Xh7xt$@uC!(#xvVt}bm?P(eNQwR= z^xAh+xNODaH5qk-<9<@r?Db#aOlUTR))Y_@W|LEjoZe`ac|?L6^wucgLQx;Fqwpp` zwGb|E+n@aDO~%tOh5t5i%|}{b7~**_JF_ z2gWTP!^Zw9qO;#KC0St$qnS4Y0(p)2@3mF<_AF?=@$d31D$tN>+`psEbuh75JQy`j z)|0EET{;!N1?{JZgsYDyyKXxQQw$zM?1~kmo%%g zIW1jdKXMX-T%>I$g?^Q5g58fr>0?8+&pY+Np7F{so*V$Zpz>rb-dpcDKq(5J?x@s8v5=P*zZt`=Hde7n^oH zyUehaaAQNCLcm{VfmwLkbq-nG8TCYPq^)NZ4c-lif!j1mctt3wb~b*nic9xe=dpW4 z?z}%C+*4eod@&aH_mgME>(w0z4kzCDMow3Am>>N9=DVDvtr57;+@`e*1kx!j%Q;lq z4;FWqX)eR1aAo2en%QunSk%S}6f zXl$4|oz-@Z16Mx@_A{O~67*48E4WMY-9MgnefYL^%AT@6n(uc?oEX+%oIfQ^%Uw7#I~i`>o6R9xtLLc8I!7jHFZghAa*m!8^y=Q*HU|Zne&o6{?~DQ zhtxAxTfdTK#A28_$@cK()?Wct92my}b)7iCFIrhvn4W#sox0#)-=7VwV?*p7?$ijO zVVr@NjF?NNCv1zsnV`VTBd$B=mmEo>&j;V$cgyZ3BXxIeiaO275I(}}1q=USHxm=z zj?Loi!STl_^E&de1#V=u$JV!oIgDm=4%iI8ATln=vx7pGPIj*C;U+cLPG);i;rOVR zVCwJmo4-#ol;ck_5sfqK-3wbcAljHd&Zm64+ErX~dtE8LI|F70@JIj40#IGdYBsJI z%NjQlnO1UaaP-utqBM4v#7;!Ug$`&;uGS8CgXnWD_wiRtn50i`hm@RWoNAvW=*=Ay z2+w5G2a2d}zuiJAr+-Rak`|te7)}WjQ$74latfp@S!0 z!$PTD59o-`yKDeZ^2j<}fB)D8IGk0#9c_9VTZl5evT7e|E)qeYV%=tRD;t0Z;*c6W zKU$MX%lxC$?!19QuhAl@`AR;37DW>pgvbnA(()!hZ#MA_cNek-9B`|mQax*xIqxkS z%Y+mCg8reNoqAG*#ve|-(yI5S>4(3R^S4qsM<=rX43A=iiqWinwNHOZ|K~bMD}h9kT}D^0Lm6t1N0UnfzliTNUK+AWGh!MM$ze&k2}1br*fB zk$;7C=P>{DCr z{9^}I>s{2^=VUFq%vNSKIm+|3rd*SxP5eZ;5g`tgS>vbpP6nFhWu~g!mkXAOcY#tY zQMi)Kpf9(8u*(!ia&~oc^js?`k3<^cqmIpNa+CSw`e;h*s>nb7F~tkp=j=Gam)mVD zi`Wtl7=|~jj29O-Hk+rjehGY!+)7U!_lDsv+-S4iVnTyWu97@Hn!!c&B?uik6GJ|La6lfBf zw}XI01T7_qy-HDaEiI94k%-mciSYd7#%O4U+|`@fBRn3qDG0hL9h=NxCfpsZJaK;C@2)qtrS_n-!f^A1 zZpchYFpz;ZRTMrLkle3WjNe9sScAorg7)<(=jy~!BW;+GjU*3!x7*SWtGd2D<-~6_w0{>8%@*L5E=*YF2@d_dt zGLa4l?=`?|AcE#Mbiu6$=3LxV68R|AJRH|xSF(~jPM`6UJ# z?!BR?*$*S$1^PKh5t%QOuWeMjeAhhFJuv!%J0|Gmr zd@&aa9D#0yOF?Gl0eT)vdu_9BU6w=Re-gK@zXeXOLY};sJ3O!)YXk-n;DDZ@NwKQv z<4`UK2O5J2l`#oWxGqpVf-`5jUX?I|eZ~a)SG{9DN?|`bRMa6w{Q251_>-ZY7r~`Ue-0A895Q6ushZM0TlJQf;92 zR*=)w?hgX=Tu1UNN|-@4P%i6BD1lz4vN1`jwK5R+4GjiE z8ei0^njRfwhZm>yB{Z);7i4!69B#Hh#t1f*)3Ar+cLr0j-f?mlTn7EqdcJ{xL6?Q1 zHs~jG=OwWt3HHw?L)hAM^1nMk6W$>qEt?Ak3>SoBq+${mG=OyQhubPTs;ZzTDsUf! zP|fIpco2JfV8vt7l^eYu$~7hstff~KklV8xFPOw-nMS1n4#-B)KG$G_vmWeezxa&` z^9b(P=1K{HhP<}r+&eYzz!%-H>rEja^AKynSi+Sj&LO!3>13f_FPV3n?{>lK-k33t zBmt=UAQbNgNpaK5Ollq=W63`Scu%NKt1wHST8mbSWgbezFclv^de@U-l=`jp6-sd# z>N6&p!pl_aW++{ds?rl$SPH51;|=J& z5Xd0RMqdK}l%D41b5Du1>i2Hq<40RV{R=ZD2JJE^f58vo8O?M}UO=$f`M(c56fldJ0IEmTuZTH-ZH z4CK@%yX!|tZXd{a{2hHgYgpZ|S=^{kf~V#|$xlUElq8zlQLP&4xp-HZs}`AXFw5}X z)loUJtdt3Ei68TKttl1@Xi0_YVd=0O|Hft-Fu-D5yuY_zW!TJhb1ss)pSRh{p0Y8P zhL)H>Ez=p7_%SN7MI=0J5NP{?833>?|fc zXb-9*F6jca#XW7IC*mv}vNdl91T`uWt43fKrOVkG$2VH(QaP4#yN&HM zcmu=eQLYr&?x48;6f33sUANAQ<>*IPBg06@7KM0NL#l)|iY#1?FbDOa4+hR8rsEMS=Ry$!hKJn_(wPtXGZP<#=m@NiDj!ok+bdbDC` z`hCJ~bRO|@nCNyUr?7YX;F>|o@|p$|r6kcOMb)}}SL8*pk>pMmRWm-}g>gLZJ4_oL zH{1NCl$GC`Fn6dlMna75BiIs!aMzgY3|})gdm_E8m$4#3`3v5OO8XvlwjCWUz_F)) zSUW^dAs^Qb6%kn^eq5dGzd%gzsrt!x;pjVmV>bziqf?UER$Bb@ek1rnowyvX4EtMk zq8kz|%wTYtWcA9|&K&jC%r9o-(pT&ge6%<019Jwx@?qO>m8?;GPlOSY3Dn73kwgNP z+F7hMSM?ey@!;-PBl_btGQjwkw^+tVVMyPhx5d#eXeuE1<$;Wk_NqU#aA_rjkIO8x zBvvFB(Y;ie{G#x(gG~1}Zm@!ZQ`1LtBVQWK&YWPViV6?@HSYcLh*bFRUtf}JCH+@Z zBhANdCNrk4C1h6Z`Sh}=G)w3;rV^&=(}&U|YnD5q2*s5EIM%^cq8W~;$e?m23MaV} zZ2(Zao|bfRphCa1fdjv7-h43ckzWCna!QusSh@rK znKsey6%vE+UnK=zaci!2vW zF77e*^DjGF!9IU#+k8bn1h3}dr#Evm+QQSx`@RC)W-qUG z;Vd;xFOK-n5(tqslM}IYi~~3>W;Yo^7i_%k9)zzRjkCOc>Hd&}Y#)qJP~Bjvb$2~E zxR|#bwMDbjQ^Nr%Ek{CTm`O7v(7Y~8)5lFY%{f#MQ^c_U5Mq@4b6S7E9)o|b($oj9 zY8?*wWPY|PuJ}cf!|oMNxOvf0O1ob)!swj(T&^Hx?AuPR>+27jJ2^G)EFktlc7ljs zl{LLDDJ<#x-6WDa-jWL_RxaDz&qnD-`}$$Q-Y!pcQ8GP=C*E(O0-*9t67*6(-fXSm zf^Ks1NhL9$?lmMOS~BPNYdgi-7zu@pKLJ$V@i{G5aJY%=W>iHYaqHlL|0_iOV%{Hp zELl0N=O4^d1nK+flI|R&zBA{`XT&Q;Z0FSy12SV!YsadLu^OB*Y^gb<2|c0t_(_lg z^ko*lkGMnf7SG`P_TWqQM9==wwLj1338_KM} zQ~(W5(@A&{Uw)go-yZtnzPKw)>9@5{EX9tJ@2B`?IG7UGLy@NGyCG5c)g!VbD~aq{ z^lQ-@zkl%~p+?k7TAJKYrn{>W;g-rc7;c@B(ACV>4-KhIzVKjw6CKJAdV43$QXogT z2R61lK|boS_ySESVvUS(&9P-VldBRD+XtvVuA9Ww6EyioRiSCp>o*IJ;i0r&Y8sJA zim=|vM{FabeinUTO<=MLCGJyy`W4aJgu?TExjln z7E&Vx^l8LeT=ivs6-P@e#zj&Jo8FslDo(*2o3#wB@H5-aHWIJi=hp8L!ECw0LL8@> zjJZH%G#J)G*)ffEr0I7<2rZ@vH~8tz$9tXo1}FyTgGfvXt9>aTVW~A3Q(W`KR-1v@ zo?iMtQi|S$?SG@KC;Fmg&QtCF!(PnJa1GW>FR1*b6anVw^gSGKgB#+OFgd1V$I83{ zvz8z6IA{Y>cV^u!Q1j$Xq{Lx`h_Ga|$Yv{12;GT78L>Po09{&s8dy)9AG7PO$?AXG zKnVtYLWVj!=`r?0%FBBOEAV8|YL`*LY?7L~3lu9_j5p|dURtrcA-!RZ=iRG{Hg{8y zUS|@=;YcctG(Llgk|5AVC9r74col0DIuKYd88~UBuu}|2#WJd#lbMn=bb!?E3;*RE zgdLJcL>GWy@(+wPOErWk3h+KVglfUL_WLZ#*Hk>NiDBEGk6G66F+SL6V?$D2=l$sE zwmGY<_%}ep^u61L(kxc5n!YFL?lU<+0V%+72`dsh^p?vI^y&wq_FCb zq`uM{Y(MM1bD#rKlly-1t)K{n1u%zig=xn3>wBL2^+a_056-7}{H9UDVX?IhXgL>> zPXn1+l}W>pwJo)V8=aS z`ytg-T73HA(AJ=@4*9dFfK?lA^n`wSEu?S~B3Y5**vsvv`=S0k9>xzgX;$t=jR$Qz zWavsN|KmhZ#{y0)sfB@PT_-yP9nYfC43tObN-VJv?YJ)(bNB9`xR0(5@5kzQ_HAo? zdb8yLxv45l!;!CJV70oz2fvTlb*a)RN)_5j)>_{1-COR{3v^$6nhR)=Nl?m2K8*~e zi0SaTbdqEZ?oM=?Yp1m1aZ7aoJ2i_Cl8qwGRw1^s!rjLOW|UEBcul4rEIxOD4heC~ zQhTCDdtz?%$?dCS%DLo9PL+o-YgFanq+iEg!J?(MY)x}zw~5gRvAvM82VWAD$!Dk@ zYj9w=SG9ck&yDV^Dp1gsAV>*=TSJ0QQ7f!_8-8D=-!X6-B~WkBmg}Iqz+iVH(!h(R zGuH}iZIarK_j+#;i=;1J&d`#c@FTOasn_BdC-ZI&Ro6T99LGeK*uVF4(c_LM1dinR z_5CNkzUH6c!w#V=+uh4wwc9@MAx;>bYMfdaz1u?8{NTvePgmeCWoVhwN|fzJNMM17 zyBy0#$qX-zbfKeXfW7imjPwxe*BRQchlq$(Yn{ra84BA?Ym~T}9#6n&0vk>zdW*D5 znSj(7peTnn=VT00006VoOIv0RI60 z0RN!9r;`8x010qNS#tmY7ZLyf7ZL$ypVCqQ000McNliru;sOE`Hz#Scl`#MS7pzG{ zK~#9!?Ok_#R8{u>-uI@LWYP-(>C!=^D6oPk0%AiHR6te*S44pYmMDS>N?kzOQba^o zU>8tUsVYcW7k<)_5{hUdke*DE$@H1`&hL*1Qs%vxWM;wuIiFAdfcM^=_wM(ede1o* zM1)BFD_QgQfJlD7>i%Oygh-`}!;?wf@IEAr{DOhwak~>2(Qn5XJO$^F`%ZfjiZ9fF z74dIK1oFC&JE!x^7T{O(AM^nkFvG3llU`4jhdOd|WL)^8m3_dCmiK90# zrqKalHJlYGI?IP#gkUK^?u5I^b1|bv3`P!EQWhWq3MKMq^&;Eu6*XW*2389Bm)At0 zZ1YSiUOXtj2CN${1q1M{I3BL^M-%fVbt196s0OSXX0-?E2ophclp$w)YjU04TLV^g zkvsDcNUhHQIQp=9+K z;*1Furg&9=aXY~2Oi;w#0Y!4d_mqhZCMoN*hPrXbng~WH$d$1ZMay3yrc_rRACD89 z#t3Dd*5@=0Iy5qLc?qb(I5lATA)z!EMN9rnLdivm$b=L?F7Sp}sGD?2H+Fe>rXuxD z+^(dkjvuk^T#l0U6N%Ty1_l%nNc2L}xbxwt9wYBj)@g+r3NvSk)?yUQeTqb@IWWB> z3ScTNboV^bJ-W}k+iT#dCeCtZ>_p+h{=`Qm24pO7Dm@Gjyuu9KhE~nsxOPal9ZaRG z;VgetvU2nc`>`$KSb+YLvFlJ~>^ZV(pm^Qz=A3~y{~TPI2M62suKHB;IG~KZ1Ih32 zXEmH9GjRoT9w(tB2mXK}uN&HC-L}TQwB(V>a+0?&6YgIRqU`IbBv^~UX$-$R(gdb4 zfY%tn)P@={C^`8~EAl3HCK3gCF-9VIV?5$s`IIRV>tBvI__ZcWvf(_r1Ljp@h%>~1 z@hSiWP8WS?;2ND3kRf3yM9%mI4b0Tn#Zx9vOB)PL&7fsXC|Wk1ZT{z`(S5KN&4 zADwvHfD>}CgyIXxnb?;2s04ZC$SV>5+A5~1(>gHc`P6O{Egncr7X^T!BF1<70TeQ@ z1amfWCf*}&@sS8VItfYRcLt>F-I<3_IQJ=HS|iwH5m!S&fhAha$eDPzJW!$+nx@^> z$G*6zuV3KH3Q+Wq{v=omz_i9{`FL+(7C3DbLJ~xdRIteFM$Y)w#2XW2^;2}uzcRyv zulgOYeCu3TzMD@>UA@^#)}0>>vF%&COeilxbkEUUb@x26TUnMhTmwh|P~>_wv6h6O|gxUvEyZO4m*7=g!HHw8}{EB4*HBrfL45Y{0g3&G;e3%U`C5))gEN(NTti*^g2F z)CVIX87E+{Txa&c_T#_SNOFNFz|`j*rftlPH!TCZNvc8^gJ8)=?xg#u z?92Ch-AE}AFj$2P`w>%WBxFB9-=Y5_`i{@bkMZG?!uG1+yL_PyR0vrJsylUS6O|Yf%wf6oml5 zB|xP?&f9Is`O~-6&*c81?)H7_Q2OP&1Wp21QAFy@3|V`-Xx`K0&OK9o5eQKLZ%jhc z#9aaV0pzfvaPa{0=AR3AgH(6-6O{^`g&nL5!&8Vi#!32HiKEstWm*f#=ZlxUe8~0d z{=37AO>u{o9&=?1G<4zmnUR?b64F{`a z1%p=^7iK690h@9os3s%|2X_7?& zMhO+DK}}GcVCe5!C}TH)xV*pe#!@j7*k5SW}G1oh4Y>cnUC^*ygnE3*G~Cvp0ikiDSkxmirtx@VO@4p;O%=gk%* zr@xGy2gezEk2U+WiOP#06#aHJ$i{f^@pn`nEc3^&>~x;n+ts(>qd>~kqmp9Cy!geQF^G9?7L$s4@Ww=xuA4Ae>iMV#hc&u-jd>7A z5#Uu|m4Ck|QA&i7AV7a_KWSa{pGg#oS}5|mP;1617APl`Z=P+;d8;K^cQ5;W^RjxP zB)YbJpsL-*D`gN_fB5uMc-=m)>hJA;j@fR{$A9&=W=?V)}l-l(n1ty|rw^w5GX} zIudV;zoFJ4lxjrv7^##Bft7DxvQLsTJM_DH@hepD_*w9m!Ezj2-%rYq&^GIK4iX|x zD9wZG%zqmOEmm4Tny!-(vzJ3){~WQ*ws&<#Wy*&9k=N_Ry!rESXVWIsxXGQgc*$aT zz21PHHTD?kmGZ5aMi1Ai-M;6vX*ZC^@yER?4ID=|#RdeH{m_OrKIOeAK-cc+Mp6S< zcP#0}RQe$GlpCh!XU_C@U-8lxGaMN^hJ;ct?c28xt?z0>pRfF!j7B4(qN1?;lTWBs zo7QyZ%$WeJ4G!9tJ-16a%Jvi62Kc(BsMQ3FQ(eW0p6rZWe!=qQ{|eD%l@NjD(BA#1 zG%DzN$Hw5-*9Cf2zeF$3x6I=TJ80gqfVzo@5dht=)*Lvdv=$y z4DI{ASSj_Kx_-OtEC200wY#NXupGy>fT?_&y4n`qPf0!O`Q-qZCb%3wULObjz5QkH zv22=I%YJ0@{7?h6Wa&~EjneOLijKzY59j#(KwaBD5Zw+5so?}Ue2Ym{gZ63Hx-8_f z%Y)_mOE^j%?@`l({Z?5%t7)S*{X_FQR9^VVIH2-c%0Io972;_E1TD%IO===;{tCs{XlqroRU(S>F^O`EJdLn3= zb(2jbcb?o)EkVAQUwR48KldDK+rAxXG!+uY;dJ1q!$+A?8F*BN(;7jd=yUU*+|s&{ zDO4b@>q?7Ia&;)Y=JP&TlsrzTYD=5_&a->8Top@m$m4*fSvT2xoagp}(?(TG)JUt< z;^grYL4`y}@JOaR-lq@bPsdFWdI4sz|)N ziAXHVlPr4o6lbAy-Gl*BOmX$pC?s{HB4x_qO0Ou4ys{#;AZ$jGK^Gvjt0t{f95Q8OJ3WLgTP$V}TAiGL4 z4|TfP!1Cst85YP+fGhJ*-NISd#2h&eY4a~K(N+pYY;8wq!E#x_f)P_nwXDJu%5rZu ztl&7lby1-AdWtfU_g=^AtlhNv7nm}sAwmik1aD9u#%{3_d&H7li1xC|J>#?>_sy2q z0j8{bSBSw1ahk^azCPF^vNDC#wV&r!j(pDK_xBWUUib(#_QX zvV7a3Dm(B@sYdqb1{6N9jPVGjGQ^X2Zj~%pjXU`@W{{VtJIJKbCB71Bjg2xql zuy|8aPyh&32 zCU1xb$EzW_tRT^gfGaS01qx>OCQs(!5P=0i-Kb-gmG6#lg8g$4~H~(WRkZBCyV^X1Q(-Wz) z&$6_+nJjtIK9)4@8y3@N5+kRrBD?HL067lDpA93&ku8@2tFkOp)@r^H``1-D?BqDT ztFGL2Me3bU*KP%O-kAu3iC{nY6)f8pNE#KQ&5YO=7S!{r_q9=gHVWDfX{gnqFROUA z6r!UHu2Z{Evi5C)LILyY(G=rxFkSnntKQI9w3Z-e!d+D5tqc+o{rCi??l7FYmT7Sl_uP|fJ5h40Xf@m{Cu$sYZqpB_jIYSJ1 zohg`@6Uw(QlwB!`T1}w4r%!rBSbn=d^8*xvs($<9azGWYc*;}|n==N^ z5C>&)BXH44!L8OaN))Ap=X* z@Lt(;-#|zx&4uI0CVAH*t~TNZ%w^T%C|9hVf;o><;rzaI?Y8@M?_ZXWTC;y<6|KvC zQ_=i>*XdnFLOtmJ^a834EC4Wcd9iO$;q?SNG}v zGzjrSS1>We(GA=8A0dB656T(WlswrP0k|U!oJx;c^UgErtr3Fb*taPAcJ6gij_AkV zW?Xb4svRsowieWlJDP(X$DXl$fa9mF@Ry6IzOxfjryOCTtqj37KQ8;v`<-&qn^DRDy|(Al=KjW14LZn2W{zw|@h3y++UzgUR*K|_{|!nMge*BPy3af8$~53$ z;)Z!syOLA^+I3>sl!C-@TUk>2cTC%&#}v_K4jo7&f{#i-Qu=o+?k}G<^0#$gvU=P& z^S{Pi$5Dc%0I5@tvS81r4C(n3I}-(|CO&G;eqBO8|a)Jyf+oig>A*zAv!h~!LthWsgANw5@LCsGAVA!U|9a%S*@A@fqU(Sn zy9KrWemW#Tg&ZuVi$-+MF=-)dd%!ppEqjSdK6_(Dcyy6hvXudO94K4=UN3(`l!#($|tQteXL4Yz!L3c$R67$u){ekgPGug zy6!!W_+cw`p(uF65-CsM! zh4IXiSedXgtC*F%=!a(1tbr-k)hbZ3kS-jFpE|*%C{}TEe#eJL(;gdOkt{p zNH0H47`u^4Zm2Q_%a&Q>`R(W}4A$=sZesd36~$sKa!*lLrrZgAhkhfZbRARcQ1sD@ zbZdikY2}Vu&-8ac*+1AVm2i^j+35>-nT9DOcu?}sk&AA5umB+XnfKSmy|91@5pXo0 znoM&|UWtMapP<_UtVV$P0Q}kH0!oi+ML&;aN%=w+kth7bRC{S>Wq^t zcEB8_h^>>D_be@CvYL*R5KROFif z@h!X|5lItvgdEY5f2WUj9Nj!yI#45jY}IWC*0tpRYI4C;FADz^1&zzR@kx$R&Y~ literal 0 HcmV?d00001 diff --git a/doc/figures/frr-logo.png b/doc/figures/frr-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..6e66414c3af3246a2594f2240952045654f8084e GIT binary patch literal 26502 zcmXtf1yGw!+coYIycBl{-r^3y-QA(MmjcB-Kyhzzm*7&|9f}vX;!uja{^5E5Z!($8 z+}V5g+TBafo{dyhmcc}Oj|Kw+gDEEqQip+ot$==8P>`TcIIu~cp+89G3Nj#=*SAk@ zM@bU&395^%o;wT-5$@X;);ebf`W_7OXE`M)M@C zFU{ZcLkro)v*_`FuPS0FO5$p;DdoX%a5D(_1e&VtQ47Jj`GLl&Vy&_`_<;Czg+NtA z2^3VipwPKPKjo!UJOEW;Ast&mDjuUMo?EtN-lmZc#a) z%5P11oxKQt`Ct1$ZP*s?{(<|Rr@ocBPA4~p(T8a@l;B)ls+lN=f86EbcfY+BN#Y6p zs7{Hu0dOKjPxaO?Oh)*nb|L=BOvBO3PUxC!a#`}I-ZP{7F6{&U+nBVQwOZZ&k?vaJyTO0v{5B0f1K;K< z3sV$@(A=U%4lyWJ`+KplQ6NGj@b14CV3s9hRs9#T>i<2LFNH7~xFTkKqh!=Zar>F4 zb@rV^!vmGMi&V_d+A}u?=S|cTiHcx+y=TIf`!!R2{%irB$vL>8{J#JFC#D$8qTRK{ z*SzRx%<;f-S}IXO^ETyGCmT9L_e(*E8a zn1j;b0&k&3Ffc-C*rK}pZ4_43IYUw6Z(DKSp)Xf4;@YHMn#l|P zTEAenM)@|iCuVK8kqi(&;rQQ;q8p0!zf#2P^Ehwv;#6yaTATP)AZs??KO|r5nL`-g z#HBWAEf^{L!cY^XrxEA&= zHgu2U!Bgb`eWa%X^ZV|nKH4K)(MAHRXWfLi9SHrPNw};uk&)6W`k&tY z$ozbslKESE{Oflv#Gx7i90VCGT2j;{t8USrHdfV^JN~2Pws(w0y0!oHg6?1|qS^)Y z6#=W)IOfPXjv4=u5>|$oBB1Vph^)h8RfpVt2)z8)(M~i-O1oHm;{t%&_L8ghuT&Ry z*EKV5%7cpfWPG-J0)JbkR3VIr{0JNKjRgQI3tH@?!2Kn>R)hJr+SFR<_WYatolVhy z$LF)=C|btM2eBsSdA{VRBDf*)p#A3wV6I!bJ--6^>K9Z4Y}o{Mx=Lrc&@GVtv}Fjh zLZPk*9|&S;Ch^{!FkTt;{@N#Z9&*k3;-)G`+ad*7hv%a*^nMttColNp;;$mQk*U3Roj zL>@2P>K{!3aKHmi{^&vQ|5|*>ONLAGggI^_+VoF`0j<4e&YUgk62|>}voALw^}yxk zCCN<2{o1~mq%_G1Sh~-ByCCnAPUuD!fU>PfTVQ_!o^2ABM z$wW=;<<7at8z3^^=l@81HE2Q;SB`X~&$^+uV8^ee_knEZ_Yv%;^tTP59afFQGxQ+} zqOnIUB8|qn7v|zGt>CrNYBZSFE^1^{o413lOSd~9`cE_Pn6lwF&M{3_&JlMFKYd1l zfk_Bz-4mw!j&xg8e$51Neep^ zEND-#_+=tL`5d&mKX#3pYd_yo(5ko3V%0G(hR^JP_hyi?s7(hfy7NlKir$v2_e|S% zK}~u@Ma4^f5Fu80uwr-&?3?c|6F1U!arp6j#M}2*rz|d`(bzgDX&Mo_EM_$SnaSvz zE{v((0ZUql#;~Z5no7)!+6pDPI}z2nW$Yk#V9>4NpNhC*OeC!%SkT>6{`cYtW`sGcu9a z;<1S!c*~h zE%FxZ?_CR1W0C9&a{J*WyXp#_InF7AtG~TsqU$VL*y7ElT`{iVg|--#HKTrJE#x6b!&=jab=4Q*I#=x zKew?E^07dRz9FjnsOl!;2&2JlyjJFNUX0hTTl|~y7u}vrBu|JkSl-dfUr-_*o!)Hc ziKe{(jb+S){fr>1ltMklNiqDu_?7x-œUvYC%5Tz3xx!AjkG~?aGX~=)0Xe`e7 za}5ils_L~)!|ZXzbV*-Ewq1&e^-?S!A>@}kOJUW4EN^* z;46-q6wRGt5dZkiZJ^yR#LvV}N+E0+?cU?*PtiPiny)A&!lU};bJ~Y^1HGTysNCZv zietjlhX(OHelYYMF$(BtA*|0D^mu&5v-%~q$nh3Q?+Nx}TTC}DwT2m4Ug41oaWJQv3|!>H5K-;75lMSIZRp_twjXOJlpp)&00`m z{nr0%{{()rEC*`cw{ZwU#<9>XA67zAsK$eg84K>TxD`q=E>?^k+$hg&JFBD+n@cXA zW)>j`$t(o@?Y~WS�yPFFK@2?A8T)PovLy(#Tvijef2LJoa}*w%*g^{dLYp4)7;z zj)UlJjco8@s9e0I+t=7<^KKmM@0FfY(&(HkIuB`b-sfaqL4z5^_s%chd)%L7T&$|| z(zj5c?z6%m^n(%nZ18j<1z)5*va3qF%v|NyP)N=ia;M|2Q0)!vrzA0Ga(BdII)>KW z;PP=dGbOP}!-$5=9LZ09=iD}Le|yW&<-~w%#Ls^P-|$HCzs6=&S@5%4`%I^e3d<9v zv3*UQ z-Mz%01B>vV_HP3%7KD!2+X6BFYwkkGtdw;#WRB!Jr%afIFOV=d(6_lL0;E;epnlUq z36C_8C%MAsESWIHR@%K$xf^%W*ql$w?z<=HU?a3Qp<#LmvxCZ| z3TT0v55;l5?|;Ac@fN-8;Y0JMMr#~CEY{*=i(1~d{UBh3CQPa=JBYSu1XO_8U4neS zJATSgS)D>Ja$g4CAje0d#ICq-Xo{wFfU2cMrOEnUsZ8bTa5Opk=C*{BuK0S|Z7{49b?B^rRLP|+sZII{ zDHqSk&v<4YzF(YI9=wt@L)mW%+}~O^d&|n69|A@T!*k0Pnu1!L{whQXWH1^-U9hRd zz+HFy)h=AXq4&trr{gmRN69$eC|d97G>e{&0Ak%+U#XyLGxo^j(h6#d^r$Dep@iKo zu#Owe)W_r8*^h@iZ@C5KP$(~S?KZ=r)N3letrK_Z7y)p#!t2z_vG8<;t{HOo%HNS)E!E!j+#x&2#N3Eq&cxfYOC%G<;_Y!|ZetJX|ewMEa zZniGQ^LXe>{8kLjZ$ca=b@08ge2^}NMsg-$PuvYknkOBz;6O;-4b&Vo6Ve-PE($>ANw(?^hnP6F#>9Be?5~%{T5Uh%+kbO^jf^m2uY9j zSouIBU-@m`3)N^YY}Ni5y^0Vof2@YC(axC(A53bD2JLlzjv^l7IZY@1XamN`{n(EV zEEZ8emP1e{IN2lm@n0^|{WMIt&)3g$4gS;$QI2HdwTT!Ga%}0^u_a>OBa5^P3}R2i z_aL>7yh7grK}A!O#~wJ(_3VU2%=kc*v<=i)iwbQ1*h(ZTb$E`3Lxs7F4wnpocq zradeCY+@RtRr?H1`2oJ{JMNreJUh8j9Yt}T^e!LCM54lkv%oS&n6W(-Mu%6pZy72L zvunJY=|aRN-^8g6AR>}q3V?e1o~{K$E$Y=SV=_vd8%_}5gfD#HFa zeMY9d3sQa56cbSeegmeaFCg`rJ?a|BBX8v$6p|q|Kn`@yr~1RFZKy?+uA>w`z8+28 zMBg8046>Y_X)Xs5voC6Qa1UP0$|P^mnSe(9mbB4QJx*svGgQJ1~ikx1CF&!^>4~YOrG3Hd0c5VO%-)|8ZNlYl}Ahq zT06=$=ba;z#U%vm>Z-GZ63SYsF&la5C3_FTK+LD`uDlnyTNT!fXau(Y!`D?5gqeq#GkL-I%JAA?s}lP^OY zPYw0?JBY5c)`GC0Iw{h=g0)A0$C%O`NkyF``LwAAN|@2~9dcn=4DhN>Q<5m5#-ZK( zwQ7u1oU&c!aoCIq^>t*>5`TJ$pvd&~rGpr<+e&*J=?AUw>=uoEyEu$%{004kF8h~b z7LyZXyR&{;Ti%Z|l$ zE3U0-7aj`FHmeEir|oQgPUeTkL1n5T=_R$KXOnu<@Z{_XUZGhxAo1vBqrv8IvQQ}k7SEU>wx z7*}#^C}IRt&g?O3y+US1`=x}!sw%Tr9vcrl$3^NB=L~bHe_l|2Fu{)Jw?L#?8XuVJ zxM-_%46c4q_{CQB#C69;j^uo@Uca7?M=aKNe3Gb$Rog+2^RMH%1}FRhq@YeVWQ;oh zD+kP`+4?C?`L~C+v7yPTSe`_1oKOq-LE_(_lOXFK8fgT+_j;ScZT8^|0jFN?u}&4v zNp*P?iya1biwCov4Pjc~fMhfkZ9@;gD(c@~N)$*}{gEg#u$UaL5|7b()*WB&~em@P-me=n(t zB>UA0GhwJCl2AFRjc(+QOZ$INf z55P^_=uNMZ*v+(N@`PvqU7))L8>^HP`)8F<&5>hWusNvJTW5N-#F!zSs7sdk!=8X- zA!@>i*itT8KgP4KL?drg;#)2jISO#w=-~(EnXhvkb@{>pxs#W37RLf#R-aWHkLlE6 zR2O6;nu*eIYS~`Y=dn|z*gyGHlRHK$ab*?ZAK%u6`|4-)_uUO!Op(GsBI)NVbKmu8+L>^jhG#W1|5p^bSoZs2wpbvHHO zbd7p^x{+HXm26?aQKjRB)B2a1QU3jx3KJBH&{H=82wq0I)GM=l#a6;U1`Qm_1+JxTYKahNMK8U(2wdOP^jFiah1oz^kZB%D!uh0u<>dUp(K-Nb=b416p~ph4A55m;fG? z2@*!A4tIa&?><{VrTv{51O*3b5aj_%Yd1rmSz8-5cn=Y1nPJIr!8|5jNDvay;ujMB z#Gl+Rhbmx!dIoL%!f1l)mRz^5&Z7dOQjZ7eRn@pg)~?1O`)fQLe*A#AQUwfX9x&B- ztkl5T7Q|BgUV!$UU(SAy&z)e6(`%;sAk7~&H6+x@3F`7izk* zoWmDt8MTp^?kOme(Qu3f3SqeG@Ab6%pv$A2aO}pXc1Y=ZrJgT45cv%s@G&IJ;x9zb zJo_d3P(*x*gS0kn~zPGHpj|w#`wKD81BU=>}$T z5xd%i8$1x0NDYKyLz?4cj8Ku3LShXpWXAs~gNAJfwGD$tm!69{lqsq(4Xa@MDj3?1 zPAKXW5;T#?sHN0$@!KP`13ms)Yer2@1C!oM^rl-OoK8yx>Z-~22wBUvoIcp9Wz*Bi zW75WKi0#xe1*iRb6z(D|EoJPUr+3LBS;1C662LOInwC3=2LyKblaB-GWx49xieH|8 zY=uvr#GIN%Mo>a+xL#0blOL9qM;yeGR8L}Xq6sIj&QlEo zM1B87X|`&YZ@=nYHRo_?EU-9MdyXgMh%=D@MYvV@w_Qi|tD-N0%I%aW&5oI=2fqzN zQ%)#QKY&3Htk||=>Tvm4@L7^3?$7k)RJc0Y$r^fhlYQ#W1JlgmvnJFxCgcZakWYj&T4-Rb)SyZ zm?T^C7-^7NJ+ZbXpOp68et48^oOC-Id|Y4kq$u1<8aku%c02B;C_#aDccZK z+nRLHyN&SJBbCn@A|)yk33iPOZ%M|Cg;)(NHUx)sN>vjj(L2yC->8Hz>d6BB&}5W? zzybc8)AN686qtFS=*QvadOZq|fwX@#s}a{LPANHV=Ho%L);HdAuQ>SejjoVK&7O3# zq506zKbLY>A1EeMh&fvv3dKJnfyvIbbo`>p@e0k89BE z3y9l2LrI^AMc&SM(=IW=ViytP*qJw5B4a?7PO~cV9cz zV3{!m5MZJC+nfdkOMy$0G%&AfSy^PLUtydo4m^3dzazK&s3OHs5ykWAww3S~?4 z{NB_4;%E4RP8mM$=fluh7h8JNC~Zv{fX^a9c@!yEg7FWTCoNdGDuCs{54FNag}` z0r-|8l(EJAH6?Yv&pj=yn~PV6?;t4v9N_6Wg*XI-rgi9VC}VPPsvI$e?m_@~EFdVI zZbPtHd^LIu42|bmL94B%BRhaK=Oaa>=SSX1N9ZX_F+Vh<>N1H_yLf~72uYDsqqtn` zj~Ybj2l3{rI--L(3Cw}56@;ZhcO@mb9?>$>M8jEBI%3E5vpzreFiT!$4Aqost6l@? z=hqky$W)Fz;9MLw>0#c(%W}5)cC%b$En#I=f|BFFUq3@OZ7~+3DmE8ixuvx{KMaC& zBJQZ_BdLoxp)+fP)vkw`?6XN5`Kt9ImG7>gKW6p`nCL>wBruy-W1#{DZenz##ijcmuotZi` z>O!c7&bvEx&td@C{Q@rq<-BhXH-9e5E@JzPOHhZ+u$9}fO@wk5gm`?L$uO^;N4`s7 z2zesHhSl&_OUC99xv1MDLU=Cu8Tj)|7YPg7GraS6((|@7dnw*T1|y#Wsuxx@(pcTX zr(~5AS>Pv8sb?ZAvt49^n)2Tv%`dayQt30&MP6TOT`Rms@^80TSc|;%d(@^?q-ln0 zNS4G?9yYtuoZl9>PlR;TG&T{^{MmJX`o)d~c*<&)>_@)TrUe0TwKt@g5N{s5&$2e) zv(XxLAjKU?6`IU2YT}A5Sbel15pK{_BylkKq&oT#Mm&t^YHG72XgYcz z^3xIav`Ma9`BWdWDx|YRO1|`|oxL*s8NZPtT}2N_znnI|3KmoB!j2d#sEFoGs3i=!J;3gbiM$oYtASiW zE4SCH`7<2gkvp`udXV7!bU0YWu1L_TJ2b(cRd{7*E1Nqd)?3p8N}1;05e;K{B6a}M zE3>>Fh}+#C(lF19u)0O}g^D0;3{ z-}9u?UQZH*y++S*)m=EQ_1qb`4$Y!V*$cVszkPH;X^!cUC=2VyF^RZ>k4(1e_A#f? zd@d2K%;ZgPop8(uk2?vQGA#Ro4nE{kZt$?4aD=@T|AV{w?!<@QH0zg1Dzbx|@j)~} z5q@TbPGo+2xN=`;T)F@ET0F)onDsi1En;x^=s--%KhJ&MS>QTX8!O2B-%cwiy{ejQfx8t!>M8KOFSJQGfRHvF^oIU@Ox0#e||xs?J%EY9Z= z+7O9M>raf^IBczn!0xG5=Wc4b+m_12jJ%Cn-Iltp9NO@n2jxD5oN~c0zk1d#4W#nI zL(SYHxmbk@$BS9uq4<8Tn?A4I8fTI@;q#e9wkrBoYX{r1TkiI-{Ak<1UQnWA4$7i) zZR+1{!hQLCtW#M?=@?ozx?l;4BZRArs`R}FK3};2MyGv=dQIELG6s+T84=abt9`*X zc;=GZ{5>TN#{Kf%C=89c+Z#Mb{`iNiP2oD}ba7!ef(DP%Uubiu-jgR7Mzt4D?F9X@ z+?Kwkj5rUmu@?J=hRCgSMbyxeKqKGDH()q@d~F#1vK_}-2{^PpeF;ui9HDHT>`EFC zAhVf#2*2<*Q^vFZ;DhX-eJTQsDe4x)1>Qzp2a{BD&<8zapY%#=5n+d%J{-~>@4YHI zRC`L$y9-q?FJ26>kmYXhMAa5yj3lH9;AB4fhB@8ct&Z{ zxg7M->P?qtX!717cWQ)mruiv(J7BRNPj+PGtTAOUWVpMnQMAP zk6|jcP0V>xIH$H|%~>J-z2K$KNR8{m^T&x*ED9?fGA5vFH6NGi-lM>wZ?!u=h!T5F zW$?ttQ#Y5=6Kz&@WX4~X^}8hZvud?5D=1$xF&S`rzAaTh-@_Kc&?4 zeWCT(cgPBE42OX!HMmCbz;soH2w+#^?vS>X`}@S(ehb3Uo7LL8wp_bZ0QP^ta&@*BWw~ zQvb=5XQecjYltXAoy}oYqMKHj>4P1Ihh?=uBtiJ>#^Y ziY0uG+SYV#AZ>rt!zvU20p4*%<@t$6r1V1*l&Gpmr8CtO@R1yeptyf z*A{&{BuEK+VpWU#_K!`vIIV6_UAw)q!hjI?8U_yo(OFbA zDnnFKFk49!v`-;qjO(~#hn6RGUB!Jca?8@*Km*0PhE!>&) zP!R8ArfdRHUh3Yfm5QyD&OX8(ntVe}&!3$k0#0W9`+z|4&fw;2ybVS#<`)qnzBs?Q zf>o1T#ZvS^hIL~asg=?p)OlxPJ@bvY(-^9s5qX!F1^tW*?rsH?E6mIE*#3ahjSCZe z=M8z+3iu#~fLE`)nAt`jyRP_MZz!g64y(!}|(sW_Sh!H?=`Zg{K!dx@K*)<(yjZAs%_0P>TQSD0}i4lWBb=m5eCqf*>FL23^-z z_*-oM!Z8{E2?+_;M%n2{mRTQegQ*u4e$hL(FCk6;lEhhMK7kQE?=tI`A5x`2$G#XFQQ04bT zLDK^8d7V*WkZ`t}Zf=TS{cuj34!~uGfvH|Vm#MEu_Pbg7yj}S!q@Ajd3Y$V+Zd-?W~GKgQBmjW9()?Qx+v`5yv@e!@djrzGczANg>qd<9abA` zO}bv54b)0;1vQlTJFccQ1Mx2izz!&3jScD15CIhKt3N5jk z*1N=pSdDcRNrq$PrLh?$UftU3f5BelJT)Nq;Un}V!ba*KwbG9cq-(N5Qz1(%)V;sJ z`hvF%WipUsB4n*)u2YXDF{sO|)XctD`n#T3H{$8fp03>~UE2wVJbB6CH+a>IU80;P zV&ZaBj2<0jx(NPrH9Sp|cnv@Ou6wG^QzmchdhZzZrA({^?xSr+8=U#+b&g;l%JZr7 z05oazVmn@;hDf(J)nxW~9q2PPzJHIH-G_!YH=eDY z{xCgm;9;i%OSj;ls}5Z)o< zOzmPLiohTfU7{gig4A^J5kl29m$&!i-tp=vV4#k383qko3Yig1DGTr7L%SJ6cP zG+Br3!JKJ4<}{qr`xSXz33CtsMzQcaolUHbUwZA6KEtZR-i+F22Or7{ zx#SoFk^-F^D>Se++)1^|5FqT0XU+E8)koU(&Hr1`&f#;FaO+GMC<oi8UwT@eKbc!(b`iAs6BaQ$QbQArS!uukZ-CCkrc@!@$~0e#S^x+*@H zHF>}1X04DPdRDKk7}(;vjr4T49oM2>W3|3;SyyyGV>BDF9p-q3pAPIHa+v9IBf(!OAVn7LrOj=@R`s+n-a73!dQUiK&+}f z0ZSrV#DblykFI-zYGEMwCCHl2Ec$iTspj90hy~POPD(Behn1#Zv~)jsoYym{T3+G} zDe!A;dz&8rT2CT9x8d5sGQzp@>mF?X_*EGIGOheu%IfppxFU{A)(I6U-+k zmkjld-L2mIHDGG|h=ryV&*yr90PfJaw*GRu?w7h>bQ_-8Bv-O5k-E<+vOv4|Cgz`!xMe5yk9 zqXX>7UB@DBdGZ;cs!BI6Y`@At7>hPLd_PCU6BOECmzCjJ*Jmyi$bHbPEsVoEI;}cidi*!v4RBMBJ(Wh7Fjb9s6d)86uR43 zB_dXaLRlu=&sEtdVPF8)-6+!q%ut4q)vuLi6#`4I>bc;N<-ccdczk_ zR%yZh9-stGK^I4P#ai&}+=!^#W7ulT#)io&cZhbjIE|Kug> zHUD!CBjCM7L>_|Xdo@SX=!sw&AA;icC>KW9B4{u3_+NBI;0}QssWDCP;q) z7VF+e`L8qCq#Jb^IYQTH*P69E4>oX^AlH_`O>>~uRPRxQ?G-gtyCMbRh?HfVn89M{ z$}L_TL-++w$Di&F$HL)P2JB()-d1Ej6!vg^O1zX4)ATSvZ=#pc6ZK-FAdl=L46Kqm z?c|coEahp&u7pu6q225TCW))7C(=49C@LBsYR^pDE%X9 zSG_dwYt5^3h}tnDB{MbWx0rreQ?eu(Y1Kt?OAZW#2D&Nq{Z=ioq%bU%0GW%rH825l=i2C+No4 zIyU;F>UH24&a6zW%3UI9n-hg{Gex(Mfkx6lUqF>amA=q(JHr-1dN}Hd?g~}0xNKqC zB8-l&H(Ux!*0jtxfy1FB6`3hwdi2fkT~sdSQdw{^+L=?%NeAZQgbb_S224I90bm?I zRdbuCo-UsM#)Tld5>ExdFcP52EzWcrwGqU;=T5w_3suC5IDNn>VFkiW4s`UXvh~w(a^fIi zyrYafup39WK#B;S#OGuRCa(iX!0fbklR6cUn_0=qPLn9DJq?^TY9hCm(chh z%B7vl;wOxNfEyjJKg0uNgA*oW@Si8NHbnfs^VrX`&_2=e(z6k0LRNbw4_Oul5O&_> zsH!|X@wnYP?Vx_eRn^jHE|_g^dB7cr*GFN=IhL)AX6RSQqLLzNf8nURlh5ag3b9~dn$gTo zN6Xbed_vbF*GQ!}A5-~WoTU<})%5z5ZQ|5QlW2LoSbMgW&M8g=Nk6bj=e1_DU8=Jh zz6aZ21g8$UD^88Ymo>oZh3^uZIR5D`KWfb-$dfJSRi5gpV_~o3y&G^ z!2}l)bNV8T-#G|Gav|-D*nR!_P-L~?uP`$^E7^dJ`WTE#AO-=e69H=Tzx@m{H6KW? zLVeH%QJR!L$^7#FObxmnoo))0%~sA5=s7yoPO36$>wH(b z0Zn$!Mw?wN|2!dL+G$ph*L7041?8;ZQf?UMc1F5nQrZ`C!N4??+l1Gc(-~H=Rz11( zV@p7p!8e2z4yPIaO5vzL=H}GCLe~W?3PkKw*g|LBC7xgPRjU{Jrl=%`!>>gXt&v61 z(IO2cI=5l<@^G8Pv;!Rkxx7vD#pDso3=v^q>|6B>hQG!$%;8o|jGeiJwFY?w#XMfo z3+dtn7nYRtjURqkhd>~{?)$M>F0_xsiL;`wLgRn0Un-{>9cPO@hhoWi*EY`mr))l& zZDYUB4SG%;+xCW~21@0ABiPYWLA(|~Tzk@fmlS9dwgRynMc0?Q$fbd150F;ALkGTD z?z6PrKf@GT3G?0J@MfF2L4DrY6vo=xNOW{`n{I7^=O1#X?I;D9-_OjoCKDsC|K0Lf_CR_;ZmOfP%-i^krVg(}jA zyyvzPgBm{d>9(F(lIa+J&xQp(Y-<(B5=}gxjM%!B{y3DX?1WK#MOVwr4{Vy;sNc@0 zy|lh6+``vS^GFQ}=aBH}Xn}4yt@Pd1Mt9eE z&Iq$?;81Xp&LApN7f(grel|55zUc8VczOL%KU2|KOA2K1Ph1eK*G)RHmOzVBrNvrAR&a(M*xE0sMUz1X<>Dd#8+V!_ZXK?rYj33|dItqV zODS_14)}U1|8?|SKalbdu3k%JaN40z=cgRM-v)RgO$djc$d*fC!#lyW!>P5Y=6~1_ z@Q8;kLfhUA8_+y*)wD_%n3<>i>-gLNh~T63r3M-xbB=mst#JLSJ8q;)K1cHRz4C#p zKh9T0#U)_Wl)Dzy>Mtrn$^RC<7(+>P;znr?oRxM%PGb1|D4iVpuMSQl=yoOkEXZB2 z4QiHeRJYIP3coBOUKl>a^P>@*+oHpo_87(ewJV?`J|viy{M1R@l-Jhi;6UriVa4sr zW$=N{3k876uIsbJ$2oRu{L9J8m}8lY*E}}%0Ny=EY2z9(_gmZ|HcNBGFRQ%7r_tWl zprz3vkQ=fFZ8WX+!sPZrc&Lu06%%)qV@UN5q{;5ZJ$V`4vv+CgnE>p))7aJuW|~E* zXD6RGAK+)Um$BQYmdA`=#8(^rRJA|e^9K`^h;a;N9}*wRs(3F2y_u8jmP!KqsI=BM zDeiC@uu*GjW=Vij8?{+-Oi*h}slA65;4Kc4X^>5iOzALGzkw2Myv)oQHHF>f=^7N(%CLR&Re8HOP&8IMvepGprWSO#9a-`XD%6sn)FNeszOHDE90;FGtVV{ z&+M16TdQo+w>27w&0H#g4T&Ca;qp0yRjcD8oGo`FkB6gBKCaxG)H25$u-wX~$Iu8N zzs#)SkF1Q;n(Ci3UuP|oHlsSn3<6$zx$-&aU#~abB_ci!au5QoL7rS0Z1Rv{J5oy7 z^zIasaMMBow8Xk#+h0HC+`W`GsUd{|fY&Xqd~ln0xr(=DFDHIQTP1G}ux>z}gjIRJ zN#|QX6&5Oy#CdR=)wbo)`p=IpINAa{Z^~K<)Qpp7CD{7{x6rDuxWptzf-8MGUCP8hP0dzrm>d;cAgx@iK zbP<$Mfq$>(4T0KR@a^ciWS(8yb2psb8_#0&681aHkl1P|qP$YpmlA(G0Bnvgnnmpe z=orJKiU+*yo{hY2(T9VDitc5A$f2bp@j#L(qm%97`+AZa*ntM&6oYbsxEf=~_0eE* z!3t8ft&dD1N%$=ZDf-FgsDFo`Z<0Le#6}Ew@~ONwuhwnF5PuYVPGaN+2<}||d81k3 z!d4H5I$I97t0gRtSi*G@-$Z0E4sD`DgvRL_iOd5HI|q{5+}k}y7PIE|vBt4S2>{pQ zLph`0P#Lv7D_@f1R%84VsDWa&61|`5#zOXcUt<1TDP@o88I4B|8t%e>Moxix6#B8j zVP?`W{XASbh^|c^KW)}hWnAV1QN#UmyzEKa zj1i%T>#NUZkB-o@JdR%^()R#`7{X3-x}+AG#sali9BWif^4d#y+VQi@4W+*O$MkZb zDz`Jru43M0rpn!k9*%cEJ#ryL)<*^ndeP>}OaaPX^r52U#Lr5v;;TllCj1T0bL{pM0{KA(_z|NkpND@s$j@x?K4jc-qms$Ve zFn1b0I#5vd+6yJG^$f@tu6iW`fYoG-1l9q%RnbTYs9J_gqKZ+5MK|KVe_E8Cj(@=i z;sf)F<%CqL`A)q@uFikB3`eL8+HAwGy?sC<(Zu%;pu7 z-DcRRQc&VP+!?7ru=*R%@|x5z)|_rQ!uBdbSllhry%R)kjPZ=VtV$N5C-&jTb$g?1O=w5O-r+T^nW*op%x?ED!^dIN z&VZyo(`^4E*aB<$zQ1vy-Ekq+4OaVYVk+7&x1-D3f==Ka`O!BGwlRTK8?qbDxXYY) zWO^zsfd)mWHrdA{Wu7o6wl_{2DxVf;Ig_*^s&%FAaO@`ZmsOI%+7$3^Wb2I*5{%`` z+&@V>&L*3oH&<$XFOS?tz0@FZ!Zy+kx)}=VI28_7ZUq*LjR~rOBV%wI*Ryg5kp_Lx zON#MU)6v!g&F}F#4^wy0;-$_oavBM(!Svc?N)-K0F|uUxOpBi5gB|57{RUnveeI_B zl19DcTZv)y8oS}4U`JI*C4N8Jf)@9z@M00ph>RA0TaPCVGMOv#8xyp=lU$tNhb~Hs zQuSTZ7pb!boaQKrT590&FK|N}@?Ye?sTt5yk(foDoe7pbTTLwrO>p6RrUPZWt1>mytWk&zm}W274}|X0voTw!Q+`{F$CxEI&y5N+r#eJ z?h3S-CxWcW_BHn5GA>_tjqTztc{uwYA26^!D(O^_Fb!?gYy4A?tPO{iuc^T;727M~ z?;&Fjze~95-DBz6*2=i(DkRDzna|s1(GyYHP0)K_!D~bbXjMj+L7YZXG6)7We1wWX z8(zG9K>nU_8^)-tok7pMan*wCCu0JJk z1{DjXcLhX$#X@!((84(p(V(3-8cmN5m$GBHCdg_rg#qjqMnW%~?K~iC8fx+BQ*Zsb zeFHY|8QCW?`CA1*!ko5bYUMpBVvO7HRmZp-1N%WtBmef=vg^ajhLLNJ(dkoTDAd>Y zsUISwb9JBbM(r>oeArH6bZaltGL`a0cma*dXLXT^NKo)G@n1w|4=4|8v-op-+*C0v zKZRm#*GeM!==GFHo}1B*2VUyer(DEEG#G>@V^f98Al3;)laYJ>@$34EXDuBVn*-Dyf@ZjMTz)Qa|q+Ez5Z2c4aEbJj3Ov=WVyv?Q>azF zA;tj8$5yqzdD<7%v=vjU;D=tQM8@oX52GvT=VS^cZZ_S)-6^=qJXGfx0Lp!wZs0GO zPCYH(`*e9k4WBsNGCd8H>pz1}YdRHVwvuB6)1}S>eicLEln{~?@aEZ`Imh#vvzla5 zsmvg*TZE4$s1n{POHp-x1c9|%0!CL>SlQHR2NnttE4ogAOk5`#R7d*%2(=#3-mUiK zXFqI`#BX$7g?8wU;Mu`LxrE0$Yy?LDO5w zSmR#<@e0AYyr_nPqxH-M3St3CHki5P3-2|r_2FTB(O_~eoJd@tNB^%@*vG;f*Y2n8 zO}KLN(U(`@MePe~LSLsEP(gVTwGWcJ%*na34ls(|JDmulnmh2;)d=3neD@C@D}CUX z?h#dSOo*kZ(TCzReD38ZA_Y1JgkH3TsCsf}Mn6we+D~CY2~n^xzA!KpXUZR-G>tCO zEk+U1F%w@WmcQ|X^R)E+a-r~PtIh0x5y{W;leXPnfZ|M}6H9gyNe zc@xt-Uv0_^+1K&p{})Y-8TZz146ub5F<*ZZFRasu%y~zgHLezu36C{v=CJkCxg@Y;$^GSsyq4V79is~p>HzM z0%es`8&axOqV@~(o~HU1fkTlXinjRYS&Kf0s-j1(Hw^kv9RxzP>y2o6x;(PXS4iCx z2<$>A-mO-zJq1d65|iLcAi_{ammwXc+vPgl01jXupai;9+|4NVz}GZMQXfA$e(Vcl zAJx&@G$WYVg+AN2`xJy4m;>@^A857&xpw)_cFACr#!m8=OnqIv$TsSdyr$q#B|=rP zw4#Sp*MUwv9#G@Y?f7XT`>0O-1MXrG|L*ipd<0`r_mAjTA2?2(KkOnoyTB1!h3AQG zP@k4guH8D|y{H`(lwT~>q&w0etxC@udmu>&1M~k{y2^m6x~5Ab-QC>+mk#Of4rvKR z`qFtxX`~wwq(P9B?(UE-=@Ks8@g1J``+s7e*|XQIJ$u%iwd_@GUXGRyy7!^W1$ZU6 zM?oFuptwqfzlz;wE0ajQ8Qii97HwxNF%lhylMorc z=*+5w1>`>VijLV(AGL-TIW_-bFK7w+-2dps8QmV9Y(0{|Z#vv-K-N!wRNMdt4sA(> zaxw>X;~&QZXlF=eYr8ycMAG$CBL??TZz_VZHSgY;8}b%)>bpr@qNPk>#nRl%n?qID*3&z+l12<@_sslv^9k_E}~(#NE$J9-Gp;;_W&6xItOE|$~!A`Rbl zK|GK@EnN{*QG%L-!B}!l3NTANTky*QRsT|gHA;a`u5`7c@?ro94JI9hh&G9R0{Ifa zN`Rc%e-Wes7zGa*xbwbmcUxHd8vVcfPzh=b+oM$fR7CXH%zgS3wJUe~+Rkj<~t2>H3+q#SP&?PRF+1M_|8 zfHDJwO#ZLA@GunCB!7oFUuux`!0jPWpK%(9H)SUTPe7xCtSnVj9S_N0O-Ge7LbN(@ zpg72w3ORd(e9B?K^H>K}U-u1A2ARM3>To4?_3iXwB;2@BI4MLG>+S6;uLJ=9U!>0` zbj_j-no6TNk1$+(mRQMzX=2_Sez*naUR96;^DThogQBaxFTGy`ZIZWWx^ z*YL!HfC4AkdYb0>UL*pu>z;korgwSgOjrP!#9}Yn6P#r6`8)Ynk>u`M&KA+r?($QVTG9v8Gfm%WbR@y=NuBa{M1n-ohY`6l^~Dy zGhMIfh0Ev0oaZETRt)Bu>5ciF*$7-V>mJ`~SQwZ+P{_+D=F~AzrnVxS(H{ZyeW=wi z9O>kBB2JkuJa1%Lrvny3*T|KbD0=peTyK3)L?$kvXA2Y+Ml8roFqqswJXQKFTwAQB zLZ+Yt2Xqn00b~^6BSC{^-Ko1F-e<(DDL~taj_qgd^^5esJNM%!2s6X;%rJo}L}-V9 zcI}c&$L`s*GXp_|D398NZ}7{prRHy+J>vdBYv}x8PJvzxpn0%FM(W!#io*tf34btM zk%iPVD2nT6wnU%b;TB}cUJ1$W-&2)|RGPBCjn`U-7UO7O(C!8z_+9yu+ajc5!?*wh(WOXgZGQO-CsEvs;@| zI@ZskofQNW_YI=EFzacB`($g}TOgz2JQ8oc%!>tWqhv*-4=h0XT%8dO_#xzTu{eE) zgbx5wc(`YIGA^F0O4WlTNOlkQy|^0czIl}=K3l&8#u}aP<4=BcQ{=z&`$4O-6vjR+ z3^zq8ku-M*hlv6s!P0omamy2xsxAh%(CO~dD(tQtXDe9v2WDk%7x}H+# z=4+YJ^UT+KWmiB`SiKtPvGmZ_6!K5_lmn1JBU}pT@=Z%JY@(qv>-~;sHe@0v2?*Qk zY=hY1Df0HGf5x7N(gmmBTBuG!VF&I@f2yzz%t*Ww!BMEgpfa}j_r$50AJDMLy5IpJ zIo&xcq1-~D$(x;})v5qW%_LI{u;e4new165y9!0~#$A+Wio$4O#YlBUVFMjA%fox<9E@}h?Z(9zaD$`RT?k3C$D>Hm5^`Fqs z7ngiVQ`I0sJDc!VwVG1Qm(2!a- zmeLWfNOz7bYE^T#zbyy=qHc2OVA{#|5^kyPK}6tuOrKobJKNmwO0F}^n9_uz4lC?r z7R8X>lhWbBu@V1P1gHRd;6|KQJfW%5!`ejlmy}=}7)G&9$j5JG5|He>H2vdZ&0$b!4}%h`D4$?g_JA$`x4o@X(#o@A z(!Qc}4#$C$mqBq_kfp0Vm?#Bp>F}l7FWv zmwyxf+D&(yN3C_O^y@{iUiU7>^pCsEMU2L;j1sqa!4G1ZeD<7~7(lt##koGq4&2MQ z@xLEiih@>_U%jfQ>;Aza+{ipHxDaCr@=v5Q^R=L_n!#@QPt5g`CQ<@YH*&J#S=N_J z?n8ivT9s_CJ??Pz(dJhyE44oNyPBKa?W)a@-U^ic0YvX5&|@M(2lmZAC7T#zhoraK zE{%6|m99obcdj>z<8P&_B4xi^Pgs4xP^3>RV}%1GlsUuV{>j3a5F=uxj0s*BsK4RYS2O zd_GLGSPpDx8c1(;;giFUBvvaA7vFpz-?F=&!uIWxz)31P*r* z3X}T8_=5mk4^_?5HvbK;!E28Nv^`KbV9-(=&CDVAdu!{HyC0A=uQ(vksC57qsPF3Z-WC~7HbY;8YRm%iqzyCN49yjJlnl1w&ikzgN!yO4<{KMZVNpE2 zV=Ov07;2EvzR^wJ*hAJ|;d)1oq%?-Hh{hu{?Bxd&IE3=IB_W5iGv-DYj=43ZSeheW zsY2^CY{|qLX`k=<^3e$N4c`D7#wl}|0vU(Ul7J+UM6M$uV#BAUh~-P9tJ~!V zSw*D>k&-r4m1xuNtplXV>tB7(-_d?8rSx#Xr7Jh1z)3@0`hry{p}t~8xL<*=d;_ga zJuIIFR5ntZ`-L)&3cbV4GqA~8=E~r%dRI!F@qf~6?OusX*JEf{d5J?bMf3EyvwJ3I zVZ%oVGl@hjb{v>-)V~jIzTbZv=&p&CTdBQ1~d)$ z<@b=etPj>p6tXV3u6TDP7}Vs03ls{~pKqTCk;M5nfKAwet~bHVM^TW#WRTdex88U0 zd&3EsUAO*#T1dgqn*cV2k$r&580pd9THq7%@U|TGu-$oAZ}TxvSy>v(=e4>QJ7{aq zkFsXI_UqA%HKrsK3MuU}iBHoAuq;}53ZGEnU|}U;5pl$D3L-Ejk##hp^7H5=Wi>R# z5ePU5H8c?5-@w7yCRrtpS}nChygK&Q*h&I3{_*fYp-$$6N2?z@e2;4)k%R@>yI}S=(oU2DzKFMXVa3Aka5qL5R5ytT>4wtDHCsGitTb$#*rI9DL-grqG{6Kt6$dXmZp$Aj`HjaFyFtjK=={D&>AflE+b1k390oTG>D z%g^I_B3Nb>dd)Oip$w*HJxu3Re?L=Xgo}ENatBZ(si0uLRpRy}$-)-6a$j5t9+9SD z9rB}Xy3DHZ?71RSvJ_pE6E})hEK8pxwsHSiKzwXvpB4P<3X$GuXcBck^RlXFCiA2n z7|j`7cv~-$98F1Y#{n*I`p^&ibsMC}h&E~-sMNrjPCPCxrc%oI(8kFX)<+_80s8V# zKXpS4Azod0vANp6(dz2A6*X{U0U@=lsq7{X+zhC%jq1eRV{>(LyAx;Ni}OU6lGUZm z@@)9{@AlU~*G#C!*Q>G27+YaEN0k_vf6fjqyd{{OUFV=xz9@0-;T?Zhh=W(l${k6L zWerl!HH;~B!{**BD<#Djw}9ut$bqEWqMviKI8m!zzM@AjI1LkBq;E6GEorTMp0Wid1bMszNeu2T4X!?n zGkk}s7z{g+4W=!*xHeWiTdO?qDnHWFG);tL@9g@W*9%YEJ7#A)p3p9SF_~I(FEx_b zTzRr(P~vHrm@run+>Emf87GrRa+r2vw zdrwPr7BA*}2Gc)dL2dd2cp?t01SOH-w*&S{zl4bpojW`Evc;a^3v5{TkM5U+Fr5mQ zvni)NOwMk~p&!*^?3|de9m@IWLrOh(YT~?YZ0nnRGw$MsRPt)2R=D!)CJ$ypNis&W z8@5%$>ND9bx2A4WKYEOI?B`N0KMAC=@y&@rXvua4x_{mD}TaumC2{OGrQ zFpi=H#`SPWn~H`GnoT6eTq~hoRrgNF}myIYF7Ai2u_S69x5Gse_>ktjfAvI z7HtoB%JxVS6ivq$>6%T~9WM9$YgSn6@hy3Lc(;<91z+ui?a))%GTL@RML*l3dR^`F zY==y6{C?P*3;UV7Xij_O*1e`J3fYDL_R|su%`A~qqWH~6`Yj~pC&r^y4a1>}RLzl( zJi3=Fzkk%t(o0Xcfi6`(c8wGdxn4@2Kb~?A+}@UFq$gA=R_&>Jt_T>FvAsNZuNWyY zIB{kXpTyz6*y+ecQN5rheW(!WbKgM{KwKwoPeNvaY|+yn+l;oWO&dNe%mT-7t5E;o z%INKf1K0C!g1^QdM)Gt{Zg3Ms9Z?DS0y323`>%Tr4@6>xi(|?uaD?TE z?=QP*b!~J2Fce~R2-NJV=;ms~C5 zS>cH3jiZKLM_LqU_pTIGZF=?3=8$^=s#yy}ePcW<`{AALb<5%57_;N>k%~oCm?T^+ zDwRqh!_g#SN#!%m$pn8gkwf;kzLBW-80MnQP3}@R=zH&sPs|G6CK@zOE<&0F_AUZ+ z@0OeIe?xEt?)Zwh`YfC~E6U8R|1{!}IFbnxWZZsy4Lf_4l>P7@JLEz6>51@1O)qJ5 z=Osl-=OxZ##2t1w+K=MJeC4RpS$Vc|XLilKK2_rBx&)S_Tn`LkbD=ViTSHr*oywN9 zG)Qx#vlO4wMz-W{KLOHTJW1*Li`w1Lh54E>P)S00RQ(3?{DzAwP){c%y|%#k61!J)Lhj8uoGFmqE*Yykb;4EGyzz0Juw zbw-B|;XQ*gJAd!)W~Q3h!olm+>VOFf{5 z`zq*`i>;a~ESSAiospaG`a9dtK~_)A=Pa!AL`|y>bax=RM-m8Y~_13%G%S{aVZ#@rnR}hHW1i78xEVis~GO!Y4!=OQa|Hq;L(b16Js<;l=o%} zKaDTGEqZRxQw2xa4z}8dy$|mqK>Edt0e@JuI<(+n0I{O=(=iq;8}aw%f%jHZp-+E#aooTo_NR2VIzS=Fj}obCB`w-2n(r$XO;=VRUYT{F5s5EH@g*z`hD>}^Lvzs{H&(hz)nyTlyrSMYe}S`OxC z+=E|Ee;!BSVole*{O+)tt3n~iNQ0*#Amy&^FF z(5JU?ry+14*YDBe`%;|=S{I5Hva#=zjie>SSwN}?c0hz65>&LMJ-mI2u!p7cuPUl%8*C17ek=}o+HY_a$?y5d^#w9UBRSWH_v^c zTaa8a+)(yiUN@SX^_BBD+oZ6FKp&Wh=0ig zH4Et=#a*hZtbXS}faPMtNwyN3s(K~JgQ2Y&i${s=W9CJ6Gr9QJ@40iL<68pH^)Lw5 z_*HC6)y}YNxWm?BU{Py>4R!fM|1!;&C&l?r1gs(~#xrGRa=+{mvjM$#LOsnO-q39uzkhgpVAc)qw&wZliHBg@wi3xXL!Mcxz4gghHu6*mkCtn>*r*-f-ri9Y*k^Xjnn@u$ zViq=$+8#Azlvgev+UlFnp9Nx@RxH#r9a8#|_u+ffB&UZT9(4w$N=5 zWj5{}Ilyhd(Lc!SX!j3J+I)(#zTNz%@Wgql5n+79NO|?`sVr<#0$&NN<{hnApJid( zN4$^0jOS(|mryu>&)XI&Cs-WcLd}u?q?boM5>d!O@IGllLP`>BJ-X4FPrii;yu@Ok zCpP9-yM+!G3~zyKVpZJ(f z+{g>fptmKP;SgzTz`Tgs%tNB!J7bd{j*Ejx@jJnvPh0gybVUN`f0 z6@%_QJ#xI>&&3W?8Jl;5uQiVi;WU^+o;drvGlLBbaogNrNzPxrC}Jmu z{^z8i*Q7kaf`qVcsZmE!Bly{u+sYq)bi;wA!HkJNU&zk}7OS$q*I?<1b19n9+{ zZDEyNZ(WD8f*(XNDb|@@owiKc7gQ2k_v_1beG}YS5$N2L_{WN*{zGZ?)*$`sWh1}B zZdk7PH(VMUCbn8D{{JE^=0Q=bXN!xRnaNC)!H=}uLWBJFk*C}w&U;!e*GbCXU*CtY zWuiSO<_wFDHi+atBQp5MLI!!tCHduc!*4=ggy!`UM29^be1T2FFAx5K##}4!9@un^ z^G^k%JUF(x;8waZYT;@mf%PnOVl)uy*@F}qf&ZCeQLe(A-V3(xi4yGKUl$q-8v$4j zEIC^OFI3dtr*qw`fP@{V)52otBS!5Pz2y1qt9`(9^xx|~2Rkz+S}tX&WG$SrS;0rh zty_xP0^UqOAwSff=Jj_)^K}-$!6X${xwl~Cl}NTKxY-vEIc`ylJaU&@W#I=r@)H7)=_(p*m>uEgS(-shXU7o^PepS?(|rQoA{sY6H-6SdxJ$cag)zGz(-U zc11-r)J}7Y?-2;Bq`2@d`Gcrwu1EbruO&x|Wur@_sB{s|p-l3YiPDa*2E&BePlU@L zQ=Y*v+BA@siw#>6=)9!4@<%{tt{v;gFr0jeJMkUv$-%84d7%2`iyg znfsHilBJ5@8I_WIUlXvg)l@=u9a1a!LI*Z{oP@A;bHk{C=efZ5m`2+lR9(iAJ>#pP z2mk7FldCBd!)(J#1AZ<5ef>uOL+b(P#Xucw;#JC|8WO+nm8IOUD zsdKd)-(=K$dZSN3^i|QCstq0R1?msTkyCQJbqr4Z>I;DS%xf>G zH!om>*MZ7Z1(MY>4M-b~3OkEw@3SksDd9~AkYNx&hS&uOL8keJrfgp&8UPq%c$FeA zbL6$Uds;FMuDN3)EZzhSO9K4Dw?n?yY|h}4tZCgujPP}Kcq>9N^gtK^mpa`5wORgk z^wtVN2Psp{w!rQWhYd9{L0 zezL-{-Pb|Ft2l46!p_cIKltiPVs+fjCH0{7w+3~**N!Y@H_3uj)wk}roix(yGa1^KVbYX zGvT3G-$cc&JaM1`+TcQJ{9-0_nCQ?cdX~nQN}%Pkn;-ic!#=oEzsDP#^aTk~t&WiY z(C0A;QOl)e`}>lA94~cm1ohK(Bmb84(C>}u82;+M%gUc3|8V#ua`>Bk4GmwnEP8vB zF~v*thz#V5rc;nwP6ds9zwHLC0RLC8L4-+|*8HjhZ_|Re3$=8yG&R4s@lOR6hW7TJ zhg#PqIV|9AEC=DAYH9Y1j>88;0KW0pGrfRO^+IIGXTlW?cbCfiIxjloHCYv(u^_Wr zK$amKqk>Bj4xRq0)8NU0P+I04=o-f!7(u^(AIloos&2jBG4Z6YHYluTvL({6++U>_ z@;OC%a4#=-wsghpH2Tzl{2(j6S<)yXco;R%4#-VVKjq*t2iP!{^X~xzeb6lWIsZ(| z{bgI`p|@}@!J!vb4z=*qz<7D@Ov4)m@H1Fv3iw6SXg8AqAV-YBQ9dT#`L8DxJH% zk7?@KT+lS3pl&pE1mivT`LbSfJ>3uh+=tf%6>kfQqRQptNR~-v_FwS{CPVLo7?#Vt z6F%6aDDa3D5sgy`HH70kR19;d6mA77Iy?EalS)42LcCn)Ay6#ZP6a>}44}DbTvtZq zEO0Sfv)!ofUA>^4;XQ)YWQFy^M~8{1BxqDpp2J~FCs*5Us-fHi7~1Pxzyy{jd|p%9 zUBg0!I^qD^_Om$1aTg{bFbbH;$mh6f`tXy-wd{!p?~cJhV4(mi98zFw#^9i+UBr+2 zwQ&FGqxb2#?f*YYbLn%U|0x{c{i6GH^K(tv$bQ&}ze4}5OqE85K;n8 z^HHK!tO{d@ATWWSm~>24?%0yNJN;$7*w66zxpaSAVZS%-39b6VG4WV=?8T1IX0aA8yM3Ljf559(>fA0uDv3PkoSUokwWBsPhT4 e%pKV?8S3fXm+$S3O~4;>U=(H5WGbc1gZ~eMq`Jlc literal 0 HcmV?d00001 diff --git a/doc/user/conf.py b/doc/user/conf.py index e79dea0bdf..6aa97de304 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -176,12 +176,12 @@ html_theme = 'sphinx_rtd_theme' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = '../figures/frr-logo-medium.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = '../figures/frr-logo-icon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -277,7 +277,7 @@ latex_documents = [ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +latex_logo = '../figures/frr-logo-medium.png' # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. From c91e9b8f74f7d7cad5fa607eb71fb64225534c85 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 2 Feb 2018 16:59:52 -0500 Subject: [PATCH 059/148] doc: note dependencies necessary to build docs Signed-off-by: Quentin Young --- doc/developer/workflow.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 1f33a51adc..e1101fd76a 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -550,6 +550,11 @@ The documentation is currently incomplete and needs love. If you find a broken cross-reference, figure, dead hyperlink, style issue or any other nastiness we gladly accept documentation patches. +To build the docs, please ensure you have installed a recent version of +`Sphinx `_. If you want to +build LaTeX or PDF docs, you will also need a full LaTeX distribution +installed. + Code ---- From 6180f995f4ab84522ac9334899857ef4c8aad382 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Feb 2018 10:59:36 -0500 Subject: [PATCH 060/148] doc: replace manpages Makefile Newer sphinx-build generated makefiles use an as-of-yet undocumented CLI option that is not present in older versions. Signed-off-by: Quentin Young --- doc/manpages/Makefile | 220 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 207 insertions(+), 13 deletions(-) diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile index fa10577844..562108a0bc 100644 --- a/doc/manpages/Makefile +++ b/doc/manpages/Makefile @@ -1,25 +1,219 @@ -# Minimal makefile for Sphinx documentation +# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -SPHINXPROJ = FRR -SOURCEDIR = . +PAPER = BUILDDIR = _build -# Put it first so that "make" without argument is like "make help". +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" -.PHONY: help Makefile all check install +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - echo "invoking: $(SPHINXBUILD) -M $@ $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)" - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." -all: ; -check: ; install: ; +all: ; From b60f68eaa8f7c843424d48eb36162b96e2bfc9ec Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Feb 2018 12:33:31 -0500 Subject: [PATCH 061/148] doc: note appropriate sphinx packages in docs Signed-off-by: Quentin Young --- doc/developer/Building_FRR_on_CentOS6.rst | 2 +- doc/developer/Building_FRR_on_CentOS7.rst | 2 +- doc/developer/Building_FRR_on_Debian8.rst | 2 +- doc/developer/Building_FRR_on_Debian9.rst | 2 +- doc/developer/Building_FRR_on_Fedora24.rst | 2 +- doc/developer/Building_FRR_on_FreeBSD10.rst | 2 +- doc/developer/Building_FRR_on_FreeBSD11.rst | 2 +- doc/developer/Building_FRR_on_FreeBSD9.rst | 2 +- doc/developer/Building_FRR_on_LEDE-OpenWRT.rst | 13 +++++++------ doc/developer/Building_FRR_on_NetBSD6.rst | 2 +- doc/developer/Building_FRR_on_NetBSD7.rst | 2 +- doc/developer/Building_FRR_on_OmniOS.rst | 4 ++++ doc/developer/Building_FRR_on_OpenBSD6.rst | 2 +- doc/developer/Building_FRR_on_Ubuntu1204.rst | 2 +- doc/developer/Building_FRR_on_Ubuntu1404.rst | 2 +- doc/developer/Building_FRR_on_Ubuntu1604.rst | 3 ++- 16 files changed, 26 insertions(+), 20 deletions(-) diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst index e93ae603ef..7ca14331f0 100644 --- a/doc/developer/Building_FRR_on_CentOS6.rst +++ b/doc/developer/Building_FRR_on_CentOS6.rst @@ -31,7 +31,7 @@ Add packages: sudo yum install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel flex epel-release perl-XML-LibXML \ - c-ares-devel + c-ares-devel python-sphinx Install newer version of bison (CentOS 6 package source is too old) from CentOS 7 diff --git a/doc/developer/Building_FRR_on_CentOS7.rst b/doc/developer/Building_FRR_on_CentOS7.rst index 60c4266894..4877c62636 100644 --- a/doc/developer/Building_FRR_on_CentOS7.rst +++ b/doc/developer/Building_FRR_on_CentOS7.rst @@ -22,7 +22,7 @@ Add packages: sudo yum install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel bison flex pytest c-ares-devel \ - perl-XML-LibXML python-devel + perl-XML-LibXML python-devel python-sphinx Get FRR, compile it and install it (from Git) --------------------------------------------- diff --git a/doc/developer/Building_FRR_on_Debian8.rst b/doc/developer/Building_FRR_on_Debian8.rst index cde9df31ad..36ed0c4e66 100644 --- a/doc/developer/Building_FRR_on_Debian8.rst +++ b/doc/developer/Building_FRR_on_Debian8.rst @@ -17,7 +17,7 @@ Add packages: sudo apt-get install git autoconf automake libtool make gawk \ libreadline-dev texinfo libjson-c-dev pkg-config bison flex \ - python-pip libc-ares-dev python3-dev + python-pip libc-ares-dev python3-dev python3-sphinx Install newer pytest (>3.0) from pip diff --git a/doc/developer/Building_FRR_on_Debian9.rst b/doc/developer/Building_FRR_on_Debian9.rst index f16cf12dc6..3ba3a90314 100644 --- a/doc/developer/Building_FRR_on_Debian9.rst +++ b/doc/developer/Building_FRR_on_Debian9.rst @@ -10,7 +10,7 @@ Add packages: sudo apt-get install git autoconf automake libtool make \ libreadline-dev texinfo libjson-c-dev pkg-config bison flex \ - python-pip libc-ares-dev python3-dev python-pytest + python-pip libc-ares-dev python3-dev python-pytest python3-sphinx Get FRR, compile it and install it (from Git) --------------------------------------------- diff --git a/doc/developer/Building_FRR_on_Fedora24.rst b/doc/developer/Building_FRR_on_Fedora24.rst index 29c7ee7b0a..ed81d3f59c 100644 --- a/doc/developer/Building_FRR_on_Fedora24.rst +++ b/doc/developer/Building_FRR_on_Fedora24.rst @@ -15,7 +15,7 @@ Add packages: sudo dnf install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel perl-XML-LibXML pytest bison flex \ - c-ares-devel python3-devel + c-ares-devel python3-devel python3-sphinx Get FRR, compile it and install it (from Git) --------------------------------------------- diff --git a/doc/developer/Building_FRR_on_FreeBSD10.rst b/doc/developer/Building_FRR_on_FreeBSD10.rst index 83e4513636..ccbe8c55c3 100644 --- a/doc/developer/Building_FRR_on_FreeBSD10.rst +++ b/doc/developer/Building_FRR_on_FreeBSD10.rst @@ -17,7 +17,7 @@ is first package install and asked) :: pkg install git autoconf automake libtool gmake gawk json-c pkgconf \ - bison flex py27-pytest c-ares python3 + bison flex py27-pytest c-ares python3 py-sphinx Make sure there is no /usr/bin/flex preinstalled (and use the newly installed in /usr/local/bin): (FreeBSD frequently provides a older flex diff --git a/doc/developer/Building_FRR_on_FreeBSD11.rst b/doc/developer/Building_FRR_on_FreeBSD11.rst index ccd4596a75..214fdbf9c8 100644 --- a/doc/developer/Building_FRR_on_FreeBSD11.rst +++ b/doc/developer/Building_FRR_on_FreeBSD11.rst @@ -17,7 +17,7 @@ is first package install and asked) :: pkg install git autoconf automake libtool gmake gawk json-c pkgconf \ - bison flex py27-pytest c-ares python3 + bison flex py27-pytest c-ares python3 py-sphinx Make sure there is no /usr/bin/flex preinstalled (and use the newly installed in /usr/local/bin): (FreeBSD frequently provides a older flex diff --git a/doc/developer/Building_FRR_on_FreeBSD9.rst b/doc/developer/Building_FRR_on_FreeBSD9.rst index b40696a095..909b3a8d64 100644 --- a/doc/developer/Building_FRR_on_FreeBSD9.rst +++ b/doc/developer/Building_FRR_on_FreeBSD9.rst @@ -18,7 +18,7 @@ is first package install and asked) pkg install -y git autoconf automake libtool gmake gawk \ pkgconf texinfo json-c bison flex py27-pytest c-ares \ - python3 + python3 py-sphinx Make sure there is no /usr/bin/flex preinstalled (and use the newly installed in /usr/local/bin): (FreeBSD frequently provides a older flex diff --git a/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst b/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst index 2ddd8bcc44..b9ee9c51e1 100644 --- a/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst +++ b/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst @@ -19,28 +19,28 @@ Ubuntu 12.04LTS: sudo apt-get install build-essential subversion git-core \ libncurses5-dev zlib1g-dev gawk flex quilt libssl-dev xsltproc \ - libxml-parser-perl mercurial bzr ecj cvs unzip + libxml-parser-perl mercurial bzr ecj cvs unzip python3-sphinx Ubuntu 64bit: :: sudo apt-get install build-essential subversion libncurses5-dev zlib1g-dev \ - gawk gcc-multilib flex git-core gettext libssl-dev + gawk gcc-multilib flex git-core gettext libssl-dev python3-sphinx Debian 8 Jessie: :: sudo apt-get install build-essential libncurses5-dev gawk git subversion \ - libssl-dev gettext unzip zlib1g-dev file python + libssl-dev gettext unzip zlib1g-dev file python python3-sphinx Debian 9 Stretch: :: sudo apt-get install build-essential libncurses5-dev gawk git subversion \ - libssl-dev gettext zlib1g-dev + libssl-dev gettext zlib1g-dev python3-sphinx Centos x86-64 (some packages require EPEL): @@ -49,7 +49,7 @@ Centos x86-64 (some packages require EPEL): yum install subversion binutils bzip2 gcc gcc-c++ gawk gettext flex \ ncurses-devel zlib-devel zlib-static make patch unzip glibc glibc-devel \ perl-ExtUtils-MakeMaker glibc-static quilt ncurses-libs sed sdcc bison \ - intltool sharutils wget git-core openssl-devel xz + intltool sharutils wget git-core openssl-devel xz python-sphinx Fedora 24 - 64Bit: @@ -58,7 +58,8 @@ Fedora 24 - 64Bit: dnf install -y subversion binutils bzip2 gcc gcc-c++ gawk gettext git-core \ unzip ncurses-devel ncurses-compat-libs zlib-devel zlib-static make \ flex patch perl-ExtUtils-MakeMaker perl-Thread-Queue glibc glibc-devel \ - glibc-static quilt sed sdcc intltool sharutils bison wget openssl-devel + glibc-static quilt sed sdcc intltool sharutils bison wget openssl-devel \ + python3-sphinx Get LEDE Sources (from Git) --------------------------- diff --git a/doc/developer/Building_FRR_on_NetBSD6.rst b/doc/developer/Building_FRR_on_NetBSD6.rst index c4292d7733..ce5c58045f 100644 --- a/doc/developer/Building_FRR_on_NetBSD6.rst +++ b/doc/developer/Building_FRR_on_NetBSD6.rst @@ -23,7 +23,7 @@ Add packages: :: sudo pkg_add git autoconf automake libtool gmake gawk openssl \ - pkg-config json-c python27 py27-test python35 + pkg-config json-c python27 py27-test python35 py-sphinx Install SSL Root Certificates (for git https access): diff --git a/doc/developer/Building_FRR_on_NetBSD7.rst b/doc/developer/Building_FRR_on_NetBSD7.rst index 6ce61d3871..eaaf87fd19 100644 --- a/doc/developer/Building_FRR_on_NetBSD7.rst +++ b/doc/developer/Building_FRR_on_NetBSD7.rst @@ -14,7 +14,7 @@ Install required packages :: sudo pkgin install git autoconf automake libtool gmake gawk openssl \ - pkg-config json-c python27 py27-test python35 + pkg-config json-c python27 py27-test python35 py-sphinx Install SSL Root Certificates (for git https access): diff --git a/doc/developer/Building_FRR_on_OmniOS.rst b/doc/developer/Building_FRR_on_OmniOS.rst index cd89f14e3c..0eb2b9fec8 100644 --- a/doc/developer/Building_FRR_on_OmniOS.rst +++ b/doc/developer/Building_FRR_on_OmniOS.rst @@ -62,6 +62,10 @@ Add pytest: pip install pytest +Install Sphinx::: + + pip install sphinx + Select Python 2.7 as default (required for pytest) :: diff --git a/doc/developer/Building_FRR_on_OpenBSD6.rst b/doc/developer/Building_FRR_on_OpenBSD6.rst index b9bc19c070..895048886e 100644 --- a/doc/developer/Building_FRR_on_OpenBSD6.rst +++ b/doc/developer/Building_FRR_on_OpenBSD6.rst @@ -15,7 +15,7 @@ Add packages: :: pkg_add git autoconf-2.69p2 automake-1.15p0 libtool bison - pkg_add gmake gawk dejagnu openssl json-c py-test + pkg_add gmake gawk dejagnu openssl json-c py-test py-sphinx Select Python2.7 as default (required for pytest) diff --git a/doc/developer/Building_FRR_on_Ubuntu1204.rst b/doc/developer/Building_FRR_on_Ubuntu1204.rst index 0ecfbe7365..68e476fec2 100644 --- a/doc/developer/Building_FRR_on_Ubuntu1204.rst +++ b/doc/developer/Building_FRR_on_Ubuntu1204.rst @@ -15,7 +15,7 @@ Add packages: apt-get install git autoconf automake libtool make gawk libreadline-dev \ texinfo libpam0g-dev dejagnu libjson0-dev pkg-config libpam0g-dev \ - libjson0-dev flex python-pip libc-ares-dev python3-dev + libjson0-dev flex python-pip libc-ares-dev python3-dev python3-sphinx Install newer bison from 14.04 package source (Ubuntu 12.04 package source is too old) diff --git a/doc/developer/Building_FRR_on_Ubuntu1404.rst b/doc/developer/Building_FRR_on_Ubuntu1404.rst index 6fc2f8d79a..10944cb8e1 100644 --- a/doc/developer/Building_FRR_on_Ubuntu1404.rst +++ b/doc/developer/Building_FRR_on_Ubuntu1404.rst @@ -15,7 +15,7 @@ Add packages: apt-get install git autoconf automake libtool make gawk libreadline-dev \ texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \ - python-pytest libc-ares-dev python3-dev + python-pytest libc-ares-dev python3-dev python3-sphinx Get FRR, compile it and install it (from Git) --------------------------------------------- diff --git a/doc/developer/Building_FRR_on_Ubuntu1604.rst b/doc/developer/Building_FRR_on_Ubuntu1604.rst index 3c6e1ee96f..9c296f8edf 100644 --- a/doc/developer/Building_FRR_on_Ubuntu1604.rst +++ b/doc/developer/Building_FRR_on_Ubuntu1604.rst @@ -15,7 +15,8 @@ Add packages: apt-get install git autoconf automake libtool make gawk libreadline-dev \ texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \ - python-pytest libc-ares-dev python3-dev libsystemd-dev python-ipaddr + python-pytest libc-ares-dev python3-dev libsystemd-dev python-ipaddr \ + python3-sphinx Get FRR, compile it and install it (from Git) --------------------------------------------- From 1a52a8c142d7317253313114c772c5e5117bcff6 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Feb 2018 12:36:56 -0500 Subject: [PATCH 062/148] debianpkg: add sphinx as build dep Signed-off-by: Quentin Young --- debianpkg/control | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/debianpkg/control b/debianpkg/control index 297a7cf106..471c7af3c8 100644 --- a/debianpkg/control +++ b/debianpkg/control @@ -4,7 +4,7 @@ Priority: optional Maintainer: Nobody Uploaders: Nobody XSBC-Original-Maintainer: -Build-Depends: debhelper (>= 7.0.50~), libncurses5-dev, libreadline-dev, texlive-latex-base, texlive-generic-recommended, libpam0g-dev | libpam-dev, libcap-dev, texinfo (>= 4.7), imagemagick, ghostscript, groff, autotools-dev, libpcre3-dev, gawk, chrpath, libsnmp-dev, git, dh-autoreconf, libjson-c-dev, libjson-c2 | libjson-c3, dh-systemd, libsystemd-dev, bison, flex, libc-ares-dev, pkg-config, python (>= 2.7), python-ipaddr +Build-Depends: debhelper (>= 7.0.50~), libncurses5-dev, libreadline-dev, texlive-latex-base, texlive-generic-recommended, libpam0g-dev | libpam-dev, libcap-dev, texinfo (>= 4.7), imagemagick, ghostscript, groff, autotools-dev, libpcre3-dev, gawk, chrpath, libsnmp-dev, git, dh-autoreconf, libjson-c-dev, libjson-c2 | libjson-c3, dh-systemd, libsystemd-dev, bison, flex, libc-ares-dev, pkg-config, python (>= 2.7), python-ipaddr, python-sphinx Standards-Version: 3.9.6 Homepage: http://www.frrouting.org/ From 12b7724ff82caf19beb9c20e570a43af8d343674 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Feb 2018 13:36:03 -0500 Subject: [PATCH 063/148] doc: fix toctree warning in manpages Forgot to add a couple includes to the exclude list. Also move defines.txt to defines.rst since I know how to properly ignore things now. Signed-off-by: Quentin Young --- doc/manpages/bgpd.rst | 2 +- doc/manpages/conf.py | 2 +- doc/manpages/{defines.txt => defines.rst} | 0 doc/manpages/eigrpd.rst | 2 +- doc/manpages/isisd.rst | 2 +- doc/manpages/ldpd.rst | 2 +- doc/manpages/nhrpd.rst | 2 +- doc/manpages/ospf6d.rst | 2 +- doc/manpages/ospfd.rst | 2 +- doc/manpages/pimd.rst | 2 +- doc/manpages/ripd.rst | 2 +- doc/manpages/ripngd.rst | 2 +- doc/manpages/vtysh.rst | 2 +- doc/manpages/watchfrr.rst | 2 +- doc/manpages/zebra.rst | 2 +- 15 files changed, 14 insertions(+), 14 deletions(-) rename doc/manpages/{defines.txt => defines.rst} (100%) diff --git a/doc/manpages/bgpd.rst b/doc/manpages/bgpd.rst index 73ca6b2351..94213db4d7 100644 --- a/doc/manpages/bgpd.rst +++ b/doc/manpages/bgpd.rst @@ -2,7 +2,7 @@ BGPD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: bgpd SYNOPSIS diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 6aa8588039..403e86e55e 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -125,7 +125,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', 'common-options.rst', 'epilogue.rst', 'defines.rst'] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/manpages/defines.txt b/doc/manpages/defines.rst similarity index 100% rename from doc/manpages/defines.txt rename to doc/manpages/defines.rst diff --git a/doc/manpages/eigrpd.rst b/doc/manpages/eigrpd.rst index ef269b1151..bc824468d0 100644 --- a/doc/manpages/eigrpd.rst +++ b/doc/manpages/eigrpd.rst @@ -2,7 +2,7 @@ EIGRPD ****** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: eigrpd SYNOPSIS diff --git a/doc/manpages/isisd.rst b/doc/manpages/isisd.rst index 6926d56051..68761f642c 100644 --- a/doc/manpages/isisd.rst +++ b/doc/manpages/isisd.rst @@ -2,7 +2,7 @@ ISISD ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: isisd SYNOPSIS diff --git a/doc/manpages/ldpd.rst b/doc/manpages/ldpd.rst index e01027d1f7..113f06673e 100644 --- a/doc/manpages/ldpd.rst +++ b/doc/manpages/ldpd.rst @@ -2,7 +2,7 @@ LDPD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ldpd SYNOPSIS diff --git a/doc/manpages/nhrpd.rst b/doc/manpages/nhrpd.rst index 8a2cb25611..cae01c677b 100644 --- a/doc/manpages/nhrpd.rst +++ b/doc/manpages/nhrpd.rst @@ -2,7 +2,7 @@ NHRPD ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: nhrpd SYNOPSIS diff --git a/doc/manpages/ospf6d.rst b/doc/manpages/ospf6d.rst index 2328d240ae..cfc6860d5c 100644 --- a/doc/manpages/ospf6d.rst +++ b/doc/manpages/ospf6d.rst @@ -2,7 +2,7 @@ OSPF6D ****** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ospf6d SYNOPSIS diff --git a/doc/manpages/ospfd.rst b/doc/manpages/ospfd.rst index 50ee503730..6e4d093f69 100644 --- a/doc/manpages/ospfd.rst +++ b/doc/manpages/ospfd.rst @@ -2,7 +2,7 @@ OSPFD ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ospfd SYNOPSIS diff --git a/doc/manpages/pimd.rst b/doc/manpages/pimd.rst index 98fd3a5c92..d7582668d2 100644 --- a/doc/manpages/pimd.rst +++ b/doc/manpages/pimd.rst @@ -2,7 +2,7 @@ PIMD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: pimd SYNOPSIS diff --git a/doc/manpages/ripd.rst b/doc/manpages/ripd.rst index 01b0223251..af4590c824 100644 --- a/doc/manpages/ripd.rst +++ b/doc/manpages/ripd.rst @@ -2,7 +2,7 @@ RIPD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ripd SYNOPSIS diff --git a/doc/manpages/ripngd.rst b/doc/manpages/ripngd.rst index 2a3e14ae6f..aedd689876 100644 --- a/doc/manpages/ripngd.rst +++ b/doc/manpages/ripngd.rst @@ -2,7 +2,7 @@ RIPNGD ****** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ripngd SYNOPSIS diff --git a/doc/manpages/vtysh.rst b/doc/manpages/vtysh.rst index 341d5eae44..38cb668e82 100644 --- a/doc/manpages/vtysh.rst +++ b/doc/manpages/vtysh.rst @@ -2,7 +2,7 @@ VTYSH ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: eigrpd SYNOPSIS diff --git a/doc/manpages/watchfrr.rst b/doc/manpages/watchfrr.rst index 5c18ac2e6a..f0b733298d 100644 --- a/doc/manpages/watchfrr.rst +++ b/doc/manpages/watchfrr.rst @@ -2,7 +2,7 @@ WATCHFRR ******** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: watchfrr SYNOPSIS diff --git a/doc/manpages/zebra.rst b/doc/manpages/zebra.rst index 9e5d4deb07..268b1d8645 100644 --- a/doc/manpages/zebra.rst +++ b/doc/manpages/zebra.rst @@ -2,7 +2,7 @@ ZEBRA ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: zebra SYNOPSIS From 4898758807b53f79576a2d83c8e22e3ae6d0f45d Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Feb 2018 16:18:52 -0500 Subject: [PATCH 064/148] doc: fix makefiles again Signed-off-by: Quentin Young --- doc/Makefile.am | 2 +- doc/manpages/Makefile | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index a1f619ade7..0a7ff6c03c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -81,7 +81,7 @@ developer.html: $(MAKE) -C developer html # include sources for shipped docs -EXTRA_DIST = manpages/defines.txt \ +EXTRA_DIST = manpages/defines.rst \ manpages/ldpd.rst \ manpages/index.rst \ manpages/bgpd.rst \ diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile index 562108a0bc..3f0c8f55ae 100644 --- a/doc/manpages/Makefile +++ b/doc/manpages/Makefile @@ -215,5 +215,4 @@ pseudoxml: @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." -install: ; -all: ; +%: ; From 6c749456224b383a95e717c95cdb6289eb9cb5e4 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Feb 2018 19:22:52 -0500 Subject: [PATCH 065/148] doc: use python 2.6 format strings Centos 6 only has python 2.6 which requires numerical identifiers for format strings Signed-off-by: Quentin Young --- doc/developer/conf.py | 4 ++-- doc/manpages/conf.py | 6 +++--- doc/user/conf.py | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/developer/conf.py b/doc/developer/conf.py index e4c56f54c3..1cb1d45af6 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -98,8 +98,8 @@ with open('../../config.status', 'r') as cfgstatus: # manually fill out some of these we can't get from config.status replace_vars['COPYRIGHT_STR'] = "Copyright (c)" -replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['COPYRIGHT_YEAR']) -replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['AUTHORS']) +replace_vars['COPYRIGHT_STR'] += ' {0}'.format(replace_vars['COPYRIGHT_YEAR']) +replace_vars['COPYRIGHT_STR'] += ' {0}'.format(replace_vars['AUTHORS']) release = replace_vars['PACKAGE_VERSION'] version = release.split('-')[0] diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 403e86e55e..6da6ebff0a 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -100,8 +100,8 @@ with open('../../config.status', 'r') as cfgstatus: # manually fill out some of these we can't get from config.status replace_vars['COPYRIGHT_STR'] = "Copyright (c)" -replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['COPYRIGHT_YEAR']) -replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['AUTHORS']) +replace_vars['COPYRIGHT_STR'] += ' {0}'.format(replace_vars['COPYRIGHT_YEAR']) +replace_vars['COPYRIGHT_STR'] += ' {0}'.format(replace_vars['AUTHORS']) release = replace_vars['PACKAGE_VERSION'] version = release.split('-')[0] @@ -306,7 +306,7 @@ latex_documents = [ # If true, show URL addresses after external links. #man_show_urls = False -fwfrr = "{} routing engine for use with FRRouting." +fwfrr = "{0} routing engine for use with FRRouting." man_pages = [ ('bgpd', 'bgpd', fwfrr.format("a BGPv4, BGPv4+, BGPv4- "), [], 8), diff --git a/doc/user/conf.py b/doc/user/conf.py index 6aa97de304..bd1bf6c041 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -98,8 +98,8 @@ with open('../../config.status', 'r') as cfgstatus: # manually fill out some of these we can't get from config.status replace_vars['COPYRIGHT_STR'] = "Copyright (c)" -replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['COPYRIGHT_YEAR']) -replace_vars['COPYRIGHT_STR'] += ' {}'.format(replace_vars['AUTHORS']) +replace_vars['COPYRIGHT_STR'] += ' {0}'.format(replace_vars['COPYRIGHT_YEAR']) +replace_vars['COPYRIGHT_STR'] += ' {0}'.format(replace_vars['AUTHORS']) release = replace_vars['PACKAGE_VERSION'] version = release.split('-')[0] From 2f8c365e02d044898c9286b907695d87f1fa0e1b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 8 Feb 2018 11:53:49 -0500 Subject: [PATCH 066/148] doc: change html theme, add svg logo Signed-off-by: Quentin Young --- doc/developer/conf.py | 10 ++++++---- doc/figures/frr-icon.svg | 39 +++++++++++++++++++++++++++++++++++++++ doc/user/conf.py | 10 ++++++---- 3 files changed, 51 insertions(+), 8 deletions(-) create mode 100644 doc/figures/frr-icon.svg diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 1cb1d45af6..7078910289 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -157,12 +157,14 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + 'sidebarbgcolor': '#374249' +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -176,7 +178,7 @@ html_theme = 'sphinx_rtd_theme' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = '../figures/frr-logo-medium.png' +html_logo = '../figures/frr-icon.svg' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -186,7 +188,7 @@ html_favicon = '../figures/frr-logo-icon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/doc/figures/frr-icon.svg b/doc/figures/frr-icon.svg new file mode 100644 index 0000000000..f7bdebc62e --- /dev/null +++ b/doc/figures/frr-icon.svg @@ -0,0 +1,39 @@ + +image/svg+xml \ No newline at end of file diff --git a/doc/user/conf.py b/doc/user/conf.py index bd1bf6c041..a9ea4ad90c 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -157,12 +157,14 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + 'sidebarbgcolor': '#374249' +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -176,7 +178,7 @@ html_theme = 'sphinx_rtd_theme' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = '../figures/frr-logo-medium.png' +html_logo = '../figures/frr-icon.svg' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -186,7 +188,7 @@ html_favicon = '../figures/frr-logo-icon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied From 241eff1636a361bea165d13b2b35450513d7059b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 12 Feb 2018 10:35:37 -0500 Subject: [PATCH 067/148] doc: include manpage Makefile and conf.py in EXTRA_DIST Signed-off-by: Quentin Young --- doc/Makefile.am | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index 0a7ff6c03c..fd326c4b01 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -99,4 +99,6 @@ EXTRA_DIST = manpages/defines.rst \ manpages/nhrpd.rst \ manpages/pimd.rst \ manpages/ripngd.rst \ - manpages/frr.rst + manpages/frr.rst \ + manpages/conf.py \ + manpages/Makefile From 79120ae8d6c1a8425ae0b41dcc38d17246225868 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 12 Feb 2018 13:34:41 -0500 Subject: [PATCH 068/148] doc: add everything to makefile Signed-off-by: Quentin Young --- doc/Makefile.am | 114 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 113 insertions(+), 1 deletion(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index fd326c4b01..8c73cb30ce 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -101,4 +101,116 @@ EXTRA_DIST = manpages/defines.rst \ manpages/ripngd.rst \ manpages/frr.rst \ manpages/conf.py \ - manpages/Makefile + manpages/Makefile \ + developer/Building_FRR_on_NetBSD7.rst \ + developer/ldpd-basic-test-setup.md \ + developer/cli.rst \ + developer/index.rst \ + developer/library.rst \ + developer/memtypes.rst \ + developer/bgpd.rst \ + developer/draft-zebra-00.ms \ + developer/dev-modules.md \ + developer/conf.py \ + developer/next-hop-tracking.rst \ + developer/Building_FRR_on_FreeBSD11.rst \ + developer/building.rst \ + developer/Building_FRR_on_CentOS6.rst \ + developer/Building_FRR_on_Ubuntu1604.rst \ + developer/ospf-api.rst \ + developer/ospf-sr.rst \ + developer/Building_FRR_on_OpenBSD6.rst \ + developer/Building_FRR_on_Debian8.rst \ + developer/Building_FRR_on_NetBSD6.rst \ + developer/Building_FRR_on_Debian9.rst \ + developer/Building_FRR_on_LEDE-OpenWRT.rst \ + developer/modules.rst \ + developer/Building_FRR_on_FreeBSD10.rst \ + developer/Building_FRR_on_Ubuntu1204.rst \ + developer/Building_FRR_on_Fedora24.rst \ + developer/Makefile \ + developer/Building_FRR_on_FreeBSD9.rst \ + developer/BGP-TypeCode \ + developer/Building_FRR_on_OmniOS.rst \ + developer/Building_FRR_on_CentOS7.rst \ + developer/hooks.rst \ + developer/OSPF-API.md \ + developer/workflow.rst \ + developer/Building_FRR_on_Ubuntu1404.rst \ + user/ospf_fundamentals.rst \ + user/routemap.rst \ + user/index.rst \ + user/conf.py \ + user/ipv6.rst \ + user/ripd.rst \ + user/vnc.rst \ + user/zebra.rst \ + user/installation.rst \ + user/overview.rst \ + user/protocol.rst \ + user/eigrpd.rst \ + user/rpki.rst \ + user/kernel.rst \ + user/isisd.rst \ + user/ospf6d.rst \ + user/Useful_Sysctl_Settings.md \ + user/basic.rst \ + user/ospfd.rst \ + user/vtysh.rst \ + user/filter.rst \ + user/nhrpd.rst \ + user/Makefile \ + user/routeserver.rst \ + user/appendix.rst \ + user/bgp.rst \ + user/babeld.rst \ + user/snmp.rst \ + user/pim.rst \ + user/ripngd.rst \ + user/snmptrap.rst \ + user/glossary.rst \ + mpls/ChangeLog.opaque.txt \ + mpls/ospfd.conf \ + mpls/cli_summary.txt \ + mpls/opaque_lsa.txt \ + figures/frr-logo.png \ + figures/fig-vnc-commercial-route-reflector.dia \ + figures/ospf_api_msghdr.png \ + figures/fig-normal-processing.txt \ + figures/fig-vnc-gw-rr.txt \ + figures/fig-vnc-mesh.dia \ + figures/frr-logo-medium.png \ + figures/git_branches.svg \ + figures/fig-vnc-commercial-route-reflector.txt \ + figures/fig_topologies_rs.txt \ + figures/git_branches.png \ + figures/fig-vnc-mesh.txt \ + figures/ospf_api_msgs1.png \ + figures/fig-vnc-redundant-route-reflectors.txt \ + figures/fig-vnc-commercial-route-reflector.png \ + figures/fig-vnc-gw.png \ + figures/fig_topologies_rs.png \ + figures/fig_topologies_full.txt \ + figures/fig-vnc-frr-route-reflector.txt \ + figures/fig-normal-processing.dia \ + figures/fig-vnc-redundant-route-reflectors.png \ + figures/fig-vnc-frr-route-reflector.dia \ + figures/fig_topologies_full.png \ + figures/fig-vnc-redundant-route-reflectors.dia \ + figures/fig-normal-processing.png \ + figures/fig-rs-processing.dia \ + figures/ospf_api_msgs2.png \ + figures/fig-vnc-gw.dia \ + figures/fig-rs-processing.txt \ + figures/frr-logo-icon.png \ + figures/ospf_api_architecture.png \ + figures/fig-vnc-gw.txt \ + figures/fig-rs-processing.png \ + figures/frr-icon.svg \ + figures/fig_topologies_rs.dia \ + figures/fig-vnc-frr-route-reflector.png \ + figures/fig-vnc-gw-rr.png \ + figures/fig-vnc-gw-rr.dia \ + figures/fig_topologies_full.dia \ + figures/frr-logo-small.png \ + figures/fig-vnc-mesh.png From e53d58537c6a42a4c80ba9561d6c081b25a182cd Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 13 Feb 2018 18:09:58 -0500 Subject: [PATCH 069/148] doc: document CLI BNF grammar, add DFA figures Technical details on CLI implementation. Signed-off-by: Quentin Young --- doc/developer/cli.rst | 155 +++++++++++++++++----------- doc/figures/cligraph.svg | 211 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 308 insertions(+), 58 deletions(-) create mode 100644 doc/figures/cligraph.svg diff --git a/doc/developer/cli.rst b/doc/developer/cli.rst index 2ecb70e932..cff3d21ef7 100644 --- a/doc/developer/cli.rst +++ b/doc/developer/cli.rst @@ -66,10 +66,58 @@ parser is implemented in Bison and the lexer in Flex. These may be found in to look. Bison is very stable and if it detects a syntax error, 99% of the time it will be a syntax error in your definition. +The formal grammar in BNF is given below. This is the grammar implemented in +the Bison parser. At runtime, the Bison parser reads all of the CLI strings and +builds a combined directed graph that is used to match and interpret user +input. + +Human-friendly explanations of how to use this grammar are given a bit later in +this section alongside information on the :ref:`cli-data-structures` constructed +by the parser. + +.. productionlist:: + command: `cmd_token_seq` + : `cmd_token_seq` `placeholder_token` "..." + cmd_token_seq: *empty* + : `cmd_token_seq` `cmd_token` + cmd_token: `simple_token` + : `selector` + simple_token: `literal_token` + : `placeholder_token` + literal_token: WORD `varname_token` + varname_token: "$" WORD + placeholder_token: `placeholder_token_real` `varname_token` + placeholder_token_real: IPV4 + : IPV4_PREFIX + : IPV6 + : IPV6_PREFIX + : VARIABLE + : RANGE + : MAC + : MAC_PREFIX + selector: "<" `selector_seq_seq` ">" `varname_token` + : "{" `selector_seq_seq` "}" `varname_token` + : "[" `selector_seq_seq` "]" `varname_token` + selector_seq_seq: `selector_seq_seq` "|" `selector_token_seq` + : `selector_token_seq` + selector_token_seq: `selector_token_seq` `selector_token` + : `selector_token` + selector_token: `selector` + : `simple_token` + Tokens ~~~~~~ +The various capitalized tokens in the BNF above are in fact themselves +placeholders, but not defined as such in the formal grammar; the grammar +provides the structure, and the tokens are actually more like a type system for +the strings you write in your CLI definitions. A CLI definition string is +broken apart and each piece is assigned a type by the lexer based on a set of +regular expressions. The parser uses the type information to verify the string +and determine the structure of the CLI graph; additional metadata (such as the +raw text of each token) is encoded into the graph as it is constructed by the +parser, but this is merely a dumb copy job. -Each element in a command definition is assigned a type by the parser based on a set of regular expression rules. +Here is a brief summary of the various token types along with examples. +-----------------+-----------------+-------------------------------------------------------------+ | Token type | Syntax | Description | @@ -382,6 +430,8 @@ In the examples below, each arrowed token needs a doc string. "command [example]" ^ ^ ^ ^ +.. _cli-data-structures: + Data Structures --------------- @@ -401,76 +451,65 @@ self-contained 'subgraphs'. Each subgraph is a tree except that all of the 'leaves' actually share a child node. This helps with minimizing graph size and debugging. -As an example, the subgraph generated by looks like this: +As a working example, here is the graph of the following command: :: -:: + show [ip] bgp neighbors [] [json] - . - . - | - +----+---+ - +--- -+ FORK +----+ - | +--------+ | - +--v---+ +--v---+ - | foo | | bar | - +--+---+ +--+---+ - | +------+ | - +------> JOIN <-----+ - +---+--+ - | - . - . +.. figure:: ../figures/cligraph.svg + :align: center -FORK and JOIN nodes are plumbing nodes that don't correspond to user + Graph of example CLI command + + +``FORK`` and ``JOIN`` nodes are plumbing nodes that don't correspond to user input. They're necessary in order to deduplicate these constructs where applicable. -Options follow the same form, except that there is an edge from the FORK -node to the JOIN node. +Options follow the same form, except that there is an edge from the ``FORK`` +node to the ``JOIN`` node. Since all of the subgraphs in the example command +are optional, all of them have this edge. -Keywords follow the same form, except that there is an edge from JOIN to -FORK. Because of this the CLI graph cannot be called acyclic. There is -special logic in the input matching code that keeps a stack of paths -already taken through the node in order to disallow following the same -path more than once. +Keywords follow the same form, except that there is an edge from ``JOIN`` to +``FORK``. Because of this the CLI graph cannot be called acyclic. There is +special logic in the input matching code that keeps a stack of paths already +taken through the node in order to disallow following the same path more than +once. -Variadics are a bit special; they have an edge back to themselves, which -allows repeating the same input indefinitely. +Variadics are a bit special; they have an edge back to themselves, which allows +repeating the same input indefinitely. -The leaves of the graph are nodes that have no out edges. These nodes -are special; their data section does not contain a token, as most nodes -do, or NULL, as in FORK/JOIN nodes, but instead has a pointer to a +The leaves of the graph are nodes that have no out edges. These nodes are +special; their data section does not contain a token, as most nodes do, or +NULL, as in ``FORK``/``JOIN`` nodes, but instead has a pointer to a cmd\_element. All paths through the graph that terminate on a leaf are guaranteed to be defined by that command. When a user enters a complete -command, the command matcher tokenizes the input and executes a DFS on -the CLI graph. If it is simultaneously able to exhaust all input (one -input token per graph node), and then find exactly one leaf connected to -the last node it reaches, then the input has matched the corresponding -command and the command is executed. If it finds more than one node, -then the command is ambiguous (more on this in deduplication). If it -cannot exhaust all input, the command is unknown. If it exhausts all -input but does not find an edge node, the command is incomplete. +command, the command matcher tokenizes the input and executes a DFS on the CLI +graph. If it is simultaneously able to exhaust all input (one input token per +graph node), and then find exactly one leaf connected to the last node it +reaches, then the input has matched the corresponding command and the command +is executed. If it finds more than one node, then the command is ambiguous +(more on this in deduplication). If it cannot exhaust all input, the command is +unknown. If it exhausts all input but does not find an edge node, the command +is incomplete. -The parser uses an incremental strategy to build the CLI graph for a -node. Each command is parsed into its own graph, and then this graph is -merged into the overall graph. During this merge step, the parser makes -a best-effort attempt to remove duplicate nodes. If it finds a node in -the overall graph that is equal to a node in the corresponding position -in the command graph, it will intelligently merge the properties from -the node in the command graph into the already-existing node. Subgraphs -are also checked for isomorphism and merged where possible. The -definition of whether two nodes are 'equal' is based on the equality of -some set of token properties; read the parser source for the most +The parser uses an incremental strategy to build the CLI graph for a node. Each +command is parsed into its own graph, and then this graph is merged into the +overall graph. During this merge step, the parser makes a best-effort attempt +to remove duplicate nodes. If it finds a node in the overall graph that is +equal to a node in the corresponding position in the command graph, it will +intelligently merge the properties from the node in the command graph into the +already-existing node. Subgraphs are also checked for isomorphism and merged +where possible. The definition of whether two nodes are 'equal' is based on the +equality of some set of token properties; read the parser source for the most up-to-date definition of equality. -When the parser is unable to deduplicate some complicated constructs, -this can result in two identical paths through separate parts of the -graph. If this occurs and the user enters input that matches these -paths, they will receive an 'ambiguous command' error and will be unable -to execute the command. Most of the time the parser can detect and warn -about duplicate commands, but it will not always be able to do this. -Hence care should be taken before defining a new command to ensure it is -not defined elsewhere. +When the parser is unable to deduplicate some complicated constructs, this can +result in two identical paths through separate parts of the graph. If this +occurs and the user enters input that matches these paths, they will receive an +'ambiguous command' error and will be unable to execute the command. Most of +the time the parser can detect and warn about duplicate commands, but it will +not always be able to do this. Hence care should be taken before defining a +new command to ensure it is not defined elsewhere. Command handlers ---------------- @@ -481,7 +520,7 @@ this: :: - int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]); + int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]); The first argument is the command definition struct. The last argument is an ordered array of tokens that correspond to the path taken through diff --git a/doc/figures/cligraph.svg b/doc/figures/cligraph.svg new file mode 100644 index 0000000000..a1dd01702b --- /dev/null +++ b/doc/figures/cligraph.svg @@ -0,0 +1,211 @@ + + + + + + +%3 + + +n0xd46960 + +START_TKN + + +n0xd46be0 + +WORD_TKN +" +show +" + + +n0xd46960->n0xd46be0 + + + + +n0xd47f80 + +FORK_TKN + + +n0xd46be0->n0xd47f80 + + + + +n0xd47c70 + +WORD_TKN +" +ip +" + + +n0xd47f80->n0xd47c70 + + + + +n0xd484c0 + +JOIN_TKN + + +n0xd47f80->n0xd484c0 + + + + +n0xd47c70->n0xd484c0 + + + + +n0xd47ca0 + +WORD_TKN +" +bgp +" + + +n0xd484c0->n0xd47ca0 + + + + +n0xd48540 + +WORD_TKN +" +neighbors +" + + +n0xd47ca0->n0xd48540 + + + + +n0xd490c0 + +FORK_TKN + + +n0xd48540->n0xd490c0 + + + + +n0xd48fc0 + +IPV4_TKN +A.B.C.D + + +n0xd490c0->n0xd48fc0 + + + + +n0xd491e0 + +JOIN_TKN + + +n0xd490c0->n0xd491e0 + + + + +n0xd49340 + +IPV6_TKN +X:X::X:X + + +n0xd490c0->n0xd49340 + + + + +n0xd49480 + +VARIABLE_TKN +WORD + + +n0xd490c0->n0xd49480 + + + + +n0xd48fc0->n0xd491e0 + + + + +n0xd496e0 + +FORK_TKN + + +n0xd491e0->n0xd496e0 + + + + +n0xd495e0 + +WORD_TKN +" +json +" + + +n0xd496e0->n0xd495e0 + + + + +n0xd497c0 + +JOIN_TKN + + +n0xd496e0->n0xd497c0 + + + + +n0xd495e0->n0xd497c0 + + + + +end0xd49900 + +end + + +n0xd497c0->end0xd49900 + + + + +n0xd49340->n0xd491e0 + + + + +n0xd49480->n0xd491e0 + + + + + From 3f5050125bcd4f973fcd20315d78ab676fd18bea Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 15 Feb 2018 10:43:30 -0500 Subject: [PATCH 070/148] doc: put correct pkg for Centos6 --- doc/developer/Building_FRR_on_CentOS6.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst index 7ca14331f0..c138eb11a3 100644 --- a/doc/developer/Building_FRR_on_CentOS6.rst +++ b/doc/developer/Building_FRR_on_CentOS6.rst @@ -31,7 +31,7 @@ Add packages: sudo yum install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel flex epel-release perl-XML-LibXML \ - c-ares-devel python-sphinx + c-ares-devel python-sphinx10 Install newer version of bison (CentOS 6 package source is too old) from CentOS 7 From 72a475e87c669c54ef8cd831f509229486f2a018 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 16 Feb 2018 11:21:14 -0500 Subject: [PATCH 071/148] debianpkg: update packaging for new docs Incidentally this was all broken before anyway. * Correctly ship all documents in frr-doc * Ship manpages for all daemons in frr * Update rules to build docs via Sphinx * Use packaging install files correctly --- debianpkg/backports/ubuntu12.04/debian/rules | 11 ++------- .../backports/ubuntu14.04/debian/frr.install | 11 --------- debianpkg/backports/ubuntu14.04/debian/rules | 9 +++----- debianpkg/control | 2 +- debianpkg/frr-doc.docs | 6 ++--- debianpkg/frr-doc.info | 2 +- debianpkg/frr-doc.install | 3 +-- debianpkg/frr.install | 14 +---------- debianpkg/frr.manpages | 23 +++++++++++-------- debianpkg/rules | 12 +++------- doc/Makefile.am | 11 +++++---- 11 files changed, 35 insertions(+), 69 deletions(-) diff --git a/debianpkg/backports/ubuntu12.04/debian/rules b/debianpkg/backports/ubuntu12.04/debian/rules index 2e9e84faa6..6449743b9d 100755 --- a/debianpkg/backports/ubuntu12.04/debian/rules +++ b/debianpkg/backports/ubuntu12.04/debian/rules @@ -135,18 +135,11 @@ override_dh_auto_configure: fi override_dh_auto_build: - #dh_auto_build - $(MAKE) - dh_auto_build -- -C doc draft-zebra-00.txt - - - # doc/ is a bit crazy ifeq ($(GENERATE_PDF), 1) - dh_auto_build -- -C doc frr.pdf || true # pdfetex fails with exit code 1 but still produces a good looking .pdf + dh_auto_build -- -C doc user.pdf endif - rm -vf doc/frr.info + rm -vf doc/user/_build/texinfo/FRR.info dh_auto_build -- -C doc frr.info - rm -vf doc/frr.info.html* override_dh_auto_test: diff --git a/debianpkg/backports/ubuntu14.04/debian/frr.install b/debianpkg/backports/ubuntu14.04/debian/frr.install index adce915e1f..170932084c 100644 --- a/debianpkg/backports/ubuntu14.04/debian/frr.install +++ b/debianpkg/backports/ubuntu14.04/debian/frr.install @@ -4,17 +4,6 @@ usr/include/frr/ usr/lib/ tools/frr etc/init.d/ usr/share/doc/frr/ -usr/share/man/man1/vtysh.1 -usr/share/man/man1/frr.1 -usr/share/man/man8 -usr/share/man/man8/bgpd.8 -usr/share/man/man8/ospf6d.8 -usr/share/man/man8/ospfd.8 -usr/share/man/man8/ripd.8 -usr/share/man/man8/ripngd.8 -usr/share/man/man8/zebra.8 -usr/share/man/man8/isisd.8 -usr/share/man/man8/watchfrr.8 usr/share/snmp/mibs/ tools/etc/* etc/ tools/*.service lib/systemd/system diff --git a/debianpkg/backports/ubuntu14.04/debian/rules b/debianpkg/backports/ubuntu14.04/debian/rules index 4f82d772c9..ce7f793ae2 100755 --- a/debianpkg/backports/ubuntu14.04/debian/rules +++ b/debianpkg/backports/ubuntu14.04/debian/rules @@ -137,16 +137,13 @@ override_dh_auto_configure: override_dh_auto_build: #dh_auto_build $(MAKE) - dh_auto_build -- -C doc draft-zebra-00.txt - # doc/ is a bit crazy ifeq ($(GENERATE_PDF), 1) - dh_auto_build -- -C doc frr.pdf || true # pdfetex fails with exit code 1 but still produces a good looking .pdf + dh_auto_build -- -C doc user.pdf endif - rm -vf doc/frr.info - dh_auto_build -- -C doc frr.info - rm -vf doc/frr.info.html* + rm -vf doc/_build/texinfo/FRR.info + dh_auto_build -- -C doc user.info override_dh_auto_test: diff --git a/debianpkg/control b/debianpkg/control index 471c7af3c8..bbd4c43b42 100644 --- a/debianpkg/control +++ b/debianpkg/control @@ -4,7 +4,7 @@ Priority: optional Maintainer: Nobody Uploaders: Nobody XSBC-Original-Maintainer: -Build-Depends: debhelper (>= 7.0.50~), libncurses5-dev, libreadline-dev, texlive-latex-base, texlive-generic-recommended, libpam0g-dev | libpam-dev, libcap-dev, texinfo (>= 4.7), imagemagick, ghostscript, groff, autotools-dev, libpcre3-dev, gawk, chrpath, libsnmp-dev, git, dh-autoreconf, libjson-c-dev, libjson-c2 | libjson-c3, dh-systemd, libsystemd-dev, bison, flex, libc-ares-dev, pkg-config, python (>= 2.7), python-ipaddr, python-sphinx +Build-Depends: debhelper (>= 7.0.50~), libncurses5-dev, libreadline-dev, texlive-latex-base, texlive-generic-recommended, libpam0g-dev | libpam-dev, libcap-dev, texinfo (>= 4.7), autotools-dev, libpcre3-dev, gawk, chrpath, libsnmp-dev, git, dh-autoreconf, libjson-c-dev, libjson-c2 | libjson-c3, dh-systemd, libsystemd-dev, bison, flex, libc-ares-dev, pkg-config, python (>= 2.7), python-ipaddr, python-sphinx Standards-Version: 3.9.6 Homepage: http://www.frrouting.org/ diff --git a/debianpkg/frr-doc.docs b/debianpkg/frr-doc.docs index a0776fd68a..4720a3b920 100644 --- a/debianpkg/frr-doc.docs +++ b/debianpkg/frr-doc.docs @@ -2,7 +2,5 @@ AUTHORS NEWS README REPORTING-BUGS -doc/BGP-TypeCode -doc/draft-zebra-00.txt -doc/mpls/ -bgpd/BGP4-MIB.txt +doc/user/*.rst +doc/figures/*.png diff --git a/debianpkg/frr-doc.info b/debianpkg/frr-doc.info index c4f181cdb0..5fadb0024d 100644 --- a/debianpkg/frr-doc.info +++ b/debianpkg/frr-doc.info @@ -1 +1 @@ -doc/frr.info* +doc/user/_build/texinfo/FRR.info diff --git a/debianpkg/frr-doc.install b/debianpkg/frr-doc.install index e5910fec8f..8854b2c547 100644 --- a/debianpkg/frr-doc.install +++ b/debianpkg/frr-doc.install @@ -1,2 +1 @@ -usr/share/info -doc/*.png usr/share/info +doc/user/_build/texinfo/*.png usr/share/info diff --git a/debianpkg/frr.install b/debianpkg/frr.install index 2d86009dba..35dfe43776 100644 --- a/debianpkg/frr.install +++ b/debianpkg/frr.install @@ -4,19 +4,7 @@ usr/include/frr/ usr/lib/ tools/frr usr/lib/frr usr/share/doc/frr/ -usr/share/man/man1/vtysh.1 -usr/share/man/man1/frr.1 -usr/share/man/man8 -usr/share/man/man8/bgpd.8 -usr/share/man/man8/ospf6d.8 -usr/share/man/man8/ospfd.8 -usr/share/man/man8/ripd.8 -usr/share/man/man8/ripngd.8 -usr/share/man/man8/zebra.8 -usr/share/man/man8/isisd.8 -usr/share/man/man8/watchfrr.8 -usr/share/man/man8/frr-args.8 usr/share/snmp/mibs/ tools/etc/* etc/ -tools/*.service lib/systemd/system +tools/*.service lib/systemd/system debian/frr.conf usr/lib/tmpfiles.d diff --git a/debianpkg/frr.manpages b/debianpkg/frr.manpages index 17a128b7e3..51f82d0889 100644 --- a/debianpkg/frr.manpages +++ b/debianpkg/frr.manpages @@ -1,9 +1,14 @@ -doc/bgpd.8 -doc/ospf6d.8 -doc/ospfd.8 -doc/ripd.8 -doc/ripngd.8 -doc/vtysh.1 -doc/zebra.8 -doc/isisd.8 -doc/watchfrr.8 +doc/manpages/_build/man/frr.1 +doc/manpages/_build/man/bgpd.8 +doc/manpages/_build/man/pimd.8 +doc/manpages/_build/man/eigrpd.8 +doc/manpages/_build/man/ldpd.8 +doc/manpages/_build/man/nhrpd.8 +doc/manpages/_build/man/ospf6d.8 +doc/manpages/_build/man/ospfd.8 +doc/manpages/_build/man/ripd.8 +doc/manpages/_build/man/ripngd.8 +doc/manpages/_build/man/vtysh.1 +doc/manpages/_build/man/zebra.8 +doc/manpages/_build/man/isisd.8 +doc/manpages/_build/man/watchfrr.8 diff --git a/debianpkg/rules b/debianpkg/rules index 574f448dff..1d98e2099b 100755 --- a/debianpkg/rules +++ b/debianpkg/rules @@ -136,18 +136,12 @@ override_dh_auto_configure: fi override_dh_auto_build: - #dh_auto_build - $(MAKE) - dh_auto_build -- -C doc draft-zebra-00.txt - - # doc/ is a bit crazy ifeq ($(GENERATE_PDF), 1) - dh_auto_build -- -C doc frr.pdf || true # pdfetex fails with exit code 1 but still produces a good looking .pdf + dh_auto_build -- -C doc user.pdf endif - rm -vf doc/frr.info - dh_auto_build -- -C doc frr.info - rm -vf doc/frr.info.html* + rm -vf doc/user/_build/texinfo/FRR.info + dh_auto_build -- -C doc FRR.info override_dh_auto_test: diff --git a/doc/Makefile.am b/doc/Makefile.am index 8c73cb30ce..bad20f04a2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -68,15 +68,18 @@ endif # handled by subdir target man: ; -FRR.pdf: +FRR.info: + $(MAKE) -C user info + +user.pdf: $(MAKE) -C user latexpdf +user.html: + $(MAKE) -C user html + developer.pdf: $(MAKE) -C developer latexpdf -FRR.html: - $(MAKE) -C user html - developer.html: $(MAKE) -C developer html From 9cb4ba0a3eafaa414d5d7cc297d5411dbfe74a69 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 20 Feb 2018 09:15:01 -0500 Subject: [PATCH 072/148] debianpkg: fixup bad target names Signed-off-by: Quentin Young --- debianpkg/backports/ubuntu12.04/debian/rules | 2 +- debianpkg/backports/ubuntu14.04/debian/rules | 4 ++-- doc/Makefile.am | 8 +++++++- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/debianpkg/backports/ubuntu12.04/debian/rules b/debianpkg/backports/ubuntu12.04/debian/rules index 6449743b9d..fb951965af 100755 --- a/debianpkg/backports/ubuntu12.04/debian/rules +++ b/debianpkg/backports/ubuntu12.04/debian/rules @@ -138,7 +138,7 @@ override_dh_auto_build: ifeq ($(GENERATE_PDF), 1) dh_auto_build -- -C doc user.pdf endif - rm -vf doc/user/_build/texinfo/FRR.info + rm -vf doc/user/_build/texinfo/frr.info dh_auto_build -- -C doc frr.info override_dh_auto_test: diff --git a/debianpkg/backports/ubuntu14.04/debian/rules b/debianpkg/backports/ubuntu14.04/debian/rules index ce7f793ae2..bb5715b78d 100755 --- a/debianpkg/backports/ubuntu14.04/debian/rules +++ b/debianpkg/backports/ubuntu14.04/debian/rules @@ -142,8 +142,8 @@ override_dh_auto_build: ifeq ($(GENERATE_PDF), 1) dh_auto_build -- -C doc user.pdf endif - rm -vf doc/_build/texinfo/FRR.info - dh_auto_build -- -C doc user.info + rm -vf doc/_build/texinfo/frr.info + dh_auto_build -- -C doc frr.info override_dh_auto_test: diff --git a/doc/Makefile.am b/doc/Makefile.am index bad20f04a2..943fba91e2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -68,7 +68,8 @@ endif # handled by subdir target man: ; -FRR.info: +# explicit targets +frr.info: $(MAKE) -C user info user.pdf: @@ -83,6 +84,11 @@ developer.pdf: developer.html: $(MAKE) -C developer html +# info target, handled by automake installation +install-data-local: frr.info + gzip < user/_build/texinfo/FRR.info > ${infodir}/FRR.info.gz + install-info user/_build/texinfo/FRR.info ${infodir}/dir + # include sources for shipped docs EXTRA_DIST = manpages/defines.rst \ manpages/ldpd.rst \ From adaf2d624b2c7552acd3d0683cb4d1393f5dcae4 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 20 Feb 2018 12:29:30 -0500 Subject: [PATCH 073/148] doc: fallback to sphinx-1.0-build Some platforms (actually just Centos6, again, of course) call "sphinx-build" as "sphinx-1.0-build", and so to work around this apparently useless name, fall back to sphinx-1.0-build when we can't find sphinx-build before displaying an error message. I am not doing in this the configure script because the sphinx makefiles are not Automake files and the less Automake in tree the better. Signed-off-by: Quentin Young --- doc/developer/Makefile | 3 +++ doc/user/Makefile | 3 +++ 2 files changed, 6 insertions(+) diff --git a/doc/developer/Makefile b/doc/developer/Makefile index 056b78e68e..e04e17d380 100644 --- a/doc/developer/Makefile +++ b/doc/developer/Makefile @@ -9,6 +9,9 @@ BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +SPHINXBUILD = sphinx-1.0-build +endif +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif diff --git a/doc/user/Makefile b/doc/user/Makefile index 056b78e68e..e04e17d380 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -9,6 +9,9 @@ BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +SPHINXBUILD = sphinx-1.0-build +endif +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif From 6165030aa827c89e508ae7fcb30cee9988babbc9 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 22 Feb 2018 12:10:47 -0500 Subject: [PATCH 074/148] doc: fix hardcoded 'make' invocation BSD systems need gmake to build FRR, hence why we use $(MAKE) instead of directly invoking make. It looks like Sphinx generated makefiles understand this, but contain a bug where the target for info files hardcodes make instead of using $(MAKE). Fix this. Signed-off-by: Quentin Young --- doc/developer/Makefile | 2 +- doc/user/Makefile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/developer/Makefile b/doc/developer/Makefile index e04e17d380..329e455de6 100644 --- a/doc/developer/Makefile +++ b/doc/developer/Makefile @@ -172,7 +172,7 @@ texinfo: info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info + $(MAKE) -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." .PHONY: gettext diff --git a/doc/user/Makefile b/doc/user/Makefile index e04e17d380..329e455de6 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -172,7 +172,7 @@ texinfo: info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info + $(MAKE) -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." .PHONY: gettext From b59555c6bf74592c9959a85033e6c56bdac15eae Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 22 Feb 2018 12:27:12 -0500 Subject: [PATCH 075/148] doc: change info file name from FRR -> frr conventions yo Signed-off-by: Quentin Young --- debianpkg/frr-doc.info | 2 +- debianpkg/rules | 4 ++-- doc/Makefile.am | 4 ++-- doc/developer/conf.py | 2 +- doc/user/conf.py | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/debianpkg/frr-doc.info b/debianpkg/frr-doc.info index 5fadb0024d..a83255a24f 100644 --- a/debianpkg/frr-doc.info +++ b/debianpkg/frr-doc.info @@ -1 +1 @@ -doc/user/_build/texinfo/FRR.info +doc/user/_build/texinfo/frr.info diff --git a/debianpkg/rules b/debianpkg/rules index 1d98e2099b..14294f54fe 100755 --- a/debianpkg/rules +++ b/debianpkg/rules @@ -140,8 +140,8 @@ override_dh_auto_build: ifeq ($(GENERATE_PDF), 1) dh_auto_build -- -C doc user.pdf endif - rm -vf doc/user/_build/texinfo/FRR.info - dh_auto_build -- -C doc FRR.info + rm -vf doc/user/_build/texinfo/frr.info + dh_auto_build -- -C doc frr.info override_dh_auto_test: diff --git a/doc/Makefile.am b/doc/Makefile.am index 943fba91e2..b822a3c685 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -86,8 +86,8 @@ developer.html: # info target, handled by automake installation install-data-local: frr.info - gzip < user/_build/texinfo/FRR.info > ${infodir}/FRR.info.gz - install-info user/_build/texinfo/FRR.info ${infodir}/dir + gzip < user/_build/texinfo/frr.info > ${infodir}/frr.info.gz + install-info user/_build/texinfo/frr.info ${infodir}/dir # include sources for shipped docs EXTRA_DIST = manpages/defines.rst \ diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 7078910289..3f531c14b0 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -317,7 +317,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FRR', u"FRR Developer's Manual", + (master_doc, 'frr', u"FRR Developer's Manual", author, 'FRR', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/user/conf.py b/doc/user/conf.py index a9ea4ad90c..817a6d83bb 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -317,7 +317,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'FRR', u'FRR User Manual', + (master_doc, 'frr', u'FRR User Manual', author, 'FRR', 'One line description of project.', 'Miscellaneous'), ] From fdf19f06f2fd96513d5da7b835155bd607cf999a Mon Sep 17 00:00:00 2001 From: Mitesh Kanjariya Date: Tue, 20 Feb 2018 00:23:06 -0800 Subject: [PATCH 076/148] bgpd: allow advertise-subnet cmd without enabling advertise ipv4 unicast Type-5 routes can be useful in multiple scenarios such as advertise-subnet, default-originate etc. Currently, the code has a restriction that to allow advertising type-5 routes, user has to first enable advertise ipvX command. This restriction is not necessary and should be removed. Signed-off-by: Mitesh Kanjariya --- bgpd/bgp_evpn.c | 28 ++++++++-------------------- bgpd/bgp_evpn.h | 17 +++++++++++++++++ bgpd/bgp_evpn_private.h | 17 ----------------- bgpd/bgp_evpn_vty.c | 12 ++---------- bgpd/bgp_route.c | 4 ++-- 5 files changed, 29 insertions(+), 49 deletions(-) diff --git a/bgpd/bgp_evpn.c b/bgpd/bgp_evpn.c index ec8e2907a6..6a3496a4d0 100644 --- a/bgpd/bgp_evpn.c +++ b/bgpd/bgp_evpn.c @@ -2553,10 +2553,12 @@ static int install_uninstall_evpn_route(struct bgp *bgp, afi_t afi, safi_t safi, static void delete_withdraw_vrf_routes(struct bgp *bgp_vrf) { /* delete all ipv4 routes and withdraw from peers */ - bgp_evpn_withdraw_type5_routes(bgp_vrf, AFI_IP, SAFI_UNICAST); + if (advertise_type5_routes(bgp_vrf, AFI_IP)) + bgp_evpn_withdraw_type5_routes(bgp_vrf, AFI_IP, SAFI_UNICAST); /* delete all ipv6 routes and withdraw from peers */ - bgp_evpn_withdraw_type5_routes(bgp_vrf, AFI_IP6, SAFI_UNICAST); + if (advertise_type5_routes(bgp_vrf, AFI_IP6)) + bgp_evpn_withdraw_type5_routes(bgp_vrf, AFI_IP6, SAFI_UNICAST); } /* update and advertise all ipv4 and ipv6 routes in thr vrf table as type-5 @@ -2564,10 +2566,12 @@ static void delete_withdraw_vrf_routes(struct bgp *bgp_vrf) static void update_advertise_vrf_routes(struct bgp *bgp_vrf) { /* update all ipv4 routes */ - bgp_evpn_advertise_type5_routes(bgp_vrf, AFI_IP, SAFI_UNICAST); + if (advertise_type5_routes(bgp_vrf, AFI_IP)) + bgp_evpn_advertise_type5_routes(bgp_vrf, AFI_IP, SAFI_UNICAST); /* update all ipv6 routes */ - bgp_evpn_advertise_type5_routes(bgp_vrf, AFI_IP6, SAFI_UNICAST); + if (advertise_type5_routes(bgp_vrf, AFI_IP6)) + bgp_evpn_advertise_type5_routes(bgp_vrf, AFI_IP6, SAFI_UNICAST); } /* @@ -3189,10 +3193,6 @@ void bgp_evpn_withdraw_type5_route(struct bgp *bgp_vrf, struct prefix *p, struct prefix_evpn evp; char buf[PREFIX_STRLEN]; - /* NOTE: Check needed as this is called per-route also. */ - if (!advertise_type5_routes(bgp_vrf, afi)) - return; - build_type5_prefix_from_ip_prefix(&evp, p); ret = delete_evpn_type5_route(bgp_vrf, &evp); if (ret) { @@ -3211,10 +3211,6 @@ void bgp_evpn_withdraw_type5_routes(struct bgp *bgp_vrf, struct bgp_table *table = NULL; struct bgp_node *rn = NULL; - /* Bail out early if we don't have to advertise type-5 routes. */ - if (!advertise_type5_routes(bgp_vrf, afi)) - return; - table = bgp_vrf->rib[afi][safi]; for (rn = bgp_table_top(table); rn; rn = bgp_route_next(rn)) bgp_evpn_withdraw_type5_route(bgp_vrf, &rn->p, afi, safi); @@ -3235,10 +3231,6 @@ void bgp_evpn_advertise_type5_route(struct bgp *bgp_vrf, struct prefix *p, struct prefix_evpn evp; char buf[PREFIX_STRLEN]; - /* NOTE: Check needed as this is called per-route also. */ - if (!advertise_type5_routes(bgp_vrf, afi)) - return; - /* only advertise subnet routes as type-5 */ if (is_host_route(p)) return; @@ -3263,10 +3255,6 @@ void bgp_evpn_advertise_type5_routes(struct bgp *bgp_vrf, struct bgp_node *rn = NULL; struct bgp_info *ri; - /* Bail out early if we don't have to advertise type-5 routes. */ - if (!advertise_type5_routes(bgp_vrf, afi)) - return; - table = bgp_vrf->rib[afi][safi]; for (rn = bgp_table_top(table); rn; rn = bgp_route_next(rn)) { /* Need to identify the "selected" route entry to use its diff --git a/bgpd/bgp_evpn.h b/bgpd/bgp_evpn.h index a8dcbc112b..cd3b7e3af2 100644 --- a/bgpd/bgp_evpn.h +++ b/bgpd/bgp_evpn.h @@ -55,6 +55,23 @@ static inline vni_t label2vni(mpls_label_t *label) return vni; } +static inline int advertise_type5_routes(struct bgp *bgp_vrf, + afi_t afi) +{ + if (!bgp_vrf->l3vni) + return 0; + + if (afi == AFI_IP && + CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_ADVERTISE_IPV4_IN_EVPN)) + return 1; + + if (afi == AFI_IP6 && + CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_ADVERTISE_IPV6_IN_EVPN)) + return 1; + + return 0; +} + extern void bgp_evpn_advertise_type5_route(struct bgp *bgp_vrf, struct prefix *p, struct attr *src_attr, diff --git a/bgpd/bgp_evpn_private.h b/bgpd/bgp_evpn_private.h index cc0ec82344..5ff16c39e9 100644 --- a/bgpd/bgp_evpn_private.h +++ b/bgpd/bgp_evpn_private.h @@ -349,23 +349,6 @@ static inline void build_evpn_type3_prefix(struct prefix_evpn *p, p->prefix.ip.ipaddr_v4 = originator_ip; } -static inline int advertise_type5_routes(struct bgp *bgp_vrf, - afi_t afi) -{ - if (!bgp_vrf->l3vni) - return 0; - - if (afi == AFI_IP && - CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_ADVERTISE_IPV4_IN_EVPN)) - return 1; - - if (afi == AFI_IP6 && - CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_ADVERTISE_IPV6_IN_EVPN)) - return 1; - - return 0; -} - extern void evpn_rt_delete_auto(struct bgp*, vni_t, struct list*); extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp *bgp_vrf, struct ecommunity *ecomadd); diff --git a/bgpd/bgp_evpn_vty.c b/bgpd/bgp_evpn_vty.c index 1373afec4e..c3cab18d2e 100644 --- a/bgpd/bgp_evpn_vty.c +++ b/bgpd/bgp_evpn_vty.c @@ -2690,14 +2690,6 @@ DEFUN (bgp_evpn_advertise_vni_subnet, if (!bgp_vrf) return CMD_WARNING; - if (!(advertise_type5_routes(bgp_vrf, AFI_IP) || - advertise_type5_routes(bgp_vrf, AFI_IP6))) { - vty_out(vty, - "%%Please enable ip prefix advertisement under l2vpn evpn in %s", - vrf_id_to_name(bgp_vrf->vrf_id)); - return CMD_WARNING; - } - evpn_set_advertise_subnet(bgp, vpn); return CMD_SUCCESS; } @@ -2841,7 +2833,7 @@ DEFUN (no_bgp_evpn_advertise_type5, if (afi == AFI_IP) { - /* if we are already advertising ipv4 prefix as type-5 + /* if we are not advertising ipv4 prefix as type-5 * nothing to do */ if (CHECK_FLAG(bgp_vrf->vrf_flags, @@ -2852,7 +2844,7 @@ DEFUN (no_bgp_evpn_advertise_type5, } } else { - /* if we are already advertising ipv6 prefix as type-5 + /* if we are not advertising ipv6 prefix as type-5 * nothing to do */ if (CHECK_FLAG(bgp_vrf->vrf_flags, diff --git a/bgpd/bgp_route.c b/bgpd/bgp_route.c index 20bf9635a3..0d226f9e72 100644 --- a/bgpd/bgp_route.c +++ b/bgpd/bgp_route.c @@ -2228,10 +2228,10 @@ static void bgp_process_main_one(struct bgp *bgp, struct bgp_node *rn, /* advertise/withdraw type-5 routes */ if ((afi == AFI_IP || afi == AFI_IP6) && (safi == SAFI_UNICAST)) { - if (new_select) + if (advertise_type5_routes(bgp, afi) && new_select) bgp_evpn_advertise_type5_route( bgp, &rn->p, new_select->attr, afi, safi); - else if (old_select) + else if (advertise_type5_routes(bgp, afi) && old_select) bgp_evpn_withdraw_type5_route(bgp, &rn->p, afi, safi); } From 154faa5007767a23eeb1daed8a33421320a9276d Mon Sep 17 00:00:00 2001 From: Mitesh Kanjariya Date: Tue, 20 Feb 2018 00:46:22 -0800 Subject: [PATCH 077/148] bgpd: move l2vpn evpn related flags in struct bgp to af_flags We have af_flags in struct bgp to hold address family related flags, l2vpn evpn flags to indicate advertise ipvX unicast should be moved there. Signed-off-by: Mitesh Kanjariya --- bgpd/bgp_evpn.h | 6 ++++-- bgpd/bgp_evpn_vty.c | 38 +++++++++++++++++++++----------------- bgpd/bgpd.h | 13 ++++++++----- 3 files changed, 33 insertions(+), 24 deletions(-) diff --git a/bgpd/bgp_evpn.h b/bgpd/bgp_evpn.h index cd3b7e3af2..064cc71349 100644 --- a/bgpd/bgp_evpn.h +++ b/bgpd/bgp_evpn.h @@ -62,11 +62,13 @@ static inline int advertise_type5_routes(struct bgp *bgp_vrf, return 0; if (afi == AFI_IP && - CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_ADVERTISE_IPV4_IN_EVPN)) + CHECK_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST)) return 1; if (afi == AFI_IP6 && - CHECK_FLAG(bgp_vrf->vrf_flags, BGP_VRF_ADVERTISE_IPV6_IN_EVPN)) + CHECK_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) return 1; return 0; diff --git a/bgpd/bgp_evpn_vty.c b/bgpd/bgp_evpn_vty.c index c3cab18d2e..1720744439 100644 --- a/bgpd/bgp_evpn_vty.c +++ b/bgpd/bgp_evpn_vty.c @@ -2761,21 +2761,23 @@ DEFUN (bgp_evpn_advertise_type5, /* if we are already advertising ipv4 prefix as type-5 * nothing to do */ - if (!rmap_changed && CHECK_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV4_IN_EVPN)) + if (!rmap_changed && + CHECK_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST)) return CMD_WARNING; - SET_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV4_IN_EVPN); + SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST); } else { /* if we are already advertising ipv6 prefix as type-5 * nothing to do */ - if (!rmap_changed && CHECK_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV6_IN_EVPN)) + if (!rmap_changed && + CHECK_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) return CMD_WARNING; - SET_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV6_IN_EVPN); + SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST); } if (rmap_changed) { @@ -2836,22 +2838,22 @@ DEFUN (no_bgp_evpn_advertise_type5, /* if we are not advertising ipv4 prefix as type-5 * nothing to do */ - if (CHECK_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV4_IN_EVPN)) { + if (CHECK_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST)) { bgp_evpn_withdraw_type5_routes(bgp_vrf, afi, safi); - UNSET_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV4_IN_EVPN); + UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST); } } else { /* if we are not advertising ipv6 prefix as type-5 * nothing to do */ - if (CHECK_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV6_IN_EVPN)) { + if (CHECK_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) { bgp_evpn_withdraw_type5_routes(bgp_vrf, afi, safi); UNSET_FLAG(bgp_vrf->vrf_flags, - BGP_VRF_ADVERTISE_IPV6_IN_EVPN); + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST); } } @@ -4373,10 +4375,12 @@ void bgp_config_write_evpn_info(struct vty *vty, struct bgp *bgp, afi_t afi, if (bgp->advertise_gw_macip) vty_out(vty, " advertise-default-gw\n"); - if (CHECK_FLAG(bgp->vrf_flags, BGP_VRF_ADVERTISE_IPV4_IN_EVPN)) + if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST)) vty_out(vty, " advertise ipv4 unicast\n"); - if (CHECK_FLAG(bgp->vrf_flags, BGP_VRF_ADVERTISE_IPV6_IN_EVPN)) + if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) vty_out(vty, " advertise ipv6 unicast\n"); } diff --git a/bgpd/bgpd.h b/bgpd/bgpd.h index 220b6d989e..5b77be2be9 100644 --- a/bgpd/bgpd.h +++ b/bgpd/bgpd.h @@ -320,6 +320,11 @@ struct bgp { u_int16_t af_flags[AFI_MAX][SAFI_MAX]; #define BGP_CONFIG_DAMPENING (1 << 0) +/* l2vpn evpn flags */ +#define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 0) +#define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 1) + + /* Route table for next-hop lookup cache. */ struct bgp_table *nexthop_cache_table[AFI_MAX]; @@ -431,11 +436,9 @@ struct bgp { /* vrf flags */ uint32_t vrf_flags; #define BGP_VRF_AUTO (1 << 0) -#define BGP_VRF_ADVERTISE_IPV4_IN_EVPN (1 << 1) -#define BGP_VRF_ADVERTISE_IPV6_IN_EVPN (1 << 2) -#define BGP_VRF_IMPORT_RT_CFGD (1 << 3) -#define BGP_VRF_EXPORT_RT_CFGD (1 << 4) -#define BGP_VRF_RD_CFGD (1 << 5) +#define BGP_VRF_IMPORT_RT_CFGD (1 << 1) +#define BGP_VRF_EXPORT_RT_CFGD (1 << 2) +#define BGP_VRF_RD_CFGD (1 << 3) /* unique ID for auto derivation of RD for this vrf */ uint16_t vrf_rd_id; From 486456ca92b9778e7cb8e0b3524dd7f98bdde8f0 Mon Sep 17 00:00:00 2001 From: Mitesh Kanjariya Date: Thu, 15 Feb 2018 17:20:27 -0800 Subject: [PATCH 078/148] bgpd: support for default-originate type-5 route Implement support for 'default-originate' for L2VPN/EVPN address family. This is needed for the case where external routing within a POD, will follow the default route to the border/exit leaf. The border leaf has more than one next hop to forward the packet on to, depending on the destination IP. Signed-off-by: Mitesh Kanjariya --- ...t-for-default-originate-type-5-route.patch | 180 ++++++++++++++++++ bgpd/bgp_evpn_private.h | 14 ++ bgpd/bgp_evpn_vty.c | 89 +++++++++ bgpd/bgpd.h | 2 + 4 files changed, 285 insertions(+) create mode 100644 0001-bgpd-support-for-default-originate-type-5-route.patch diff --git a/0001-bgpd-support-for-default-originate-type-5-route.patch b/0001-bgpd-support-for-default-originate-type-5-route.patch new file mode 100644 index 0000000000..92121082c0 --- /dev/null +++ b/0001-bgpd-support-for-default-originate-type-5-route.patch @@ -0,0 +1,180 @@ +From dbc3fbc612ce6523a596804c270600de1f6f2309 Mon Sep 17 00:00:00 2001 +From: Mitesh Kanjariya +Date: Thu, 15 Feb 2018 17:20:27 -0800 +Subject: [PATCH] bgpd: support for default-originate type-5 route + +Implement support for 'default-originate' for L2VPN/EVPN address family. +This is needed for the case where external routing within a POD, +will follow the default route to the border/exit leaf. +The border/exit leaf has more than one next hop to forward the packet on to, +depending on the destination IP. + +Signed-off-by: Mitesh Kanjariya +--- + bgpd/bgp_evpn_private.h | 14 ++++++++ + bgpd/bgp_evpn_vty.c | 89 +++++++++++++++++++++++++++++++++++++++++++++++++ + bgpd/bgpd.h | 2 ++ + 3 files changed, 105 insertions(+) + +diff --git a/bgpd/bgp_evpn_private.h b/bgpd/bgp_evpn_private.h +index 5ff16c3..bc68e25 100644 +--- a/bgpd/bgp_evpn_private.h ++++ b/bgpd/bgp_evpn_private.h +@@ -349,6 +349,20 @@ static inline void build_evpn_type3_prefix(struct prefix_evpn *p, + p->prefix.ip.ipaddr_v4 = originator_ip; + } + ++static inline int evpn_default_originate_set(struct bgp *bgp, afi_t afi, ++ safi_t safi) ++{ ++ if (afi == AFI_IP && ++ CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4)) ++ return 1; ++ else if (afi == AFI_IP6 && ++ CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6)) ++ return 1; ++ return 0; ++} ++ + extern void evpn_rt_delete_auto(struct bgp*, vni_t, struct list*); + extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp *bgp_vrf, + struct ecommunity *ecomadd); +diff --git a/bgpd/bgp_evpn_vty.c b/bgpd/bgp_evpn_vty.c +index 1720744..5ce71db 100644 +--- a/bgpd/bgp_evpn_vty.c ++++ b/bgpd/bgp_evpn_vty.c +@@ -2476,6 +2476,48 @@ static void evpn_unset_advertise_default_gw(struct bgp *bgp, + /* + * evpn - enable advertisement of default g/w + */ ++static void evpn_process_default_originate_cmd(struct bgp *bgp_vrf, ++ afi_t afi, int add) ++{ ++ struct prefix ip_prefix; ++ safi_t safi = SAFI_UNICAST; /* ipv4/ipv6 unicast */ ++ ++ /* form the default prefix 0.0.0.0/0 */ ++ memset(&ip_prefix, 0, sizeof(struct prefix)); ++ ip_prefix.family = afi2family(afi); ++ ip_prefix.prefixlen = 0; ++ ++ if (add) { ++ /* bail if we are already advertising default route */ ++ if (evpn_default_originate_set(bgp_vrf, afi, safi)) ++ return; ++ ++ if (afi == AFI_IP) ++ SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4); ++ else if (afi == AFI_IP6) ++ SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6); ++ bgp_evpn_advertise_type5_route(bgp_vrf, &ip_prefix, ++ NULL, afi, safi); ++ } else { ++ /* bail out if we havent advertised the default route */ ++ if (!evpn_default_originate_set(bgp_vrf, afi, safi)) ++ return; ++ if (afi == AFI_IP) ++ UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4); ++ else if (afi == AFI_IP6) ++ UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6); ++ bgp_evpn_withdraw_type5_route(bgp_vrf, &ip_prefix, ++ afi, safi); ++ } ++} ++ ++/* ++ * evpn - enable advertisement of default g/w ++ */ + static void evpn_set_advertise_subnet(struct bgp *bgp, + struct bgpevpn *vpn) + { +@@ -2671,6 +2713,43 @@ DEFUN (no_bgp_evpn_advertise_all_vni, + return CMD_SUCCESS; + } + ++DEFUN (bgp_evpn_default_originate, ++ bgp_evpn_default_originate_cmd, ++ "default-originate ", ++ "originate a default route\n" ++ "ipv4 address family\n" ++ "ipv6 address family\n") ++{ ++ afi_t afi = 0; ++ int idx_afi = 0; ++ struct bgp *bgp_vrf = VTY_GET_CONTEXT(bgp); ++ ++ if (!bgp_vrf) ++ return CMD_WARNING; ++ argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); ++ evpn_process_default_originate_cmd(bgp_vrf, afi, 1); ++ return CMD_SUCCESS; ++} ++ ++DEFUN (no_bgp_evpn_default_originate, ++ no_bgp_evpn_default_originate_cmd, ++ "no default-originate ", ++ NO_STR ++ "withdraw a default route\n" ++ "ipv4 address family\n" ++ "ipv6 address family\n") ++{ ++ afi_t afi = 0; ++ int idx_afi = 0; ++ struct bgp *bgp_vrf = VTY_GET_CONTEXT(bgp); ++ ++ if (!bgp_vrf) ++ return CMD_WARNING; ++ argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); ++ evpn_process_default_originate_cmd(bgp_vrf, afi, 0); ++ return CMD_SUCCESS; ++} ++ + DEFUN (bgp_evpn_advertise_vni_subnet, + bgp_evpn_advertise_vni_subnet_cmd, + "advertise-subnet", +@@ -4382,6 +4461,14 @@ void bgp_config_write_evpn_info(struct vty *vty, struct bgp *bgp, afi_t afi, + if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) + vty_out(vty, " advertise ipv6 unicast\n"); ++ ++ if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4)) ++ vty_out(vty, " default-originate ipv4\n"); ++ ++ if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], ++ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6)) ++ vty_out(vty, " default-originate ipv6\n"); + } + + void bgp_ethernetvpn_init(void) +@@ -4411,6 +4498,8 @@ void bgp_ethernetvpn_init(void) + install_element(BGP_EVPN_NODE, &no_bgp_evpn_advertise_default_gw_cmd); + install_element(BGP_EVPN_NODE, &bgp_evpn_advertise_type5_cmd); + install_element(BGP_EVPN_NODE, &no_bgp_evpn_advertise_type5_cmd); ++ install_element(BGP_EVPN_NODE, &bgp_evpn_default_originate_cmd); ++ install_element(BGP_EVPN_NODE, &no_bgp_evpn_default_originate_cmd); + + /* "show bgp l2vpn evpn" commands. */ + install_element(VIEW_NODE, &show_bgp_l2vpn_evpn_vni_cmd); +diff --git a/bgpd/bgpd.h b/bgpd/bgpd.h +index 5b77be2..274ca82 100644 +--- a/bgpd/bgpd.h ++++ b/bgpd/bgpd.h +@@ -323,6 +323,8 @@ struct bgp { + /* l2vpn evpn flags */ + #define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 0) + #define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 1) ++#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 2) ++#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 3) + + + /* Route table for next-hop lookup cache. */ +-- +2.7.4 + diff --git a/bgpd/bgp_evpn_private.h b/bgpd/bgp_evpn_private.h index 5ff16c39e9..bc68e259b6 100644 --- a/bgpd/bgp_evpn_private.h +++ b/bgpd/bgp_evpn_private.h @@ -349,6 +349,20 @@ static inline void build_evpn_type3_prefix(struct prefix_evpn *p, p->prefix.ip.ipaddr_v4 = originator_ip; } +static inline int evpn_default_originate_set(struct bgp *bgp, afi_t afi, + safi_t safi) +{ + if (afi == AFI_IP && + CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4)) + return 1; + else if (afi == AFI_IP6 && + CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6)) + return 1; + return 0; +} + extern void evpn_rt_delete_auto(struct bgp*, vni_t, struct list*); extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp *bgp_vrf, struct ecommunity *ecomadd); diff --git a/bgpd/bgp_evpn_vty.c b/bgpd/bgp_evpn_vty.c index 1720744439..5ce71dbf62 100644 --- a/bgpd/bgp_evpn_vty.c +++ b/bgpd/bgp_evpn_vty.c @@ -2473,6 +2473,48 @@ static void evpn_unset_advertise_default_gw(struct bgp *bgp, return; } +/* + * evpn - enable advertisement of default g/w + */ +static void evpn_process_default_originate_cmd(struct bgp *bgp_vrf, + afi_t afi, int add) +{ + struct prefix ip_prefix; + safi_t safi = SAFI_UNICAST; /* ipv4/ipv6 unicast */ + + /* form the default prefix 0.0.0.0/0 */ + memset(&ip_prefix, 0, sizeof(struct prefix)); + ip_prefix.family = afi2family(afi); + ip_prefix.prefixlen = 0; + + if (add) { + /* bail if we are already advertising default route */ + if (evpn_default_originate_set(bgp_vrf, afi, safi)) + return; + + if (afi == AFI_IP) + SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4); + else if (afi == AFI_IP6) + SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6); + bgp_evpn_advertise_type5_route(bgp_vrf, &ip_prefix, + NULL, afi, safi); + } else { + /* bail out if we havent advertised the default route */ + if (!evpn_default_originate_set(bgp_vrf, afi, safi)) + return; + if (afi == AFI_IP) + UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4); + else if (afi == AFI_IP6) + UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6); + bgp_evpn_withdraw_type5_route(bgp_vrf, &ip_prefix, + afi, safi); + } +} + /* * evpn - enable advertisement of default g/w */ @@ -2671,6 +2713,43 @@ DEFUN (no_bgp_evpn_advertise_all_vni, return CMD_SUCCESS; } +DEFUN (bgp_evpn_default_originate, + bgp_evpn_default_originate_cmd, + "default-originate ", + "originate a default route\n" + "ipv4 address family\n" + "ipv6 address family\n") +{ + afi_t afi = 0; + int idx_afi = 0; + struct bgp *bgp_vrf = VTY_GET_CONTEXT(bgp); + + if (!bgp_vrf) + return CMD_WARNING; + argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); + evpn_process_default_originate_cmd(bgp_vrf, afi, 1); + return CMD_SUCCESS; +} + +DEFUN (no_bgp_evpn_default_originate, + no_bgp_evpn_default_originate_cmd, + "no default-originate ", + NO_STR + "withdraw a default route\n" + "ipv4 address family\n" + "ipv6 address family\n") +{ + afi_t afi = 0; + int idx_afi = 0; + struct bgp *bgp_vrf = VTY_GET_CONTEXT(bgp); + + if (!bgp_vrf) + return CMD_WARNING; + argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); + evpn_process_default_originate_cmd(bgp_vrf, afi, 0); + return CMD_SUCCESS; +} + DEFUN (bgp_evpn_advertise_vni_subnet, bgp_evpn_advertise_vni_subnet_cmd, "advertise-subnet", @@ -4382,6 +4461,14 @@ void bgp_config_write_evpn_info(struct vty *vty, struct bgp *bgp, afi_t afi, if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) vty_out(vty, " advertise ipv6 unicast\n"); + + if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4)) + vty_out(vty, " default-originate ipv4\n"); + + if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], + BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6)) + vty_out(vty, " default-originate ipv6\n"); } void bgp_ethernetvpn_init(void) @@ -4411,6 +4498,8 @@ void bgp_ethernetvpn_init(void) install_element(BGP_EVPN_NODE, &no_bgp_evpn_advertise_default_gw_cmd); install_element(BGP_EVPN_NODE, &bgp_evpn_advertise_type5_cmd); install_element(BGP_EVPN_NODE, &no_bgp_evpn_advertise_type5_cmd); + install_element(BGP_EVPN_NODE, &bgp_evpn_default_originate_cmd); + install_element(BGP_EVPN_NODE, &no_bgp_evpn_default_originate_cmd); /* "show bgp l2vpn evpn" commands. */ install_element(VIEW_NODE, &show_bgp_l2vpn_evpn_vni_cmd); diff --git a/bgpd/bgpd.h b/bgpd/bgpd.h index 5b77be2be9..274ca82ffc 100644 --- a/bgpd/bgpd.h +++ b/bgpd/bgpd.h @@ -323,6 +323,8 @@ struct bgp { /* l2vpn evpn flags */ #define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 0) #define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 1) +#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 2) +#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 3) /* Route table for next-hop lookup cache. */ From 6fb219da876ace4732e31005466cae708e512d42 Mon Sep 17 00:00:00 2001 From: Mitesh Kanjariya Date: Wed, 21 Feb 2018 22:02:07 -0800 Subject: [PATCH 079/148] bgpd: provide a match clause to match EVPN default route A Border Leaf can originate a default route for all the leafs within the POD. However, we do not want to advertise this route outside the POD. Therefore, we provide an option to filter a EVPN type5 default route through a route-map. Signed-off-by: Mitesh Kanjariya --- ...t-for-default-originate-type-5-route.patch | 180 ------------------ bgpd/bgp_evpn_private.h | 8 + bgpd/bgp_routemap.c | 44 +++++ 3 files changed, 52 insertions(+), 180 deletions(-) delete mode 100644 0001-bgpd-support-for-default-originate-type-5-route.patch diff --git a/0001-bgpd-support-for-default-originate-type-5-route.patch b/0001-bgpd-support-for-default-originate-type-5-route.patch deleted file mode 100644 index 92121082c0..0000000000 --- a/0001-bgpd-support-for-default-originate-type-5-route.patch +++ /dev/null @@ -1,180 +0,0 @@ -From dbc3fbc612ce6523a596804c270600de1f6f2309 Mon Sep 17 00:00:00 2001 -From: Mitesh Kanjariya -Date: Thu, 15 Feb 2018 17:20:27 -0800 -Subject: [PATCH] bgpd: support for default-originate type-5 route - -Implement support for 'default-originate' for L2VPN/EVPN address family. -This is needed for the case where external routing within a POD, -will follow the default route to the border/exit leaf. -The border/exit leaf has more than one next hop to forward the packet on to, -depending on the destination IP. - -Signed-off-by: Mitesh Kanjariya ---- - bgpd/bgp_evpn_private.h | 14 ++++++++ - bgpd/bgp_evpn_vty.c | 89 +++++++++++++++++++++++++++++++++++++++++++++++++ - bgpd/bgpd.h | 2 ++ - 3 files changed, 105 insertions(+) - -diff --git a/bgpd/bgp_evpn_private.h b/bgpd/bgp_evpn_private.h -index 5ff16c3..bc68e25 100644 ---- a/bgpd/bgp_evpn_private.h -+++ b/bgpd/bgp_evpn_private.h -@@ -349,6 +349,20 @@ static inline void build_evpn_type3_prefix(struct prefix_evpn *p, - p->prefix.ip.ipaddr_v4 = originator_ip; - } - -+static inline int evpn_default_originate_set(struct bgp *bgp, afi_t afi, -+ safi_t safi) -+{ -+ if (afi == AFI_IP && -+ CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4)) -+ return 1; -+ else if (afi == AFI_IP6 && -+ CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6)) -+ return 1; -+ return 0; -+} -+ - extern void evpn_rt_delete_auto(struct bgp*, vni_t, struct list*); - extern void bgp_evpn_configure_export_rt_for_vrf(struct bgp *bgp_vrf, - struct ecommunity *ecomadd); -diff --git a/bgpd/bgp_evpn_vty.c b/bgpd/bgp_evpn_vty.c -index 1720744..5ce71db 100644 ---- a/bgpd/bgp_evpn_vty.c -+++ b/bgpd/bgp_evpn_vty.c -@@ -2476,6 +2476,48 @@ static void evpn_unset_advertise_default_gw(struct bgp *bgp, - /* - * evpn - enable advertisement of default g/w - */ -+static void evpn_process_default_originate_cmd(struct bgp *bgp_vrf, -+ afi_t afi, int add) -+{ -+ struct prefix ip_prefix; -+ safi_t safi = SAFI_UNICAST; /* ipv4/ipv6 unicast */ -+ -+ /* form the default prefix 0.0.0.0/0 */ -+ memset(&ip_prefix, 0, sizeof(struct prefix)); -+ ip_prefix.family = afi2family(afi); -+ ip_prefix.prefixlen = 0; -+ -+ if (add) { -+ /* bail if we are already advertising default route */ -+ if (evpn_default_originate_set(bgp_vrf, afi, safi)) -+ return; -+ -+ if (afi == AFI_IP) -+ SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4); -+ else if (afi == AFI_IP6) -+ SET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6); -+ bgp_evpn_advertise_type5_route(bgp_vrf, &ip_prefix, -+ NULL, afi, safi); -+ } else { -+ /* bail out if we havent advertised the default route */ -+ if (!evpn_default_originate_set(bgp_vrf, afi, safi)) -+ return; -+ if (afi == AFI_IP) -+ UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4); -+ else if (afi == AFI_IP6) -+ UNSET_FLAG(bgp_vrf->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6); -+ bgp_evpn_withdraw_type5_route(bgp_vrf, &ip_prefix, -+ afi, safi); -+ } -+} -+ -+/* -+ * evpn - enable advertisement of default g/w -+ */ - static void evpn_set_advertise_subnet(struct bgp *bgp, - struct bgpevpn *vpn) - { -@@ -2671,6 +2713,43 @@ DEFUN (no_bgp_evpn_advertise_all_vni, - return CMD_SUCCESS; - } - -+DEFUN (bgp_evpn_default_originate, -+ bgp_evpn_default_originate_cmd, -+ "default-originate ", -+ "originate a default route\n" -+ "ipv4 address family\n" -+ "ipv6 address family\n") -+{ -+ afi_t afi = 0; -+ int idx_afi = 0; -+ struct bgp *bgp_vrf = VTY_GET_CONTEXT(bgp); -+ -+ if (!bgp_vrf) -+ return CMD_WARNING; -+ argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); -+ evpn_process_default_originate_cmd(bgp_vrf, afi, 1); -+ return CMD_SUCCESS; -+} -+ -+DEFUN (no_bgp_evpn_default_originate, -+ no_bgp_evpn_default_originate_cmd, -+ "no default-originate ", -+ NO_STR -+ "withdraw a default route\n" -+ "ipv4 address family\n" -+ "ipv6 address family\n") -+{ -+ afi_t afi = 0; -+ int idx_afi = 0; -+ struct bgp *bgp_vrf = VTY_GET_CONTEXT(bgp); -+ -+ if (!bgp_vrf) -+ return CMD_WARNING; -+ argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); -+ evpn_process_default_originate_cmd(bgp_vrf, afi, 0); -+ return CMD_SUCCESS; -+} -+ - DEFUN (bgp_evpn_advertise_vni_subnet, - bgp_evpn_advertise_vni_subnet_cmd, - "advertise-subnet", -@@ -4382,6 +4461,14 @@ void bgp_config_write_evpn_info(struct vty *vty, struct bgp *bgp, afi_t afi, - if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], - BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST)) - vty_out(vty, " advertise ipv6 unicast\n"); -+ -+ if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4)) -+ vty_out(vty, " default-originate ipv4\n"); -+ -+ if (CHECK_FLAG(bgp->af_flags[AFI_L2VPN][SAFI_EVPN], -+ BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6)) -+ vty_out(vty, " default-originate ipv6\n"); - } - - void bgp_ethernetvpn_init(void) -@@ -4411,6 +4498,8 @@ void bgp_ethernetvpn_init(void) - install_element(BGP_EVPN_NODE, &no_bgp_evpn_advertise_default_gw_cmd); - install_element(BGP_EVPN_NODE, &bgp_evpn_advertise_type5_cmd); - install_element(BGP_EVPN_NODE, &no_bgp_evpn_advertise_type5_cmd); -+ install_element(BGP_EVPN_NODE, &bgp_evpn_default_originate_cmd); -+ install_element(BGP_EVPN_NODE, &no_bgp_evpn_default_originate_cmd); - - /* "show bgp l2vpn evpn" commands. */ - install_element(VIEW_NODE, &show_bgp_l2vpn_evpn_vni_cmd); -diff --git a/bgpd/bgpd.h b/bgpd/bgpd.h -index 5b77be2..274ca82 100644 ---- a/bgpd/bgpd.h -+++ b/bgpd/bgpd.h -@@ -323,6 +323,8 @@ struct bgp { - /* l2vpn evpn flags */ - #define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 0) - #define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 1) -+#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 2) -+#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 3) - - - /* Route table for next-hop lookup cache. */ --- -2.7.4 - diff --git a/bgpd/bgp_evpn_private.h b/bgpd/bgp_evpn_private.h index bc68e259b6..4b2742058b 100644 --- a/bgpd/bgp_evpn_private.h +++ b/bgpd/bgp_evpn_private.h @@ -280,6 +280,14 @@ static inline void ip_prefix_from_type5_prefix(struct prefix_evpn *evp, } } +static inline int is_evpn_prefix_default(struct prefix *evp) +{ + if (evp->family != AF_EVPN) + return 0; + + return ((evp->u.prefix_evpn.ip_prefix_length == 0) ? 1 : 0); +} + static inline void ip_prefix_from_type2_prefix(struct prefix_evpn *evp, struct prefix *ip) { diff --git a/bgpd/bgp_routemap.c b/bgpd/bgp_routemap.c index 4d5624d3b0..b3cd4b7af7 100644 --- a/bgpd/bgp_routemap.c +++ b/bgpd/bgp_routemap.c @@ -594,6 +594,24 @@ struct route_map_rule_cmd route_match_ip_route_source_prefix_list_cmd = { route_match_ip_route_source_prefix_list_compile, route_match_ip_route_source_prefix_list_free}; +/* `match evpn default-route' */ + +/* Match function should return 1 if match is success else 0 */ +static route_map_result_t route_match_evpn_default_route(void *rule, + struct prefix *p, + route_map_object_t + type, void *object) +{ + if (type == RMAP_BGP && is_evpn_prefix_default(p)) + return RMAP_MATCH; + + return RMAP_NOMATCH; +} + +/* Route map commands for default-route matching. */ +struct route_map_rule_cmd route_match_evpn_default_route_cmd = { + "evpn default-route", route_match_evpn_default_route, NULL, NULL}; + /* `match mac address MAC_ACCESS_LIST' */ /* Match function should return 1 if match is success else return @@ -3249,6 +3267,29 @@ DEFUN (no_match_evpn_vni, RMAP_EVENT_MATCH_DELETED); } +DEFUN (match_evpn_default_route, + match_evpn_default_route_cmd, + "match evpn default-route", + MATCH_STR + EVPN_HELP_STR + "default EVPN type-5 route\n") +{ + return bgp_route_match_add(vty, "evpn default-route", NULL, + RMAP_EVENT_MATCH_ADDED); +} + +DEFUN (no_match_evpn_default_route, + no_match_evpn_default_route_cmd, + "no match evpn default-route", + NO_STR + MATCH_STR + EVPN_HELP_STR + "default EVPN type-5 route\n") +{ + return bgp_route_match_delete(vty, "evpn default-route", NULL, + RMAP_EVENT_MATCH_DELETED); +} + DEFUN (match_peer, match_peer_cmd, "match peer ", @@ -4628,6 +4669,7 @@ void bgp_route_map_init(void) route_map_install_match(&route_match_mac_address_cmd); route_map_install_match(&route_match_evpn_vni_cmd); route_map_install_match(&route_match_evpn_route_type_cmd); + route_map_install_match(&route_match_evpn_default_route_cmd); route_map_install_set(&route_set_ip_nexthop_cmd); route_map_install_set(&route_set_local_pref_cmd); @@ -4664,6 +4706,8 @@ void bgp_route_map_init(void) install_element(RMAP_NODE, &no_match_evpn_vni_cmd); install_element(RMAP_NODE, &match_evpn_route_type_cmd); install_element(RMAP_NODE, &no_match_evpn_route_type_cmd); + install_element(RMAP_NODE, &match_evpn_default_route_cmd); + install_element(RMAP_NODE, &no_match_evpn_default_route_cmd); install_element(RMAP_NODE, &match_aspath_cmd); install_element(RMAP_NODE, &no_match_aspath_cmd); From 2c29b18a1b327beaddabc11fd8e062310625b574 Mon Sep 17 00:00:00 2001 From: mitesh Date: Tue, 27 Feb 2018 02:19:57 -0800 Subject: [PATCH 080/148] bgpd: reassign the flags in struct bgp af_flags to avoid conflict We have af_flags in struct bgp which holds address family related flags. Seems like we had a conflict between two flags. Signed-off-by: Mitesh Kanjariya --- bgpd/bgpd.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/bgpd/bgpd.h b/bgpd/bgpd.h index bc5350ce24..43d76e5273 100644 --- a/bgpd/bgpd.h +++ b/bgpd/bgpd.h @@ -320,11 +320,11 @@ struct bgp { u_int16_t af_flags[AFI_MAX][SAFI_MAX]; #define BGP_CONFIG_DAMPENING (1 << 0) -/* l2vpn evpn flags */ -#define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 0) -#define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 1) -#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 2) -#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 3) +/* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */ +#define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 1) +#define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 2) +#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 3) +#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 4) /* Route table for next-hop lookup cache. */ From 1ec31309bb056e4492ebf50a12e8bb29a9c4b29a Mon Sep 17 00:00:00 2001 From: vivek Date: Wed, 28 Feb 2018 02:07:23 +0000 Subject: [PATCH 081/148] *: EVPN symmetric routing for IPv6 tenant routes Implement support for EVPN symmetric routing for IPv6 routes. The next hop for EVPN routes is the IP address of the remote VTEP which is only an IPv4 address. This means that for IPv6 symmetric routing, there will be IPv6 destinations with IPv4 next hops. To make this work, the IPv4 next hops are converted into IPv4-mapped IPv6 addresses. As part of support, ensure that "L3" route-targets are not announced with IPv6 link-local addresses so that they won't be installed in the routing table. Signed-off-by: Vivek Venkatraman vivek@cumulusnetworks.com Reviewed-by: Mitesh Kanjariya mitesh@cumulusnetworks.com Reviewed-by: Donald Sharp sharpd@cumulusnetworks.com --- bgpd/bgp_evpn.c | 162 +++++++++++++++++++++++--------------------- bgpd/bgp_evpn_vty.c | 2 +- lib/ipaddr.h | 10 +++ zebra/zebra_rib.c | 25 +++++-- zebra/zserv.c | 35 ++++++++-- 5 files changed, 144 insertions(+), 90 deletions(-) diff --git a/bgpd/bgp_evpn.c b/bgpd/bgp_evpn.c index a8ee14c72e..2271aa1005 100644 --- a/bgpd/bgp_evpn.c +++ b/bgpd/bgp_evpn.c @@ -478,6 +478,17 @@ static void derive_rd_rt_for_vni(struct bgp *bgp, struct bgpevpn *vpn) bgp_evpn_derive_auto_rt_export(bgp, vpn); } +/* + * Convert nexthop (remote VTEP IP) into an IPv6 address. + */ +static void evpn_convert_nexthop_to_ipv6(struct attr *attr) +{ + if (BGP_ATTR_NEXTHOP_AFI_IP6(attr)) + return; + ipv4_to_ipv4_mapped_ipv6(&attr->mp_nexthop_global, attr->nexthop); + attr->mp_nexthop_len = IPV6_MAX_BYTELEN; +} + /* * Add (update) or delete MACIP from zebra. */ @@ -626,17 +637,17 @@ static void build_evpn_type5_route_extcomm(struct bgp *bgp_vrf, } /* - * Build extended communities for EVPN route. RT and ENCAP are - * applicable to all routes. - * TODO: currently kernel doesnt support ipv6 routes with ipv4 nexthops. - * This means that we can't do symmetric routing for ipv6 hosts routes - * in the same way as ipv4 host routes. - * We wont attach l3-vni related RTs for ipv6 routes. - * For now, We will only adevrtise ipv4 host routes - * with L3-VNI related ext-comm. + * Build extended communities for EVPN route. + * This function is applicable for type-2 and type-3 routes. The layer-2 RT + * and ENCAP extended communities are applicable for all routes. + * The default gateway extended community and MAC mobility (sticky) extended + * community are added as needed based on passed settings - only for type-2 + * routes. Likewise, the layer-3 RT and Router MAC extended communities are + * added, if present, based on passed settings - only for non-link-local + * type-2 routes. */ static void build_evpn_route_extcomm(struct bgpevpn *vpn, struct attr *attr, - afi_t afi) + int add_l3_ecomm) { struct ecommunity ecom_encap; struct ecommunity ecom_sticky; @@ -666,11 +677,10 @@ static void build_evpn_route_extcomm(struct bgpevpn *vpn, struct attr *attr, for (ALL_LIST_ELEMENTS(vpn->export_rtl, node, nnode, ecom)) attr->ecommunity = ecommunity_merge(attr->ecommunity, ecom); - /* - * only attach l3-vni export rts for ipv4 address family and if we are - * advertising both the labels in type-2 routes + /* Add the export RTs for L3VNI if told to - caller determines + * when this should be done. */ - if (afi == AFI_IP && CHECK_FLAG(vpn->flags, VNI_FLAG_USE_TWO_LABELS)) { + if (add_l3_ecomm) { vrf_export_rtl = bgpevpn_get_vrf_export_rtl(vpn); if (vrf_export_rtl && !list_isempty(vrf_export_rtl)) { for (ALL_LIST_ELEMENTS(vrf_export_rtl, node, nnode, @@ -681,6 +691,7 @@ static void build_evpn_route_extcomm(struct bgpevpn *vpn, struct attr *attr, } } + /* Add MAC mobility (sticky) if needed. */ if (attr->sticky) { seqnum = 0; memset(&ecom_sticky, 0, sizeof(ecom_sticky)); @@ -691,12 +702,8 @@ static void build_evpn_route_extcomm(struct bgpevpn *vpn, struct attr *attr, ecommunity_merge(attr->ecommunity, &ecom_sticky); } - /* - * only attach l3-vni rmac for ipv4 address family and if we are - * advertising both the labels in type-2 routes - */ - if (afi == AFI_IP && !is_zero_mac(&attr->rmac) && - CHECK_FLAG(vpn->flags, VNI_FLAG_USE_TWO_LABELS)) { + /* Add RMAC, if told to. */ + if (add_l3_ecomm) { memset(&ecom_rmac, 0, sizeof(ecom_rmac)); encode_rmac_extcomm(&eval_rmac, &attr->rmac); ecom_rmac.size = 1; @@ -705,6 +712,7 @@ static void build_evpn_route_extcomm(struct bgpevpn *vpn, struct attr *attr, &ecom_rmac); } + /* Add default gateway, if needed. */ if (attr->default_gw) { memset(&ecom_default_gw, 0, sizeof(ecom_default_gw)); encode_default_gw_extcomm(&eval_default_gw); @@ -1269,6 +1277,7 @@ static int update_evpn_route(struct bgp *bgp, struct bgpevpn *vpn, struct bgp_node *rn; struct attr attr; struct attr *attr_new; + int add_l3_ecomm = 0; struct bgp_info *ri; afi_t afi = AFI_L2VPN; safi_t safi = SAFI_EVPN; @@ -1288,15 +1297,23 @@ static int update_evpn_route(struct bgp *bgp, struct bgpevpn *vpn, if (p->prefix.route_type == BGP_EVPN_IMET_ROUTE) attr.flag |= ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL); - /* router mac is only needed for type-2 and type-5 routes */ + /* router mac is only needed for type-2 routes here. */ if (p->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE) bgpevpn_get_rmac(vpn, &attr.rmac); vni2label(vpn->vni, &(attr.label)); - /* Set up RT and ENCAP extended community. */ - build_evpn_route_extcomm(vpn, &attr, - IS_EVPN_PREFIX_IPADDR_V4(p) ? - AFI_IP : AFI_IP6); + /* Include L3 VNI related RTs and RMAC for type-2 routes, if they're + * IPv4 or IPv6 global addresses and we're advertising L3VNI with + * these routes. + */ + if (p->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE && + (IS_EVPN_PREFIX_IPADDR_V4(p) || + !IN6_IS_ADDR_LINKLOCAL(&p->prefix.ip.ipaddr_v6)) && + CHECK_FLAG(vpn->flags, VNI_FLAG_USE_TWO_LABELS)) + add_l3_ecomm = 1; + + /* Set up extended community. */ + build_evpn_route_extcomm(vpn, &attr, add_l3_ecomm); /* First, create (or fetch) route node within the VNI. */ /* NOTE: There is no RD here. */ @@ -1478,22 +1495,20 @@ static int update_all_type2_routes(struct bgp *bgp, struct bgpevpn *vpn) struct attr attr; struct attr attr_sticky; struct attr attr_def_gw; - struct attr attr_ip6; - struct attr attr_sticky_ip6; - struct attr attr_def_gw_ip6; + struct attr attr_ip6_ll; struct attr *attr_new; + int add_l3_ecomm = 0; afi = AFI_L2VPN; safi = SAFI_EVPN; memset(&attr, 0, sizeof(struct attr)); memset(&attr_sticky, 0, sizeof(struct attr)); memset(&attr_def_gw, 0, sizeof(struct attr)); - memset(&attr_ip6, 0, sizeof(struct attr)); - memset(&attr_sticky_ip6, 0, sizeof(struct attr)); - memset(&attr_def_gw_ip6, 0, sizeof(struct attr)); + memset(&attr_ip6_ll, 0, sizeof(struct attr)); - /* Build path-attribute - all type-2 routes for this VNI will share the - * same path attribute. + /* Build path-attribute - multiple type-2 routes for this VNI will share + * the same path attribute, but we need separate structures for sticky + * MACs, default gateway and IPv6 link-local addresses (no L3 RT/RMAC). */ bgp_attr_default_set(&attr, BGP_ORIGIN_IGP); bgp_attr_default_set(&attr_sticky, BGP_ORIGIN_IGP); @@ -1512,31 +1527,21 @@ static int update_all_type2_routes(struct bgp *bgp, struct bgpevpn *vpn) attr_def_gw.mp_nexthop_len = BGP_ATTR_NHLEN_IPV4; attr_def_gw.default_gw = 1; bgpevpn_get_rmac(vpn, &attr_def_gw.rmac); - bgp_attr_default_set(&attr_ip6, BGP_ORIGIN_IGP); - bgp_attr_default_set(&attr_sticky_ip6, BGP_ORIGIN_IGP); - bgp_attr_default_set(&attr_def_gw_ip6, BGP_ORIGIN_IGP); - attr_ip6.nexthop = vpn->originator_ip; - attr_ip6.mp_nexthop_global_in = vpn->originator_ip; - attr_ip6.mp_nexthop_len = BGP_ATTR_NHLEN_IPV4; - bgpevpn_get_rmac(vpn, &attr_ip6.rmac); - attr_sticky_ip6.nexthop = vpn->originator_ip; - attr_sticky_ip6.mp_nexthop_global_in = vpn->originator_ip; - attr_sticky_ip6.mp_nexthop_len = BGP_ATTR_NHLEN_IPV4; - attr_sticky_ip6.sticky = 1; - bgpevpn_get_rmac(vpn, &attr_sticky_ip6.rmac); - attr_def_gw_ip6.nexthop = vpn->originator_ip; - attr_def_gw_ip6.mp_nexthop_global_in = vpn->originator_ip; - attr_def_gw_ip6.mp_nexthop_len = BGP_ATTR_NHLEN_IPV4; - attr_def_gw_ip6.default_gw = 1; - bgpevpn_get_rmac(vpn, &attr_def_gw_ip6.rmac); + bgp_attr_default_set(&attr_ip6_ll, BGP_ORIGIN_IGP); + attr_ip6_ll.nexthop = vpn->originator_ip; + attr_ip6_ll.mp_nexthop_global_in = vpn->originator_ip; + attr_ip6_ll.mp_nexthop_len = BGP_ATTR_NHLEN_IPV4; - /* Set up RT, ENCAP and sticky MAC extended community. */ - build_evpn_route_extcomm(vpn, &attr, AFI_IP); - build_evpn_route_extcomm(vpn, &attr_sticky, AFI_IP); - build_evpn_route_extcomm(vpn, &attr_def_gw, AFI_IP); - build_evpn_route_extcomm(vpn, &attr_ip6, AFI_IP6); - build_evpn_route_extcomm(vpn, &attr_sticky_ip6, AFI_IP6); - build_evpn_route_extcomm(vpn, &attr_def_gw_ip6, AFI_IP); + /* Add L3 VNI RTs and RMAC for non IPv6 link-local attributes if + * using L3 VNI for type-2 routes also. + */ + if (CHECK_FLAG(vpn->flags, VNI_FLAG_USE_TWO_LABELS)) + add_l3_ecomm = 1; + + build_evpn_route_extcomm(vpn, &attr, add_l3_ecomm); + build_evpn_route_extcomm(vpn, &attr_sticky, add_l3_ecomm); + build_evpn_route_extcomm(vpn, &attr_def_gw, add_l3_ecomm); + build_evpn_route_extcomm(vpn, &attr_ip6_ll, 0); /* Walk this VNI's route table and update local type-2 routes. For any * routes updated, update corresponding entry in the global table too. @@ -1550,7 +1555,11 @@ static int update_all_type2_routes(struct bgp *bgp, struct bgpevpn *vpn) if (evp->prefix.route_type != BGP_EVPN_MAC_IP_ROUTE) continue; - if (IS_EVPN_PREFIX_IPADDR_V4(evp)) { + if (IS_EVPN_PREFIX_IPADDR_V6(evp) && + IN6_IS_ADDR_LINKLOCAL(&evp->prefix.ip.ipaddr_v6)) + update_evpn_route_entry(bgp, vpn, afi, safi, rn, + &attr_ip6_ll, 0, 1, &ri, 0); + else { if (evpn_route_is_sticky(bgp, rn)) update_evpn_route_entry(bgp, vpn, afi, safi, rn, &attr_sticky, 0, 1, @@ -1562,19 +1571,6 @@ static int update_all_type2_routes(struct bgp *bgp, struct bgpevpn *vpn) else update_evpn_route_entry(bgp, vpn, afi, safi, rn, &attr, 0, 1, &ri, 0); - } else { - if (evpn_route_is_sticky(bgp, rn)) - update_evpn_route_entry(bgp, vpn, afi, safi, rn, - &attr_sticky_ip6, 0, 1, - &ri, 0); - else if (evpn_route_is_def_gw(bgp, rn)) - update_evpn_route_entry(bgp, vpn, afi, safi, rn, - &attr_def_gw_ip6, 0, 1, - &ri, 0); - else - update_evpn_route_entry(bgp, vpn, afi, safi, rn, - &attr_ip6, 0, 1, - &ri, 0); } /* If a local route exists for this prefix, we need to update @@ -1605,11 +1601,9 @@ static int update_all_type2_routes(struct bgp *bgp, struct bgpevpn *vpn) /* Unintern temporary. */ aspath_unintern(&attr.aspath); - aspath_unintern(&attr_ip6.aspath); aspath_unintern(&attr_sticky.aspath); - aspath_unintern(&attr_sticky_ip6.aspath); aspath_unintern(&attr_def_gw.aspath); - aspath_unintern(&attr_def_gw_ip6.aspath); + aspath_unintern(&attr_ip6_ll.aspath); return 0; } @@ -1801,6 +1795,7 @@ static int install_evpn_route_entry_in_vrf(struct bgp *bgp_vrf, { struct bgp_node *rn; struct bgp_info *ri; + struct attr attr; struct attr *attr_new; int ret = 0; struct prefix p; @@ -1836,6 +1831,15 @@ static int install_evpn_route_entry_in_vrf(struct bgp *bgp_vrf, } else return 0; + /* EVPN routes currently only support a IPv4 next hop which corresponds + * to the remote VTEP. When importing into a VRF, if it is IPv6 host + * route, we have to convert the next hop to an IPv4-mapped address + * for the rest of the code to flow through. + */ + bgp_attr_dup(&attr, parent_ri->attr); + if (afi == AFI_IP6) + evpn_convert_nexthop_to_ipv6(&attr); + /* Check if route entry is already present. */ for (ri = rn->info; ri; ri = ri->next) if (ri->extra @@ -1844,7 +1848,7 @@ static int install_evpn_route_entry_in_vrf(struct bgp *bgp_vrf, if (!ri) { /* Add (or update) attribute to hash. */ - attr_new = bgp_attr_intern(parent_ri->attr); + attr_new = bgp_attr_intern(&attr); /* Create new route with its attribute. */ ri = info_make(parent_ri->type, parent_ri->sub_type, 0, @@ -1859,21 +1863,25 @@ static int install_evpn_route_entry_in_vrf(struct bgp *bgp_vrf, } bgp_info_add(rn, ri); } else { - if (attrhash_cmp(ri->attr, parent_ri->attr) + if (attrhash_cmp(ri->attr, &attr) && !CHECK_FLAG(ri->flags, BGP_INFO_REMOVED)) { bgp_unlock_node(rn); return 0; } /* The attribute has changed. */ /* Add (or update) attribute to hash. */ - attr_new = bgp_attr_intern(parent_ri->attr); + attr_new = bgp_attr_intern(&attr); /* Restore route, if needed. */ if (CHECK_FLAG(ri->flags, BGP_INFO_REMOVED)) bgp_info_restore(rn, ri); /* Mark if nexthop has changed. */ - if (!IPV4_ADDR_SAME(&ri->attr->nexthop, &attr_new->nexthop)) + if ((afi == AFI_IP && + !IPV4_ADDR_SAME(&ri->attr->nexthop, &attr_new->nexthop)) || + (afi == AFI_IP6 && + !IPV6_ADDR_SAME(&ri->attr->mp_nexthop_global, + &attr_new->mp_nexthop_global))) SET_FLAG(ri->flags, BGP_INFO_IGP_CHANGED); /* Unintern existing, set to new. */ diff --git a/bgpd/bgp_evpn_vty.c b/bgpd/bgp_evpn_vty.c index f519bb463b..f977760a96 100644 --- a/bgpd/bgp_evpn_vty.c +++ b/bgpd/bgp_evpn_vty.c @@ -2780,7 +2780,7 @@ DEFUN (no_bgp_evpn_advertise_type5, argv_find_and_parse_afi(argv, argc, &idx_afi, &afi); argv_find_and_parse_safi(argv, argc, &idx_safi, &safi); - if (!(afi == AFI_IP) || (afi == AFI_IP6)) { + if (!(afi == AFI_IP || afi == AFI_IP6)) { vty_out(vty, "%%only ipv4 or ipv6 address families are supported"); return CMD_WARNING; diff --git a/lib/ipaddr.h b/lib/ipaddr.h index 98c28008dc..3857b83027 100644 --- a/lib/ipaddr.h +++ b/lib/ipaddr.h @@ -85,4 +85,14 @@ static inline char *ipaddr2str(struct ipaddr *ip, char *buf, int size) } return buf; } + +static inline void ipv4_to_ipv4_mapped_ipv6(struct in6_addr *in6, + struct in_addr in) +{ + u_int32_t addr_type = htonl(0xFFFF); + memset(in6, 0, sizeof(struct in6_addr)); + memcpy((char *)in6 + 8, &addr_type, sizeof(addr_type)); + memcpy((char *)in6 + 12, &in, sizeof(struct in_addr)); +} + #endif /* __IPADDR_H__ */ diff --git a/zebra/zebra_rib.c b/zebra/zebra_rib.c index 5c316e077f..cc4888f3e7 100644 --- a/zebra/zebra_rib.c +++ b/zebra/zebra_rib.c @@ -305,6 +305,8 @@ struct nexthop *route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re, nexthop->type = NEXTHOP_TYPE_IPV6_IFINDEX; nexthop->gate.ipv6 = *ipv6; nexthop->ifindex = ifindex; + if (CHECK_FLAG(re->flags, ZEBRA_FLAG_EVPN_ROUTE)) + SET_FLAG(nexthop->flags, NEXTHOP_FLAG_ONLINK); route_entry_nexthop_add(re, nexthop); @@ -421,6 +423,10 @@ static int nexthop_active(afi_t afi, struct route_entry *re, re->nexthop_mtu = 0; } + /* Next hops (remote VTEPs) for EVPN routes are fully resolved. */ + if (CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_EVPN_RVTEP)) + return 1; + /* Skip nexthops that have been filtered out due to route-map */ /* The nexthops are specific to this route and so the same */ /* nexthop for a different route may not have this flag set */ @@ -858,9 +864,7 @@ static unsigned nexthop_active_check(struct route_node *rn, case NEXTHOP_TYPE_IPV4: case NEXTHOP_TYPE_IPV4_IFINDEX: family = AFI_IP; - if (CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_EVPN_RVTEP)) - SET_FLAG(nexthop->flags, NEXTHOP_FLAG_ACTIVE); - else if (nexthop_active(AFI_IP, re, nexthop, set, rn)) + if (nexthop_active(AFI_IP, re, nexthop, set, rn)) SET_FLAG(nexthop->flags, NEXTHOP_FLAG_ACTIVE); else UNSET_FLAG(nexthop->flags, NEXTHOP_FLAG_ACTIVE); @@ -2548,10 +2552,17 @@ void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type, struct ipaddr vtep_ip; memset(&vtep_ip, 0, sizeof(struct ipaddr)); - vtep_ip.ipa_type = IPADDR_V4; - memcpy(&(vtep_ip.ipaddr_v4), - &(tmp_nh->gate.ipv4), - sizeof(struct in_addr)); + if (afi == AFI_IP) { + vtep_ip.ipa_type = IPADDR_V4; + memcpy(&(vtep_ip.ipaddr_v4), + &(tmp_nh->gate.ipv4), + sizeof(struct in_addr)); + } else { + vtep_ip.ipa_type = IPADDR_V6; + memcpy(&(vtep_ip.ipaddr_v6), + &(tmp_nh->gate.ipv6), + sizeof(struct in6_addr)); + } zebra_vxlan_evpn_vrf_route_del(re->vrf_id, rmac, &vtep_ip, p); } diff --git a/zebra/zserv.c b/zebra/zserv.c index 98cb54f7b8..983b04ed91 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -1143,6 +1143,7 @@ static int zread_route_add(struct zserv *client, u_short length, struct nexthop *nexthop = NULL; int i, ret; vrf_id_t vrf_id = 0; + struct ipaddr vtep_ip; s = client->ibuf; if (zapi_route_decode(s, &api) < 0) @@ -1173,9 +1174,7 @@ static int zread_route_add(struct zserv *client, u_short length, re, &api_nh->gate.ipv4, NULL, re->vrf_id); break; - case NEXTHOP_TYPE_IPV4_IFINDEX: { - - struct ipaddr vtep_ip; + case NEXTHOP_TYPE_IPV4_IFINDEX: memset(&vtep_ip, 0, sizeof(struct ipaddr)); if (CHECK_FLAG(api.flags, @@ -1208,15 +1207,41 @@ static int zread_route_add(struct zserv *client, u_short length, &api.prefix); } break; - } case NEXTHOP_TYPE_IPV6: nexthop = route_entry_nexthop_ipv6_add( re, &api_nh->gate.ipv6, re->vrf_id); break; case NEXTHOP_TYPE_IPV6_IFINDEX: + memset(&vtep_ip, 0, sizeof(struct ipaddr)); + if (CHECK_FLAG(api.flags, + ZEBRA_FLAG_EVPN_ROUTE)) { + ifindex = + get_l3vni_svi_ifindex(vrf_id); + } else { + ifindex = api_nh->ifindex; + } + nexthop = route_entry_nexthop_ipv6_ifindex_add( - re, &api_nh->gate.ipv6, api_nh->ifindex, + re, &api_nh->gate.ipv6, ifindex, re->vrf_id); + + /* if this an EVPN route entry, + program the nh as neigh + */ + if (CHECK_FLAG(api.flags, + ZEBRA_FLAG_EVPN_ROUTE)) { + SET_FLAG(nexthop->flags, + NEXTHOP_FLAG_EVPN_RVTEP); + vtep_ip.ipa_type = IPADDR_V6; + memcpy(&vtep_ip.ipaddr_v6, + &(api_nh->gate.ipv6), + sizeof(struct in6_addr)); + zebra_vxlan_evpn_vrf_route_add( + vrf_id, + &api.rmac, + &vtep_ip, + &api.prefix); + } break; case NEXTHOP_TYPE_BLACKHOLE: nexthop = route_entry_nexthop_blackhole_add( From 3b7c7293ee18d3c8881f763aa98355f5bc7b7dc6 Mon Sep 17 00:00:00 2001 From: Martin Winter Date: Fri, 23 Feb 2018 08:43:09 -0800 Subject: [PATCH 082/148] doc: Create infodir before writing to it and prefix with DESTDIR Signed-off-by: Martin Winter --- doc/Makefile.am | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index b822a3c685..9d2285a448 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -86,8 +86,9 @@ developer.html: # info target, handled by automake installation install-data-local: frr.info - gzip < user/_build/texinfo/frr.info > ${infodir}/frr.info.gz - install-info user/_build/texinfo/frr.info ${infodir}/dir + install -d ${DESTDIR}${infodir} + gzip < user/_build/texinfo/frr.info > ${DESTDIR}${infodir}/frr.info.gz + install-info user/_build/texinfo/frr.info ${DESTDIR}${infodir}/dir # include sources for shipped docs EXTRA_DIST = manpages/defines.rst \ From 351c56649bfd8487676704a10995d736d1d893cc Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Mar 2018 10:20:36 -0500 Subject: [PATCH 083/148] debianpkg: disable pdf build by default Causes build issues on a certain 7 year old platform with a severely out of date sphinx package, requires a full texinfo distribution to build a package and nobody reads book-style manuals in 2018 anyway, its all about the web docs... Signed-off-by: Quentin Young --- debianpkg/backports/ubuntu12.04/debian/rules | 3 +++ debianpkg/backports/ubuntu14.04/debian/rules | 3 +++ debianpkg/rules | 3 +++ 3 files changed, 9 insertions(+) diff --git a/debianpkg/backports/ubuntu12.04/debian/rules b/debianpkg/backports/ubuntu12.04/debian/rules index fb951965af..83e5e9689e 100755 --- a/debianpkg/backports/ubuntu12.04/debian/rules +++ b/debianpkg/backports/ubuntu12.04/debian/rules @@ -27,6 +27,9 @@ MULTIPATH ?= 256 WANT_FRR_USER ?= frr WANT_FRR_VTY_GROUP ?= frrvty +# Don't build PDF docs by default +GENERATE_PDF ?= 0 + # #################################### diff --git a/debianpkg/backports/ubuntu14.04/debian/rules b/debianpkg/backports/ubuntu14.04/debian/rules index bb5715b78d..64a3d7b63e 100755 --- a/debianpkg/backports/ubuntu14.04/debian/rules +++ b/debianpkg/backports/ubuntu14.04/debian/rules @@ -27,6 +27,9 @@ MULTIPATH ?= 256 WANT_FRR_USER ?= frr WANT_FRR_VTY_GROUP ?= frrvty +# Don't build PDF docs by default +GENERATE_PDF ?= 0 + # #################################### diff --git a/debianpkg/rules b/debianpkg/rules index 14294f54fe..46f8f48028 100755 --- a/debianpkg/rules +++ b/debianpkg/rules @@ -27,6 +27,9 @@ MULTIPATH ?= 256 WANT_FRR_USER ?= frr WANT_FRR_VTY_GROUP ?= frrvty +# Don't build PDF docs by default +GENERATE_PDF ?= 0 + # #################################### From 6caf40e7b2c07de77fb950dc3c3b3f0c9c78487c Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Mar 2018 11:37:15 -0500 Subject: [PATCH 084/148] debianpkg: include mtracebis.8 Signed-off-by: Quentin Young --- debianpkg/frr.manpages | 1 + 1 file changed, 1 insertion(+) diff --git a/debianpkg/frr.manpages b/debianpkg/frr.manpages index 51f82d0889..d4bb920b46 100644 --- a/debianpkg/frr.manpages +++ b/debianpkg/frr.manpages @@ -12,3 +12,4 @@ doc/manpages/_build/man/vtysh.1 doc/manpages/_build/man/zebra.8 doc/manpages/_build/man/isisd.8 doc/manpages/_build/man/watchfrr.8 +doc/manpages/_build/man/mtracebis.8 From 0f2ac0c5bacf4d487e0571ee6468b04cd564c30b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 1 Mar 2018 11:53:16 -0500 Subject: [PATCH 085/148] doc: s/environment/make Error message for missing sphinx-build wasn't clear enough when explaining how to change the path to the sphinx-build binary as it said 'environment variable' instead of 'make variable' Signed-off-by: Quentin Young --- doc/developer/Makefile | 2 +- doc/user/Makefile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/developer/Makefile b/doc/developer/Makefile index 329e455de6..640a1ace38 100644 --- a/doc/developer/Makefile +++ b/doc/developer/Makefile @@ -12,7 +12,7 @@ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) SPHINXBUILD = sphinx-1.0-build endif ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. diff --git a/doc/user/Makefile b/doc/user/Makefile index 329e455de6..640a1ace38 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -12,7 +12,7 @@ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) SPHINXBUILD = sphinx-1.0-build endif ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. From 558283638bb50ff24ea28bab89c1bb4c89ccc3dd Mon Sep 17 00:00:00 2001 From: vivek Date: Thu, 1 Mar 2018 19:50:46 +0000 Subject: [PATCH 086/148] lib, zebra: Fix warnings Signed-off-by: Vivek Venkatraman --- lib/ipaddr.h | 1 + zebra/zserv.c | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/ipaddr.h b/lib/ipaddr.h index 3857b83027..e8dbe9cf09 100644 --- a/lib/ipaddr.h +++ b/lib/ipaddr.h @@ -90,6 +90,7 @@ static inline void ipv4_to_ipv4_mapped_ipv6(struct in6_addr *in6, struct in_addr in) { u_int32_t addr_type = htonl(0xFFFF); + memset(in6, 0, sizeof(struct in6_addr)); memcpy((char *)in6 + 8, &addr_type, sizeof(addr_type)); memcpy((char *)in6 + 12, &in, sizeof(struct in_addr)); diff --git a/zebra/zserv.c b/zebra/zserv.c index 983b04ed91..1fc2bfd309 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -1190,7 +1190,7 @@ static int zread_route_add(struct zserv *client, u_short length, re->vrf_id); /* if this an EVPN route entry, - program the nh as neigh + * program the nh as neigh */ if (CHECK_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE)) { @@ -1226,7 +1226,7 @@ static int zread_route_add(struct zserv *client, u_short length, re->vrf_id); /* if this an EVPN route entry, - program the nh as neigh + * program the nh as neigh */ if (CHECK_FLAG(api.flags, ZEBRA_FLAG_EVPN_ROUTE)) { From 609dee9d83f720e6767e1065837faaa746bde361 Mon Sep 17 00:00:00 2001 From: Martin Winter Date: Mon, 26 Feb 2018 07:45:19 -0800 Subject: [PATCH 087/148] redhat: Update spec file for new rst documentation Signed-off-by: Martin Winter --- redhat/frr.spec.in | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/redhat/frr.spec.in b/redhat/frr.spec.in index 20b96bb76f..9c7848499a 100644 --- a/redhat/frr.spec.in +++ b/redhat/frr.spec.in @@ -135,14 +135,14 @@ URL: http://www.frrouting.org Requires(pre): /sbin/install-info Requires(preun): /sbin/install-info Requires(post): /sbin/install-info -BuildRequires: gcc texi2html texinfo patch libcap-devel groff +BuildRequires: gcc patch libcap-devel BuildRequires: readline readline-devel ncurses ncurses-devel BuildRequires: json-c-devel bison >= 2.7 flex make %if 0%{?rhel} && 0%{?rhel} < 7 #python27-devel is available from ius community repo for RedHat/CentOS 6 -BuildRequires: python27-devel +BuildRequires: python27-devel python-sphinx10 %else -BuildRequires: python-devel >= 2.7 +BuildRequires: python-devel >= 2.7 python-sphinx %endif Requires: ncurses json-c initscripts %if %{with_pam} @@ -169,7 +169,7 @@ protocol. It takes multi-server and multi-thread approach to resolve the current complexity of the Internet. FRRouting supports BGP4, OSPFv2, OSPFv3, ISIS, RIP, RIPng, PIM, LDP -NHRP and EIGRP. +NHRP, Babel and EIGRP. FRRouting is a fork of Quagga. @@ -302,11 +302,7 @@ developing OSPF-API and frr applications. make %{?_smp_mflags} MAKEINFO="makeinfo --no-split" pushd doc -if [ $(texi2html --version | cut -d. -f1) -lt 5 ]; then -texi2html --number-sections frr.texi -else -texi2html --number-footnotes --number-sections frr.texi -fi +make frr.info popd %install @@ -506,7 +502,6 @@ rm -rf %{buildroot} %files %defattr(-,root,root) %doc */*.sample* AUTHORS COPYING -%doc doc/frr.html %doc doc/mpls %doc ChangeLog INSTALL NEWS README REPORTING-BUGS SERVICES %if 0%{?frr_user:1} @@ -602,7 +597,10 @@ rm -rf %{buildroot} %endif %changelog -* Fri Oct 20 2017 Martin Winter - %{version} +* Tue Feb 20 2018 Martin Winter - %{version} +- Adapt to new documentation structure based on Sphinx + +* Fri Oct 20 2017 Martin Winter - Fix script location for watchfrr restart functions in daemon config - Fix postun script to restart frr during upgrade From ccd40deecef225dd973719a1101f2519641d7331 Mon Sep 17 00:00:00 2001 From: Martin Winter Date: Thu, 1 Mar 2018 13:28:57 -0800 Subject: [PATCH 088/148] redhat: Update CentOS6 to use python27-sphinx package sphinx > 1.1 is needed which is provided by the non-standard python27-sphinx for CentOS 6 / RedHat 6 Signed-off-by: Martin Winter --- redhat/frr.spec.in | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/redhat/frr.spec.in b/redhat/frr.spec.in index 9c7848499a..310d7ab939 100644 --- a/redhat/frr.spec.in +++ b/redhat/frr.spec.in @@ -37,6 +37,13 @@ # defines for configure %define _localstatedir /var/run/frr + +# define for sphinx-build binary +%if 0%{?rhel} && 0%{?rhel} < 7 +%define sphinx sphinx-build2.7 +%else +%define sphinx sphinx-build +%endif ############################################################################ #### Version String tweak @@ -140,7 +147,7 @@ BuildRequires: readline readline-devel ncurses ncurses-devel BuildRequires: json-c-devel bison >= 2.7 flex make %if 0%{?rhel} && 0%{?rhel} < 7 #python27-devel is available from ius community repo for RedHat/CentOS 6 -BuildRequires: python27-devel python-sphinx10 +BuildRequires: python27-devel python27-sphinx %else BuildRequires: python-devel >= 2.7 python-sphinx %endif @@ -299,16 +306,16 @@ developing OSPF-API and frr applications. %endif --enable-poll=yes -make %{?_smp_mflags} MAKEINFO="makeinfo --no-split" +make %{?_smp_mflags} MAKEINFO="makeinfo --no-split" SPHINXBUILD=%{sphinx} pushd doc -make frr.info +make SPHINXBUILD=%{sphinx} frr.info popd %install mkdir -p %{buildroot}/etc/{frr,sysconfig,logrotate.d,pam.d,default} \ %{buildroot}/var/log/frr %{buildroot}%{_infodir} -make DESTDIR=%{buildroot} INSTALL="install -p" CP="cp -p" install +make DESTDIR=%{buildroot} INSTALL="install -p" CP="cp -p" SPHINXBUILD=%{sphinx} install # Remove this file, as it is uninstalled and causes errors when building on RH9 rm -rf %{buildroot}/usr/share/info/dir From 24a532dcc24e5d7c76d5dce0ff94669b346c2a3e Mon Sep 17 00:00:00 2001 From: Martin Winter Date: Thu, 1 Mar 2018 14:49:52 -0800 Subject: [PATCH 089/148] doc: Update Building instructions for CentOS6 - Added warning for CentOS 6 support to be limited - Added instructions for installing sphinx27-build manually Signed-off-by: Martin Winter --- doc/developer/Building_FRR_on_CentOS6.rst | 40 ++++++++++++++++++++--- 1 file changed, 36 insertions(+), 4 deletions(-) diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst index c138eb11a3..ca18f743c4 100644 --- a/doc/developer/Building_FRR_on_CentOS6.rst +++ b/doc/developer/Building_FRR_on_CentOS6.rst @@ -7,6 +7,16 @@ in redhat/README.rpm\_build.md on how to build a rpm package) Instructions are tested with ``CentOS 6.8`` on ``x86_64`` platform +Warning: +-------- +``CentOS 6`` is very old and not fully supported by the FRR community +anymore. Building FRR takes multiple manual steps to update the build +system with newer packages than what's available from the archives. +However, the built packages can still be installed afterwards on +a standard ``CentOS 6`` without any special packages. + +Support for CentOS 6 is now on a best-effort base by the community. + CentOS 6 restrictions: ---------------------- @@ -20,6 +30,10 @@ CentOS 6 restrictions: - frr\_reload.py will not work, as this requires Python 2.7, and CentOS 6 only has 2.6. You can install Python 2.7 via IUS, but it won't work properly unless you compile and install the ipaddr package for it. +- Building the package requires Sphinx >= 1.1. Only a non-standard + package provides a newer sphinx and requires manual installation + (see below) + Install required packages ------------------------- @@ -31,7 +45,7 @@ Add packages: sudo yum install git autoconf automake libtool make gawk \ readline-devel texinfo net-snmp-devel groff pkgconfig \ json-c-devel pam-devel flex epel-release perl-XML-LibXML \ - c-ares-devel python-sphinx10 + c-ares-devel Install newer version of bison (CentOS 6 package source is too old) from CentOS 7 @@ -80,6 +94,24 @@ Please note that ``CentOS 6`` needs to keep python pointing to version 2.6 for ``yum`` to keep working, so don't create a symlink for python2.7 to python +Install newer ``Sphinx-Build`` based on ``Python 2.7`` + +:: + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-babel-0.9.6-2.sdl6.1.noarch.rpm + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-jinja2-2.7.2-2.sdl6.noarch.rpm + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-markupsafe-0.11-4.puias6.x86_64.rpm + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-pygments-1.4-4.sdl6.1.noarch.rpm + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-docutils-0.8.1-3.sdl6.2.noarch.rpm + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-imaging-1.1.7-6.puias6.x86_64.rpm + curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-sphinx-1.1.3-1.sdl6.1.noarch.rpm + sudo yum install ./python27-markupsafe-0.11-4.puias6.x86_64.rpm \ + ./python27-babel-0.9.6-2.sdl6.1.noarch.rpm \ + ./python27-jinja2-2.7.2-2.sdl6.noarch.rpm \ + ./python27-pygments-1.4-4.sdl6.1.noarch.rpm \ + ./python27-docutils-0.8.1-3.sdl6.2.noarch.rpm \ + ./python27-imaging-1.1.7-6.puias6.x86_64.rpm \ + ./python27-sphinx-1.1.3-1.sdl6.1.noarch.rpm + Get FRR, compile it and install it (from Git) --------------------------------------------- @@ -133,9 +165,9 @@ an example.) --enable-babeld \ --with-pkg-git-version \ --with-pkg-extra-version=-MyOwnFRRVersion - make - make check PYTHON=/usr/bin/python2.7 - sudo make install + make SPHINXBUILD=sphinx-build2.7 + make check PYTHON=/usr/bin/python2.7 SPHINXBUILD=sphinx-build2.7 + sudo make SPHINXBUILD=sphinx-build2.7 install Create empty FRR configuration files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 7fd077aadd54598f8764003d9b96fde1e30c2701 Mon Sep 17 00:00:00 2001 From: vivek Date: Sun, 4 Mar 2018 03:28:50 +0000 Subject: [PATCH 090/148] bgpd: Parse PMSI Tunnel Attribute and display Received PMSI tunnel attributes (in EVPN type-3 route) were not recognized. Parse them and display the tunnel type when looking at routes. Note that the only tunnel type currently supported is ingress replication (IR). A warning message will be logged if the received tunnel type is something else, but the attribute is otherwise ignored. Updates: a21bd7a (bgpd: add PMSI_TUNNEL_ATTRIBUTE to EVPN IMET routes) Signed-off-by: Vivek Venkatraman --- bgpd/bgp_attr.c | 50 +++++++++++++++++++++++++++++++++++++++++++++++- bgpd/bgp_attr.h | 17 ++++++++++++++++ bgpd/bgp_debug.c | 7 +++++++ bgpd/bgp_evpn.c | 14 ++++++++++++++ bgpd/bgp_route.c | 17 ++++++++++++++++ 5 files changed, 104 insertions(+), 1 deletion(-) diff --git a/bgpd/bgp_attr.c b/bgpd/bgp_attr.c index 3f3acbe0e2..56303a3df5 100644 --- a/bgpd/bgp_attr.c +++ b/bgpd/bgp_attr.c @@ -2114,6 +2114,51 @@ bgp_attr_prefix_sid(struct bgp_attr_parser_args *args, return BGP_ATTR_PARSE_PROCEED; } +/* PMSI tunnel attribute (RFC 6514) + * Basic validation checks done here. + */ +static bgp_attr_parse_ret_t +bgp_attr_pmsi_tunnel(struct bgp_attr_parser_args *args) +{ + struct peer *const peer = args->peer; + struct attr *const attr = args->attr; + const bgp_size_t length = args->length; + u_int8_t tnl_type; + + /* Verify that the receiver is expecting "ingress replication" as we + * can only support that. + */ + if (length < 2) { + zlog_err("Bad PMSI tunnel attribute length %d", length); + return bgp_attr_malformed(args, BGP_NOTIFY_UPDATE_ATTR_LENG_ERR, + args->total); + } + stream_getc(peer->curr); /* Flags */ + tnl_type = stream_getc(peer->curr); + if (tnl_type > PMSI_TNLTYPE_MAX) { + zlog_err("Invalid PMSI tunnel attribute type %d", tnl_type); + return bgp_attr_malformed(args, BGP_NOTIFY_UPDATE_OPT_ATTR_ERR, + args->total); + } + if (tnl_type == PMSI_TNLTYPE_INGR_REPL) { + if (length != 9) { + zlog_err("Bad PMSI tunnel attribute length %d for IR", + length); + return bgp_attr_malformed(args, + BGP_NOTIFY_UPDATE_ATTR_LENG_ERR, + args->total); + } + } + + attr->flag |= ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL); + attr->pmsi_tnl_type = tnl_type; + + /* Forward read pointer of input stream. */ + stream_forward_getp(peer->curr, length - 2); + + return BGP_ATTR_PARSE_PROCEED; +} + /* BGP unknown attribute treatment. */ static bgp_attr_parse_ret_t bgp_attr_unknown(struct bgp_attr_parser_args *args) { @@ -2447,6 +2492,9 @@ bgp_attr_parse_ret_t bgp_attr_parse(struct peer *peer, struct attr *attr, case BGP_ATTR_PREFIX_SID: ret = bgp_attr_prefix_sid(&attr_args, mp_update); break; + case BGP_ATTR_PMSI_TUNNEL: + ret = bgp_attr_pmsi_tunnel(&attr_args); + break; default: ret = bgp_attr_unknown(&attr_args); break; @@ -3263,7 +3311,7 @@ bgp_size_t bgp_packet_attribute(struct bgp *bgp, struct peer *peer, stream_putc(s, BGP_ATTR_PMSI_TUNNEL); stream_putc(s, 9); // Length stream_putc(s, 0); // Flags - stream_putc(s, 6); // Tunnel type: Ingress Replication (6) + stream_putc(s, PMSI_TNLTYPE_INGR_REPL); // IR (6) stream_put(s, &(attr->label), BGP_LABEL_BYTES); // MPLS Label / VXLAN VNI stream_put_ipv4(s, attr->nexthop.s_addr); // Unicast tunnel endpoint IP address } diff --git a/bgpd/bgp_attr.h b/bgpd/bgp_attr.h index 1b1471a198..c60fbd323d 100644 --- a/bgpd/bgp_attr.h +++ b/bgpd/bgp_attr.h @@ -66,6 +66,8 @@ #define BGP_PREFIX_SID_IPV6_LENGTH 19 #define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH 6 +/* PMSI tunnel types (RFC 6514) */ + struct bgp_attr_encap_subtlv { struct bgp_attr_encap_subtlv *next; /* for chaining */ /* Reference count of this attribute. */ @@ -96,6 +98,18 @@ struct overlay_index { union gw_addr gw_ip; }; +enum pta_type { + PMSI_TNLTYPE_NO_INFO, + PMSI_TNLTYPE_RSVP_TE_P2MP, + PMSI_TNLTYPE_MLDP_P2MP, + PMSI_TNLTYPE_PIM_SSM, + PMSI_TNLTYPE_PIM_SM, + PMSI_TNLTYPE_PIM_BIDIR, + PMSI_TNLTYPE_INGR_REPL, + PMSI_TNLTYPE_MLDP_MP2MP, + PMSI_TNLTYPE_MAX = PMSI_TNLTYPE_MLDP_MP2MP +}; + /* BGP core attribute structure. */ struct attr { /* AS Path structure */ @@ -119,6 +133,9 @@ struct attr { /* Path origin attribute */ u_char origin; + /* PMSI tunnel type (RFC 6514). */ + enum pta_type pmsi_tnl_type; + /* has the route-map changed any attribute? Used on the peer outbound side. */ u_int32_t rmap_change_flags; diff --git a/bgpd/bgp_debug.c b/bgpd/bgp_debug.c index e89f399e41..1c9c92044c 100644 --- a/bgpd/bgp_debug.c +++ b/bgpd/bgp_debug.c @@ -159,6 +159,9 @@ static const struct message bgp_notify_capability_msg[] = { /* Origin strings. */ const char *bgp_origin_str[] = {"i", "e", "?"}; const char *bgp_origin_long_str[] = {"IGP", "EGP", "incomplete"}; +const char *pmsi_tnltype_str[] = {"No info", "RSVP-TE P2MP", "mLDP P2MP", + "PIM-SSM", "PIM-SM", "PIM-BIDIR", + "Ingress Replication", "mLDP MP2MP"}; /* Given a string return a pointer the corresponding peer structure */ @@ -415,6 +418,10 @@ int bgp_dump_attr(struct attr *attr, char *buf, size_t size) inet_ntoa(attr->cluster->list[i])); } + if (CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL))) + snprintf(buf + strlen(buf), size - strlen(buf), ", pmsi tnltype %u", + attr->pmsi_tnl_type); + if (CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_AS_PATH))) snprintf(buf + strlen(buf), size - strlen(buf), ", path %s", aspath_print(attr->aspath)); diff --git a/bgpd/bgp_evpn.c b/bgpd/bgp_evpn.c index a8ee14c72e..9e4a5172df 100644 --- a/bgpd/bgp_evpn.c +++ b/bgpd/bgp_evpn.c @@ -2932,6 +2932,20 @@ static int process_type3_route(struct peer *peer, afi_t afi, safi_t safi, return -1; } + /* If PMSI is present, log if it is anything other than IR. + * Note: We just simply ignore the values as it is not clear if + * doing anything else is better. + */ + if (attr && + (attr->flag & ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL))) { + if (attr->pmsi_tnl_type != PMSI_TNLTYPE_INGR_REPL) { + zlog_warn("%u:%s - Rx EVPN Type-3 NLRI with " + "unsupported PTA %d", + peer->bgp->vrf_id, peer->host, + attr->pmsi_tnl_type); + } + } + /* Make prefix_rd */ prd.family = AF_UNSPEC; prd.prefixlen = 64; diff --git a/bgpd/bgp_route.c b/bgpd/bgp_route.c index 20bf9635a3..93570f4a3c 100644 --- a/bgpd/bgp_route.c +++ b/bgpd/bgp_route.c @@ -81,6 +81,7 @@ /* Extern from bgp_dump.c */ extern const char *bgp_origin_str[]; extern const char *bgp_origin_long_str[]; +extern const char *pmsi_tnltype_str[]; struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi, safi_t safi, struct prefix *p, @@ -7035,6 +7036,7 @@ void route_vty_out_detail(struct vty *vty, struct bgp *bgp, struct prefix *p, json_object *json_ext_community = NULL; json_object *json_lcommunity = NULL; json_object *json_last_update = NULL; + json_object *json_pmsi = NULL; json_object *json_nexthop_global = NULL; json_object *json_nexthop_ll = NULL; json_object *json_nexthops = NULL; @@ -7787,6 +7789,21 @@ void route_vty_out_detail(struct vty *vty, struct bgp *bgp, struct prefix *p, json_last_update); } else vty_out(vty, " Last update: %s", ctime(&tbuf)); + + /* Line 10 display PMSI tunnel attribute, if present */ + if (attr->flag & ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL)) { + if (json_paths) { + json_pmsi = json_object_new_object(); + json_object_string_add( + json_pmsi, "tunnelType", + pmsi_tnltype_str[attr->pmsi_tnl_type]); + json_object_object_add(json_path, "pmsi", + json_pmsi); + } else + vty_out(vty, " PMSI Tunnel Type: %s\n", + pmsi_tnltype_str[attr->pmsi_tnl_type]); + } + } /* We've constructed the json object for this path, add it to the json From 052ea98b431598466e939575df2992b483524587 Mon Sep 17 00:00:00 2001 From: vivek Date: Sun, 4 Mar 2018 06:56:19 +0000 Subject: [PATCH 091/148] bgpd: Fix warnings Signed-off-by: Vivek Venkatraman --- bgpd/bgp_attr.c | 8 ++++---- bgpd/bgp_debug.c | 4 ++-- bgpd/bgp_debug.h | 1 + bgpd/bgp_route.c | 1 - 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/bgpd/bgp_attr.c b/bgpd/bgp_attr.c index 56303a3df5..73256046f6 100644 --- a/bgpd/bgp_attr.c +++ b/bgpd/bgp_attr.c @@ -2143,10 +2143,10 @@ bgp_attr_pmsi_tunnel(struct bgp_attr_parser_args *args) if (tnl_type == PMSI_TNLTYPE_INGR_REPL) { if (length != 9) { zlog_err("Bad PMSI tunnel attribute length %d for IR", - length); - return bgp_attr_malformed(args, - BGP_NOTIFY_UPDATE_ATTR_LENG_ERR, - args->total); + length); + return bgp_attr_malformed( + args, BGP_NOTIFY_UPDATE_ATTR_LENG_ERR, + args->total); } } diff --git a/bgpd/bgp_debug.c b/bgpd/bgp_debug.c index 1c9c92044c..8b308c8f3e 100644 --- a/bgpd/bgp_debug.c +++ b/bgpd/bgp_debug.c @@ -419,8 +419,8 @@ int bgp_dump_attr(struct attr *attr, char *buf, size_t size) } if (CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL))) - snprintf(buf + strlen(buf), size - strlen(buf), ", pmsi tnltype %u", - attr->pmsi_tnl_type); + snprintf(buf + strlen(buf), size - strlen(buf), + ", pmsi tnltype %u", attr->pmsi_tnl_type); if (CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_AS_PATH))) snprintf(buf + strlen(buf), size - strlen(buf), ", path %s", diff --git a/bgpd/bgp_debug.h b/bgpd/bgp_debug.h index 765e43f5b4..10a1e3159f 100644 --- a/bgpd/bgp_debug.h +++ b/bgpd/bgp_debug.h @@ -136,6 +136,7 @@ struct bgp_debug_filter { #define CONF_BGP_DEBUG(a, b) (conf_bgp_debug_ ## a & BGP_DEBUG_ ## b) extern const char *bgp_type_str[]; +extern const char *pmsi_tnltype_str[]; extern int bgp_dump_attr(struct attr *, char *, size_t); extern int bgp_debug_peer_updout_enabled(char *host); diff --git a/bgpd/bgp_route.c b/bgpd/bgp_route.c index 93570f4a3c..d9d8280027 100644 --- a/bgpd/bgp_route.c +++ b/bgpd/bgp_route.c @@ -81,7 +81,6 @@ /* Extern from bgp_dump.c */ extern const char *bgp_origin_str[]; extern const char *bgp_origin_long_str[]; -extern const char *pmsi_tnltype_str[]; struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi, safi_t safi, struct prefix *p, From e221d227e32e474b7a9cd21861fcec90cd158fcb Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 5 Mar 2018 11:03:27 -0500 Subject: [PATCH 092/148] doc: allow env var to ovveride sphinx defaults Signed-off-by: Quentin Young --- doc/developer/Makefile | 6 +++--- doc/user/Makefile | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/developer/Makefile b/doc/developer/Makefile index 640a1ace38..f5e7cb60ec 100644 --- a/doc/developer/Makefile +++ b/doc/developer/Makefile @@ -2,9 +2,9 @@ # # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +PAPER ?= BUILDDIR = _build # User-friendly check for sphinx-build diff --git a/doc/user/Makefile b/doc/user/Makefile index 640a1ace38..f5e7cb60ec 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -2,9 +2,9 @@ # # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +PAPER ?= BUILDDIR = _build # User-friendly check for sphinx-build From d8a8a8de00ca28879eb865cd4f25e362570a910e Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 5 Mar 2018 17:58:22 -0500 Subject: [PATCH 093/148] lib: some frr_pthread fixes * Use atomic fixed-width thread identifiers * Add ability to change thread name at runtime Signed-off-by: Quentin Young --- bgpd/bgpd.c | 6 ++---- lib/frr_pthread.c | 41 +++++++++++++++++++++++++++++++---------- lib/frr_pthread.h | 34 +++++++++++++++++++++++++++++----- lib/thread.c | 12 +++++++++++- lib/thread.h | 1 + 5 files changed, 74 insertions(+), 20 deletions(-) diff --git a/bgpd/bgpd.c b/bgpd/bgpd.c index c06339aad9..ed0a12f052 100644 --- a/bgpd/bgpd.c +++ b/bgpd/bgpd.c @@ -7528,16 +7528,14 @@ static void bgp_pthreads_init() .id = PTHREAD_IO, .start = frr_pthread_attr_default.start, .stop = frr_pthread_attr_default.stop, - .name = "BGP I/O thread", }; struct frr_pthread_attr ka = { .id = PTHREAD_KEEPALIVES, .start = bgp_keepalives_start, .stop = bgp_keepalives_stop, - .name = "BGP Keepalives thread", }; - frr_pthread_new(&io); - frr_pthread_new(&ka); + frr_pthread_new(&io, "BGP I/O thread"); + frr_pthread_new(&ka, "BGP Keepalives thread"); } void bgp_pthreads_run() diff --git a/lib/frr_pthread.c b/lib/frr_pthread.c index 72b47ae5c3..ba6d89429a 100644 --- a/lib/frr_pthread.c +++ b/lib/frr_pthread.c @@ -1,6 +1,6 @@ /* * Utilities and interfaces for managing POSIX threads within FRR. - * Copyright (C) 2017 Cumulus Networks + * Copyright (C) 2017 Cumulus Networks, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -29,7 +29,7 @@ DEFINE_MTYPE(LIB, FRR_PTHREAD, "FRR POSIX Thread"); DEFINE_MTYPE(LIB, PTHREAD_PRIM, "POSIX synchronization primitives"); /* id for next created pthread */ -static unsigned int next_id = 0; +static _Atomic uint32_t next_id = 0; /* default frr_pthread start/stop routine prototypes */ static void *fpt_run(void *arg); @@ -40,7 +40,6 @@ struct frr_pthread_attr frr_pthread_attr_default = { .id = 0, .start = fpt_run, .stop = fpt_halt, - .name = "Anonymous", }; /* hash table to keep track of all frr_pthreads */ @@ -85,9 +84,10 @@ void frr_pthread_finish() pthread_mutex_unlock(&frr_pthread_hash_mtx); } -struct frr_pthread *frr_pthread_new(struct frr_pthread_attr *attr) +struct frr_pthread *frr_pthread_new(struct frr_pthread_attr *attr, + const char *name) { - static struct frr_pthread holder = {0}; + static struct frr_pthread holder = {}; struct frr_pthread *fpt = NULL; attr = attr ? attr : &frr_pthread_attr_default; @@ -99,10 +99,14 @@ struct frr_pthread *frr_pthread_new(struct frr_pthread_attr *attr) if (!hash_lookup(frr_pthread_hash, &holder)) { fpt = XCALLOC(MTYPE_FRR_PTHREAD, sizeof(struct frr_pthread)); + /* initialize mutex */ + pthread_mutex_init(&fpt->mtx, NULL); /* create new thread master */ - fpt->master = thread_master_create(attr->name); + fpt->master = thread_master_create(name); /* set attributes */ fpt->attr = *attr; + name = (name ? name : "Anonymous thread"); + fpt->name = XSTRDUP(MTYPE_FRR_PTHREAD, name); if (attr == &frr_pthread_attr_default) fpt->attr.id = frr_pthread_get_id(); /* initialize startup synchronization primitives */ @@ -126,16 +130,31 @@ void frr_pthread_destroy(struct frr_pthread *fpt) { thread_master_free(fpt->master); + pthread_mutex_destroy(&fpt->mtx); pthread_mutex_destroy(fpt->running_cond_mtx); pthread_cond_destroy(fpt->running_cond); + if (fpt->name) + XFREE(MTYPE_FRR_PTHREAD, fpt->name); XFREE(MTYPE_PTHREAD_PRIM, fpt->running_cond_mtx); XFREE(MTYPE_PTHREAD_PRIM, fpt->running_cond); XFREE(MTYPE_FRR_PTHREAD, fpt); } +void frr_pthread_set_name(struct frr_pthread *fpt, const char *name) +{ + pthread_mutex_lock(&fpt->mtx); + { + if (fpt->name) + XFREE(MTYPE_FRR_PTHREAD, fpt->name); + fpt->name = XSTRDUP(MTYPE_FRR_PTHREAD, name); + } + pthread_mutex_unlock(&fpt->mtx); + thread_master_set_name(fpt->master, name); +} + struct frr_pthread *frr_pthread_get(unsigned int id) { - static struct frr_pthread holder = {0}; + static struct frr_pthread holder = {}; struct frr_pthread *fpt; pthread_mutex_lock(&frr_pthread_hash_mtx); @@ -210,11 +229,13 @@ void frr_pthread_stop_all() pthread_mutex_unlock(&frr_pthread_hash_mtx); } -unsigned int frr_pthread_get_id() +uint32_t frr_pthread_get_id() { + _Atomic uint32_t nxid; + nxid = atomic_fetch_add_explicit(&next_id, 1, memory_order_seq_cst); /* just a sanity check, this should never happen */ - assert(next_id <= INT_MAX - 1); - return next_id++; + assert(nxid <= (INT_MAX - 1)); + return nxid; } void frr_pthread_yield(void) diff --git a/lib/frr_pthread.h b/lib/frr_pthread.h index 2cc50196a8..3990e2a4ce 100644 --- a/lib/frr_pthread.h +++ b/lib/frr_pthread.h @@ -1,6 +1,6 @@ /* * Utilities and interfaces for managing POSIX threads within FRR. - * Copyright (C) 2017 Cumulus Networks + * Copyright (C) 2017 Cumulus Networks, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -32,14 +32,19 @@ struct frr_pthread; struct frr_pthread_attr; struct frr_pthread_attr { - int id; + _Atomic uint32_t id; void *(*start)(void *); int (*stop)(struct frr_pthread *, void **); - const char *name; }; struct frr_pthread { + /* + * Mutex protecting this structure. Must be taken for reading some + * fields, denoted by a 'Requires: mtx'. + */ + pthread_mutex_t mtx; + /* pthread id */ pthread_t thread; @@ -73,8 +78,17 @@ struct frr_pthread { * Fake thread-specific storage. No constraints on usage. Helpful when * creating reentrant pthread implementations. Can be used to pass * argument to pthread entry function. + * + * Requires: mtx */ void *data; + + /* + * Human-readable thread name. + * + * Requires: mtx + */ + char *name; }; extern struct frr_pthread_attr frr_pthread_attr_default; @@ -107,9 +121,19 @@ void frr_pthread_finish(void); * frr_pthread will cause them to run on that pthread. * * @param attr - the thread attributes + * @param name - Human-readable name * @return the created frr_pthread upon success, or NULL upon failure */ -struct frr_pthread *frr_pthread_new(struct frr_pthread_attr *attr); +struct frr_pthread *frr_pthread_new(struct frr_pthread_attr *attr, + const char *name); + +/* + * Changes the name of the frr_pthread. + * + * @param fpt - the frr_pthread to operate on + * @param name - Human-readable name + */ +void frr_pthread_set_name(struct frr_pthread *fpt, const char *name); /* * Destroys an frr_pthread. @@ -198,6 +222,6 @@ void frr_pthread_yield(void); * * @return unique identifier */ -unsigned int frr_pthread_get_id(void); +uint32_t frr_pthread_get_id(void); #endif /* _FRR_PTHREAD_H */ diff --git a/lib/thread.c b/lib/thread.c index 9d64663d9c..868bfd0e9b 100644 --- a/lib/thread.c +++ b/lib/thread.c @@ -343,7 +343,6 @@ static void initializer() pthread_key_create(&thread_current, NULL); } -/* Allocate new thread master. */ struct thread_master *thread_master_create(const char *name) { struct thread_master *rv; @@ -427,6 +426,17 @@ struct thread_master *thread_master_create(const char *name) return rv; } +void thread_master_set_name(struct thread_master *master, const char *name) +{ + pthread_mutex_lock(&master->mtx); + { + if (master->name) + XFREE(MTYPE_THREAD_MASTER, master->name); + master->name = XSTRDUP(MTYPE_THREAD_MASTER, name); + } + pthread_mutex_unlock(&master->mtx); +} + /* Add a new thread to the list. */ static void thread_list_add(struct thread_list *list, struct thread *thread) { diff --git a/lib/thread.h b/lib/thread.h index c830446e10..f7c110914d 100644 --- a/lib/thread.h +++ b/lib/thread.h @@ -174,6 +174,7 @@ struct cpu_thread_history { /* Prototypes. */ extern struct thread_master *thread_master_create(const char *); +void thread_master_set_name(struct thread_master *master, const char *name); extern void thread_master_free(struct thread_master *); extern void thread_master_free_unused(struct thread_master *); From e207a4b589a489649cdb06b2c824dc6948158b21 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 10:33:21 -0500 Subject: [PATCH 094/148] doc: prevent `clean` target from building manpages Unconditional automake subdirectory flag = 'man' causes manpages to always be built regardless of target, which is undesirable for `clean`. Remove unconditional flag and override automake targets that need to build manpages instead. Signed-off-by: Quentin Young --- doc/Makefile.am | 1 - doc/developer/Makefile | 2 +- doc/manpages/Makefile | 17 +++++++++++++---- doc/user/Makefile | 2 +- 4 files changed, 15 insertions(+), 7 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index d8244edca4..4a9b0525a5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,7 +2,6 @@ # Tell Automake to invoke 'make' in the manpages directory with argument 'man' SUBDIRS = manpages -AM_MAKEFLAGS = man MANPAGE_BUILDDIR = manpages/_build/man diff --git a/doc/developer/Makefile b/doc/developer/Makefile index f5e7cb60ec..f5aca7a655 100644 --- a/doc/developer/Makefile +++ b/doc/developer/Makefile @@ -12,7 +12,7 @@ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) SPHINXBUILD = sphinx-1.0-build endif ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") endif # Internal variables. diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile index 3f0c8f55ae..33a3af1f14 100644 --- a/doc/manpages/Makefile +++ b/doc/manpages/Makefile @@ -2,14 +2,17 @@ # # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +PAPER ?= BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +SPHINXBUILD = sphinx-1.0-build +endif +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") endif # Internal variables. @@ -215,4 +218,10 @@ pseudoxml: @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +.PHONY: install-data +install-data: man + +.PHONY: all +all: install-data + %: ; diff --git a/doc/user/Makefile b/doc/user/Makefile index f5e7cb60ec..f5aca7a655 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -12,7 +12,7 @@ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) SPHINXBUILD = sphinx-1.0-build endif ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") endif # Internal variables. From e3e3afffc966dd25e3cb2a28573729ff7322d6e3 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 10:50:30 -0500 Subject: [PATCH 095/148] doc: sync ospf-sr docs from master 7666589034ef51aa56e8530031c7fa08f81f4c58 Signed-off-by: Quentin Young --- doc/developer/ospf-sr.rst | 64 ++++++++++++++++++++++++--------------- doc/user/ospfd.rst | 7 +++-- 2 files changed, 44 insertions(+), 27 deletions(-) diff --git a/doc/developer/ospf-sr.rst b/doc/developer/ospf-sr.rst index 0ee1a12f28..3f8b549df3 100644 --- a/doc/developer/ospf-sr.rst +++ b/doc/developer/ospf-sr.rst @@ -5,6 +5,26 @@ This is an EXPERIMENTAL support of draft `draft-ietf-ospf-segment-routing-extensions-24`. DON'T use it for production network. +Supported Features +------------------ + +* Automatic computation of Primary and Backup Adjacency SID with + Cisco experimental remote IP address +* SRGB configuration +* Prefix configuration for Node SID with optional NO-PHP flag (Linux + kernel support both mode) +* Node MSD configuration (with Linux Kernel >= 4.10 a maximum of 32 labels + could be stack) +* Automatic provisioning of MPLS table +* Static route configuration with label stack up to 32 labels + +Interoperability +---------------- + +* Tested on various topology including point-to-point and LAN interfaces + in a mix of Free Range Routing instance and Cisco IOS-XR 6.0.x +* Check OSPF LSA conformity with latest wireshark release 2.5.0-rc + Implementation details ---------------------- @@ -176,17 +196,17 @@ yourself: :: - modprobe mpls_router - modprobe mpls_gso - modprobe mpls_iptunnel + modprobe mpls_router + modprobe mpls_gso + modprobe mpls_iptunnel Then, you must activate MPLS on the interface you would used: :: - sysctl -w net.mpls.conf.enp0s9.input=1 - sysctl -w net.mpls.conf.lo.input=1 - sysctl -w net.mpls.platform_labels=1048575 + sysctl -w net.mpls.conf.enp0s9.input=1 + sysctl -w net.mpls.conf.lo.input=1 + sysctl -w net.mpls.platform_labels=1048575 The last line fix the maximum MPLS label value. @@ -195,8 +215,8 @@ enable with: :: - ip -M route - ip route + ip -M route + ip route The first command show the MPLS LFIB table while the second show the FIB table which contains route with MPLS label encapsulation. @@ -207,8 +227,8 @@ especially the `lo` one. For that purpose, disable RP filtering with: :: - systcl -w net.ipv4.conf.all.rp_filter=0 - sysctl -w net.ipv4.conf.lo.rp_filter=0 + systcl -w net.ipv4.conf.all.rp_filter=0 + sysctl -w net.ipv4.conf.lo.rp_filter=0 OSPFd ~~~~~ @@ -220,16 +240,16 @@ Routing. :: - router ospf - ospf router-id 192.168.1.11 - capability opaque - mpls-te on - mpls-te router-address 192.168.1.11 - router-info area 0.0.0.0 - segment-routing on - segment-routing global-block 10000 19999 - segment-routing node-msd 8 - segment-routing prefix 192.168.1.11/32 index 1100 + router ospf + ospf router-id 192.168.1.11 + capability opaque + mpls-te on + mpls-te router-address 192.168.1.11 + router-info area 0.0.0.0 + segment-routing on + segment-routing global-block 10000 19999 + segment-routing node-msd 8 + segment-routing prefix 192.168.1.11/32 index 1100 The first segment-routing statement enable it. The Second one set the SRGB, third line the MSD and finally, set the Prefix SID index for a given prefix. @@ -248,9 +268,6 @@ Known limitations * MPLS table are not flush at startup. Thus, restarting zebra process is mandatory to remove old MPLS entries in the data plane after a crash of ospfd daemon -* Due to a bug in OSPF Opaque, LSA are not flood when enable Segment Routing - through CLI once OSPFd started. You must configure Segment Routing within - configuration file before launching OSPFd * With NO Penultimate Hop Popping, it is not possible to express a Segment Path with an Adjacency SID due to the impossibility for the Linux Kernel to perform double POP instruction. @@ -266,4 +283,3 @@ This work has been performed in the framework of the H2020-ICT-2014 project 5GEx (Grant Agreement no. 671636), which is partially funded by the European Commission. - diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index e7ea9c52e4..59917f5262 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -1033,11 +1033,12 @@ This is an EXPERIMENTAL support of Segment Routing as per draft currently supported. The 'no-php-flag' means NO Penultimate Hop Popping that allows SR node to request to its neighbor to not pop the label. -.. index:: show ip ospf database segment-routing -.. clicmd:: show ip ospf database segment-routing +.. index:: show ip ospf database segment-routing [json] +.. clicmd:: show ip ospf database segment-routing [json] Show Segment Routing Data Base, all SR nodes, specific advertized router or - self router. + self router. Optional JSON output can be obtained by appending 'json' to the + end of the command. Debugging OSPF ============== From 985e36a609ac51d8e39e252e796097c12c33adb5 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 11:03:00 -0500 Subject: [PATCH 096/148] lib: frr_pthread.c style Signed-off-by: Quentin Young --- lib/frr_pthread.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/frr_pthread.c b/lib/frr_pthread.c index ba6d89429a..6fafc8db36 100644 --- a/lib/frr_pthread.c +++ b/lib/frr_pthread.c @@ -229,7 +229,7 @@ void frr_pthread_stop_all() pthread_mutex_unlock(&frr_pthread_hash_mtx); } -uint32_t frr_pthread_get_id() +uint32_t frr_pthread_get_id(void) { _Atomic uint32_t nxid; nxid = atomic_fetch_add_explicit(&next_id, 1, memory_order_seq_cst); @@ -259,6 +259,7 @@ static int fpt_dummy(struct thread *thread) static int fpt_finish(struct thread *thread) { struct frr_pthread *fpt = THREAD_ARG(thread); + atomic_store_explicit(&fpt->running, false, memory_order_relaxed); return 0; } From d0be47e8e152e82270770bdb77aea620ea9b3ab2 Mon Sep 17 00:00:00 2001 From: vivek Date: Tue, 6 Mar 2018 21:29:09 +0000 Subject: [PATCH 097/148] bgpd: Fix warning Signed-off-by: Vivek Venkatraman --- bgpd/bgp_evpn.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/bgpd/bgp_evpn.c b/bgpd/bgp_evpn.c index 9e4a5172df..7122f2a095 100644 --- a/bgpd/bgp_evpn.c +++ b/bgpd/bgp_evpn.c @@ -2939,8 +2939,7 @@ static int process_type3_route(struct peer *peer, afi_t afi, safi_t safi, if (attr && (attr->flag & ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL))) { if (attr->pmsi_tnl_type != PMSI_TNLTYPE_INGR_REPL) { - zlog_warn("%u:%s - Rx EVPN Type-3 NLRI with " - "unsupported PTA %d", + zlog_warn("%u:%s - Rx EVPN Type-3 NLRI with unsupported PTA %d", peer->bgp->vrf_id, peer->host, attr->pmsi_tnl_type); } From 2bfe7ba7d416b6c2ea60f597cbeb0ecc711d486d Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Thu, 1 Mar 2018 04:40:26 -0500 Subject: [PATCH 098/148] zebra: Fix vrf output When you have individual 'ip route..' commands under a VRF allow them to be displayed properly Signed-off-by: Donald Sharp --- zebra/zebra_vrf.c | 1 - 1 file changed, 1 deletion(-) diff --git a/zebra/zebra_vrf.c b/zebra/zebra_vrf.c index 9e13f4ed6e..d401bd36e1 100644 --- a/zebra/zebra_vrf.c +++ b/zebra/zebra_vrf.c @@ -568,7 +568,6 @@ static int vrf_config_write(struct vty *vty) ? " prefix-routes-only" : ""); zebra_ns_config_write(vty, (struct ns *)vrf->ns_ctxt); - vty_out(vty, "!\n"); } static_config(vty, zvrf, AFI_IP, SAFI_UNICAST, "ip route"); From 85dd0c8afa087ac5fa0d7f31d9d5c83de169120b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Mar 2018 13:59:15 -0500 Subject: [PATCH 099/148] doc: update .gitignore Remove the various manpages & info related ignore rules so that git clean can pick them up and delete them. Signed-off-by: Quentin Young --- doc/.gitignore | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/doc/.gitignore b/doc/.gitignore index fca8f3209b..e539d9a97b 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -2,13 +2,6 @@ Makefile Makefile.in mdate-sh draft-zebra-00.txt -frr.info-* -zebra.html -defines.texi -version.texi -texinfo.tex -frr.html -frr.info *.pdf *.eps frr.ps @@ -28,13 +21,8 @@ stamp-vti *.toc *.tp *.vr -*.8 -*.1 .arch-inventory .arch-ids *~ *.loT refix -_build -_static -_template From 4060008bdac311b7340c12e2df9ae5d72c28afd8 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Thu, 1 Mar 2018 05:10:47 -0500 Subject: [PATCH 100/148] zebra: Allow for storage of non-configed vrf routes When zebra is being configed we allow for static routes to be entered. This presents a problem for when a vrf is cli configed but not kernel configed yet. Modify zebra to notice that when a static route is entered and either the nexthop vrf or the vrf is not fully configed, to save that config to the side. When vrf's become active( kernel configed ) parse through the list of saved to the side static routes and determine if any of them can be installed. Additionally modify the cli to output the saved to the side cli, so that we can properly handle a wr mem. Signed-off-by: Donald Sharp --- zebra/rib.h | 2 + zebra/zebra_vrf.c | 6 + zebra/zebra_vty.c | 352 +++++++++++++++++++++++++++++++++++++++++++--- 3 files changed, 342 insertions(+), 18 deletions(-) diff --git a/zebra/rib.h b/zebra/rib.h index 5f03f1a131..0c3eff3609 100644 --- a/zebra/rib.h +++ b/zebra/rib.h @@ -446,6 +446,8 @@ DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason), extern void zebra_vty_init(void); extern int static_config(struct vty *vty, struct zebra_vrf *zvrf, afi_t afi, safi_t safi, const char *cmd); +extern void static_config_install_delayed_routes(struct zebra_vrf *zvrf); + extern pid_t pid; #endif /*_ZEBRA_RIB_H */ diff --git a/zebra/zebra_vrf.c b/zebra/zebra_vrf.c index d401bd36e1..d9ae31f6c5 100644 --- a/zebra/zebra_vrf.c +++ b/zebra/zebra_vrf.c @@ -161,6 +161,12 @@ static int zebra_vrf_enable(struct vrf *vrf) } } + /* + * We may have static routes that are now possible to + * insert into the appropriate tables + */ + static_config_install_delayed_routes(zvrf); + /* Kick off any VxLAN-EVPN processing. */ zebra_vxlan_vrf_enable(zvrf); diff --git a/zebra/zebra_vty.c b/zebra/zebra_vty.c index 582ff3110b..cca41ccb8f 100644 --- a/zebra/zebra_vty.c +++ b/zebra/zebra_vty.c @@ -29,6 +29,7 @@ #include "rib.h" #include "nexthop.h" #include "vrf.h" +#include "linklist.h" #include "mpls.h" #include "routemap.h" #include "srcdest_table.h" @@ -76,7 +77,186 @@ static void vty_show_ip_route_summary_prefix(struct vty *vty, /* VNI range as per RFC 7432 */ #define CMD_VNI_RANGE "(1-16777215)" +struct static_hold_route { + char *vrf_name; + char *nhvrf_name; + afi_t afi; + safi_t safi; + char *dest_str; + char *mask_str; + char *src_str; + char *gate_str; + char *ifname; + char *flag_str; + char *tag_str; + char *distance_str; + char *label_str; +}; + +static struct list *static_list; + +static int static_list_compare_helper(const char *s1, const char *s2) +{ + /* Are Both NULL */ + if (s1 == s2) + return 0; + + if (!s1 && s2) + return -1; + + if (s1 && !s2) + return 1; + + return strcmp(s1, s2); +} + +static void static_list_delete(struct static_hold_route *shr) +{ + if (shr->vrf_name) + XFREE(MTYPE_STATIC_ROUTE, shr->vrf_name); + if (shr->nhvrf_name) + XFREE(MTYPE_STATIC_ROUTE, shr->nhvrf_name); + if (shr->dest_str) + XFREE(MTYPE_STATIC_ROUTE, shr->dest_str); + if (shr->mask_str) + XFREE(MTYPE_STATIC_ROUTE, shr->mask_str); + if (shr->src_str) + XFREE(MTYPE_STATIC_ROUTE, shr->src_str); + if (shr->gate_str) + XFREE(MTYPE_STATIC_ROUTE, shr->gate_str); + if (shr->ifname) + XFREE(MTYPE_STATIC_ROUTE, shr->ifname); + if (shr->flag_str) + XFREE(MTYPE_STATIC_ROUTE, shr->flag_str); + if (shr->tag_str) + XFREE(MTYPE_STATIC_ROUTE, shr->tag_str); + if (shr->distance_str) + XFREE(MTYPE_STATIC_ROUTE, shr->distance_str); + if (shr->label_str) + XFREE(MTYPE_STATIC_ROUTE, shr->label_str); + + XFREE(MTYPE_STATIC_ROUTE, shr); +} + +static int static_list_compare(void *arg1, void *arg2) +{ + struct static_hold_route *shr1 = arg1; + struct static_hold_route *shr2 = arg2; + int ret; + + ret = strcmp(shr1->vrf_name, shr2->vrf_name); + if (ret) + return ret; + + ret = strcmp(shr2->nhvrf_name, shr2->nhvrf_name); + if (ret) + return ret; + + ret = shr1->afi - shr2->afi; + if (ret) + return ret; + + ret = shr1->safi - shr2->afi; + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->dest_str, shr2->dest_str); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->mask_str, shr2->mask_str); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->src_str, shr2->src_str); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->gate_str, shr2->gate_str); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->ifname, shr2->ifname); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->flag_str, shr2->flag_str); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->tag_str, shr2->tag_str); + if (ret) + return ret; + + ret = static_list_compare_helper(shr1->distance_str, + shr2->distance_str); + if (ret) + return ret; + + return static_list_compare_helper(shr1->label_str, shr2->label_str); +} + + /* General function for static route. */ +static int zebra_static_route_holdem(struct zebra_vrf *zvrf, + struct zebra_vrf *nh_zvrf, + afi_t afi, safi_t safi, + const char *negate, const char *dest_str, + const char *mask_str, const char *src_str, + const char *gate_str, const char *ifname, + const char *flag_str, const char *tag_str, + const char *distance_str, + const char *label_str) +{ + struct static_hold_route *shr, *lookup; + struct listnode *node; + + shr = XCALLOC(MTYPE_STATIC_ROUTE, sizeof(*shr)); + shr->vrf_name = XSTRDUP(MTYPE_STATIC_ROUTE, zvrf->vrf->name); + shr->nhvrf_name = XSTRDUP(MTYPE_STATIC_ROUTE, nh_zvrf->vrf->name); + shr->afi = afi; + shr->safi = safi; + if (dest_str) + shr->dest_str = XSTRDUP(MTYPE_STATIC_ROUTE, dest_str); + if (mask_str) + shr->mask_str = XSTRDUP(MTYPE_STATIC_ROUTE, mask_str); + if (src_str) + shr->src_str = XSTRDUP(MTYPE_STATIC_ROUTE, src_str); + if (gate_str) + shr->gate_str = XSTRDUP(MTYPE_STATIC_ROUTE, gate_str); + if (ifname) + shr->ifname = XSTRDUP(MTYPE_STATIC_ROUTE, ifname); + if (flag_str) + shr->flag_str = XSTRDUP(MTYPE_STATIC_ROUTE, flag_str); + if (tag_str) + shr->tag_str = XSTRDUP(MTYPE_STATIC_ROUTE, tag_str); + if (distance_str) + shr->distance_str = XSTRDUP(MTYPE_STATIC_ROUTE, distance_str); + if (label_str) + shr->label_str = XSTRDUP(MTYPE_STATIC_ROUTE, label_str); + + for (ALL_LIST_ELEMENTS_RO(static_list, node, lookup)) { + if (static_list_compare(shr, lookup) == 0) + break; + } + + if (lookup) { + if (negate) { + listnode_delete(static_list, lookup); + static_list_delete(shr); + static_list_delete(lookup); + + return CMD_SUCCESS; + } + + assert(!"We should not have found a duplicate and not remove it"); + } + + listnode_add_sort(static_list, shr); + + return CMD_SUCCESS; +} + static int zebra_static_route_leak( struct vty *vty, struct zebra_vrf *zvrf, struct zebra_vrf *nh_zvrf, afi_t afi, safi_t safi, const char *negate, const char *dest_str, @@ -98,17 +278,34 @@ static int zebra_static_route_leak( ret = str2prefix(dest_str, &p); if (ret <= 0) { - vty_out(vty, "%% Malformed address\n"); + if (vty) + vty_out(vty, "%% Malformed address\n"); + else + zlog_warn("%s: Malformed address: %s", + __PRETTY_FUNCTION__, dest_str); return CMD_WARNING_CONFIG_FAILED; } + if (zvrf->vrf->vrf_id == VRF_UNKNOWN + || nh_zvrf->vrf->vrf_id == VRF_UNKNOWN) { + vrf_set_user_cfged(zvrf->vrf); + return zebra_static_route_holdem( + zvrf, nh_zvrf, afi, safi, negate, dest_str, mask_str, + src_str, gate_str, ifname, flag_str, tag_str, + distance_str, label_str); + } switch (afi) { case AFI_IP: /* Cisco like mask notation. */ if (mask_str) { ret = inet_aton(mask_str, &mask); if (ret == 0) { - vty_out(vty, "%% Malformed address\n"); + if (vty) + vty_out(vty, "%% Malformed address\n"); + else + zlog_warn("%s: Malformed address: %s", + __PRETTY_FUNCTION__, + mask_str); return CMD_WARNING_CONFIG_FAILED; } p.prefixlen = ip_masklen(mask); @@ -119,7 +316,13 @@ static int zebra_static_route_leak( if (src_str) { ret = str2prefix(src_str, &src); if (ret <= 0 || src.family != AF_INET6) { - vty_out(vty, "%% Malformed source address\n"); + if (vty) + vty_out(vty, + "%% Malformed source address\n"); + else + zlog_warn( + "%s: Malformed Source address: %s", + __PRETTY_FUNCTION__, src_str); return CMD_WARNING_CONFIG_FAILED; } src_p = (struct prefix_ipv6 *)&src; @@ -146,8 +349,13 @@ static int zebra_static_route_leak( memset(&snh_label, 0, sizeof(struct static_nh_label)); if (label_str) { if (!mpls_enabled) { - vty_out(vty, - "%% MPLS not turned on in kernel, ignoring command\n"); + if (vty) + vty_out(vty, + "%% MPLS not turned on in kernel, ignoring command\n"); + else + zlog_warn( + "%s: MPLS not turned on in kernel ignoring static route to %s", + __PRETTY_FUNCTION__, dest_str); return CMD_WARNING_CONFIG_FAILED; } int rc = mpls_str2label(label_str, &snh_label.num_labels, @@ -155,18 +363,37 @@ static int zebra_static_route_leak( if (rc < 0) { switch (rc) { case -1: - vty_out(vty, "%% Malformed label(s)\n"); + if (vty) + vty_out(vty, "%% Malformed label(s)\n"); + else + zlog_warn( + "%s: Malformed labels specified for route %s", + __PRETTY_FUNCTION__, dest_str); break; case -2: - vty_out(vty, - "%% Cannot use reserved label(s) (%d-%d)\n", - MPLS_LABEL_RESERVED_MIN, - MPLS_LABEL_RESERVED_MAX); + if (vty) + vty_out(vty, + "%% Cannot use reserved label(s) (%d-%d)\n", + MPLS_LABEL_RESERVED_MIN, + MPLS_LABEL_RESERVED_MAX); + else + zlog_warn( + "%s: Cannot use reserved labels (%d-%d) for %s", + __PRETTY_FUNCTION__, + MPLS_LABEL_RESERVED_MIN, + MPLS_LABEL_RESERVED_MAX, + dest_str); break; case -3: - vty_out(vty, - "%% Too many labels. Enter %d or fewer\n", - MPLS_MAX_LABELS); + if (vty) + vty_out(vty, + "%% Too many labels. Enter %d or fewer\n", + MPLS_MAX_LABELS); + else + zlog_warn( + "%s: Too many labels, Enter %d or fewer for %s", + __PRETTY_FUNCTION__, + MPLS_MAX_LABELS, dest_str); break; } return CMD_WARNING_CONFIG_FAILED; @@ -178,8 +405,13 @@ static int zebra_static_route_leak( if (strncasecmp(ifname, "Null0", strlen(ifname)) == 0 || strncasecmp(ifname, "reject", strlen(ifname)) == 0 || strncasecmp(ifname, "blackhole", strlen(ifname)) == 0) { - vty_out(vty, - "%% Nexthop interface cannot be Null0, reject or blackhole\n"); + if (vty) + vty_out(vty, + "%% Nexthop interface cannot be Null0, reject or blackhole\n"); + else + zlog_warn( + "%s: Nexthop interface cannot be Null0, reject or blackhole for %s", + __PRETTY_FUNCTION__, dest_str); return CMD_WARNING_CONFIG_FAILED; } } @@ -197,15 +429,28 @@ static int zebra_static_route_leak( bh_type = STATIC_BLACKHOLE_NULL; break; default: - vty_out(vty, "%% Malformed flag %s \n", flag_str); + if (vty) + vty_out(vty, "%% Malformed flag %s \n", + flag_str); + else + zlog_warn("%s: Malformed flag %s for %s", + __PRETTY_FUNCTION__, flag_str, + dest_str); return CMD_WARNING_CONFIG_FAILED; } } if (gate_str) { if (inet_pton(afi2family(afi), gate_str, &gate) != 1) { - vty_out(vty, "%% Malformed nexthop address %s\n", - gate_str); + if (vty) + vty_out(vty, + "%% Malformed nexthop address %s\n", + gate_str); + else + zlog_warn( + "%s: Malformed nexthop address %s for %s", + __PRETTY_FUNCTION__, gate_str, + dest_str); return CMD_WARNING_CONFIG_FAILED; } gatep = &gate; @@ -287,7 +532,38 @@ static int zebra_static_route(struct vty *vty, afi_t afi, safi_t safi, gate_str, ifname, flag_str, tag_str, distance_str, label_str); } +void static_config_install_delayed_routes(struct zebra_vrf *zvrf) +{ + struct listnode *node, *nnode; + struct static_hold_route *shr; + struct zebra_vrf *ozvrf, *nh_zvrf; + int installed; + for (ALL_LIST_ELEMENTS(static_list, node, nnode, shr)) { + ozvrf = zebra_vrf_lookup_by_name(shr->vrf_name); + nh_zvrf = zebra_vrf_lookup_by_name(shr->nhvrf_name); + + if (ozvrf != zvrf && nh_zvrf != zvrf) + continue; + + if (ozvrf->vrf->vrf_id == VRF_UNKNOWN + || nh_zvrf->vrf->vrf_id == VRF_UNKNOWN) + continue; + + installed = zebra_static_route_leak( + NULL, ozvrf, nh_zvrf, shr->afi, shr->safi, NULL, + shr->dest_str, shr->mask_str, shr->src_str, + shr->gate_str, shr->ifname, shr->flag_str, shr->tag_str, + shr->distance_str, shr->label_str); + + if (installed != CMD_SUCCESS) + zlog_debug( + "%s: Attempt to install %s as a route and it was rejected", + __PRETTY_FUNCTION__, shr->dest_str); + listnode_delete(static_list, shr); + static_list_delete(shr); + } +} /* Static unicast routes for multicast RPF lookup. */ DEFPY (ip_mroute_dist, ip_mroute_dist_cmd, @@ -1894,6 +2170,8 @@ static void vty_show_ip_route_summary_prefix(struct vty *vty, int static_config(struct vty *vty, struct zebra_vrf *zvrf, afi_t afi, safi_t safi, const char *cmd) { + struct static_hold_route *shr; + struct listnode *node; char spacing[100]; struct route_node *rn; struct static_route *si; @@ -1907,6 +2185,40 @@ int static_config(struct vty *vty, struct zebra_vrf *zvrf, afi_t afi, sprintf(spacing, "%s%s", (zvrf->vrf->vrf_id == VRF_DEFAULT) ? "" : " ", cmd); + /* + * Static routes for vrfs not fully inited + */ + for (ALL_LIST_ELEMENTS_RO(static_list, node, shr)) { + if (shr->afi != afi || shr->safi != safi) + continue; + + if (strcmp(zvrf->vrf->name, shr->vrf_name) != 0) + continue; + + vty_out(vty, "%s ", spacing); + if (shr->dest_str) + vty_out(vty, "%s ", shr->dest_str); + if (shr->mask_str) + vty_out(vty, "%s ", shr->mask_str); + if (shr->src_str) + vty_out(vty, "from %s ", shr->src_str); + if (shr->gate_str) + vty_out(vty, "%s ", shr->gate_str); + if (shr->ifname) + vty_out(vty, "%s ", shr->ifname); + if (shr->flag_str) + vty_out(vty, "%s ", shr->flag_str); + if (shr->tag_str) + vty_out(vty, "tag %s", shr->tag_str); + if (shr->distance_str) + vty_out(vty, "%s ", shr->distance_str); + if (shr->label_str) + vty_out(vty, "label %s ", shr->label_str); + if (strcmp(shr->vrf_name, shr->nhvrf_name) != 0) + vty_out(vty, "nexthop-vrf %s", shr->nhvrf_name); + vty_out(vty, "\n"); + } + for (rn = route_top(stable); rn; rn = srcdest_route_next(rn)) for (si = rn->info; si; si = si->next) { vty_out(vty, "%s %s", spacing, @@ -3409,4 +3721,8 @@ void zebra_vty_init(void) install_element(CONFIG_NODE, &no_default_vrf_vni_mapping_cmd); install_element(VRF_NODE, &vrf_vni_mapping_cmd); install_element(VRF_NODE, &no_vrf_vni_mapping_cmd); + + static_list = list_new(); + static_list->cmp = (int (*)(void *, void *))static_list_compare; + static_list->del = (void (*)(void *))static_list_delete; } From edc33b2f22e790cfe3e60de869baf17d0c8c65e0 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Mar 2018 14:35:20 -0500 Subject: [PATCH 101/148] doc: fix make setup Iron out all of the glitches with recursive Automake, 3rd-party autogenerated Sphinx makefiles, building and installing 3 different document formats under different targets, and handling clean. * Implement all Automake-required targets for 3rd-party Makefiles * Setup subdirectories for 3rd-party Makefiles * Override implicit Automake document targets * Clean up explicit targets for developer docs * Move Sphinx-generated Makefile to an include file * Update targets for debian packaging Signed-off-by: Quentin Young --- debianpkg/backports/ubuntu12.04/debian/rules | 4 +- debianpkg/backports/ubuntu14.04/debian/rules | 4 +- debianpkg/rules | 4 +- doc/Makefile.am | 70 +++-- doc/developer/Makefile | 220 +--------------- doc/frr-sphinx.mk | 219 ++++++++++++++++ doc/manpages/Makefile | 259 +++---------------- doc/manpages/conf.py | 2 +- doc/user/Makefile | 258 ++++-------------- 9 files changed, 362 insertions(+), 678 deletions(-) create mode 100644 doc/frr-sphinx.mk diff --git a/debianpkg/backports/ubuntu12.04/debian/rules b/debianpkg/backports/ubuntu12.04/debian/rules index 83e5e9689e..9a3ea1ffbd 100755 --- a/debianpkg/backports/ubuntu12.04/debian/rules +++ b/debianpkg/backports/ubuntu12.04/debian/rules @@ -139,10 +139,10 @@ override_dh_auto_configure: override_dh_auto_build: ifeq ($(GENERATE_PDF), 1) - dh_auto_build -- -C doc user.pdf + dh_auto_build -- -C doc pdf endif rm -vf doc/user/_build/texinfo/frr.info - dh_auto_build -- -C doc frr.info + dh_auto_build -- -C doc info override_dh_auto_test: diff --git a/debianpkg/backports/ubuntu14.04/debian/rules b/debianpkg/backports/ubuntu14.04/debian/rules index 64a3d7b63e..20b821ead7 100755 --- a/debianpkg/backports/ubuntu14.04/debian/rules +++ b/debianpkg/backports/ubuntu14.04/debian/rules @@ -143,10 +143,10 @@ override_dh_auto_build: # doc/ is a bit crazy ifeq ($(GENERATE_PDF), 1) - dh_auto_build -- -C doc user.pdf + dh_auto_build -- -C doc pdf endif rm -vf doc/_build/texinfo/frr.info - dh_auto_build -- -C doc frr.info + dh_auto_build -- -C doc info override_dh_auto_test: diff --git a/debianpkg/rules b/debianpkg/rules index 46f8f48028..82a5148039 100755 --- a/debianpkg/rules +++ b/debianpkg/rules @@ -141,10 +141,10 @@ override_dh_auto_configure: override_dh_auto_build: # doc/ is a bit crazy ifeq ($(GENERATE_PDF), 1) - dh_auto_build -- -C doc user.pdf + dh_auto_build -- -C doc pdf endif rm -vf doc/user/_build/texinfo/frr.info - dh_auto_build -- -C doc frr.info + dh_auto_build -- -C doc info override_dh_auto_test: diff --git a/doc/Makefile.am b/doc/Makefile.am index 4a9b0525a5..62f3ae2b6a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,11 +1,20 @@ ## Process this file with automake to produce Makefile.in. -# Tell Automake to invoke 'make' in the manpages directory with argument 'man' -SUBDIRS = manpages +# Pass down make invocation to each subdirectory. +# +# Each of these directories contains a Sphinx-generated Makefile that has been +# modified to implement all the targets required by Automake, as documented in +# the 'Third-Party Makefiles' section of the Automake docs. +# +# Note the absence of the 'developer' directory here; development docs are +# never built as part of a regular build. They are only built when explicitly +# asked for. See comment further down. +SUBDIRS = manpages user +AM_MAKEFLAGS = DESTDIR=${DESTDIR} infodir=${infodir} MANPAGE_BUILDDIR = manpages/_build/man -# Once that is done these will all exist +# This is a hack, see comment further down. man_MANS = $(MANPAGE_BUILDDIR)/frr.1 if PIMD @@ -65,32 +74,49 @@ if EIGRPD man_MANS += $(MANPAGE_BUILDDIR)/eigrpd.8 endif -# handled by subdir target -man: ; +# Automake is particular about manpages. It is aware of them and has some +# special facilities for handling them, but it assumes that manpages are always +# given in groff source and so these facilities are limited to simply +# specifying the path to the groff sources in a special variable. There is no +# target for building manpages that can be extended, as there are for pdf, +# html, dvi, etc. Unfortunately this leaves us with hijacking the +# 'install-data' and 'all' targets in the 3rd-party Makefile in manpages/ to +# make sure manpages are always built, and then using the special Automake +# variable defined above in order to take advantage of automatic installation. +# +# However, it is conceivable that someone may want to build just the manpages, +# so here's an explicit target for that. +man: + $(MAKE) -C manpages man -# explicit targets -frr.info: - $(MAKE) -C user info +# Automake automatically defines targets for various document formats. All of +# the child 3rd-party Makefiles are aware of all Automake targets and implement +# the ones we are interested in. +# +# The SUBDIRS variable at the top of this Makefile.am causes the following +# implicit Automake targets to only build user documentation, and not developer +# documentation: +# - info +# - html +# - pdf +# +# If you wish to build developer documentation, use these targets: +developer-info: + $(MAKE) -C developer info -user.pdf: - $(MAKE) -C user latexpdf - -user.html: - $(MAKE) -C user html - -developer.pdf: +developer-pdf: $(MAKE) -C developer latexpdf -developer.html: +developer-html: $(MAKE) -C developer html -# info target, handled by automake installation -install-data-local: frr.info - install -d ${DESTDIR}${infodir} - gzip < user/_build/texinfo/frr.info > ${DESTDIR}${infodir}/frr.info.gz - install-info user/_build/texinfo/frr.info ${DESTDIR}${infodir}/dir +# If you want to build the developer's docs in other formats, try the +# following: +# +# $ cd developer +# $ make help -# include sources for shipped docs +# dist tarballs want doc sources EXTRA_DIST = manpages/defines.rst \ manpages/ldpd.rst \ manpages/index.rst \ diff --git a/doc/developer/Makefile b/doc/developer/Makefile index f5aca7a655..9807a750bf 100644 --- a/doc/developer/Makefile +++ b/doc/developer/Makefile @@ -1,219 +1 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -PAPER ?= -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -SPHINXBUILD = sphinx-1.0-build -endif -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - $(MAKE) -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +include ../frr-sphinx.mk diff --git a/doc/frr-sphinx.mk b/doc/frr-sphinx.mk new file mode 100644 index 0000000000..f5aca7a655 --- /dev/null +++ b/doc/frr-sphinx.mk @@ -0,0 +1,219 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +PAPER ?= +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +SPHINXBUILD = sphinx-1.0-build +endif +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + $(MAKE) -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile index 33a3af1f14..ebbbc31009 100644 --- a/doc/manpages/Makefile +++ b/doc/manpages/Makefile @@ -1,227 +1,48 @@ -# Makefile for Sphinx documentation -# +include ../frr-sphinx.mk -# You can set these variables from the command line. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -PAPER ?= -BUILDDIR = _build +# ----------------------------------------------------------------------------- +# Automake requires that 3rd-party Makefiles recognize these targets. +# ----------------------------------------------------------------------------- +# install +# install-data +# install-exec +# uninstall +# install-dvi +# install-html +# install-info +# install-ps +# install-pdf +# installdirs +# check +# installcheck +# mostlyclean +# clean +# distclean +# maintainer-clean +# dvi +# pdf +# ps +# info +# html +# tags +# ctags -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -SPHINXBUILD = sphinx-1.0-build -endif -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") -endif +# ignore these targets +EMPTY_AUTOMAKE_TARGETS = dvi pdf ps tags ctags distdir installdirs check installcheck install-dvi install-ps install-html install-pdf install-info install-exec +.PHONY: $(EMPTY_AUTOMAKE_TARGETS) +$(EMPTY_AUTOMAKE_TARGETS): -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# These targets are automatically generated by Sphinx but conflict with +# implicitly defined Automake rules, so we manually override them to nothing. +# The other option is deleting the Sphinx-generated rules, which suppresses the +# warning but kinda screws up the symmetry between Makefiles. +info: ; +html: ; -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" +all: man -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -.PHONY: install-data install-data: man -.PHONY: all -all: install-data +install: install-data -%: ; +mostlyclean distclean maintainer-clean: clean diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 2d6fbe8503..50331b6f0a 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -159,7 +159,7 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/user/Makefile b/doc/user/Makefile index f5aca7a655..ad2abb25c1 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -1,219 +1,55 @@ -# Makefile for Sphinx documentation -# +include ../frr-sphinx.mk -# You can set these variables from the command line. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -PAPER ?= -BUILDDIR = _build +# ----------------------------------------------------------------------------- +# Automake requires that 3rd-party Makefiles recognize these targets. +# ----------------------------------------------------------------------------- +# install +# install-data +# install-exec +# uninstall +# install-dvi +# install-html +# install-info +# install-ps +# install-pdf +# installdirs +# check +# installcheck +# mostlyclean +# clean +# distclean +# maintainer-clean +# dvi +# pdf +# ps +# info +# html +# tags +# ctags -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -SPHINXBUILD = sphinx-1.0-build -endif -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") -endif +# ignore these targets +EMPTY_AUTOMAKE_TARGETS = dvi ps tags ctags distdir install-exec install-dvi install-ps installdirs check installcheck install-html install-pdf install-data install +.PHONY: $(EMPTY_AUTOMAKE_TARGETS) +$(EMPTY_AUTOMAKE_TARGETS): -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# When building 'all', the logic is that we want to make docs that are easily +# readable by the person that just built them. Technically the reST source is +# readable in its own right, but we'll also build info and html because those +# offer sequentially better reading experiences. PDF is not built by default +# because it takes quite a while. +all: info html -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" +# info and html already have built-in sphinx rules; pdf goes to latexpdf +pdf: latexpdf -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* +# install user manual as info file +install-info: info + install -d ${DESTDIR}${infodir} + gzip < _build/texinfo/frr.info > ${DESTDIR}${infodir}/frr.info.gz + install-info _build/texinfo/frr.info ${DESTDIR}${infodir}/dir -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." +install-data: install-info -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." +install: install-data -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - $(MAKE) -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +mostlyclean distclean maintainer-clean: clean From 37ba370b9eb45c2905c9c411f29c8ecf5e0e4c53 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Mar 2018 16:28:23 -0500 Subject: [PATCH 102/148] doc: change html theme to 'default' Looks like older versions of Sphinx switched around naming for the default themes. Signed-off-by: Quentin Young --- doc/Makefile.am | 5 +++-- doc/developer/conf.py | 2 +- doc/manpages/conf.py | 2 +- doc/user/conf.py | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index 62f3ae2b6a..caa909d50d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -10,7 +10,7 @@ # never built as part of a regular build. They are only built when explicitly # asked for. See comment further down. SUBDIRS = manpages user -AM_MAKEFLAGS = DESTDIR=${DESTDIR} infodir=${infodir} +AM_MAKEFLAGS = DESTDIR=${DESTDIR} infodir=${infodir} doczdir=${abs_srcdir} MANPAGE_BUILDDIR = manpages/_build/man @@ -117,7 +117,8 @@ developer-html: # $ make help # dist tarballs want doc sources -EXTRA_DIST = manpages/defines.rst \ +EXTRA_DIST = frr-sphinx.mk \ + manpages/defines.rst \ manpages/ldpd.rst \ manpages/index.rst \ manpages/bgpd.rst \ diff --git a/doc/developer/conf.py b/doc/developer/conf.py index 3f531c14b0..e2293b2a6b 100644 --- a/doc/developer/conf.py +++ b/doc/developer/conf.py @@ -157,7 +157,7 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'classic' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 50331b6f0a..a78e1a2c38 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -159,7 +159,7 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'classic' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/user/conf.py b/doc/user/conf.py index 817a6d83bb..efe1023740 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -157,7 +157,7 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'classic' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the From e7cc2122de7d8107a2bf26929e17776d4be21b70 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Mar 2018 17:36:20 -0500 Subject: [PATCH 103/148] redhat: update frr.spec for doc build changes Signed-off-by: Quentin Young --- redhat/frr.spec.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/redhat/frr.spec.in b/redhat/frr.spec.in index 310d7ab939..b4073f94f3 100644 --- a/redhat/frr.spec.in +++ b/redhat/frr.spec.in @@ -309,7 +309,7 @@ developing OSPF-API and frr applications. make %{?_smp_mflags} MAKEINFO="makeinfo --no-split" SPHINXBUILD=%{sphinx} pushd doc -make SPHINXBUILD=%{sphinx} frr.info +make SPHINXBUILD=%{sphinx} info popd %install From f83f396624b34c5e50241910f6bdbfacb4249559 Mon Sep 17 00:00:00 2001 From: Mladen Sablic Date: Tue, 27 Feb 2018 23:16:45 +0100 Subject: [PATCH 104/148] pimd: mtrace only IGMP sockets Feature of mtrace only IGMP sockets on pim sm and pim ssm interfaces. Modifed IGMP socket creation and show igmp interface command output. Signed-off-by: Mladen Sablic --- pimd/pim_cmd.c | 18 ++++++++++++++++-- pimd/pim_iface.c | 20 +++++++++++++++++++- pimd/pim_igmp.c | 21 +++++++++++++++++---- pimd/pim_igmp.h | 5 ++++- pimd/pim_igmpv2.c | 6 ++++++ pimd/pim_igmpv3.c | 3 +++ 6 files changed, 65 insertions(+), 8 deletions(-) diff --git a/pimd/pim_cmd.c b/pimd/pim_cmd.c index 6002794658..803e7bb013 100644 --- a/pimd/pim_cmd.c +++ b/pimd/pim_cmd.c @@ -604,11 +604,18 @@ static void igmp_show_interfaces(struct pim_instance *pim, struct vty *vty, json_object_object_add(json, ifp->name, json_row); + if (igmp->mtrace_only) { + json_object_boolean_true_add( + json_row, "mtraceOnly"); + } } else { vty_out(vty, "%-9s %5s %15s %d %7s %11s %8s\n", ifp->name, - if_is_up(ifp) ? "up" : "down", + if_is_up(ifp) + ? (igmp->mtrace_only ? "mtrc" + : "up") + : "down", inet_ntoa(igmp->ifaddr), pim_ifp->igmp_version, igmp->t_igmp_query_timer ? "local" @@ -758,10 +765,17 @@ static void igmp_show_interfaces_single(struct pim_instance *pim, json_object_object_add(json, ifp->name, json_row); + if (igmp->mtrace_only) { + json_object_boolean_true_add( + json_row, "mtraceOnly"); + } } else { vty_out(vty, "Interface : %s\n", ifp->name); vty_out(vty, "State : %s\n", - if_is_up(ifp) ? "up" : "down"); + if_is_up(ifp) + ? (igmp->mtrace_only ? "mtrace" + : "up") + : "down"); vty_out(vty, "Address : %s\n", inet_ntoa(pim_ifp->primary_address)); vty_out(vty, "Uptime : %s\n", uptime); diff --git a/pimd/pim_iface.c b/pimd/pim_iface.c index 998f8fc2ca..ff7238ae97 100644 --- a/pimd/pim_iface.c +++ b/pimd/pim_iface.c @@ -574,7 +574,11 @@ void pim_if_addr_add(struct connected *ifc) /* if addr new, add IGMP socket */ if (ifc->address->family == AF_INET) pim_igmp_sock_add(pim_ifp->igmp_socket_list, - ifaddr, ifp); + ifaddr, ifp, false); + } else if (igmp->mtrace_only) { + igmp_sock_delete(igmp); + pim_igmp_sock_add(pim_ifp->igmp_socket_list, ifaddr, + ifp, false); } /* Replay Static IGMP groups */ @@ -611,6 +615,20 @@ void pim_if_addr_add(struct connected *ifc) } } } /* igmp */ + else { + struct igmp_sock *igmp; + + /* lookup IGMP socket */ + igmp = pim_igmp_sock_lookup_ifaddr(pim_ifp->igmp_socket_list, + ifaddr); + if (ifc->address->family == AF_INET) { + if (igmp) + igmp_sock_delete(igmp); + /* if addr new, add IGMP socket */ + pim_igmp_sock_add(pim_ifp->igmp_socket_list, ifaddr, + ifp, true); + } + } /* igmp mtrace only */ if (PIM_IF_TEST_PIM(pim_ifp->options)) { diff --git a/pimd/pim_igmp.c b/pimd/pim_igmp.c index c0a58516d9..5e1aecc3a3 100644 --- a/pimd/pim_igmp.c +++ b/pimd/pim_igmp.c @@ -281,6 +281,9 @@ static int igmp_recv_query(struct igmp_sock *igmp, int query_version, uint16_t recv_checksum; uint16_t checksum; + if (igmp->mtrace_only) + return 0; + memcpy(&group_addr, igmp_msg + 4, sizeof(struct in_addr)); ifp = igmp->interface; @@ -387,6 +390,9 @@ static int igmp_v1_recv_report(struct igmp_sock *igmp, struct in_addr from, on_trace(__PRETTY_FUNCTION__, igmp->interface, from); + if (igmp->mtrace_only) + return 0; + if (igmp_msg_len != IGMP_V12_MSG_SIZE) { zlog_warn( "Recv IGMP report v1 from %s on %s: size=%d other than correct=%d", @@ -510,7 +516,6 @@ int pim_igmp_packet(struct igmp_sock *igmp, char *buf, size_t len) return igmp_mtrace_recv_response(igmp, ip_hdr, ip_hdr->ip_src, from_str, igmp_msg, igmp_msg_len); - break; case PIM_IGMP_MTRACE_QUERY_REQUEST: return igmp_mtrace_recv_qry_req(igmp, ip_hdr, ip_hdr->ip_src, from_str, igmp_msg, @@ -819,7 +824,7 @@ static int igmp_group_hash_equal(const void *arg1, const void *arg2) } static struct igmp_sock *igmp_sock_new(int fd, struct in_addr ifaddr, - struct interface *ifp) + struct interface *ifp, int mtrace_only) { struct pim_interface *pim_ifp; struct igmp_sock *igmp; @@ -862,6 +867,13 @@ static struct igmp_sock *igmp_sock_new(int fd, struct in_addr ifaddr, pim_ifp->igmp_default_robustness_variable; igmp->sock_creation = pim_time_monotonic_sec(); + if (mtrace_only) { + igmp->mtrace_only = mtrace_only; + return igmp; + } + + igmp->mtrace_only = false; + /* igmp_startup_mode_on() will reset QQI: @@ -919,7 +931,8 @@ static void igmp_read_on(struct igmp_sock *igmp) struct igmp_sock *pim_igmp_sock_add(struct list *igmp_sock_list, struct in_addr ifaddr, - struct interface *ifp) + struct interface *ifp, + bool mtrace_only) { struct pim_interface *pim_ifp; struct igmp_sock *igmp; @@ -934,7 +947,7 @@ struct igmp_sock *pim_igmp_sock_add(struct list *igmp_sock_list, return 0; } - igmp = igmp_sock_new(fd, ifaddr, ifp); + igmp = igmp_sock_new(fd, ifaddr, ifp, mtrace_only); if (!igmp) { zlog_err("%s %s: igmp_sock_new() failure", __FILE__, __PRETTY_FUNCTION__); diff --git a/pimd/pim_igmp.h b/pimd/pim_igmp.h index 962c50e76a..561a127d0f 100644 --- a/pimd/pim_igmp.h +++ b/pimd/pim_igmp.h @@ -90,6 +90,8 @@ struct igmp_sock { int querier_robustness_variable; /* QRV */ int startup_query_count; + bool mtrace_only; + struct list *igmp_group_list; /* list of struct igmp_group */ struct hash *igmp_group_hash; }; @@ -99,7 +101,8 @@ struct igmp_sock *pim_igmp_sock_lookup_ifaddr(struct list *igmp_sock_list, struct igmp_sock *igmp_sock_lookup_by_fd(struct list *igmp_sock_list, int fd); struct igmp_sock *pim_igmp_sock_add(struct list *igmp_sock_list, struct in_addr ifaddr, - struct interface *ifp); + struct interface *ifp, + bool mtrace_only); void igmp_sock_delete(struct igmp_sock *igmp); void igmp_sock_free(struct igmp_sock *igmp); void igmp_sock_delete_all(struct interface *ifp); diff --git a/pimd/pim_igmpv2.c b/pimd/pim_igmpv2.c index efa36e618f..dbbe83a965 100644 --- a/pimd/pim_igmpv2.c +++ b/pimd/pim_igmpv2.c @@ -111,6 +111,9 @@ int igmp_v2_recv_report(struct igmp_sock *igmp, struct in_addr from, on_trace(__PRETTY_FUNCTION__, igmp->interface, from); + if (igmp->mtrace_only) + return 0; + if (igmp_msg_len != IGMP_V12_MSG_SIZE) { zlog_warn( "Recv IGMPv2 REPORT from %s on %s: size=%d other than correct=%d", @@ -154,6 +157,9 @@ int igmp_v2_recv_leave(struct igmp_sock *igmp, struct in_addr from, on_trace(__PRETTY_FUNCTION__, igmp->interface, from); + if (igmp->mtrace_only) + return 0; + if (igmp_msg_len != IGMP_V12_MSG_SIZE) { zlog_warn( "Recv IGMPv2 LEAVE from %s on %s: size=%d other than correct=%d", diff --git a/pimd/pim_igmpv3.c b/pimd/pim_igmpv3.c index ecde546c06..3360e36b4a 100644 --- a/pimd/pim_igmpv3.c +++ b/pimd/pim_igmpv3.c @@ -1874,6 +1874,9 @@ int igmp_v3_recv_report(struct igmp_sock *igmp, struct in_addr from, int local_ncb = 0; struct pim_interface *pim_ifp; + if (igmp->mtrace_only) + return 0; + pim_ifp = igmp->interface->info; if (igmp_msg_len < IGMP_V3_MSG_MIN_SIZE) { From 8c60fed743a348ec22c2a2429d45db1c39d545d5 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 11:11:04 -0500 Subject: [PATCH 105/148] doc: disable parallel build Sphinx is not designed to be run in parallel and exhibits filesystem race conditions if it is. Disable parallel build. Signed-off-by: Quentin Young --- doc/Makefile.am | 4 ++++ doc/frr-sphinx.mk | 3 +++ 2 files changed, 7 insertions(+) diff --git a/doc/Makefile.am b/doc/Makefile.am index caa909d50d..aeabc0981d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -9,6 +9,10 @@ # Note the absence of the 'developer' directory here; development docs are # never built as part of a regular build. They are only built when explicitly # asked for. See comment further down. + +# Sphinx is not designed to be invoked multiple times against the same toctree. +.NOTPARALLEL: + SUBDIRS = manpages user AM_MAKEFLAGS = DESTDIR=${DESTDIR} infodir=${infodir} doczdir=${abs_srcdir} diff --git a/doc/frr-sphinx.mk b/doc/frr-sphinx.mk index f5aca7a655..3d91e8f63d 100644 --- a/doc/frr-sphinx.mk +++ b/doc/frr-sphinx.mk @@ -1,6 +1,9 @@ # Makefile for Sphinx documentation # +# Sphinx is not designed to be invoked multiple times against the same toctree. +.NOTPARALLEL: + # You can set these variables from the command line. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build From d47ae3db4cf14c72d8468d61113ac88e19235791 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 11:12:38 -0500 Subject: [PATCH 106/148] doc: don't build html by default Since docs are rebuilt on every make invocation, don't bother building html by default to save a bit of time. Signed-off-by: Quentin Young --- doc/user/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/Makefile b/doc/user/Makefile index ad2abb25c1..223f8a64a3 100644 --- a/doc/user/Makefile +++ b/doc/user/Makefile @@ -37,7 +37,7 @@ $(EMPTY_AUTOMAKE_TARGETS): # readable in its own right, but we'll also build info and html because those # offer sequentially better reading experiences. PDF is not built by default # because it takes quite a while. -all: info html +all: info # info and html already have built-in sphinx rules; pdf goes to latexpdf pdf: latexpdf From b1087f35076a01882e77dda1f9c841ac1000fdec Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 11:20:53 -0500 Subject: [PATCH 107/148] lib: frr_pthread int size nits Signed-off-by: Quentin Young --- lib/frr_pthread.c | 4 ++-- lib/frr_pthread.h | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/frr_pthread.c b/lib/frr_pthread.c index 6fafc8db36..36a89168c2 100644 --- a/lib/frr_pthread.c +++ b/lib/frr_pthread.c @@ -152,7 +152,7 @@ void frr_pthread_set_name(struct frr_pthread *fpt, const char *name) thread_master_set_name(fpt->master, name); } -struct frr_pthread *frr_pthread_get(unsigned int id) +struct frr_pthread *frr_pthread_get(uint32_t id) { static struct frr_pthread holder = {}; struct frr_pthread *fpt; @@ -234,7 +234,7 @@ uint32_t frr_pthread_get_id(void) _Atomic uint32_t nxid; nxid = atomic_fetch_add_explicit(&next_id, 1, memory_order_seq_cst); /* just a sanity check, this should never happen */ - assert(nxid <= (INT_MAX - 1)); + assert(nxid <= (UINT32_MAX - 1)); return nxid; } diff --git a/lib/frr_pthread.h b/lib/frr_pthread.h index 3990e2a4ce..91002dd8ef 100644 --- a/lib/frr_pthread.h +++ b/lib/frr_pthread.h @@ -149,7 +149,7 @@ void frr_pthread_destroy(struct frr_pthread *fpt); * * @return frr_thread associated with the provided id, or NULL on error */ -struct frr_pthread *frr_pthread_get(unsigned int id); +struct frr_pthread *frr_pthread_get(uint32_t id); /* * Creates a new pthread and binds it to a frr_pthread. From 2b1236a27e7502d0adfc1a137a378983b3a8ebe1 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 17:51:42 -0500 Subject: [PATCH 108/148] *: globally ignore clippy-generated source Tired of dealing with this Signed-off-by: Quentin Young --- .gitignore | 3 +++ bgpd/.gitignore | 1 - ldpd/.gitignore | 1 - lib/.gitignore | 1 - ospfd/.gitignore | 1 - sharpd/.gitignore | 1 - zebra/.gitignore | 1 - 7 files changed, 3 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index f7c731b4bc..c5fd0ced9b 100644 --- a/.gitignore +++ b/.gitignore @@ -82,3 +82,6 @@ GPATH *.lo compile_commands.json .dirstamp + +# clippy generated source +*_clippy.c diff --git a/bgpd/.gitignore b/bgpd/.gitignore index a97bdb83d3..105be22995 100644 --- a/bgpd/.gitignore +++ b/bgpd/.gitignore @@ -16,4 +16,3 @@ TAGS .arch-ids *~ *.loT -*clippy.c diff --git a/ldpd/.gitignore b/ldpd/.gitignore index eee96c636f..a2f4b51698 100644 --- a/ldpd/.gitignore +++ b/ldpd/.gitignore @@ -15,4 +15,3 @@ TAGS .arch-ids *~ *.loT -ldp_vty_cmds_clippy.c diff --git a/lib/.gitignore b/lib/.gitignore index 94f401ebe6..072146dbd5 100644 --- a/lib/.gitignore +++ b/lib/.gitignore @@ -24,4 +24,3 @@ refix grammar_sandbox clippy defun_lex.c -plist_clippy.c diff --git a/ospfd/.gitignore b/ospfd/.gitignore index f0d800efb4..752c875a62 100644 --- a/ospfd/.gitignore +++ b/ospfd/.gitignore @@ -15,4 +15,3 @@ TAGS *~ *.loT *.a -*clippy.c diff --git a/sharpd/.gitignore b/sharpd/.gitignore index c396f3ef94..cc33cfc188 100644 --- a/sharpd/.gitignore +++ b/sharpd/.gitignore @@ -13,6 +13,5 @@ TAGS .arch-ids *~ *.loT -*clippy.c sharpd sharpd.conf diff --git a/zebra/.gitignore b/zebra/.gitignore index 7a1321e546..4a06756a2d 100644 --- a/zebra/.gitignore +++ b/zebra/.gitignore @@ -13,4 +13,3 @@ TAGS .arch-ids *~ *.loT -zebra_vty_clippy.c From ba85366ad34ae0497df8f4773aae81a567e10256 Mon Sep 17 00:00:00 2001 From: Arthur Jones Date: Fri, 9 Mar 2018 15:08:24 -0800 Subject: [PATCH 109/148] zebra/if_netlink: compile under musl-libc musl-libc is a lightweight libc used by alpine linux: https://www.musl-libc.org/ AFAICT, this is the only change to the source needed to get basic frr support compiling on musl. Two changes in one patch, get ethhdr from netinet/if_ether.h and replace the only __caddr_t I could find in the source base with caddr_t. Testing done: Compiled apk packages using a docker environment (patches coming soon) also compiled redhat and debian using a similar docker environment (RFC patches for those changes are queued up too)... Issue: https://github.com/FRRouting/frr/issues/1859 Signed-off-by: Arthur Jones --- zebra/if_netlink.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/zebra/if_netlink.c b/zebra/if_netlink.c index bb0a0e052e..a37d74416b 100644 --- a/zebra/if_netlink.c +++ b/zebra/if_netlink.c @@ -30,6 +30,7 @@ */ #define _LINUX_IN6_H +#include #include #include #include @@ -362,7 +363,7 @@ static int get_iflink_speed(struct interface *interface) /* initialize ethtool interface */ memset(&ecmd, 0, sizeof(ecmd)); ecmd.cmd = ETHTOOL_GSET; /* ETHTOOL_GLINK */ - ifdata.ifr_data = (__caddr_t)&ecmd; + ifdata.ifr_data = (caddr_t)&ecmd; /* use ioctl to get IP address of an interface */ if (zserv_privs.change(ZPRIVS_RAISE)) From 98c5bc15e712a6fb4dc7ae827124cb5494e23688 Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Sat, 10 Mar 2018 18:16:34 +0100 Subject: [PATCH 110/148] isisd: revert some counterproductive indentation This reverts some of commit 996c93142d3abfab0f6d6c800474e22a8cfbdbc5. --- isisd/isis_circuit.c | 6 +- isisd/isis_circuit.h | 5 +- isisd/isis_lsp.c | 7 +- isisd/isis_pdu.c | 11 +-- isisd/isis_spf.c | 36 ++++---- isisd/isis_te.c | 57 ++++++------- isisd/isis_tlvs.c | 190 ++++++++++++++++++------------------------- isisd/isisd.h | 5 +- 8 files changed, 131 insertions(+), 186 deletions(-) diff --git a/isisd/isis_circuit.c b/isisd/isis_circuit.c index 75d4397637..a2d1e75d94 100644 --- a/isisd/isis_circuit.c +++ b/isisd/isis_circuit.c @@ -382,12 +382,10 @@ static uint8_t isis_circuit_id_gen(struct interface *ifp) /* Circuit ids MUST be unique for any broadcast circuits. Otherwise, * Pseudo-Node LSPs cannot be generated correctly. * - * Currently, allocate one circuit ID for any circuit, limiting the - * total + * Currently, allocate one circuit ID for any circuit, limiting the total * numer of circuits IS-IS can run on to 255. * - * We should revisit this when implementing 3-way adjacencies for p2p, - * since + * We should revisit this when implementing 3-way adjacencies for p2p, since * we then have extended interface IDs available. */ uint8_t id = ifp->ifindex; diff --git a/isisd/isis_circuit.h b/isisd/isis_circuit.h index 0d392036e9..3d97d42b5e 100644 --- a/isisd/isis_circuit.h +++ b/isisd/isis_circuit.h @@ -82,9 +82,8 @@ struct isis_circuit { struct thread *t_send_csnp[2]; struct thread *t_send_psnp[2]; struct thread *t_send_lsp; - struct list *lsp_queue; /* LSPs to be txed (both levels) */ - struct isis_lsp_hash - *lsp_hash; /* Hashtable synchronized with lsp_queue */ + struct list *lsp_queue; /* LSPs to be txed (both levels) */ + struct isis_lsp_hash *lsp_hash; /* Hashtable synchronized with lsp_queue */ time_t lsp_queue_last_push[2]; /* timestamp used to enforce transmit * interval; * for scalability, use one timestamp per diff --git a/isisd/isis_lsp.c b/isisd/isis_lsp.c index 55888bd389..34eac676d6 100644 --- a/isisd/isis_lsp.c +++ b/isisd/isis_lsp.c @@ -1875,15 +1875,12 @@ int lsp_tick(struct thread *thread) if (!circuit->lsp_queue) continue; - if (now - - circuit->lsp_queue_last_push - [level] + if (now - circuit->lsp_queue_last_push[level] < MIN_LSP_RETRANS_INTERVAL) { continue; } - circuit->lsp_queue_last_push[level] = - now; + circuit->lsp_queue_last_push[level] = now; for (ALL_LIST_ELEMENTS_RO( lsp_list, lspnode, lsp)) { diff --git a/isisd/isis_pdu.c b/isisd/isis_pdu.c index 20c39a624f..cdbfb0e653 100644 --- a/isisd/isis_pdu.c +++ b/isisd/isis_pdu.c @@ -1184,8 +1184,7 @@ static int process_snp(uint8_t pdu_type, struct isis_circuit *circuit, entry = entry->next) { zlog_debug( "ISIS-Snp (%s): %cSNP entry %s, seq 0x%08" PRIx32 - ", cksum 0x%04" PRIx16 ", lifetime %" PRIu16 - "s", + ", cksum 0x%04" PRIx16 ", lifetime %" PRIu16 "s", circuit->area->area_tag, typechar, rawlspid_print(entry->id), entry->seqno, entry->checksum, entry->rem_lifetime); @@ -1244,12 +1243,10 @@ static int process_snp(uint8_t pdu_type, struct isis_circuit *circuit, ISIS_SYS_ID_LEN + 1); LSP_FRAGMENT(lspid) = 0; lsp0 = lsp_search( - lspid, - circuit->area - ->lspdb[level - 1]); + lspid, + circuit->area->lspdb[level - 1]); if (!lsp0) { - zlog_debug( - "Got lsp frag in snp, while zero not in database"); + zlog_debug("Got lsp frag in snp, while zero not in database"); continue; } } diff --git a/isisd/isis_spf.c b/isisd/isis_spf.c index 0eabcb7e47..0aaa66cdeb 100644 --- a/isisd/isis_spf.c +++ b/isisd/isis_spf.c @@ -85,10 +85,10 @@ struct isis_vertex { struct prefix prefix; } N; - u_int32_t d_N; /* d(N) Distance from this IS */ - u_int16_t depth; /* The depth in the imaginary tree */ - struct list *Adj_N; /* {Adj(N)} next hop or neighbor list */ - struct list *parents; /* list of parents for ECMP */ + u_int32_t d_N; /* d(N) Distance from this IS */ + u_int16_t depth; /* The depth in the imaginary tree */ + struct list *Adj_N; /* {Adj(N)} next hop or neighbor list */ + struct list *parents; /* list of parents for ECMP */ uint64_t insert_counter; }; @@ -276,12 +276,11 @@ static void isis_vertex_queue_delete(struct isis_vertex_queue *queue, struct isis_spftree { struct isis_vertex_queue paths; /* the SPT */ struct isis_vertex_queue tents; /* TENT */ - struct isis_area *area; /* back pointer to area */ - unsigned int runcount; /* number of runs since uptime */ - time_t last_run_timestamp; /* last run timestamp as wall time for - display */ - time_t last_run_monotime; /* last run as monotime for scheduling */ - time_t last_run_duration; /* last run duration in msec */ + struct isis_area *area; /* back pointer to area */ + unsigned int runcount; /* number of runs since uptime */ + time_t last_run_timestamp; /* last run timestamp as wall time for display */ + time_t last_run_monotime; /* last run as monotime for scheduling */ + time_t last_run_duration; /* last run duration in msec */ uint16_t mtid; int family; @@ -831,10 +830,10 @@ static int isis_spf_process_lsp(struct isis_spftree *spftree, return ISIS_OK; /* RFC3787 section 4 SHOULD ignore overload bit in pseudo LSPs */ - bool no_overload = - (pseudo_lsp || (spftree->mtid == ISIS_MT_IPV4_UNICAST + bool no_overload = (pseudo_lsp + || (spftree->mtid == ISIS_MT_IPV4_UNICAST && !ISIS_MASK_LSP_OL_BIT(lsp->hdr.lsp_bits)) - || (mt_router_info && !mt_router_info->overload)); + || (mt_router_info && !mt_router_info->overload)); lspfragloop: if (lsp->hdr.seqno == 0) { @@ -1430,8 +1429,7 @@ int isis_spf_schedule(struct isis_area *area, int level) /* wait configured min_spf_interval before doing the SPF */ long timer; if (diff >= area->min_spf_interval[level - 1]) { - /* Last run is more than min interval ago, schedule immediate - * run */ + /* Last run is more than min interval ago, schedule immediate run */ timer = 0; } else { timer = area->min_spf_interval[level - 1] - diff; @@ -1549,9 +1547,7 @@ DEFUN (show_isis_topology, continue; if (area->ip_circuits > 0 && area->spftree[level - 1] - && isis_vertex_queue_count( - &area->spftree[level - 1]->paths) - > 0) { + && isis_vertex_queue_count(&area->spftree[level - 1]->paths) > 0) { vty_out(vty, "IS-IS paths to level-%d routers that speak IP\n", level); @@ -1561,9 +1557,7 @@ DEFUN (show_isis_topology, vty_out(vty, "\n"); } if (area->ipv6_circuits > 0 && area->spftree6[level - 1] - && isis_vertex_queue_count( - &area->spftree6[level - 1]->paths) - > 0) { + && isis_vertex_queue_count(&area->spftree6[level - 1]->paths) > 0) { vty_out(vty, "IS-IS paths to level-%d routers that speak IPv6\n", level); diff --git a/isisd/isis_te.c b/isisd/isis_te.c index df0b8b62d6..079340b4a4 100644 --- a/isisd/isis_te.c +++ b/isisd/isis_te.c @@ -805,8 +805,7 @@ static u_char print_subtlv_mm_delay(struct sbuf *buf, int indent, A = (u_int32_t)ntohl(tlv->low) & TE_EXT_ANORMAL; high = (u_int32_t)ntohl(tlv->high) & TE_EXT_MASK; - sbuf_push(buf, indent, "%s Min/Max Link Delay: %" PRIu32 " / %" PRIu32 - " (micro-sec)\n", + sbuf_push(buf, indent, "%s Min/Max Link Delay: %" PRIu32 " / %" PRIu32 " (micro-sec)\n", A ? "Anomalous" : "Normal", low, high); return (SUBTLV_HDR_SIZE + SUBTLV_DEF_SIZE); @@ -913,8 +912,8 @@ static u_char print_unknown_tlv(struct sbuf *buf, int indent, } /* Main Show function */ -void mpls_te_print_detail(struct sbuf *buf, int indent, uint8_t *subtlvs, - uint8_t subtlv_len) +void mpls_te_print_detail(struct sbuf *buf, int indent, + uint8_t *subtlvs, uint8_t subtlv_len) { struct subtlv_header *tlvh = (struct subtlv_header *)subtlvs; uint16_t sum = 0; @@ -922,8 +921,7 @@ void mpls_te_print_detail(struct sbuf *buf, int indent, uint8_t *subtlvs, for (; sum < subtlv_len; tlvh = SUBTLV_HDR_NEXT(tlvh)) { switch (tlvh->type) { case TE_SUBTLV_ADMIN_GRP: - sum += print_subtlv_admin_grp( - buf, indent, + sum += print_subtlv_admin_grp(buf, indent, (struct te_subtlv_admin_grp *)tlvh); break; case TE_SUBTLV_LLRI: @@ -931,31 +929,27 @@ void mpls_te_print_detail(struct sbuf *buf, int indent, uint8_t *subtlvs, (struct te_subtlv_llri *)tlvh); break; case TE_SUBTLV_LOCAL_IPADDR: - sum += print_subtlv_local_ipaddr( - buf, indent, + sum += print_subtlv_local_ipaddr(buf, indent, (struct te_subtlv_local_ipaddr *)tlvh); break; case TE_SUBTLV_RMT_IPADDR: - sum += print_subtlv_rmt_ipaddr( - buf, indent, + sum += print_subtlv_rmt_ipaddr(buf, indent, (struct te_subtlv_rmt_ipaddr *)tlvh); break; case TE_SUBTLV_MAX_BW: - sum += print_subtlv_max_bw( - buf, indent, (struct te_subtlv_max_bw *)tlvh); + sum += print_subtlv_max_bw(buf, indent, + (struct te_subtlv_max_bw *)tlvh); break; case TE_SUBTLV_MAX_RSV_BW: - sum += print_subtlv_max_rsv_bw( - buf, indent, + sum += print_subtlv_max_rsv_bw(buf, indent, (struct te_subtlv_max_rsv_bw *)tlvh); break; case TE_SUBTLV_UNRSV_BW: - sum += print_subtlv_unrsv_bw( - buf, indent, (struct te_subtlv_unrsv_bw *)tlvh); + sum += print_subtlv_unrsv_bw(buf, indent, + (struct te_subtlv_unrsv_bw *)tlvh); break; case TE_SUBTLV_TE_METRIC: - sum += print_subtlv_te_metric( - buf, indent, + sum += print_subtlv_te_metric(buf, indent, (struct te_subtlv_te_metric *)tlvh); break; case TE_SUBTLV_RAS: @@ -967,33 +961,32 @@ void mpls_te_print_detail(struct sbuf *buf, int indent, uint8_t *subtlvs, (struct te_subtlv_rip *)tlvh); break; case TE_SUBTLV_AV_DELAY: - sum += print_subtlv_av_delay( - buf, indent, (struct te_subtlv_av_delay *)tlvh); + sum += print_subtlv_av_delay(buf, indent, + (struct te_subtlv_av_delay *)tlvh); break; case TE_SUBTLV_MM_DELAY: - sum += print_subtlv_mm_delay( - buf, indent, (struct te_subtlv_mm_delay *)tlvh); + sum += print_subtlv_mm_delay(buf, indent, + (struct te_subtlv_mm_delay *)tlvh); break; case TE_SUBTLV_DELAY_VAR: - sum += print_subtlv_delay_var( - buf, indent, + sum += print_subtlv_delay_var(buf, indent, (struct te_subtlv_delay_var *)tlvh); break; case TE_SUBTLV_PKT_LOSS: - sum += print_subtlv_pkt_loss( - buf, indent, (struct te_subtlv_pkt_loss *)tlvh); + sum += print_subtlv_pkt_loss(buf, indent, + (struct te_subtlv_pkt_loss *)tlvh); break; case TE_SUBTLV_RES_BW: - sum += print_subtlv_res_bw( - buf, indent, (struct te_subtlv_res_bw *)tlvh); + sum += print_subtlv_res_bw(buf, indent, + (struct te_subtlv_res_bw *)tlvh); break; case TE_SUBTLV_AVA_BW: - sum += print_subtlv_ava_bw( - buf, indent, (struct te_subtlv_ava_bw *)tlvh); + sum += print_subtlv_ava_bw(buf, indent, + (struct te_subtlv_ava_bw *)tlvh); break; case TE_SUBTLV_USE_BW: - sum += print_subtlv_use_bw( - buf, indent, (struct te_subtlv_use_bw *)tlvh); + sum += print_subtlv_use_bw(buf, indent, + (struct te_subtlv_use_bw *)tlvh); break; default: sum += print_unknown_tlv(buf, indent, tlvh); diff --git a/isisd/isis_tlvs.c b/isisd/isis_tlvs.c index 8e0fd74b73..452025bed7 100644 --- a/isisd/isis_tlvs.c +++ b/isisd/isis_tlvs.c @@ -161,11 +161,9 @@ static int unpack_subtlv_ipv6_source_prefix(enum isis_tlv_context context, sbuf_push(log, indent, "Unpacking IPv6 Source Prefix Sub-TLV...\n"); if (tlv_len < 1) { - sbuf_push( - log, indent, - "Not enough data left. (expected 1 or more bytes, got %" PRIu8 - ")\n", - tlv_len); + sbuf_push(log, indent, + "Not enough data left. (expected 1 or more bytes, got %" PRIu8 ")\n", + tlv_len); return 1; } @@ -625,11 +623,10 @@ static int unpack_item_extended_reach(uint16_t mtid, uint8_t len, (mtid == ISIS_MT_IPV4_UNICAST) ? "extended" : "mt"); if (len < 11) { - sbuf_push( - log, indent, - "Not enough data left. (expected 11 or more bytes, got %" PRIu8 - ")\n", - len); + sbuf_push(log, indent, + "Not enough data left. (expected 11 or more bytes, got %" + PRIu8 ")\n", + len); goto out; } @@ -977,7 +974,8 @@ static void format_item_mt_router_info(uint16_t mtid, struct isis_item *i, struct isis_mt_router_info *info = (struct isis_mt_router_info *)i; sbuf_push(buf, indent, "MT Router Info: %s%s%s\n", - isis_mtid2str(info->mtid), info->overload ? " Overload" : "", + isis_mtid2str(info->mtid), + info->overload ? " Overload" : "", info->attached ? " Attached" : ""); } @@ -1126,8 +1124,8 @@ static void format_item_extended_ip_reach(uint16_t mtid, struct isis_item *i, sbuf_push(buf, indent, "%s IP Reachability: %s (Metric: %u)%s", (mtid == ISIS_MT_IPV4_UNICAST) ? "Extended" : "MT", - prefix2str(&r->prefix, prefixbuf, sizeof(prefixbuf)), - r->metric, r->down ? " Down" : ""); + prefix2str(&r->prefix, prefixbuf, sizeof(prefixbuf)), r->metric, + r->down ? " Down" : ""); if (mtid != ISIS_MT_IPV4_UNICAST) sbuf_push(buf, 0, " %s", isis_mtid2str(mtid)); sbuf_push(buf, 0, "\n"); @@ -1180,11 +1178,9 @@ static int unpack_item_extended_ip_reach(uint16_t mtid, uint8_t len, consume = 5; if (len < consume) { - sbuf_push( - log, indent, - "Not enough data left. (expected 5 or more bytes, got %" PRIu8 - ")\n", - len); + sbuf_push(log, indent, + "Not enough data left. (expected 5 or more bytes, got %" PRIu8 ")\n", + len); goto out; } @@ -1203,10 +1199,9 @@ static int unpack_item_extended_ip_reach(uint16_t mtid, uint8_t len, consume += PSIZE(rv->prefix.prefixlen); if (len < consume) { - sbuf_push( - log, indent, - "Expected %u bytes of prefix, but only %u bytes available.\n", - PSIZE(rv->prefix.prefixlen), len - 5); + sbuf_push(log, indent, + "Expected %u bytes of prefix, but only %u bytes available.\n", + PSIZE(rv->prefix.prefixlen), len - 5); goto out; } stream_get(&rv->prefix.prefix.s_addr, s, PSIZE(rv->prefix.prefixlen)); @@ -1221,26 +1216,23 @@ static int unpack_item_extended_ip_reach(uint16_t mtid, uint8_t len, if (control & ISIS_EXTENDED_IP_REACH_SUBTLV) { consume += 1; if (len < consume) { - sbuf_push( - log, indent, - "Expected 1 byte of subtlv len, but no more data present.\n"); + sbuf_push(log, indent, + "Expected 1 byte of subtlv len, but no more data present.\n"); goto out; } subtlv_len = stream_getc(s); if (!subtlv_len) { - sbuf_push( - log, indent + 2, - " WARNING: subtlv bit is set, but there are no subtlvs.\n"); + sbuf_push(log, indent + 2, + " WARNING: subtlv bit is set, but there are no subtlvs.\n"); } consume += subtlv_len; if (len < consume) { - sbuf_push( - log, indent, - "Expected %" PRIu8 - " bytes of subtlvs, but only %u bytes available.\n", - subtlv_len, - len - 6 - PSIZE(rv->prefix.prefixlen)); + sbuf_push(log, indent, + "Expected %" PRIu8 + " bytes of subtlvs, but only %u bytes available.\n", + subtlv_len, + len - 6 - PSIZE(rv->prefix.prefixlen)); goto out; } sbuf_push(log, indent, "Skipping %" PRIu8 " bytes of subvls", @@ -1361,7 +1353,8 @@ static void format_item_ipv6_reach(uint16_t mtid, struct isis_item *i, sbuf_push(buf, indent, "%sIPv6 Reachability: %s (Metric: %u)%s%s", (mtid == ISIS_MT_IPV4_UNICAST) ? "" : "MT ", prefix2str(&r->prefix, prefixbuf, sizeof(prefixbuf)), - r->metric, r->down ? " Down" : "", + r->metric, + r->down ? " Down" : "", r->external ? " External" : ""); if (mtid != ISIS_MT_IPV4_UNICAST) sbuf_push(buf, 0, " %s", isis_mtid2str(mtid)); @@ -1426,11 +1419,10 @@ static int unpack_item_ipv6_reach(uint16_t mtid, uint8_t len, struct stream *s, (mtid == ISIS_MT_IPV4_UNICAST) ? "" : "mt "); consume = 6; if (len < consume) { - sbuf_push( - log, indent, - "Not enough data left. (expected 6 or more bytes, got %" PRIu8 - ")\n", - len); + sbuf_push(log, indent, + "Not enough data left. (expected 6 or more bytes, got %" + PRIu8 ")\n", + len); goto out; } @@ -1451,10 +1443,9 @@ static int unpack_item_ipv6_reach(uint16_t mtid, uint8_t len, struct stream *s, consume += PSIZE(rv->prefix.prefixlen); if (len < consume) { - sbuf_push( - log, indent, - "Expected %u bytes of prefix, but only %u bytes available.\n", - PSIZE(rv->prefix.prefixlen), len - 6); + sbuf_push(log, indent, + "Expected %u bytes of prefix, but only %u bytes available.\n", + PSIZE(rv->prefix.prefixlen), len - 6); goto out; } stream_get(&rv->prefix.prefix.s6_addr, s, PSIZE(rv->prefix.prefixlen)); @@ -1468,26 +1459,23 @@ static int unpack_item_ipv6_reach(uint16_t mtid, uint8_t len, struct stream *s, if (control & ISIS_IPV6_REACH_SUBTLV) { consume += 1; if (len < consume) { - sbuf_push( - log, indent, - "Expected 1 byte of subtlv len, but no more data persent.\n"); + sbuf_push(log, indent, + "Expected 1 byte of subtlv len, but no more data persent.\n"); goto out; } subtlv_len = stream_getc(s); if (!subtlv_len) { - sbuf_push( - log, indent + 2, - " WARNING: subtlv bit set, but there are no subtlvs.\n"); + sbuf_push(log, indent + 2, + " WARNING: subtlv bit set, but there are no subtlvs.\n"); } consume += subtlv_len; if (len < consume) { - sbuf_push( - log, indent, - "Expected %" PRIu8 - " bytes of subtlvs, but only %u bytes available.\n", - subtlv_len, - len - 6 - PSIZE(rv->prefix.prefixlen)); + sbuf_push(log, indent, + "Expected %" PRIu8 + " bytes of subtlvs, but only %u bytes available.\n", + subtlv_len, + len - 6 - PSIZE(rv->prefix.prefixlen)); goto out; } @@ -1710,19 +1698,16 @@ static int pack_item(enum isis_tlv_context context, enum isis_tlv_type type, return 1; } -static void add_item_to_fragment(struct isis_item *i, - struct pack_order_entry *pe, +static void add_item_to_fragment(struct isis_item *i, struct pack_order_entry *pe, struct isis_tlvs *fragment_tlvs, uint16_t mtid) { struct isis_item_list *l; if (pe->how_to_pack == ISIS_ITEMS) { - l = (struct isis_item_list *)(((char *)fragment_tlvs) - + pe->what_to_pack); + l = (struct isis_item_list *)(((char *)fragment_tlvs) + pe->what_to_pack); } else { struct isis_mt_item_list *m; - m = (struct isis_mt_item_list *)(((char *)fragment_tlvs) - + pe->what_to_pack); + m = (struct isis_mt_item_list *)(((char *)fragment_tlvs) + pe->what_to_pack); l = isis_get_mt_items(m, mtid); } @@ -2459,11 +2444,9 @@ static int unpack_tlv(enum isis_tlv_context context, size_t avail_len, tlv_type, tlv_len); if (avail_len < ((size_t)tlv_len) + 2) { - sbuf_push( - log, indent + 2, - "Available data %zu too short for claimed TLV len %" PRIu8 - ".\n", - avail_len - 2, tlv_len); + sbuf_push(log, indent + 2, + "Available data %zu too short for claimed TLV len %" PRIu8 ".\n", + avail_len - 2, tlv_len); return 1; } @@ -2541,7 +2524,7 @@ int isis_unpack_tlvs(size_t avail_len, struct stream *stream, static const struct tlv_ops tlv_##_name_##_ops = { \ .name = _desc_, \ .unpack = unpack_tlv_with_items, \ - \ + \ .pack_item = pack_item_##_name_, \ .free_item = free_item_##_name_, \ .unpack_item = unpack_item_##_name_, \ @@ -2571,49 +2554,34 @@ ITEM_TLV_OPS(ipv6_reach, "TLV 236 IPv6 Reachability"); SUBTLV_OPS(ipv6_source_prefix, "Sub-TLV 22 IPv6 Source Prefix"); -static const struct tlv_ops *tlv_table[ISIS_CONTEXT_MAX][ISIS_TLV_MAX] = - {[ISIS_CONTEXT_LSP] = - { - [ISIS_TLV_AREA_ADDRESSES] = - &tlv_area_address_ops, - [ISIS_TLV_OLDSTYLE_REACH] = - &tlv_oldstyle_reach_ops, - [ISIS_TLV_LAN_NEIGHBORS] = - &tlv_lan_neighbor_ops, - [ISIS_TLV_LSP_ENTRY] = &tlv_lsp_entry_ops, - [ISIS_TLV_AUTH] = &tlv_auth_ops, - [ISIS_TLV_EXTENDED_REACH] = - &tlv_extended_reach_ops, - [ISIS_TLV_MT_REACH] = &tlv_extended_reach_ops, - [ISIS_TLV_OLDSTYLE_IP_REACH] = - &tlv_oldstyle_ip_reach_ops, - [ISIS_TLV_PROTOCOLS_SUPPORTED] = - &tlv_protocols_supported_ops, - [ISIS_TLV_OLDSTYLE_IP_REACH_EXT] = - &tlv_oldstyle_ip_reach_ops, - [ISIS_TLV_IPV4_ADDRESS] = - &tlv_ipv4_address_ops, - [ISIS_TLV_TE_ROUTER_ID] = - &tlv_te_router_id_ops, - [ISIS_TLV_EXTENDED_IP_REACH] = - &tlv_extended_ip_reach_ops, - [ISIS_TLV_MT_IP_REACH] = - &tlv_extended_ip_reach_ops, - [ISIS_TLV_DYNAMIC_HOSTNAME] = - &tlv_dynamic_hostname_ops, - [ISIS_TLV_MT_ROUTER_INFO] = - &tlv_mt_router_info_ops, - [ISIS_TLV_IPV6_ADDRESS] = - &tlv_ipv6_address_ops, - [ISIS_TLV_IPV6_REACH] = &tlv_ipv6_reach_ops, - [ISIS_TLV_MT_IPV6_REACH] = &tlv_ipv6_reach_ops, - }, - [ISIS_CONTEXT_SUBTLV_NE_REACH] = {}, - [ISIS_CONTEXT_SUBTLV_IP_REACH] = {}, - [ISIS_CONTEXT_SUBTLV_IPV6_REACH] = { - [ISIS_SUBTLV_IPV6_SOURCE_PREFIX] = - &subtlv_ipv6_source_prefix_ops, - }}; +static const struct tlv_ops *tlv_table[ISIS_CONTEXT_MAX][ISIS_TLV_MAX] = { + [ISIS_CONTEXT_LSP] = { + [ISIS_TLV_AREA_ADDRESSES] = &tlv_area_address_ops, + [ISIS_TLV_OLDSTYLE_REACH] = &tlv_oldstyle_reach_ops, + [ISIS_TLV_LAN_NEIGHBORS] = &tlv_lan_neighbor_ops, + [ISIS_TLV_LSP_ENTRY] = &tlv_lsp_entry_ops, + [ISIS_TLV_AUTH] = &tlv_auth_ops, + [ISIS_TLV_EXTENDED_REACH] = &tlv_extended_reach_ops, + [ISIS_TLV_MT_REACH] = &tlv_extended_reach_ops, + [ISIS_TLV_OLDSTYLE_IP_REACH] = &tlv_oldstyle_ip_reach_ops, + [ISIS_TLV_PROTOCOLS_SUPPORTED] = &tlv_protocols_supported_ops, + [ISIS_TLV_OLDSTYLE_IP_REACH_EXT] = &tlv_oldstyle_ip_reach_ops, + [ISIS_TLV_IPV4_ADDRESS] = &tlv_ipv4_address_ops, + [ISIS_TLV_TE_ROUTER_ID] = &tlv_te_router_id_ops, + [ISIS_TLV_EXTENDED_IP_REACH] = &tlv_extended_ip_reach_ops, + [ISIS_TLV_MT_IP_REACH] = &tlv_extended_ip_reach_ops, + [ISIS_TLV_DYNAMIC_HOSTNAME] = &tlv_dynamic_hostname_ops, + [ISIS_TLV_MT_ROUTER_INFO] = &tlv_mt_router_info_ops, + [ISIS_TLV_IPV6_ADDRESS] = &tlv_ipv6_address_ops, + [ISIS_TLV_IPV6_REACH] = &tlv_ipv6_reach_ops, + [ISIS_TLV_MT_IPV6_REACH] = &tlv_ipv6_reach_ops, + }, + [ISIS_CONTEXT_SUBTLV_NE_REACH] = {}, + [ISIS_CONTEXT_SUBTLV_IP_REACH] = {}, + [ISIS_CONTEXT_SUBTLV_IPV6_REACH] = { + [ISIS_SUBTLV_IPV6_SOURCE_PREFIX] = &subtlv_ipv6_source_prefix_ops, + } +}; /* Accessor functions */ diff --git a/isisd/isisd.h b/isisd/isisd.h index a8dcc8adaf..4cf164d00a 100644 --- a/isisd/isisd.h +++ b/isisd/isisd.h @@ -52,9 +52,8 @@ struct isis { struct area_addr *man_area_addrs; /* manualAreaAddresses */ u_int32_t debugs; /* bitmap for debug */ time_t uptime; /* when did we start */ - struct thread *t_dync_clean; /* dynamic hostname cache cleanup thread */ - uint32_t circuit_ids_used - [8]; /* 256 bits to track circuit ids 0 through 255 */ + struct thread *t_dync_clean; /* dynamic hostname cache cleanup thread */ + uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 0 through 255 */ struct route_table *ext_info[REDIST_PROTOCOL_COUNT]; From c59f88c80947eb22a528ca269fca04e5015d6d45 Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 18:42:30 +0100 Subject: [PATCH 111/148] isisd: cleanup usage of circuit_id Signed-off-by: Christian Franke --- isisd/isis_circuit.c | 23 ++++++++++------------- isisd/isis_circuit.h | 2 -- isisd/isis_pdu.c | 2 +- isisd/isisd.h | 2 +- 4 files changed, 12 insertions(+), 17 deletions(-) diff --git a/isisd/isis_circuit.c b/isisd/isis_circuit.c index a2d1e75d94..4341584a24 100644 --- a/isisd/isis_circuit.c +++ b/isisd/isis_circuit.c @@ -234,8 +234,8 @@ void isis_circuit_add_addr(struct isis_circuit *circuit, #ifdef EXTREME_DEBUG prefix2str(connected->address, buf, sizeof(buf)); - zlog_debug("Added IP address %s to circuit %d", buf, - circuit->circuit_id); + zlog_debug("Added IP address %s to circuit %s", buf, + circuit->interface->name); #endif /* EXTREME_DEBUG */ } if (connected->address->family == AF_INET6) { @@ -265,8 +265,8 @@ void isis_circuit_add_addr(struct isis_circuit *circuit, #ifdef EXTREME_DEBUG prefix2str(connected->address, buf, sizeof(buf)); - zlog_debug("Added IPv6 address %s to circuit %d", buf, - circuit->circuit_id); + zlog_debug("Added IPv6 address %s to circuit %s", buf, + circuit->interface->name); #endif /* EXTREME_DEBUG */ } return; @@ -300,9 +300,9 @@ void isis_circuit_del_addr(struct isis_circuit *circuit, } else { prefix2str(connected->address, buf, sizeof(buf)); zlog_warn( - "Nonexistant ip address %s removal attempt from \ - circuit %d", - buf, circuit->circuit_id); + "Nonexistent ip address %s removal attempt from \ + circuit %s", + buf, circuit->interface->name); zlog_warn("Current ip addresses on %s:", circuit->interface->name); for (ALL_LIST_ELEMENTS_RO(circuit->ip_addrs, node, @@ -349,9 +349,9 @@ void isis_circuit_del_addr(struct isis_circuit *circuit, if (!found) { prefix2str(connected->address, buf, sizeof(buf)); zlog_warn( - "Nonexitant ip address %s removal attempt from \ - circuit %d", - buf, circuit->circuit_id); + "Nonexistent ip address %s removal attempt from \ + circuit %s", + buf, circuit->interface->name); zlog_warn("Current ip addresses on %s:", circuit->interface->name); for (ALL_LIST_ELEMENTS_RO(circuit->ipv6_link, node, @@ -458,19 +458,16 @@ void isis_circuit_if_del(struct isis_circuit *circuit, struct interface *ifp) if (circuit->ip_addrs) { assert(listcount(circuit->ip_addrs) == 0); list_delete_and_null(&circuit->ip_addrs); - circuit->ip_addrs = NULL; } if (circuit->ipv6_link) { assert(listcount(circuit->ipv6_link) == 0); list_delete_and_null(&circuit->ipv6_link); - circuit->ipv6_link = NULL; } if (circuit->ipv6_non_link) { assert(listcount(circuit->ipv6_non_link) == 0); list_delete_and_null(&circuit->ipv6_non_link); - circuit->ipv6_non_link = NULL; } circuit->circ_type = CIRCUIT_T_UNKNOWN; diff --git a/isisd/isis_circuit.h b/isisd/isis_circuit.h index 3d97d42b5e..367ad51f57 100644 --- a/isisd/isis_circuit.h +++ b/isisd/isis_circuit.h @@ -32,8 +32,6 @@ #include "isis_constants.h" #include "isis_common.h" -#define CIRCUIT_MAX 255 - struct isis_lsp; struct password { diff --git a/isisd/isis_pdu.c b/isisd/isis_pdu.c index cdbfb0e653..20a491ac18 100644 --- a/isisd/isis_pdu.c +++ b/isisd/isis_pdu.c @@ -415,7 +415,7 @@ static int process_p2p_hello(struct iih_info *iih) if (isis->debugs & DEBUG_ADJ_PACKETS) { zlog_debug( "ISIS-Adj (%s): Rcvd P2P IIH from (%s), cir type %s," - " cir id %02d, length %d", + " cir id %hhu, length %" PRIu16, iih->circuit->area->area_tag, iih->circuit->interface->name, circuit_t2string(iih->circuit->is_type), diff --git a/isisd/isisd.h b/isisd/isisd.h index 4cf164d00a..85d3974fa6 100644 --- a/isisd/isisd.h +++ b/isisd/isisd.h @@ -53,7 +53,7 @@ struct isis { u_int32_t debugs; /* bitmap for debug */ time_t uptime; /* when did we start */ struct thread *t_dync_clean; /* dynamic hostname cache cleanup thread */ - uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 0 through 255 */ + uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 1 through 255 */ struct route_table *ext_info[REDIST_PROTOCOL_COUNT]; From 0849c75e5d75d25b0d330545451295edfe8d23be Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 18:45:02 +0100 Subject: [PATCH 112/148] isisd: allocate circuit_id only for broadcast circuits Signed-off-by: Christian Franke --- isisd/isis_circuit.c | 22 +++++++++++----------- isisd/isis_circuit.h | 2 +- isisd/isis_csm.c | 9 --------- isisd/isis_spf.c | 4 ++-- 4 files changed, 14 insertions(+), 23 deletions(-) diff --git a/isisd/isis_circuit.c b/isisd/isis_circuit.c index 4341584a24..c8642b623d 100644 --- a/isisd/isis_circuit.c +++ b/isisd/isis_circuit.c @@ -377,7 +377,7 @@ void isis_circuit_del_addr(struct isis_circuit *circuit, return; } -static uint8_t isis_circuit_id_gen(struct interface *ifp) +static uint8_t isis_circuit_id_gen(struct isis *isis, struct interface *ifp) { /* Circuit ids MUST be unique for any broadcast circuits. Otherwise, * Pseudo-Node LSPs cannot be generated correctly. @@ -403,6 +403,7 @@ static uint8_t isis_circuit_id_gen(struct interface *ifp) return 0; } + _ISIS_SET_FLAG(isis->circuit_ids_used, id); return id; } @@ -411,11 +412,7 @@ void isis_circuit_if_add(struct isis_circuit *circuit, struct interface *ifp) struct listnode *node, *nnode; struct connected *conn; - circuit->circuit_id = isis_circuit_id_gen(ifp); - _ISIS_SET_FLAG(isis->circuit_ids_used, circuit->circuit_id); - isis_circuit_if_bind(circuit, ifp); - /* isis_circuit_update_addrs (circuit, ifp); */ if (if_is_broadcast(ifp)) { if (circuit->circ_type_config == CIRCUIT_T_P2P) @@ -440,8 +437,6 @@ void isis_circuit_if_add(struct isis_circuit *circuit, struct interface *ifp) for (ALL_LIST_ELEMENTS(ifp->connected, node, nnode, conn)) isis_circuit_add_addr(circuit, conn); - - return; } void isis_circuit_if_del(struct isis_circuit *circuit, struct interface *ifp) @@ -471,10 +466,6 @@ void isis_circuit_if_del(struct isis_circuit *circuit, struct interface *ifp) } circuit->circ_type = CIRCUIT_T_UNKNOWN; - _ISIS_CLEAR_FLAG(isis->circuit_ids_used, circuit->circuit_id); - circuit->circuit_id = 0; - - return; } void isis_circuit_if_bind(struct isis_circuit *circuit, struct interface *ifp) @@ -588,6 +579,12 @@ int isis_circuit_up(struct isis_circuit *circuit) } if (circuit->circ_type == CIRCUIT_T_BROADCAST) { + circuit->circuit_id = isis_circuit_id_gen(isis, circuit->interface); + if (!circuit->circuit_id) { + zlog_err("There are already 255 broadcast circuits active!"); + return ISIS_ERROR; + } + /* * Get the Hardware Address */ @@ -732,6 +729,9 @@ void isis_circuit_down(struct isis_circuit *circuit) THREAD_TIMER_OFF(circuit->u.bc.t_refresh_pseudo_lsp[1]); circuit->lsp_regenerate_pending[0] = 0; circuit->lsp_regenerate_pending[1] = 0; + + _ISIS_CLEAR_FLAG(isis->circuit_ids_used, circuit->circuit_id); + circuit->circuit_id = 0; } else if (circuit->circ_type == CIRCUIT_T_P2P) { isis_delete_adj(circuit->u.p2p.neighbor); circuit->u.p2p.neighbor = NULL; diff --git a/isisd/isis_circuit.h b/isisd/isis_circuit.h index 367ad51f57..de6e7f2d87 100644 --- a/isisd/isis_circuit.h +++ b/isisd/isis_circuit.h @@ -67,7 +67,7 @@ struct isis_p2p_info { struct isis_circuit { int state; - u_char circuit_id; /* l1/l2 p2p/bcast CircuitID */ + u_char circuit_id; /* l1/l2 bcast CircuitID */ struct isis_area *area; /* back pointer to the area */ struct interface *interface; /* interface info from z */ int fd; /* IS-IS l1/2 socket */ diff --git a/isisd/isis_csm.c b/isisd/isis_csm.c index a283260d92..10870d5c50 100644 --- a/isisd/isis_csm.c +++ b/isisd/isis_csm.c @@ -86,13 +86,6 @@ isis_csm_state_change(int event, struct isis_circuit *circuit, void *arg) case IF_UP_FROM_Z: circuit = isis_circuit_new(); isis_circuit_if_add(circuit, (struct interface *)arg); - if (!circuit->circuit_id) { - isis_circuit_if_del(circuit, - (struct interface *)arg); - isis_circuit_del(circuit); - circuit = NULL; - break; - } listnode_add(isis->init_circ_list, circuit); circuit->state = C_STATE_INIT; break; @@ -143,8 +136,6 @@ isis_csm_state_change(int event, struct isis_circuit *circuit, void *arg) break; case IF_UP_FROM_Z: isis_circuit_if_add(circuit, (struct interface *)arg); - if (!circuit->circuit_id) - break; if (isis_circuit_up(circuit) != ISIS_OK) { zlog_err( "Could not bring up %s because of invalid config.", diff --git a/isisd/isis_spf.c b/isisd/isis_spf.c index 0aaa66cdeb..ee447d01f7 100644 --- a/isisd/isis_spf.c +++ b/isisd/isis_spf.c @@ -334,12 +334,12 @@ static void remove_excess_adjs(struct list *adjs) if (comp < 0) continue; - if (candidate->circuit->circuit_id > adj->circuit->circuit_id) { + if (candidate->circuit->idx > adj->circuit->idx) { excess = node; continue; } - if (candidate->circuit->circuit_id < adj->circuit->circuit_id) + if (candidate->circuit->idx < adj->circuit->idx) continue; comp = memcmp(candidate->snpa, adj->snpa, ETH_ALEN); From 97035386217665c3ac4536b32c4edc122266603f Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 18:45:36 +0100 Subject: [PATCH 113/148] isisd: remove unused debug code Signed-off-by: Christian Franke --- isisd/isis_route.c | 40 ---------------------------------------- 1 file changed, 40 deletions(-) diff --git a/isisd/isis_route.c b/isisd/isis_route.c index b9605018ed..ad769f9886 100644 --- a/isisd/isis_route.c +++ b/isisd/isis_route.c @@ -100,26 +100,6 @@ static int nexthoplookup(struct list *nexthops, struct in_addr *ip, return 0; } -#ifdef EXTREME_DEBUG -static void nexthop_print(struct isis_nexthop *nh) -{ - u_char buf[BUFSIZ]; - - inet_ntop(AF_INET, &nh->ip, (char *)buf, BUFSIZ); - - zlog_debug(" %s %u", buf, nh->ifindex); -} - -static void nexthops_print(struct list *nhs) -{ - struct listnode *node; - struct isis_nexthop *nh; - - for (ALL_LIST_ELEMENTS_RO(nhs, node, nh)) - nexthop_print(nh); -} -#endif /* EXTREME_DEBUG */ - static struct isis_nexthop6 *isis_nexthop6_new(struct in6_addr *ip6, ifindex_t ifindex) { @@ -184,26 +164,6 @@ static int nexthop6lookup(struct list *nexthops6, struct in6_addr *ip6, return 0; } -#ifdef EXTREME_DEBUG -static void nexthop6_print(struct isis_nexthop6 *nh6) -{ - u_char buf[BUFSIZ]; - - inet_ntop(AF_INET6, &nh6->ip6, (char *)buf, BUFSIZ); - - zlog_debug(" %s %u", buf, nh6->ifindex); -} - -static void nexthops6_print(struct list *nhs6) -{ - struct listnode *node; - struct isis_nexthop6 *nh6; - - for (ALL_LIST_ELEMENTS_RO(nhs6, node, nh6)) - nexthop6_print(nh6); -} -#endif /* EXTREME_DEBUG */ - static void adjinfo2nexthop(struct list *nexthops, struct isis_adjacency *adj) { struct isis_nexthop *nh; From 9fe21208143e9a1ab2fcdc8e782c0de57b4891db Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 18:51:17 +0100 Subject: [PATCH 114/148] isisd: add support for TLV 240 P2P Three-Way Adjacency Signed-off-by: Christian Franke --- isisd/isis_tlvs.c | 147 ++++++++++++++++++++++ isisd/isis_tlvs.h | 24 ++++ tests/isisd/test_fuzz_isis_tlv_tests.h.gz | Bin 232370 -> 262877 bytes 3 files changed, 171 insertions(+) diff --git a/isisd/isis_tlvs.c b/isisd/isis_tlvs.c index 452025bed7..66a19e150f 100644 --- a/isisd/isis_tlvs.c +++ b/isisd/isis_tlvs.c @@ -1329,6 +1329,119 @@ static int unpack_tlv_dynamic_hostname(enum isis_tlv_context context, return 0; } +/* Functions related to TLV 240 P2P Three-Way Adjacency */ + +const char *isis_threeway_state_name(enum isis_threeway_state state) +{ + switch (state) { + case ISIS_THREEWAY_DOWN: + return "Down"; + case ISIS_THREEWAY_INITIALIZING: + return "Initializing"; + case ISIS_THREEWAY_UP: + return "Up"; + default: + return "Invalid!"; + } +} + +static struct isis_threeway_adj *copy_tlv_threeway_adj( + const struct isis_threeway_adj *threeway_adj) +{ + if (!threeway_adj) + return NULL; + + struct isis_threeway_adj *rv = XMALLOC(MTYPE_ISIS_TLV, sizeof(*rv)); + memcpy(rv, threeway_adj, sizeof(*rv)); + + return rv; +} + +static void format_tlv_threeway_adj(const struct isis_threeway_adj *threeway_adj, + struct sbuf *buf, int indent) +{ + if (!threeway_adj) + return; + + sbuf_push(buf, indent, "P2P Three-Way Adjacency:\n"); + sbuf_push(buf, indent, " State: %s (%d)\n", + isis_threeway_state_name(threeway_adj->state), + threeway_adj->state); + sbuf_push(buf, indent, " Extended Local Circuit ID: %" PRIu32 "\n", + threeway_adj->local_circuit_id); + if (!threeway_adj->neighbor_set) + return; + + sbuf_push(buf, indent, " Neighbor System ID: %s\n", + isis_format_id(threeway_adj->neighbor_id, 6)); + sbuf_push(buf, indent, " Neighbor Extended Circuit ID: %" PRIu32 "\n", + threeway_adj->neighbor_circuit_id); +} + +static void free_tlv_threeway_adj(struct isis_threeway_adj *threeway_adj) +{ + XFREE(MTYPE_ISIS_TLV, threeway_adj); +} + +static int pack_tlv_threeway_adj(const struct isis_threeway_adj *threeway_adj, + struct stream *s) +{ + if (!threeway_adj) + return 0; + + uint8_t tlv_len = (threeway_adj->neighbor_set) ? 15 : 5; + + if (STREAM_WRITEABLE(s) < (unsigned)(2 + tlv_len)) + return 1; + + stream_putc(s, ISIS_TLV_THREE_WAY_ADJ); + stream_putc(s, tlv_len); + stream_putc(s, threeway_adj->state); + stream_putl(s, threeway_adj->local_circuit_id); + + if (threeway_adj->neighbor_set) { + stream_put(s, threeway_adj->neighbor_id, 6); + stream_putl(s, threeway_adj->neighbor_circuit_id); + } + + return 0; +} + +static int unpack_tlv_threeway_adj(enum isis_tlv_context context, + uint8_t tlv_type, uint8_t tlv_len, + struct stream *s, struct sbuf *log, + void *dest, int indent) +{ + struct isis_tlvs *tlvs = dest; + + sbuf_push(log, indent, "Unpacking P2P Three-Way Adjacency TLV...\n"); + if (tlv_len != 5 && tlv_len != 15) { + sbuf_push(log, indent, "WARNING: Unexepected TLV size\n"); + stream_forward_getp(s, tlv_len); + return 0; + } + + if (tlvs->threeway_adj) { + sbuf_push(log, indent, + "WARNING: P2P Three-Way Adjacency TLV present multiple times.\n"); + stream_forward_getp(s, tlv_len); + return 0; + } + + tlvs->threeway_adj = XCALLOC(MTYPE_ISIS_TLV, sizeof(*tlvs->threeway_adj)); + + tlvs->threeway_adj->state = stream_getc(s); + tlvs->threeway_adj->local_circuit_id = stream_getl(s); + + if (tlv_len == 15) { + tlvs->threeway_adj->neighbor_set = true; + stream_get(tlvs->threeway_adj->neighbor_id, s, 6); + tlvs->threeway_adj->neighbor_circuit_id = stream_getl(s); + } + + return 0; +} + /* Functions related to TLVs 236/237 IPv6/MT-IPv6 reach */ static struct isis_item *copy_item_ipv6_reach(struct isis_item *i) @@ -2067,6 +2180,8 @@ struct isis_tlvs *isis_copy_tlvs(struct isis_tlvs *tlvs) copy_mt_items(ISIS_CONTEXT_LSP, ISIS_TLV_MT_IPV6_REACH, &tlvs->mt_ipv6_reach, &rv->mt_ipv6_reach); + rv->threeway_adj = copy_tlv_threeway_adj(tlvs->threeway_adj); + return rv; } @@ -2128,6 +2243,8 @@ static void format_tlvs(struct isis_tlvs *tlvs, struct sbuf *buf, int indent) format_mt_items(ISIS_CONTEXT_LSP, ISIS_TLV_MT_IPV6_REACH, &tlvs->mt_ipv6_reach, buf, indent); + + format_tlv_threeway_adj(tlvs->threeway_adj, buf, indent); } const char *isis_format_tlvs(struct isis_tlvs *tlvs) @@ -2178,6 +2295,7 @@ void isis_free_tlvs(struct isis_tlvs *tlvs) free_items(ISIS_CONTEXT_LSP, ISIS_TLV_IPV6_REACH, &tlvs->ipv6_reach); free_mt_items(ISIS_CONTEXT_LSP, ISIS_TLV_MT_IPV6_REACH, &tlvs->mt_ipv6_reach); + free_tlv_threeway_adj(tlvs->threeway_adj); XFREE(MTYPE_ISIS_TLV, tlvs); } @@ -2349,6 +2467,14 @@ static int pack_tlvs(struct isis_tlvs *tlvs, struct stream *stream, copy_tlv_te_router_id(tlvs->te_router_id); } + rv = pack_tlv_threeway_adj(tlvs->threeway_adj, stream); + if (rv) + return rv; + if (fragment_tlvs) { + fragment_tlvs->threeway_adj = + copy_tlv_threeway_adj(tlvs->threeway_adj); + } + for (size_t pack_idx = 0; pack_idx < array_size(pack_order); pack_idx++) { rv = handle_pack_entry(&pack_order[pack_idx], tlvs, stream, @@ -2549,6 +2675,7 @@ TLV_OPS(te_router_id, "TLV 134 TE Router ID"); ITEM_TLV_OPS(extended_ip_reach, "TLV 135 Extended IP Reachability"); TLV_OPS(dynamic_hostname, "TLV 137 Dynamic Hostname"); ITEM_TLV_OPS(mt_router_info, "TLV 229 MT Router Information"); +TLV_OPS(threeway_adj, "TLV 240 P2P Three-Way Adjacency"); ITEM_TLV_OPS(ipv6_address, "TLV 232 IPv6 Interface Address"); ITEM_TLV_OPS(ipv6_reach, "TLV 236 IPv6 Reachability"); @@ -2572,6 +2699,7 @@ static const struct tlv_ops *tlv_table[ISIS_CONTEXT_MAX][ISIS_TLV_MAX] = { [ISIS_TLV_MT_IP_REACH] = &tlv_extended_ip_reach_ops, [ISIS_TLV_DYNAMIC_HOSTNAME] = &tlv_dynamic_hostname_ops, [ISIS_TLV_MT_ROUTER_INFO] = &tlv_mt_router_info_ops, + [ISIS_TLV_THREE_WAY_ADJ] = &tlv_threeway_adj_ops, [ISIS_TLV_IPV6_ADDRESS] = &tlv_ipv6_address_ops, [ISIS_TLV_IPV6_REACH] = &tlv_ipv6_reach_ops, [ISIS_TLV_MT_IPV6_REACH] = &tlv_ipv6_reach_ops, @@ -3072,6 +3200,25 @@ void isis_tlvs_add_extended_reach(struct isis_tlvs *tlvs, uint16_t mtid, append_item(l, (struct isis_item *)r); } +void isis_tlvs_add_threeway_adj(struct isis_tlvs *tlvs, + enum isis_threeway_state state, + uint32_t local_circuit_id, + const uint8_t *neighbor_id, + uint32_t neighbor_circuit_id) +{ + assert(!tlvs->threeway_adj); + + tlvs->threeway_adj = XCALLOC(MTYPE_ISIS_TLV, sizeof(*tlvs->threeway_adj)); + tlvs->threeway_adj->state = state; + tlvs->threeway_adj->local_circuit_id = local_circuit_id; + + if (neighbor_id) { + tlvs->threeway_adj->neighbor_set = true; + memcpy(tlvs->threeway_adj->neighbor_id, neighbor_id, 6); + tlvs->threeway_adj->neighbor_circuit_id = neighbor_circuit_id; + } +} + struct isis_mt_router_info * isis_tlvs_lookup_mt_router_info(struct isis_tlvs *tlvs, uint16_t mtid) { diff --git a/isisd/isis_tlvs.h b/isisd/isis_tlvs.h index 6ade0af28c..98edbf14e7 100644 --- a/isisd/isis_tlvs.h +++ b/isisd/isis_tlvs.h @@ -103,6 +103,20 @@ struct isis_protocols_supported { uint8_t *protocols; }; +enum isis_threeway_state { + ISIS_THREEWAY_DOWN = 2, + ISIS_THREEWAY_INITIALIZING = 1, + ISIS_THREEWAY_UP = 0 +}; + +struct isis_threeway_adj { + enum isis_threeway_state state; + uint32_t local_circuit_id; + bool neighbor_set; + uint8_t neighbor_id[6]; + uint32_t neighbor_circuit_id; +}; + struct isis_item; struct isis_item { struct isis_item *next; @@ -190,6 +204,7 @@ struct isis_tlvs { char *hostname; struct isis_item_list ipv6_reach; struct isis_mt_item_list mt_ipv6_reach; + struct isis_threeway_adj *threeway_adj; }; struct isis_subtlvs { @@ -227,6 +242,7 @@ enum isis_tlv_type { ISIS_TLV_MT_IP_REACH = 235, ISIS_TLV_IPV6_REACH = 236, ISIS_TLV_MT_IPV6_REACH = 237, + ISIS_TLV_THREE_WAY_ADJ = 240, ISIS_TLV_MAX = 256, ISIS_SUBTLV_IPV6_SOURCE_PREFIX = 22 @@ -303,6 +319,14 @@ void isis_tlvs_add_extended_reach(struct isis_tlvs *tlvs, uint16_t mtid, uint8_t *id, uint32_t metric, uint8_t *subtlvs, uint8_t subtlv_len); +const char *isis_threeway_state_name(enum isis_threeway_state state); + +void isis_tlvs_add_threeway_adj(struct isis_tlvs *tlvs, + enum isis_threeway_state state, + uint32_t local_circuit_id, + const uint8_t *neighbor_id, + uint32_t neighbor_circuit_id); + struct isis_mt_router_info * isis_tlvs_lookup_mt_router_info(struct isis_tlvs *tlvs, uint16_t mtid); #endif diff --git a/tests/isisd/test_fuzz_isis_tlv_tests.h.gz b/tests/isisd/test_fuzz_isis_tlv_tests.h.gz index 3eb0205a5db812b83d5818bf4c161dcdeadcd7b3..cca702b138f99f61f49760b0d403c8379f085109 100644 GIT binary patch literal 262877 zcmd?RcT|(v76&?BN1Yi|Mo~I4D#D-?>CzGv1(BvAy+nEqh)5@7Y#`D^dJTerbV8Mu zsFX;Jv;-0$3POMoVhBk{LXsD!+GCAO&IG=IvI98-J~jZI=x$o1hb5nU4R>^+~Ksw%l+dTGt{mtPVG z-TG-xaCbQtf!j_2@$jmA7Lv!11*IanaXYu5al5-z6jV1BxXYq0HS)Ju$T$`#j)&Sr z@_55J{9aiCUk8ZTMa%MGy*X(VJ}GA&%H83C4)dwYC|OV(hiXx@QpTf#gauW6Ry%(S z1dU}G#Ilz7F*`IUi`Fg+JWPOAMeI-(_yvSi0yAMLhrbKlt>o{L_*CdFj8_TbtMb?Q zTd+7TnvdlZ8=@!qEH1K&&&4x)M^2DckUSVKn7`B@c!&oSe3<;+oW_M+Jae7`WG1Nc z@%$Y)pPUBbk@)rPYiI(3pYyqmOF=@4139}(X#|dxFqFrF+(p0$(3%Jv`~u0EKgZqK zTKXyr4437H>})YP_)P(GRHHp?+Ax%ZXF~bAR00yoMFsPby$wLbDh$bs+u;$I5u7Dr z+CtoDaPv|yLBJ{P2A>Jz^R}b6mVrDFpQ6gIZs753oxU=X5I1^02hg#fo7v}Pu&{*n zhFyDZSj(+!Tj=piTtjty_$c7gO=tr@VkQEW9l|xN<*{!l0wXrC!F3X6rCJq3N_4aw z0?f_Ut-a|dqaf9_00XmXWGOpy_FbS3lFrX!twZU{8ewxjG-S(yLRFeYGn-Fm?38K0 zv|Q^`bMPC3>7Y>Sxo@4@$F93-V{K-wiIe!_)q%Uw<1fwDJJWS@NOUsIqR8yl3y1E* zG7Ss5`x({Us|NclitiVn&IqPC;eCp%0^I6fGKCAcl^gd)YuK>!7L1hny8Rs;mcESE z`yUv?4$5s{0?X+ZU)5$~oz%DZC>?%v>}D<{T^C#5>_81~ZJ5R^p2T7qs@*|>_2m%u zd1}-~EZ}T@KmgRr95B4%NbWegq*2bQ2WXfz_pRDWazvIYJC=?1ri=$(Y5ve?j`p=v zno>Ex(Y#{MmC(YDJ38V<*IE*Dz569q-5odF%tcal&dOFnHb)A}#K$l08aD0p%`>&r z^m}Kg2HDV?5r7`#&P~l?!o_wWgd_OpNfpzK8^N^&_Vk8TE*Tbly6)HMi60-XXq+&u z{xubxHX4G$Z8T@_I8moC>sk==Lzid{&Re#uNu$lh#i&Suy9#S& z8dA0k9h(2kkdZkf4dnHmEH8C%r6LNJ=Tix@Up%KK}-* zWC7SwHuf@+7(P5*zqTCV?`Ul1)KcM9?KHT`jqJI)6xyk(Jb4sdMqceci@o<&tu;FS zy?lG5sgL44V&{f{7dg=mir0z!hQ)0yBGN|h1P6IqI56M* zvmS9)w(|o2tHHe9)nSHkgqX8Oq6#aFHJj;e$F5@UQqYkBmLQmDGJ<7N6_n^S3=C?~M7$Bk+kG@YpVuPKWXM@H-1i zd!|$LK4&=~$%DU@<1a6jxwTu&W>2xq-^&AgmP9n*Y6diL+9(Rjf;z(g6loouK{VFB=fSJ{{#5gL!Nk(4tRFLvh zC+{doY~{X2E078%+36;h=Nr71nBuyYx8t?;%u@I%s45W@H9a5X)6#WCr@4%iGMvx0!qW&YAJmbVVljOP1xKAlx5|p85&7=VuDz<=yjvYUF$X z|Dsb1?gkQStWR0OzhDh?@c8@S zBpcbn)BW~!7+*+l&?Tw8{otDh>}~^=0NG`N!Vg$iB|m7pAVP9xeqKDVv*-6F{%A<>jYP6zdg4G^ z!#zj;Z{#ZwRGcX0<}yK}_NazJ^#wD4(tts4br;5H1(qS-8v1c>PksKQ>`<$$x|dd< zH-|spLcSS5_!5{7J^ag{j;T$vp&s@@7a!K9sDHmu z9aeYfW{zwT(xb9nrFj5(Cf?Jb-GZN57m#hyJ*(L)>pA+A6QDT(1PJMFy%= zTb;q0E9>V^TCsc!8a$RNsU{g>#3pgu`L14>q0)d^S|{SLg^aUawpc6F0Gt!*x>uwj zEgOwm3B^(^ExH5n&bGR_+rik*n5$B_PV+33%QWWYmZ50@?R9QZ=88U_)XMiBUVn^< z3d{=Kj@{w2qf@6&hKM?8T|0mCk#xAlX!@@m>lBl)&X$fZ&ex?G>Bk-)=6pHK@wCc5 zDjfJGth!ZIbfe+&*cnsSdB1?QmgADg`%N`86YJz>#{AV~I?rCy>GIC6$*{=_$k0-s z|56%V=N)i6EKTQUj*1Mf>rUj_#OKoudEP>uqvd{*^Pz91nyiHLo*lA|LzcT)+X2UR zzj|N;0*t%7Bjt4MscKr`iaklj$nXmuYj=sCb_erl%=inD5#{Tpl zKiyxeK8{z8+}@nqIsk&0fzXb)sTCc+7rR!fIURQ#%+>GlJXdy&2>0lUF?h4aYx>X( ziU&T{BR%(wR!3%8qhe)rl%+$F3eCYERT5i$uYCBq1UAQ{$y{~Rw0X|WYwYF9E87+6 zG>aFyY47`l=~2le{OQaNT&3>{XnAJ08LxUHw3*%pSq!g*SY%bCDl;lko40pgcf9WC z63)8UeD7MS4Y3vy*s$f6YC}W$12l4W506RI_>tHK2}Y>CtX_Z)XIUmePW(&oqJ3D3 z?IVf!Av?}2+ux?W+vgD1R!kB^z9A-^n7 z8mgL3)n2qF7VA|GCAEcoDSVLEPG*_T1PUpGZ4Bp%LkWeUN@;nzmKUT)w^}~KKYxH< z&sp^7u9Z26HyW)>HkrZj&xIan(}+9zWN#aXMlAHuudurf&3<-M{k?5#!Yk(|OUu{# zQLe1kSq#26pYT!~Xxl&IfGqkNWwXE1{pMXaiQ8ex`Ph5Pk3QGyw;gOa_o%e$td6Yg zrdp#?j*DG?C8M)^{7l<@&??O1V6z7GO3vgFP?K(Ks!Ys4PE(o?WNr0EgUj2K=Bi0V zEc=D)S?JXfiBYqalC`IXL+#gd*j|Z-6@|_+dp(As=7vDYy=74`_xYO>+9M&Z0bmpL z@pwfg(0SB})Jm)iEN0%!hBomwv6=g2LOXd%O9$MmM1{M%Ny(E^xliZTTdTC& z`mAgks!7#&NoV|wz$$;}V=59bzQDEnS0E(3`g0;iEvz6OHp{cuYOj$pZ*iO zmZE=5*2}aNZE4V5I=V{9_XF9MX6yPr**^Vklm6h`od@7t4RFV}hmWT6(6E+Go04De zW9oHqZfS5DfVdAV9+v8AU^O5SH;@yMuiqjuplL&7v>s|E2;)vB9#2Xoaz5lV9V25} zAoZ#FWJ09|m$NkjAG{{hO2Xb;pUL2HUv^ZSC7rc`(WAnj7|m118}u_FZU)7~c{c#M zH*6BMr@`n=DyIFbH63z`bYG8fR>is4crz%OHiCY#tgf5sl#zLp?wB+@=_TS9U|E_1 zK$f%wc2ec=b2OoCL(rv3wdeb0nXwfQoI!Zx*UlcF1zCAO+H@09tj{Lmv@vE?4y}Ie z#k!{(=f*dOLSbG0fKS+2(N(!Q3-bW_vynazKY8>pP45U&w6EdAd2>CeTwK&KWFJ~% zm{8XVl85g4IW9_upai-g zg@2Lv#(R0qTlnzLT>}Fe?R|4ty?(j%W9ao`iB=D)Oyn%{5G9i{%iqW-DKfyIVdH;z zDK?xE2{x;EpylH;x2w}J7cyIrxO-|JMIf8Uke&weHMqFsB>BGTC-Ac}GgoT2&e@tG z5t{T48Kk*HE*N@9(^$g_2YO#)&>*4)zGN<<(p(1@yrW; zyx>`NfpE6ecCYcUSu0Hsp=N1XbW{?lgRm@GbSOF%>T(ohZZHwOZECY$_FX z!C1FUgc^9sAVaT^0f)i^gJN$DB~AxRr}$(eR_UMYMV;6V+ycdvryfF!xmxnZ(ln)1 zi#ii^$iVDh9-ZHG-PNH{{^D>LO|N1cS$QJ8!bV3eDad)Dr!1=GpeSaw`X0 zEGBdP1Z@l-fqJZZa(1gkD5a=4pp_5#0`b}rz(`6`b~@-NAzhT-Emqpm%ZTe^*!V! zxUQ-QT4j2Sv@>wwOxX3n-MQpp>q-NMB6q(eTj5&k?6H_pUt(BnndM8%L?w{$YwPYB z>&0pyG0T21*;LQ4eR?&?HKNw8v>I9ernXZp_fo+fONGVRhmrE&`bKz4K#8ba-wCw?V#kkhi;;4%mK62)QncMYCMIQS>?uwgvM#tw@of{__9}M_1N^)23 zS&<%F_O(l2nmXRjCt$+UEN#RM8FxZ~dEX4}r^+q&n2)GP*i7pt9g+*;9v#i4F3 zS8EQmjC$7hW0X5B^&6I?LRF^}({1+uw0?}To>>(Yn-lY5Kdy9oFX>o^g6aA(vo77D zr(Qzt5+2!cD7B7=_r6ov2L_b5sctF({SwX2!9{N*tWL&9iS}Z|o27k|y@j9o)RX#5 z{uu0AKDluRe_u1x$UlV^eTRQ9xC$?{2Z8(5xs?xeHB6$QQ+6RCCD)+*Qi*%Rw ziP?$cMcPv+*vC;)t}(wjx^L6&yfDK#Y)~*%(RU!~&KaI`kCpqUvX!5DsSlj^8C85X z)uFR=G9K3_(itT)=__KL_F?B3%>`|fX5U$waRB_ec5?IRe0Qqf)aj|yZqxH+k~ecA z?Q;5xkj~qP=YpjiM$|jgyko|ftL=<}Z*^PtH481~RkbJj6!&W=ie1v;A)eRj5qxC7 z$;DTpYe7Tp^F+V#%;R<6f&d;@VazA~%P%tH*s96jhB4zF-`FYUPk4~OSu=oD9UY>g8j8W0w z){6$%qH-pCq_5R!1a04@1`J)&ySkF^a_!fzWheK-V?q4T8qyPuZl5>*s&*v1T$M7bMC$CdV16Pz@7czhk}*oBedw?3-_Gs zM@GsAB;Px?&qYF)bMTgc%T8;hX5!an>-Dl)&W7Qm`j}os;Z_|@ z@SKNc%ta*hO)9X?5_VO+><>e>ne4`vn5-B$Zb_LWZ!6Z>=Z`eAx!TDB8wXEJTc(dv~%x&&l=cv5>SSuo+BP?f53GpJg{b>oz8 z^ISwt`TobClw46KN#p6YX!{kfdRWenomb3hN)@I~<|_qc-ckqSoBI3%5)i1MfSlLX zr)mzK7iiZab*=1fPs7@AfiqxV`5}7dRo99sC-Tbg%y|#o!bPA3>-O~T>vpfZV8Ywk z&g(Nb#I;`@p$1&qJt|XHA9$qKK%f*;9V7*M{t|V>>x8#JHn@km-Z(^`I@*0!Du`cRodxUqU>l`0&McE>w9Y1*R&6A&W!~1xrQ{as*a$Vmsruaab{X0{2ZroOqG?^#m&BZ8+(IjgUFGVgigVth(a$^$*NCSng{7&XE2t& zC5vqge401Xf)#HSR#dBNd2Z8Y3tpcg?z_EK#{uf3Y6$!}?Wu_TZ?npnpQv}$-PTjB z!jf8PDM137J`>x9B@0}kD8Annfu(*QDH=xCp^h{Q$Yaad>YJ@dm^+6?izVucj&6!i zzON><57vRbVHpwW$=}?}Z?}3Vx!=sSP<8l5GX(QwiuzHdtCU^bI24|9zDP|5&_4vRpz|c3deLht*Vi%7n z-!YAH{ln#mO{yOV;eKV>gn0jX>flRRG(qL?0>;lyEKCtat`j^*YU>2Rkqn4 z*m{!iwaQWiq!n5{<#z((hh0bje>2fjp?+a3cGZvM?$qE~SgB=txRWDX9*ffRN}*eS z)5|41Yfo-AmHbMN3`|+QV&Ei>_5^&oinY?EuLbI>hZ-&s>I@UC?l2vP&l- zmOr~K&qzMXRYuu%y|1#6b%;{|$10*$9PU~MoKCh1nnfMe*nb|&4<`1ZaQ?ly>dOiG zBx%1KJIKaMIA}m02QR21Jvk&*1Rd;ZJWn;3-0lCu({ z+P}0Gxp7N{FifQl1$VSve|fL%?w9CyJN(1rI|w~5v5MZ~D4e3hnnA=h;Yo0MQA$|= zQ!DPoO8W9{ij@L<`o@ey*2DXYa-Ynv-69;TC z`6#rd z-_L$lUpSlL;7Fa)Pd$i&(`BeZJQIT9}Tj0oXnp^fzk+0N<`%Tz>?;hf|uY!X*BBqvYwx;N7UTj zDB$Cf%U##I*l$V!D3nRgGaRPG7a<$k%$>1Xmt=4$y?mI(%~0o{jr165mf?f2IIWeh zM;K&lQzD#au)#5%CpG|V9F#0hn4LrBUxJJoecY&l(Mrb3cTWaxl0bzygPQlC(C0fb zP~^^XrmFDzOl1d>ko-Wm_0W42TdUcXB`!BVkKQQjVrSYlE!idF)KU~rT~xb;BFQ}> z6&f5=qTqBB6W5Mn@$CLSWTnq3Cdx$hIks`ql?@++`vtUkjObgp^@@!X9GQy3?_#3l zcLrNvnJzB8E%UD#YkHV%DVN+;h-=RY?apke`?jQP=V?vS z9!k_cNsf@B{`oxbiLuikBxUpXy0^*pjmZjMGV79Z4fTbGj+@{4he+<*FZJdV)$QKQ z<*4M8@t#O03rsx_0w}AF$!@8wsf3yHiJ}P6@Fgp-%l5jtIPytiz^ohh5_0r~?R?U0 znb_}x?snxCY?s|zQ4nh{BkShc5l;rZOsaN4na$h6Pq+_RB{#f%weA{!y=Qq$i4wcI zMw7H7>qA@-wQ}=s#>~FhxL0@t{`TV^#C$K$J5OaV7_3$16D*l4gFNfDC(|sk^aInY zkUn+M+IE?gh4uFBkkmuLdC;SEj-bRkQdK}fOs4|t!k6IPh0g|Or8i|%Zaak$cCw@S zt=zG|u=&g28ZfY$<3AlLpE?S8hhjq$&@1-kIUAJ=1$B&h1q>Xu<{=yg7@nI8mC~kw zDK0v`snbLa)H>&3Mm408`L(bV6&5o)9%#>A^e*Lx{wxgtsow z8)$qk<^0y~Q?{a3>)u?{ajG177E+#A zwA^jn2Y(V`Za*yWwxI3~Q>~`kmDGfAmw^uPKlUdcekf!QdTKSI>f0W0SZr*d%~QVK zA3LG!+ zYYMQeh)D$xI)8EI^B>NHlV-HG-&xc)D0a>8wgTq*fz8z}6oWM%kn64<4(U zMKoctm3Ie8j6O$*T)-GOG;C`h?V0M!wGtq`rE@_K7U18tHAh&{bP3rU2`I8K>|#Xj zu52Uj8sG!KcALGymXp)$x2H+{WvAK*TF1@n#2OkzUI$c#2SDcK{4vjEhj{!KaIKNg zkeu@gD+V6c6PM_P!#OEa=`%Vyo;NJde51q7E<(P)~+Wnc#6m7`_0T4X zvD}NjGcLVnk{iZvY>M8SIIn3QZlNZl{v$A-bSQ5p7j(f8fL!ugZaID&RT=Rxipu!# zhGfxwyZM~t7mjmt&1&@b1^IPwAI0V%C;UP6(JZCr)K(v2hWy}2MNs^RFCeQPemW1{ z8yD>;-*a7~;1{bK)6GJ8v)SQ2s%!8nu7<|Lx)`u5hQBwUU@ZiX{mAgHQ1oU@5=J}f z^KGJ!kk!{t;&DIH8a)=)ZS46uCz>FEo@;I}g=)*~D+L<3+@M>-H)36PDqJLc#=GUWt@Y1mRKuQ3?++O6eT%|}4uzP8O)!Q=%zx4wCCPE{aAK(*)EG71 z*3$BMYtsIS<>_TpaVJC&_FRa;Yio6qqmfGj1omoungxbX6~nguN6e-4mJ0FI}UNC3Q&)|va&j= z89~z}_Z-c%2K=)hbUeCEd^c29EOf4BO<~x?G+)oa0q|iUW3jxrS_Ovsux7bOHT#W( zPDIuh#q9RkdQF|Id<*;{`Ph2>kClV(w#uhwyq>kW&ISjmgQQmu5Us`vk%tKJK7k=J z^Vv2o&04e1txRoBBJPj1m(~yEwJ6uBK&wnB4=9Z;!Sa7aGo%3s( zQT?T$M{?(2(?h&E$2++}fkUXAFLB7g=7>erm_Q0JeWHEsG42$-ig5Th-6fhDdrnRJLo#-N+3W4@oNnL6qw0CSoH5t^a=Je$)!Gh81A*W2Us zok*+v>!yGns5jT@eRdCJm1X=Ma|SD29Ga`6AGr415cf$%B!{ye?$T$oa&{JV>qYo@ zl)tR$`a<>~e;?DV*Kt|mMRY(WH@?~guaR{-1R+0f6@%S5Ys?eQX@`=I}kq?EB-C1 zg8dInD|b!-=q|;*&fflu58$(&MHxYOT(&p0hgZ)S{g}|SCuWAAt5TJF`}RCdPVU5$ zm59fH%tQYofRi;VW`k9z=rNV}?e_thA!PSR5(X`}H3*IU7P^1l{MUeed$lrr%k>4F zU{=b=p_^RIXxmCX+CULe|C3Uszft-}@&;u@&-p^AS|~1W?8huCXu-y*~k(^xuvvocm%oi(KAHBG06fXArvhU*GK0 zaGAfAU~pHHPBo4`6`f)i7?^yfBnMjQhvRmH?I%0rl zTyKw|H|ct^PMGiTaP9z_x2>n@gxT{Kt=wraayi<*6`4#rHa+We{iV>~3FtCu)1dq& zVAK$w7xDIAw95uEy%#={+L`U`Al?pZi6B5C*qqOt94I95MbowI6`(M1o$!u>2ND(t z1fFd{9LJSnAH3_xwV6^7GCzBGo_RjVvN}SGI8ryPX`=9xU6CQzU+Br;r|E{F3)-{R zf;>zTxEJf}yGsXnG_>D^WSJ>7+)tE@n$pt3%>*`(pJVSHY$%s|aZG$W8i)$O6AScm zUdc7v%T$kJV-Av!=S+sbl1DbpT~OyFaA|%rBU*hf6@mBSTr7R5E#fuURi)*-o49al z3urJyyucAs7H=IB=uf?tpJ`I0IJobzSV4)PI<-Y?f}JG@U~fUbEZ3Z z2WOF`11r|CH+OGy$m6@&=c5C+76u-?!YgRN%e*AQSwG8|44b$;2{79`NQk_kM7|?# z@qMomWc}l@lVKeK@I|a5a*g0dDrW90^OFI}qdAQo_k%^}`xA6N zoTdc#*)%YW0dR;n`BKfqrFh1w|I%3Ov$yGK3DGZ^0c(a+0iXptRebU1s1u)o9*j4| z4JmYC^C{InDH#27Fn@b2Z8YpPs2E>tg0+x4n%EMqH(*g1FtPSsnD{_C%wy{Fhd1P! zWIGcfRL$|qz$Fh%o`MHPhZ%y$`0od7qW^rg1UU7;IiFj;kzz5utrWFlgh13rDLc&00bqALO8p*#Mwbm5I`|z znFK)xrTmO@5|KuU`NHXg#PV$*Ky7L+1AyTBBcL^Jf`f$KGO3VY2rT5pw@TQznrZ|z zsL;m?8r*(-o~~`Z|FP9)`~A-}yxtBKbXuM$Txo7)HLqjpzRYXIM~UOak7vtV(n2s^ z%{|}W_mY@wH1%$WSHtFY=tT}OM?=;n+3DYnw0`0^(IAVzHx4|`M6(cmkd+xKw~h@6 zktINF2%w`(I~CyqD);R;@sR`+*}s!th-?g;W9Lf#)586il(uLHhPVUCC@e3F4z`;q-Q>8_&zmqMZN4!I;lYMetCF+37ciQ zkUl92q)a_184GPjSP_K2y$gHBA;y9h0ihc^JX;9tO&SGRO%V|clpUR`Kftv}Q9h6w zcVc8`M|mJ)dAA`F`t$!{^1r9>{r~drf;$n&X{xR8v-F>nkWDl~3yM+=Q z4dAhsumoWOa+hRwn}7WG#JF`qO8tN6)Uem8UvCOIPr)t~y(l>XtOY(QVHIr_P7AZl|t| z?e5o|zqPcAgQUO`qC9n>OOvL7`(Q=KmE@kvbHCF+7~A{s^-mGCLisU`$s~S%l-POW zz0_a6JKUgq+_Oh`=2^}LROL>>DB{_)r`K98NT&8lO~2#5*>ZzySN$qz&8}0I#TQf3MaXt2`-Po($Rr_YQF~0@Pv19lzA7@H{v{WO1e0m<~c*RK4??8Ot z_cB7Kh7mLVZzML;z8(lm#@M_d%ToWre@=To#&du=H`mFT%iv70IEaOWRh@P#qy5b=%Gun~XZJfE*Vc$DtCgNR(78)Nr4H`t5UO<3D0@=f_6*ain&hwzl4x?bWhwLjg9#jf{a8! zUS~~I)#9SU=|vrkunk7EbUsTW_LsX;K>JJ3G~%g`;wd_HYVg7iMhSk*Ip%l#I3^D< z?F>|`%|^phN0GzQ&$Niuv`ffUUHAQAih!RltjpGxAW?Kd-UPKmOFny2^`}*_BOHus z!^qXKz9y4~l(3C<@TksFMXA!NOsT{lqe7Lr$X6W|+{WUzSf8SS_gWdennIn;p%*(h z0{e3qdjOox_P(6)rZ*b=VNO&dG2TRWE~C$D{p(zD=~!7bA~_aENJC8$Umc4BoGH&e zdEx1X74`lxjfY2aQne<`J@1WGX5J{PY8&@$a5@rV7rKT?o^r&L)o$Dh8MnS|+j8j? zYzyR-@a*XN?yW`5=5$IgS7%9MQHmIQraFkT+Fa5+PBMY@Us{p8_=s1@{iE*hgffzamG>xBCM6E2_9dv4))JHS>i8y~Lt* zH{Vc68SCbr@P73D_udCKd#7BNUUa+GSj5h1sbU7QOlO#U6F-gqpg6+h{@a;n;7bmOC ziP~nkG=+mWU8~~C`eSQzcG9H4m^=GljJW`vQT5H(mIe{w&f(AMG0uV3LRT}>ss;}m zMv4Qme8+`!7=yKq9BUwg%nd~EJ^LLg(DwI1o0VYnSEMPB_F=$|CkyTsvUi!)ZUIew@&LfN z(3V3iSQ@_|NvuU!_SKK%-cc?kKN^=18|YuJP(LRYjpq>Dt8RbW;+Nk#&60wedEPKq z2`FEuNk0neu{g=HO|s0Ax!Q~{QVnmtb&F&2T-$WitXgbeHJKfIH3G3Z=_q`QB9b|; zM%I0}5)s6(Go{`-czZ!hsF{mVb=l^YKNq(0hm1btW&yk8T@nf?8LGVd*AjYK<2Ihr z3_K*WBNXjImlwi-4U4^ok+)WU4YhJ!x!)D9$J$)G2|l^lYtD}SN^iKvh-MqHB4e(h z^TJt6;7G*%Xyj$_?>`S760&}Df&9xuzw^%9ZJZK+SW69>>92F@Lr<-WP)Y{toq{YO zlF&4x6_ue+qBX4xKa~LF+ubgjlh}-9wo7bFF0kqwZf?^Sy50>OELfTpsmkpyIqQX|lRWOo zLk>T>7t=W8b<>6My&=uJDd$U}9a-dwZ6}$Wx-5V-z~zTTTqWatBZ1%+FM$LKbt*d#cFB z7i+|>$Dxw^JJ0sQwf0&Q9L&DvMpLqMjcqvcV{OPRN66#P6tkWEszc!xvQPft1EJmf zF81Rr+i{?}IG1A0d{?n89oLQ;RV}2=ele)lYL8;P%e#ak1%=M+)u%hRfz57!p_clg zQ@<3rQE~-vkQ*sMHDUBo>9&^eO0<_ph6?JY*lAJhkB?{yK4ZZsAMV!eq?%!ELH2bg zuJVO^aaAUGu=41+m15etnxGyh7q?ll<9lP;T}{4EoqMFO@fU&;?11-}Rv9?}scgml zPz}t=5ActXvlSvrwV$*M#Oq)u+wuUF(R+Stc{#wwghJ5$iQ8M^8wCoY#FmgvZ(*e1oV@>-Gj#$M<%4t`&eo1?k?D%B#OSTt4T`+bHFRHD}m3MAC-oh%Vg1GC->PvHwT(jaZDm$Wg*K*;&jEkzexKx zD*rDp@u~|8I6RXB6fhu4qrKV(l=|FtaLc}kq>~nZo2Syc``qmW=RF68B z%ypYy2wl%S&<}K(<#of2@CrnrJ?!1S+DBPnbEOIfbA;X9C!5?*=O3W$jxX2to{0y~ zFt*yB%vZ(%E-t=IS;^biLrH5JZ&Pev|Ev|5wS;N0!x?zM(&`^!TgbLxxZURjaNLY` zAR&$J6_3mi0wcZnUPA*~9MD8iCFLrCWD8M+c|1Y4fvc30!NYh25dn0RhkYBL?lyqQkTMSN~41}*av$EP!g~QWkwRVHrBUCq>TEc@jSh+JvJ%UmI z$M&s-A9Ocs3r^8uxT`YUDb9F17hwA>&$dbz*C6U{Z0ndsgGbVcZup_31xIy4B-jG9 z(eL_S%6v;tKmKv~$F^GT)V!93d6GM-E~l1n3V zx#Zy1wRQ?Ul|Ilg4N5?>zo+*LYh`w8ult_yx^WZqNjwkSFay%-1TU_{ z|HnA2*K&haJez(sRRn-oT z`dC$t6fS*aMazRP=mrO>9cR498=x=Re+Z`LjCU@y>}^f4J@G2`dsz{1t)_CVsIBJs zdmPr`N9)PbTk6vUpp77R*cGGrG(X$s21unA*vp z2yKx;XT~PobX+>3-zHiXuefzF;OLs@+7Y!cxh^3a<0BbSZ!ISb7kf`e#{yI>{2!-I zm2-KWOR{y9p+5yX%Nqpn1J#anVXRcZj>`>CmJn&z{Z~mRus3@j)pHoA4oe^3_rI!G zuJ{V*#D|z@Kw2Uf&a`-&dIi$5RzQnE)0kOS&K+EZ*@~-5krOq)N~<6?+sC2R>Pr_s zgR9Khp5*q&Duj0Ej042}A?V{ug-nKM(I2n0>vB&-L+1 z+4~LU|Gj6ZA;STSnVwrBVjlVkrN+v#ty(@N2$GRQ9*ZCTH;VorTmlPwuuN($&9AGL zb{Bo@Z!iXA4+$5ynIQ{Li8}*{{)=bXepl+@n$7t%H0jK@YH4m^6uLRa#LnwxPfY+0B}y&iQ=XG{|TMbiyRWpHHOPjeyj;M05<0;M-{hY zm8eetWxTj|>M+ZBt>KmT%Bt-((#8fY1`RkK03$LjwbmnIaF+iQ_uVtpU{4$TYD z`M*kgo6D?}4LRDsXW*PRaxYCEcbC^zd+2XSH*kzm>kk9HCZ|#g#a4bPo@{9RJD~r6 z!uR3xU}ZDNXt<2o%xpcf27)$d|3DHT`~}MRVsY5n>Yx+Xb`>>|Wrv8t!?-&FOrN72 zsCt&@!;CIUQw|Uy>Tydx(CDHZWs=}pKqxP;tp*Y1yU~hFsHlh2PV%As-F+$ZYz>{L zbhW3YgJMx<8op$8zp&f7?yCABAZYodX4KFKzgP_k@atOER{9$=f5Z?7=x|JqpzC0C zxYquD_R)U}JhYInhIJ9^@}l(SF^bh16eSLu%q5d^fN{JXCR+CQ|72JOfl3WV?)9+H zy=m--um2^Z@HqX+L%l}{MxhT%5UVCL7uO&<##LyKqL-(@JlPE^bVzb#+He}Ct&xS; zafXMfK%Dnp^cnsFJftLVVOzOSRgvqTLYnkiF^m}kITIv)MRO*JiITE6JN+RZ%`Qdw zZkh$Fgu9@@2a_+Mq*^*a*lnyX$ zY!|o*f`L)yJ(77I{dazXh))79j3Ur2jQMEE*(@mD+&)HNOAYGW;W z3YuD(ld;tXU*=f}3}JH8$jq!~A^ud%q8K&6Z}+DWAIG9L+B57^CrdB+uVvjkV=wf6 z6MRZ=aWX$QSRZhvZ&D7mO}F0$2BXr92OhsKxh5U|_;BkyTyk+%%Sg@i;|@q%)9Czq zL}xI9dCQ=9>PE^dXGG2tF^h1ITrw7#8)kIX$;|1FMATcqOc!3HR9khGGv$UsaSqn; zN;~%9)^Zg?Rocmoe=)o`yGz;kEVj(G%(cLi=*Q|T_*Mfu^LejaY~p>Dt6h`e!~@}m zr>fMb@uik2IyQJ4BbxiL}HsGknnYao_&;5mr zbO_&~p+8T~|EInEr_=Grc8Q{|kgcnZKD!xpZXWDUm+X*db{i`CY(@nz;N%b0 z3x=X|G=cXe#q172<3%?k7K?TMiT?dXTmWvSsw&{2$~*e?`ty%pRvzp*K}fep+yBqd zh$NjcLeQI_`>cE+-~4_ix)2V7EZoF#?*R=cnNz&}j5 zkB)CMUsIYYf`h6zJ6gy&w%z>Sv{KH;-i&umqhFizaX$1HY+&EZj&c|-v|3f9J%CvC zp8zKOOF;i6O7pjkW7?fj?k53N_Q)~r|H0mSKsA-FecxxsQO5#|4e996RC)_Nj18o# zNGC)H_2s(njYJ2x1pa{JxZ;)SSviy=UhfT zyb%2GpX!2rqTJfqEB2ghJ@2$gw~T2+c8va))Bk(u0g4Wf+^h_aro)TTHt&Qjwf#uz ziDt#xsq zolgR%*bQVZU1b$Pe7|cvK?~*jE}D5%a*=vx+R12o;@%|Oh+jk5$LOP2tzFkScGG;5 zft%AfP2n~8UDN!7nrA9oRdQF^(~i?Diw`>;w1Qom6ITZG`uV5FE5PO4RSwdNhXH|2 zoUf{X+4|{Ien|O~Js~=1Y@^R;R4Wm?JM?l>xIFh%sBHH~3PvcL6Foqp^gq>w8&S5TRyZ{<*?udNeJxO4*ACSF$+htBO9U_5{X~!r^!&>v0bZtc zFxoZm2Ag}8?H;a&mo?e9IP-@Gu7HVuc$G{*29UFVe3ksYu72Mn|C71QZA;ojd1#;H z1gRI^>hHlbz%f^6Z*w`ssvX`c^D&JS`n3)Fd*C6gKRkb=(6wGkp5{x}%Q^!@R~1YD z;CA)Tu3e!D<3fhe393I^0l|ig5VgmW*Q#~b`imc_wg$!esP|t|p@2s*cE#^N{w77| z0kVzS-aVUgkF@XmtnL2H(6S2H2el5$JeBbBi1eFi2jT+X=LSurD4g{-&&9adFm8Ju zyc+GAUYqxCx&+vld3v1*%(wXUW!!^wSE||>FM1TMMXU&`Z;PqFK?q00X_HTrPcttG zbs8;a*o|Lnx+eTQ;CXJ_QHBs7n`ZJ$4jXCk#UqD8N;iI_omJZ?|&}1C2)7O zRyh2|kFRgBRRmurLs4;&r43~SN8sqbbvpMPl-mCe zk~;?Nvr5lN{-%~>+HI(Ef)*=ahkqGow`85a2414R$Mvrno)aevD& zEwIzKw;d-`-2Y0GLKUYrjX$cC2CLevy8A&wVBph$%Jr@c%+-*E$&<_xeaHf%vYcFhnCS*(a|Ah%UVjng;_5Q=MFk@g-YLnYIezXlQiW_TwW!0I>otUk6x6~UE zo|rfdS-$1GycmDfAWN*p{)7$wJvX-exis`YeQVc|;4?S3ZMHvLfAk!sLu=!Iyd`!4 zR-slZz;rNOyCm>7#$)1o%m1K2e?1OL|Nj>3KRBB!q4=@R4!3;`!vQ(7RQ-tYUOy-5 zXZ5A3y66S#kZwNLx&(E`%$`^7vb`|l|8K)|1l~fJKW~@nhcN&ZRh4ScK*X&6JKi{R z-v{fH6(-}w&3Oy;C9vn)rP!jNWt53ebECkQ!p-m#j@RYZ5z9$8=)ql6pYN>O0C3O& zUaPM17l|1)|gE@a*04?YZ}?3b~HZ&ShBY^vb_ z^N>OfV?!e8V#dS8A5-=v9ul+crmg=@@*@HDxK(#ceX@F--#jH{)qQ8dR&3-{pC8fiD}krFv9HIjkv$<--vq^vU0bwNk9D&Nf{86stfY4UXg%e6vV+$RLA93Q zLe8Rl9icFRRO}C5_;(g~cb)H0Mbj}$C~LK4Xwa<^=scv+-1vB+wUzP*_sS>CH#d>t z_i-OI49WZUX-}#Q*z)Zbfh-`6&{k}WPNugox31f}Z~db8dwKXSLK8qb8PES!AU@RS zwIrts13gH`%2b?(f@%}iq0QMWYtuz|`=o#7XT6TCvoY<}t)Ei6KB%qmU5&Zu+^3pR z%GlGY zQk@C0d76ZhZE-f7A7pbIMG1J~Bh$cS7?af;E=Jz8S~-F{vog{gaPr|}-vFtfpthN5 z%631_5lo8g33x(+a#16m=)E1s=A{{`uPm>_??(5#srsZwgz9L6y$z1|_-jx_=!sWU zZYqzThEg(nQ(H&$0{X>a{(5P->mSE1ho6hd272e?OxA${xHHo0!Oai69jdC6oWrj} zFqe!ByvVe<-uqE(ysS@@rfQ!fgz7R{y|TW#bDb5&xS5+*0ON;b#q&Qf84p~k2-{nXIT*?c zv|(keN-j+&A}6PaZ2DwnhsYunInv!@zo(;1Z553XJRi7tQ^4I<)FZ)C zsM~ow$IgS-dOD3E$Xmf>61wb?sK0WOu=C#DKlvFV-rgT~_>@9{x0B+hdF~r$IW)8i zV5MR`3!g)pV2`Vf_GHggkhkDxD$G9&N6gJHNUJ5zJuAi&36A)2UqZd%rMsmdvq| zDFD73t?P;ZUch6?8`WkpbhZzWR{dIU=i{(mP)?HVrkOR@Nl_(S5dHCY8@eF}Lx|BX z=x8h{z+jW_RyzO8IN{SmY=wodR$^WQ0`{tA&`y6-m;74D)kCb*~xs8~T{U!rWixTv+9 z!~>yVOvl8hCX2-GD@wbs+G^(pQ)K0Xl*(RrvKk2T^x8e&{=x1*&$PH?i>|1FrMXbJ zdM5J0f?e-U^sqag8C2BL{MLFGux%5xU`h9|Q)O8ns$++n9`O^(`U76hXOQhE4|&S1 zyVcwrKJ_R>A8F?2N;>Ws9`f8?N^%9HmZBTjBubjFc9Im}G^4(Dj@SkG-$@9c&-$A3 z6&>rY$6Gu=Maeb3aXP|QK>YBll46m!wVXBL2tFny>+B{}GQr|BP)PtZOpsm5-rb81 zyjgm6lwJ^qHks%QCVSzOm63F>(eu*6azWCeb^}@{8pua@R(kb%Ws-JZYxN%l9h{L5 zJD+&Dj~(@N+j$s0pW%S~@^Wv2HtGNN4gFm)7bD#1E(Yii%PqeCoK+C zQ0{xnS+G4%*d#vk45^VFTt z(qC!?bN+K4@Bc}O2dqpKj628k9p_>eEUTppV)P=V$)>^<0EWv=I1C0K5s(0MSZx+; z)k5b`(YSk?56=rNR01thz0ph*z0UM9*Xz3UEqnWB-Hy<-%aXa8Se(Un6iSmqdA3mh zu9w=j17!3VR;W0Mx~=Dz@yFOoQoBF8Ba$lC?r&7lBmh#?;55bN$18(B`)HP%L1Q90 zo@2C>_Ga8ernUwO8Kfvd0#I%L9a|n_^5l0~nZzjcA82J>BGsL@ogM9$D_XP(I>g+G z!Z2L9S+vctof|b039RR|8^+pHi-4a`OOEU8hwk+$Glp9blfGxL_WamwPyStgrpi}E zP1GI-cCaNQqDZ9@+ z-D!nd>zQfMG z*BnpHTnK5Rooud|yWoiUfZ8v6UoK!vyh+l904EZ-w!S-qB@naNi|ljN>C8E;w@vrY z`+dky`Z7L)U1qW_y#NWZ#v-v}}iuSVy(QW2W z{alo9bAf)i*Fp>bMV;U9y!Q_q%HSOM4^~%iEvHZfia*NV-anIGIGiS)K#MoS-N9_R zu;wGViPbeh(3zi~7D;!#O?(b3%BjmRX3J@cdtFRo*!Q-JnMdTR(A;Uw-K+Kz`r=`2 zD(m?@4LjV^Jkp26Z@X%g1TDf*k5dLeof5;G)67hsd3}HSq}Vh1ydQnu_xX0JQQkM= zjdSJKEai(I$~<~Txe=2mXwC!Sd$zlfbTWM5jM0&Xak*-$c}?JW+O9+GP>B2GVqH|wFNfGar7%Jv0tKRc4OEAt^@7R>!Zr4{h4 z(`S6dZg%5i^qWLh_;J7UEWIFp?Lp~lDJH(xwJ}v=`~2={4clFdm@Cu5eZkkUVQSbg z@x}z_OwTtkS1)|B4){`t)}Afe-mw%#%cR)oy>P7L&b(DmL@T(ME% z%U7D6n7M{j0U>#7Z2$RiUD5#tPN=i$fS!H6O{ta5HnK8|D6ZEiW5Seimd*!Ipf&|J zgRq4f<=|>Z7+>^rQTkqev|w|_|4NPL#3t3QAUUUj_o?U zCRI!@``D()H8;+;yT^tdF1Q({{0h$06TZ83dU)rho9XTzTa3`G#M^T~HtS&So;hHe zEpD3TSvtL}+mk3V{S_7Xrja}*&b#{+;i!{#E$uWfI;Lo~!{Pwz_okMX$XIz5+bb|O zj(@Q971a2wX+&fl)L~!T+|35rRUVY3UiowE(b;6}wO(?bN$HxliZ#jJ z9ZVd4g-{)nM*b)X$cbmwTN;2j)~lj4f8%kkomqWOmrW=cC8;no6Z6=o?JJJXIqA`U zQJB{r`THj)>e%??v&DW1~jIa>BhxOhy9Ml?~kdJVY-OIjF9D z(|pq-l+}DwO*XW$A8ff_KN#RtYi>yR?oK-sS3PIts(R$yTnDg2u_z{Zlxe|cw*8f+ z$}=1rEg|36$_83YR=(;k)aDZ3O@zz$eZ|oY&jv@jQzQa+I#5TGhL@Hc2)5{b0-JJH z=WzZ2xya2Cqy=yi%@3f-xS*9C+;&c)3jDmq?6Y16JT9tWN1X*5MzA7^xVQkDWxe9* z&fG}X=@==NVcl(XX1oeUg^Z12qO4TPYdPb+@D&Yq8Z9o>(xBZH6z)a<2$*BrZTayy z#S?G`%*DEJ0$1i=vh)&i3XnIi58t+qYO@6lIV2&rS|r!*){SV-I4RtJJ1CO*xE zWI*`u6>U;gGFFc7I#R2f-uZ8cSEWUCMbFhuK^k-n0Rkh{Dn%s*hRr@e+=zM5z3#Fq z{^922_&V>Zgt>(YE;f=UaD!WAK<+7pqb4h?Utwq?{4N0*se-t>DG4UKl? zGQ$v1nVa^Bqi1RW1xqP|7hLj2NJ;vFQgk)gl&4*M>sL| z9rP!bJxEmE?c-EZZ&BM`2_w^Pnp zxd#{p7A0=}VR$YlGWMG1?t$Wz_a7Cf!ED7T9YYSFZ$D)=K2}e3cI31dN4>$>7F;PK3USw@&Un$5bYmbruEdK#M5;V9?){5ke&LYrAlu_b7%);17Q zx-H!k9o9ptG8kh;N~gd<-Ir&60;?1ndr~+Grz#d^=(!0V%;u9Cr`eLXRH+ugbxu=; zZN-jy<<^t~!Y3tU&ZHt+S+-%vO-3Z6mrf`Vx}wx!5vo)0#ORhOZj2Pp&!O0w&EaQX zgH|{8_7xNooXXv+vK@97UaD}lv)?3^zI@K#DQ-cT^c5A?i}Ah>=q+nUpMMx% zI%inmEMAu{eeCuUb5Ca2n%??DdLLF(%!fS=SP1QJ7zfTdLC>@t2nB;vLt~?7>c|Pvb zDH$@@)Q)%6s4%Jc6m%yjO)HxyCdhS7@p$=Kc75cgeqn+40A*67fCs7RD{>QFET$s> zuiSsBUMd)JYfoHwmTPSWwI!!em?E~vNgR)>kYHDo31PkDinnaTBe_C3&NrN_b;XQy5+#;uPlDUTn{OCtPbg27z-VGl zd&OL3g4&?G56%vGiYgJq?j|xqpGB^yPx~PPymA4z4~ zx$L$Nwd$b5S1_te4!H)JZPVBpPsUluKv;2xkBjgXLz{PYeP{2j92eXDc+J=3Yn1Cb z)3F1F2F0k{+~=O{whtQofZWtp(c{pI4CWGQ5L*1TV@HI4PvcX4r_rXeUZ^Ka|H=Xv z*(q;t_*)JWC7;DWBK5~H-(|jZYe=d-M9i&=1K~-bC3u|@X4SfEELZVSh+MT~v0=U17xN~G-$1Blq?M|PhlCRF_ zwoj|+o;JqUS~$>k{gpw8mtBAFw}JyDKH zD@*}8X$`M>J^z`OFUi2qNUkC#xhXhcm)`ozHw9}v(N^{t*efxw(Mck<(qZzzFNzjk zk*q}YR$Z+J2Wq!k1_6g{2m9LGmgeU_UZP&CM0aqW4YEpGR4ED@;nk&B`&t>E9})CY zMws*(t%lWo#6sBPu?2(fUaNh!5y!l_&5Z4i{7QKd%+Kw_cTs}s=E)|o>l5=gNqzMy zMX(fIa~m-V_GWG)7AKjK@LeQ8ivbyY>_}FV) z&AezZr5A;1~rt6k29sU}*PP(DL)K#p=B+ zujy&mrvO*SUCzM{8`ve4gAe~Sq>SjGk0KjKNq3w&DQZc*L-7c$1-886tI>zuyFAN~ zpHgBNs)S!S{@nn*&0j_WD;QWTY$Of0{;gPlWEb*v)7Gtd>xB&#iseDw`s{SHkL2S&j#P6@Vite=$e^v={>Z}C5dGB-&tZ-cP#^Wy6PyT5S9;RWh{^DMe>Gn|*X(uxLu;;Sm zoA?tu67p$}E7nAss2I268V-2DiTB1?Z6j~*o}e_IH?yg1{;sCNU0BY0^m?^&AN zEE)*~3F=zAxSdk>9z8y66lbE>y0RTc-wzDa%_O$_WgO!%XkSBt8+ zTc0c6e~9GB54)fJOteEMtEE1@+}P3d$+vK0IBThVy6Tw?N+riC{`M%&H0Msp0!Z%- z@cx5RiUTC26Ax8kM2%kCIkwRjuc)0wz(PC=`(AE;wIQBUV1%0-WS zsAwECM<}fJ^ z^Xj^vaaY(EzR`QmfWDKi8i9x;D-G@i#OHGV;!Az+<*I)w-U~j7qMpxd-Pzw{KQ;yN zUzS2$Hm&wAwd`6&4(@~6qC2}cN{-qlh*|~JinmH<%OM*%aM^YKe#BTfJsbT@awNU#_0Du+GI8%3N3} zeEv=i-$+<+9;I5j2&5SE3WXE{qr$>fN^x%6T>Z(Bsir};tDdm~i{(K!RW;4jVqnR- z#uBR#*1m)=?w8!u;MJ+KO1ZG3I}m5xxe}RMaa>itr9^=^g+lR6ho?{)BSX!t1|{=p zI;{*AFNaf0fr$l&L`>jS4iig(1W#gWXoeaVdYYLr-MV3lI3*+wz{YgR)Wa4@1;HnJ zP^E_=&TUAd>W}Vv6oXx1CptE>b`ZtFbYb=iee^g$#AGn0W*jE4K{L_rX3zXOs4cmy zp1HpR&tmqy(Jmt`^i~h__stJuCqD1-!c&_=bl4c1UBzc5d0>Ky#hi{5b2guwjE$eTfZ{N09*gk|Hk*vUU@id$Mh$v`aZk^G>S!!!^{YekM z`40RxXlEt4vzS+s@iYG#hlk3ijwI2&BPzA;R`hD4CS1O&A+m^zTb(D$;$1YCfXj9j zjfHz&)@j8YVf^$f6X}usbBU2)W?R&n!7Tqo<4nhv*umPcCntkNOAX;6Q`hIQ zWJ}M-DT@`*lyH&;Arb6=M($NnYV<>_6sP^XZZqTRa-O@oZ7PZ}KKX4428T`0{QJqI z_^yoG!cuCGF(YkgA z0vj7xEUXkO)8RfbeLMwc=YA5ZPF`Bx@*UP;gYjR~Im$PwM@ zi&sC|-bRwMu`4N5FWAlvxWsMpQm3$&u;@+0d>SrN#O1NjRN{S9iR=jC%xim)Ao*=v-Fo z%NtVm6;<@T)s*A#LcNSx;(*#anL;J2?rM1Smo-x;`BX%WQRk0p0F}#?(F2jfNxL6E zM~c4$+tw@y6dlv;hgeX?O!$&anbF-r4<+PH&S3AyVPW-GB*n=Z%~Mum5yBbJ!W zQIKS{uzKgFkXXQIdfP3h&2s6yYOC8OkrJws}sfjYA`Jo1QoimXb_k!CRQJML8t7HLN6W}}l z$+F@6BTX%1>l@5^r#NekrNretMH@0=VnULXp2i)BAJoz2~|&`4E<^p13csDKrIu0?^8m7aV-?)PtTF_Q{Je7Z8Hd?R}S$`%EDGSy3+RT}0hQ|^i}h+!kO!go1sEBNal zm4Idj^Vf5NcIw;rHt>_BA;lFfFNz(_g57b%B3iQJXjP*7#d-0VR(OXyv=m61DNk+P zb7eIA{M5a;oBkQ!y0&3C&nY2rFMfZ}#Zvqb=RAUw9E8>VEK_A!Bg6{h6VHad?>BD>tAk(MQHr+35TeHTXws*~U@{|y& zF;cJyNqw(bw3?YlI&%h3 zFe+qi$hNB13e5D#T^YL`BY{o!jl=fYJ+;S>X?!O)^T^>7@HvH9>>bY6Sn z&5~_N;|0AcAX(^GZH>q}$N6Y?1F$AW`^f&tMzo)J3sK8l4pBPja8n{ zRr)bn`i0|N-8K-fNCJYp=gHNbiq6Y9Xod4V2exi$v&p>~htrH#1W=sn$@9dt$r8SxuBt!=2LGE3&Ogby*2to%4KGw?!1cV)>P3`gwBE@-X+4 zmEJF$zLplVJcPh}Eov^O?@QRGP-_*`@gyzO=OzBS#`wTL*iE@?4C*i%eofHYYZ_cx zcn}oj0@+|4W!KJAM{B4X4~GNcw*;`#M2^(g)b$W|+_rPWzJDq5z~KroLPZ}K5p@v6 z$ZtMeIW*Bp{Zp%{*;rM^J+EH2shrSAr*@5<8#@tyypCKi98J!3N`VI59AUGk4(#lz!V7eNEGl*G zr__;S*~Of{nxabCXt;NfCHFb*qi^Z6S)?;^d1~~s7fJTKR!so=*HG&hI}A1L72xsG z(~U7clf}?wiU8c65d^TVi*aJDPBSGQSXZZ4KOLiGqw zI&70L%YC`-DS-y2K~Bcgy;^Gr3O&zMiL+`4J%S|Gy|3a#wa@K9l(%h9#omWoqWu!?;0=GD1X zl*=4ykatqt+dz<E98U~SAy+p8Wd71ZTtTUB!L z=vFQa5q@VH#ceHhXg1kzO^VFC0ITa6Xe)o5>*`J75f9K4RwxVbT7EDAWqY6<7}+_- zxRGMo4&%(;B*bxXs* zbe&6G9PUC)9Cm>KryH!`2jec?QFeaNs&#RO^$PtCSP|CJ?vq~(mXZ#M1LRisw~bDV z?_Lp%$*IHWu~W?3jowkER{Q~Rno|MGHwdOfM_&UHLAuilArSW@OL;(nOi0*cWt}R7 zR?f1`T$0K_RtyRiOj}TnD%sH;UBth2UiW{BXtPKPqcu0`qh$)}eS*IJDmFK`p`jg# zVe_MQI7zmrXmHDB0%Ak@NKfrg74}90?VoH&gDOTjQJ5Tc7dPVO7{b=nbgiYFJT|G{ zqOiQ@XKp&juQICC@H*GcXS^w(rhk*54z6^5x4vtXVABA)*eqnWTUTL2@-osY;|+ZE zNC2 zrzPu-!JH<<7uV}H?5>wpN2%MCS;aLTlZI(0c&QXX#7wR#t9#aj2aLMQZgkj}1{t?H zS8vZN9#xe{v{=CZzl9-dt^`@pmdd-CCeuD(ZnWQAWo(X*H6R4B1_^eY-|#J zXKL4GvQR zdJYs6RVgybtr1c{8<4OFTyx0RupW}$c!-{`y0Lwt5F zgGbjn2fh;ZRqb&-&Sb9ak!J{N`TN91l){%-^=Snvq>~KktSDBiFdA)5Y$Mx{;47BW z1pV}Estf{%%jMRVLzXnS^7{~Vct7|vbLI)|5@6c0Dz#deq8lGQU$@+k=~@q3vTf5^ zUv=C`XkIWUy#UQ^me3F}3d?*oJ<;#Pm7B09*?VekbDyD~gr73-0d}$eSnK)R{>{JD zda`X4f3gkP)3e zwK*GbK9K5zD_A>17*e@%U{eJ5wX|8|m zG-I?I~iKyJVb z9pO;7ar@a#_j@zXPJ!W zcAGlKQzmbzaiAcJ6)r#`HtL}kKyN>xB0y>W?s88(43<1)g`3)R>^{cE7)On*=m}XW z2P)mEEV9xSeYfN}`J-HCbwPiB2B7ZyUZ9V9Qo<8~VGy;d z{RiD(EKjfNoKg&>MAt-Ies_b;KScMZtaHU0Vy!RH$m*i83Fk3T{! zT85E+wkfkq*{o%BpR%`pCmY2)Pq^9yPD&;amd~SLR|-N)gA(CA+nnOleQG8UX7QKG z+<|%w%A#-|=e#bhJaR(Ezjxo#S(;t-Wl<5;Gll5U_JXa}D)&iuP_nyMG*MsJnqjgx;2ljf5+yi?(Z=a@~ok2ce`I6exZ=Md`iK_S@ zsH;r4^8yr7bxntRB>(ZF@wzvv%OZMFz|=_zKkeyzS7s>#UJf`CMRY#Y#;{>>V}JP+ zK$+^Zq-?B1;m&TI>diZcOAEX4V_NhL39lf9vsxObDiuflgWr95bho-Dtj_nC-J=(3 zN!X?I)*d^>>iT{cM8fFK-7AvdfblyIQJrH`1BEHEnEEkxZ!!>T>{pQ6RC>9$RjktR z;ksjiJW+@>ZzZ>uGwH*a+Gc`g-j1rDJ;-{2x_N5!va7h}?cZqs!n zLvbj+Q)>a|rN@@nq5|wor?~xy*JvU1mTMJ-h9^-l`;qT7d?qsXcGs4$RC!N^ znO++BFqHltM!$<_q8`S@Lns%DftAkt*LO8I64Ok_<*V4?0~fyHTW-k5(U|N25tv7>23m-U^!;~J^%Pm9%bri6>J zY@xG!G&m>Q$BC-@B=3uRWrS zJ=lj+#-6yPtkyaAL2}<6mnzx$BJk}Wkmr7<@cQ4ke3>)I z-;4MEyBy~Kjn)TFs_r(J{b0jLt0({h2YM0u@F2WgEPRP3eqdKZfYPy!aT}iPg>r}} z)IJ6NU=pyafi2A|ZBoISc&WwJe46`152&sRRjJ=Rpa%chuSD3E-zVS1KR*hOJ0eCu z{N$Hy8FZ`ny<{~;&E>2xR>52rGH%4rN16^2lqBj7uX@{DK%-YL7teIq$7O!}`2>H) zh>L5QwjTeYy($d+NVVFt23{iz_%?k<*0nZ|-48cr!4Csb6^1lC@or0xc?|2=d%JjE z^XGlJ5H{d71rh~vQE3(7FaIIruGUhr; zO|IP!8Vzwox6yQ(VLI2lmEox?xXk!|wr$Fem+F}ExF*S=6c_w}wLe&pLeA{#71ZDJ@7=ADwjZO91w&4y9F5k>j=fStH_S z)PPi#zjfs3$#-`-Nu`qtY>xp`+&NCh$rq^VkAM%D=d9{8X9PA7B5~j@@Zf-_2hq)0 z_t6}fSv%7ksa%xla{K*)I-F7E8{b!)vY;5-;wyg3@{M2$K2;l_hZ%lH|A^FXkfsEg z^nEn)axXiFdTW+Rzg}gWvPCMa-U=n;&OT}5lqjhbPv0u07eZ+|(+P3yy*??5#O%R! zCw#R0332Sr$-E{G>=~#_5*=IMe;WmO5`Jc7Q*2E;=pxoDku<)Jw#2Am{blX>S;C&^ zdXKb^W@!}Bu}+JQeU6b5lagvkuWc6axDmS7v4r~0Jg?0?CO0&$*tL>jb1z!cg*7to zs>f1oRB&#-ujW4dOHkxGXK{rS!^@fF4qJG>t6o4`qDbG@c(JciU;~aSkyCV>@f9|X z0=KQ*C*Epty3>fvX`WJ^)7DEA-eJ5cnexNC9M@4jeMW{a>lLsNw11)#yK*58fy2JD zyDV-yWc&(dHHxLJ5xrVqB%cz7^vbh%Joh1NF7hK$oTl?G9vL>|iIpWDe8_d^JdsuG(mg@x=&6L-aI=vjZs1 z34ADMxvKNt?1=qxy8yKp;IY+wl6cCQxpjDMx*ys%(PmJgEbrxAY=BKxckA<#E~Au{ zOQyI`%FE|`YJ8tMf$yDMM#f{WKNu1SBydss<253OLFdAT*DTjIphg;*oq#MD)|Yj) z*+9dgk8#LWg234d@GSpX5*Rp)h)tZkvge}c9oe+Cd>BaK3A7IkEh!#WZDka)a_ypE zx6?|;lPHI{YR;V)Pbh02vpWi0s(E>*`C0=b9(18*846i%bzI$lcxH!14rT}5mj*1!>*?JH1V(iorkOpl^~m!kxH#p{=%|&AguN%(O<27 zQa+{_r+Ox9F5LH7J6ieh`EtRzBp&g1zwAmb4K>dfRVWXrK6F1bS3@b5Hq5xR7FI-MLqDY_Oh8U}OCas}`D- zVyc=C+aRG6@^j5q5>mPb%=A`F{)vvQpqOMxq6m9^%(VEq&78@f*@c*t5q}6q4Yrlr zPyS^YoR0kb0W>>*)~{2u!fwtmGFpOgiaTWNtnJ&e-g6aGv?Ea6B+OJCJ-tfMRpX;? zEj;ymHi29#am;fmqFOM2I=wzP&>9OD7$sNPG`7x5JaNZP7xg3QO}zYzn?RcSoEitHMhyZZWVuF- zxgzs;R@KerEBdS;yse7XCS&j1lnKBOeRb^4$)(i9wf4oYzjH+d-)=GF3$taD6yNBg zUB`johgfaMhTUi|Z3l+iBcL3)R3tUtwP9T+gNH!43d!lq7MEBv-HgsjgbPv()2$Dk zcU#)(ChTe3LjVAvlDy95$8`!>8?qIG_xwN9y?0bo`NH>m<~SoWBBG*55#p$Tbde%8 z(Lq3@2}mzdLJt8kgcbs$2nbS!-ig!*gx7Bl)aEAJn!NfW7~tQ9Mx+m?>h9M z$BfroDD{Wa{-KXvF8*%ZeNez^!*cXoUxe~ycFe*#pbHyMi2_ymn6G7&r7F)zm%y_RBVcQ#a z7N=a9$>kOSu2dp6qJC#F$`#}9MJ0qzPS(~fvrc_F604fU#VxiK3=_HT25i^>%#%N79|3P(^WfC9^W-s7&sG_!uPh=l{dek^2NP%^!B^&y9RSHhX~Wz@C)1?w}3~=Qgrr z6KfH9@C9;&zgtstIS?TV?%bI(!~ zv0cZsa#eu)A!xk%{b4o1Xa8RUv_Dmbv;GHwHXpdKC9;$8YDe?!^QI>Y)QqSH*Nd=O zP3bB3vRVT}Z|HNHe#{N!4m}gL`L4@~^vw~J=H$Q2KXN(csWbmAxt#%FQi%G>%ON}~ zLqr~{>>>T$m%ZVtwc$_JnijtDxMHzhHv|^d92?@HZVZEcs@CEk$rpJqQzmi)l|HoU zu>AaOhIZ?MD+OMBnS-Q9g;>hO;X_-oSPSv8BGJrY)`4IjvqXW|4H^ z0V{$uQJbaK6QB*rL)PO@E#D*$sZNKYvf#@+EioUN<-DdJfcIvv90di;K==N?_hXkX zIj>4TaJ~a`JIF|AtV=k84p~ay#rmc;!Ud>@4?G5VE*TxHC20GJ(+*29Aw6YX*`s6HbQs2Q{DKUVg|p^eM4xC zivc{usbgs?n0YU=Iuz2+XtvvWGVc?qH6f!cXW1Ee?`nOcjt3=8y^1HyYRg_f{za?@ z{5k?WUzGjK=BNffsim2c5|@05Xm)1aG8`Iu`^_@F1 z?Hq4DYUf*G-(rrTs?#VEu8Oq`v{{v#9|>z0n-l9o-978;;`71oa*Jl~hlkE!2!1`e zN~gK!Ls!T?e^Q)zC%I+*kSN!8yDE~o#QtpwvGEhw(sZNvb~Ai7S!H0$1?-oYbkXvi zhO5WJzUsE2PJZuL*PPMoE*7p0b}0&8n&KejN$@)fQ`KW$qfV@cw}&HidWJH2(T|H7S7n5E<<}YrFc0!4R#k|FH!BNoMqZEu zI$o944Svej^Y!rH>R7x?D3{G!m4_ZWH`5z*@6_tL@!X(Y=iA4WA3ma8_HY-JI`s!l zK6IosuVY;MYP7ljY;fyX3ei8WCaHGB7I@gXB<8nMojo`)(uNRKDtESkKQ%p$ETYC6 zDV>(->ijhzy9zNY=V*!Dv9&(8BPco0AAj3xuO)&U3?#WH|RA z@#?OJ@YaW5QNv`#)kJpx089U-=ibHf2InK)BrP``a?9@M3NyiJWhvvnLO_ zHdBV&tYsD2!K3?1{n#6~6pJLZZp8j^f5zcTpT{hW``%mYoK*Xg=PwY}UHA4o>fsVp z?mMj-TVVw~BsuM~>dWv;%*NeAvJ4w?4#}u>d^*==ehOFIVO}^}UXb3A@Y08Ab##T@ zzYvpH9LGU|{VxRE znaVD}jD-+Udrrro^qNBHdETi(zJD&veGdXlOSV04y_@OoJ01}Bmx6hA`eaIR$V%CI z)0 zjPAd}qqUWVJ-*@7MOajWl%f7e#3*ih5UMqi!TDzBInmh<7J1Woqj0nr z{e^9344bRc-LIGgdGVzB3g2FoDT8t0BvLe>gTd9VU2IsZmZqVjg#FjsuMo4@&uVnW z^FZ7DDT+ieSn5bw*+IEnoX1jwtX*EjrQlWnDOfp7R5nM}(8T9sd<|PqHN#zO2gmP!-y{wwcR=friZnGNeMQ;H~hRXwK z(S%-S6U%q$MMn1R^+Rm~n~l0{l|fSCps@$qTS9qi3E;YUh}tMxq2E@l;yc@;e8e%{ zgqirsHW9vv@~iNhadFYIpG}F!RkJ}pL*Z11(TF0`vmw57Qljo6?6OG-9 z4Ie5@0~NLmqgyxHll94WWBe`PGGI0t^$M1%*xbmUi{#u#obKWP<;#6-R&hFUPhP4o z8(>OUQ6OdAuSZSNBEC!fhMSMWfusCMN{7J}D$Ls^(_%v|U6{tB@4n&^Kr#5VLP3J62o}Ej{A*$>WAq0GSKcomn zVkP}CK^j@_NSCi3!}2#2`rzn{Ee86+4#|Zj**uoke57nl+h{an2iG6@2}&Mhk4vu0 z-~4zjfTObjUdhvYdxWxp&=<@Xd=vr6DWkui*LTF;@mLwdWwN zE@>7aC0mdd`{xC2qwkfAAAzeyQAwv;xbL>DQ<{j zkVfm<64qFm$na;Lf*DIM6lb;MLI`Cr!kz)$JyVj8Z>5S={`Iom#-TY>B!+6!?`VC8 zMMq;*zuBmML{e*2YX0jA7nj8mY-N9ti>q%UyVKFcrFG04t`rk0r~PdIl>+^_a?_d) z`L-QW7u76FzHLC7tYoWb>kJD*B;l3lH(nHy)F;LoB>W3}jjT-i-0G{#I?1}xq3edt zMH5nn2wW+}Q}HXcCY^o*ftwO1>&_#{x-*v%xDS=^#On0!Dd45=g#R-Pj&!|b%+oha zt~a@Qa;Z!@g>!yBMZ|)CC|H<5UqV_B1nV!>qIdrto7d^I)^Ltm`3P6_upFG8TKp%&f~3p^E5XcYHj9RHrruOO)a;&y+J9 zWT)j47d_K@Zu1g*LZ0&#xy|5K8m^cN?GF3)x0DPjD$DqAM_6GOw;HjZD|nzaTYgy> zN2eC)&PbK08(l*O;6HAZ3F2R^p!mCgjV+H^FHM0S+6(TwR@a&cn&Z`^#MX8kFFxkH zb}6qhE%h^KDHNQcYudl`;L!YhOICqJ?@hV$Er+4d*+r6=4Huxz&FHB7OIs*L)~YX8 z*WS97$9;}WVnwc69`XRY^S4RnM-3IUya511v!qXZcH$yJ{yv;7S#zmYqbiir##XG4Kp8;Kd z>LOw3JJP5-QsD$aBZ!O-6}~d7YDPNZY5FDq9=4%fk~^wPkT+!wa_95v4Nf(t2d*r$XhD?;Q|_c%S#}6N#jpoUX7G%~I_9@$ut& z#Z~$vPW3thogXYMMzMVj)bU+`c!wmgp=M)fUIk0kWpB9yh$V#(UuU@HfvySw2jSn> zvm9OMISjKy&czz&;{E3wl`FQ@N?1C}$A$-hi_okB>SF3~U&o1z*!L;s`c~4AL^aV& zY_N|yrjGdyW7D@`fb}-UChgOkH_PEJG75`o05e6|dA*2^<{#_v&&Lh_UgM zrK!PAXN(Y_3%5Eytj)Zqy>&aU>#Dnfm8aX-J(vvov9^*|3H8rmMZ8@84rBqUoyyZA z#%D8r&!Vy(CMH@~Oc92iUdSM7$!;kYO9g9MU8mm!RGt?DR$>N*gbE}A&V>(NX%bwC zwVAKKX*wX0G5E%``dUJ}QB6jS{DR32!3eVf9En%X4oCf(=fgRi$4Jao{j;sCLM8Yr(!O8rBmq>IZ08vH zLHev-`gPQsw(FrfcOae;a%|gbl6n)L0sS?BvrT&0;qy+Y-BDY)ECW!UE$w_Um8()e z(KC;|k~cQS>ukzK0!~wx--qqGV>6Ok8 z+Z0NEQrY+KsFWqXHaii5lbtf-yCrsrK{|hK(3bJLXG)EfPKQ)aK~syxff_lU9aqN$ z-ZY_A-p9zCOoyIn$G&J)6gajak2Qw3Ret{U1l2Zr%4R$ldH7xMpM=fSy@2K-Y**+; z*I_~>0g#&WcvDfh9Rsj1MA`w}wz35mVJHlx1@0)9?T``&g!CWF#HzO|7l8CU42U0uAm> z*yQw}BOh{pibnf>G|F($nyMq6*O>$+|BQ2qg z%vtTT-+PF)V+UhJQb)%38pHKBRG3kK;Ys(^mR@4%ah!YN-gpPrEGTY~gvm!MxG9ue zkaD?yHdZ0=4cCIzS*-%kbGat`ubj8}6T94RX9G&`_W_c~l*}DSq26Dg9IJSJt(&W? zx5AY3>};Znt}rvM&h&)ewswhND$+2QgCsa{^<{{YMZ zQLVkpKA01+`d^H>|JB0qK%14X(&9#5dqVKwwYftR8K<{heic&z$|Uf~ zrQ}`NC43(sX&1luISZYKg@$<@F^TvP*^{%QUNU1(^&lxbfufckh*_NP={0?1d9gD? zB+?A%`cBy-_4uAx381XAiA!84ySH2m`e!YWy+c6X#~$V&v2~l{Prt@6UEsutQf!uO zE2EapLKjMm)Q@yrKwX8o#MHN@XxXM0hM+#1!(+lvI+N<>j+N3(X6%XOz=w~JF!Jl7 z&A7_Sg|e6Rw#@n*yy@K;xXKIKSm}4u0w{UlWYERF_Whrxg`JCknHHAU)!NE%VX*Iw zMQ-CeYLDDDa-$5mhqQz()?WZbRSbQpj-4hSBj@A+pNq392KU|jv5kFic+>tL=7qAO*c|Ws$6bIG zAY&J+?r}XsJlsLwB!GjU{MI2fSI?%Z!Zzb$n=EcOItezo8Yv}?XJAq%$@X*wA5hoH z$N;P)@nm#Vs1tuj<%cDXCsSJzIcuPio!Eb{0d1!NBAHj48Ipr`aOa;K3}IgF`<8Oo z3w7+H+%+kN9cTO7WwWL0b(RtoM>MoNVw-dDH{#?Sc2z^95D&6(Zyjo^2>^bON7yC> zijd((M{i(+S@jo>9Y`8xfIsC_$KY&az(ma@h%kW)^oHjNuiXaYrDu~h{xUOEWVAe| zt2F<>qv9cPuQ=A!&PCo;E-Q9dN~~QuCgsCsfTl6^QDuB&e%<$nP zT-3tm*oco3ZOl!}62hvUOh|&@ot5uWthJ1`dwzoFD~CDZb5kOnkeDM`o0Mb@feasW zIa4hZXv!dj@uupDf6bun+VBV)FdZX1k|MK#v9yFGJi89qY4A_qA7{_+-V0XBF!52k zP12G8=5ympdl}ADYu@l|Y*}aJmWEA|h7{mvt2mh|eQ>WB05X?7Y1$=La+$-!?Ufdh zshazxi0gU#9K#(Qz1rjOxfEIY9Un?$?uNAELS_Hh371h?D*yXE?$kS37zmJ~JFi}% zBxml!fi9vm-j^g-Q)U&P5G4~5S~Piw%^hY}++zLXBRhvC$8sWfn*Ab+2F3ZvJobns zolS3QS!`uJ14B;zyv4R4X8o)egcu|idan-Y#`vl8ZqCTsY!+=b##Rhz-Z>2#ezHS4m^Uey)de+{bC4sV3@H;L{b!^;EDR&Sj__0 zL&4h=t&pUf?tX=3-tY4dOSl|;dz2ZRUUuP<{3+W|ak%hGDPR9~W z6gqJq=p36Iv=dN2w5y}4VddLwubKlW%29Ahq>9c=U-Kif{SAt?XQ{1^i%@ zm_RC864__fw$3>hb0^hk4HcCvIgYPh>=0f9+zO6LD7U>2URK!r+FuX=P-3*5aC5S< zT9Dw_a34W(R5g=wk*>EkAOVy~_zDjSJhrLig$?;SxOb3O6-T{k<-d?Y3QWjw@@cO~ zY$O`21W!JSp?JT{n>j6uN@uMF93>+oJa?%@gB(~LPDgm;R9tmtyjKH0L7F^$2kZE@ z8Xm4u8!6jvHGMaiHk9N?^(!taiqmsCr9N6-)gH5G6F5&K67BHI#Qklf3Gt4vT9s1< z+6fz%3nQI&__uo;ur<#*WHZz!UP37X*qZllC43r{EARUpm1HAtIpHUP<90-&5k+OA zea>)#q?UHVVbIiZKiKU7gMB}us?YUOtX)&@5Lyf{lAuRFIxVs|Y>6@7IHchCh#vtY zXA1cd`mqdWi*})$tJ1Qww{k>rD`S^`{{d-YS)|PQn_orWvWUAW*&wT;#~i6tVnLfb zN1e=RSa_dju{2j~WZbvc+2Mv16ecIp+qL0SRALi<-s^kB4tH<^XupgA~QoJre!G>KG7x z@vs2~)m^k$1gNDtlXZLGmG>*;TnmJS#YRuFi6OS85eCML>=0>qizSh2tz_{+R}A%C zM!gnr{f!RkDLdVHl)Z~cI$$R%A?NW9%N6UAvOL#oy_#({aqtTwj3$H5nY}AIx$(*PdNR%5h}9qs1XN0 z>Slve?{NCW5dJkIOQQ8Q@jo%LsQpn%ZW?`VwEgM(0$_htEQkp2RX2bhrjlJqqODVq7JRLKjDEw?ywqfdcSk-=yD zm?~O$-2Bakd}b9r#GX>kmY%Zp zAfiMVGI(?`m9{dOyfM-CuB-Q$-Rev@WSM!j#0~4VVi^fI=6XR9@VxEK{CT%!_AkXQi&X1%iaNkl068IK%&ET#UoX+d(hNqwA2l}_Rn zRPS`tVKIOn1^W@bh+!<5`GnV$I`8wAZfIwBgX*szg)8Ks*ahUkG}i($DeC=_U%-e- z_u`vh^9zbw1&wb4@J(O>IImbm``o*u&HLxDtTV2us8oeMrFB75`6lsU?nDENoVE3ve7wEQxFgiUw+)Irqw_q;iDGK&8p*#$iaKh;wtmb=s zL%**JSFLxJVEXR!d+y|0;j(fA6B4VPY^@eQ%kTG*@0^nwcTHWQuJh;`Kz|90^=_zG zsT?5-Nr?^X!tx2|79A@^hrr4R*CBsav4iyyfAoI&4Wy_~t7o|@YyGiZ^k`na;AwRx zwPs66a}@1Ko*Ww*dZCzKLk17&_D3`s!i))IAuWgQ<367O*X$`IJ12h?FTeS;b-_6< z?pXHNTOQmo6jbYs^Us!;?$X1u>Sf2^RwJ~nguuCjhX$%EH21DHaNWUvp1}oZKqN;4 zI8ms5BW8|2{Yl-V4VmT|z=n2qa3X`W#|torNmgFP0>YDoV`xc9U97kRV&}u@p>%^v zm*eMNF!U#CB!pk(sV}baku!{(u&KK#M}tUe?N&?IZS5TD;(9DLv*gVvF>OY76C0=< z@5w%T+;iz>EYh+W^U4yUb6R&K_nfKEY>!13S|rU_k;^GpN|MdzPC59b939^rw!mNJ z3Wrw8Y42m|ex+w}$9g=IJeZDc`Ys_0Qdxc0qC#(f<$dxVM(WLOb(4hy2-OwZf`{ul z$ke{$8@3o0MXHpIW;B+jBg+s(%OjOVT1lN(tL_U(YYbwR;;;yNRdC#>s8wi2FBkmg znC=x+#n)PQ`y}ZIJ7!N@$vTc*kwgj3AIt7|jqorBK}_g_huOy$nehwGY>vU8#!Aq67P-t8e|rZynSpLP4c$b$(lECXJvwXX zQom=$vHy3z9B8|u<;yDSq=~7@F7ot-#Xl*k8Fg53XCkf(-E%#AN&u7k7J+^x8>Cee z>LzJ!C_m6$BOA2zJHs~<{C1R zcGY3J^v%tv%t0%ndAG8ieY)zx!)zaH^s!Sh$SA<|$-L3Lg9BYFT+nIpO7uqV^m=w# zfP>$4$9|4P2S2|g_Bqv$ohH=u+0CqtI}tlX2>Xic+J z1@x))l?E5~iY<~jKBsb&(i+^v;OFo4DY50S^T&NS#hY~*7EvU)V}tPfVIpD_cek*m z9|P?MES@I3GmMe4l>|jCm#_gcYf&dTGg|mbJ+VN@P=yk;gTVzTE^>rcb!r(}@SuiR1`9RA<57 z?|MaXZhp>2ppUrXp1baA{&*pbi`vAiZ-)xsf)4iozOh{IHy67LQ(1=HeWM4%s(JfD zHMwv4Pn#IX&GEa>PD26;4jw(K2pEGm((&DS;hd%_=egfI*ZlpoRj*x^g5nzGuwAXZhWu%2}um4t&#+&EvZP_M8=o=(~*Ujx#RDcHzG#-Jf_9^3p@qfWVZp+O@amML%3j%u&xaI-B`NneiQ7fP}5v0sC$8>Yr zu>uF%zkdpLDT;L6G*f$s<=1l;SvFV>XM6*GHii7A@=)dBBs#NJWBlaLp6mD;@m9v^NSUw<@?5s`CGYu=lSZd=}eEP1dZG*4;Ngds83Q1yM<*ntT(*+*bOj!#gi; z^t{Se?k}?Y__3}0izMiIpY#ax=a^tVDe&&-! z$7090>&NNx5{#eu&*-sM|BBVOKW$jkn}iN*&aWfT04T7)H!4TD2TDtobL#WdE_ZVw zkshXa#w>{K*M1-H(S=hk3-`#(w*}}`O((8+KB$R>xp+|{jw!)d-U5pM*^S0)&sY3`j9L@LXB;R5?uq}? z*33x)XG9@=zes$M^+4{*1pP<&nM79(3b-NfHW1|!bgHP>-0)WOt!A&*s@z0IdzGB} zK{KVl$?zFsLQ+`L0Yl18TJP=2uKyuokn8`KrEr07a|i5R_lmaTGorMd+f8Pe;heYIohWm9novZ+Y`IKoxXFVm69y*a+%zrw~N8{ zc+PLvM)Dt@9zFQl*->V>TVZIh&YPq2XoWIUtV9yUAzjX4qiUintz%wf8$77xqRTW1_b82K{F<0<7Q+^&cU&WsbbJIo@_!NKE>+PLW!JQ zh#iN=s4bdcncUYi#RZL@c}}Cz?mv(sihj~OXXKXt4sQY{baL+Ok8Mg`<$DQ_AM~BF+gMFfTqV(I!Y_YDZ zL`Rk#+17VvphgooI2Kr{+D7DCYguj^>SJ$=VT+H?YC#eMM7XuQxUqK24kz+m1+z`z zVM`9Wcf+Lg>XjO~lF(nY^l|HH!LiRAzI)gO8dr`}ogXiA2n8Y*8vGau$EmL^@>48- zbFFM_>|a2Oq$MnVax$x(+%S+E+{@c0Jv> zw!rZnPX$AIJuB^m7=lxb68x>wr{YoL3Bc0LyOPc1z_eiw2@ouu-)Sp8%C!seD9?&S zQA_j}V^cTOgwczBx9_kWId%xP0|-p6!2XVqsgLrXDULEx*+aPqORQjTDjNHwQot*Tl1iy(;}3suI4rmAqVyC1jQd$#YKInCiDfJr zyim{jG^9M;WVJdV8$iw!Lr%dHOP4*-rYOYTw?jF;AZ@c3Ji%RS(q{vS9Of+craB(d ztxo2NpT2HAuBvg!H-;vdO$^zYv!m!L>WVcl0+YF%=AEh>o|#sQWB7wfy}31CZXkQ) zOcrACLgrqck{;ADzlIH`ocT1ny3rTs1kL+dUemd2>0 z_;W-3!J2nJk*3AY#dbi#?l)W#EE)HFv>XMo^B11Goymv7SbY;Ib2pXXa&w1UbSHW4 z{e2%ZswlI*@W(fw)|;-)P!*+?&9otLze9cG4KM++r`!?nw)u;AM?ur}Xb`M8ii_m; zBz0GR4jILB3jHLYhq?)mNc1-I2X!6llQ2)r__r@$)o|fC{+w|ve)aG{vHNV)kgc>1MUD%!@ORyn%`Xx6>YmG`Kk4NM58aX~ z^Ai#F>4=;Vn%bS}+?$JGINki4FXLKNj&Bo-kC-DJv7wX1uyh{@#|w~Vtejbv0|%Zy;A4D9fFTZRCm z>vdGygD4rly&H9(>{Ndg^6{dD*>Z@#YMVs)9DNMFKNQ|t>qoLmsKdX^@pXm_`$4(xeqxoLFW3BQk819DfJu$9v?=XAZ>p5g!zb%;)nwrM&)gSewll=ro zRk0o1th<3mRV+Hg{4F2dGN#ff(`?Ph*7%RB!cH_O@u2Hb5A5;~5Z(+oCC! zk=Vg53Mo{H?;g95tl)1Lgr)Nh)mbEI7uAF7P-SFGv|nAWa!7+nA64rA4Bgr7Gz+(6w)lJPOc`?Kj! zb|Y@YIDN+Dy*|0a;4xhn9CStqewb3fm`u(1qCgfasZ1E1=Uc7I#_S8w#~1H{1^gx^ z2Ixj;Q0SyVqJ{aJ1bUHYDw?3Uv9dAu=~sju`BI#IN%t+L8E}{*>vwpb=nbxQy1k*b zc}AHTsxy~w2<)->Z+-Qz_%!+1h~40<;)ErC&aEgFXY6mh7Nm-f4nd#Zukb^6O-3uESa`&$5L_+7deb~3u>T)cL zttE0Blc@$0Q$6!W>q3}W`Nq=|4ifC7Ep8_x2eYMbXKqiuD$>ig*3Pv4ySsM%mEW#L z>6}^70y!tLZ7wt%Jt>;{RQXE7ylG~+wx`d$DG#ew=#}L;HD(${7z9hht|Bz`PEXjL zy(!J$t6x_YWHbkx*X(xZzFjemPV3U_#KayEBo z7e;>Iy~7{=C){ZClEZG7P&La<>~N+;#tg1X+^P~K06 zi3VR^vJn!BiE|2A^=QPn>9Zq9k_ z2@k@|kHC#tEyey#FdC0>vC zk~OAiT<{_vgQyFd^S)V$_^xpaAF;mu-m*GO_{?#4R7Kqc%tpJ8m#Iwe=^EE)drdS~ z)zq(HPQq*kR)0wOY3Y>&PzboUB!nyyOm6?LNM^DHQBC&v%dW*%0=4BL@{srcB=P8f zn~?(TVZ`jF;_Q!w>5=D71E6%xw##TRyrQU?`@%q~O+bZuphV__K z(NlI{B@9rbLV%m!|Kp`(zja^c>tL_f=i+|&_gkIpyWRsXqCNZ+jC$edGJy5zy!QQZ z$r)J7NoyW$;&q3`j^)$d>SWAD?zj5o+zw~IK?ym!D89{I6)?8<1`Ku2WH$p#qp*5# z^y3Ih3C9!Wfo+^b{`g(^-g`vsQHpW)F6FCWOZU-D#Nqv7(cQ7JPG6JacyK}5ym44P z?FDvNaEtRPgkEBM989%$>Gb?>g^sJhd^9&K*($SRE9ILg`){S@X~SLQyMMD3%X82F zb18Q2UoXYX&KHcNJvi=3yHTw>v6_BMdDHQJQ2Q4bP_(0ePc}=)a3+t}9WdL9;ykFQ z65r}U`(|!9d|(X;mU7v|H{gKBU(Kx`VqM_uj_5B`j0lk-^%~CXZYhE@3l-= z{+OxiiA-Jac8NI>M=h7R_Zm;+ObAII4RCIk!t%J20BmL9Bm1jz9xujz8}--`j@l7W zH43H@T8sCK3?4(vsra3~D3?-%cX1iw z{%(^A%5Jfyh7=(&ncyLQ3^!iPY)>%{f3PP1Vg(ncV>tIN%Y(_}lA%cIhU_1&Q@2?5 z%PaK~Ko#m|-sUYB$eOypoXYkQX0*H=+W=%}^Ts}-RofB$qE6z$77w2>ym|9t2zJcm zqyuxJTRdm{&O5Ea(_79$ltWji81HWi7uo4E>2n`ve%P1fqi>aJ*NU(9Yq36R2ywU+1g=zzuAA5t!PSicvFv=fMrLzc>rsp1kWXE0w6QFEsEXtVS}UhgZAd^4+l_d zj~8yeqB6g&X*qcIO~&HwWBt0i%im_)l9qS4^FnuHgPt$AAgw4y;iMI<+fTp8bZd_F zLGyEETDQ{DOcENo)M*?_bm_&ig)ZAF?4cgjgx-Vq-&Aw->*)2#|3{R}g?|+#ljKb* z=IlH0jX(g2GWPwJHD%q4!*0uR+vs=xB9fn4+tkx{@rq^_BK`SSYD)3TW9ImG(7_Rv zB`+BBH@L;^X3#tV#$0=Htl6vHf>_bmZ_sTa9v9KyHubsAy~74D^p6JEnJ0yy3Gw+m zks~so`L)0FJb_xLfTUF*k^7b65_;Zlv_pJ-L-^L(p=v|B1nR&OJ~!3~JozK`1~Tr3 z$dyO<3`976R(|irGjz`TBJ*o9%TkRF^HzXlCTQy&?{JjQ0D`J<_yDpEYoSaqNf%+^D1s_G3p6rEq0eY=eVYOw^kdU=)>5#wzupf4XBCPRGl z>sS_|s!L|H=mJR)o1>qZjkKO@5MxRQVio`&OG|~{gAlf}4}p9hm16eV+s5D^e^1cu z@oIl$eYlFrGXu!h>T8{)-3Rj}ogZiF&gkhMWf(zLS`vp!_@wW*gw#MSv4ziL0gGij z!Ti?g&bp;5$*|at(?o-`g$SR=|Md8fhgeuH!Dm*{UrIQBCF=~#RYx4%mztvx!%XzP ze{ldrp3voEb+BvL*)+>j#f@++$lMFvZ=~`F32!}vMe!_-R|czchRjcJ38_K08y-W5 z3J8mqAiD^!>n_@mkUDfXwv(ZMoJlF#saQ8e>oeu{bzf`sV4YL*o1wOw@sN<fw^3^Y%48DWSi!{7CT6Pzs z{_%6QgKz(j1g~25hO#^O{hNCHg&N(A1e>q+byCd%R|3!r?x>Cml`o#SJz`|?N1DJP zEw@8w14s*Eb0zd5Y_-q2*6iNxh?Uq?=!m^l!d?jKRdlYMaRa-Y3U)H_vrna$xhq$1nohq`HhR4V#VdN}Ls1VI*| z$hTa{vU#bJg_RoCk*RS#4zqH^60C*c-tz!f{tpQIv^l39r_!QwO>MM}>vow4!*siB z2{zd23l0dJn5%U!xd7x6t=EZ*$Lf9Tb8Qu%9!wNAaYT6yUZ7+|TTFBW+;`O?!Kd0N z_)2d!6Dj%rpoummf_K8$;R5Z6>$=+G76_yriNa6zEqCrFaW;>cdZFg&TqI&o{ z5wW}emMd-r{f3B|XouS^X#{;^XkcpZJZsJ0T=mx7cw5-N4pqsOeTC8*hAI#oRl$pn z#mO?g+tRLmW#Sdt;5CBukm0cT%daY+`*!f4@&_6%So(Rhlr={B^P?y5)rZT1+tOaY0&^~QFG{K zQ`APtf5p>OmWh?yP@s}Jp0&!m>; z5sXrhui1nYuwbtt7eXH{4Z1qwnQH%sYv-ee+biVDW<-m3 zN*tU!dixj6t9C!{r#sutNT}FKi*R(FtSArtv*+;eB7W#Pq&|qx2%(aNklBf-&)73| zR*xYkBpYSx5l4!Ts_Nr*1cn;YzJZgkP-K3DlyEKh%^v%be)xBYjI zLVwCx#n<-(t{PkEMlABfW21J!8kh4%yxr5AV9b_Q2P8g5jczzs?M%Vg@S)Sd)wfAc zRD#*#H#=m>u)qaV3>fKhQKspwWk(6iqW1Ng#`o@v*JvR4dX0=^NT7nlz`TG`>=jfb z#+R%r!U{n@w3GJCE;;y3B}Yv>;Sb{;mqLLO-(A2sNo>rpPnUDrs2*?@SXZ2gQRSfR z_~9^qHrMyRrEPq!c6`pqE&d0h{d3(g+kPFOgPoi7`i5*UN?7G>K!*!VPu8}3+K`&x z<~OTS~;Y7G9jJbt&P2nO^8Y)g8J6_hOe2Ft?}LDJZM&GQEYERuF*j_%OK*>cfXH4 z$*@hTW!7}0N@E+h@spXfEN=_o)>-~xL$rvDYEX2wQ*QwBGJuqT1dyeyf#=(Oho0*9 zrK^*S$qKifhmX)>6TWTRH&9m};k|F79?d?+nliwF)=sXB$>`;P#0BZ~+T1^v@iiwC ze_B;dv>jGhl9n=?%;jCnpCk9N_eTl_{ zEk5n$RAh!k)MsTY{%E6;8s+Qdzolv2`b>12oox6;+H-=~SNJI!Zf(w1fcdJ=PeWMV zA8nzD7S&s9v^6Ed_4dInaCyPm6?r=MkSDfkB*nfB{L?(1j7i@x~rIXLBM zN$a^b^oRvSR`>Zxx7O5bh6qTBSJfl#uw9#%qEv(M-FM-1r=BRQ8b9sBmfLt*eRnZB zCTK&dr2d&uU1XbCv)VMzBEiu~2r})BAuR7{C{W6F3>1NA` z1ue3*1M_(wy};w(YVcff)j>*mx;ci226s=4svAq~-}`9pt8EqF@lcw!V$y^ib#)t0 zTJv)Cvp9Ae+W~n@g!BqFOsOpoQH@!5Q0qS5xWl*asWb)d|FmwsRun34@-7hIu8wcK z7S@I)EX&R{KI8^hPQJugmPc@cOhv{B#UXnw$;`l!^cUtB4yuo$(~H)7T^ z;Ch**cnh>4-E(QeapOzhRP9@QxPKhjdUD_Q`7?#_zuYNnub}<_8Zg}2xqVuus^q1P z(7dx?AFiKhI86C8BlPM2_rv+$K2l*vNB#D_*E;PSh_CxU1oa|eB0lS9kLb77!yFI; zYuVWStT3784`H92H$|9Q!#QM!5rwZur+(nS|BXZDg8=K@whQI0?GZGK36oY4*$r55 z>)+h$b?`hojUGc}u& z3wrnPgq?IN@^4u90W*B683cu`Bh(RfJsR9}>z0FBsRfr=2%WWDqd!bl>a{0WIw^<8 z*Yy?&5)`AQ>0q7UUi_e2PZ^ISX@+PTo-Z@sSG&D`dbV_-+ETcxqFhEx$sN}f;>>Xp z+)?gVymeV-uKrEWz{mUe2>dN+Zl-;o_yT9Lv^;1$gKvV*iJx2!7am?-&7;@Do6#5y zt6YUeL&Hcg6NJQ=YUp!n2&c=J6#T8Wyl&ZQ9a84iwY+*Qi}+W+fEV9A-01dKw?MmF zEwkKoxK>C+YW~^skv_IQOW@L^Zw2kh=OyJ;Rs`)9mHrJ9Vv57eebkdU3l&Z_M=TCH z2Q?B1MKG{F{nQo578Floos!cA48x?&yBv@fsBCl8n zJBex3C5XxRnBBV0-7VQA3ox@UzfWR~1G#B_3?Wrws)aV)e z(o4XToP8aIM=R9)*yNxh{frN3a}9wrh4%jUk05HZDj5?2O(Sy|-OieuZb#}lKr%j~ zg|Y`XGzSs{wKbzH-B@)Jg(=?0`>w}*AQXBI9S?00*Fn$n%wjoAHBrL5&jGzplLBoO z{MKY;#S^;p)6O&`A&h}{+r_6`BE0T0l=R)}0QVEOO1ipo8fc58!DBsN-qiNmXt|2l z>niQGuYCE!@z)K1uaF-5z^yIOdiB-un(Er_GAqkKo-EQ2C>7%q2k4@sAX~NFr3rt1 z6qp(7no@_&8A;*O0|`NlCbFpIb1iQ((%)v-DvW)>IrL_2NFbdnzT8a>mWDkk4u(d* zc##4#aT@>KoB(p)si zzAK0H);?#Y{pV}SN!pS#ADBw&w z?f%AIi0&>m*l-@xXXZ^SjW-|%8m4DqL5Tq&UrD!b^`E-B>$1@3eLOAfy_ViJT=pPm z_IqGe60#PEIc94rt&`62p^BItl8WAyAk_;;mG!1`w2(9 z3UD!9>eM0+UV?V)bwi$C%!|F!OX~^AY^-yu<2)SIVm-?DMFg{gx$+Oyf0!;nXr_OT z1?PO`)a=KQiCCkRlclM_@M8=y%v|bTB52DXyi5N7?h7)AVZk_&-c&*l)PaSAjQ)>t zVgBJg;%GxoP@-iwlG!WG%8UVH<>@#6ZswojBWvns3d^a#En9vSIS>Ppi$fv?FS(KL zb-qikodrA}i!k<&{4atWX{_bo%K8t~KN8_c$gFj6FiTDgqV1I$AUvh{tH*zPY4DFX z?*GSrm${FfYA8p=iT<=5vW|SvPjT8{ZC!!i=cjcYK9`=ItA6sN(f+PgRdGEzGLwVoY0jSz?g&{71 zJ<;;$nH`wN79>5d@RX1uzK}NXaTIxzntf7W-|i#!w5Cn3>=HTXqY1mBDsPcWiJF@J zm$u?>W&2-^$^ROl7OUn-E5(FqFYm85@DB*iDSP(|e?SyB(ye@t{50|HfP;L}`%$B& zDjxqoY*l>FoYU-m!~YO``d`}qe?8qiBh0k#)&L-h9cweye#OE4Q?0@=J&7fIR?uJj zDWlztR@k|5iX6Ln;-aPbWdTtM%wir;RmzF=U^Fjg$Vp{^GiA9_ea$Sc%rMHCw-K9V z&@n%h0_d8p3<1t5EY-}*`Os`{YSIaBJ{z*)N@%dPXyglT9lbGor7E#VH&{d$wu_=q z3E>56J(49C@F;VhfzKZDEjrl&-tiv1Wb~g$Qzho|>L<^}kUuyV`_kqC-b{a5wLe|B z)S~~0l~G;3;GqrOx}Zw#|BUh@x}8GbiqV#SdWP{(+(}+SGUBR!(x&fVQz>kYkeqc@ z9}?|OR`#>)JLH}y{`axaSfsC$aaEt9?}}{3uF0E1kzv+BwNccE+TDeF#XcIaR6pJH zpl$11iuLC}%7!@zbgvX6=y^7)upi+T-bIt6ZOXaZ2p%sDM5y?lmiVW``!Y~~`wHx3 z@@Sd2`1%+9%pV6*7(D*V`n;VckmBC|Hl|K<;ZAzKe){q5FuTg5KBDe6fWt+}ZdCoFVowu$bo}+n@ut*O`#rV4>WG;pP8IsQ zzW%N_=9|JPpW%3{R?-ovwHl4p*0<{kNnWHmRalm3n@_e*Oqg(K;JTstRd+CurbXTg zQ^dV)ROp!K@@fWqpQ!TplZd-9H8-v;SPCA}oLBa{(D0h%axFWlL{qwJvE&gElDb~S zc+;eFiL=Afd@I#r5_Ju}Hgw zAU4Cp!}gXjaP}S%p|ejROw&PZmO-Mc{sZ}a-yQ3HE^Qq)gUw)U);DY~uTx{GZ9XHQ zqt53Gzov>`JvELI6FwV2xkV@x(lCj!M=A~VH?_+OgVkSc2z$bua@{kEp+RZfVKKycE+QJwOhqI zGCk&LL09F5Cc^I24%}0U^Q{B*Pn+UXMtUC>Cl6I-WdxQcDHkGVE2PqD2>w>2kcsg< z=GKWbo0ng?@orptX!z-QOK^-v)CZu{RqLd(^!=ER0fA4M^v$v0w_o3Svj7vy^h*J^ zDdKS|&!xioI$Thop(XLi`6XeGk@J)%;OYfykHqnYXFabvLOzz2@^AQwI>vb?nnMcM*A=of=QaL9zq=RXWJ#H${Ec&xt+`2u{M|~oQna+!n8cXrmbPY2-25zj(ZzD__{T$MArLL8bNiejN4ufF;B@Ha0}R22{r7K zzZ>uMUbt~6Sf0vH9a{)n6zX`Gtt`A%rVt6HE+dA5gvUOg?Qp*WK8~vxUwgwJvb^49 zNogEYCKRkp_0>pvNK7wp2PLYo{LrxOu-#@g40!g@^8G8!CGdEg2HugQ4 zh(|ctn!R9+LRon4%`NYC*@mT$-`f98+sk17OR5&KptKdYOeR}vdtJu* z28Y+^3b@2;65g$}>w4NLchsvBFWzHt8P95J5-;+nE+v3%gZs?exkwvtLJAZLr9gpp zifUMA>2+?p`&JGY?{W`vKKd2e#oOcSTF=Q!ONylG_!i)!^tcTDo97cmMm(9r`bA})c(~%fnf|`2vN6!Eo{ut~JcG!S5M*8{c@K1ZrUZl@~^iQ?Ao;|Afm+`$`Q0p)+;{L12b|b0|D>CmQ4{2KiMPgaXmI9b!V_@ zd{M}n63&ePcAJfYQZY40C*Xdvwu5o!1dO4sb@P&KRv!I%4#vA zW8u@8{UGb(^-_c=#=83QCEmX1wh?GKK+v(y-=6eNMVCG0nOc$8G$Ijf59c^P$E^Nt zQC1w5kNj0?)O;$s+(R$(LvnzBP2W9{B2V04`B?bl<=cc@;=)PZM{RC=yTozNJk>cV zT9H8iHhOI3tcvCky@mEOVdeTbVgvI*$Vt$g1UY2}`^K)le}S-t9wW0Z<^_82&r8>M z5TnX>25L%sQYs?D#1Nk}aLN8cyF~GuI15}Hx()npnY4yHQPNSKdb@<4uId-IQtjIz z!^>N7z6(zdw5KZ1@+hvYDG*ZS4&0@)D&I?U+@;ew?$YyAw!1sVcFf`XGZ#hXLo_LJ zff?r2?YTZSH+CaD=O+cqa_xx{TF{f_I0&vx@G(oXD&EbH53b%0a}%~k`hM2y5MBNC zz_+~RhXBZnGJ4Y?!cT5xbQiRQ*HJuIjgat)#M4)`*>sKs{Vw5Yz1$GaT4=5wg%CUd z#f?&AIVO4=3QCq`O?8ZdwxLUO=BMnsXYlZg@5Oh~rDfF8k_R;QVy!uUOX!lJDx#c9`(ppy}OB)(%^rh`B>#aW(IIwF_${!z=eOt}ABbAnE=3 zb%cn>K69Nj%%GF7`+I>qtW@~^=_A$x<2~^6;iH&m*myW+I1;|+CC6eyVa~8kTdJjr z-kF@N=W*G!;HjVd8^q!xQJmOFk}hMq$)Jmi9RL!tKeFHj!@`{JJ#Uz3A^V$TM2FGbXF` zBznjTcPi_|0^{fUd!uJvUte@t!F48_Pv6P2?~n;xb5ROB)mIbw=z0nhqXqGOnZZ+E zRDWNrk2(RnGi2gYT_rr}nmQX|2*JyuDkWfIM?#~R*k5dW?uf4YZMqL(v;0DSb3U)esJ^n z!-V+SV2~3f=9nLRB|P%UUeH?E%(q@!qqWmh>LrY`!k5=dp4L;Yci*sknAj!PS*w+> zB%6O9?T%{GpO`aww_CzT7DY_#c<~eA0wVJ=7=1yuhJKG;XY)0qo`?3&= zH%1Jrq02KOX5iy(OP9aAmh;9ljMYCDpKpp2I$7g5nDbUi#T>Qy2PMsZN2r)sdpmNg zN$hksJ!5V3wDnkESX9c(7)iMYQ4{#z^fS-XY{r7&l{UK=e|7;3xz6E&-l4eVw7k(C zQdJNe3SY37OiOap48FvAe|O#}#Byob$_=Xe;Yjc^$c9;d#~y9sK_a);E|)Jtc)<>U2?)`koy3~k;xL! zol3OAi)eG+e5AV%R}Pi`nb6j~v@@lsqL>UEG$_K%OwrWMwsr>@Cp*`B=5euvF7Jy_ zWR&P~w$JkW50vVtj1doLX@{2~Te9X4^vt2~JZ$@XUfd&g8fgI! z5dnYm%?#Q`&^Ju5TZgcc9*5Aa7o$nNkhd1R(CW3?V;vutjzz51Tc37Ii5PczntSD| zQm+U>=}mS|K=5v7SSCbGIFR{MBzVGpuGALu4ESqsH}#0r$&sXd=&V0=sI zX7)|i=+l_87S_3TFXpiI>K_+Oabjq{8_lY3mmtrM!ArNQ@w-iL9Kv z_2@NeD0k#u6oO!$&o9m+hq640zM1N}q|~_fhg|Z@?%u1Y6Di6tNIE2s74@Ag_tWNqVq^4=bc?$VsoI9=dpnH?d*OW!1>4hF zUbxCPp;ypkYspn{F!T2v2j=fXAq5yCPI6y~g=Jd(;fp@?b+_OdRSdbhoy3VnAD?#^ z0C?P4+pKx-9K(Olo!U(Jyvbni$c1TZ@AtcMBjT|gBa-&|jC{&qXBfZcRv=0m<>i#(eXWScLkG8x;HCDJUVevy;N z&Yor}fRnTcVm)EKg+vT|@M!b{!En5%WKFBUwmYlaZ21tBVH+lcNbD2tlkn3WSsVz< za1^#M)_F>sYr|YLe#cK7m&op_TPHUaoj+9)92_E(yC_kD7Zr3Zvv<(+b~Wzru>fHf zJ^lnG%qBT}wXOWq$27J3xXb+EI>ml_lyA~jRrUs$!m_qK8U50V)Rl^D!d&kSJn0YO#5H&k2nO9u{nCU|~4++L7`vS^C7oqTdmWKIJ% zyHCI$oB8F`Ri9t4?CVu(5|w=VXEJ%3TaMGu3kofIsPx&iKf-mTb7eBp^umQ1OTceJ zUNq{2nGRZkLZ8g)_sg?x1$)>#31}!VPV;4^jx4=yf1F`Ear1J9cb8G$&+3P5fJcJt zby~F{*D73rB7S}MAoEWbt`9384Rbvh;ny|A+C+S*$vj^A+|X|0#R3@}Agj?kSW(s` z`AxBx;LyXns8Q}6N@-c>HW^TULD;%*{%CNt+=?=zIp;j1ms-&Cdil2p#Ifx6AoEGW z(N{w`$i7j?<7`AB=_ghi2~Q6%FDCsA&@sY#kL|w$+S|Wvm_FGce!gO)dVSSjU@QJ+ zvq7uy(sMhfAy)0?OW;jCym(?iSJj7T+qoJ)kx8F{+Vr>;LNZIJbbHu*=5ogI5Wy8x zs?*gxQUx*p0#Ov_;SD8Tg8=phCZT3mHpTk)E}^qeTnnD^i0kPvVqzFa$Rrp-LXesq$^@!#~sI^xR7r|R-fMCDfY zLczpR1*7ITJbooKi!$3^z@TWT{18 zaU{QxjhI|xyLVolPjU72v_pTT!urc8>gt;rY% z6DS>dM-4^ZSRTU{p=G37T3gs10n-D1;@m*&`jrp4g_rjxP4ezJHuu?F#KqgY_A{PP z5DrTAe!+iQ*Gk_&1U`P;dBu$`n9+j(Amr)Vp(l0Uk9mX~EW7rJhgE(e_MqckK-+t) zQlWD^7L=f)8PK7JejT6tj&@wKsDEa>Z@mMdZ)H_Ouckbg3CX)8XIu78v9zSiSYm1CGyKBtGO&40YRLt#tyrg*H(D{ zDRlU1weD;Q08=|3=1N?6IPTzRG(G5XpAbEIhUTxFOuX6sb}VJAV$64H4#!Sa+kJ$P zsC!$imVaJtSIE}m^1gK-2(ZfsoeG%$;%BTmSx+m0i)8I-76nDg7Z+mFMY^M_lRwk( zt|q5S>3Chy^;+o|V)4-NiK0F2QTMcl1D)r-I6`$h!fs1QONU7d7`&2ae`(j==u;g8D!^<*rzcVF^nxp0Ax3U2D zBaz_9a)3JKk{zB52Gt_BD}8@m&U)2qpBh}rw=!=7ZI~Y!O`Y?}2fm!` zt^Ao0+UcqtaVcdf+C%xt+Y7o35B#Obklr=J-r$C^VQQd!J{IR#LA%avlbD+ykch5CWRa zRFkLV5WYhztBNtXVOaZ!%6BJLKL)Jrteim_vV`A~5inW*o=Yuj=?Q)Pr=A;y1G9}M zv~KJ42Y<5}Hjwax$oiG@zto(3ou%i^zAc*<{5;E8PF_lo@BqefIK!8wf7({Kss!dr z6-_;_&%DPLOcCkgIGDrEw#@5BNqeO2$}}?c2GZu|_S|OnA{|gToPvhn*R(CMB$RZ; z*Q`;C!Z7=#um>U5#yd4Hv}M=3o*Pp-igfSjgn+q6*Mtzd@nIe=EN{#!jADRJJx7CiLPylpNE8bD@^;W zR|0Y*5R>9pMv5i}Ri3=7?oywajZzHcqqVuGsVDH!K44N{SCXI`jtfuz-71%<2?e#N z44f}yF=0rk<6CAC^^NnRM6!!ecL@@g^s%G+9^>ps^XuZ`84a&`e97BwhAUA5oB zQVT}?h?%Z7JZQ=h^R}0MX3f^`1zjm}@{3wworz zW3A!iYF1^tFn_c5RMC8l&Fo!0A7GCp*|@q7>nW!A@O63dLXbucOi`GN`To3m%7PVF zhcrfPHK+Ylx{XJH=vnWR5q$#?m4u_2N5(@!^M9tT8Gp3q8(;M-Z}mbWvjzP8HWel-}j(2kF)eBwE2O<`_`W+PR z?t9mxk7q#TeFbh)$OUqswO!xosbHjRbQ?~bzo1!UA7nmm*)kU z>Q&&9#y^8u+{$@c7a#ltc3aDRMEDS&0i(Cxi?1{VQ`S%U?h-fO=&4C5 zy6n8B#d2?1d7Hg<;hwLC)6ua%E%%94m*6V$ZKQDnIS{?z0H&#|i3b;%#<(!wFBx1~)*466bj5m5E>@?RqcF0TCQF34AlfwfR zo8LLhg%fD2bJ@N2$0ut)Ee*u>wKIN(kwYe`$PNu;X2Oog9#uMZI>_s2>yNBC{m8UL z6?*pVue15vjY~nZJneh%nw%3#z-~23HgkTj76)~jeaIG$ceKlHESt2fLJzZNKbcMa z#MxD_Z1jQ4at5FjU&kr5iLb4n_Y<5}rTzalRUf)rmRACx4;d@~7!I!hfn5Lhllq9y zHlxliN@?IeR^9}7At06&h$}=>t3@lc;rbjW=ve5}^-k;lnNH~`p1td&skh*nKM#9} zZ2r9aI(YCE{TJh8j>tvQe~};3Tt61Lg7XyZ1KbdAviF|iS;;;5ixO3&EC(LXl=HwZ z6q2(&2;uH+(5LEpyb(SJA|t%H8&mrE|G3iN-vxjfoCb3BxH%;vy_~5gOTb`nb5AxC)Gk37-+l__G`7U zYMuMqxv6`|JMmzRi2(XsF-pQ$Ltk?@%1%IyvD%I*bb0N&+!#}S^bXr}vw3z*L;JH5 z;?Zi8$ZYAP-NVrrADae|T$7gmy=^{(=B$aN29MlEUNr!!a$F6RV+@G5MTO_}G9nMe z&Ex;2xc#%Z;E#`*)UHgFe2rDsFO}!$_+N^2pzdiN_eH)Xhq{6E+q6FgQIFyJRh25R+JEjT zvzfZxS0E5!r2}K3BhWl-v+{mMs72llaS-o6lbH48+v*LT2=uaRZ*x`^PW`63f&Qlu z(}(!)>^oo3lO8(h@o*|pnfBWa{wfFB6w2)+!1+_mPX{`@pQw1=hp=BA(OiTzZv)*c z%k2PRECiZSoR{TgxkbpIen`ys8@Ea*ZHM|~L}R-PX4DBoyfHm9LusA=ZS4#3d4Or{ z@-OJwau=xN!dN}LObP6PoyjWpQ~MnDCP1V2a?q^Ig0*~mXfG<_V>+uJDDRR&Jztgm z?!7n>-ay8`snGyI{Q5#gq9n@2i36RxT&1PB_QjxnD(=l~0WAvTM$>FReSCYS9}!y) z60G+1>Aw5TI_*}rSJw^nHO^-5+k<$cY{`XA#Hu=UKGXVq z8+sFeWiXskqEc(=1JrD*M;op1oZBGbksTxUv}1sgdtsONIRQCGjgCVeFzNyPEBoUO z2G}mc*Nf5rQDqkI+V)Xp>n`%|&mY`dp8CQI1_?()_>r08K&R&Ir$7N@6Q+FUE}L`l z_0f_Hk^S-xKFwLPzVz2>e7|2T;Axrjcs{nx-H@a_n<5FLAv z2hJfchg~4MDfdq{lP1mT{<QQ_RYgmvnn4zi6W#0~~YW;Fhn! zxmv`3y=vfmiizjHSv8<5>v&hf|Gjkl2X;2@`gx17RbXrGgBAs^)3qiIS6j`y25#!m z!cW>p3JM3DUVw?1a`(aLQRUpGe8$5Yp3B#9+5_u~OPE&Y6_}(02C9qaudsKV&j>wg zFg9G2x9*shf%`O098l0kLF0|mTWs+HtGjk_eUNvlpTj_oxNg+D6JCs{lE7Yhyrf&m zdeCqqZ$sT3)E+*HczYBxwIG@9E9>r(ArmATI^?D24>6uR!Jw%jrpLK!nJxJ0qo3U` z2cch|u**1g`Yh;u1qsv#{=E_3^48>$gYB2`*@w{|OACmFb-(u{+H9G6T~O|ct$o2T zew)r~D7B={z?)WDhWN`0hN$4MFN4O2ccHz>Xk00;1O9k+viD~Aahq@hq7-6uOU!Ag z#gHrZ1WjpOYhmn;e};U5gb5~I$RlB>o8%AHE}*Jg_OsuAIfKct>8+shX$pS8@L1ZO z7iX&~ew;L~bXJ0ruHOyFJLP?;WuZt_TCC@(2O zx<{&F3o62110>_#+25ibxD=3a2g1WB#G9L;eUgzQQ;+dU*hQe5#}NX0eif}l4&zn} zb|8JDM0`B4z0z|vL(@&rA0d&u4^q1V6wIPFC0T`ZW^Fx~3CQO~Eat|?amxw}#fmps zU~gb<%EOl4dS5Zg^K{e-0!qvJs_-@VlREJW3W2yGGwx>qNA8RojyFNgk9r1XGxBd@ zcw~E1?+a-s1ngWa+k_yeNxd&&3o}V64K>3-SX{Y<+t?3bl8#uAA~FwqBQq;^ijxqAc?@Z^(4-RG6?R9b=N*&{2`U znB52Wryr&QI+%FvGy$x7hp%vHp_AUx2{SlJxa z7bn#Z<00J@j*V8pE}b=KkEJ3`9?ez`m1~aZ!GEp<42N|GKlWmQ(y)%2P7)?#&W)J! zq%(vIFkLFxeN6n2XDl???<`lU=&Yh~H`2`(#EnT;XXk=rZL@0#r!qvOp3Ou*73|J& z*Y1;j<_37CWgAh?0k;)Ps)9fin4`6vL6AsRp$GM}G+Mp}dm&={F#LYc(qmb7E}e*M zw4=c|F1gM>(*$Y%`GO&mLaN7`CQK|qj!+W&zAio1YOm{7r}mr%0gG&R#_uHLL!eI3LZ`qj+E= zv?i;2wz%d)ydo}SrGJEZwXV>4yxz{vYj4%c=mwQ`Yn$j9(bk8e*szf4 zahIGpeAcMR!gw`@-ljkFCLpOuBtWb2{;kQ)0Gl9wMoX|7wz1Veo8T+gQ3jG1X?b|o zp4bXpZ9XL8pQQ!FnbBa;6|FatQm+xIvwqoh(GZo^NewI*#httsv^JhA1lOm11Hhwf z?UR7L&(se$4QnL4x2ekzZTi4`1vzbVa4wMzt?h`>QsMV~? z9GBZcW@`_`A7vYm^UN8@V}NN4FBAEpRCEKB%|Lc0A9IgXhrUMbzLPgY=~^0ZxE52) zoJP>nN}68LvLjhIw$XTtE-}S$rxseaWLc&AA`$XH3u4dt*t0dAH7Pwk)i7 z&GPa7bB!xY{8;ZWygOGD^zijN zS21DuuWAK5H3rRPMYjIbIp1!(5tG#RpTzx1weSNPoGzW)nS5rQd?s!AH0V;ZWI4XF z$GW*|i4PVscxx@*1h{w%UiS%c)*|R<@#bE6kczUl;3MG2vIu=C#=e{@CmS8c)c;~CW)x?GUMu4=n{vDtkv$-60AW4?`irhrq!Uo>2o z!p5GjHPL*AC5I&ws;G}O+8Q;))>h`{V)#_!!hBV2XRC;pZr zww_OP4xn(I5jvD!ggyrf7lEzl2Jh5l#|@10;JZV^%gRs zkeHWAWE9$oBi+>!j2Z)|y~K}VUTjNXDC~#f$E@7cTT>6RFTB{(U9ue1{q_lAs9XIC z4?9MocNHfVb>Gl_#@PO}6zk>)mGnuC^$wZ9%(rTgJH}fRE#d!M-u7G1Oo^>=lnA9K zzI*^{$%!^7M98m})T2Mb$L?H{j3ZokUTUct2E?~7`* zz-2c;@AQfVH=M#5AC&R;4|017&fEWW56OV*BM5697Ep{eAA8;TNqmoq;`kY2+lmtxo z@a`zK%dlw9RY5IF?`64TteLB=3uR})y?*F`8E>t_A`5BUw$8m(Mb7>-&ijs_tewZ- ztwQ>+K!wONV@hvPELFZo;D^?HVb2dL^c#QrY4d7x3}Dv~8tJu&^|pX3tn{%nv;gw9UKvPIPbVXAazt!-X4(pHz%5 z9vY7#>##=rPyMKYkDTR9iNEy627ezz9#+cr9d)2SveS6m)K6UEI2o zy#&s>2-%$heNinKsrriyw-)dE-5`BM6r5d73EOt{h;f$Uh^xeImDQ3l)u-M6xrptz zj^Vfb;k`;aD#O@RlqUKc=8eO^Py};FG?aob8o(3@55R6Uq@uncP?zqpZ-*J?Z!fSL z$Hebx+ye7Z?*x)UU6)YoW0TV)-W_!TTPIc`T-!S~{Chk4VTgT@@qKeR_=m-lxkvp8 zvd3m9x+f*yF}{DJ?Xbw`kSr?HZ(ql3+Eftw!%Y0gdoy#E5p2d9b~>oeZ-i}dU@4w6 zFBPNM%`wwA<)-{>^maZR);3(QyBPL1NL!{Dul^=!>v!{KP`g_lpEJV;a7j$MVv#_} zzB%G=TT6cVQQCP&5gTUxl>!RQG-XPfam1A)&ws$hA@0|TiUQ?~YAcOt@$m;8%%`HZ zl5Flx_bEn=?Wpt*Tc$GPoMJF4W3<@svEP0GJd`pkn}=6w6dZIFUo_^^sdq#VTEwL2 zZqdhD$xL0cdzRm_oz)Nf_3A@vXnq+=;jKf4;~kC=9cIgzAE4o|2o4&~?nREYC|}3x z%30)hq(Rl=j3p8=J?1nLL< z)CKF^;6IIbstz~z#uj`L3tuVNd&|+u(5KuP)ei1A^>&bl*#_GjINWiOg#_*cINX5_ zbs_rFA_X`G-Rp@l#0wOb25w$SQN9B#T3n1`brm?jIix|s$1AAlPv$P1wkDCCgsMi< zFCFOdT-~EZe-d*S?2&k6d#+Z;)-=*?%QgPJ-pwQAMCx*4)&0rmNNQ)fb1P7IyC#?2 z`Esg>=Dw}}UN2uu9aHb<6nj`N7{$(T5M210v%jL)oO}nR3=O?0Fok3qL#FR znbf_GNtl6J`c=cGc3R>M=XlOTr02CQ*VTeYh`3xM%dpj#TrtGDz}=CFdP%}YaYa%< zhkM(1Jly6JppJyczI^QLHm9dk84gPS${CZzvUvht?UdbCChQpIs^_(l z@`RQm#>lOtN9d=1U*cfQhvnT-nzr?yKLKAz(1}KA z-?m*FW*p}u&I;z_74;v!tq~>V%<`@N2@ta0dU{@7j`3kDaKFu_%H8s8#W^*?dSs(@c4v5?00OHQk-OV_FxUlpL zo;JjHKpd4HU7$o39W`Z4-b!jPwp8V4p-0}NM%?Jo_j2MhIV8H!7KH2uIQPE5H*6CH zTvmY3=H`Lvizp(2dt(M=1zTN_U1QGpaZ&AFQIWd#kJiQ=iz`vHZn?V-_g3*~NrB@p zvmN@2CLt4s-H|EB5DW3fg6EVVu1KoK!xdM5V%*@S^rGjehO?~R!XQMuIQihEg^@sI zoromEuAy={E~}zx6J3JVe&A8DTK|zNnHpVCrRwfn5+Dv)^%|}ibONPoru9}&rDAiH zQS&i%5w?P%sajLel}qK`;Ru@eR#>EZbPzv9uYPe<8m?88b%_z9;?nA|GY2I>jaYXu zSBg=vXM;tFw2e&dX6faO;p!OI&hW(dyIM;kL?sRj&RSU;qKI4w8L(p2d7{bh7YWZQX5AqUtM6e3(pC%m?q)%?}+A0*7z6*^H0~2I%(BnVmL-+b!)h; zU@fboHsEhaoIKKC)68`w>i`m$TEAoO&(J{m!)Qk2trU&zY=(mwrnmTIycXAt5 z)8ws-OvHSe*CqcUS#7P1S@WfcWsIyA_`cGcqX?sf2!d19lMP@g@9Xt5@MmPQ(lOO? z+f=ZBhUQO# zG}JYF?6`P`{DfNh~E4RziHVRrWqB8NZy=SowjN|Si0muZ~j#CywwE~lIv7&eQrRwSZ5-2pr zdt{947Enq`ZIduyx2$2JNwK&0FJP*@t2G%e*7DW<@$;fv?DraKt1I8`XBUWU-l5d6 zG;Ih}#=+I^BIn34mkFJ1Ji+UAt3uZVUtACY#JMFScAu(KijSk&b z+Y;T10*Vk*VX9du6nQ=%6dP7iY?d%W9jLGYos#6`h^b~hENne&s$WpiU;(Zi-wXWRRN9ceOodk zI|O8g?ccBU(pzmL)u<1yjn@xR(3IxF>?~qKs7P(h(u)y}3zKg65;|RFYU>GO+XPAX z22b8VUTl0b&OzYS)5yh<9C1Lunw+X~7^eyn@AtE(IPkyvrFMToOOnSxYe|+Ud0mN< z4H%`P<-*u&2jnJ4;Yj$=N50iD7kX zCmS$qfgAd%MM{%XN(lOUa6#PaIsyU7Mr=HCsz#xQBSLR-gm`sq=Z$nnwLkN>S>6f+ zKEhx%T5k?!1X!-i?TzYE3sq1;R-9-mIB0=d7_}U73l&>89~xYNoVo)D>#@7OvNI?D ztu!@GLFeMS$Fg(KVsoosRWL0(?QARFOf%h+{=Gkr< zJT%P4S%gYV=N{ub{MTcJGE$oiDh`l0|pr%FhyY2y5h z?GoeEL38;AXsoNN!sjCbG{G@sng4BHp1J^Gc%K)0z^Gl)wnzgW@j2b9K5MI^j~v(cB|)u-T12xbFYL0)rQZy{!SD& zexsu!?+_vFbs>Fcoj>F?Qtvrlj+;ljHn=WK=|}l&Tq*5Yfu+bYgGcnU5ch^yX#avYQmiKJ&LnIx%H3XBg&TDIO(m zqECI(78Zu~a9idv)vPcs2c=|-vyfoa*+26PEt(C_g*?jcxHl!TR;~JMI2F{xclJ(% zLZiIumvA}y+~;29^T^^d`VOY;`odip$}(av*1S_+P$YU|=Dwgn*5UWvyvt z^K+>CPZ_;o6_s&5-gvK2^7CgZ7=4~O9nqoT(B8_|C%zyIzaWhxe}`WnMph*FY_Uuk zDZe*cHxn(0a~WZnYt2TsceSatmc2nb@pRM?%`w0$``w7a{|FotT5&w8IrbU2rBM_s zPbHP@PURSHRKPB588vsQGQ^3GF* z6b*bgRuXI#dE_5?|1aC$K`8-q?fw^y)9763my&G8(SMSucBJdPiuhI>*0({asy7 zESb?l`}0?wcq!jL_d>VO!|E^p^KQ6GuIx^Y;8Ua1hNC8JA-$siA8qde)l|0r{ogx| zVgqzgQ4ttLK}A5i^idQ>F&+~nrsk{LyCeEGxHyO;C6j~yo z0jL%afwJAjVxT^_e2N3Ce7uG?9t2}+sGM6rQipjju

MA?%t-n;t2jQ;10ljH8wX z2Gm=N7`QxCE>LIFCI7gKHcPS#9}V%1M@qki{_ow~3TnX%5#WA@KyJiAj7q9}FJ32W z0OfcdsC|%pjZDpB7mNHed2z{V_w3@MHj?!&(Z;v<1^*)HCBkhIb3tjCHd*;Ke6tnz zad~j4H?3{?QI%?~g6j)eRJ~|zPdC3vcwu;$?D2nbD}ag$VS3nL^>thO#2U! zP6Qhh%|{_0)Xjs{@UJ*DidjwvS7~5v_2XoLwj@h6>uW!Tm>dclW{U^5xW>4m{6bKyRi7; zWMI2WB1gFI-~QcO`Oi=2?>GL>&+Y$kE$)#RWo=qIDTUcD99fD?0>P|7rS5iBP8T^r z0YRy8(uR@nRElqf3sYD{)Pe;H*r+Qu;vkLOILuJ-^jK0%;-sNhE4CgghxY07W|IZH zcc(Fe`DL^%on(9{54@rDm4)DtyGy`b&Fjbxi;wCN;lGtH@6=U!Wx@1 z2N<@N_vV#)BA!c_0Tl~xdQxVT_3*lLY*|Hdhnid@XMjy}dW4B8;PC945-&Vj+lndy zFP{B2^Jn@jty>@GMaFBlG-J-~*(!QuMQ+AKXHh*YHlO*^CHUiR5=JBj#8}(+mw$-a z0_AJ9X{$zX0I8LZO4hd?L)<^`<$DFtpI3FehM{`i)X3=!Jk{hKQvFBWF!EO&xbIaI zs$7=Zxe7Zai&q3U90JO$HWF&T^NT8BNb@Bis5T_)6ZLJj6l)bT>~7AvOzA>I&JYXN z!(w@%|Ckt!tDPIgaVyE|XwtM3Sn(I@sj<>Jjn?uSXIQE)lz28^>W=jk3_X>2N>WIVF2o%zG6 zo9iM4@8LhB>SM{dr*TGYWsWd#F)_g`1`fH)q)~!{l(u)e8iEh?%N$yqR^w7zAU9Il z)W~XTYCCf9AXYu51hY}NwQyh4{{xR!HB3uG~ewRY!Tzwqr&37ZGG5F z?$}7r$6V21t+-uF7wLJ^_WCz5PjWh40k-g5e|f(h2lPTMBwdB$4V{ z9@ra%5%edNK9+x9`^a@9o)g>#$^%kj#y#r~yh%JH4v+914_bJ1`sl;3HVAgHtkmhI zqDu|e={(-4+Kn}dHYI^v3Af^al-*3lfI}-;Sbkt|?Kg(~ig|GM$o-o%Eg(SZzH#fq z@jX-$V2`L{yzj||y$Km&nhjy>aI7@4vU=blOo->-no~||pwwa~48LA^%dv%i8&!3c zPtyKHX~|M)NfNJ5fmvw(d}R;!_{WMzHv_R;ID9Pnh6D2iRM>aY(R0XSwsr8ibMK72 zi{GSN0Ywp2vXD8C|0QVMr2@n#Ea`0{=IGWI3`eOBjkhj6olVC3ey){klcPF?IqSL4 zg^qWygq$Fo(;DFUTQg$Qw0!?9|6T9*QNG*5Kagi<2^C2ru&UC-? zw&sK3w&wddgfD5G!zoKREpIBZ{?y)#aN78c(86F|^w$c!PK%3~Q=uD&c0xV}hV~>G z;1Z_s*C9Lj;l=^=7#-^I#sPUvU$>M^)fV%>Pm;cjfOor&VUq;^YjvVAe6-`^?dy*4 z67a3n$xW%$Fq-uKvI{CohSy)^FJDvXcfXrlSzh1>CNxHM@7M47JI=Z`0m2eYp-0NP zuw=*++l`Mbvo+I{W@Y;e7HqAj%;XeL+vly?_qD&EDOaxU+_%?=GFYFcHmsrIZMxY4 z3fw8zBkD()cj@;qA7(oMO|-_ts#5~p`&yKK{V!S>-s0#1%d1{AO z!nD8rp9B(_8l=#aq%zS{Pr38yIuC|y7rrSfQW=0QqVEr+F7fWTO*C3~Bu#a^&wOwaB4)i=|8V%8+9>0t~0=2P?`j zklyf|;nrdb8P4O^smQL5`a}5a=y1^nI{glcr2W=1Trz-}rtCA;&;1WW{=K~$Q6t%U z9mrq>GE(a$mN8Y(QCZJvx5efiUdRfOX zPoNfapvbY*O>NAV6|`m>$U#)@ke8cz7FBq8 zgk_DFoh$8h?Sh_aEKk5kfnttD8yfvs!6S}tFGC<>=+HiTakR>9>7|<^I3bvqKK8@u zV*5Z@d)mn^VfwEszXiEh>>KW3ry>QGM%}n?%DXQi^p`sr4=@UV?8n#V1uFp?z*hU1 z(lCH^3L4<eUO$yi|+$3AolDNBTK&$CU1a;We`Z=iihmKRTpsN_sUNsamp<<$z0z z$}bqM4|Zg-erg+pRn{DS3p$Aen|2UGu;h^&rOV0eV7g8XwT$(q?rqLxg~$x$lv>JD z^1u}biO(xT`{Ph!0meDL1yqG(#rGJ26FsE7=9n3?3=uT0{mJr}$UJd!qbzI-2(}4$ zfzfFXm^;u@Ca219c>p@{Mi?{sOKNsn-6ibUxH9&pYM7U*57Llo7FVep@F6&bWv876 zSXs&9;x$n;!22hRCQ39;Z>4j9??A(vOt*XDmvZx`&ng)hu3z`5D_??RO)A22lKs<(#|lQdDo5r`fYi1zg4<-q8uc39Wh-V{nhr! zw&`N^VT-^d5a!za@I|`eFgmF${mM6&<#R!8gkTp!pj0oIFb{YHvt7pDyK4(?539`7 zzjcZAr#8+|FoF4orC4mPzV!!H0|4#d%hT3aW0M^M=>o^0@3CzLa6cn>^@`R)#81<4 znbunQabUYIDI(hS6k!1yusbuHT(&(jkT`P^vqZw=yT5Q6 z@Bp`|XXu?0&9M!LDAdo2TkBH*bH^jxs}}0x@~qm%65`7hM<}a(I(>Nvk<%4r-qq() z>(p)r3V@~E%~Lk7Su}*HK*!QP!!qyAjfcvej1F5pIXRTl>-wNj&VBn$4eYimEZ2);i=Og%4$&%W zZH}90ZsweWM$re&NMUq)%AF5%dk!IHDYu(iF%h1+oUG4`Zb6LDz>Dou!D{?(&M@v? zXNE|S;&3tU*G{Y~d8Br%Pr{yG(Y82RJI3n&Oub}vmd;T{VTIl}_~Q>Z!=^gs)I`05 zHn+E5%P0j?Xk%Dzt^9r!4uf?8O4#kZv8$`PJ=#DI%7g3SU{t!WH1u9@aAa;LVT@k% z+fiE|klSzd3jw&tK*Z&n`Zq-?JW3(#MDJ$wmLG!I>tMY!Mp31sr5*pJw(zCX zDnZ0~y?J7NXAYm?TSqTe_sOMq`S$WP;zr5QN!BA?4A}^2yK4Ia3yw21D^K0dt`?8+ zFLm8V6xnGc9wuYgHW ziA6=i!EJ$C#K*xq1u&5aC<@;NKeW!c@Bo)wX9o$?P-PUrkT?6UGis@~tXof4Dkl2jhbU(_Y{Nh~=Q=an(k)vX>lUtl!#RaHq%{I!UksU3iRz>6 zA84LUyUBH@Qx2w7w@t`EOQg6yIjKe!C}J;;3r7`=m-;+);g&`AwZrK{_}%zTSC@?9HlJVx?3GIOt?(cjsGuEq=4ZNi^wa8d zcb1cGRzlER;GnR_8$<=nllB?iGj+2O3ByY<*#gzsM-#?f?Vmo#**7;V^|((Ao>d#8 z*I(iPDxTyn#~GDvd6RGQHy9i;9S|BUcG1P*Zjg zdXQt8vBzv0H|TWOjuhjbG@s}^HCh%nxmm_=X-?e0KWV;eRYsK4$sQi+b#--FL1tT9 z4Yy*lm+bz*WAc_GR-vvrFy(jsY$TJ{S!u~VpGrTnpfp0QzprUI=HuTh*ZrkTf)rZf z;XfSO;aGkqbV|~r;TE66hnPUIuG;qRv}M0y=UWLwAntbhrDNPPMQ2}g%_PUJAb!Y` zJ{kM5sX0x494gVkHxPm6H-wV-vuUFkwSE;fBZ-C@l>U4-*c)(v5wvJ7eot0CcNRBm zjhZiFvDVqipB`43`Vcrft0L}?xtqOHT;kJBIDWlp%@68d_LV!@2$<y4^UqXfm4{qrYq^CwpHpXFG8YcE)|a4~VRUwO@`ip~lEkRSnO`SEW^${gqk(7FI+o!f<@BA=+4 z$nAnsGYo)z(l*MiVKP}Ffx|x_g=@Sgn>S=|0D0+`{ResZBPhE~+AAwYdvgCb$|+3? zpq%W)`R7kG0PrOb&+Y{_d?|^Iz-R&9bvAs-U;-eYn#C7fcpkr6BOE%@g+JY9#Afg4 z_9cDDd2;03LAA<{F}aeG+lh`rE-qsaj1dKsd~2XRdIPq-M{mrM4P)%AY9stVmHA&Z z#@yZ3Hi7`(zvN8N1NNy3^z8%;hg*mcfQ_m$K;B1wQ2lxRRoMEgviLaJA^;SRPhHcx z2UN3`ttd1n-$yJ_z~W5raaEUR+($%P!(eNmJP8u&?{QM+CtFtltPWr=l)r*jK?Vra zep|~8dc~H4>veaS>HRSu`d$6DqIc3>ejgOx_RU^akdYd~)!D+G6{O&4L)GoTC{kN? zr0Gb^+d$N4qJHmSKWzCDpEmDMVkF;wgi6Jv#)IJbiv2wF5NdrB<1i?&2!vrIK+$P? zh*1my+w%=%^1BMTx41akBX~cj&J^*UO>LUyTtgsJ_IMD*mx`A>4zHkotUl&DR_^O83eO z;BK_X-yVce;6bnzxw2#@v2Y?+{S)si_j~!9l)lTX_Y(Re?ccEnkHJFLC-~-c7k-u| z`aAF@k*7y!z-^O59)O}w|B~|4;*lDsEpjWT%TYNz;(nDuS z^s%9k$A}9|;Wy$vaV6uxE3pSz8f^oRC1!*TS?0N86T`z)U9dHHvFO~58Q}F#MEmas zCT^fIAL}mQS!clJf|LCr=?iUplvP!M(-ONrOM=nf-Jah_xof$G1IZ^yTFW+w3y|M7 zF0ANEsrhusudhX5lwE}YDwlm{T26w^Ve9tbwas`o83!}7L~MxR%Tcp!o#7Q)7@!ge zKr)}te@6aThi4kC^Tp@(uBeJG7j^>3M*!B+X&u@J03@4|Ste`cC2}jjvMH(ZSGk&Y zf#I7dLY^i755{r0ju-Tg$pY_4jzP@*n2?86nzHZ3S5V@wlmgK6hyyCXE#V+sNt%#g z#T7e~K~GEn4Olr?uk?^v@n4~p&~G2W0IPgE?N^`VDplQ9$*#OHvg^`?!WyrW+22eg z5AuHps{C$fW^sMt5N*}1QrT9??-g6Hma`>qtJoAH_SM!|=cw9Dk|5taMSBck{q=uf zWO&xKd?;IXbN)NW>&Hh4F-18;|;~Is*usJ4A5V^+{U@8UwU@BS1XVzIX`@U16 z@o9FEqSarT_W;0Un&VYVXA6Bcuc*<0RJ=1t9uP?z6!CBrHCaL%u^GV+`fu_U7P^LX zy@yYo?%y+0anOW=f-?wi?K~gSRHpKe4;iTX)#rkSZ0k2q?oxL6up^q+kKX<}|9IP} z4ar=g2~^~Gmom-%CN6l+3*Z)&u@zs4#ZzhjlBka)&7GgRoc{NWo_S?j&i{>=;}KXp9XuaA_I z3pK-jwckUgH%h^jmc4R%LB3ui(`O}hF7eqW`W6`878vdb!e2@6)6WbvG_P3ba6t5G z@)4=u0q6fknsTU(3PMQ9CDhre6nwWa3pR1$J!SM2fVZJ*nlI==-!dov?-i;PqWT9-t~~W$u7{2)10ab9?t(eJ9AEG z0i;r3n8|e<2z=0*X%pYfP6NQe9M`EsD$pfd!oYcWAW>-kcYea{%%~-`0C5Z7^1O576AoPmVYumQi~UxPOTM#ey0bWKC;3UwZ;;jZy?vv0={;#XChSc<{&f z^WM5szopeN9JL(#d0A%AS_y5dnnF^X2BC253^6il3QN`6JjjPGl{ncjrMA3m(bSu1 zGa*|EKX*2u90_$i@;tm*w|yRu@WXa=JTP=FA`P#!IJ0FpKc0e1`C z0GN8tb;RD&k+FLlabc{%cM)gUeMPbD*>RKja|a&0`y1*EEi?3oz;2*fQ%LV3830uA@7D5F90#N=K%QRXwJ7k?51}jc*cqNNNmt{Edl!>2Dqv(A8>e3 zRj;XbMUUd$n2eHy@CqaDYl3BXjVJ8ys4}WCph~AIS0~nXw}aySy3Gpe=dXa73Xa=9 zz0pGmiXwKHq4o0nEBNOFQW_AVRc<@|z~H9`k=Y_~rx_|+dI0nn!LdfSZ$4%R$2tWC z2W`_>G}@%Q*BpVoz_$=V&THU;Jbw0S$PTp=RKUZfGx1F$>eexAwFuHfpZ@s#$}b0S z&pm!6{Ak-u2vv8rXtU*UdlmM}&n^lwCvyu0tW=USWAiLi6uk;!`{cgH=&E0;jHhjD zM0wW?cciD^dC=%2a$A0s=2v&V?3G^JXmD=-iO4Q*-LSb~u2_Oj8A?*wQL?TAEtwr- zdfL>wnCWS;=;(plE}ld?S!mQ|OCze4+e3d4h4=c7D@yh`nJFd?MyR2WH3-A#wedFzAXHOZ}Ekc)_?RZ9^pHEKB_slL2%*j zzDXBG&iQs+kr?Nlz<_g(o-DtTV=nR`L|2@kGfZIN*6{%!&yE#-ERar&`j+_2Uu zfp$;ubVl9*Ufq>wslodJGfVUmDf{rG}9MnXq z)ka$Jyb;8~$CYKGtVTj0u44svAMUGmA_$k9eL9r;?1#B-ksN+jkY-@sK2_geKgrER zv^vIc9sDupg#b&Y?SOHeK&B)jc?k0OHU`WAcK8$C)MLrvZ!NSTc)pmW*~-gbX$u4!$g=PjU5Q=({*;@np*ms-6YuRH25lwGoP{(tNQLL4n_ z!+$3X+}?k@}XwFxCy;rbt@gnO%U>$L;Glo>c0<4S=aUuifeb8_5wfe&bc03 zW0feY|7vTyreD@xUZm30s0%-T8_Q+LaOovFzLE2HA{5-g;+uqbhpx*7`iP;1A;H{b z_)HMU{l-y7l|12a&`P##G5dS`eERV0Hu)#N60ejxU|Z-n*I~=M_1uyqrq*fgo5C z^AlwZ?XeS_6hgbw#>8O3!F}tb!6%FL`LbQr(PWHQp`QGZY%25obN0_!?yc`io;cs=azzyw)0jXh(_(gB+GQKf7&lC{s_g#cjU!026TD{gVhdix*vDt zgEix!wO5LOInD$S{)OwBt=~?xwJBwp{ zpf+Dz0^A_i9zONh3RKEGW!x3k|Av-cE=~UlF4|^R(D|FV=2bPX?WBs>fw2@B&*_N~ zpQ{2TC!srEmgBRv9_Til)$0tNS(TvwOg}%kX7m1Rbk`FNG0Opi1I*UjuC9KI&$XHc zp0+7=WIz`RI+{vy$GR>00M${)9$7SQU}A;@d!MEftrqa1?0)juvV_U5kUF^A=TUdE zKf)W=6Hma;*UPK}&_fX{qXx!YJc(0LI?cOY@F;w)0=MkLfV;1ZxXTwvNI>(BE$8gY zKkP0e2P&UfW`!<4RIk=kX1?%G*({@ZQ;&(&s*PI3w*FKhqGKjPs& z+KHFm}dSf?&YBRfay%>~(sANqGgHRuV zOTK|V;U?KZ3)7a`MIFj_*(p?r3IH4fWKemPQajsrhTAg2f36yeq?=0~^Q}3r1V@jf zyRuA5X}#$2A+g=|Jo@Ql?lWO66jd9oK3!Vj%{clOO5d~=ppz!mX6^$%a@#Q>uKShZ zZaTb-4vEAb@XikG$Xrf17cW%PU(@-vNK~Ivmh&w*Z#7M4Lnb)TJaa8B-^YDs4blO> zGKP7Ms;pC;b3ls15LZU-q1Mp3G&Fj(5!;ZqF?u{;b(j*)jhJ-LlDIwtXrkF`bg&W5 zcf&jQq|bvRUJEr}4=t*7*bgz$Ev7Opo=e(MqhA9 zbDyC8?GKlAgY1Gro84#%I$<0!WJ~#f+psQZ7Dv}ykJwBtd*v`g*p~OB2lai8_vOE> z=i9W=>qu2wO=VeN@r1_A`nBXCdI7B$NMEvBms6y*Q_??a&{9}kN zbXJ`ig?Yiam{~p^5rMrs0}eT)vWm)4!doEjyf%TmPe)=?5X~?qHn-}z_&-2prYcANl5SS)Q%h3flyb4t&@>K*-J~*iq3mKx3ZOIJ=y_`nr`hQl7ysBgR-qE&AhdM zOHFDWG;ghO#zaKo^Z+iWwtsCV+lk7V%xju_L*3T5ZCQaQ4C)wqMRfe*k)6^39D!*+ zxE32&KOsjL^CRDuEHEmw>APb$2m^7R@OhY4Pkp5u7iZFQP~BSAE4%Exo{4ME{4-^WSU4qa(T%nSG_XQaHWqcU)TjE&Lnc&)z?Z_%}G z2QQ_Hm^d3xc*#w8_01?)1T|O^2QlXj$T@*J!<#Rq$?--Dn<>Tf)~_xFb!WMQkkhNH z$B@!h+hR{ldJFT#t41=dW0iF(h_?t?{ti{*%d4wz#jRo*pTbeyj%%~e74tr>g_H^p z5t1Es<+_90X6xDv(;$AWk;Nx>hE7jR=;;ox?@z0Dq--S0__)=Ejs8yF50 z)_uKO&|KFfDZFn*gl7dA8CIiQX*;@QK6BNu7nk0fj&|=$&^%ne+^wcL^LNMNElHlI z8hzK4faVuV)MG87Z6PdbY)hq`yd%mGyLV zr=x?UHDwK4ygtc79iY|(SV;kDsq%IX$r(>=kI%Oqj4s73dsdG}?i{^V6a0L+Sr2Jk zWiyD;LbDKg9BZfw<7pDGWw3s=_*O)ZV5VvKcP#XCN{R)i_$wAB3+|+XUN+ry!n@|aSy9xKh*)a z^TE3&ZW_Bgc#U6_Fuq2xwQAA2CPj#?^irwdpu6Bw49-=i;PQ(b#XC2~3&&#G+HVYu z9c(@`#@XNUI>}nP7OZMNL-hW8w3BoIICRhj@pRE4O!s`bwWVaacu_tOA-r# zmrsZ%&Q}~154$#pS@7e+HehwD){n?F?2D?H2u!7<^;ENcG;<98sce5NUo(7b; zMwRdtB{>Xk4@OMCT)7S?;TRW+ZZ390V!!i6#>JBX*T37^imHNU=bfWV8BkH8b@-+w zQ!kH#*>BYsEHblk;txEWb7848+kLVK)?Z~711))U)EM}X_5J-rHVb@9VkP)XUDIf} z1sAuu5PrU0thTt+s+LQCrP6j+FFI~v6*f1l1Vsg^qdJ4DAjEVN0j`HtQErD!UNQO6 z&b3F!0<(%+9NcaBE~hL8i%%y$T&i5Dnmld1geNvisjV~phL`Kx6^6Jbt4why*4F(q z;UL2*($@Kwuh~`sd|ULkWQd^ zi>uDu{-ewKkG{~q2@Uz5cD&cS%23miRQD?CQ%3Ax5dQz^f(>#D#T^k<>;Q@r0idM+ z+^PE~Mx1pNU$N~me#QOLh_)ooVHGRvhwDae;#NJjjyVv6pgR&-u4e{4F0EI5nr`fT zqlk_~MQ8*k*vhE&7<1Hb#2r~_10j~qrj<-6QqIb~)U`1jIswdFhqIfq#n_A7>xK|Z zk3N`NYj)F1SjPJfGJdhkb4YemYVPon4v=VAMAy)-@tPA?P{n9PjFBDRZ@8eCb17DB zjqQWO$O)A#72hqTH2PQ^EG|3Buz45_g0h zdvg`9O_0!$L?+>6@nU{GCz$M>IqPmica2o5yr~IYilz5^)%-)Fa8It#y5n=CMZE5> zm*{LI#IHNRX~AAVUhzYJ6>h*?CSae+Rn{@)mky<$p?VAToN-DMu=V0~ zn(b~;aZpf&^o9QD{*IhfL1@2dy{*|%QS61FPPsO};nJKOH&T}f^gP(CHJqToV+QQ;P*O{`ASLz^lRxT$)f^gLgwtA1rM({hq!ZsF%X zh$nHZuP$}V+Si&Wty*o=$GH@JZdgf@VDI>Cs;_j(h8Y_BDp9G^o99zBOJU5N&6Sm+ z-JMNZFpwP(=N?85-egD^{B-+O{dU{9BTH#xdxOHHP};~deMJofc|32!!{C#UkegzD zQdC* zr64N?bE^LKWBBqmAca=x#rVYnG&kdTfWZXv|D??X`M0)Sa&h3UjFb#r-YHHdMes*= zdBf|6R5lmWTw)=2HK$vLG*Llm&6wHw)tftBw6ixr3!U-t{qcah@=#504vYey?OQTC zMS8J``G|^#+&QB+A8y4+B?h?CALq;iDFBqBmy=gie8_a0FV;y7_1^9`zK-6v9G{am zk8TWj9!s4ed2jD3ct(>9=@Ziot6*GdF1m7QG2o<Y(|?^oB;KFiCGS*}_;^03}zvb_dO_bup?cA|<5ACq2{8xrh}xW9fNBbM}T z4iVCNbbgjzkrxA{5koU-#p~ahN4~qk**Bu_N@Q;0x=MlU#9S9oLcQM)yb~*aTq|$< zumNDGH{K#ed4CY)+NbW15=+mfv6K6S3Ypfq(0GBN#Xdw-*W?mkbo2aF<}N#}!ju}b z_18oE(ccp*%!v){W(f0V2-*gS5JnkgVB%((V%^!Cp}_*F=Z;`vIvC}sht3!kyXxC< z7p;xhx$OH^sdH?ybF6zy&wQ$=)v0`R|9o;tqNgUhwq!Ibir-*40bZM;M_Ml?e{HXP z9hSRTt@(W8JuHI=m zT1y_jI&#StIsSqux@iZYbrn42GX8p=@krqEo}BStnXUi21^lPR@IU?xI)nE_u`zbE znrjm~`|ltnUzn-klcLf0wSoduRFH1j5TMR0#JPehD4W9T!StT55Jk_Of*`?=sEns% zAzlJ1j(8m@3d#qy*j{FN+iWc=s)ij;g6Vn~Al-)f`#(jRa=XLZ{Uo|e-2dnc)E{2BJ!5RAcXQ^N-OdH~zS7-Gy2)r} zIl+$WLjLgjp{D-QYk59;LUFQOPJ>vRyE`ua25q;3x-8qjSVpJBR7vG2pB`&h*8jS` z#H6&fHS92fgleo!npy*Y(C#$3A;jkN9r~(Z7;>FDOPfRjq3MFbDcTJ?)?`!Awy~P! z5#Fg~!~OfFs;R0m264Z^%5?!D_1o}I;R`6+*X!P|V}>FtL}aVpD2>Q$rh*-PqA#aD zn)g0Wd%#+2UF=+d%Al!z+h(fbU9vO>MjBsPq)(53=F~fvD-cg~DHs;=wkS)rnm5?< ze9)5Ul4SHQ_s{v3niJWU^y1r|;os5vdnO~1 z@kL3SdMYiypM{mTsE7~i1e04cbCRX~h$m5!{0t5J;Gg#bm+S*@n z4kSEP@BL!Nj1L(gms_-7i-+v-vtIw_#5nlRH-e4HzPi>fsg2upLyo%EtKt$&?|0lM zZU-4pr-MVnp@s-U1jrCUiH<>?m0l0{P=gH6b&**_ogpqd#O;lDPFOQNTK5s&JC~wu zc>lIOsV8qoiOmnnx)=Bw5hI>_vbE2kj`s26V&k2a3jNdV6{{enU-^uder+OB`fiS8 z%3n7yUV0BcllqzG^D7#^zhn(wV(aW@`0DvMe;_MF3f?d~(2~gMr}GV*(?Wli8t>X( zv5)Q3N7bY!^%LH5vjv}28e_7sG1J&!d&CavpOqbD<8ub(-d-VIsF>TZmy6#t%DFot z3TQi`^gLMi7Gi#yhGzz8>5Z6W>}c)jqeWeVgp?oY%(J@Yp|!`Siy1A>(U^1n&*$lY zE}Wzyt(vU%4I`Pc>*e?gU{R}1QlOvhe>SKDS$~5xqSjfO-i!x3u6et``R-oYwFRnE zB>5FrebC>;w}PjB_Uh@of0FtUXM)q1=p6eq30ktB-yrhh(>Q0SQwfI~rDvzifBh-u6EO zyyQM-;BN4{)ypS*UW|2@@MZ9gEMCcX)wQ`8PI)_~1L;|ogpE%X8}dE|^BD5(r4IKe zj@56s!WNz1DZHLaa_0O|sPNef3z(C!XSPz+`!cQ;l-Yi#Q&;u(d+iPdr*Ea{jf$M# zkdzoYiF|gLhY`xV13xxR>kl4zUH|mD&l@9zu8NsJf1j%V&m7Ob9&SXg8mw|xPPBsH5^N$$$Amru8cmw9{n~$Qo2q%Wls@_7=pZ>nn+9tt}$!!b?LEHzm* zqnld~H4D&-!&qCCI}SYEDpp5IH)$6F2>-@oy!tWw;zhpF+(+5E`+4LbF__9vpv!0G zYz>2QdH%8ce7);Eyk&bT^U}zh$!pI!hfNV0yDUE-YoaT+CT9_yXyl=l2cg%Ker_v( zMRsy6DIF2q;2V3#=l#O%GiS|B`Pl>iW??ytkB@t6#aIn@RmmFHXm_uudqJ`&>|0lG zol7ojM8;4~)^Y4vC&3x~1QF=NS(tGCgQ>PQG+WvBTX*q$ukqi`dWv&>mNZC#kAYo- z{@PRi@4V=wuI$BBk8q$Q8-L!M>p1eZyr%?MsrE;g_0JctN9ZQiwVtGoc{_RGH(eWg z|MKsDtC*SGn%v0>@ZWo=A6_-E>c-F3)V#|Vt#0kz@;}=@Hd}YcoD*Agm(*Q`O9Wle z?XyhH4w-79X|Xf1vnTYpOc?fka7*B~obed#WH>e)8Xx#(X3GgX)>XI8-k^F-SCDeW zcuRMuU2szMqVo5(Z>2c4%3ZD>c;=KIkbN2+wXZ+BxnA_J()~oE zv3KJpJo=VC$QVp0R(w_`aTe zUlB^br}RK>W;B zL431z0L+~~XItdKeTMhGO*W2}w2J2&xLNZH$8-o6>a>ES z^<`Znh4ug`6+gR{%vh0qh1jW^Vpc8ceGR!Yhw|tbbIWkHgW}<74~1^uQ+ptkIp%B2 zG+v&nb6JN(pbmJSe7IzX&%}oBSBx_bEysjEOVG#9ajB?i>AOwjyXM04rsHcCR?5@d z=2`WzWMYU)!F@ORSX|0d&^wMdBE8+{dqhnK25A3SUDlF9wZf+--vh){;?WGfm-k^+ z&PzEoTbqM5k5(}oo4nk20L3Exjqo&{G=%#P;|4e9omEZ?hEarKowh#K_euS-oE+{h ze@?;oxWRStej(mt&>kbmip1(QK7M6yKa&o}FrRO78lO=*%RM&VW5W22x!GCxfELuG z#3aILMlVMXkLGr1>((8S;!C{cx0Uw!rDyl>zQO+9H{{}%VlFmEEQXp+RsK(Z7TI>y ztc-6b?-r0=ghM6;hX4O(qCazy9>O}LaF*4s@%{4!L`$=%zcd{E=T-l7`2s%BYY+`N z7;wMDZB)JX|F(!rp+i72>$y4KMC(V+H{!#IpL~U=vx;-&T5X<%YWAGvnf7V08kptf zfcCJ!|7Id}!BtE#E;m@(4YAytuemo*byY!jBmb*of%6w#0kIZ8@2uB$+4o(2Si?hp zQS=urQ)Jx5;{VVxHODAEhlv@n&fpJmK-UQ?Lq7_c8i15EmWNTNN_UQiZv_mifaTIs zbOaY1Uu>n>!d#Kv0X~j$St%6f%X=M)C>@9}VmrsZ3!#CWsxv3pK7buiV^roW`h*G@lqzj}vTe z+?H=YZ*t4=Po;3P$H9Z}d!903aEw#E7 zsr}MK&I$3b=~aLHCPJQWs}`lFEfO%{B4a}D2P7}gel{5ZcSp_@n!c;bgkt9}dnrDR zXe?On)PTQd%Uc6lpJku-#|naGVkERv-G1UdY_IkJh_2evnFB(H=DRe$$sj+5hfYRF z(7NGwte9Ov_msrEw1Hvmx&KorLJS8O@=Pjx(9=^U87-d)2IY{1+#%(9fXLJciR|dBG zt!6=s0a`yPN7eOPG?(s>H1AA~{t?ThgQ@ik(Cc#zma9(pfOzDas$xD{hZKRpq8k&0 zfuWwaYXg&O#}e#TplxO?zloh-J8TZ7f}Toni;H~*W}xM{=A ztjPU^#RLbQbw~qu>C>W4i&>*W0@Msa0+c=p8KQ*}#8mNzO5+LZXGjYSuBD6fRL%dQHn|Qe*dD8cjho1N1hrh8=X(!v3mj+L7fy}@ZFKe-)a~O$oIjVz*k7z`7fx0 zBy&K*n&5Apu}z;Dmd{y0Pcuk>SYwf|=|ZViy>*H4CvZJ!0{-$v8C7?FZ8+$w8Ht0d zR;T$9)(oER1aGBShC_!|{6x2BycvYPKzwxc@?#@_NhMunM}pbVlelN=xZCe!=CB>plpb%dWfGH-F6(@J(e@UF#y z%sjnhhfiWwud1fzlWjzFXe8<_7PjaSpKF+FA6ViyL06W~^2Cv|&;orRAq+-7f7r>t ztNrU0MYXgJnTF&by!w*YF!zhiqi@LxTf)wP-lE{S3CYr>QRz)5Oa=BpN(xa6EPYnV ztUg**RW8RMr5~l6U*gJnpoi)mJZxTm9>`bt$yI^K{5@Zx#z_a={Pk<~96vTs%qm38 z9

;=qqC$_xBy7!;-cAWLBFff`r}dSpnS+nj z)(l}ggerTIur>5_kmucO^JvTFXw%{Ik@68He8h`Dx?NpQGJIY5Lqu}p`}8ARWBq;c zg#RH*yi?7~UU&SG_teHO|1HG)$2Jo`cu%&53!o)F{sWx+-%U10aVzVOUjqF6KgGLC zzro!LJn*0XYpDEh$HBF;2YwL-zx@RQ{wE~;PlxEwqio$Fz`KHu5}43d66xqTfy0Ev zNE%E^!Rb&~cU(hpw4#ZBGfeYNsD7==qey$fDL(Y2R)uJ9_e!*{kbDibHkoCCH2{;l zG}bJz`U=>4VKcv%*eN`6kW?yF4eS^hmNcl60~eB#fD=@`)0+?7oxa$s{HG}Re+IPw zKl`+)83uikxwx2wVuwl)Fe0dJ5S=xHmA@~p>s}^7k_5oMTW$44PK`ae z(5%JsLw<+|gUp(<^Sg{fJ-e`Dpk(dF4e1nP`pm$(NrUrzM&ROf)E zIbu}&6?_TBS}yPYIW>@D6u4q~2&4cyP**;%c`>>@O+<;}v}y~#>vK!m7*ZD1UBW7v zl`_pm&#UJEYVTgY1Q;I0VrSOD4@)!yR4$?s=Z93u0gmUFVZfhPZBa?|s0qamx1qkV z0_nP!q=q%1K4E6t+ZH%~KqA+oC~jAezc;({8fDN&>tupw@gh@h#$77y`5mtv3%~}xXk*vjV&krM3za?J4iG4Leqo4^VT&K5SsgLuF|^ri4R%;75>uQ z?jNx~7n3vteq;SABCEw?S(d-DA~~kpNUKq3CA=Tw2#!6KM4tF&`1|<0bkjy0uyw$TNC{5%FvZ8QL%0Vvn)QQ0GUKM zw>VbZ5apZc@nQY3 za}tyjTHeeDnS@loqYjb|k~4dNj=qu6%QF=b&b(h3&b)ncnO4`#ZkgSxxst{&lw}{J zvUqw-djl}0-R#`(5RY#2!;QIXRSsu9rnoM0myyh7H65@@W$-AP+M24Lr6Cpyq(!xu z-{?U5s&2p5#&07DJt*IXh`kJ(;jWNK*rH{;{tSZ4tzTQit^c{-;VLalvG$^R@exG) z%vW37j9AKPim9lK)e@KOJV(;rlsi!oL&&6GbuFxJ%Au%6L4nod`}jSr8_rgB5=RWm zl^o6_3Lh{>r;=5|Db;$rWm@GyYmZC>Moyc5&>t0YD%QB)a>MGFo1aJ#?ITpx-?g|? zJIVg^f(Z*?vB^0sybE>zeu>EZS-HRoU%?j9I^SXh?wwmG_BFuZ@K$igqEzOZRBTeZ z`mMzI_N@H#Wzq)1^aEpOy{yM6?Fk84OOcv^^0q85lgJrRyRWgm)RKKVtd&&+OwaDI zcQ_Dtn)Fre2I^kwX24K`977$U+y+K&fF0pyWWu>yTta+uy5PAo zdm8Gk(D0< zf=!}su)vmWYc=q9-H)Q?9|f=!1F@A7u{Rhu98?m$PKvm#t#s-p)t|nJ=;c^yrtJSH z%%`jr=eRI!eZdgn*p}=F73>~gbuV(c*ID{}7CM*mE^CiRBka3pxjY+5V5}i95*v)I zj?2sCNWW}U61Bg+mbqm0hXnF}pg#RSKo|a>Z%sZ9cn66wF=24ld z_d@@aF9$Z=N>jcJ^J>$G&98TXMOuo&^IqPX?OHw{4VeQctLvms-F{rL`gW7wxTac1 z*5p3$#oe?)VQm>IzreE}wtXP@td$date564S8Tzg!pI54e!Kku`a4m=!6@yPM)gu6NNa!2pz2(sS#kcmwA? zpiX=UcBirEk(23#E`_A9Uh9%sJoOwDRuF|amCqXaL(a(j}r0l{ew*HWK}-g;42 zXH}>XyqR1V^w4iT`-%Q6V)59zAmtX)R9aiFb2YC#&M3RB2qHTY(D^!rIiliE+V2VX3T$K6CDjd$yEbUaYcK1*45UYdaphG(2l9Bn~*qE za?Y0~6i`j3ROKGdF-hi;_4LTeME9p195~vbNNYfN?ybNFUy62zBQfbTk!aCQsx;-I z!={kB4l7jFT|T*rUPM0Xf^|ySygOffG!{v?SV_BNbobb;&esfprL6yizbkx(s+Pl9 z8!_;J#krnZ2t%1(^Y)D?mWVx}_@NkLeE+c4T!W4BnWM=+uaLm*VRy^QMT*beJ&S%B zwwcDr*yp4F&|@eq&i|0vNRXIuN$wU~%b_nHDz|4ZCnt};U(=&&?h~8op`xuETFnh( zrTJHAl~JMa=~AA^i;E?(K(nj} zKF0Vv(crbq2>ZJMN@b+vu~ShFVSnO?fihY#UAm_0*f#=M#ijCEGHHwi2N62Pt zyx%&k&&dy(L%;+aRQ_n?kLI%;~SGh4ywwq?R9o|+vhJZy>-m40DV6Be&>tP#Wb;^NTAo|M3@MA5m0j!eN=Cx@+eS=0pIdKean-JF{Q zSPfG8>*=p)kz2_C)i?8ynq}qh`VyHd$~krZC@tUe3Yxe+BxQM+Fz48OjJOxkprah& zNz9!}f}2~_vhIwAtA>kpb4e$q?Qsm68I`}R+zz#%nV2jQOfR4Fkln8^$@ks6Zt%26 zhgi$xq71%=p$q%%AMES~JEs&gXUhhgoqBC<+MH+afChWRP2j&$yQJulT8nDJp#lDU zSbNJDgx&9&nn}(Vns4i${Tq$UH~ok*`FaL7p0}0C*J&Tb_jl3%3;R>i&;5S!Q2$4n zO^TUsT)4`UD?Z!jR~yy-VUJSQNUej*T;F!{g@diS*V1y`*!KDBk+&7te?OGB92L-W zKgTRvg=PJFCC_kP%AICAogpR}qZXY}AdN&maTC_>Le)2rXcJ5PYGnzZ&DesX z)xFXg*p9BHONDs(V5pqBKt zCrJZ&`^f#m*|zGwo1cL`176jkk)~=n-b`2 z5`DPZd?;c9+$)ej~^yvQax!wFyUZtF*Ga<}}{49U$;`m6Ca&0Nd zgmU96IR4jj83g}pW=9s9m3fK)24lig3uoRPng{~LhBpY%C8fldE2xvj%y#Quov-<( z&rF8AjhW*DBzd2x!xerP0WHCcz!A88Yd8@}>N`wm7xw*DLNA=my__`R4?z+3&|rA;Bi*Zo;O>N?ukCbJ6B`8lnw7R#u^$> z*KVsRV9E_g@4+zXE}n6PZP*gv48gD&dIuhw>6!mhMviP9kTWc!cttlnNGf}L#?-?;N zP~9or$lB1LV}N`4v>F)kCMaNDa%FRtFvIW(D%RKVTbg(y__?KgqVrv|?pPq~#7dae z6Y13JR$==Vg=3%3+z)7tOPl+phD7iC1vK5z(-UhQl)jkjqps80sj?3zoWwCcqCcL$ zl8wJ<+38<|DwMk5+fbo61iA=^1*d!KheMQ&63}{G3Bb*wMX7acP0(PpEET9r^ZXE) zF#xRn`06;~6ev}mufoI@p0h1F_f`8-fX(15vC6V$|L7R^e(~A^MRr{a8|sDmRMpOm zwA)Lsc_i7Wd+ZMC9+GBj4PX^IRpA_e1I+delw;Ovbi|4^Xf|M}*kfixg&Vz+ZW_w( zdz7EQPx}I0`hYRr?C#neuB6sgZ6V2W8>#7$k#Mpuy%J>9Uou;S73RPs$?p@-i6WEJ zD{er-j|qouW92r|8Jg1kDDJ{D&tqyZ%hM2+D;4VYQhaRrOM75@DOM7sp$ldU)(0pF z`9dS~J+D`96Me@oB31m=M;wLb&*!ZXKlvW<6AXUVt&z3F#e)H9UJYuNnfD!coDk!* zu}JsITYB7~Mw0H^K>9U3Ri9h$jem&ZSAJ}-L?j{Cf7`lkpUfGbA1J_bquVD#| z29!;Q+Gp$=xfC$k^})&+{d{`OFKsdc+$x059QHXafC@Y^wYmtFkhWOy>-fM3S+I<* z?+mCNBfLAk$8HI+nMEs+=MUjk=TR=sYd%4GGGw%XRw8dcki+-WV`R9M2HA%FI@%!O8T9;JN+p^VhvT* ztLNr9w$sH@d}J&sGAc0P_Vd$oL2XroQ2^zm-j{p!@&d%?-e}0;iQ?QrOLu-^yhyGv z#~bvC^H3ZtSXDvh{virgEgfU|hT@zrHgA=a-iqb+J&AWXh&)0*6$#qAhsFsC<)G$l zyS5z!j}STleC-;^u$uRKIa(F|k*-7cE_A>#jJj}4?h%zgECK#^1fKt4uMfJQ+8jGl zGJDjGd!m+AYq5K*xO$tkMj%>}ndxg24v)!R1}aJ}QJx4VZ3~-_Eqj!XKE$gg>~%T% z!4~T#Y{EnW2%ZG|bm6@UVh)##x(p;)Obep;%Gj?nVBY zXRbvSg*inQkv)AXsyf7!{>|N_Rr#T{C}1#qfJHfbN)j9-XM{P;IroOPGqA#5Xi_wF zZ8f3zpBMHis9s0U1sqq64z(BM$s#(B;r0Js<@;K`@AZE?Gu1tJsc`mK3K0n!@w8t5 zM7~4r>T;`whw9D&J>5Sq5PwP8obZ$L)gV}I`sfK`lnA%fx2HX_2ZkRj#Ec_i)Y%q< zKW>z-@I3q7kY?^j8JULrH7+G`%KW;&Gb{}QnBO}?H+>j0-##+qbmxGt{#Iq~y;qs{ zP467o$S@p+EFz8plCb$CD3P9SbUiXaNyJ-QDLc7Ug9~(il7YKu9%0rgQq`5;Yuou(0?Z zO87>-qh8%V+!Cf_4onPb4E}=dU=uzRfbeq8#)=rxsED? z?Je)IROsE)UH;(O!3)^xvq8GO*;9R|Wkq=7W7M7}6*Zl!a~2ZcT?Eitww!tRI6{84 zXnUe!<0@tIIw)omO35e`oHcbW8VvMZL6IH2jpZ=9Ipw#?@^x+`nbKv4tl5E=4ZrZO zbY#+aCg9 zWdV;aGPk@r0pNH*l3i}fy2?QU(3d9Tq4Kk)VjXVE6z@!8woF9xt)p=SJC-x*!;E#Rv=QrVt=7vQb)!wbwx zD-~#Y&t~LXIGmcbCxgUZSbU~&&*3RK(<9Y+V!34drl~xF6-TvihJu4ss|0&Oli#70DM9)#gVsSZe@n@nQ z7%}yAVx554Agu3xtuQb^`g_z~7#`g|_^kB#yVf?d=}}!XdH=fg1>#cb{zGqS8A87B zEd6rf$5MZ){5cwQ5>&yBI1_aIQ_Vohr;_}Nr#nw=uf=XR<-Z?$v{!C4A4RH>SlAtA z%!NTYg6rZ267*})?4AR^Rm4lP?($pOPEcGug-B1%q+VLhM4BG42Gvz;3C?onV=l;}Wl@vV!i8y#mC#)U zOQ!Dy6F*BPx>DL|#5`lETdJB8P#y?({8=#}QmvZeFLRQ33lh_i`Teq`V=1`{@|7jt za=SX>AbFgaHxoAwzPK}9=9BwO{_PBlA^1!Zrj)GK)6{&UJBf1RABp}9SY{mZZW9%~ zVwpz99?3zDHt=zB=iJ=3z6(BW{~D6Q#r!V#bpA-Ki{dCyr^pI7r#ua z9-TbfvW_z~ChuiM2N5y8J#Vud&DSou<@j8Tj{TnS1;b&ChU9j?v7Be4c|D3$xIan)TH#g4a9io~=`V@#7e?ThHBvCPyc z>yi4NHZei5%_&qC%AO&Co&qSx)q-)<#8H~dH}AgsEBv00%#8D*dnvcn5BhvbGV+*i zPeuIjH%*Bn-N110rKOXNADOrOO?zp5?g{^^1%nFHFoy!^>31beIfWfPp*2uYS%xlb& z#xRX;u2=R}je(TqTHzk3EBbJ7z0vVWA3IQ{v|opOMMS+Sw!*pT1vu5#0r%u#Oz{h* zef?5Fo~cbGu_Q^sqj9YByb|;;Q?szCXDKD)uSMrSyxsuZE|4&j(sA@*9rgDFxB@x# ze5_HO;?YyK3uu9Qf4_ZMrQHReg<8I9y!!>7xYP zQZHkZ%R+76YZFuNUQ?xW&BC(I>}%IULND~pYEKIZDR!YTA65AB-oIV2{Y|?$%4)kY za(2xfNRF-}Dv}^m&LoGFmP%J+W(@7SBe2TK%MW`2aoX^23^ePyX$>A7ZQY257o{<( z-|}3V#7b9~l+~4dhAL%_B15wx5Up60m$A2;)&+IP{3{dc zxf4IqjE-D970GT#5ed-%iM+i_$$E^h_P#g%eR=(;A2@qvCo<^a%NtkPG^|-0{F;g$ zbFBj*`q+ggPYN}C_}bPK|LDXmSbr45z6)?*50jN&TB4Rz@{9Rqa#Z(`1=~QrkEdX^ z(J}kXxm};`%!Q`xu4X$JtcXXE3;$?_;)>mj;K>kjTov5eyS&la`HJ2AIBe|Gi#w$! z9k<^8o*aDg=j5RIWmy0R#OwncYX;pPnN>P_X*40NKzIOF>y7)yd6|;}ou2NMS#@JTDYK$3bFtIr#<&IbOuPw)kyy zZu_?4qzsc`V=aCzBoOrYCda}{>0gSPgQH}?W8nLy>^Zuw^w459zC zEa9g9OaxvX$>(*SMkje=%}u+^>ER7~{(CwTD9QKCCU?4H+#S7oaNUva-gC$Dwn!qt z+2pZJ&X3KlC<5_dU5Y6b%&E7?)pBw-NQry9?m=DsF{UU*C4u%c8lg2i`WO~??em=L zGBzrtAeMW0tNpNPitd)0U~7lzVVkFVz?{;Jz=zyvE#G@u%<%V(8ObzZK7udq(Efum z_U99kzaC#x?{Izi?#uo2s=%A#tetWj=nVOCVDYLQOL)xbY{9OE@f?F-g~pfF&0p6m z6OOd>Vi}FzS9zS+#1&Wn@=qw+-)p|7z7k^Jck`^Bh;8983jAsJCZ>?=Ks~;(CO0f; z6cIP}wIa3&g9++kLoVnXo}F>y)m<-ZPo@8smmmofGrpC93%Nm?5*KxwCPez__eL>h z`5NK!g;WMtks4=d$cP~26YF$TjiY0gfeh(bB>CgTZV!(YIgTPuc+wcp#tM`B;HtDFzqZ*x{A z8L+1&)k+gTM*oaW&z^ejov)9oR}LuUFQOML!T)gc)sYlXZ`F-{o>V*2FHSuw`Ke{1 zR=bCiQAPAm+NLWcSDen<{|a+T%Cjz_k^94D8X=AXUL28hg%#5Sl&VtQECK^ag!*oa ztsFyQh$Ew8YH*o4#Yw}t*6QHu4kc%hm1&g86;$$IEK1yp_Z0f$kE;0b`z0J-XFD95 zAy%sy)DrVM`<_eKbicqu_I=M}!0Z6i(!lCvm^Zz@jW;kqO)0%%XlL`*zV{L?Jq>3- zk!u7EGe*5{yM8mE_D$dy_6F2&nuWSiH`;U@0)8QxZsd;01}-&j&8)$v>Tw`!>g>}U zR%D+D&2_q#M_sQ^`z+plyHF9mbKV;DgpLQ`ceP}8$AheZ@up)SHv_0S_x1g?8j2a` z0O_obIQ`ZAya;?9kq5HcYL?j?xYL~102C;=cyjhiH)Q~wBR?gM)beO*@bh&_C5L5M z_hU+MdRcQNVvcc_Zfx@z4EbE%<_5sB@w;5BLUMFR&MQt@L<2b-`++H-w%xTQd-Su|*6`Exqgvs&BUuJdKN!#A}=E))H$ z=8VtL)matPon9IGHAnwk(SqgdV;4m|IQ{)XB0rWINsx^ndsQ`fGM~NRE>@u3w0%5O z8YASpdWzM$0LI;IwJol7>c&)tqtkDi=RQqai`k9eH>?@&E(W>7eEVE{4K|ezPtleAC$$p64@tu9{#N-Mh4OHPw$z z|2wEKD({xbD`bg~8220}Kz?34L6To^Vqap75U|JXYu z;{6IZ=Ts3Fj6Ic48To*HVOX{fbG2dXey3A)$&~UQFR$iSP2C6|=kUzZ>cpc7 za7M@GhvlO7)iKe@Y#l_~ZECQV&(~C+=v5qYS!q3pZ+7`yLHaA|a z%Ut19LKDtMc-9Jd-niewQ^}$N!-jz0nw7_V;i`fC1}NQ@u%?x^$q{%YTW38n^FRgj z_{(~p-^wx2YZG(k(KfEt3=Rm~I@@77s~}Ur_tWXOM$k_OaX|%5_KEC8>?ffp!dExs z9i>y?fL8MdF=k3n#cdw47mVbjtUUkpg=gy6nk?2NQ(ml5%r*h2wVoFGEhI^U`41}t zs9Q=5Fuo%Lp`R)kDY?EH zq>LhhA{8vR&6ZTp55=E^dgx#p6ofbBD>6NzvfF~BB**rz{$3(GmA0{S&NKe~KMH0w zJ$;r6tW5YHXYH-pKOThaeHpr4ErlG-_$ssbd#dr@+p_-3r2D^iiMBdlGgTia$@#+Q zv#5i8pUNAWvWt6tq#l2C!;mXj>~?=kYjd=X(59+AG(JtFY=M#TaQUe79)RKp5yi`_3nm!2|h_ zn`%F~q+L)(QWeZSjwJa`Hi)G|kmdv3H(#AcO82-#xFyfA;iQmh#-wPEo>7oWYJr}hD3V}FEmk|WybAxF+6tL=7)2y$~-Sr#qIPjpW ze(Mq$0*}peE>d*f(LufBBVKx^Bfmu*uyaSP83C2Ln{2XS+;NmH3)jAGxk?^*=XjlH zX{QM?{dO?GgB90{l-jK|t_{3bC} z{?pPL`+8UXlf8Mf85!r!h4+CopvtN4@15Ve^?}sJZzpx<&B+YqDz-Wb)d^z{4sTGM zZX`}$656g^+Y?P#+lrV&rDB(Du4lK0EfuWn;JSP+5Dc!%p4GL#iB zVz!-HT^;~#E#+$|r=CS58_RR@p)U#KXKE>#**BI~Ooao0lN=^2Ct5Fnc=!Ee(C#Sb zacQ?2x9h0O`>&U1TI5?`(5w5ebw}uLIEv*n2q;zC`Z#C|_Yvu=4Ljl~AKDw^CWW_G zno_cdOycy9jPA4B1#iFSj#+rZ#%wS?dJOul4f^dJbT)gdN+`eCHSSO<;~d7hu$Lxq2@t}(wFGB6A;C)3^!dlm5QZvhV53I+!I@vaNTzORySnegpG5^Qm1u> z(Ia!amj-0MW7@tB-0wSjEpL<~uhn!^Q_V?A&Er25Xb?U;WhU`P7~gjR>fp~As_5tY zTG%LAIMg?(-}fDKa=+lu>^k5v?)IlngHsulq_Tj*CdcPBjFGuMp6_)J?F{7GN+kR( zj6l3e!&ZW}dh)jS5?npOW_{CG_oM8L;^vU*ri@}gPa}B-MEnf8dSv*|>^gX{vlae1 zzBI2m&5*Tz*!1G}R%LrC?JlAk=tya+*^YrJ<*1B3P3Wg4(|jxvEYYVjB@3I4JpM2( zI}_6HCX^?Ow(Vs;+G@U$!6BP-q)#+v~!L5OIYJzuJv_LOIzmyc1p)d7b{P4<>j>MJr_9jIs{I=ekdRSFZNh(CM4lYi)PMmv`^R*^z|(*s8Vp+CjtV{q8X%s*7zQ4r~$*D8GPVbGu|gbe%yyK zyLzaL)CDb5)0{8UrYf4(+q$b|)=T*#E^&Roan>x@&*Y7IXi?AEbv9hH>#SMY>>qT! zWAGf0zAH3nrHFv{$eO52$xgGFj(!<;( z_u{#JF#E`qm8_TW=B+*ghKsjX8PMN_eB(*3W)^x@Y}^mpAv8$GoAshFMJy&ca%cl0;sc zPc3^f5Xmnl#rrJGmd9jnH#rDOFaoF7h7ajXRQnz@yLpwHmb2gXs}fdS&!&HDNAd36 z9>tzHwW~ieLMP~-88KbYdBTkxd zClpI6R@3Q>QeCM}ez;QkOH<^O4}f~ackn%`DizC2S$5wNO*#u6MnG@~v*KE3~wFK6HcMaa>&RQ=+>5mW1EumKtySnF&EbC@pyePXExA-o{2~ zg`+C$U(>0`NT%!Xgc0$@^3o#%t9s=x@_8e$+`>bIR<}z zZ?NL|>(qIMG@~eq78K~23=TA_F&hXE za|9yy3FD&IfR!rsG}ec@dW&>NA31(WpuRFuW|PsUUF^tj5eN@$$DOkqfw6g#%wE%qS6PY_84vq@GE#VfJML z_RU^l=x((2-bKn`w$Ow1)>z0!iry?ZE$unGm}@0P?eMM{L&(d{%1d?zyYJCWzfD(- z;}p;zs-fEU1iQkCJ9aDGqrT(ip}l6#hvay#qcUsy$Wp&>Q>-{sJ$>61dz2@5s;c?g z!mbv2{n^I@@H@Jl71FnBq}}%sC1KYw4+WaNWOhy8&VS9V!O-y(8%WwM%TQIMZ1?{dmc5CvLj6&e$ zG0$4gi1oGpsilR=$%0-X-|Z4I<2(9T=W}icM)?8GqFfnMH(0iRc`1U0e6AgcU>E&> zI`~oE5cK)H2IBV+THc!WgBQ7Tu+PVs%3hrmF#nZS|I=S*YtsVk+KTIdef31~!uyS6 zo2U^=UVd7tcAyrb_wZ9-V~yvvkb!j(hc|m31FPjWP?dA~B6rYo8g{b+ZpFEJ*`M0q zp;;F9Ya(bdFbSYsZSvT(8i72`pwKv9SzJ8x$f`ybGOSyWW$omgNbT|Qk^5$-$%UB! zUm;{E8`f+~ZLMkfFks_47w5{$kIrz>4E;kaaG4Z_Fau zdb8M#B}7n4Y#8CY;1lO0n6Bs;*R}7aSMwDzn5YuIwVq{l&t5f$zPY%5k`FZKqk?LZ zPd5{;F-^;BjM<9WF3X}=VMg6rbqVkukFRC8I7i!~-(+3zi6>1tQ|x=B8{47jVV(GP zUimY%ro=9_bA>gkpJ*H>XcTpzD;O|rfqqNAU(L-(UhrV{c225K?vcfPUPk2~7_(Ht zh0!MZKcDsf>m$;?<@EiJ-_7R&8TtTvemR#wxiBW474zQS7W_)ik^NG87}P|#5t`C9)zos<#GL#O7ZB_8#6n86YhKxG!Ot$rb3eN%jrM*X z%i+m4ABr(-jP0sXmgAczg%}FeNqa5}@#PZVMApae-gpsO=jf*L0`WGZ`vaJ){Wv>L z=1{7!`&a?(2VuuSd7{35njZT@`P?m+awHdxk&| zs{ja{TUFeU-_+m#XQsEDt;w!u$&F=Q3bHnl8I04vdbN^2Z)V?@&oO|-v=3wRY}l^L z%&`BV0SD{2HTC^faU?R`rDZTC7X!xmTD6XTW5O9)jErtGtjbhM#2XsXtwKW3aFNw3 zh<399P{JU{pmr@jsw4Tq|IeLfWMoC^Mf;hSKZ%IAE(Ir8uZzJ1(e>3S>o{eEA zxm%^fQ#i8|UEVFd_59@zfz+aVCanYKA4^`XN#3`*6fD#vCAy6H7EfD_jEev9{Ea6O zYgO1Ru$q~T_239lM^6+Yw>+b%^8^d%%F^uG%{+!;*T& z+PF>v<;A%=Q7*xSBwvQOE>qmJ3o}XE3#&o8)QGCiKv8)(Bn~v^bG;8~tj>ZCpt z&~^~CwPT|~BBY@s^gmAgVHe&3Hm(bATqkZKL$xb7eLdiMPizovaH${ucT+ARPg@}u z_4c0=@!SUA1zg5zZdl;szF#+h&~QQbR}CEqH%`~NE0SeOrt^xX^VWn{_HIe$vP5H1 zFWTvJ>!|%Y`9)xxHS3va*&62!HNY?4kv|w`|GbV9xjOpuSwv4g;FPwy`{RSCI(7W_ zHRJf5M+Ims!WufzY}^i~yd&e*d4JwvPAg2kFHPkLK>fTEtG*rnZPU36+rxh+58)AZ zz8EbDOyRrczj2Qf^rrn2lf?d}Z*0EL$GUKcY2Mp&L&fBsEitkLM*)O&po=&s38H_3 z?4RT*Sj}9tCi&hWsUb+`S0^f5S2q_ZB?P~GO@w@Qqvwd}J4f%7ZdPfANL)wkwi?hy zzI6boK&2gzEK%+&eAa$BOb$}Bb|H+32P(t}*W}vj?j8)eo}iFpB4RR$Q!(VQVQ`Rg z0{xD>z4Kyy9(U#dSQ{>iD~trg4E?<0(z+TCRU7x`DTa{MVZh;iGreXou}5d23XM6H z*-*4y^w@n_dTx)+wm~76WkQuvNv0djp5sb~zBG=^vC<%%52d!#dgyvKI_RaEIDcZ> zz6_3k$Q4G>4q;>~B*|3j1h(ey55oF%BHZ?Z+`N10E{gHPXtJLpqndR?XL<&P7$HB> z(B1Z!;AUMt>yR!zYao@0|7OL|O&(m_KXg@Ria6<_PRMQ170=@rt}hsD(oL1TDV$3m z8MmZtDkDXOj#k|pPs3`tCSa}lHHv9lz40Cr1eB`cuqrp>3TWL54=QieMV{??ieqh* zZ%nlH+b;p(O+2DL>IlCWdF*7uBYu&fG(sO=wL_yj46KMHWGxkF{e#Q)oB(GJJv2f9 z)u)J4>72eJ53t-5ox7#hd!?UBaSjLi0@L9Q(m7N3<{~Q09!6h5Nl@RksH3>U&s59V z?UvE8&meE^!u6vsooRA#X%b-A?|h*5CcKYj%R+D}qmX%5#K0DW=V~v8#|PINRr)bj zf45To+I({(i-ko)lmHQtxAcGDx8m(~$mI9y+B$>!ZF zU-i>b6-zi6T@ke-T${+G(%`=AG;QFo%neA4FEUflH~>Jw9gmv0Dl+wy{Cj9Z6U*^A z%`tCEcq=58Y20%xGqWwQE{lG{1oIqAyO&|y@iIHyPcIK0(e6?Mq^qwHDF%d{A!LVP z69zs~_rXV+K0ET+Ib? z7$O-EM{bfh#pJ>xS?e9>y-R6DY3WwUZ#KrG!uKTLU9X#ST<9q({8|?$q*jYU>^Y*` z&uxE|#)V|dF^%ivznNPPF-pr=W>-9Kdb-@DZatZ-&G^o zCgrs&8pOqo+gaE}$;KK&YOOr9oM&BW2UPW7WS=! zV*t-3VUK}vj$#}epjiczFGwy~9*hlm!B;<^fSJ(+2t%a+i4r%&@h`QX03~m156Q?Yj@{cZ@wj}vAWyxn)9Fo-CzA8&X7^`4A`n}*@4n#5&DiJ2hIalE=dNcw zQiqEWD!)~`bbSC2<^gy6t?jMbLP2IoZvkqnZmMtUh3IvtGr#hs&4-QLC5A6N?B~NE z9)s({rK$PH>MgOlq!lMA4<*UT2f(}_czPymwMn+$m1qRzM>81HI3aIl;Y-ty_=7(NHCif5C{%_h}j3Dx`<$_?+~c~ zv&!5!^xdXjJa8uuR@e{=s{@5~r8ew2l4`Sv?=gE=ndJ%I<=5X-v9-n=|EeST(Fl`q0*V2o-Kn*?HObyk6!lz;BGZ z!I05=cN1gpUsmCJ0u)BpJ{r(G@g|UGDthvMzbZPr^DRUp;_2^~$*7D>6?UV7FB(8% zDxZtJ>Omu+P}JHnxr1h**qZH|C2c_jMIx<$%I2s$fKAM;-UzIsGF>rN z-1u8imGg&1U&_v;)2gK{C^DofU2}ET0HmQFTZ=pulDc{QpiPJpFu`9RFZJSNio6mo ze?eu+q8Su9E|nlesTGgr$R{><2z-+f#~<7hiFEiCbWb({#J26>EAn%WAa!t(AT{nX z$gaCU>mT762h#CF@OgcD)@Liw%Qbw4!#F1W6?LGfiaiGrtNfgAX2HDG-7EQ~`J?lx zlmW>%!scNqBA{`X=;mF^Reum0^-<{%AK3$YULY-))t!+dOqlqehRJ_jx%KZ`Lwq=k zTA9n~zPl^`cbo@Ii`duTo{4_&o+rKbo==VPp-=n*99U&p+2MU+TEUYIeV8M&v#lXU z;J!hXmSC&W-b3`LwXUiYP4%2lzmoP};LrYrviv9D^7q+hw;d2fvQ_pzeZ%oT!WxL37Lo;F!C|t84>m9udDOm)@OP`N?kLd~Q{qFp9xKR_P z&W@efVNk71=!iJFu>;);m$+k@N=*P`eN%Si5=MIpgZX3!d?&rTQY_al{oh zZP}aNdjwGjwEyELPXGGl*^V&4L%_3kW~mxoTnMDP=qKnZ@M$_WP-)F$a9a4**#qdq zhp}_+rmOVrhvxrow~<*!C$^`~5l;iY(S7P4RkR0y~@&;C|LN-0d zH=kL`mfkE_RoU!A`VhpIQ~jdG4(#?u4i2x&mUI1Sa#q_pv;KVPm$69pKTQy1x$yJk z6OC8@v?ldlVm+_u-v4<$_AwUQTJPk0J*|&9-wW^U!IQ1tSwG*Km)uYhKzxFFA{EK% z`HP2Qx0~L$*uiXLC(d3@lD1k-kqf0B308O4tT^#7c*G z0MRDXGE82;oK@W+x9)?72fu*MS*@HKWXThIYO5a@eu`b94IFIpIbJmR=LIBBfUaI{ z|GC1)p0ZMzR?B^wzYi!!=epSZ%e?N!>_+>&z4uy^`yATMt*{l(i(^(a)FZ7PR6hGS z$qg4cf?;t>6TwbkR?w~J`8DYy-{-)QaOQ4lU{!V?RHN?fV6NfwpVJ6?)b$YL8sA5c_(pstMt%2){lI*MD|&g=lUweZTq^ zGYAe^oH^kqB1u&W=fuyYS)6&I-@*`E_Lf`Vue1BH%SJiQENQ>~{q1O0gT!dTO1~0r z?C}254~1oFd6duT&BA!IfTOmfSuykABWozX$fGY;HHK&Yr=RCPJ^Ky1w^F~&-VHkb z`RH%ATfe+V+TOI~#|O`vXZttmvd|&(Q7GmWH}%((a}3|N=zn2*7G-|_Q1i-KbRO_6 z*39~?v+SDb&-%fQe18#G|8-Ol_)Bc%`JcPw@H9$Izn>{x{_-DN5IWVu!1;<^zhH{b z5tiSmWKnvaUt$fon2H)Np+u{6!`))KoV#z;c!w1nbptg0x(*`RHbYj}Z@ZG#FL&tu zD?-bS&int8&~mtg$!~BmJ{udCb}vEuDX+AE{F{&aDQtzr@Qa?gn`60M5aD_v9*VG~ zu|Cx*+Inwvy@5SPeCg(Wb;<0dm)S(iB9}tB!at9c;!`M@n2gmu--f{ zhGtBR`t7Ex3>$43F3;Uf5;=Jdgi0B%z@Y-E$*GTf%IF>v~~k8H#k7YVP6SnZw^+ zgghy5qgL?CbZ1&OWj8e2h0=4BHPp1O_I1f%#Wmt2s+q{X=l15FeWELSeI{k#^YN{t zRkhVKZ^r(j>U!4~F-DAvoY>#ZJSib_XOzTE)SH^4BVJOr zftDT?rxj*Xmi6BJ*N^+2LM;$9JCs!eIgNOZG*MznI}cK(d~TM+Jb>Tu9%do;Tt0Uo9t5GpBtmN6E0;$BRpCjOtEJhQUycC!iOj#op= zj)NA*JwQoV>(Hqz-* z=C#FDifRqj3&Q}y{xU~-d~xNFXTA|*|WN5Ne+ z)+1_40W83lD!{)T+9b1eX|EIc#)pb~?-tbkdb2ot#~?VZc5!Psm+N5kguD&UvEhX? zPzM8OmyYXkk!7`j7WU%BLQok56?r~}>wf9d3&n*; zu<2V$x0IN$@~cb}Suihe>&L5vwj11Pol6t;ePj0_<3EA#iB_215fHMO+DJ2|LX9$5ZEjy*P!@QfdWY;lwfKDx zHdtyvZ|qho?pTCe&XQtElBxxk+dE>um(hppi_y5(c*!#duWy6*#hGhGv?fl4Pt|qP zetE|dx%#Hcfe7DD$K?&X39XiW1DcL~@?}moYvz}Thf1ofW{}>93;`I=m5(B=nw6C> zU(0GP*8si*5d;r?=-1I;7BCh+x@~H?wR2^z8oBh~M$uA79OPd~ z6R=^Cb$Ov#{Vp=S&msl4FTJp-Mnld|T)vD+DpzmTy$fnec6MSGqk5?8>dQ^rnQ{{Y zryCx6c+@ZNdV)Op_@6ZL5c`^C7LRtC2ET({OGU^wFmD?>lDD|Gwxu9UtD>+wAoq$B zC_ii*&|$w&&xJ$djcdw&@9rJ$f(Y7=dBg^%*C6U?N?+!iOx3ya?r+9CMqJ!O446E8 zA<}O24rCoUi{j%&zShy~@htk_dIg>lERj+MzQkCpnLsi0 zVBDh_mtDVs@zcX85j^WnY3(MA>^m{3#mDE+!v3KaA>XvLE51xDC*G)Zg z|3$O?_gTYfG$v*c-MWo18D)Jr9Od--g{h|5&(>d;Yr92->1_*Y*s9HxWEbN0WR>Rd z&o2#N!{<2{ zWZ4wr8H6YwUt9~uYsrU-*O?q0eBK;>@+7`Yv!>{+elEh3LV#ZzrgjgnDb*-Iazt0X zvS&SSyxY&^a7#ayE}vs9W_2x{{XU@bokC{B?-U1zcpZoUvDUL?D;JR?e+jr6u&mB{ zPRDMUssXsu;7#S}-^p<=7nqXBb&Uw77B5rPyQx3(>#=aA$oIlbOHinvSAIxD(y0dn3_UZWkm3dBb zt)z5wBRt3d3MYNS*dMv{NdXQdw7_JN%gmjPvw4r&aNw<1GET_!eV>(&_`7epd5231ZuU>~ZmN-F{<{mm)U_XD_+ z6-x?Y6t=obCQsd2G0@yz&y#Vox%JLOOmxvGjrXE+*YvP$2y|jibBo;ttXvZHY(z|1 z%cVFhMN`Ms`9pr@)Kg}J5}o)}B`%wuHgu=77!O>fl0r}Z0<^8c04LlxVQ(F$t5Qc> zrYja+5^lBW$k^y0qv-sq@OJanV+^C&qwWh2F?z#KDiXZAUc_v9YOPCqat@^VG#&>a z$0$OUbaxZM180>kIqjgsKul`{V@;xA2OO(Q|ntfQpes?-F)=N*%ZWR^XpA z;UcNR$_9gW(k~_WLK>?(y?HUh{mRHj`%mmeVO&HOh_2{6OZKwCVy)cJfXtMm z18?tQ36DBp>zFQX+L`i_$G|$hO_nD=z$xI0xrAKCD1^WgbT9WW*wx(neh! zVUc{9Bcvx|bd(oHel^t(r`=7b#)U&1v8?uC`RLk7)wV48=P>xR*VdONC29Clrd8j7 zGICqL+K3So5jx_6%RdTJn@xnnmu8z5r#$gxC$0lcmWU;zTaSu9SAH4YlAY(0pxm=} z=0&_C@Xrkpu24Hv)G;Mra&7spTyR<0DWG)(EBhr9L9oV>BX_ot2%TP$GmFg)9>p8* zbA~E@tL5Pr1l>=rKM&*&L{66zL)d)VSMOdks?3i0lvC8-)E+yTUQScfl8ufkbeYr+ zwVTrNnB25nG<^=(?evpWvEE9n57WIf!bZs<2pu+?Zi{VUIyca`p|rIW=^%!$T7wJ` z#pI6e**3m!CA!a*FOC@UCL(4fBtFs$**^${a^?)4%9!z-oz^_e=Jw@xp6bi12Ct!# zKg>2|;gT-~D(i3>X4Qs32e2L}$BP*Uj=;GUEv2)IGKL$ixpIYe=l2m2Y$8ZZ_uw=j zn{qVt%rmUBNX|)#Nl^XjS}C)VgoYny_p^=X&G^1ZC2l}{KM8xy3H3FDK`bd(31}vH zm$p!hWPpE4ly}ZhNB9IVPxBUmWO#X#p2h?PvT8c8HFt&2=~=-*ufOr?Oypi#D0M3G zoG-1Ag3Wn7aDmF~W(Y`Y-^1P0Oh{0X32K5k*!3&!Hj--Jy7Y6;UlZuPi#hZ9siM*eD|}f^G}K1f6NkPy#u>Vm>#-#7JhC0Xa8p+ zDV}?Vkypts4F~dc-MF=GB*aN|r_2to3ETY&io8Q=5eIFAS-DEGzX;v?qMy<+ZZS(@ zbl=JM-01U(L}N$LB+fDmhuS&))wx5P3X3|U=<<<3%e1bnF}2SnaJ_q*iH^kA~7gV=A3Zkudc*fOcvs<4@ccr5ia z^3FH0DY~V^$-qEhRM-BoO*624*Kjp8AGG82Bq2vb#>NbVS>f=JM}b_)ztjU-Woj-( z#3Bk`Rt^wewd)qPB89EoMF`YH$fpeB3ZE4FCN#GZ!~?44F`#@0pjF6^NQrhadx5;2 z)r)(2h_@-MQm>PBEs!ao;lgSSa7T{1>9p~>5m)a`@?4NTjz~$N*A4u98hhIYH~ZP- zb*saC$tU=f#_bW=6P$blj=4Ta1hwl5F#yD_`ZMnl_r(SPm%p>%yo0CqsH%}&K4P{f zZ!886UToWR>`Z@h4uW}_gdH=>C8mRmw(wU@u_L+!y`rQg;#q|>G!f3EV@&Oc?J?o} zPx9scspAn3NPE|0PFvGJ`d5Cb!sWQ&$4kha=1<{zwZ1OaU zRweQ{K-rhL5s=SW>jGVCK^6=H-pC&0Zl=IX(?^ag1yXjt#zh6PnYJk>lTOGn zmvG(Bxz7Qo4io3{Wz43V`}$X#05MVMY`>! zg5}r|?V-BLCEPo=X(eNUfZ)V@DP1$MDq`(#khXm1HmtQ6^#xp9Omw{0y~91jT5{?D zW$3swYv>qyk5uOT8;ouHJS@XTZ+hn{PyswSBoV4EtLbp$#?_KzhBdV^1-mpB0qV)w z?BX3#4SDx&9v4?oSTHsq%^O+>jBA9QCD9NrVpuPgkQa^5Z{6B>{)ENTF(=lj!ngDJ z#)&!(Q4|{)wAJ>=ZHYYnQ2nZaAw@Tss1DX{US9JUIa`m|g_Lrbq-C?#xL8S{lxQ6c zV1>(EY3S*B|Jw?Yyff#c!mY3j#V`Y~IH}cEZWuceJK1^wae}DdYL8dAp!L)^zj=Ew z!W#CK1NEgbh8?_NLiR$+8Wwn49dKU`dhgcvLgu<^L|eRW9=l&(chJwuIH$G>U=U}lxV?MFHo`}@U9h^%3wJ$E?F+(=}K_R8G4(}>|tH9B{o`fO!3M_ zNeVpy5D11T4GK8My-^jyWCn>NQr4Ktq`7LP23rk-BN+bsO9 zEwXqmsluf3LtEsma-CsD^~Kh%)orT!Yt@|QpYF!*vrg9$MRlc^UQ3p;*0qNf6`@O? z=n!w%SItLU1Pa!cfk+OcE3!k0^iS2X?p9X~!~qq~_tJgjxVE*(`2094iKkBoVh!25 zDkkKv*)QgsYL{J}T)mqgj9_2FY_8Y%ZD8zdf1!}MN}ERP&0~>jE^a-x=D1h72%4a} zbmWd<49N3MYF6nGri4`e_-9ZKUzg*f`m_=4zc*OOI%Xxayl`#O)6?0rIjY-}*h5p4 z-PuF4>iZIZj&x_sUT>J+g$7Ei7d2T~uv0KeAoTPH7rLUif16t@_-b!@0eWGgv(8f^ zxay`tbD~i(zZ4cJeG%Wmv||#|HlAuw!S{)dhJS44?s)6Pw40tHFZqW$gy^Pg>Q~h> zhlON|O}K;(YwTqtQG5nFdBKMwjIvs9Ez#W>RTUBS=Xk9GgU%Oa%32dhG^=zj7(_~t zL^!-^6lc{zx_KP*?G~i64&i9febdL)@oR=b?j8JLJ9Nq{DzKuoCYLL5GX-N;e9fVx zlX5f`FZe>S=Dtk1QMwyvTSUq0&rYwe3$<^ZUAmO4+5G06LA`91;6lTA%Ju%@<&IR_ z=A_gZH)h@8yS>zI$c3Hj@7fA-a}gE!}o0j3GF3b`9#j$r#Yc5yH(Z`D+?>AO#B!Cq^%x%+wA*?L~CfYXKmt9fag9XW*h zTy#S+%1V)6I2K!6&f;-CV`&ZxoqvTP~1@>)nBih zREzB%E$@CShg9aMkhCF>e?hq)pHOfKOiA7!o3`UIco~@T1y;dGaY8iATX8J zD#|A*4~5hcq#k44)sQAu4=W#09-lv8p7JDKPv)Vo2lja!T(j5N)i0!4eMWGaY zAJmk3y{z++5xNRf&qK`5*rPWEhfLJGl_1<#%tj)-0wp8w7rG5J|EasZX;YMeC#=;g z0WRe_DLaijtls7bMT$txKAMJo7mQs{j7g;>J;IwlgMQH*mZB*XU_>ft)v z_pM{-7mAP}QREhFy;iR3IaGmi;U=dQ^08I3SeF>+evzkYr&%R>MkCq)6H)VgVzQWQ zF(ESILz6Q|EE^czl-f>n^0Ue%X^32!ZQ4#9t;1&L6*nVxWFwqlf$`Ruxgf9b+}(_4 zv;AMkLP_!wzA2m5;Hx!K?(OW)sDpIR_l0)JqBYOAaJd|0Rf?4L1szH^E-N$qH^G{K zvKm#cmSGzfE(vLU6ZA)`qsMv*_7B#wXUFHyFt$;RMuTt5cT#;_o7;B$(uEUdWGpRR z1#VUc7I&fujT}=@=(5ik(At0cZKt;t3!(b*aiH_v3G^OuKakySmJj!DlRyV01&-m(dv?eSC( zZbESH1Fm6jQcQtq*ogzC*E3(5*7Zi+D*IfGRYy}@)*LTt+uOIFcTB(SgAWN?Sm3NP zey=ufuecXdomA@6@Lui%vRH^w!s5;nZ)1c-^jj{Pd3WZF5MSm@mMkqDy^m`VMVK@D z80m?ttRE_3dJz zkwiRGS;LDmsY~hR1z0r;Y5#0C2hOqqodDkgn)8uznc!@0Y)*ZZ1ga^{8&ej`rfh0y z&{(s=FE)IQdiARfFi z4awi1z5q-*wJF}JAkSqUr@C%_UrWxw)@@SJBMVj9o_MJ^4}{KjZbvV1G^UPmxdx2- zZ0qq>g!^I`n#Zw<^Nm6Al6~vdk}s7RXG#nt2vWVg&6w_zw7x<*Y+Z)HzS7YWCnfXf ze4<(SO^cs5TQCesrKp-IrkY8}lIlpth@0|BNe|%T2D?4lNwbx!*Ywf+)x}WE{ zZx%I^(yaXckNpvj^h7P(H9FzoZ<(YIw7Eh~=fM<644%y#p90`KCuw}HBYNmG3Wj!~ zSWK>4WJ;Ji6J6D5zlmU%^X(vbF-lExSnqVva{x;xc+%6$?|2zT8qXQZUo3fv3*y1s zI^_RsS1}})DcmMx)3E%i25``zR5V0|UJM?cyrb^-OzxNOuGx=LdwH*?8`vxd%U^zO z!jp6c*ZkU4YK`SmW9cNT#q_e*^j`n!I3cxNtLW43gssc@EqsTK->o~Opwm|&WLoO| z`aVZ+)Qn?@$pzfz{mC$&k>n$gFf2F>%!?j7a4;;;}Kc9cTuPc@6hK@*gtv=@>fPZG5m z4cdDt+B>!H^)|jR2Gf{`ipkr0+Al{}pG8-bXk9-tabYAJyC(kh#@>j$gIS*zRU`T3*qh!yD3IH>RvHr8cD$p5gIVZW?Imn zKSygeztOw`qP%cTY_#a$(d!P*$09r4R>j`^gqu(YED=r`yuoy2$~>;;uVjwh6^H!T;R~^1qo$^rn9QgBV7B`O&)O z&AE%h^~#kO*mO(43B*X}`YkO~*WX(1?+yN=8UM?KkDTwDuw=h&19X=X?fU;APyK@_ z?8gz|EWfekNAc|c$BMS}S;wWPKfZPx|5**&1>I629REKQ3D5SEc!53v{SQ~})euz_ z{^2)c(Wz>AW9=u_D)Put9^a~3(!M!2_o}zx?0?VVsu%O(j04|EZeMqpqmV$w{VATR z?|Pe}|4)2GT%{O;yv9rT-gB>|n0&gU|;&^(3`b~KH1>_0G#uttHlSc{X zDe6W8<1uN55T)k>x`7`dLgRFGi z6ntxUiZL}M6LGM=g@FUZndF^=o^pr0-x31nNXZg z*;gq24l#;+baktri{i|;0FXrX(}E@6jmW+s zZso#1h#c+i1ZXph9)SE9=tIZv-v(Lh5-l9h5-c@r@tJ!L$e#CJ-gqj!Y`VU zs#P5NO5KwtRhyNUmhNOXC5n_0Mka^ef@VtUlq2lZ1Tvc8W#%f-hDJBL6CWtTVm+rK7C7`sKzugSt_DXt-jJ{e3bGFx@rtI7>si^$GVU2F0v)r?nKE#6vMlrkiU z|GG#G{1$;vF>GOqfcg|sZw;^ZPyBJlhwX!}qx!d;jwYH~qPD%jqm6M=A>N9o&3wtrC3{C^o9b(y8Y@6tMoLCO)mRoatB1l;hR6D+ z14P$DmKxuBqr!RuQt#F_VGP$@xK7(v#Yr044cDCysCNrou)-+{fKj&b8VR*6-b=og zgXc_o>M0u*|9BA0xY+4`Wxwx}4pmxz!>x2SqjsZMbz^095&^+O@1<6s zZcAecMg-y$=TOAwN+4ICz+92c!Mi7j4BKhyZ>ytl{{^07B-%ul@9ZwmT?O0;ydX< zeD@CTq*ttXE{jdzZ~$*WXM-wdeahO2Y{FJGl9QHG@P2h8-X2m80R$XU})1= z8Aa&iMQd@o&5)a1WA_%kDPo!9fK`N2DaIh~#XU4}^KIq8a`)|v?K$ou5VV)qrFKO> zVP0o_f8pS`#V^EJ)t{!nAuWC5Mthz7Y=o~mdLLt+sPhTP=MaRv5STXqLhQC3&YZ~5 zyiz6$lBRvQ!<}HcxRWwIs;dWo6BP`5c^A7iAcB3dMCab9XUw3-N}HXqgXAtks5wF9 zIQA_zgI-#E7M_Gx*{yd$mUpJn?1fFfs0T==>Vy@qtxossTI7Z0_FU9P3f0vW#9Ym4 z?>8`$$W9I|-LR5r^JwT&FlbD5%N7)o+g2&r&2BUlwh_<|euL{wFj{JoIQm%N-+k~T zkrA7SX>XvplCA@s?zN_{v2HGyMfi^7xY;i6Z}X1N#-gmCDOu0ADXS?Y`fbGEi zBvJMA9Il;3y!VQVfkfL}9YPkw$5lEY@Xcw_LPa0v9}~BChy|N|p%$z_(|p@lkGtO> zq>sD}{xxSYx~S}sm|zuRz%2LVVoeWN$s=u8y2uXQ7fefsN>u$r-`7%)cbrLi3ZQG9fWx@?mL+qAOcVPk?{CLW+$_o_~n-wHphnw0O0=j+84kU zPc8V833lIqd@hH-+T*6TK2=)b$~TGw$kJPvxmpOr!MR3pA+JJS1p`QDh+&iFHDp$O z2*dqFFeA0Um!47d{Kr+cXf>nYs7kF_$H~=^sgHHv$^7mv`Z-6Z%YtXQ+ZXtgi(puk zjv71|z$%MYL*An8g@pl}w~xMAmBl=Pljt$A+|7{UagqHTRdlBb@wm;AbNofdd-ub` zAMWwKaC}`N_!*`JKL|8ps*}zfkaw_T--muhvxW}mSc%bZWDnH&s1DRu)EzbWUzI0@ z%^G+o{p)4@pRz7{cnuZHs>OcC6B99}ulBRL>PbYkxX2PPODU}*(x;FjTqN$M?=cbJ zM^H8LaX7Di+~2i~y2M&b6^Tvzz4Buty{81gkJ}_Xa)ONG}!3f5o zC$+RVC(HJIy8{eE(pLKv?twF}D$SxzjrXFHb8c(YksGO3BAC)6~GJoOt*XPutlTI=T;J z?1O{SpZ#akz&{a3lG3&*^JCp*xa9i2uo@fG$$yRg6Ij%6t&U@{`Zp42ZDcYf^5;=f z^^|hUFDeqW*1}6Uv?<~h|Il5ygOMsv^fez@zj9vHVq%_VmM8~h!rSmSMdOd&2BSYh z{j|m_0;s$2hVc(K0YE z7^#EE3t8^r(KAz1z9EetT`q!OYh?lG^vjfc!2;LaGrCIhBeK_nyXfS3k^>M3JoHpF zM^GP77|Nemv5D@B+ul@JU|Il-C`?(b?As_iwc4l_2K5Q%z5otadl7C?D6_&$m}gFH?;c53n1zd3>pVP?thgBVL$YE>p18N^ z((E$6mfe(7&`igc)2O!1@jSkql0mIMZ+ zVdGH(W|e)hScpFQ)7|xB&v);O1&b}~ozOF5as(}KoxlJ4Bl+|1WK!zh#Q$lr&RC(8 zO+Ts(t%m8TAm1Ms-ImijS-vE*;I+pBY^hbe&#qfc5G;-n;a|{Pr-tA1qB=Gl6R}?i z>S%k?@e_EnIwQ?*f<8AVAO5@9dMF559#V~VG=|&oZhY~rwE4%Zgtb;6-B2`%-J^K* zE;{96t>4^cmpy%spd_tJ?|y~xwI3)>UauwyqdXid5)k($7;P{5=g#2{^{F) zoANv4r-S?-`I!l8$D@ZMVl=*S3@|V3I{3IOwD%C**OgxBe673=O6Z#`6>A=W#`$~` zxETDW(EFp4Ldqh96z_DfZyrCw4CczSx2VdGOa04(qfb>n?wqXR z>!V8kg(^hsU{&Rp;UKpG;9Bqdh_Q@6m?KO}_Y;uMB0ny~%IFT`U;jDcv#NZl{0qNF zti+#k$NpCJzm-yrJ{u^So_6d%d4K%F`F`yj!g0~rK9H9Kd&#^yM}mp{4Q92%pa#IiedT4Ms2Q9%%p0j2*_@VKy;`gQN(kyomk3*PSV}?2yaU zSjNwGl;2f$<5DVfo+J4HV?%`u=;zWr1j2=~HZCcJ!?L2N0{4Wn?pMT)zT=NnJq|kY zS2z8=1%C7yD-nUByC42S7JKxU4x@lenXNYi^^`&Id)5%Jma=+soOUjd%@3yb8vEJ( z-*Kt0{aR@_lX+ZkLCU2CUFrAFgX|wo@ISTD?5}H2zxYFC{h{MZrDggr;*!G^Gi<0G z_NY}*j8o-FYt8UZ4w{vI_|A#ldBjvxb8-BlSc}NnC9!i1;9m3n&5(tt{b?FNR2q1b z-lzbaIe6k!X^}8}wMe&12qIdL29BUn7!5=;#4nsKXBQJ69J6?J{t|y&E00K0sVTU2Z+}G-e)+uR;$PQ1%d)(h=Ni=43<0BGZ3h!5zh9iMXJ%g*vT$U@Y)ZyYR^+w#*`)W>D zhOp4iiuh@g9ZBtKMAm!!Qs!x7rMX>(A^%2Ca^ZgWs;c8~U0$|riOGqA4Ph~hqUx%J zT=nVzrN!4C9i{qG!wk!KIpzAms$gL#Fy0|Bzm7fQ!>f;ftma;Fp}kHS`Ky#iHj|Oc)tyW&CAiS4H<4zSLRgYlr>6v^lAqBXD#^@u+hRRFPUUow7^aI@u?`!Nc>Z7I!PS$9F z85fYk(9(o?pk(5zJR25KawZzW)Q2(kO?A}SA`n<@liGpZ-9D9eS%c@{0#nHtSUG?4 z<=CRNP=rQ;wAL6j@l_aId4_|yYnSwWx^lHiz?biK|58ZAS7eLa^X~>{4Nz>wjf%wE z(FJf4`QQ+8Ewh!QVoSVyDZr|&P~~P;t5_QT_~Nm}uaVHSQZ6lGfzngf0^+H~4T9sT zmIC>d+$wICBWp^8fH<>oT=&Z2{TXtY$P?kn>P)h zK*>yh-~{sqR5wUl#AO|DP*ZZ{Wwt^%fnDUqIltb>lL-pYKONF~WNTKr!4O8W4pO{m zfAPvSIX07@#%!6N*|pat)^=ngK&j_-%Ey=Fi4R5yCHOu4uqBNSd)H4okm&rf$<;ic zpJs+gKevp^WeaW>yX^>^eV26{DmGdxhGQDPtY8chiZhMcJ`?a{<(HxpC+=$1%FT=6cGxQx(YK?=&1>Mz2@wOlJuJo=u{RjsDw@UkVZvlEaH+H_p+xZHm)O0{{XZ@3-7pJ*9QomQC?r=gY6pq z=5swVVMQ8VjJjXi@?9*}vy$?0wKNy_zQ}B^#yir8oZJIn#HBnJ?(f6s(L7!WE$cv%LTASz}^L2FAvS?b34I^`F5LsSxw>hUm!Cdn=_w1stzjj z@h~orYx||Yw3_3z;>&aK2KUZ$@n_0utgLT6Kj(ON{5)$XYcmi|KQ(ZUr1V$nZ#(~K zqtO}3Bg88Y;(GSZNBDuP>ImsimFTwF3u0+g$wgK9fo05zgNHCimIT$0$ViXGx&b>R zIx22@ua+2qF+q*CzkMK$dwT0iJ`NZ~Y`?+VPqD-Tr;nYUQCHj!k2UboEH$$@+;}b_ z1!l~($8uLDUJppL@3n2cktqG)^xs~NyC_RWgC1!P>N9xbzX=Zb-(c~7nic)eKm9@s zTJsG3?05%z{)9Ob{^!iBSGtK6qdAux-3uCT3H5<2m`k#QX7|ItTXAlWcXFO1y#kme z~s(<7n5QlD1Ce6U-kaWE)m1t;ZeiDAxt)EDJ zJY-LxSWPTKYE5T=*}La^lBcj1t6!=!dnRV(XJwsdDrf3jM&v1nG9hth;}&5T2&J?0 zp=sIG6*!lc@7Dl+TO5OiR+k*}w;|%JL~TE2{jJAj%cgni&9kid4Zg4EBX7O@{*_OB z5FKp?<4CQm>=gpigi?nsb%Qe=y91wlpy!eL*Ct11u;=P3m1aov`>>5>2T&2|Q&ozB#f*4%Pje?>EHj_`TseC zLr3Tv{~>I-5q3S+yh_Qt(M3DL1AgKhAl;l@{8klbF6X%1VSRH z&~?k*-tF0FTt+aKTpB>NQ{!hhWXV5f5~jeT<~h?E+A0}&N%-~yK;5oqf?;A|zw_>N zJ;BOqfZVcu>)L#Azl}tMePqM-6r|ngja`UkhmckC`efG|wTXAtUB%n(wFl~^ho!0c zZ?SkLYm8JTFMpA{^u;vXsEr_nTwh<$tt!;0nh|%7@$QWDMx_}sTsu6BjA$zi&qT$`e57Z zlOiSkdZL&H@2eJQWj0V((SlV}@ciRhat4?RVvf+NMl>Y+B{gS@mgM#BLY8s@3PMwh zv9%o%8CR&Z#RcrDGr*w_goyYmtYb#+X1) zZQVUhvI{!;jX_oKvHZw*mz2|t`@fPk$CF)FrrrilA`vjsE9Idblu9KCR)hv(IHB__;cW^ehcwUNlM%IW;+GI5Wm^*eL8Jx zE0K9fBS%CW?&Bg1G0bhOLr|fqsnFs4PW8SJ^xxr80aG_5{j$@P%nROtGx9zfj`|4= z(QL&E)|gy&!1_iQ1fly%a`&pfWIK+-$#y!?E{jqh95M~|ZUTF%|0!6$CdAl?BZa_~ zF5a!!1GVkOf!bn|>R%Sq;NO@Pl$F>T`G>EY2XdGX!kC>N7j zhw_cZ10;1mYSWu>7NQ;qx84y^2o4O!K*7Ixe`wUcl;D9Y8db*v7|KpqE;4QnKd;O+ zYsc}FI-E-xX$MS3c7=^%$S=rCi_Uo;6k+CcPbTuZ8+)$HYtw@jW_iL29TL3J0N0P| zaZY0H3maD69brVMhWj`??`s+{RSWB0!l<=9 zr{XNq99DpZ08|%dO}YZRd)9>;u(nc_L0`Wof>r?$9z=M4E#lz!O=#2TP$l%8`T4%I z52)IE2DJ)=F1LPg_V48IE~?%&ku2QI=~WB{u%V#pHr#il%||tguctbSzZ^mbP2Ck; zJ@;@{V-$xN6|pyVm$#UFJ+2XqaYkXhx|h1wFka=(h-TrsjmC%AftZ+im#>|)71Tyn z9nAts(qOx~&`_*Bf(;+pe?UFZ25TU01(&^pcGpsXQ|@8?tA~q$;C1D#hLdY2s~U}H zJ%zpT+YGOKRq=0+UHx&B{%<=+sA?PwZQGceGD&Kr$fj)FnI%|LO%CL){d#kZ1hr<{ zRL-!e=nw%a)8~_@TKpprn;%>HAPqO^KINr>t6uXeyh;NC43F|0ib|FU>`+3O4OP*~$T)@@I|Vdpm58{!k5>#$S% zz(MgnE3oY>(7Yzir8TkaJq#W>-ueeql*Kk!#Uxo@I1JXY!b#rznwNbeUPKRe)yQ;e1T1s}nUjul!+KUhrF1CZba;4p}pt`xv zDW7Cn*5!Sd#iUzRAMRCyd`!5E)+MCB1{W=_p94s7$zG^T$C%pUSY(@SVV2jCDQ!hQ z@=IpRe6Z%uA`e-LXx-awXp0UO>BzZ-XhmHh={8AhA$FWMYD5Cr$zF?H67>?Cfq#g| zRf1~_UiV#9T+B5`@~m1`84 zVXz;|WAmjkxOcQZ?dKWe@CV_gSFRfwhkL7DH!8!}>MS&ygd{c*U@K#urgN^SZMl^qE2mQh0^+wI<(9%b=Ekt4XICc4oR}q!(`LZL~RxZ7x}D+hte! z_$&oy86B{bqbA?EZ{61Dtxd9V9qw2G%n!=pxBG2t@!GWa-b+XW`p;G6U@->!i`kMG zopY%1>ez#0A(d&gnHFh^9A@1KD^2;IzItb(VqeAN1+;^NZop0_|x$maYR9mmEu|E;|sI()98g)B)K>L09#o6yR5Rvss zh6-*rt)6n&SWCTH+FXXFP&Oy0vc1aL%A3&*OR6)CYX%y*FjeUV$&|;Q-tM=BF^>%o zwj8fFTu2^|{v#_C5go}inS)#~c)HQb*XF6He{JaaoG^%z&hS<(P%|9skE>`%**RZ$ zC5Qft#RZSH6}f(OogrLX2E%InrvFlF2A4Z}vQoPp`hzI(C?x;De8Q-#yl5@9yoy@Y zBcGmZdF+ONfGYxPA1lhe)NUNK;fI)ZNPyETSKanqzsh=_`AhcWUpJnMirlXjZ^7oWPy{nvt5 z-lJ@guJRgGrK?mDy|ozqK={SKrO*5iq?&2JZb4hAocJgMsnNoXNxw}4^gF_~ZB9=h zSQ@+7pq}=R1au`3KVVPDP!IISW>>U}d4qq*A&|MT`}@VIu|UonaUGBPX9p5 zK21D8&Z<#@K2l?mjDE2w`tV_Y4~g&)9e6Wjq#6gcF9kx2r^=}jRYxPM7kqk*3@lsA$0mh$vdJ4$nWNNUY`O7XjQKRYbPX-*pC37+-HBUKZB!Welg zfu??~yS}Tz%v@ear}?}~J~%iSAEEZT+&4V#wUR&E651K!HS3z7C;3Yc96Gre}W*& zB}}QCy&QAG8}%5{67d8ua^{iJ_&JtjYSWOf{)}&qi~QlV1rqc!%*;l+8}$mAkh9f~ zei5PF-na63gh=SxkLAqpMu~9~%kLUN!~^`1;x%;(;ipF{17Rh2w85g2-6ecV47eIi z1f9nM*s(gWw{^4Wd} zV^LOkg{g)8GpS&OP>VO%Pfn%2Hi>~15)RPLn0|@%@#T*~x+K)^h24%}wO?K%_~5uE z7&TP`WuZYfOUvu%JH?wM{Guo0b}jnJT^?h*zSX62f3F-pPGyDfPrE^8jpA;*HbH+V z!F?HNC2ZvNk^N_XR|vHsKz9*x*hNQVWDS_n3>OP_z>KiK3|jOysBtjgZrobBFF zV&>4PPfJLveMP0#XUDB}F(gIxdatTr^e3lszMBDak{J)?#xJzrv${9dG#q+uAl%$z z0hq%UpwQ1XdIF5nx#=+TS%&fKP+mAPEZ{RpCG`L_SjGK#>9**z1;1YlyX;qsV zRq)C^ERq~cC!?B>duLYE5K{*f^kI6u&L>t7BCgQ3b4<+ZqFr~U;AEAssSVP1yUKi9 zhhMizOS|yiSRkfU_av=^JY#!NX1=R?h}YRw+A}L(nE9<#1|{p=yVlVhca;UOtaL;i^Zu&6BGaFj;-3AfIScLT5{un|`rb zqNAbp6?eniMhWB?QHGV=_npj1FgBCt+(%KP^ZQxrsQm3&mZ*hMVB*te)it>hgq zKSNT4k{BZb(rP1FU)kRVW7|^Ryg;S87bd7p7#Y_!HT&v-_w3cCv{goU(fLCz-ES3x z>24$Pry9p)2kZ>@^n`DHFK4XZ(ah3cAEprOvR*Ib+m*QUfCe_7ywA`P+p(~S3@!C@ zXPCK4W@x?XQLetLA*R&5rjXH3+o9DQqPQEV+3Sa36nOt-!)K-52?Tu}gG(#5YL=L| zvohwz5k=_X)si1>-vt>RvAC<|ycE$Vp>WwBjtr{ZU7uVslK1!K#osoPLQ(BeedRSt zqYDRPAKWLmj=bqBa4KL8?Zisl$ol6or8mAeF(oJDJ(M$c3Axrr#e}_wYtki8A8N3P zY`qOq-T1J<;tdMZ1ErbFnm7!$EKX=Ov_X*33-jteBJ*1eg;eu7oE8^oVhlUhdTtf@^^$vue z(Ig+DjFB@r|95-rPIaR2`EuIXr92Id#?R1{@Zy20rkK&d>3?NO zCgHZmHrvs4KKRk_`oFQ>mM4as@LOk5?uMWDGXtV7oqRZ_G!GmH{Qqax@j&i=5mIAG zZHn;6TK>{+2DyEj_+WzM+Ux3FUP;AjO(TMP&7?@ScJ|B2uvB9OfxwamGq_b}R6Mk7 zE~GYj{z2fbe_Kul5GOx)k`t2sIxx-|{!7;5IqyY3-Zk~>ce&FbnHhv=iuxtBnRqLn z?G_bHfhL*!b9JsEg74RN)og_&Z>q<0ZmcBh0i|L|^TH#o4*wlWYRY`NR7%Af$Q z8MIWchDhdEjT{zs6VA6t2N8}_$>@!a&h!#h;9|!op@L$lde(JyP$F!w`8m=BaT%`>qu~$tliE~JZG0B zB2%s*xT^Eq`1E#9;Wh-(R!hkdZO!kCLXC|(7p5*wUp4X;JCRCNfgMXO7EH)clVKCo zAL+t>uBGtDv)|*hzS{8ZkwZzjV$@eV$c|tPSWpr-9*%u(8+zp=<4TZg&T|d^hBMp8btR3H4m{8K;cVYqTcK@*%DtZlUR)E5B%sY ziE1*}ItcB;(DAj&&Jc0hMSqT|ZOoOd&%v#RHLDdG_80=+6ac!iU0o5U&tbE6{{T`z z$6sB$Wu@SZq#hA=Slz}GmgVi39DMEtVT7&VV_vcD$-c=Qo-mAX!VgupTmO-BQ ztn%^|K*fzE4II5_so~YIp5zW-7{K5wq=6Xg)uLVBQKU%;WJ>tVV?Dy@#mRGmrU6+% z3@)|g3{417q$IQQ3yjj~?DMHpL^2U#v_W}RSs`N4Po@8^A#G%q)KtqJD2xLwh_^R` z()X*_16A=3Q5hf7^3X-i@S0?swOi;?u&0n)Lj0oq+AWWIik^`KE^>8zHexbh6o6CA zDIBY0tQtS((EUR8fKwWyJB4#WpZ zOa&?(oW;yffijDyf;>shBdWby$`7Md9Q>~0yNA{`a;p+kjPr>Mmk&?}+lH~76yvC1 ze%JEm$9VXv`(((>(h8~xdl~*9IIOmZT>>7%AcrZ(6I50yAkb6Th;z`vS+!dHNf4~* z0d5J@C|phIY7EBpgg#dt1+VPd;c?_J!Om*prth}x&a(aK8IkE)of#E-5SW4XPrjbl z(X??&1S9Tiy}WOX z>ESg##$wEg=-YJAUB3}UvQ8y!E9RWBNmL`fZkWTq3?IbZflmCHu<0znZz(t%bv^Tf z15(goN!b*MpLkb-^8@Wfhx2?xg{h?Ml*WzZi|ym|nFV)fe=@DpnL`_}*KN{}@U-Ld zU(!yqD1?>v_)NRF_fO9_3U`)?p4^1Ke)8&P==PtHQFIxVZMuzyY8DN z@2vX8qHo7cNBer%XjRxdKO8SYJ?*fk`M5=g#S!DromB@9cXQh7oJ|k;uuLA3L5z`& z7O>#7b6h^UG~Xs@_lg4#8$Klp;3|T*Sdm8Ah3uFN88z&M1_*n@bTr$`iEuw%=(RN9#7rHrw+XkvV;Y zAEk;}eI(NxKTCz?tLLg)?en?ZVRk!Bi8}du$|Dy$7K-AWMR&@YYFS)JTP0hrg1v7N zHXY?Vnl>GJ;!jIxp0%8eE_f{#7xEpG`W@5id!@`@It+IpyC*BVmu0V{c?2-s;*sQ4 z`z?clux@sy91s0k)R!$`bqc*#LyQXn1;rwGfr*YoQIj=W3$Z8D7hCDU@wpYt9Rz^;@ zvoOG{i8R4jS}_X+D>G(^wR;G$REv}nW1|n}Vihi&U{Nulz7)xx^hO1KRz1?7$r-*R z&%1t^*q^>tX@D@A8I)=a&6SbRM9FhPGuw!&`5eiBUb7U@$cDBoTT(&3!;Zp(oCUv9 z-o)io4#87slfBAwNb;+rA&m>=A7IH@Em_ONC>OLLiCly2X^dq%0mu=s$41N-9N;`$ ziv$%rw%8e95W_`U=CLb#B2*weGw7}ZUlgBf zt9=tK=L*@HqX+l}vjV78w^>8ly)|xlNz5%feG5hm%tpC?>p;pUNd60k`N;z>&yH+P zzm{tgRQo>tn*0FLeSZy|eywk^DU0m-}lr=IPy zP~6Z`xucTTDrh#QH9i}DS%@_Bhx!<91p4Szq7vSHr_X=dVXMV%DmM?uRQM%x%YyXt|W)R+??~ek_tI$w_68BeISOR|Q}2*InaJlXdbNyy+#zSya=%yVrZhIgJmVt3T+po*ud# zOh68$H6%2Y?YIKm`aI`Sk*E_9clL+!2uSwjQ$R)e1fWyG;r02wt4mAeatT1|i7@CS zHRWnmUuWp+o;XZz+tUhM29JN3=N*_OtJC9CBv!u8(Y1r3;91`Z4=all0KO3755)LS zfW8R!8kPIUIC7ILJkz`7$|jiD)pp30QIQ*V=WHSCo(K(O0J(K$5NhSPolRov+_1fx>?o)=W{L&j4)l|%K6NfQVFzritMV!h)?0BFNh_Woz z4tgnqx*UoB*2AL_VM{NsA3o`Jz5Rv2{)FB^hKOEl>uh-=@pvfp55>Kjs9q7OY}sCo zPZ_Tm>z*~QC)g)$ELVTP25|4XIMM1Fu467IM7&#jldzm1_e#!n%T>4E`a_lw+ZyXx z)?8sb2m?E^Zc!Zw-7aA43bfPugLUicd2A}LL~7*thB#|LmY4k@&MJ9U{kr*Ug;IU@ zb3;FCeDCpn4e5(EncTVb;Rv$N^-796g6vz0GHz)<2lR69I`VLZS!vfTduq))T|J_Y zm(PRM)d2J_3qaFlEX%PKioJ!nHThD`>X==6Z}-?st5s#7v)q(@HTITt;Am0t=|%{p z5gO^A5k=(WeHC&Jj{FUt`nvi2ydlGXb@s{NV$R00=Xc^E=L{!GbA3pBwTpA!IV(OY zo{!f?U%m7+w&|mYc3kXCGqM(sKLzdI51lG*4l0+^&uZB&ocka>aZ z^6y!c^k?Cz)qwpar<8!P7a}7`ei4$z5poU_mo|6w9{Rra*L1Q~5={IM9cZViVW~3H zfIQSve>=O`wC{yp=U#k$fpN_wRoxwXmu`w|AY4AUQEta3>xrE&={_e#ZyE6k%{RD{ z<-&bHjscYQwd>xXBh5J_a>sF-85zE{b$xavq>>2AK=sT!4l-ckF0dvE`7i>lfUmztr5$$N2Ic4YUq z*q)?>FjZc%=?y($yb=6my?yuFU)$NWu54Jhj~Yb_TsV@{o0@n2J*39yF}ySnnr9{A zmkbFD+KEN;%mM~W6RB@B0JgMvpv^a16RFjXS5JYan_kHj`V(AUH81`4sK=Dc-1vaK z2x~@B)VJdy-n-UTBsEY(Q`EaQ_IA@XqNr44$AdLI)?fMK!It?SZ^Gp`QE!97Sj>Ei zgyCMcxt;MSp9WGS4@hpt<3)R#Y-#?M!+MuuY2Ct?H9m*>!K*|w_M9sHd z;e7GZ$i^O+dEtO@XgBcXu)JO5$IEgjKbj9y=(9rnP>&GXpNNMn%3+>n$X0Zs z8I?1ITRlo+u}f3c3CWkhaV+v~d{Q^1_6@dKi88$ADT}rk!9jcsUdf`f=6GW_n+g+( z2~$(=?L-gIw*%!Syh1o5-T-cvm)lEpy_9PjJ-l!6zUL%S3tiXT6e63t(LFng&Tm+j z*$lVarE->DPc-5)nr?Y2*r-+Kg*WmpXZTB@OU+;^)r}^zhAR$PB^p!7(o#2}X9j@b9uO{!sP)f=Lc)4(BtoeFuQH>QG)=@y4QEr;g z+C^deuc~Sl$xNQ~FK3*}bJ#(7!n1u#Wn|AmZYTg~6X38QLBH9Iz>iu?6TszErE|#2 zPa)I^n*GBjWW|BmswHyQ^l=Mv?w6x7Q)(OZw)*K8;4o6byIL>=v3Gq6i0z+$I6HBr zx6d+O`d|{N+XRVzJwL?N4Ra?zJm?An+g)47w&TO`HcJQtO!Po?x%?8>LCP5~10T72 zORVeHNR#_7sX4)5eQR=D&LDrR^&PL_MU8M?J74XzP*>15?RUAMqM&b@t=?_0Cd266 zX!G%YuxYkQO&*dJMG2nm0d%1Tyqbpg(oH+zu?>r0_rpbrZJKxU60vqdu?*Kh@@mQ( zFS_4a?h2zS!i*^&B!s!rRXgS$N??Gdvaa|21Cbi$gzgsK>{tB^Lca=F66zj`7aZ#D*KJiz!EFmh@jdSw%dk(vijHQqPFEX@zCr=$+%(N{ z?C_^mhb(VUXtS81?UKSwXXYyxJd7&1+@@Y){%m~ z0@t&ecZdzdjrm!=wtTIbQr>oKyXiw{vL#!P$!_5Xaz8)~zPz&w`rf=^+Wg+g|Fo)^ z#40eXl}>V7Bxe_mW%b6igXyytS1G(%CBs3k^J>w2CvUda!^Sy?M6foN1jnEiHGo4F zK!{;!=%%n*-8yb-JuJ^Ah*1(6*z~N{$d5mk_5af9(;7}M4qcz~oXeqAmUj|{X1^mYoCn2{oPyu3S~E@g(sMSYwIYG}}ov z2?~08=ctbW*5$e*VhgI0o^t?C<8Kuca+ISCs?bWy4%Z$sh1Ku{t)^{P+)(4ct0{5o zNc~1i^d&4gHSg;0bS-j`Gkrb)=Xo^T)h-FdO)-RhW-SP6uTe2=p^9zn)M9AxtVo&r zsE3RTk#Apz-f!P@_{uV?BJEk?-3Bx2E55tuUB{42@Q=!Uhav^`c8 z9yT|gqK=R54N7dITj}PNa~d%wl@^7o>sIDLv)|nbfjYZoP6gz6;azr;<1A;WJtn6p zrR!en>1%4kWQpy=W&cwu{c;KsZS6SihE75vE7%8cxP@oMq>-?2CLOy%bvUHy*=mZH zurvMXR)+}y;NjsenLIB8S;k}1#8OX2>{B9&NZTh0{v-s#SUx~tQ#KzUcJjdCPS?5$ zYv(oFENB!tZ#$diuJO3gP6F;RJWxy9+Mc`%RqXSid!wDj5mHv! zp)b|bpq*3SR3uFbRQ>h3iHe|nh&_*T`p0CImKNq9&&G+6Qf7@aH9twhEb;ji)DlewN!6GL3rTle+;q*=$IJ zkarbkPV#6yMNpy6*xJKluCDn@B2v5%khLYbJ4tON0k0E3Bziii27kES-9|Q$rEyoij2oUId;j|8WNTAS? zI$}+iUH(B-m(1F&B66#$zO3!vVJ7_5)&CJ>Qqt329dFxhOb$MTb|OE8_CA==sa-QH z@(!KpQcPzVI1~IaM&VCqik}+J=*$?0#Mm|m`_2?APaB7*;(Ur!7GXYTfmIu~O`|fl zH|kbzZ3(R1vRDmpVBuL{f0SXFWZ>#8@$d&i*Zq1-X2_AMan0I2@T~Ai{1#EQZ^TEn zmKv@rR9KJa6-vAcN+&-Rm_W+=x~_nz4<@v`KMqo$azkhtgsoR-_s6?MajH8tB%@t< zBFdM%V>e59V{}6eJ?R?t&ZzAG49IRL3xXJps!fI^P-0mlD^Ojd(2D_mfa_ud%@ikQ zyD!rjw~cVl6sQ62uFulecEQF+L?he|SS#l*9$LO;=)r}WJ!su+MG1#Z4Lb;hU_LQ> zoUN{fZe#2?BESiiLaiP%Kh-u9gEfESuPzCfWFMlE6fUY~F1%^u0O(k>a~RFFudf zh?xb<0;2i^vv$R*+X(~;LJpV#PaY9Ae;-y&nr5LCeZT(>TucAs8MARPB02-JSMGy- ztZlIdOTwICUibc9;wOJK++d+=78ol{#&y!A=$gN_Al4r$!q`+8ba}S!6jaZ}v>PUr z%46)RHXUaGdo==KnHS{29)xnQr2rP#)CUl`G6zo3*Iu zn|I1%3ID{uWGzRBeK$RNf1cV9toYFrgqnmOu#F(Jy#rYX0I}AgtFO?d=ZXEAJ03iB zYjFU5`Yj9N)C%SZ5(jZ46>n`{bNFm6v#z#V0WI2e7Vst{f zoUa~XAr<{vy~^8HpqV6&Sgq-oAK?bpgez|QPeFli?*(;?vpLIr`Y5LTy*XEZqLXFT z^c@^MwsbAyfxYd>kx02rJ~lu;T#}b~c&CYD$Ljy%?K{AlO8R%dUDvhCA_5|96#)?t z0Vx6ryDB2mM5H(AB28+55Lj1{4$_;D1q7r_)%;bIFd4Cn^#;?J>=#EH24OvMTz>x-QGyojw_4ciC18>r~ z;Hj5$?W*i=cb1yPnvgBCVduuE0555WJU|!M(tw=F5`;-V4IN|)<0ANq`t|#iW#?6= z3ChkGT7Rs_3Ba_SyLRKq)a`k-Wx zxj}ZoPoATZ#axKI`1Fkm5{W-iexSAobZavu7Rvt4dRbO8#gDVD-sUc#2qbnm-n+8R zq(z>Yx9jj@i{rjHOU%cW&d6NK9&{oDy-GS@p#1dUyBk%U@Fzm{w7ODhb@JX3tM zn44FT{ayW(J%f{4)4{kd&G_&JuHD{r+^~}-vg#6DQdDrro(ZIdmu266Jsi~O7&Bqv z+cTxrE>Z3S0#|>W5bbonY*=$nwJ@gz$A*q7>^&r58S!S-nGFT*H2dT1h97VjWCMmy z0-@~!d%B$)ntlB?jsl@IRXdCtvV^8XRs!{hG``S`=#57RdFi?B(HAO}gR(085+=i8 z9n|>c)9OlXm;yU}*Wel2)ZR@%2l)*w9h{@JF8Q@Xnd)$-&-d~u3nfMGiObpE+IewK z2SDf)=Fm~RHT#AMqok&Mj$gpPXrxK-RqkbFhh}h&?2iXka*|+UW}(IBu$*8wCv~Sz zfcimi@@CU7titEzCOA@M!-F}Y>%{{?t!$jhUa9>HfAC};Azpi*8^UVi0D`HKP4Y5jKftcJ=%cg&aEZe#`eF1ruieQ_yN=-> zrmaL9{nu(0?uG#+XQA7VSH4VHDf?LkXvN7>UWglB_p+>?KV&z%uXN%8?7w}TYw7M_ zcw-*8&+bQZ0U9z5>4~GQ$tA|50`Mr=b#)WQu)STPHqLkUMkobS6ai(CNr;T z3lf}loTgoAe4UOJjO%O&*Sa16lql~&b9rAXK9BG$jGU?DwVQEK*TeB&ZJHSow32SY zspqNMrA1hoYk+Rp1-n&myyKj=i;fIe_?*E@osaOUY{u5nn9ZNjb+vW1BS4RT+%gP| z$TmvrZJNxGX;^BeKWh$c%Z9Ll$;o>>eAY7N!9dWL=PD0m%bw zeom=0-7dNfnON>8o}V%>rf3&K&QzDQwv6*#7->u|x@oq#9m2TOPJNInbT59ILUA@0N0!t3U~w43lk756M10sbjszNY?mO$JyuEUtW#vW`5ELI zIhpz#ta~u)tgCXko>f>hoLTR6*{S&k%zBTrG5w=o;D|(qeka?iGNp5H$_+LT6DYR3`Svwnf-e?#qzt zob%Wk>DKJC2LQJh!g7gMM*e%n3}w%o%bcw(mHRf3@rmf~X&tc<`WL}2i%>3EPrEEi zg#D6UnH<>VCkPu8s)_PHDvOwo)gNweMYh87Iy@ERQsM7-z#Ce><4NGy?KisZ;)`79 zjYxfSz2FC8og}WgBzBoA7r_#l=O9{a&gETM>J2SmPJ!d@t50t< z-P4i?H=r^f>D8VbbLLr-Pw;-T9vGtTD-+L&!YGiV@_9CI2u|qlgIoMS7f|qCt*ruD zYp>mYLbo5+&eg0>@>iFhU79wfcW-a#c^-*8cS!fi&I3>R&eo*$YU+B?hpTGjC_kZK zt@F{4QB<$im!C6EOYM4+p9i6hIo45S*+*vKwiH3w-ZqsoKQFw$MoU2Mx3f{DSt}hg=cFz6I-kC-| z6_PX~Kin8m-u|{Ds-i8+^t#jOybseZ+YX0L)p}^&Tsj|9=OtU~h4uB1KOE(+V%LNb zcrsX?H-9;M!s{%kZe)2}FSq}@JIoGEJfDD7gkDqak-L(zm(>cm9=4{pzCuj?V)6ly z$l6FVgI}UBv)A~<$lJ_v-H4&Q-KI_(y}pp~PidUr*q%7o7rOY<7tnL6+|JK=H_&1n z7rVciJ+L+SkWk%#aJzMTWcu{jkJevZ4QfRO*<0-op=W+kX3V~2S^cCyRww_y`=0rW z?-qvn$JY4+6M}y|n2iLC5D0q^*>7YS=zYMaK;7Oa=d9{`j^FkRh$!=O;<$Piui$fa zKcC{|4vNr1;e(+&OR5K3>#4>B9q!(V-!hsuUo<_CwXJqs?E$5Hx233?i>sbU#3^6HSI-XNTiku=0l-Ntu2Z{f!o)A&*<*)l)8`e|-pR-+oC z$wt63A60}2uP5N?7kM?{$JQaE3VN0bGZhN~Wk$cvT**07|Lt3tjz@e-yhD}=oPY|LoI!;N`k1SR06laVXQ35zjIk- zW<%FqbVmpsMaY(b#)aC=mgttp5LDYw)>|np4X)8@mKNpbVFDPkL}MRWc15!IYIKRi zo1-Nu(lBn^dHqm065SGqjN{!(!JX%eHJKJB%JFDLn z7*!iRfVgtk-D#SJ)EY;2gu8pHTC_ey|(D^*}N6~A56P_1wo>~03u zJ+bHTL1?#GcD0vHbb5YqtYTSyr!FRvPFVGjms~~#DJ-t9?pT;>1-e*VMB8Q=_aq;# zr^bHK&Nz1=r%JjCSSLXZL1uM3_LU-cy{y=Sy?dza$lu^~Lv<*2qR+HVI4RdL@Ot3^ zDI>--`r*S21tdmy`DwXjww#40V#bCe}>3Z9It_Rl-NZ6K$VD z&rjnR6U){;VW90XP@Ng=0bzFDbj!Nan?4cRl*U4XV(Zr-Embn@s__mnkn3mXt(HJn z$#CJ-bSHjwcjD(BlAdR%I6B9QIM2E?UjozFY+Obm_DOKTlt6>xEO)MiLLiLV{rsY= zM6jihysD!u44QqFpwylag4=y*T2|JC-Z^E+d^3!u7o(bHckQlBOEMloa{>W4qZfuM z@Zf>0&fFVS*J%EB0P@s054`O3lak*f8v>TN^xA=1bFX(?Z>5Hf?tfy(j-Ucf; zh}kYq4srZWdLgA zq!;&$EP}t3cp0MC)>D`{bX87mqla}o;lVLLc(ZmOycxP|SUCgxtFh0Ub;xwoPuE^t zI9ZQ=mGZ(&>)c;$eg5+%%!3`OnT_B+s%-^_4=kP7W+{wUUt(OthX4Jfu`ylywiRH6 z!xiawQ6VM+{q3!#Z-)?fgvI`iZt;JZC-y3X_=|FF2%ZAkS!-G>dH(;(wrlr{iJQi)bv}-b**)? zcSFa#g_NYGZG+Z5@2tz%sG}A%1S0K>gbZ_^EXEf&eXMP~oVX`zqv5mf9_P$aBs~>_ z!CK+;CF>?Nr_p;&%M#$&II-j$acnccD0S85N-@sip^z$^xL?kA$x4IM0*vy+sD1{P z!W072p4O}@R^i&2(EG9#B^|rB)7ZKsFx;p{cv?mV96j7P6Rc7vw6>bgs5TD&jO;iw zt@OU=YMH~T(qnf~h>hr^a)x_n=wHkacmj3ApoMxmv3O916 z+{Zd#D*Ror1_IhnA8&vsLkgBu1r16cCG zrKD6}wMIy9;T96wueGYoLirgX62ofd0WmS@bNA+3W(6Gt*1jh#>=R;X-AqU4Xemu% z{#Z&N*NzPg_f|X-u@fn&xHs#*GViOa`m!DYwSUV8YMh=>V$!DkUW0#J-wVTaMmuE= zq}LlXcrZ;m>mYU&=lSZc75&tI^3i=6Cz*wjKuv458$Qt30;a`$l6byyyXJKkG z8NIJTVKu}a!2K^?)&njqeaOt)01>o-jG^)Aw(d+aH6vPP1*)gCbng$w*!#>|GJO?# z@Z=&04?V>_g3mqN?NWsR+apN*sZM0B))or1hrVzEx zD_Q6E=Jx>`BC^!wm#n~j&oNZYH=U<1A2I$dl-6g95%_oV)c(xxlEyDxp7AkF`b0zC zrRE{;7D+PlAaY{4ZNLagdha{lLtzzcIGbgAlKdgXyDvDi_yj*b_|y*?eq>@#`@COz zF2ry5H@a*1CmBhW*1Kox-)qNO<;=)O4Ve336&;969g{j_xy4Ai4AUY@jxxg>Vh|*2 zq&r2U;G|7SU3pjc64tJNAcWl1OB~opCI-=3dTp8sR!9_xyt~RuN*f%OoMEmDq)znB zz5hr+B#4~%A2D1!=N&jEzv+*+(1r@lglavNOesy3JC1cQ3xp^-A4zPEdI<#AG=_<} z({0>Q8JL+w)7tvOi@49gPa_Ez*uJjn+C>O*AeDxQP9|H~A&FC?H(U{n991O;fN&^R z41KCl+=2&n+OP=+x7amHA=OM5tiMU7aFe3CwY3H5`^2#G^CrgF<5_IBfucGU+~8Vj zgwj2r8;*M!W3TKTX98>kX1zt~>2ie}*tZ;Zr#f%{XxkJ1zN<&DDz5~Nk9@x0H~&ai zomBxLZg{U0(|)k=Zs>}}LJ3obmc5rL!*gWHCP+l436G$h<(M5=DoCs(w`Uj21_WXn^Z~1m&(*@x&kFE#!Zoa>7Rx??c&vd zv^=j|MGVbime94N34$Dcls?FxsT9NBGx(IyiYzThAv zZi{;;kD3C?3vbf*r~UQkEp~TW>yopW!Frz7!^c!e3Fs-~1a(s(dd>{#kiD&X#cMM4 zS&(H;$#K?um6*}m*|w(o(@8etwt58KG219c4lN}9ZQFL$Qn6q94aHPUS=*b>Q!=1( zOa2mj=)Oy@5z}&79#k8LGl2{bpg1P|jpF%AREzy_E6E__x^D~+o6CTa9Z< zn$>Xoom;pPFX)^KF{-9N^DELFwXGOkL^_SzZqE565`tq*T{aJe7IaCb%TuG7D zM0|05K``WPj<8Knd)+g{$=RT;ZR1hC>D4&b{$pcNw_w5deeJfVJpBx`tcz( z^GTLNBd<3!g~5b+e=1|s)+OwOsAL84*uKI@D0f``hfwK(&>i|k?#~5Y1duFOa3-)W zw0Nfv=pw-GFZH9_phNAApGQ*XM+Cxq#wj%4DC_+(0IE0pWq)%q!7|n5w*EFEgQXoN z_w9b|wfzE|>Sv-YxUebxJ|OPnv1F%!WSI9VW$dmSz}Ms zkHhldygP`8$+BL}ulYufA)mZNY?59E@M$-FDh)air`ow0L?Z9O3Rq)9zzyBqlXR!| z#;gFsscK!9o1xdh?uYl1@06`PEti&HORi@0GmgQ|))V7G?lB~IZ3^3SrEg|by_4&R z_Y2(5dx3}&V~7EWMeQeW4^S;&mvgn+7W`AM@#w#3QWu8H4gqmG`@h)d>7P`uOAL5Z zBM8S5QEas6=G68EDJUPN&kPw_ynBAtDp};jYsnQ@0$s+uhC(?en+O1y#MnhG0G^ol zf88O_YLIh3r|e=y3M<92P8(1MdMfp&2P?|vq##r1)N%(q{Hqu`j88zefk~na@W`r zw_o+ys?XLyOPwuVo3ey!2N*Lr_Qs>>>_g-1wpxBY&ITtv((^If6SVQ7b#^}*OykbO zWki7cfluyGxR&tJm7X&+_!KQjW(}lZowIPllo$pp5~?Gg4RL!;3T8LeV68QvKNHSs z9FM-J=Thm;yj`=g2oAz_S|2n8^YRh4I?dKAs>J z);rU7-3Z3y*oHlT9oOdF&=P5~Ukj^DGa5}2p<$+H{v;9x*HM5PZVjOcUwpY|dUa|q zEI@d<+A_3E8I~F!&4r2NI#8m%-o7%|?ladeTosq-iUzbyXT|aChyGdR9;hiFlL+oL zYL9lkz~$IOo9m!1;@6g4pD~})mXC$r=~H$OvFnWFoBhoCtzFFBC-nYY;`msnOoUb* z47EuE%|Dus)?!P}PDE+R9dd_uqSi~fTvyw(%GiHP5B`ounoMc-1z>5kQ{8+7^TnJC zJ3XDP>|n6T>G?fPM*-9HHvpnYos$#g-i0x5H7fP2;kP{Cbk+o&(&~&NSMIUfJki6;!D7b6*JGa=30oBEP>$#SCT7(~W z;eqs&$4FoM$N`(cVWt|XTtJQKJy%)3oLrj}VQ4;kZa-rE9Nae83D8$E12;Gw+M@08K5jc(3VQ1E6XAOmNz6e7NQk8$WH`Y_kl=&VS<=LCbf; zG!A+XUv%-eKEadUqV2sa_iu~2U55Yg{OgFp($@e6wK(wK7=PojDs*V4dHS;)@96AX z^m2(zF-xjh4`eIYpUaRww%{~wQAUM)Yg8TW_)b{L{`Ag8+Kgc~C@9)X@H5(JK$sVL zey*2C<#!FLq9X>xh6gT&E}@4nR?SGnT2-x54zEoxzRoqhf zO8a%BN!)Nv@bH%^W4Gr=Zw<&&75iXXSlT8(m?A&(sVn9*&(ITQFHf-MLYqwiRcopp_`*}7*Ot8jknVPZRC#u4HNOWx@je^%s~SamB#^bDctbNVISGUCP6k3A~`wR9P~#I2Wv zB^!z(0{C!DNM=+m++Yd~BdYpg94p#p1Y~%-_Mn)Vy>M%ujcfJBnJ8AdQM>kKnqrG; zj7SMQ49D(@g%W<@0q$Hyn{p+p^?%wct_R#!sT0B!>Q>Y5_J3Zj}7kVJ% zpXdSd-|2zIKk0#>f1n4tigvs@?yh|hW3aOJE=LiAre5pI%S4RW%hW9*`OQbWeTz<= zx9NNr*BM$VGyM*qcm&~Cc6)jx!b@iIG>K930yMcE#~Xe7VtShKbnri|y_)6<(y}NUco$nd7$X#e!|Acs2V+UFA#9+1pJ?|OJ zTf{CU!pMBbT0?dbEk-!23J3yHILSLG?9>ROi^f1)TnV^xp?=w!%6sis0KyhH7in5RjqP8^b$egrUM5`5CRqke3xMhA zkJS2|cMnI49cMG}_sfQdR~2|AbC zEJ*Rbhns>2@e9zIX((b|A9@b;bN#YE32H#{lPT)JW{Af|6#zLV4YGc<{{hts4srZAq`xUmlOq_JchX|al|obm}?eV2JP)p%`6vsVCG zi3ovbYx+j%+0=yNt?9qrLM=naz&B1+@|V)P%|`_t;q5^7ZDWlK0IIFoKn<}E?;!`fF1a3fexE%Nm^k=f8%%at@ zg0+jl!z&Azj@OhHc^L}#PH>$yg_h}_HBOwND_9%ESX`PrTRi~H8n_G{es_9bj41&~ z{J7T^o71SG^ah$l6K)BA2x`_G%HgU>a)c}UHfHSyR1ms=*A2X&M-MO_-Yv;x20EgaCF+_&h2^()?IB-vqcQonFj(p#^{|u zWxF@H!8E{Wiu%UU{-3J-vaUYm*mfrD8Tl1on)ooLhQ2WHsM@dCWPviY*Ht-Kd8SUV zf3Os9D%gn8R0jl|)W9I4J>qD&9)jM-_bO0VsR|s{Xt_@n-Laf&ev%_#@>=HoK3F~; zI=b?pXRLL_kLXo|=n@aoKwxI*KLc`69&y76WZmu2tf<2afm&4CN<6u6wM~nV4f6*N ztq`Y`p(Djp@4;$@z9q(^GP@BVp}rohT)MeukUto{hdf_Nn0c68sG2pxifYMs-rCi( z*<0HgT>Zd&jH?pIR8t~7hDfEW{TortH|vp=0f0WVkf1iY0p&_mDpp1eT~)l6`YP%T&nvnn-FCsQd{1Yqc8RS8 zb?93@(1OY*BEhpyTXz5*=P;{XZ0j@0BYqBOu%RGhQp5W~lv-9Ud98!^C_>>lly7_c zg@vEZ(bIV+p{n7Ut6EVJ_T6YvS1-=ko5-plx|pS_7A|i+>(&}f zKUGUuO| zy|QzW{2zi8cyX@$9;86^?*Q#uZs@*sj;YY@#`JzRvX?*kCcG!hdGYzc#mSfj;NO&> z>L}rM!60E1Wf*Ana1_g<_!iOEm8NUfPzSE(c^6ccq+fJ%$vpW|F(qB&rpc^dj-;Sj zLRDtL7=3Vun_>v7uyjT>#aH;bQ4Lol{L!RV+>P;l?vOQ7IWZg11d`lTV z<~A8erMwC43WiPTrT+;1O5jKFeFg(|xUY@EqmmxLCgso{`p75p~A=tikFae2wo>OBoC7lT_DT zPl-s!<|+kvyWS$btIfUXJKAi{kGTrtKRr;f<^wtbN8O2g-0)qFRS&q!$5`mWVNdL? zF=;mBIwbXopJYJAv(lCAZ#~ocp|2X58ntREv5lBi=_0^28Qm?{(*{lG{3xUg6)z}8 z<|@Gx0yuV=rLI|?4$?EQGPffT-SL5XnXx=XuFxB0PHVsj&(A38k(;`H#^$C$(PrwE z3TB8~s#NM_ul;7qnuvSogN4xMeUdCx#waSFZVonv)|Fs%3o(ylC&)c}MZH8L198Df z*Rqx1Ba>@IsHK1sOd35NL-K(ql4q0#SnY#4LRZp`Cjv7a^Val zpIjGJpH^g4+v@RlNv-fx?!Cl!73NIa0cK&3+#~jxnQ8Ibgc-w5k^4q@yN( zZH|6C%7x|~xn}4kJs-`Bq0MXEi81i&Ov(}ZEdTRM=ta}rdpC-!yC2@R+}`-?q>-&7 zAb+9CZ(I*;1`W$8wNDK>NtRldoJBwGG__vCe?uBj9W}UU7SpOzo3`3ADhoQszk2(2 z_gg;L8Ejv+hH=E>%be0aY5nOL_V1OZ`pf-&;{mVd*0R8wnfmRyQrhm@D%U5LG0_7} z79K{^cd2UodOHxE&WBs=O4||2@U$zQgx`p(Fuyun`~3*z7Y9BA4HGXMUd(czZrwQM zlB^%0|8@y+I~Ud4d1xZJx#4-CjY2VcFR5jHw)msyZMoU2dKZf459i&2wKRp|k)ek5 zYNHhUU4?#-W#5M#or?+UTJ~hfBED}C3ZklIjEc zfSOhKe$MW}W+d!9fuC`HemjhsJ`>x$3VNm@;cWWB|xcgXXy`lk#z0@Lu@S6j{LlEK&mMZwpY z1^+4+_*WJHGqOLICUn=yt#I`7I6ql@(;1$kkrwE_z~brEiRjpA-dXM`rU*?k?XF|r zL>C*n_`7?Qz6QZfx+ zH|Sf1lJ{U9gb@KNe^uSTO{wzrGjgM zBh0hS5mv0ir8c5Vf8a#a)vhBuKMF5A4}Qh5`7;c}aO+Bl-NBNz%aD z65p4sWaQY>dot4p7x{zWDrRBfyDD@ZWB0Px%2SJbr_(UCbTYI8rsuPJc7R{SKknBu zRyr&PW_&hMZ9-2F7zYW>-<#Tc?G8V@R&J1Cy7i6V?O9+AFH1tEdCYd1!n;PnrOM?a zkM?znI7*l;xgiw=2wvG@Okb6($et4y2c(W7x=j=#v?~OSU<@Gh=v4DanT9C z)x9+{8#9C2kPno0UaZzB&yVt2iqja7>9*H`AtrFmDod<*$I!&J>U-^#muBjzF*){G z^B~z-B|+_vm8&psm0FaNdp({8gd*{bKZGsp?vj7euWh!bpgr%dvY19MjwKJQHr=Pf zy}Zv|cusEvJhHS#9m~`LzYrAFW7QQvFf3PZ?NG4r%ndVDn=zl^`*dQtl4!!2S~1Xl zR~13aQy+QE^89UGZJbBc9z52EjHc^V)yb^p`0_9zyW3#d4gH65M zti>UTMHWX_RJwtM@#4hwo~7kl$Lc7of#Pf?-arvT+)VDDt}H5g^Y--NR*Rw~zmr5( zb?*?kz_7Y+1FSwyMAy--uNUDa0vNxf@9@U$NoN+<>YHw`@?3l&I|3=wyU%PS|yQ6m9HE)?=-9K}9{+!s)SX`~s!s~F^z+JWH z2GHzJggY=Jtma*_2jbd&%&Jj(800y`oFSkYV?^m?&D zP>;l2z2MF7WtmUnP4xv~4KJ=U-A>dG}* zKXsAhcB(8Q%<&28tVjQV5zsvdaI-#O}K|${bFtlMNt1PSta~W}FR9v@1 zkL#HX4yIMJ&u*&^-KyDH;HGt1MPUzaqT^&^$?ib1IO_=t$_vMXd-P%cbp>rud#Yun zd|cRwGZ7h0BtO7p* z`yu4VV+0d=FD_7}#WMxhGdnGjV!fAo<`@qU0N?;v~_f*1#z!S0i0CbHCyf z=I{M9Eo`-5#N+&^z9k~;XIKV9j(m!BlKpY`qc1xe25q?KJuKS`&j|?qd$!-x&7NBi z|G+#;SdOG0Y3&=1_9Dj;Uc?1J{^5N&Z_^}XpGGE&_+fgjkS%I=cERC+_vG$WC@Ffl z(2`VXMLA?Ei(#dhJqfJ!0MU00S=hd|_`zC;vmULcwWRg&U#8;!y<`5~591ekDAFy6 z4%3Rr#=hR{8TYlP+_y?@Tb9RHgCZ29VlA-4Fh;Kr22G47{Yj4ChD<5I8{?HBm!`ITDEKQyW*q2=V`&^mHpPY77dtPF) zGug^mU&F1|%CiYMDS8F1uQ3-sILsIOHtc-AX?x=6u>J5^Va^UJgeY>xkhji=bG64j z>59SMu!|*;8U=(OuUtWX>pYdx>=9OK!PzzQLcrpae)$`tq^*&6cXyJt6mia{jn<7T z4U8GTd_Q!G-vQV3VJt7BQ2xqnSm`BH)sV3Oim+qVeh=lpin;Mi7mddiv+ROCf! zi*Lzb@&7*P)c@hCkG%kF-3nZpyuCE#-jt!{AJT;TA}?zf`!{uG)kaSiqrXb9E$C=@ zzrzTx`=(^T7HEG-*9?fG$FKB-G{W(xquc)!Ll2c)FI;czVYS}wZk~@jk6ZqB8gPF5 zeClg-J^W?zrBbD=8q5CT)Lcg2x6coP=q>7n97wJGq@20)i^GB|CnAPrLz}HG=^V*$rl2E#_jP7owe_i3~u6^6Ymy2$ujZB6xCCtlCc2K$8`d)SbRc9ve3xbptvKCN!pl~{p%(0zIHJ}H`nf4)ro_u-sGu?ZD% zEcQ;>QMhpEK4WKRBMr1gp6#XdJXa54q6~|R-X@D)As6?YO~KrN6CE78dhMM_aVb>} zi_Q<1=&xV6$~!9&HmBaI5x(kIax7tLS11%m!|}k1l;S?ZkdP1dJhTrmH>b~xEaeA{ z#|9P;Py%oCcWDYP|2aP>HF- z232rRyD@56EvebbgzTWnaeu3fQhC>urH|vT{EC$UX&fKx{qan<_xgT&)=N`DG+gHD zbmqB&;03GoWL}_G?^GKldv>>P>Vg_$3_s3ZEeMt;^Cz{I!rzbW2dNX{FeSMDZN@;!?2$L{Y)4)BoBFHTufZI?P=LoU#mssta&y&>%<2-lwY{<=wp#jd$&Qjp_f=L48& z9EXK26NeIS0zn)`;}@4*H$tS)@whd#z(~XUc=r-%8DO89@n{ZUXzm^~wFMZOw=-)R zOyzqLnLUZ@O=kSPNqs4tE`zh>P5C;xI%dHciK-db9ed__l9ea4XXEzfiA((}x?0{BJiR`$KSH~17%Ay5M;(oF9*OD}Nqr*f+qJJ^U-l{l6DLni>hW~b?>33_S4|bL5GaWxI)QRyx0G5eIMZyyh zu~cWUq(r{>4FP`l&(0e?xbSqXM5gy>kX4It@6mu(Rppotv-;+)T)TvEBdNsqH_Pce zm8NcM-8YXBGiJ|TMAi}EA3tRD9zgavxep^5@pRoln8)hsO~9+~6bTB! zh;??nfYwii-;B=>ip&nd%w>3k`uSWRPuY*D=Hddwn}WONxLcEk+99$*l^kdN;BrqPYuN$JFQPU9nUoG>X5MT%#f#jf`(p|iSIxh*c_ z)9=&I%RgtL90ePdm9@5Gp=*NpFMl}?yc8b8C%cv|fS~Tbop2NWGZkvzlJwwo{*#KO zhrRb*fttI0T~9Plp||*Gq}LM1mCwdrPgV%}bUU zNMe<xH>{0x+v(6Jld3RI4@g0mR)LbmP_47Z*f;D-9 z?Q3)x_!0fRK|3U3C_c^8c-@GP5tvb);{lx{< zL?Mm;pW@oi_X{Ma^#9xl0V^rSobvP%;{J0Q^(-gJ6;ilY({4oeX}$O_F{8bo#;>#| zN+$+tg8zHONygN*KFvrmp>bCGBA>0g-<}-zcxjSrWbOEzx9ih_Un{NXZdYZ-jiH~K z0Gqx4{4DlewPN3-a{Bj+d36rPqu9 zvZer*7Og)uJLQN{qz=}-LDfFBVQzqr)T8~{!T-EgA`A9~ZO+3p&K-%x&0HRdlf5n8 za_Eo#hwuO^HNB_(u~-7?tJI!#M5DMg{d%bl;%Lz3~ZjKgHv9%AqL^d3) zTdnX}#*?+q**qsCzjH%r@8uV<2josc34=ouJ8wkB`D zurz)lBhWHW&ksf_^kV=9MGuO4R%E>7n!U@1e7rQ^cslVEkpg)9yaBhCv9cdt9KY6> zr=8}Bs_0qu&4^HmjISN#aszm?kQ$Ehyqx>WIH$SnSaHTDw~i*gux!ZKl`_zn^5zkC zEug&};(>(3@dnIsg zfe`nZqqML0Ls=xzZg>RtEvHzn7#=L*0eG6VK_sBj>MSM!v%j}PvDv?|$LduNjWp!W zTKyti1YaaC|I02#%|NffLyk&Yl82Q;_GzKchM|fpYjJSm*_4|afvSs7@UVwNjrt1@ zES=w+L3D?ASx9>)j_Oq1oxni)3#+m=IbDp2@2BPlcTy_!sEz%2vjK3qpi|i3t+lvm zD3t%|zWgF3ada>AxP&(YF_5(#9Ei$=?l?TCr>8YTo&>EAC16q7DFRyW^ht|n=*7xn z*|7Ez+rYx5Ar|)C+2E1+;P0_HI5qw4Off{E9!p(vB>i-F;z}cmuMtH*F}B|nqPIGS zwm{F&qwQA~YvtTyljuGn`mH?#svwsm2U(DeE5$e8Q}2kwt5%{MljbBB-G=vbwh2bm zj>C*06GoZn6ou$kRK&_$wYy28`o49I>&!IX!5xH=DlKoyECl-xn=tFk{WY6dIoZ?u z#Ztit%Z<;QAqE+nZ&@MAbTv#tjgNcSbip!Hu6w_9K}XDIdZ#46^hR2h@E)jIXy-Jk zrH(aHZ&ifzOX#h?XDio!iG-i+DP{!r*-}$Z7LfyXLx=r`A*@~Jt=4G6q+lEBd)3ko zD6?T>qWAk%BzWt3KNsRj+8-=48ExD6-+~isAK~xS_?`F=oyHJrcWGL2wAd zjXk6{t%3UUcJr8{?Rh8We{2%cTW?@y$6mJx&-6-aHkTjLnJ|QuuKUW{5LuC_L)7ZW zg)Zk38+)qX`d#aKxX=q00sKTJx|q`V3@NpINmMfCG@pXp$w^q{MViO*nukTm_mB%& z1GmogRHPG?CZK7}_*bo^8CLYwj?XzKP@PyKfcOl^1ma<{!FtE=|?vUD>+%4hD)^wW&2vv)q%sf>0EOwg{m3i_;(?Oana z{+Bt%swp(+)RTIFnb3h*BkW3@Wieg9DFjhU>38)bC5^fY_{Hsf2@RBTPpdV==i^## zU3p<1i@XIwmk{1e2ZiUX!-s8cM(s+SrleRa<*aUE>CkjBvXf?C6GzQfGQn074{2h1 zhp2t_%jd1~U43IKh7_9aVE_4mY>aJ+3%rGGVW%K;u^fW8d}Xy*)sfEWUT))Z0#T;& zcKs2qRvYxQk=1rYkK-as8r6&iHwAXH_wzSBsM~Z33?@l=`ghDj%h`)*Q4sy zvy%h%$QeuH{Ye#neVF@u@%uLU$j+I+Eq%WhQ32jbn{01?u0E_+S ziv8y*e@&tG+WUH1&8{2BHbuvylU(~|`At}5>1r492ULAHXxHQCj_*HFts2D@9c7U} z5;8s!cIzCy1RUIGkrA(F`<};dL51(4imgssP+C6j3_H94V4hQMflf6O6dexI1hMWo zt$B$-#(PeZ?}g2ZgQT;g8P(fOIe9*Jar@pEvUJ0yu{V$L>Gu@&?p--UZNh~lNq$CH z%!K5nZ(r#&NsYC69O34NXu!K$YF^MsnpUeh@s4FfGjpJIshhDX&4LU^gFVF`yaR1G zzhB2trcW9ZgkEG-`4`_D@`N1Ihb^zYFGAtvOG>W)x<3fZBwCK;dxuv9{fM(U2shE( z)jX?J{aCm(r1XnKypalJ7O`9gg-0{>M$LS(B`cg(q+H1No=_&nKF^i zH*Yg$*F&Lw>zRf3hA<^~&hja(@?cSY+Js3%XNbwVx|KB|N@d5~$1k>@26@$wH713k z4PnTZ&|o2TY!Nt+wEl7EbJbGTRp0zN-=eG<-R%2ID&^x34Uqx<51=ti86ojc4OSiG zRg0al6JlLYO*Ato4k2>pi;dCO0&6$N@$-&z>5aCWyrlIDbQo$}f-ig^atXN!iYY`r z*Nyz7a$PD-sftz_^qY7uOuwk?*e0^vzOF47^^(7Ui{VJwG)|bd*%iRnf~PrLLqjK% z!&sBOzGfm1SL9q@+;g*OPCK7#GiRpR;MmloO*ESeMhPh>#r*HtxIOF6oQ0BT6^Fa=t>-3d!@6R6D3L_iWz@iPD@fg_XNZ3{;u~9&D@^~= z+Wfw!Hn#5@~HXOW*7^hg+WUUZ_8LV(_@$QqOTcF9F>z%i{H! z2G;ni5-2$C$%;SUXr;r7K!>Ts#vV{-LuQ?d!n#SZmP-j;qW|j ztNSgHpe8T+2A`~}j7D;~YE5o1ZmeD-=WNi4!~Hus=|$^J4T#ZxY>%4+Ni`KrFzeu2 zH(N1n)x=&p6M5VGZtG>TL@)Al)k9pFs1b80udTj72J|2lgd98_H~m&#edz|M6jZ7s z18H;?HAc)%gMBL}+!u46e)rO6x;I>3P)WkLiOU}|aH8;N^J`;rtUqj;W!~5v>ywJ~ zY&kCy;VEF!XmDEoqNXeM1egD|JGg%lVrp&c(z)|t^BXBc*`*`BE>bBIxTDPrf;Jbm z4{N%4e&r0dn#aJmQ9%c%Df7MF(td#iZh*8$$AjI^ew}F(1vi0Hw zuD}=zKBImk$zJN*rpLUvZDW5>!5Tqu=d`vdGRASrW&Zu&WFTbDPn`lhB&NE=UGv{R|- z-qm*<9@tJ}tl!ZFyXtpg?h2_tq1yZ^BA0C%HUDzEWe$wt7pHLw=GrKeXeHX82f;o4$g3IKX=-{ z`EPZcZk52>dFtNblr2QY&xT9;v$ONmxjJjBf4o$P+csNEgb3CBk&*q*-^=)z+VFJl zW8?|6`1`+{{O?}2$8ss@%_xJv`Lopju7G!<9)wCvT6?kE(|1Vr^L#(W3E5Rux?4ti^~@eewoon0 zw|_6X6}G9@&Z13B4Ps+rpxZQ-&?RGyh+%^0J4sOH>#6+9g-y`(kP*UPSMWKy{#e1E zo3r4_Wht*DbgHoy@CDM7+F1BT(Wf1q*!=D}rGltt+cc%0|6Iafb=v{4%U5mGOWOnG z9W#h`Q*?%-HqHI2m z0$z2QyN<9gN1}C}l%0^JwQI6M=GEs{U^d<-Rkznfx17~#3-ULw^`fz$kM0nJcgXp* zGw|0Tc+H$PMZSWdmpFEW8Nx_$*hVnJ@m+{AT@whPe~9+-(e&Cn)|gUm6nsWDE$rj4 zPJm_!i<&6~5J$gTplqFh3Q^2(Rj<2(<)xt!(z-*z3hXxACCqb5&pKf&_lsHSOPoIl z?%!K&Kh4(}z0jW|RZx{#LCMat@})kbT=bp^FFU$ff6e=|dBziQYpTa=i(|w~eV`lm zcJ3I#K$#PK;E zVKuWWzJcTRt(3}i=}T-IlL}gHcg8%6*y*|3=zqC(CLCO^aV z_5QqvxpXZg5hzH)aTH*dE(`g#^K&fMKJ^6HXD}8*JpJ&wVvzihCz_Iow;7$ z*`+}B!A)Fo2>$&~gjR)I5`W(B5jyOFD>Y`M*04Ze(oX{8dUU`uLeKOh8r>7hkaQ!y z#ehTOAX6qp<5_xrV2Xdp1OJC>H@epS@`<)rXjTGkakon0Q*jx!3z*S>4q+>AVjqDBZT#M!@P&&XumQ?d{>UzNy~iPZP6Qc^sn# zebVyzW8FhlN2t@a(bsg95LY=%geY8V+<3&QD^<0x^wH*T1^^no`nK^!&inNsK_ALZ z{*DWQ7h|Shsm5ymzkD*~zouA+(EWhfh{WVIZuC_?R429V)Cth0LdIek-v4mowMbhW zrd^J*zqA2(!Q!|nC(<5*nVW!U9~9SzwJ`FcVmc?1cQbG!*qhf_93Q36F@Sb-B^aOP0(2O9+TRSW#4inzBDB?z1jBM&FwMnR^<+ znTXJPSrv<|sD+1&qQMBB_;k++|EtUHQ`<93f<6R}3S8E%M>8@UWoAnVz?!&6ERvUN zW!JG0&h8!-&pi%(8z-{e5BEe{?vq<7G?#vL}hLRLhw$*_9IrLUcUj(w6@f$8!vqA~UO`h$ZQ#(EV6H}5j2+8b2LB3=& zRizo#gsLhE(0)pM z8j5@3A~)fAi=jcED87}yOEXJ&{b$O+^?eE9>+zoJAM&)@>Ps)7l0k!H7j^7R6*ecB zs4>pRm*A5T_pn42>(5dVv)7hc9_hxRdReg`%!_*10~8M9eg#9kYwfmnhoW?MYpe!g z1@IYPV7(N#CVB+I`#S&(YZ>_Ym}Nv+FG^4{F%vp5RD-+y3voolh~4xi+tc}nmrFtA zG`FR=%+y390EOQd z)bKEk>>daKBK9K08#8?)aeOZ*yuF^sa=|4FNc;$xiQ6sB;2kyY$a@YRO58m&3~{en zC>Jj!fFeEM==FdMnk@ov$UhD+*#&2h%Qd=p(e6T!f(%RY06=THKxezAl@eCRq*&Dl$W!k3LnT&C>mKL9D`hZ zZ*X^@4iyO89kE%izWn4To8VrLrq)ak)0*KItMZ8hm+I&HqWnGZ(=Vba+{)6g375{) ze|RmRwZHNB{2{oUj6pjHyJ{7&W@W2@Hmp44?bM@USGrmGStE64c#pU#14(_&kFbEw zE{{EzlAQ0)-IUQBcV9*887ZJp0PdrR%}U2DY4O&`s(b7#qU)25oITChP=U1_C!J=$ zY!7vL^F3Y0cbuhk#H*pn8`A~nvZ6lA?ef`8US!Gbj(e|b^`g<;fBfD#$~boVj55$A z@Nf&c3$ysBt-Q~zS#19!W~_NH+Hmw<8fMQ(<{tdB)@Qd`clHGq@!wLdr*`)!E&8T9 z(JruzrPRst4|=*;ZSX}Xs+*~|J8@OMDw?TB?q7eRCdJ}JQ)ijodUIKIELSJz4{+oQ zsY=;yT9%&W?Uc#3=E!75VmLCrrMZGLZ;wN7(fyf2k6_5{B&S8&d|1CP@h++5I<&rj zVsITeG1GPfem2DYlDDpLYvNNDZT`i`CQDiOudI3Fd5F=;L{G1gt*s{(dm&b8E9D}` z)JCbq!-$E?hL;UFZD0<~;o|kG-iQw`0_6nFdxNTtzPnA+wI05YOsMEhe2=U&2#sD=FMaeu)?Z)V!SL?F7i1f zTW=U|VX>#w`gG<6%O0BRdtR=O*lgh>Hc^4SJEmy!ba)_mkpA)yVb2@tt1ZfhS=AC)<*rDO_4Vz29NnQj+Y62egbCVu5^_z>w__?}tSeuiw% zc6b;|pA?U4%k%Ipxv}@^F4&{P;}lg6sMV5DZ}lM@%J-gwTEl}kzf*lpp%ESXdS?rH9OCGhb!YUJu5qEBw!hB z+O)w=KU`ihUxNE~MzB9W7h00UzmYILntBs#VfzjC$F~m zhai7+k}Oli9m;{OD3}GvU_uZ z!>xv<8mb$+7f1S;An-88BZl#C*-@Zqy!l5>9_}{o{$-YT#czsbjm@`M|MUzz-5XD` za-kUMJr`f)wYGXBqo%Z6pu5LX4EE9-_o0$YI6cxm16jTZ62StcjZ5}5M;mhmd%gNu zEO51?O0FVKV&U<~gW2Z`_D@6JGK7~LcOT>C2c9dEM3ix&q=?3@z9lBo|$lu9vMIX=C~d%Og+h@bK+YV}sSQFr740N4_0{4D*8P zBkqiVlC9tm^&qfitw+q->y$FoDpUMqghSc5DbE(G^vUgVyL}-2-1t5gfAY>qi&~l0 zd=`3!&y&LZhl$^Z%Q{7S6Td{vH*fJSemae%+coo60J8)1^!ojsv%`WRl@G0581jo> z3I=)+W=ZI5wu7XHT9`MH`yEEWihhHS&sy!?Ur4=(?v<%)Gj@i+NNdmVKU=N`T|Xb~ zzYuhtR(ffmxM*_yZpYlZ7o2E03TSj^rtUQKQvG^HuFpo-JmtR}3RN#TZl$!OEPbn5 zf~O9=%leGJ3ffRM>REfj?nQA~nBFbIFNb?sFbarFr)g#-Bw=A@rptG`WDsiaY-w}A zY?oU&?4&gByP#Vk8Cki(x(n2}hUJ{q8I)>$n{8X7_8Ryh(P4ReQ`wN^`?kUDc%vh) zO$TjnV|shW1512ad=?2Xd*LgARk8}W!ynUG4DZ@CAW&;IlGVRRG1hIU1}_&h-*xai z%-92`d78kzUe{kVaLT@%nu3PIPgV8$Dyr^sS5Ys;Do5`E<@Udxxy0}kGb)|P<_E#2 zL^hNE!(><&Ooanko~WsOL-Yf&>-t3B5joQ{QL^dX^tF47rI0p(`ygySDt}Um9QIDT z;bKPgXfbMfp>bv_aX})lArJjJZ?Hy=JS?;z+BrYAQNfGx(xvVMX(^h-N(4k|JXH#f z^izeZCznJAY_6IU21l0U9?ccAr;k1CZWAbY*xhMX(pNUNx%5fee|Hk*jg=Y?jONkx zjGh6|42EcPrGV=<+(pyFlfney91vM8%vz_P`nTQd>G1AP{#~Nf8Tt8iSJb@&=8n~R?06&G{2oRg! zmj6^Qt7UHPCuc4IX+tky2Rz8ekPsZRi&16UsGN~=%iytV~UZ4whVIFht8RT^`1U-VcoEcn4e| zgUyP6lyHlHXjpw%IXL31VD&@@D|7)TI8OPYgI zc!E0hsT=s$dd}6Cr~GOzqp+kkCqr^MDR8!gZ_ubR?#)dh%<27aX0E0sCL z)jJP2@xq1N+C7aIE!>0K8JwLVmKvT3;=p~ow3^$F!}d;eZREAzq0zJ?bNMXUTONcG z&aRG`ot5mj*e8#%&OZUic$O#+oEpg~5Bg0ILU&v2(F)uZp<(k`{iT$#b9|09z_aJx zdsyVXB`|1;RB{T&YiweDBI&Iyq32&@qo0%_8x=e?wsf>!h3ODl+CO?`RvxxTAq!j7 z^XXujRyQb-WQ;3ub34LhsaT64W>s-YUQ6l$?4$LG#2N>gPg|Ns(Atu1Yv4qG3=h!- z65R-0#qF{{35nLFZNHmOfEX5nWWR;L*6wY#4h03whD>eQ?ciaR%xX&~+LI#;7`ZUw z`cv28>77n$f<;@w7S)q3HffeFZsKk1J?g079d|y_@v4@iYi;X3#|LtctvM!8#%@z) z@>a4YU`>H1R?AyzkI+K`+at(O+H(~esHX;BQ9zN@hfQv{3HUW6z;ileUU`X@Zu}64 z+{(CGJABViEM-%bNOQFH0JWmm5HBoD)qw?)+|OmRo9cRUCD}vk4U`AbO+w^>;il=A zgnpNejcVG5oV;?<2u(bw1K8$NhV~L6bE!$C*A~_{r1U+Nksf$tt{SvHYq7qm!yA;D zC1P_%{?X6u`&Q^EgTT{v5=*~^#17scGou<~<2r(AVXtTa%we5!K%r(`E>hcMw^#Yv zzE?5_C9M=J*TZ>+i_1e|@)ls7Pn!h1x+3KIeSbANQ{8vCi53`g*7;S~#2T;eD5#Vg zoTz4FZ@D^9%A=PZvCUPQG~VF}+|_RX@Kc$Xs^$2s^i^$CsTi@e@OPNT`^?%nr^2VF zjK!_l%QKj-Xg~GM-4L%z>onINFhCVhxcje1sX!gqWP%5cUEe)_Xy*IErp@_5JgAUY zBkMPx_2qki{uo-W+{P@NA~$=7*_hR|88J zVO9Kgfj&k*-(iR0ww@KBSEIQXqnBIxa$yzgP~wSCvMFmBM$SdE=|~FoqGEb8QJg6_ zBBFc2eVyeZhK3igqM9+*C^B+=-vq69#Is>cMJfB@ZlY4swt-1~| z%47x@^Fhn}8a>B7d&wYhJ-GjtYn75d9==X`8Pf=k1AF*TPh*_SS4 zczUhb2hu~WvzjIqQHV1>W@5jt-qKSbDpnE89#%lLA?X?4Y}IN zBGk*mo7Ez6=1khd1})2aL8}JO_X}!eRZhLr6EE5J@dyi=tcb$b#GPu5O?en?h?qtN z8OVQ1_qFd(omC_5pXo>?iO<`myy2erJ!aHH8wq3=6ba@4GDsRW|$>>;vZIq-E#wH&dNX4zi-Up9B*$GQ7NwY<_ETizlIJ$ zx*?v?8p2RW;IpP^Mc+GXw$@4q!gjnLyjC={6Oc?QKR9vpOWJ+BAOCgmpAJ9S@NO^2 zmZ)|m6pil|SY3J$$9t+aH2H9mZjRIT(5zzQ%y6~&#JS1xxgl$Kn8+&fJVr7NBRE|& z>vc0Q1#?Yxy=rp%!$;Ql-(!6#=)SbO4f@>fN7CLI-ZvgP4dSZ!(%vD}gR_NiKb9YM!4uT(-bOkJ6Ye}w(Y9g+ z8{XV9wwdVo$qLpX6S$X7HO`r$w|6pI1hdTG2_Shj%Z%?LO6)L%9lg=qflRgH7Ku1dnY%L2c;@FW^xz2vrcZw;Fq zy*-XsSLc$(#hiPQ;y$U4l@kyUR+5XBlh}<|dzIW{VC||P0lK{5*XLc0_nf4I?x>a= z*)eLAs^M63-E~Vo(#xXQMYv&0A0=RKiiHkzkfTkBU_Q6Oq)%n~KXDl6E$}+C+bav` z(Aw{7O+T2}sYd5=t8e-!M~u-jcX0{3+NHHVL!fQqxOWfg-oTU_%Mf7FMK{uDD>WIk ze2p~+Sy~2x^-%VgCW^Nsb!z<$-m$dY|K!E!$eo^X<4qXe{2~BfRzeaktGTjOO12@a zeHay9csH76@u)s@MNjP7o zKCzjCOFDx9knmDEohPDnapJYsAPgGsf=p-YDuo?P_K zg%$t~oqa2l6{=%-%~%f2@`hYJgsa$YSqsHG3k%Fi|58bjtfB_IQQ zUhvP3w3k$}q@m%f4^q4Wol8f^S-~%hrS)B2FC1(yb>%655ebsJXucZ>nR)f6+5{y{ zCwi|9;=qgU^#yD>8HKmRVCHp&I@0gRM?xnS!f*9F8R?im;d%fee@}n?Ze=LgxOXwP z6UR%|?PCd3Uwv4@MDM^}@zh;>g-Gr##Z{h5$r@3};19;+b#6Dl$+n)r1fMGo?YPLND5Du0k`x4v=(YuDgL5^*a$x>e|hixBn4RRXyS}tWd?mA&QEjW(sF+GakzmunmXbBEj+bp&(4;?QWlGCMXl{b;@ z9aI^5%jU0EX1uV;#mG!sb#poT%8R0p?oikgB6RfzEckD^N4L!Fm18<<6@aMzTqsAF z7Vo*gBf{HGGEKFXfYtvb7!lBP7YWD{=yL+jrC!Jl*0NiZ+_)=mkgMfYKRduuQWx}` zWm6Jr8QfG%g&9sjSU8uj-3Mgasyg>9nwLR`UU?ZW{%lA5I;>UvGK*5IKcI`B8@<xkiJv_ZDZq0IPe|)%VsPi#$%z+{ zb8Yoi&NW^T_W2M!`^Oc&op|R4KR!Hbq8<{wJ%xcXw+V3dT`IhvjM-k}IwO3g?7wvC zZ1UPo(#|fqh{_M!^^EfFlrwVK*LseCl+W%|J*V>FU7c&1RE5Q{nV&hORwL?@H-3|Z z{2-?Bn9rC?4r$>~?{z=9_ct*X|8IYbScryL8rgU9y0mM?(GFkuxKBAO=HUX)Z|{4P z8uqiZ*%-18QJa~9b?2?KYR=!=y%k49Y&n#+xJk`d}DW*OtjBP zCDSVd$NH7|GZ5YnpH%VOZ2-G38+gp*ijG}hxE-*Q5;q69m2RD~c4fqSKp|ctgOMgm z^YR1deyW;ZSmM`xnrB!c;=b^MJWdHwUjpdf=f0R?1#Z7o(;p>P(8JiKvmBL~g49zy$`}y139Z z5LUpBDRn=qFKj{KpJ4KHI!|a!X!No5;zd#9wvuNBsRJ_HZ<`nVRyjNMx58TxCE#$> zN|osAz^Y?rwWiBT-S;{s-@FdDc=1kg>Gt&C^jzuV2ek{_fhy#Z6d8%wE1(TCn>-ci z-1}nfm4&?uYp+j`qt#9u7ZhQ$0h;wMeoW`s$$M8v9YH)wd==fG(x8$>jxHdaQO^La zGn6)`^)VW17!Cs5+)J12STy-yKx^{B>{TwrmOSasL`@aB*D2$UQ}d#j0x9Ln?)yt5 zIKUB;m8FFF8z9o3Fr#nSrN1DRMD5(}y=dHnDB1jIHQ5r*^`CgI<=)}c@tzaTELD!b1KUa5V=wvg z40VeYD<=Q(!5Q2uVoY7TA2Gi7iGfI2?fZxF_HKX1=6zS4XM9NtXVy>ukOQ4uVpYXf zYFIu@X{h^EocXW6Y380zbeks&>}SJgRV%^s^%H3$_7CkCJy@kbe3b7ytlhW4^?#C6 zKs4wgUu}Fh@Ekd7jN5q5Uq4>i=L zzilY{2{4=bpXWR;o$pDW9{PvecGJ2Hd+m>5!R>$Dyb=siH5{>A9bA5RkLS;grU1Wu zuEQ!Nc%Qe=p-?ojx+N370 zIQy6DdCM6L0bP^rw8y#Fm{uhYH}-wg)Mddqt0@b*iu zBntQDw^oQ7pyQE&--gUE0Xs0|O=0LxOWPe=>7@OWs6k7!P}e_4#%5al_mL@DMq4Y^ zNJ1g{zF#T|c!l2xm~v49^{Ra`Ks+Sqaz9efGUHN&``q@x{VJlFrQtY0N7hpCVJm49 z+3JcBo`L2Do5j}e8VYK%Ir>dBJ9jaTk9P^j;VT_T69w}~ZEf4Mq$`F-SHoOY{3Mg= z3|rohkES)h6f<6P-gQ$vf|&OXVU__lUdN4?L4)rzH8VW;YM5JQ0oNh@nv^s z^>&&0!75C^%sJS3W2|VYpX{go>Ivsta}Lk4q!)xZaF#~?2a);A4Bka@$!S{Nno@Q* zRFY0!gfg799TBDr>5-2Tqk~|E^`a>mv!m!lzk0D|lT2Il$bx!b&oPGW3z=ot+w;wK z;w4z1aUUMyUnD;_{QUgy^%4Pu8Wi)yboUFM7igHXkPLkIGyq6q3@f+znA1`nl>;_2M6cxtxJ#+Ifkp4Xj1%a@UIDWKb*)cd-lqB`E#y=3Y?R zmNc=YY9h|UXPNg%U+dLTBMMh4K7@t=hTN_+(l0JwfZZ2hIa`5+kJ3i9>nTh*$0$Hv zARL`erVtoREZ^egt6shr@9xH}J3I+#z(#6de;Y7Q2$*tLJUWxZvbpl2N~c>h+53}w zao}{lvL+L<)g5?IO#h;6OyX7|g;^-BRvDcwjE@=E@gb~*2z$4K9Nk_EyLAf)U-19+ z_!G)*Av5dX9B`#V+M(}Kk&rrpR5cY)zZFMK5|V^4A6F95^}zEBLCB&-%}fvEMiAlr zS?#M&K1p*+)Rz%|a2$&56#DkY{ts(7|D=IZ7U>t{m=fi@#<|wfnoOusZ8<_bUgph4 zN+pI%6Db=?Nj?)+UmdDI?4HR13Jy~dfniSFj(10bk4CDTPw1~J^W>w?Zsz)plQ=4s^%0BmDpP8#m!{G2L00qMKTD5u@jto@qMRPkPW}_2q z_M*8wde&X{%}dH@gJHKvR|%-a0~1zhRt9Q8T$e?2m4E%vm)_Y{KtWYRBxK}f!}h~s z2TRFMYU}F#f8e*@)OQ=XhJ4f&UlcD!@xw&h$(^V3I&juB_E(E^<#o^pWP>>ASyz| zI*4-h0sIzwzxn9+jSNc??n6o;WTz^Ik(nOQ^>&qOeiS3Bn5_<&r~E zEh?}Goc$>|`nMhhtXlLF3%zcj7st;LH4lE6%j^k{q0TnH8oOwLD@>eEM@2o2ds%$6 zoX7xOSvxs61RgQu=}1VNM|I!%w5xl4I&ti3En_SWh4Bb9!A32#OMy$J{T$+x-gerL zC&&#K5DW61^QhA~RwZPKXO>toIe58xi8mv&!_01~2iOo$0(nN`Tw*9ys=s_ctU>h8 zy}w9vVrHf1ZJkkGv~Rl@)so&Xxe7QrxM@GW_MunxLwgT{f{k(Rol0Oa*W0gfA2HWC z-9LNVpYYU@VPR07>3+{Pmj7(PXjk%xl|;g%76 z>Lu`qCM1Kw(qMjs!=o{%u_hObPkNj)3YUdL=8&Z|Gb_*8* zgEi!eK4Uma&SOm%gHL7@zLz41XT+unOLz}<7@4#s=sj(VU-YeKy6VmSkL#XB|su-s&S zfK5@2c>J1qegVv;s7u2BA>L1XGx%X>U|{1|C`KOS6yhHmOQa0->7h0r=7Z0BlnmjU zF_pcbte}5Uk_U8e4!K1Eb0@6{D6nA~m)kp|Sr`PC#8Ri_q4>O5yoT4FZJAgc0hFjF zL~@V|FpEDpswgf}Grss;740gsqRmB@9|BN9?JS86$6v+*Z4h}v(xH&tK3q7-t#_0emMKiO#VKW^S>vSbZ z17Zp(&MV0>T<^~kP~!8{Gu-ONJ-N`QvS_}Hf1PJC$GXDuGBT3Bvd%k&;+#fB&Sl7x zGENwo^}HA#)M7KS*kXr>zfU?ocSv2nDW=8l1?ce}`oG`qw5*$|xcH+Utr#e%M zJRqNiVh~@2VwC5O01lFK3)Sl6a zX3~Xs8zS2BCeepj-kl1G7gC0vj!0^QLqD5Pa}o^G19EL|CyM2Xg@-oERs}#_2)91j zBPuBDnFy)&VV4FnLMHc6nVxgP63>rXxdST(V@~=N>#Ym6aWGySwQJ&B{<6}{Es!V^ zjj@1ohU27O^wycH-CxpWxu!I>C$-q+#9PPfR${c)amVH#fI_+(ezsNTkp9$_i1QLL zzZWZdI(#+ZmK4LF&FcMds`*dB`2?KZ{?}?&#>Z&VAt3mH5;XZcz>+y~%@^RKo2-DYrQ{S2OOot$nRQGSq zrt#4{hEIY~JAWn-dtb#*J^R&}We-utvj@3q;JKQ34bh(R@c4cYmlUN@oe0>nY>Qbk z4w2;P)^n>#T$7I;oRsEMRtU5ltXv^5qUDU$(vRx)Y&*TzFcY!$n*dvT7Uw>)Mp2!E z*{mL?f`-gwW12%aeHK6DH;(6zy^!@0?J>I$0T}&Fp0++3*?M31&Mw>s6Q=ODa{tcZkXDXuRpZprL4jD~GEB`(vZdC;EvC6;f zJ~|CB8yP=$1>}ZA9e-T}svde)gwix2Any3+UKK|q0e}*vQed}y^y4m7U-a+JZ7iRZ z1Jx%(9aHA2{ptL!58pIa@xg{BdSyuC=MA?FP@^AN$fm_%*zzn*$8*QAnVj7(1$E?6 zMRblc&5&im3OwM5cZg7ZCCPoN{oD=Dew#huo?DOi5J@_d$tFWrHC-z>dpgr}$n|i2 z1C7iT>-^gB_k(v2m@d~hjL%QMP{mDLBbyA&zD)KP&6Kq4=hoerU^3DfXcbG2`o!7^ z)!cHhUnL{L1oBK{m&RLFMpAJAu%uccBDLB5MEV$RQzz_VCPzt( z(kEmKIQjN4!q+E4va@$_jjtmjxJ}S14Bo+cM?%Z#t^cGQH=zKfCth?clUaLQ0NqLl zUf+qK3!wKA?&Ei1fePkka2RX#Y=wobd9)wL>3gEP1>Yl-JTC_%+qW8&shlP7~Ee0nQL( ztX`?YR^ssn=XUBq&)vxs9*m|!DTnGOfY#`ocDZQCm76* zKKMoZ@;T3I__04#qEh$jdLS(2|783<`LXR;6}zS96&JoHr}#9=(jQjlRJ`l~s6;z& z?q*W9e`RJf|iiNKV?+t2806f`$P-oDgzK7DC^17$jM8>WDico$r zqgb%t(w8gB3(d)adN8nKBcqSQ%~!|v&D)xRPnlnGEwmug>q&0@#^&Ao99KxCGa(=R zhToWsDu3XF#2CYV~TDF(oHUNUSr|K)=2KJ~L-)Ehv;kIKIJw$vZz6FTG+ zeBVn}ghCFVp@XliRxCcbnV~UUE!rWO*k>&)*uloo93wrRh?P=0WK=`Pa?#vh6r4S5!Rj5o>cY zi4m^@o9~`6cW>=3=f2?Tj9jzdOj#b*Be`pZSL%%P@v6tw8|)0RL>=Flt-CGFm@$yr zYLIl>BnS(BI6y5OSMkYNcpq-Q2C4T0w`d%wuaV^^*85Zw#ud&g)xP#{9CT zY82=41(mDQ!K0(m4}!}0?3&euj@(1D_={5Vl`$1335&7|ZU?75sgr7!2T15#1t31}iV8Ua5D`o*!18iyoIyE@&GaA0cEG-NLS`gb6QR8vOwjJTD(>3FUW( zP%URVWfm^0NzC=#`gDN~X$kFm)9;<;Xj^J);-%z{iT3Z5TnoVWFFr^Oc*Jo_DPt6! zGPP&uE1jl4|Iz23j!V`1%jSey5C5~vK^hozOmwyvCU194JBDBR!iO-JBVd+g#S9!1 zsH!yW&rC=o36&{G#3I4iI$|iO! z(JI&b2!BLcsmmB@_O-XDO$%wqpe26eagGU{6-N*96$LoQwjtKv8C&-?iug6o_;uBS zIxfm?U<+B{oO%rpd2>9qG-QaBNRjd43wk4cVz?br#x=>CG)g4>c&bd0kmyVu(A2P3I?> zU~0-bZ-g^{#3RUs6z(P`zXM#To~GD`tBk&*FB@pav$Yv7#WRs#*Dg@2Cg^6 zLr^(o%F-tNZaK$1Jvyi6D-XC-I^uthviRU{$gx{VAOYV~ELm!)Ie|U?I?I-E;!|z$ z6IQl2`wVreLz+7s_HCBwKjBT4?eLDSb=Q7+%S;@6#{+z>27p8KOQqSEMq$P3aD%LP zt~iEgNZl{1K4$C+%+=x0*;y4a&v4W1(YHT}!V zQ`|K}2lb(H28j#FKAelsW(s#v{r{Q?>1)dxQ8{2faeZzccB!(=+r>4O*cG43oKmB*ubq{-@3PP@ zD7F>HH)3UP25a#MbCHU^B=dH-&O@thU6*#w{mCR}dmDoXfnP3DY_ zol6Q1Y5lMcTn$PhL1!x&ET$~8GWN!fyQt%gajaE|r~Zs9s$`@p?|v%A*SrZ|7zv&? z=)W&lj&crexLW+6Pp_Z5Z@})%WD;9qc18k-B|U%7?f}RC#S04cT<%GU6lA^inbRt5 zz5i>#)wiGi`^Oh;sx}ty8;;|xJwusq{3@bG%Ze;7s1z!=MUL0c>#L1(`Z7nl$7)MA zdj1gdP8loh@w}hZ9=s_&d&-+^?Jh%9$PxSPdl~P%VV&Maa3kEgqM!;4j2wMYS|7s} zF;Nd{n-YIJeF zq%m-|@hv>_Ps#56jqZAqX#MyXa=Y(2$n4(~?*EYVc6+b8Fd~DniOUk65csC^{aFK_ zm7*(lUHTG9{FP5ODG=F}l+^Z|K)fn^tF?vN+9ci+;?u?)SlfGZd$y`JGtwTIQ93dh zuh^(M)OEp*n#|FWe)E63e){iUVE+Lr`Tr^b_0ZxSW?j6nfsphd6^Yx@SQ4HcWSXy5 zZYkj_7jMoL$EzUPqR+#hqTnd`xIsm}?6xgc=Ppmbj0k6CCtQGVoJiR%2eqYu<=$0V zFU#l}=6xuzqCWLXfIXMYbRk8>7`9ooL!ySjM#(R59xYvU+bVnrlIeG%>t7$nzqtwQ z851M~t=en5K={7+6#R3-KkuXzC1uBB^HXcTC=z{qxyQ6_7@O(pvTr7XlEKq6#nT{A z%2FN?t;p!$V;Ey;rQ-8Et+aTasjfXacA@Tmw`tx~ufYr=Cu+;C9wFEDj-RJ`CL7AM zo~1a=0J|A{gXu){R6=krpv~K8tG>@mP@QsN_vkd4b&G0vWcLZ=^MwzSOYaX-F6`Zl zo;I`z{9RL>o&HP6v^HyF9*?^+egvIcni+3(+>_L^G+~Ry$rejdz9&Ed+x&*Pjl0GH zYVAX+FALT(i_tr(Q6eC-dMr;Wv3jmCJ3eB!m%ki3*c^OLSldqz2Ug#r< z`AKdR#pDwwiI<6Ay?u6H{$1PVYvFs5`hNrse1|yLgBh^2cD`!U{10<|SHS(h zVmZFQ^WQ-nzNY;HQ2_tfU*Q)27i~GUr#JM6#?k+%+h42xIz;~upM=e!QOby-3p8y0 zOm3pFU~*J&ErqT1mhjH%7}IiNBnJcj7Nq|F&w*h=S%bX62myFL31TJ)Q=tIp^nXxX z)#oqzN5xgvxWih<(tDeKwPtYR&*QnLIRzS+leTBcQ;v0L2U%Tiylo ziplV~#&N;6i@?d?_!|2~$)(i=W90fw@5xixk7QnW;p=)GRdn21nGc z%{E@~kn0(Twhk9F+#7icP+^cR#ubZ!jpa%iZEup6;&^s$7i z{Laj+^ST@WlhmO*pDZF+e9bkbi=sNVfxFTP#B_GQ`4b5iy=G5mD&`ny2b*S@{!b5g zco{kqLA%x$87eOj@aQ~$ar>(UEJC;Pa_DYxHvU4!< za1;`kXj=+6?@06?XM-3MGSM24FiMQ{lj`#IY08$E`)$$SOY;DPwo>DgkMcUmHkv7t zMTuC&RCxbZ2;Z@$Ib!+yjXhPHLuOU@Ms&a&R32+edV@UYJ`NkKsB)t-9-d zXe8=r{i9IVbV)aiw*OLoEJ0DFM|rA=B`II5?Oe~{CY_B6&Ly4C6D_M6niuzmYrY>( zhOvSO-Fnbmt?iWdB#0KL&1}UhnpNcSqhNBU^Z3o<9?#}+_kDX;zU}NC5t(~un8&QULkAF# zJyeI}yF)!LcuPe*W%x>s40UxbX&SEZD4~A>URMhB&?`S4^>+pB8+{b!aaBEROX-hw zfmvf|cLyN(kPBAL2po-(2r~j=Xe{I&cvpHNK$V;Jguk9fi z;q3#6YbkrjUs^gYUwNCI>SwftvQlr6U)k$jC^D|Q<^II~&4f>GF|0D=@?zMjHSKNz z)&Sh&8MRhF%^IbZFV*}}8*A6<>aKC0bur{y^B$FZBp)1o#)qnz8hpwa@QgeIwoGcA zI~;PME$O4~W#{s!!-%&`$oE;kjlP9({I|ifkl7on?!4?q4e-IgJfLq?earX9!^6At zbVgzC3k)4Z@1>D<<4K(Qs4O`W)nv~a2-Zmb@kCb-jb4>;&#LQ_mqkNLSxhgibxOD2@}Zj>xK zOv$Wp|I^~ochyi!Eg3rzgqBhD-6Lz)@VC^nx=Zp{x(1W{%~sZnFI2}9^A<*a0=yEY z+<>+BxA5%a1vMnY}fo(9RKf-f-H5EATbc z9U1sxaZ#WOGK&lG9k}r24lDm&Ve%Pcr zOCAH96nzH!oTvFkCM!$v*$TU%3l(;IE!ZnzPC&zO`j6w!$-Fw_2u(+9UJ29EUHRX< zSNs*m>GgE4goWvj?sj8ud)PV;HQpXP-7zz7QKn*6GH%AN`lqMjZz)=xIdIxC&LIgtZgd|6i-bCpw3Ifss zq4&^34@e2ULx3a%2qARd=y~pa?tOmux%Yj4|Gl5A&)#eAnM~QU_RQ=xv%ag^JRDQx zE$M029QN+EF}SF-@3l9iUVptMUc-Xf^#XWY9pcsYy)NNFG)qG8%lOvLxN54lY?R-= z7%RKSx-()DwUjcrF}6Fojx2+s^AjCP5s>SUdf*zgPuR@4lnXvHxR>kT)G%q_cj(Ec z%vk4X9>&6s&rpktmV!Skxrf_HL;$GOJq89G(FMH1C$bPMcHH{7Zbb_Yemp-;-YCxz zm3?lI@cS>2K_$vwJCiDpsigiiUyXmZToHef5K4K5{22lzANWrIreg{&p!mlgZWdxW z=rIXJC27)jZTqk8YsL(@9>VbSr0Nr~AGu{DvYoHn6&_0B0h?wMZxIivk_Rvt#h^K& z>SX~n$SRd3QnvN6!ngkgZo~c`x7C-$F(R7&QI09w?642LfXwxbFkBtyMb6ESijdU( z-FUoy&Y>s_2&iZOvUx4##ZSzJa&{VKLs9$~$dtFHQhi)(+%{vke8CZFDmpz@m2%N~ zKo|XDe)m{JN>(Cm&-J`ygIO9F0blivT3vYF*bCgREcn-PnlqFdn&ABjc^n(g6ltY%Ok+sO`sD?SUo(y`gwyee=>hU`8~XYC;)qXcvg z6WKa2_Omc7Tgd-cs^;$m`J~zI4^EX|^6$G-c!+CSfd@UOOMm&o+S?lcr2sf`(vv6( z^k0V{;pWQDlxi7*u-sddWhFQs8{GMU!Rxqu$(@d1w@J+M$w2iYb|-*sv2FL#1!{j} z3mUYW_wwPVuVHe=k^Z{#dj?JN@N3FRC`-~-9iwuR<^+nZ7QJp6jcLMpj4Cr$D+}8S zjmt(x{JmfDGby0-Y}(DBoeiWk^|r~}G8+yaIROH>Gna7w7Mzq(cQu@J@4mpaEyRMT zy)s6*= z|2}cz4NgUWlOpr2O~%qT@DR%)NvBx<;R|o^s#r1ON6{ zd0zM3stKl*Y4g5C(pUHCQ-3Q1$LR6PegNt8ze_$~l>5I6oi2{zi!#bd^hC~81WEix zdT`9~tG4Fm^toDwiqyJGy1ti}P@THVef&jYHUJ)#A{^%1U4~(R8U}FBkk@S{zvg3i zaBnFSG5w{GD?CqrX?-eH@{a1gEnSf?A@WGa9#OuKU|a<=bP`VJ3yc`=BzYRh8#4dB zY5p&~?)~Rc3~yF4a<@LRI`-86tyY&JVT^O)?DpQ=!Jr$E&i|xsd{weTo(N-cr#Xcp zru^lxG1W<~h30Y{T@EztiJ}1V$sV)V6%9J$htli|xfmx8u}$f0a_X*Xaq<33c3ft^ z``p&z=oq;9|CBAHB8NKX)A#GX%>TRa(L|!KfqY|%EJWkjXRc!5E9oM`z01SPx`6=W zp6ZG-FvpvvP_I3Aj7V1-iZzBb*_N`vPo*}rI;DHCEz7@F7OP5nM0eh)4kkHvjdEj+ z@GnIC?}GThy#xPygi)-VwLZphrgxvykGAS_1Z=*2)+K;-a`wDrRa0b*#Q&5}xld@V z;}kiY^|~z?-3s>4+kVGtx3{#WTDB*-+=yD#dV5%n|2G724VzWCNb`6xUc5ft>wBi; z{yl}8nJc2sk*PE5gI(!?2i{9NZmXsp-_s7wflKb5$a^ExUhy3!9Tg9jM6mJU4diRD&?g2aas@EcVmfbjwtn6G#|(b-DH+Or22KxQSe3iO zYhOLD8^3PDcpPgalU^+i&w7t~&-&jvBwqe+{-=HT8#Ps8>X5)XW#y@8HmqGcj5V9lr>K0uzY>h68YY+40oi(&02-H#Wc8pKL#Gn=vYiVUsX!lQ*tM% zLvfz+OueS-*CtFEspzxv_lsl*4l>C=F)oZyRN*IpE7CDZ)s7uzSa`;)?h!nCC>H}a zG5OM^DX@jJ+C!{W{EkyluXI9<57gl#*G6#SHytaRiGwDWm&pHG8_eBTuJOMc5}=M~ z3*B{1$e>I@D^(|iT&-cSQYYs%vYt5AQFR#66`cOr#WD7S!yz>nYwM)DT57gk_LrB$ zcMgL)<#e^zO6w6HXr2=H0NAe&x;hQroXu+*qjf+6|SxitDIGGX0rNxBQnv*5q&?a13DPO@! z%<lq0G56%)XnWOlHz5xv{w3=EH1mZK0uLvlZ*9Xsh(d_r;4qLc^!U|6E_cGQub z>B{n(VFfnd#X`N_y6@$^UuK<88r6cn74x&`>{hg#z1Y=sWt|;tB0`vGon|tXe~!?~ z>r3GasGI4p_ZPMM-e^F51fZ^T;4jU+jQS=f-FAdnWTfUN@?^NpJ`8>4rrw)h#AoPx zE$))Eal4_v&evdCr#uWAi=vR<*yQAHDyME&^naN({DrkgejfSDEo~H37|0C= zTM%-vgA46M@UE^$5=v>rnL1`U8fVs(?S2<%0Rufra&u4m^x;o~uFsJaBoFbm zjYoN7LkJD#xy5$p*~%AQ|IzaYcUzTkG)O~89zdo!x_84m>Ve}y|iWzEv{qRrt$KWc^ZzpO*C2qRxkUneLku(M%Zp|7 z*a%rKmA?5r^;iE17OC#oq&M^qlG3o!dYS$wbmB9V!IOyI4D0idl#CT$$@x%-Nt@R^ z$Y6C)R3r+ICU|O|7(BV$JtZ&Lp5xenl5fwcpUklvFob{TtxUNvtAd8N?TT4#dG#;r zSxr792}FIoo=~~FpM*_`hFzmL&2O!=%z&!zjem~i=La3+&twZ1fBsskFK{(>ZZKqU z;w?b>8nP`nM0$sOH)PNRAv}1ODc885qKXi}qY*6ynBNW=tQ~`K&rQ8jlZ8tG#&;be z4Mo3BKQ}J@E?y zZ@8-T-f|t{@UFgHbl;;Vxsla~ar9ssslLxj=d`nHM!^yqMR7Y#c(+(Xg6Q1J>mGq63JurN zYot0!u7miPTyMIztwvN?p|Y`OtivtXWhcV`>J~SIC&@i2-M@_~vk#*a+|))SZKHGf z1~h~e>s3P``E*?t1S_CdOxVtgFf+Msp}bqW+ZwEV=lceC!_D@?g>$G@wue$Ou&6#= zbW%+Vlz6WYe^kG}d2||6_Kt6*jD@q)^k6B{%N5IZf6Yr1%Mby#fMpAXu?yFmE3@0# zMC3YeKU!x|*5*;?iON*mNjKoFusF&;PUBod2A4+0A&(l+8vFJq5-Mg1NUVX%F#Pyr zEfIkN;?fT~J*woG_AsQm8@0#F(@>1~b=E!$htjPa_6AW+>=qltqVck~y04NUmh2yv4v!ir zlS8k$9m;9%doJKqWZOeF$?rDFZ&?lxFE@mBBz0x)r2$Dfv z&o3+|M*iyuU4GRknw?s7~IrW7RlE3eH zOviW=J%jZKs=kr+oH($jS@l(d*nmL>Ld`6xM%2@0&3z~?m*2Yb=TX;tG#Va4w??1l zOB`aiEz!4J_i7Qif>f^e6h}J!>3_l-=WMGC0w?NYa~Mba%1v&L=!`jnpCZm=$)MMB zWiRiZU85gj|1Mk5s;OwWf2+qONpei{zHGj%Pt?Qho04dqH5<&DFxfLid4zpdM$36+ z#5*$*%gR^#mil8oYf7~?!AqEEK3+e>E-|&PJ_UVztjjT>Q|ryg;09l|Ww3pKYdXSB zqt|4n;`u40XoO>t%uJmI)>_i_GRg&C^N8t{n789_-*f_cnD=$&EyooK3cAY=iJlZ{`>`Wo*qc85w zj5!aLa%6R?iC6-Ql;VMqPeg#Bo0W_z8E>)WwHmW1)0+c%3o0k_kL@rRgSWkA6qpKVLOEVHQkXcbZtA3cIYQ#!mMO7Vt~opG8@HE?f)gxi@4m+aIcL zXg~1QlV8~OWKm|fP}EK_ijd)K<=cFq_NCfLGoR5BAaxCB-|AUc`U20wMRqWe9Gvc^ z?akn|R1W>j?{5AixYOV>7K$Iu#0{;qOx5mVK2RofhAmTQKs1vnAff=nzRE&(XF%q` z53g+^HY$JFtyV=R4)oNk`n=*v3W9Mn1OL^oY==o3^CmPwgXX&iG&(A1tAt&3{bMmEHb$ba&W1r0~a*AA=)A?+0^&w4J zmEe!L^vzAob;R;bskJlYy8@APsDBEnGaCQ-T*tF$GqUe<-HvT zcuE}Y)vB+CeJ(%41zPUiI)s5?Sbk~5H@gh1!%^7EEf4IpzV=v#B1B!iulEW2>}wkC z)oR17FC`z1x)t)Sr^()nVbM;LlHQw9j(yR2KVg#FyIPhTaO%;dnd*AN=jKb}`9KMfgSbdlpbQHIX^=Oln_{KTuxr zAWQR)zemd@cErlvoLzBd8-b& z)DP^sTbYL4+T9tQaXBOTZ-_ddO%K1MP{uw&F~V9G-ukbSot!yjNEB|mGTHcVX%^g= z%;DhIaYHmv?XK>>JC%0m)x*RJ}!7o8c*Hk~u_4Iw~QlWL@(6yv+rn+c)%n;owk8|O(5dc68&K=dg zaXxY+zD5FW>@I3ERJ6@(d7P~PF5cH;2T>DdeCa3T8=B|EByX*9fFij{9SrkO>@0y( z_NeO<^ED4QWZxWNlKbWhCh0rs>;j(E@Ku#uNv0R*X|H@z?vUO)?C99d;|IyKOb zf)|L^iQ09G!?L{x-%?FwgIpoKX6Q${Zv;|kTO*T!GtI6?($v>-t19QlS|ZCTE4%{7Ev1!(%kFgZ-2DRE(k#! zi1@BWc{-Oxc-Df`NC|v3v#*b|AVxkoY%Z@^W)c}B9|tOXw*SMmBJ#RR0}UN)WVi|cWqEF&!_B^d!Hr$vqr;ID z0@F!-iy)HSQoqpaoB4TS50+#|bZa1qZ&=ShaFyZvgEWW)B4Qz{b7HLB^ZKQ5Uz^_* zm`_#6+4Nq=-wTTZJTEk*^n0CaeI9s)sN!5>?6{JC9vk^a=7ylxwH$04mu8Xf@R57E zDe!VEvKNyU0pvODnY8X-GNm%MqYvf11|f=9p4LZkmCignK$z*;22dCInolz%z>JSW z_qtwO7t(3%#0@~t55G3O#O1Iy&2KnHPzlzyolrHuvfW)`&;L31V*)*VW3VM!_L^uz zqprj|-e9o3ubY3MSD<9kc*(*#o90Ts!c(D%pH22+h>8~dcI;7e zJ-TULLA)O0XVaL(iOuEW9?8lwz4KaKeztHx4ob$qIht<2o1%>Dw*dM)g{co&iFuYrHA5J%hf-Eb0Ar zj2_9?-Cuwbplgr0J&btX@Y%Inc-F3LTu@;6VG+7wo#Cb69>qwrhBv$E-Sq*nrD{ks zY?)5|VT>=T+dmlFGz_+uBELC|DDM|*x+53e8%<_&9fq6$@nZ*{ z1B@|0D2Ih3aFKfeGPvj<<{OLmK(tSlp(vw6!@Cffyku0`uCkbnFNv5hG z$$iFsMiTapHGzM+Pqmd}*w3-Murt~i9fmBF8?N|t5jMOs#9$l3whn_o@Q(&lQ5x=Az^S z-p#TFN2p>6lhKlN5~iK0C$MH9FCJ2@Gc_?wvz z*}o3Tu(gbR#SMwD*6wvP|18oGw>$Y&4tlnN?61<6)& z@y2Y9{uDjK*6I)=9x06y@CnR0*SksQV-3X|LPf~nk){#c=lfNG{L%iOwi_qY zDMb_hpPpKg5gO4K%;)T$SkIrDzQriUWBwsBk%FM4v3^4Km3N3eD+w$F4@CDz^C6Yv zs(#1I3V-|AlvSE4XOEqr8Lc%&&?H(@-rN_koN|r91>WacCj9I{766QAnqXX z3eHCwDcoMyp)b3Q69(o%10u-J8@jJ-<>c%CnBg7)uIN5Rdi6;8)`LxuHbU0U{1rXE zRt5`|Wz)9~MUGX?NsjEZzXK!&q7`08A3r?WJ+rec{3BYyXcP)rrfze&^}Uc&R5%hA zLvj$LE(LPJZ;S9S(c~`)%DvfBbaL5yrTT)O&^6$z%!Lt267ykm0-b~!4s#!KljT>k z%(~)0&oUv>{q*rA!IR-)R6Sh8^r4*c3X zT2&>1AI4TOLCwl+kY#w0(T`oP1eNxv`WpdyKRa@B#_s2r`KLmk$TTw65H6yymld+~ z(RXgLwIt;rU-WH!&`9|*=uxVCnsxa-C~@z1vynL_1XG!iSJ2O1pNT9t14_&QjXvVM zTBOOyYCF8S|5(I|=~|JdumDd)5&p2Cvq07sZfmxjp`puFRqH(|-&@lI0=Ax0H+h!h z`)$z5mC0%-Ng)crDkKFMWJk!ssqi`a8E*dsCJ_yKBTkb-1yEy6qU3RLO(*${KU=Yo zmpjP8yMfgYWQHshEZSJiMg90qd8LRSGiMD&Ii=Wi$juyhCZ75=puAG@-yPoLvuO?B zT%{567firdXJ=O`V!vQC?AILRQ8c zjdzEBO$n7(I(p<3%?2(%k`5QN?~4PqrCnyKF*FGmZ&2MAfVn9Acwmtj3VFEAO`cd? zXfH}=Xni*G^^aXMRn)!+^x1ops#l{doM$FQ6fB`7A$uw>{Ok17HwWgJ8|2{d53T5w zr3i)zSSChp(&2X4rmN6+u>JP<_fmO6smsnEY1uOFDSD=?GWg73+5|x{Ejt-fzw(&D zGdZR7?7jF8_ybwU(H9Ly+N*TtsG*ccNqb5mtJ#}-eWmPFxt3ifdsa z#-m9AN;&ccz$28@XUD`!pJl1`mpy=TBkCt|KSCp1I+|z;L;kUQ=j-5MY32jV8E?nC zpv9AnlbBiNhV<9UjPg**wO(v)FKZvOl( z?;N~rqcrs1euVxyR|Tz4Z9e>bzN$sx!pXPiJg^M>Zr9NM2Ro_qr>%E%w9{7mYD{Lg>V0^=(sK8r)n$T-?~mC>U%mU3Y~XoCcB zm$%TqaBM8jtX6eXf9q8+x0RZpBXBOvKhB@^^O8C&n%?B=)Xy;uFyOR&coIlbb19;UvT;5MIn!x6pGcJH_otLa6*y`sELG&go>>{Y$fM*`*zoUhz}|Y^%H!cY2}?gPmdA=Rt%tMvk!0kpoEAX&dmU1% ztM5HG6Zd-S@hd6Qk;xJbuj;`hndS$n@+&=ch3V3CsEyjUX{nDLFcH%lsqZh#>Wy{}KXC1*fw2>kP)eAG+v1b@Ichaz z{l{+PIgC?JV&sr+UZ`r>uCL?dQ0}?|$qZdx-6OMUq^K4@?4A@>Uh|!Iz2`?&-E&g& zl3&$jW{LCZ`3zT>MbAeCVho0I@wY7CuiueVs}ED(pX>Epcj4JE=o^|kTQua$>ka@Ch#wc|c$Z_yVE%z`Z`O6uH654Rx=Z(R?AyHNl!x3;;W$7` zlfP93ng}~ywI-@+>r(aci(u@aq=F*%vVUh6QI(3wDVkhno%6CgavWc`wr@a>(=T}S zSSlEkUQb9qonXx95y>3VFm@`Z z>b#Zkn$?8I5R$etZo1L{=1=n5@4#QTeioP}{b@sUJxZBFN0SrXzo&F4wsmd~*wg7) z_sHpBSve2Fq{weD!?m`WBF}_NM!e#jsZDn$=d~JXw~uObVLC3|W;2k5`Y8e+;Z3(f zZvh;pKktS3?avD{Uw|F@pOc7Cyub8h3RhwI=3YGXA)#=rqb8dlsc+WeUh~y+<~t;N zc+JzZ;uO5*MeD;ZNuTqZ^>}$nOrDs&51VIdyj!@v`T-^bEiRJ+qKYy zQFEct|0}q2*}lbORQEil8|SMAF9>9KQ74klsZFiM-d&XG9^GH!kA}GGV4~sX7Um5H zTSUC@OvCXmd5#=RQc(2$GQYJ|6kOCsnx!mZG>eLaVTq~=5FsZ4A?V>8^;t~PMNlAZ z9kriqqK}%H(L8}_N%U@|=iRf}GzDDOuFUIjHFZrt{~krXn6l-0?pWp3oWq;fE61OL zpLse9I)_3ujW(U6_^ZPSo@6I*bPT`QA~Wv}DVXP6{KQs6%w9M3N_{tXn$cb*Ny7sp zE3@QTVj9mSAK81oW-F8$=hL2671`-h-99pWSlF&Nn@Y&Bc75PHwlnx`&S*k(m@W9G z0i_h#sA%}$3ahUadQYn+i)~*``rFjq&<{s*>NG>(w7pvUllq~6xhfo^16oD#Q0EQj z*i0UQq3g+{a6W>5$;XE4mSbi*V4*~cL+oL9&w_0gvp(FmEcViMTZmrJ4Sg9;2Z3z9Sdj z;_=X=MTBpTyq=%}{XU7s6J-xW>6;WWe=$upK%{YK=^(5T)?#E@QFen6Tdlb!4^ zwN3qp-8uJ}`eiZku!q5Z&@G)>isad0$xEv@VO z2Wzn$&(4sDiyGyw*Wqui*)OP?cc1e3w(NC0CKg4_ z0_3G@%Dv`r(aDBz0U_2%j|>QC&Ge2&AQc zZP}g=MIqbHA^hpD7Ip*LY_Rc1B5Z0gNkcnjp?EXzn-&@vX(5e8OI{C4f%Sp-!K#?H z8ujiO18+G0v)hpgwYkKxv0?Ozn{k7Sf_Y`815=)Zl`L;B=pb5V|Bp&sIj@YO3Hw#a znps7KRTj^PHA2(MepDN~1#tVyemfV$z0&K@7G<#zev1nCRGj!q1Z5Dv+a7|73lD12 zq4^c0pfr(c2XG(r#%+ZSy0IJFfx z7O3Le@Q9Ej;1(1qb|6^)t->akH|xOmp6PMD!{Y>M+u-JH>({qG1BnRNw`D$NmAiVt z*eYV7Ku~WzrPMOO)khA}7s=D*PkuPO)S+0EJzgJ>vLW- zGlumufKpcJ5rjj4gH+LCQ8kwx zM6PHU%js%9>VEj{C~GS4=PDCPa)+k!f{TkNa|S_12B;-yRZtm#`tv+$i0 z(_^5*tuMT-8`WZQI;^5Ka;IyHPA1gl=z0Tlrj4fq`g{?%H`Tb00dp?xz8|AQfFO^MgE;o&G!{>K)D<6ity^qccW95i=jqFqd$_~>-LrFrrM#Cyu3fQ z_%}bz+`(!6`G6N6PkIPNKbhz!US2a4yzVib3!XNHKL%atUKf*7LouzlQPUoMVXfBf zefmdoS_5veUiL1A)cgXaKu$N312O|9XI>s}d8I^7hIZ6Q`^=BGeR=NoUG|d9&ef*< zgLCv#kY{jfX*PeS0Jikku8B}bSGI=-Aam~B094Lq4k0_d;R@$iZo>zZO(m*?p~rSs zxYV6{w^kSi(NHN<*jLyMP}p_YFIViLe)4))-PI2-`*n+U*F+9xTxw1S!`s8mi+Ur? zST#87Hbrl;3J=DC>fW%&dTNb4F{ZO&k9CzgY~sX!*+9$i;lGS-uAa;?9M3wlA>8?Y06{6WD^;el(*auoZmf~MR52PGTb++~S4 z=9fJ8N_Pmo(?{-h`??tTe|9R#|50E!$Nm^}HH3y3#)jP=ZqDI4Xx>~#%?d#e=65`+6{ z4yG-#tu4B(g(>#S_t~#}8$t@|!IjGgDJsEhU}Kk*_)*h75wz?5H838y}A z1wb5TfL$@$cH6BMk?A0{%-}TIak0+dyca>$uXYf0?n>67HXdU^_u5POb0@dw~J&Ab%?#^R+!x~-Q((>%6S{_mZi`ETs8^Lbq4Y$=r$r}r~ z->MBv8och2j$HI6kraH|)HfA5Td&f5TTWZ1>)~TBD)K=ul*K|L^S>_q8a8$8IBPvL zW#&1QSC3sgN4H;mQ_fP0iH}#4JbnK4ANOLid979G=&pC3#B#_9FF?Qbh0eMSKKL>z zs=pI8IBc8ssS!i51!}4j5FZ2)veD%+=b=7~zLB{`%GDu2Xwx%12X9H}R$NX=wP?ZI z4LR{9Sq;G4_7m-fNBCG~LKDZoAUMsNiL(gPNzx8*NWNHkPV%i|Hjf2RIh^P;nyfje zDz(BT<)zRbVdEnIy?x!G%hDfe?YedvTixf0a8JXV;$*NzwdRObo7rYhRFN3nHke+D zrYn^x@n02R`b>&W0i+7q>xUjSY;wA3r~UX+&soGu?A*iOfpu_h1s~r1A17)8D#a@I z14paQ>QIq_&YN4ohG%tI80DTn$DY&dj3%EKey}9W!I}6paDfB~U%nFd_2T8BxkEtE z0eAKk;-uz6`)7`njm*l$fh#sI@5PLFewYAoFq;NXt(L3!&0k5Iv#tqjQRWpJ2?KY5 zcJlT|sTF9|oD}%yN3vrF{t{saeNhgB{5xX2#KeyT8(U#9aMI>pI}UuBHkYXOrpjMG zDB${QCXx6AHgksj$1MAw;zj}gf249|Bj%;(ur0;S7dhj>|}+<-|fkpktIaBOoina^@O5)3Z%UfMV<{69!@{<*%pS=F^A z;jSG0z-oCt8$N}>^TEHqlx!-@5pu5%_laLk8{c}F=n17Px<+fY)1`s_u4UydeeF} zyHEjhj@G!$6tyRQevbBC851+EItXf9*6V5&?n(fRZ&!}#3K!qv;z!C%W`K>gVo8aW z{3V`tnlz>ZMU-DLI8x+l=&Du zT1{0@2Sy0{ViS5xqLE~$mB??1_Hvo)DLP(OG0l#M0b-=2SqoJd+;s$_-umk(e`^D0JqO!!)Bn< zxvwf5H`rdx4kVlmvx>|Rs0+EyYon2w5Vm)FFM7^woOk|DL}J~nXo6*ePOo>xpCZI~ z{#X3z$J61`H&)Hvt{FCnQg9P#hzr$romLV9hQK>~eltzlOJut67J3$?ATZ*22C54Mwd8sFPy&-joY_X|T6L+%1yEbx=T}rdF|fsBTPPR~Z)k+)9(W)Jk|~#c<>2 z(*UC?F&yiLJ6Wq0J3Ch*SN$+AKjIV@iB(*l?A}a3{*j~ZW^8b=to#rAW9`4qI>g{E6;tCCtDu2545># z)#xsD_ic+Q%bJuJ*WG;X2hQ(Pkc9KtZBC`8t@mk4N(hjJs1s@Bf|ye<&4=IwIdn~W zqmsHf7dZL>b^`gbkX$@?aTy$2OC=rjB~5DUN|Gg)`eHPNc&Y2|HlEbjdsEW+4Qj!8 zrp{=uW6{8-#!^6TAZoU8^Xdlx@Ka7?y~6Dm2mSO?0#V8)%az~268_PVVi%556KZX5 zJ8fKEf1sp|G(eR}hnsqbwwza3O}T@;G5M-VuwfUsHIU~2YD#G+J$%JlJT?!)H@RVY z*|03_QuUtJ6mhKKHL+?K4|nRQW+t|H^=d5ZJaP~`8`lzZOKoij=bzNg z%=mg8o&1}_>4FQzJdHn@QCDNeKjIs&)PE3|dLo?lG(OSWGI}-YQl*u5REp8Xd~8CD zD^bTwS1iI`Wt^ug2N*WSd+=afsGyPoPU6Hzl7^?{<64bu(|*@cr+>!o?SK_esX zMWaF3f_izG*msqi^t#tH=2DR=!c1y&u@Ir4BfJ{)@gV!fFA>@dF~_lCrsL%iQW|rIr@MeXYs3MTpEW2 zU#qY0Dw!OmQtmb$oB^llTjt^5vvT*V=8<;!PHwTwY47UWY`=S>D(FzTxRHD2@r@1C zgP}9eJ>B0fTz6s5i;fU8M1Kq~f)B;98V@f$-!}F&P`})gOez-XA4U<|MZNp`zdZ|T z4Y|+&@2Onay-w1dD6>DUB^Zb^cI}mw3Tsh%CC0!4b9pIyk!En!J#<_jpzS=?-t+kU z`wO*gwK5qe+O3B@;{yi=5susyKb2EGcJy3$tSsxx1&@fr_4;?*x2`&ziA!2d^oYpE z9M&fV4k3^B*T=lq#|*K(0?RI-En;cX^Yrnaj4Km8?Mh-%$>y;9?%x}f6rn~#rbwFt zLSYTu(p@bpJOf{b|DG;TfqB#WBkdCQL9}~tH=W`i=`ziO_s-qhavhD(3c9D%vUHiK z6ZJ4ys+Xstt=L%8%~E`1`Zz=g_N1aYDl3QIdM#{a^<6(TPa0tq#Q!RPa*E6s`=;l% z&SV5Lo~75^=w4rBcyN?_s1O_EQ$@xE0|LJ|OlbDui z)n#6|f(TG^eW^n(XmkLcam&v;s8HANE-$JRPLIMSPFt#_Q*z(Y&3(hIU4!?%SDoDP z3c7KT?(UQ|PAXjld`|sOsM7n5$WQbY+}(UfOhRj?f@Nj3;%py*CoLOlo#H zE}+kuIro6w^Q!L5lbLCbccmd3OYt|^#T}ocr@U2=GB*ABdZHo@UIi_(B)->1kczsI-MM$us1LBs1`QSr4IDJJ{*;%2d7D&}OX#V6u zdc=c#u)6b&OM~V5s~%dJoOUk;S;e!FX*RwS#?u69u4>NL5TVZ|LUAFdQ_Ff+XZ^YR zUMiA4(UEzqRJE!=sm!Gw(wTDiU4fd>vC(hm-6~CYDl}5ctvQHA>kglaOZ7FwNe~!D zVB|@FZ*Po|6?^@Y#?8z&JM=4;1p3;P$r?e@tLdBw%SEPo7X_%An0HdqDoMC&zK8dA zv>B+be6q5PWR!UH(m4D>?@ok#6sF^pX#e&}C8&lqGNF;T+>0b+;0c)yR54shb2?hw z%|fWcp=aTNsnUU95{sZkoN}>X1c%krJ$UHUle=zcI z2+ZL~bDpT9&Xh0RuOl?MZp|}?nO$N1$H^LHYJ?h_ljz+QoXUm!kNN#mgkGr2A$E+R z59+cLP|BHlG)tfZDo7nP{r9cVjjA{=|~#V!<9;b!_w=Kh&XdtUBCO8{ zBOWGt%qripD-u!Xks4a`%Gi666A(3!A=Gj^6`<#?b(Gi$$GwM5p95<*Tn8JQ7t?`@ zEjWIu&H+uG0{E2!P-^CwRlBh6dqA*P0W(H6YCz&QcgIEVDqf8Aqn1VO=oAwBsP52_ zeWo*SQeBRDiap=@!kWO&`j>!ApQ6-fXR+s8NkTo13WqHxjpE?nE*uuco_wEwzoU5& z4BMrVcc0P5-}t}o{LkY_zU z?^zgo{-u8NA3i>s#&J^mtt^U81K0jZ2)}Z@(Ps==(Y_Q4L4Tclg?j2(eSc}zWTXQYe zeEz@3RoPD3MfscB#L_4B4_>*PGu=DRz3dW87gx(18obhN4RNHZ{=Vz@MSd?~?;=no!QBJP%yZD<~LWrSsvg)z?qAzJ|Tj#OyZUh{I}IgZXRR` z*G9-jn5SN9TH487V(40wZ0j+TD*6Cf$DBUBLoI$y!MXxsd_e8B16kFgz+WZIPda++ z-m2%I=T1q>w)beAav$wqHHE&aOsP&;n9%*A1$u7?@wrl7vAA^oRh^5mCh0?EXP0Vw>O0D_*du}{xE7)H{@bJ%3Dl<97yAC512U>!a$*Q}rTXfO zvn1H;l@(eNJo5zD{e!Sc#%{UV3wOZ0;OhQy=kg$}r&DRNA0_i-paHoQf2oHTe9`M! zc76#lF70>DxC(B2I;p(b#=;s?q=J1zgK5N!uB0YGmxk!|^abk~o_XDQtvt5P7Olm#I<_@5#^T9W6g-6>i0dx*KW1+AP1sv@(QNQ!<20 z8@7U2zpBmWJMPE8a@I})2a+B*cfU~^SITr~;{1X~MZa>GmY^SbAQHhWZ%9E!4^LNW z?>C|)qu=P1FY%l*ihSewfU{go4>)Qc$W*?SWCYqZqLjSC1U;v=y#9(wc?X%q%@;rMr7U@vmg)&No;SaQ*%&$Y2r1LW0?{W z-e00@th8JegP!-8U62e(kMMgoiK=O6yk32Fd~>aN`!*SCz;FNZAc}BiK|1E)9I+=O z`xPb;dspLoBU3$muM7&fjIdOUs>8)r2%}3mE4ya4qV(r@REUpSS@46;n?y>nd7-dZ z^6@ovM1^G6DXr4N2Bo(eySH^)CxEcmFE+g=Uob*OnvRngKY2;1VuEYfDOG=^fJvX8((&SG`=0 zQDxp-DOK=(eQ9r3vh08BbIkwvGo`|vHmE6&i0Ec4jf_g~-%KF=>j3+IW4ZpjEK{h5 z+a+xDo_K)3Ho{oC`_u96p;>2b%UACN;X*s3kP<Ldw}W`sC#*-CAGMNM06DHNvf=GwgrB;gr|y&nlA1;jRl|xmvGp~KN7eJOm{HeP z?tET{?yR!eup88Fd?Q5xob+@)Jun{Qw;BkCQ@vO`_F34k^EO*6Uj1fvFcs%Dx@GB- zi&}kZOO3C58CBl^>t>x?e|b44rfy)+b5Vd$Y6W<=*cdsj2L>TyhwQDYno|a;6Kittx6L- zYMFHQp803;2~NL;OKFch_`V}6D2@Ooy;+?DE5O7d%bet3>e*72c)W7b~fHyf`X-3A+S1$0j( zJC(<8Pv&-JCzqcZblo0xjMN)c2DR2M- z_D>WUl^*E-$LT?ZqqL+R86}G-B@F7}_a}-w3?QiSrCQNwi?^%fB@r?@w`;1 ziTH0A=`z=dA7>)1N$)!rTr^A44cGY=liilZ7o}@o6cwb!`!u>yr!j0%UWiodHd0L4 ziPU~{A)7%|vt>+Zx!unDkca`au~*2LEsiK`K-+G*evDvxbG?-uue+^luEHsqlwspE zMB+FIw(trSlC^Fvzf|Vi94^Hq*A}t%Tpz_7%0pTG@lT%fNO8e4Se<#ZV7`H?CvF$M zq%5_?kA^4LKst#vi&SBojl^B+od!%bh%b{mEzaHdxRfLg>0-D*H~4mc=bA$FnJy&4 zU@o38!xdLr9vHC5tnn(1utpO>ZK^RD1EXt{0Eb z`4Z&T^VRt$;j}TX=pea)@h=HxWa11fwZM=cQ&wvkJH#^Dpfr6ALnAZ4cAvu~m!mPU zN4zhhV;6sn+2c1yvs4lcic({Wz0w9tcNj6VR-^0%CKaY(lLO3ON>!sw0>hom0>h`q z$yCC&`={;E+AiKHjCqR&w}p|p5heyj2CFP1f*?V~E{=O8=NsEs>^k>9zL&ES=l{ji#~Q+)F_w6ioBBc$?c_r`aY;B$toJEMhsVf>uZF} z!~Ip$;(wOPsLfftNV0`~Gg?aD8;Tfc}N@t-SJm+*c~_FpB38&MOs@b3V}bMoKM|0CIQ*ei{|MPB*d z*+n$vL^iMBQ^No^Z532k;OTNiu{Gdq&(Ca@8D^Kv<2V21$^W`E>fzSo@8=JGquC;* z#Qsr0px4B?f8?teM7hyOy7s(QjaU$P;csV{5;40U!^yj*Z#`96&?{3 zq0MU3!p|!#StVpaeP2##Ch%7#?y^O%)EfuEGXHO1C;s^!Qgj8|m+i}qNsr)TPHXhH_A_Bkm)-c-dY3fQ zXcf0@h`Yni?Rt~1MJUYiNB@N%@84WHt3sMkLcW9ASCPFe84P6t(Uf~&J0vK ztxDLS;d(t1&m>KT%<^)91xw|_R8wBcfYBx`poMP2q2UNg$sE5eKDYKye!$tnQUqwO z#?}0Hrv=rtJm*avi5vk1Fmw}fClHD(yU4m;H-WLiBxL~}gdKQ}bO(ZjQk)!qL&j1i zk&pxbme3s#UUT&{iV`YYbLF%#6e21HROI{Rr&8L&!F5R#dP za9YzHauB}F1z25-*Us4r!>$&H<}n6m5XAM*O@lFB7~KiuDUu3I9y>?Spkv)Q?VFQG7hV+O3tbi9}7dDN(Ap)QelBT~H(3O*Q^CdC|wOXk@;oo*K zQMT|?=beY$$D2Ah>Vq`ny3?!AHzihX4*&}asp7CtUYCmO^hB+Db?y4UoHj}Tv`r#V;1!?!Oj8QTv z%sfr3XP9yznRH}+4t5#)=8fFGivnASIwV1VJvWdFHs`VD*4bw+CJARg?UnOD%V8U% zJnp){d859KcEA31;zXl$k1@XFTXOH+9<3Shjw!LO`F1(kQ`w^_=nv)gm?Z~PEVpLP z)01h6YPFV|9YE(DgF7KQeASVX*I*#5p>bS89Yz*gzwiI1`C4hWC(_V`v4ZADT}wK& zP?&I?x?KNm#rfAf;Ka)+@KQ%%r%Q^V!w>cd^{s+T{nRm913j+|fC}-=c@yccE-l&r z+<3{mvuIVt9%OQc(O*_OTMFmb;lVK~O^;WNvO!%eX4J*GUx ztmz7tMmEedV&jHIN2YXm3wLK^`ipc$@qWzHe#}r6LZecFd7*f4bA--%3i!mwU9L_! zq%fb2x4#UL!-5`i6sIRCrDdMy9B&S7FKZtEoRF563UKioO3yi63Ad@Sihe*%XTb;# zS;>mf;^?uk#Fag`hnaJ6*bgA-Q33>eB$?Bll8(Wqf2 zE(PTc#+2#TY*r87n4sT&Q5(>~M&}wz-NQQAvi0N}C0>8ODVF3RQwp^GbmTP92j-31 z5ntxEVR$*XdJt&f95#VXQiO~`E;ZW};KK8?ONBwx5J8ghL=V{3QCO1D059y~8Sf}b zjcjon(h}riTk{~w0mQSInbV?7o79sfHhTnTzD0L=sm@cBe95Y9ks!nJ>5S^?bsP&t z^n#_O7dIdcK-`IsH+L=m(Z1%Fp6k4!vZIF^*jh}m!GlRuGfeZ@61H&f#}dnQO(t2Y z!-(U}f+MrehVgI7VYTC*mRgYWH+_xfa#>v0IYZwWuWGR-ysYz=HgXcQjO^Z@t!;d5+Kw}Ahjao;qy{PkL)n(&&nsfbUz`9+_rS~#rWv$RUGFnj*ut06 z`d_xC6dh@#q>-keLgSuEeH1y}Ak9H_I)+Y8`}F;*8hvlV1__B_`&hXW=mBI&_)CEAqr4`u9N%Dsyi2#9 zqiwdZd~WwQpWgtl+3(XB_nlXroL+HA+57aVj$X5lK2%z-@vXH^D#Jz=`*N(aqmTI~ z;mf_wCN*~19FV(%n?prj6>xirwvGIC2f42fT^KNEy%cKYEd0Usecp_d*JA(L90k;K ztJS~vOWezHqtgChIz!E}?>+vWAs%dY_aE_m^weBh{`4rr13f-C{UlNc;MNzOVN~1D zJgIk1D$rsql~Uh|Z(({|8~gH#OrloXy_L|1vz(0Yx>|9<0uxqxrF;9xJer)m7Zt-n zx{k0Y19j;-y%P=P>z+#VXnrueEm^^yfU7tQy`cGE2qMxP|<<<<&k#>E_ktzeC(R1#m5LQz$#w z-N~6E^17!_YQ-9e_NLO#98CpL3o4^ge*k;L3*8srzGf$^A?V^=m&Y9f4%eLYLXDX` z`?#$nFSnLHD8Fq%&nHH7sJ@$?(icd21F^NVY@%jo)@YkEf5;n8$fBaIDUGmSHi%K_ zX=I|L+T)XEr1iI-|2PREP>1+3Q(qcgt~XqEUA%(oRCNE)tZKr#2?NpS=qei|(4Q0v zZ_Z;gnqO6brUAQJ&k{<)0h{;WJYG+=VyVjct0a2L{FjhEATu^PVk#w5@|PTR?q_(y zT0uhrn_vYQ-COb1#)^HTw8-!H@YHv?f$Jwba%hW5RKoaJG)uTUO@;D}8qci5$!MLh z0=xi1!s6-78onb96!8HdPf!V}+ZHWlSC+o=|u!j+gdup;L4lij+ zhB+wnjquOK^=Ma?YsH~~lrd{1zW9z$EwlBT;}j*abte4kDB9zR8`59*W&Ql~1mh+P zo%>|!JyexlCZ4f#89^k$kasrQyljl*2Z&?eB5F!>LJn)Nsa&v3+LCN>+rqS{hNo<> z468FobNC!j(X`z(-{QiAXgJn>LpC^x(`vj$RAWG%NFRwE4Q?CL3P|=JUa+T^YKue= z+qBY$Hx)}vBCUekv~mHSvR~#=TDHtU+qJT&Lyw&`tDGaC6`x1*82^)=k+1w#Ilf-a zV;#ZW@PV1Qut(y5$LqP&SSA|&!Irt%dVME$v(A#zYPx@5sfI%ltkF`Qn!PHk)l=)o z*1SdlwcSN^ffwu%?mv1A@#20%;|G4ew*GK4?-zt!omx*0n>0Yu%;da+8`J^yx4fRI zk4h+NQ!)vfQNqV(IKPkB{Wr!~l&hZ>QU&Y?C*gKIUj81Cx<&A>?j^pFWufymS*iI=?gXY;csbMWqdz*c8zum2CVP7?z-nl+F_gj&-(X^#RC6J?xUIIj3y z{G{`j?=uU%d@02YLw+ow6YwoN>VAOG!hO8&Li!Xb@ZRUGFqo`Uz_sxH0DG9`Vz2%2 z$W$a$t8#^mERxoSqLgAX0(=;oLcGq@9Sm%3fFM)mb9xLc%L^1ZzQKo9*n!fxmuUfK zWS$$fyNZ~D=|2fLv=+@cf8gxWgF^vYKaHUcP_OIT!sM@cbEI%`UH_FkQbp)i8HC!{ zoo0&pB5ITirej~gZqlZAn}lts^2}#}-j#Jc=cy(%cizNMoSqaQALwqt?f#5+B#_Sa zg^LfsYm6W9%tt}1m)RgkdploSXO42AxL;*&_VdAe(GpTPzI?e(+AO)Bv8~QY(1pr*mv5JEy68dMm|h($;XNRCZzA3(hNCp{ zhLsT{*OBMONpAl)j&9N=i$m>Amq~FYO>VR2_YB&d2-<$qDrQ%(LoefCcuk zqIYZ!b0pw~tkqjEiQK|F@reteaKo=6pHX+^GHhg)u{W(wn0Kv}PxRU)5}U{*eQ@l2 z#WcYD52Q)~Ews@#$xAsusz40rLBjF)d=~C%trMr0>^bu3Ew-?1HhyH*bnpxtP8c9v z?$Tk*TE~)>QmUN9QuVWC#Eo9uMG~gKE-!#$1+1Bx3&}sSEixR$XXEj#Lrz&;a+Oc0nLPju2b`38hG`fl4 ze)eJm;Tb*Flto_>_6A2BCWeB#aSXG3X|sGlbygm^s0TR(?b>yuGYH*{d`jarCWtT) zZZea(`{DEANCY@iJcZ210f22MA$<({SOZ>5 zVF=xu4B`zSHU~eTD(ODlY3Ea=>0UQDt?A+8=a$@D-A(*?BaQwZFZ<63QBkWorLp%0 zn}##hx0tZTVe;bKMq@P$$Cr=aUxPjm4I|+MtQ8X2{qIV5_bcl8dNlW>>bj>weLe|L- z=ieye3o&nYKhfARj{bF8KT+L4nVRnAy+n;vh3G3xoyz;>SDa>7J8-9uxIIWi#&5;v zyr*)$?Bk0(Pi;PEpFShf31Nu2bOHPdXj)l^3^s8an(9&H5hMq2;TURsY2BP3+FmaW z*7oRK?m>g!vDY?*m}Pd=O)CiR=?x*?tVEyuWcI^9@xzP^{O*dk9~(JWzjV{yeL|3k zf@urLI+|?HU8r;^|1M7OscNxAr|4Wr{JIM>Vude*slxYNu;&Begr;E7eSt z7n7JBd*A(e*48Mxf~a^`5Vh7VoG>1GyW74k{h*VB4?GdhUP;z#W9p)hFIKwjEl41Y zTZ#u@j9*Ai*HyR$?I8h)JSd-%>I}jhwm?ZDR*}nUNHlcM@;*qmlxJ-}Lm zs&Ix4cA{upPcVOHFct0`34VjHc)>;@;c(f~ZXfP8SvKw0^rDlyYpn2gBR0aT_axrd zLQ(63`CZ+f%Eo zei&q)CND)^yA5>?Ybk}Q@LZ}*M~&Q=oY=XdopvZdyvmhr@SY`WzMz+9VZdC} z^+Ip66CM-%d;dqF;7=>+8(_>W$vBTR$a}U$1mbES9#~j1b2$j0VS-`-U&C;R6{7_l z4DrK@^bz8+AruGG6END zCn#ww=b@Qc0}SYN=^CiGr0E1ltz<&W5AI@P#FwQE!YEnK;<| zXS;B}fH(%d`^CpnhuzKf+3AcNOBsG&m5U-|vCTjV5Y3QXu6U(tYk7Jp(B}*vM_L~r zCAmyJ$*Go6ziFvjg=`ocrCGg4>K1^$O*wnZ>%+&-?)d7>MQXA9wDXYFRQRqP1s*$c zWJza?Az>e0y013-jGTsvj|W4-K#^AYEkB-xd5Fl+tgn_O;>Mit3>5EZuF3W&$R%IH z`;F2!DW8ZOa-2O_$vyAQ&g-FtV5tkg1|Y}_VPe?v?wbgejg+hMOBrxtu|rgvS0 zon8lAJ5i-jNV%PX)?Wl#c9F)^ZUwv7a%Y4a!xs4q@X@_PzM%bjpr8M>4>POXhW;9Y zzGoYo&QLe*%qOaOTiTt;TIe* zkUNqLGZ`7-+f*u z{~Q7FiYsd^B*V92Dp4C1Csm^tJ_@zbl(6^JI}pKW`tLD{rwTgxx4pd5h69&nK`PzdZ&K~P_6!uas6qV`<&{ugNDTsp8Q`m8w1h*1!xzCqR

ebVA`g7e=zTA~`BNCQVqM zAu4I+M{Oi>W$LTleBN*^p^z)JX(h0?dvY}iyhYIvHqxP5iYfJmv3@{gmZ_3<1rvR3 zVaImq#R@iDN5B|mNy%Z)O%rFhFEnUPQNYcv`rJXio{QQq^5M`(?uz@SQ`KmzUk+M`ONhSMsykN3L6)Obh%hq z{j5IhbGc>pQ-9w<304!iy+=+jjZW%9^XvB+FHwVjcV5(((%fPe8dBh;T|~D47xGK> zHfi_jq>2pWB1dx}unE)5iwD4qO#wpdWs}wqXJQ1sHO;$^_GtHvzb6$Mh00X5dMCQn z_ImFcg)SjSaJ?07repMT4;*>YK8+gRxs@q=F-KHa*e&;k1B3q~0E5d${7b!pk-0{y{lr>5_TaW(>U%KVjwfY7>p=^*rQ@AfU0B7{g-kZH za0Uiv6iw@q(w+;8P&;aIq(1to!i-#n@!V|E455&i*`|SbZ{Yo{S7%> zSnAul!+iyI8`7uj{>VM8-mTHAbLN|SyR_0Mn zM)S{w*6Kdk%ji;+aFCo+O+_^kGwAS~U@jt+m%?Z!v{m-8@W^`0xPf+& zoV-H7>EVEP+B3ZwsCItxK{(957hB~8n5B2(kZ_88ah156T)s~N*`UBh9)ltUO+~z` z;~Yd1W@aQf!B=^tz|or@1e&@=apyWXN+>dG(}V<&T74SpuMS0$7&;&9 zZ{jnAD>PNuh$>@ie)fAP5)&q>PFPg(`B)OyqGfm7Zg^=4M?3?|>WHX2lJ+#*_rVDh z*o{Rbd=hyO{R)1u|HCkWbk*#r*6QrM5z^sHKkDv?zK9j|9BLQed3z~jI1{rX2Jj~zbbNDYA{{yBwD6WceZvbEfecv13>v5` zHP{XA-n)23IjyKbZ$W$93$uIH;#IQF(}-{7jVeP^sO=ZXpST=4SL)o=RFwp;iLH9< z%AmJ^*|KR#^~4rEKDH6J17RQJv!6YG%{hEYWyo*C<8pPcScU&Vr`1gA5NkoE-Ok`7T*UBJkLJ++^`dP?tq?b|B^Y0h`OQqx{Jw ztgfJE4aX+&+I2-O_kdJx^3Mwq9ufiIM74_(t1fZ%dRre!Bp!)s2jU%tZ+*|CWGM3A z!ak3o;)^hzDlgJj=DZl&+fZ zCN;F>6|?O(l+PNtT;`)0(CeiYym72?&uts@TBK+%{^w~%?*M2w?rRJrfH`%fNElmt zy!LZcs8-M@G1Lv;a|}NGkVpK`YfEy@@Nj+@l1JuvL|(KM3=9M|6M>2jceBv?r^m!%&&+Em$FW@}u=Rf?kzr_M3^TwH023bZN(HmiI z_^eOYDsHiCY?^cFS6Gym^2rpZT^s z=-t`KaX+;ZajC@5PPO#-r1!xZw=*mA_$)iD?Tv$!Rp=$Q6r)+dU)v3Z9iAQ0Sd; z_yi7w7A3DQmWnw7*+!<@+pF#0eB|&FD%f!wHAXJZgiPniZGJ+i1lp2&$I5q>lE>X0 z{FYry`cy9*gIN5LBsJYq?Y~p$l%|>y?FQ?<9kvs`^Q7JKriP^03kPFYo&M@hI4CI+O-T{mTGVlY&t8F(rh5426&K5Z2j=xkJIT6cJM@88aqp#d|g-jWf6k!?MK6xeu|tQc$U%4Wg2=XWh#U)wpaZIq*ib7nzzkmQW0O#zm199!Y*7k1o!ey5lba@qD{Ak-oD`lW`NaP=8( z)yd5DTQu#>Jdn$P;SShNftnQAywp|s0*>d{6*7*jO-wN|kVpS5kG@vhQ(gMH9Y2T_ zxjf>;V99;yi|}?H3ZP;!-a9cb3NbqXN-4`;MiJ^7e=NE-+3^bI4jdf2wEh0AiJQsd z?Y#$+y3q-Dru_t`y~ZYg+XQqZF(~Q^{n!+T_Q*0Mww{RX*P5iFY2p;$P+W#Hpsg`D z?^ns;Z&9u9qJ$}Gp=?kThU8~ZKw3jSb!f(9!d4yPx**ru{;oRn{jV5-HAC)9amnxL(OJd zuZ5m;rC1^G&BaGGudi$~$bvQDOJHQ=sh&}xT*UDbyP1MLB?;5(x`7xgZIc5>@nbeB z{We(OgQvSfG|R>jV{&6V8lE#T-_qK_0eC?UYkwa}=j~;Kx}2@FrobgTmHeOlZ*nf2 z)#86ha<8&CzN(g(cSkbQxeW;7*ic#X2m?!XhsWx;NNIX?XG=nlli7N%Yr4pJ7F>sX z%V;lne_yGZCs4H z$=KMFU5^^_8|t;6O}eLq-9eEU48`6Ncfk&GvePIy{L2bFwT@5Nx)|#0zRIkJrhBAs z92i7|rOF}A`Lt56dbse7P-@lVZZolHReIZae*IKZY7^5lyY6ng_6>deB*RNVi;#4Z z!MB|cx~)iJhee?3vE2K5@l|VBhSfo1rw(@@>EibjDcg3?POKfJa){X>)cX>N7!GOC9&Ne%S@M8O zs-ae96=OGS=S?t~E)bn$V}^v~w#ZKyw&7O@CT8_0b`hHH*)NVcX*8{)95gz)c9S9L&l~V;DcI>r}jmwx^UWMW#fwED814xQy_ z;5|xy2`vM(0m=Xq?DOnrN10Kb`ebLaZVVGvJ&)pt_v*u;`lHq+F~DHaOaI7+)r?iD zI%)K1R5&Uv4Bg0D7b;qhC>Q;P3BS(~nFKr54^BJWWAFO-^(G6rd#&)px^v{~h@NdW z;>nkJ{N_zIq?f~47*M}vBeC=8eP*=~KM&t+1o%kQE=zSBY)zjQ9?91e)3$usCh9)i zOeHlfD3fk|$w0bBM$atKa-8dx@CtUF%`bBGqt|HjZT${^<8F7=X>aIRNG;{SQjS zoIEFw@1xo!x}Xf-XlW^w<%xUsd!eEY+`882@6lfbZP%+7Gcm$y-3BGfz#a%7IAP*c z`udXM`bP`vF*>Ff`1*~()^Hku8Jt+rg=*!(X!`}`KYsZfxb*6m3i3=EfK{knwFVs$kd~OzZ1=ACzA1~XG zg3MPBQ|~zxyEK@<2PZ)j5N!ixosg0u#IfBLUMDrmfksp787xjO0FcNP(>$7>piqxQ z9_ert8pASu$8?v3?VINd5AQXU!T{%|U7R~B72s#_W@4bo(Z7MQfvg)uM1=N^cBVEC zKwseM#6U+QULG(U4ov-}x%I>7oWa=03GCCy{8B3)e#M-9SS{?uUfzvt@Bv}%?DVIM zoLRZ#Mr!c~^E-PZLb7({`T+hn{C4q@hyEtXX?ixO+dXt6;puO=ueL>WzD(z`s2eBG z^hNc>P%~!NwCxNre-9V6$rsHtZm(#Am4>myT7#XCipu#)f|16`3hVLL$vIdx}Tw+8vOQu4#;DdOWb zxnBQ*ox;XyuItAM+Hdy7MGJj0Vo+QR$Rg8)4el7ikiC@S^D<*t>$K2ij#lWRyk*mm zbob|x>-9BFJmt8{XCnYdl`V_}Wy?BJ@yrzd6YI8B^fRFAh>xCcU*+`A(deJU(w_^b z!6axF9PjM+JLkXdRumZUR{vT{3H7zM6OD!V`<3SPU+SNztreliC_H**f1_cc@TjsB ztgAz~WU%<%Jv0w#VW0c?bgZTMzGNaFX_RR`6~n7?GoR@7G)!@*5_69K$iZmc_rD>{ zjW##D4Vd`HfO+JMI2DokWBoL}sdN8gBAWY6z{IJ>k^0ON9)D2RCn~&3vBK~F2LbHw z6o!D7f0Y9M%TPk`z7cB~Z1+Z7)cbh1bkoJ75IIpU%4dWiJw=23<}8Kn1vv1fJYk{U zDg*nNG#tVsKmY;7wl~BqnG9;F{g@9X8k#O{W(uA5?rcowC_$NbC^kk~JJq)Ee+S|U zk?(pA*&A&hodfM3?kweulJ1P|EI5#XaDzeNWD9D$tF>MDyptq7g&2rm|nH&aLDlvHl-V;aV=G=wz?%{zt*-A@vlI!ZTm z;bJz~TqU{u;VIZ1QxjhWcH)WWghkM-YE%|i|5MMLi41lWY-RjX67ytj5ZB>R`JPLM zcf_?t|5Ti~hg&@m-O+F;Bu3aw3Uxo1+ZVGt5}Nx$eN`@8$V`5i>UG z8YcVNgO?)IPTch2(&COCJD>A>Y5)}-AH((KeVZ-t2eXa6pa|+-<|!T(cP-Fxjl;VQ zEj$&kQ?Gu!W^6sH(jo}sE*q|*u|h3331wFMu&FW_*fxCA(?RT6!-%tHjl?(KS`R7B zwsvke7hqhbiAz;#{XA^O~=`{>cg=%r8K00FKWDtay5YrkY*FS<2^<}6oH#*=p< zhf;i=Ij?Hgf0NqFp8lV#MCD5%xA)ursjU8U0jfO??VNswPqS>!`0K=kcAvagtW-1q z`AS}el|q4#OUS=6bULD*x=H8zS2ouGty1hW-v6oEEH7Rac&&eKtn;r^{BH%!2QGyC zH;b)*?r+NWzlqehmETJ}tfR%tA^cVT=M_0bblQ_V3F1F1==v&P`56m=cvR!tU8=sT z?sp-3;Q{;KCiRZ}`J3y`LoC9{7KxW}-ZA%ki5i1jLtQWVW+2br!5nidjd&Y2XUJr?G~J0jme&rrLS)FdR572C$|9jrxIU3yE~WEHSZYOR&z|*TGv+X9qT7O~>3y?MNGTu_ z>$}^yuraM-DblHDDbhuOHxHn|N5d$iS`}XLqAQodj$O}8pT)6@Y$9Y$K^2kFt$Jq~ zMM14Ra%W?g>@cXilfs~Fi5xGwB~q?a_7%}fFKXYN^{HiLJ$o zcYx8&?TQZlTuP5Mq;IzMeItCI!MJ6b(Q__(tQN`uB%;Qz8Z&i?ajZK_70QrAPXa~*#(5|O61K!&`tfmM&7QFN z?Kox2V@_7XhP$3M^(J}JFYFl>4})5#eAyL=gbdbi)qHs)59k2V;*Jq?z=ml)n^ z0iPfaTq0w0UzOU*@5sdbqzqP8)^fS)cu)|b=mejVW8JZnPLxsJH7z(_?G|LUcuTf* z_KR>Np|>>T>z&Meb&3GJ1OmB-s91Wg7ft=(P?n$-TCNAw0gI*6HF@^dXs`|IwUOtA z9~MQRWmwgi)V1Nd05mfMJ$*Pi(P#<1z15M)?hw|nxN_M6-LCpoc5FkW0moY5=Nr@t za=JSJ7-I&kPQgpp#-#~yuW|{C+UvQT?w>SJY+>eoW+~!~{h9|TcI#bGE%@3)48Xw7Z zST5l5WZUEL=!JpUaifrIPNi_iWi4o@m9+rcRyfL$PYV0}aeLG{$(7dJ8!5jiy)z-& zy)8dV3Z5ZET9Cjb-Lukelrc0>7RuY7^fvEprdUzVA12pET4cBDOS)3V+(RRS<`2u$ zMJop3*=7<4$&kS@QO}t%{<1^A#}!?!-F;)KM53r>K*U76O>D5tF`8EoJDlpg# z3WOmX1c5xXIm+z`I+*d8gX8qh!7`6$IfOYtt;3_4?U4;Rjf3YyW=m7EzOcZ;g1o@d z2R+SufQ2Dnjs;o&o1=%W#_*WUe&fldMd=4@xi!11g@i7TX_}$&v0AL`65xkG<8d#L z1%7CK2iC%;l?2j8O&KT#_ylEUm0Th&G|i1B!-VGTv}D1u#?0q!@>`oi!4Jco!R>W5 z4n$jv_S@p6u3R^$Ke*+DxyPzLL_CR;^41218vLBy5$RG8HLLDwThEp`ke|@5z4|RE zy4>^jCpk|}0r4b95r{;emzExhdm(&gE2lkXdY5&9KjnK&GoV~v2HA86{)uMT#fxO= zMH0;2Fr+MZsZtI&$ZSYW<$E}tsU_FX;BI*4x%NEgOh81E8YpSjx;Rq7Fwt72(y=9J zB-gi{F@WEV;#ZWQIf>YjBYRC)#2sc1khoZa`#u1g%j5kprzoMt5DkKF3Y@} z*kLQ-Z`f+19$UlXg@`gAp2$Tcp5LwXir!=dOo zo%b6EGDlXEoGrdQFso`?Z%UZtXNL~l)#E%&{5pkBoxflrp`+JI3h&E18qjqzg@-Li z{=IPS>mV!smaHSKr&`Wn+p^fdxyBtH#?^fx`9Q(0$z>5v9_xrRkc21s+OGB{PIdY3 z3d9&KGS^7c{=wP0%bjD28B4;8GRe$l%y^DYE7r@r4~#LHs3~ zRGyxlYE65b8@ym&fW#0)!Zq;!2powBU*=45A- zPmlp9z^Iic~{o6fc$7o7iLk<+5J;s?)Qsg?KZ>^!_qsyLySQ&>u` zUH)DEu=i8R=FsgC_`^boU33O5@;XVCfqiqVHnuI$8$^{Y&MS?gJ9NkplDS5F)(`6X zpc5DQ%d>E;18do2>U)jL;`Nz6QZ@o$j-5Jxrl^yj8ua<4nS|~da2T2Su2Pf4JoioF z!yqKb`DBvkq(yT}aP@oSJ6z5P+h$N{PA`Eki40*X?e(exoYQ9|kh(-cQicrbi;$FY zDBd<7oqc|YTxC=%t65s6m)*J&NyC^nahpt{Y+i=jIV9daMg2==`BZ#Ltbi zc?8L&ZLsh?m=+PamZb&87eC(De7`;ZRhoeoiwc{JaSxUoG1Z3}v`EXmoS^dSRKs(7 zkeu3R@Z2le4bn^;gspeN&9>FdfcQ{Ifbhh5$*x7>2dmOlw6;9S%gRS#I~;PtdDJ3) z)B+04v|bWjF1v9M>UHMG*QT>NOP#_a*`>4}7LuW{%a6q|&}gG=LqurMWb0>24YV}a z-?wd>X=Y3Y#RRG-a$++em4_mEo@T4*dN&Y@!&b;p%<#LM(C z$tlst1^(&s(bUnSP!GhBnD%n1z^*}4%{(WXLRGnYT#n=?hJy0`(mooJt%w+Vedc6%qd{YPCE!&+Mys!x$DGLGlFY*p z%`&U(wOfRV1clAAkk0{8U7y(mNjf?P(8jl3ruqX2N!h8lzh&>9G)hEeoqUj$ybBoM zFwR7?=c0cY8s6;nr<#=gOklN+&`Pm6t-{%ngslRmsU+_@dT)&BKSY+6so^50vQ|6x zBoPTy$nGC^CQ0hbgm|o1OF!}tB`eI&qPn<|8{nBhvXm=r;iL+Rl0NKKFe90Lt_#P6 zvqAYUeLM5StK*FiV|-CV7wArEy73$SMNIx`d65t9oXM%JqEr8PB&^s*U6Aa)IDQvL zTa$k#`Fv@zM(JgWl@h{0kmGli#)~b0H%;NZlHIxUdv=yBf}EysQ+*9av(W>C7z3~F zGrKq?*qK%1W|d#EN78ujdy3?WU@hF^oYpzPmapOgtWZf~7oTi7V+e3lp_vV-zAr39 zGHWabRu~41z4j1wKC|-x}UcPk)}hmistZU!?`*(R%XumVcpX zcwpROZ||P=QFPOd&8~(oUF`i)w_UZw{5t%4Vh5~OKgj=Xkda)i^D=lT-!^qM+rsg$LMkH*=Zin|rbP@(WvRP^}qQ1`hN zl^67IK(k~+m2}Pdx-;WOK}%;YVtE3cq7G&X^zwRD_v`UuXzY@y%9ky#JonQSh0#vRE8=smjW~>ByQE z7xQu7J5PQ-lVk`90VECGMXEHZ(xnq1UNyuk$QsnxtQL=Nun6vF$Ssn0J9F1);bV0 zRD+$gM*ujx8Cyn`9hSlgRmXY?aFEDH`zrJZ0~e7TI=$UsO8)dK6rKmuy1V&2-LNkv zEF|Wr^Vld(vt7xK>F^P<$MX*?9R(S8+$rSZ#Ots}=x5x!Y(+d6x3an(QZ%X;3Mnb(9~(H5*1k z>!)Ky0@kEQsfN6}Ls=ZAV>H|{rl)LOpU@TGir&e*b&r@Lg*cWZfUSILIMRF8bNUp2 zpdAmZVcTA=+j>9<-}Egl%D0Ka-XeE4eJ$m*d^3!8(k_{$(KC-)mhQ)R6qE4 z>1H-bC;w_+!j$K09U0KK6yS4!J6*tx_jfs2yHWqkrE&K}z2c?9{NS$65Li*AlF%i5 zp5tqj?NCow?$|oT8!pbJ^xc7qo8Y2vK}vg#fA6}9s@dLHf9^}mnhuI9Ty2Y#16IHk zy}vl+xsx-n5XD8dsPk~uPI&28zCk>vx+700sdd?3VOpN=3HEKrx|1eyHrZ%0CX+?k z^7EcCCcWI;9;?gOnS@VKpnL8qp0nj|lLZSG#h4sCpJ+{_M%I1`A~ektzXHh0 zAS_5abZ;6-mgQ>Es%ELB$1GsV^jIPmlr=s(#Ww=uAR}Ft|HpRV@ zBff+)&vkc>+*!_O^}mqjm#jL6#ipVu3& zrCg%>cno)IIYR}9`n04mGCBV*AUeHc5S`00h%S->qC2(o2Z-+1e*@7aQ-<0&UrLB1 zafSOOEpWxrK#~k1Q{9f-b%aTvFX$c2qO$hDU z=*;b?UCVizt?uNwai13x_<@*bB*C|OMJ=j7hNVG*gOVoIibs&g1>LantjO~02N~~~ zC1i@c_ID_ty34_$45Ge2!bwO8`;IyGBLK zfJLcsz5#!m%$yYb$#yQ`(^<{UkgD?FTviv3jY@43A4 z&pqF*%x^XRtOfoD?aAC3K~ans0mgl{MC)fQu(sLZ@l(<^ScG~zkn7Qze^;J#UwSil zs!V^oNi~rz#S}aSHA~_&(QJO1Ru~A9HLji8d*&dDDDB#itBA`)Xd17*?pBZNUB!D7 z3A0A5Z^K}X>Ax}&UWz;4>f+8%PfI@cOkqP^HcS+&h52;DDKgJ`>V>4M7%(Xg(qk&p z8+YRX_~Bfi;#4Wq~}_zlMILwcs+O zi zV?Qa#K3h?&)%d<2CYYna}TIiTqE{DRcMsq;VIV*{Q%|MM$dAwVYW1#?v%^rvh67r?yQOnkpn={ z1>4*E(mXBQt^Tf(!_NNYEVIUMmc{1W6(xAsG#?CF^}}9EINaJ9zG(dD218iYH><9B z^zJ3W{W;!TN7Ip%P0lcn+E2U)f1{i1epow4`<$(f8#12$yh|Q-67qU)+P!ZP^(#q#8U%`&qD4SL!s`!`?Km=Cr_Ez2}&PGf~yL%tTIJh zq5P*q9p+zrQx#t)T$2p=z-zX>CcYyFjLq`~Hhl6cIYW_>p@_2x42aj1OPnm@`4_R7 zf8T`xx78ooP=)p z-@~jkd*eR-H!y2+GbWj{l=^skSpQ;q&yv93eugo*#6KmWDA|gT?cAGeTw!b&~FG5OV$ThE65R1%llfTlYKV+h+lx!2={2 z&QOpuRxNMNeCri4-LK|GQ$(g+oz?pHEKhN}vG zZwthF8>%*-xxx>4pW)Usy+1U>Tdx80h!WNb*bCV!ABHqiMQIy;C(Ubop=Oehi5E-E zP%QM#kle~>#?@8_cjC3D<5U5N%izA@@iN+x{4`_VMOjDE?s-&U1Hr-}eqpNR9)v=|9jjHsJwExa z@XBWwnhG|5)Zcl4ei2<0Eu0KPw6pe|!4%R^JH zNIR;Y_nr?}-0$QTtV6b6sW+GQnk4aEruLd5PWMwZ84CA%-BJ|0rxOuZWt1f|`TJ(4 z-XpP@Ab82m%2r>uGQq%*KByqM!ykQPRO6|ZVhmpV^PaNM-qMd|X$EY#pi)Zu#)mz0 zP0?7d<(RCxWQ(HD%u2m$=s*{7D@vRi&&vC1#9V=#i=OE} zm7XYZV#&yo;;ViP^8O(>q#`RfAfJBOh{ap3zxN)pn_^H;VIZ!YYv@OQiyzT{RCzl< z=qROfjfUAXRWTcWKfRwcJY5ywX^6tuQnx!Jt&wf&@s+TWl;OOIi9E!8$n5e2YJilU z;WoD*>eYWl9ABOwAJ5AjJc%HEw-ZPw(NHEchf6u02K?m_M_Swfl&OAWTQ2PBQR zEDf!L=^?{WdU9cxlAeUx24FpvVkPE;_b$>C^yN(EchvY7h{&^M zkB?FU91L6HIvC&E@5*7mjov;x$0I#L>JSAHfqhY-2RxWhX18G0^?rikTn(|&h z(kAFl-k204UB|U!=A|px`X{{{b3`u}dU-&}gdbC#El~ISP0L1bH;-wg4(5NMucnm! zg}%CbWwDJaZl~jM|J$V75tPKZpDu;IiaF)JdQ13>1!{_it>R}Ij(4qt&-I8`o@A2Q z=Qewz$d@bm=!=PlDIN2aL3>3J#UhDE#Bw8pwWPP6qK?Tl>pBvoNPP~HN+rtYV!7E) z8=jf8B%hesrzgM2yx*3TS8hgiRH2AG$dakFPbfFLw5Tg2hL4yny0t){QG|yeN>+FL zqTa5qM4<|ux7Gl#kh+q{u4g`fN6x|e`M%<4GJ zQJzsDD$0i<#DHY7T`B`xG>bAECy3>QtjHaL6t1l+j&ch|CGZ~+tGgeocOp@)s(G{< zRdVUM*flJx6#8x+a7^*;we8I0;K$Dm#o7qEuV}qbO&Av0&S{2iept=U8bk=K??UM| zI(#tUyN|&ekz#x98x7i2Rw+qGd&G~j{LJC9{1-aepovMPS3QY| znlhnQ)-_di{GobGs(acAnfvN&Yd=l(_MDDM0fkaedjt4;ZO2219>&0Izk4&GBYY0m zTQIsUQT6Ync?RF7@&A>X7>0;`F-&3iYqmA7%G4HXbrGn1YwTE?1LO*C}Md(Lp)eFD^4_BwZ|+?s8GE z3sQ+)@V*GF4hkwHwa+jIz^lj(0;If}IvZ$$q)T1MxMZ4jO+w|D8lT)@y}|oqkz9|; zVm;H{k8Iy*HZG2Z$Iwo+VRX8??Zy-J;M`m@Nz<>&+~-D?=0DjAdQ!-B2DVL+3| zGU1H?e1wvF=q?Ygb>lpf=FFY3wE~Q0cI>W8SoBe@iIUwzeX0jD9h6q$Iyg)~lv8jr z+6aj1O0}*sboafmjZqd}i+!Z!H*i_P)XQzvvEMEfCF<9lmR5LXT&Al(ghB{2Thn`Q zAZ{3J=5RgM$ZisQ$Qi%cqBDq?#$Z~V*qa%HC#O+I<|R|b4NIusPg9g3(-4g(!dC+KNHIxH$Mf8{D5 zajv3B?=nRw+1=edE#DSoFj4MXLia4kV$te)FZN#HVGw_>-gOq z8!zF@4WD(KvM82>6t2{?F5-Kmb&@rWxa$;%OPUyTo6BK^Cbc@Meinw3Z}ATsE{UbC zotj&jA2lxtXG8(>)`5A(j1fg+>Jww72kZEadWT{V^K8p25sR92Inf^7IIR!q3;JLx zr|n>h9$c<^DENSL1Rs|Vsa$TU(CBedZ);-zhyW7hJaI ztk>ohsOx}l3?#m+P|$-cxGYTF_#BXmeWSPCj0G}X0D#Btsb)d|9yh2$o-b$SWf(C? zv91f}CDtWu#xtrl?M%Ou-wm$Go9TQAO@vn}L|s{~pL*#iU+mZMO>?NDjjN)<*sxxe zelnKH$+~lyknW=;_<%!IfLXrJ^6JjAc828zszu&8InAz}{YLx2B8?HR5!>Zcm4&{` z*~piS`lp86AH~#l=iHG*Mfo&bI(=iPD*mc;Tr7)g68BCf)bH8o!KT0A`})IqZkwdo zHEOFNmv(St{8ZK|1P93Md+5%C(?qEs|0xu^wD5eFj(a%1-1smuX>`bYlE<(+k_YGR z)aZ;dh291jb^~g+%*Lu?M)tmru43PAV2YoAgWg{K*^ zkCU(-&aML~5y&QHT$OEhgRRcNr^={FV7^gW{FJN+?&cywlOJvZt7TdQ$H>h|T~X}z zQg3!R47aT+Sh3culJ*o*8s;s{bhk6{^THLQZ`o(KdtQ-)*7%#*U};jl^m+^Top1x4 z?rtJqSChpvKr*Nlyci1jt<{d})SteNoSQ=_BIz6=0$qKPNp{jp;=emE9{DgPC2YYP2xNEdG`MiV*7tIj}KRbRc`e% zc5;i-7y9*)Ld&=e&9-Y9M06k^UHt7|)0oiF{ngE%ZJklJ5Dm0=Vz8AG2kfi0w6X1V ztq4QnWa1-cSVsltg5OK5D|T>=@NJ>oVa1}3_4&GyFmHTe5w>INz6+)XP6AemF-c)M zH=bMM3Q;9?kCNP;D^5B`Sgx3C>nmjI>WY9quNVd7YMACsbkty03Zm_Xs%-U9MkQGb zvihN~_{P8!6J{+Um4pxtc>%QUVa?uxF|gO4a^IZ=ci0?U3RVn0w*UNjD;ctgIBUkgO$Pt_EoOL9BrF}44Ah|d zw>y*BXEQ8GG{B`?P}O3)&#~DUShWjs#NT)XtuqD7pyv515nR44-qtspESj~DvTk}g z5nGa7S|Sef)^uh7{QU|(hW~qC;s33B@P9B4_HDH+L7`v}z!d^~340g=Ggqo;S#Vi* zbaz+uTifzTl;@DN+)A%)_L6dwXYBFV~F<1Ca zVL7@4ZE?50cTZDLYiHEiuNl(q^;~o!(Z}vNxbMZPiEPssn*U}IjAgF%ihl-cWyDaM zPM`Vj7VBFgu1^$;Z#Ch578zwaj&;u~ac;-r97wfP#gqJ;l+4T#zc$pw76Dq2lD!+>&l{ z$&csp5Q>E?bv(2ZODGC>y2LjhapW?KO@(myYyWhcebWm;9A3TT#ku=&|0p`37dq=n zy_>mTlzLU4(opGqQt4+qtl=Cw?`O=Y2EWqJ?LWJH=bPgqpy#F3F z+*>IqBtrJxHQJ{$H9Mp{R_<+u*6$22&UVetc5?+NU1Btw7~bc zsG*F#wJ}8XA*U4fHsn^mV%#8z%97gwbY*?eJnf->3`WkRz+FO{@^f);SROp^d85zz9sav<_Z19hq`Yjhm0LC4Yzu$%J6y*CNkqr^v0d>!g~Z( z$d4Hnl&9!eIq%152bnnKxAWUGqL4S=4`D}Lk` z`xk`rGz>9w-Z8-d;+7otxuw}sQfNcDZxka=(U8956GwjY5vPgYft;eGo z{vPhkB7b4&bQfJDhcm1E>w##8E_(WJOs!|+gE`j;4_3o{Ea#|0v+dV9an-NOkT-?ed03B=)xjla4*0_O@VNy;cv3yqvb6XS--VIPet8ENM#pe4 z{UEjaeLO4#Vy3hg`k6kdzDyh=qCp#$>I;-j|WZ1uvY#?nJzND6@Rj3nUb(@ zlaDb|MoI1iSmb{@`gZ)rki&xtA;9ybAw*JFOOd;ab(Y z6BW=g#|f6vJav#s#&w+xtdc-D*`<5Ty{uPix#ilF>qFkNvhdN zwo;2BRqr5-)MCu4JxJ3-a~FgFUV}q(!-9Z?-l4e3u7O|=t&f44cV1^| zY+D9T{RpN7@xIjNGti5Og;Ce?Y@!BLr!4r zD9mk2Yuycc%Tuo(6M-JDM$0hjZrA&k?8kT;Sb^pf{dFlds^j-4hxzpedm7-L@_F~x z-kM~OgcSZo=0Qf{q+qLCL37)VyPX9pLHfj!R?y%o?>GOfF{hUGZDa6K+Wq@x6ST%$ zR2oVKi_J>IwlPI!&~4QW>ox*6`_{p?ghMf(RLR|g?In_n~5f{w~`Gq5+?sOV}WNy3sxYS?)-ez2r z!*lp@R`zbj=klAj7V(N^$~kmtY@s#Q1+q1+5v#VAfnha^cCVup(&qNpSeWz^??G;= zdP6==z!v?7Cj!L1IRr(_Z~A|9;2I3>G@udebh*uO4Z_f<=yv;QW`>b?b^jhgqw7Si#x4vmBPO;$^fV?U5Yumj-?X_T}8^l z*AOOOoL{ngJ}4b@TS!xNXE9qm)e@5r;!4_6sM!Yk&y%jSF9z%(LFteK6$nxG@!ZAd z^z_(-FvO2mM|t-J%Q$snB#~e+?=844yM8O~)jQqs-8N91$0DKLs=p6MAT06@hi0hB zJ=gQStl5$~>3q6-WshKcJq1;49iNbUkU2!pjMa@1g3pxE?(^|fr&X-1S2u0TuQ|H5 z++(?GWh34&>+{-W=;YA*mY|lb#{-D%A3S_&+ug)@D=BC57EvfWGn-7tG#&H6YLewF zLuZ3dhIZZZ6w+n!lOw5XvIM3Ws~L%wK)w;#ctu392A9IAtQ2GPJI+?E2dx(c4IL(& zZ%mB}G)OdqGyuG1-&6)BPl_qd{_3p*>nf}1{vggQEm#8qwol4tG>zK%1}QRLQR*Ln zx@Tw=HaQ^hQk~UCfEUjrRvb^5_31@;1c9B#ik>K3AXQZ!C^k=1H{VzjzgUA|z#CT5 z?cQEfAwFKKq?i=Whp)>fD( z<%JD)PkwFop1GRg{bPrWUprfO%RIjb2)hXm1m#b{YE&o{2#L4@0W|z z`Wo;UuOo(1rl7dEk77luAQcKp5-$MEe>0JP9_w%R1ofnh)nh(0%AW=*n||Y=M3g%t zwT}X)%$0aZ?qB}xEl4`7dYnKOY%)1yzRlGkx8BWP?M1!4#!6T({my$oJ<-+XmckRh zmHX+JpYWa0`Vl54gpSOV%!mqB5S|lc@X6AoG(F*4v)riCBq6vhrdt_3e{Z84^Z9sZ z`H3HJCRz^Q07KmZGAyE(W{ubZuSm+Js85o-jAF_u#?lvdLgJH4kiGJ zVNLBZS#g9Dvv%)JR)%@fJDQlJb3ex-0v0qTwN{CLN1mo;%9RuT4^R29$XAzG*u(Eq z195k^4^}*6$b{ybuNopho!<(|YU<9KK&qpsY%wT9i7i9j1nZlKdaE+`o6pUOrHSc2 zNVNCfG$NZGztXxlUB*$b%#|6FSQ2AAE^IyD%$gQ|k4|1HEc@97g96u{Z(VPFE4$0b zKF>(qi=3=_O7}6#URzRX`mXn>u5UKXrP70+HJe48K0c}C8q9Z+?R6-Sdp1n#)d#h$ zaTb<&bL4ofYdl}5E13)rwg1g5Aa`KeS3ScTM5(Zj9ZrtiQ{SD){m4++Jo)fOklzmq zwXfxf+UNbNU5bloP6NBw^`|Xx3zI&3M9-YX{B5qA;4#e)HVRkqQ`Aj~GMIt^YiEn) zm3dx2{WHDGO*(|8;ji8)W<&mOLYLuf&ATlQL4)yPc^|&Eh`#lpSa(dNze9UpY_b6_ z0Lpy^HJc_;j}N!J{Dkh1v^(4U#_5Rm z9fycHZKUn?EumXiM-Z-0_NFyD^AXR|N~{>A4V36swH@yhgzf}VobZA!z4ppriGesI zz^t^sn8jDl-$^`U5?pfPFC1jk-d*_*<_?JjCEtCaUKSgGwd(qNKT7s+hv)+;QTR5u zGT6#x$k^ly2&=B^Ht%Ll{(=cYJ&HoQehHM1j9oiV#&92w@2bs;)Z3Gt#^jt1mYo1E zpI-SkiY(l0YGw^(2USUcB;JU3aV}l*I4>7M>~Fw>^RI?+)t=~AiFx=sm^1YY;&d19 zZL(D0(X+PWY0K}SQRb8tH=;s1sFiCU5UDhxNX%st0?3afZPc#eliq$gA-&1R{iF?b zu&V?3PHP9=0dG))H{d%CVaZq?jE7qT*Z%jzY5L>EC1u}wz?WnH;@OBOCxHn>mmL4< z$D-g0x?VZ{xmUZvN~6j%F`n9^%H?yzWXkzkQF5co==}65D5gru?-pNErt}PDq!^sm z7}qMK2plBoFu-Q$Fq)ufRh&|7Gx~wWeR5><*KyILAgJuFnqWr1q21ARc74BawQz2P zmQrKr56*#y0-nxN9XIYV9?i?ZJ;RSf!oO|ijosoaqs}pL2behq_aa{hPJ(#udVZOK z_W%rnaqeXczu3^3FZ{9)#s1}jGod@mb1}4M`~%$2&{hQ+I4L*}QJdNBO8A-j{I$t>&G$GcA6|R7BteMJ^9HWrmC&+*IOA)G| z6}z=k8d};3o5rDGTBQ{5VX~SMNO)a9IADLqTQ^>azn7(H`~axJ>7o)&<9xEw4B^kI zVHiDv3I-*Z5m{5yhqBI&6nfsM0jzg;snq6Z*VeM(Lw2r=QOS6v=8C6YaDKGr*toVJ zT~$3yDqfoDDbDJhYW(_5^>t;Eh;oJ=74;4tYBz^_XFrWy zkz=`?zwTA}K-eBsn(D_eu3C3ZIh~yOU7%U+Hlx#5SKb{1m!!`LYZu!CIXBB{o9*96 zoiBhn>f>U0F4=hs@mKUs5X1>}SajnoFGu*T(@(aWn)C=Yc$WnZYn(U6`vXY!i;7$7_Aizi(Zeq}GrQeQ7GrW!Mj;m|m{@$MM` zhIDW!{J!!;dF#`ZKkDWAbbUtZ>=a|*`cxbZ``#9`ff-zhimCDD9OquNhQ(9ohblfZNT5i~;ja}2 z#a#>4=`$z_xh7qd;WA(@{)GO!R&4;+Smn&MzOEl$(nfhyG4TAVQntONrgMXa^81}$ z`|-okFICx`R5xFH&3Dzme$I-68$nm-v1Z~|GV;_+=F)iZb%>=S6kCYeB8jfMUb(=z z`1E5gEl3~z^tRVI(Z))7w!H?Ya>&S%8K5N-*_+*=yHG6qV3)vGlE1&5~ox3&R=X^s7oabh$3BZVLx@MQIH zl$||~v0rzCBW!w~Nxs4L-hg|RPt((-5!};O^CF9Sv}NKvu4truTAIw zY|)6Hm%A}AS^R~P~l#H%ca&{l^f{C=j%fj=s=DT|q^GeCDEHb_=HCs1y zM#&~Gbfw)Gs2)oI@@-8)?6|mB;V6d=506 zQ&3IcMh*$`zMm@B0Wwg@mZ8y&S~YIVTX^4OV%9=o&3{Ynpe^xoLk+cOD(#9A`gOr*(aRz>6pByN#C@vY1^) z{I1o5wr9ETT>(brZ+O+cwGFr?_yZv2>y`FtMJ#e+Y59N^8~+Q})*&0(Xnd>cdXFLO z%@&sV`hZ5KV?R}-C@_PD_6B?;%`pLiDOL!-{R~&>M!Vs&m*znJ-QvhXJhanDZWQM< zc83$r6O+He;GP zYx1pt`R6$|A8y_HzI-;6IEIvdDQ{6HGnEtfh4eY9XiAXl4BNzGNtJXe0p0BDgW6(U zKh}F)QY~3)wMq>p^{(TlbA&Fc&a8zo$~r~W)THt3m8*R%WcM{@_3BU#=#*;CbOI{- zHVQ7;(KLO%*)485EdxpFK|_I4VPCJJQp&Z~4!w+hgN zc{1Lkf@vzqZ>||{NEm38O(~7-Tzd|Wh`NHzYPhCOPaBZzrU{VjNix~$w5~V7hA4IFaKJ9w#?iST{Il7R@ zEq+X>gvqLn_T)tinA(%)wAmMH@4b2dLd(hkNodgW?ou@%W+VZ5dL-SVC}xbmulkZ4 z@P-wzpQWU|8Nce0bb?)9^Yq$xe4n#W9p$l*Gq`#^O<>*QQE}tYt z%F_U~`kMCaN4IS>SmdUxo}rfF9-!fyX9*EOxH+R;LGmoez3bu7XkqrO zy7d*1y0YleuC+{Ovv%^a?q%I!?`?l155Ig)ZTGt*_+3B9Wt+3s8fU{KxeVM@>=qss zpu!lit6s9RZ;9X40>ePU7=JjPQbfw|z!U&cFU8*v2U;Mj_l0hAc8IORmF<2ky|CJ? zxFDj&>HCIRE}~=U`W03a#QTt%?6Xd)zaUFkh1lop=gohR>p!VZ%su_sg&KeCf?Tn-qOp}SvCD|BSsuspRZr>gwaf_y%){2(CjeaP9ZHwn94A3dMpH~ zmQe9IiCnX*FxW3BW3YK!UfA~i3>_yw+;Uq{ls=rPVk=-dGvO^IBNR~*D{h%+v%T~{ z9Nlqb`us8_^|Y!^K(G)Z=-(FM^UqfqPL}it{@JH^ar_s@_s`4D{1;27Ejz^3<0K*o za{)m$;8}KGv-Ps$(URyINIKm|V?dQ>d2>EiioV92=8vUO&QZKf#rgL@N-W+P@upqs z!Jh{o53xz=!m>eKjt2j?nf{~2_cy11nK1kKrN5c*@jU&zzMuPZ8h^~EFdRsq(R1t1 zvrI)hed7{g|C>?%@+tUtZZfGl|J`^$&#=a&toP>?CLVB`M@;-<*8kWLzC1pQ`nz+;Z$1zeSEf@BW1Emv1*g4Gtng2M3GVVVH zXi-TJIU#@4f=cgA3i`*me~HnE5~a5}nox^hrxumcUwZy!E{=od4~|A|Ur_)31TMp9 zHW^5FskpNug{cH2u2a;%p%fADIanx+tA+e)fy~$cq)a5v=>N)$$&`tOD@H@?OkaO> z*1PW6jJXniD^~zN)v4}Tmr%lrq5Hrj^ICx);SbaC8(I-q71=5E$MQs~kxDdat#a(N z`S1uS8h~Ygo^(|Pq&Fp9FFdo;z&<_K&gGAss*Do#@0_ z70!M=Us7KyxkQ6$42MZD2XP=*yB~ic(P^{FN!UBGP>OmScXHwi1oJ`Os7%etEebx} z^ZbW5hNJRTwEf3Ly&ntL61uhPAHXHc!lz$~DvtTZ=w{GiWeQeaP9=@)B`>mzG~+md zKJYZ_&j|+hn@CTo8x5!zIofJxyhwXv9YPmV~7H-);Q< z)uhjNibLe#;Jxv$oiPdS+tPfhzGexH{$MNmH;)8slyQziIwZDvUq>WfH{c#MqCUDI zK-C5siZ^M@?Y9f)%mkjKPXZerh7swg=o28SB)g}2Xp8oE0n~Z|rf7xO*C|O%j z>NX6E8%Z5oiIHFu`$5s9@RgyFKQ(x5y+WWa&Y0&e9IY3+K=JT6auc!3Q(uw*dl>QW zKI-fcDfc%Svi@lu7Evs$7Sd9&Z_<|z-_z)6Q<=<#ElEDf^Syw|H!~UaCLvqPo_iVA z+-5|trAjaC+|(!Bd|{d9))1}OS?O9)%_TEujFd7aXN_AHn;sm^B11yc3-p@7a#lMs z?stKd_%9jtWVyw|Bg3iTdh+jPXG8s}-)sdw5NJ$i?3CRPPfRtz?Q}-3%|2o6Xr zLfy-#5sOCHD>Zcjv3d(p&#Q)=I|u7?JST-pBb>kU*|8}CKy-74pC0T+aE1FmPyy=d zfm*B+AXS?=dMX*AJ$tsyH|3u}7Q7w13v*B&-;71D?K5+DK^90uytDQR>;o3L_rt;+@={MX_*af19>ZVxs;FL z?RwV7UK+ovI?y-(80&I-Sv^8C@wMUfpc40I$Ck&Vt%-!I>&1P)3N@|a(;IzctVtQG zDk`U9wv3mUg$e z*JA6=x&oaIr`sp*C0-kT%MH!3`$K&c(cH?lq%(a2N@4dKB-81wqEOSlfNK)d zv3C`g&W%%ru)*8Qn9=T;k}F%n9DcSIR~oH#09X8;v@rM?nwC-f{kagl{IS+OO_Fc= zetOs+L-_(4fpQG)EN=4|naua-+l6^!&ViZoq@Jn0Y_FNei#yefbseEiU^D36>`rVp zpzo11TCmS{Q!CrX0W0*P;fAKZi$(zDogE|P?MiYTLRz@oJLOTEqDH)H`i^=23?*Ux z|K-Xst7&OaR#n*9oFnfxQ=X!imUnzPRoolzP|q;;(GFqt>lYcdrF|NcL+udeGXZ>y zgM8)Pm5J7uJo)D|#(koj^R#&FK7?=cwXf`dRU$9raJ8ir-MTT*?(#OA-i#g!I_M*l z$lK(DMS8Fq=XKojJzTc$u-UjYc@MK4vk*8r?h*=3rcuHufqckY=tX+6>n`q~kJ8w3 zxVg7A4mX2h3Zzrnl=hpy9zg3L(1SiL68M1PL@^149vDq**O~<=9PVt-bi-W0^80#USj(lD z^fBP`VM@VeN%{S~)g&|W(|t0r&rHKv5*QiAAla`cWLx(N&w)incej^vMVke9s*ncb3;74_)<+6spd57M zIT15O&{;*$t_yh|M(&OwV<2Rb8MW9RZbJ#Y*W?XMILYJIz;OC`WY)}@(}2>s7DbSD zCkz^}tAzq<2j}>XGk^FbJj%o)mLszsARMp3!%X>5_JCj5?ox&yvYIlh0oo8_}X>8u_H6>cGhmo zT$bMN9*4naUqTKKNwWzHCYM=($n&XjH3jO{Et0~FuXdFRpL?6(Llti~RPUoPwJ5q` zyz}+9^OEL?*J1=ypE@QJ#U#FBFday%Q@|Qi#S$81snKkMk z^6bJNV=rrzuC(>RFL9Bd;}U0ADf+->QO};G?6(uroyj`yL4hGRs|xj=WZ!MQOipbK za2P4^UsRIQ>oc>>C|WPfPylw_eP)s*^ECs5qKA@I4r_v0PqoKbL(N0^M}pBpA=eM{ z_F|jM>+spcl^gH_VQn$id92bBJ$bsy_@LGzQg>fv{{T_|y$t5RWQH`m1XUan@g91z zFZ}Z6`d%Yf5R}B%7bW!eW1f$z#-IyCC};sk-cTlkl+}zqYLxajNMO1)lt#AqhteXn znHu{cIxpNm!pd-y>H)U}7anyUU=#(y zC?%9ENk!<1f*p*yfAQcR54l%M8^qplxccb1WDaqBTnp0IwS!-UViXO__eitd;Aa{& zzh2#D&h}}eC!?YMyIN;Ta Date: Mon, 5 Mar 2018 21:00:40 +0100 Subject: [PATCH 115/148] isisd: implement threeway adjacencies Signed-off-by: Christian Franke --- isisd/isis_adjacency.c | 47 ++++++++++++++++ isisd/isis_adjacency.h | 9 ++++ isisd/isis_pdu.c | 119 ++++++++++++++++++++++++----------------- 3 files changed, 125 insertions(+), 50 deletions(-) diff --git a/isisd/isis_adjacency.c b/isisd/isis_adjacency.c index 72e6d4bdb9..ece080347d 100644 --- a/isisd/isis_adjacency.c +++ b/isisd/isis_adjacency.c @@ -47,6 +47,7 @@ #include "isisd/isis_spf.h" #include "isisd/isis_events.h" #include "isisd/isis_mt.h" +#include "isisd/isis_tlvs.h" extern struct isis *isis; @@ -78,6 +79,7 @@ struct isis_adjacency *isis_new_adj(const u_char *id, const u_char *snpa, adj->level = level; adj->flaps = 0; adj->last_flap = time(NULL); + adj->threeway_state = ISIS_THREEWAY_DOWN; if (circuit->circ_type == CIRCUIT_T_BROADCAST) { listnode_add(circuit->u.bc.adjdb[level - 1], adj); adj->dischanges[level - 1] = 0; @@ -161,6 +163,51 @@ static const char *adj_state2string(int state) return NULL; /* not reached */ } +void isis_adj_process_threeway(struct isis_adjacency *adj, + struct isis_threeway_adj *tw_adj, + enum isis_adj_usage adj_usage) +{ + enum isis_threeway_state next_tw_state = ISIS_THREEWAY_DOWN; + + if (tw_adj) { + if (tw_adj->state == ISIS_THREEWAY_DOWN) { + next_tw_state = ISIS_THREEWAY_INITIALIZING; + } else if (tw_adj->state == ISIS_THREEWAY_INITIALIZING) { + next_tw_state = ISIS_THREEWAY_UP; + } else if (tw_adj->state == ISIS_THREEWAY_UP) { + if (adj->threeway_state == ISIS_THREEWAY_DOWN) + next_tw_state = ISIS_THREEWAY_DOWN; + else + next_tw_state = ISIS_THREEWAY_UP; + } + } else { + next_tw_state = ISIS_THREEWAY_UP; + } + + if (next_tw_state != adj->threeway_state) { + if (isis->debugs & DEBUG_ADJ_PACKETS) { + zlog_info("ISIS-Adj (%s): Threeway state change %s to %s", + adj->circuit->area->area_tag, + isis_threeway_state_name(adj->threeway_state), + isis_threeway_state_name(next_tw_state)); + } + } + + if (next_tw_state == ISIS_THREEWAY_DOWN) { + isis_adj_state_change(adj, ISIS_ADJ_DOWN, "Neighbor restarted"); + return; + } + + if (next_tw_state == ISIS_THREEWAY_UP) { + if (adj->adj_state != ISIS_ADJ_UP) { + isis_adj_state_change(adj, ISIS_ADJ_UP, NULL); + adj->adj_usage = adj_usage; + } + } + + adj->threeway_state = next_tw_state; +} + void isis_adj_state_change(struct isis_adjacency *adj, enum isis_adj_state new_state, const char *reason) { diff --git a/isisd/isis_adjacency.h b/isisd/isis_adjacency.h index 98bb9838fa..2c3bd19af8 100644 --- a/isisd/isis_adjacency.h +++ b/isisd/isis_adjacency.h @@ -25,6 +25,8 @@ #ifndef _ZEBRA_ISIS_ADJACENCY_H #define _ZEBRA_ISIS_ADJACENCY_H +#include "isisd/isis_tlvs.h" + enum isis_adj_usage { ISIS_ADJ_NONE, ISIS_ADJ_LEVEL1, @@ -91,6 +93,8 @@ struct isis_adjacency { u_int16_t hold_time; /* entryRemainingTime */ u_int32_t last_upd; u_int32_t last_flap; /* last time the adj flapped */ + enum isis_threeway_state threeway_state; + uint32_t ext_circuit_id; int flaps; /* number of adjacency flaps */ struct thread *t_expire; /* expire after hold_time */ struct isis_circuit *circuit; /* back pointer */ @@ -98,12 +102,17 @@ struct isis_adjacency { unsigned int mt_count; /* Number of entries in mt_set */ }; +struct isis_threeway_adj; + struct isis_adjacency *isis_adj_lookup(const u_char *sysid, struct list *adjdb); struct isis_adjacency *isis_adj_lookup_snpa(const u_char *ssnpa, struct list *adjdb); struct isis_adjacency *isis_new_adj(const u_char *id, const u_char *snpa, int level, struct isis_circuit *circuit); void isis_delete_adj(void *adj); +void isis_adj_process_threeway(struct isis_adjacency *adj, + struct isis_threeway_adj *tw_adj, + enum isis_adj_usage adj_usage); void isis_adj_state_change(struct isis_adjacency *adj, enum isis_adj_state state, const char *reason); void isis_adj_print(struct isis_adjacency *adj); diff --git a/isisd/isis_pdu.c b/isisd/isis_pdu.c index 20a491ac18..8dd43258fd 100644 --- a/isisd/isis_pdu.c +++ b/isisd/isis_pdu.c @@ -120,6 +120,32 @@ struct iih_info { static int process_p2p_hello(struct iih_info *iih) { + struct isis_threeway_adj *tw_adj = iih->tlvs->threeway_adj; + if (tw_adj) { + if (tw_adj->state > ISIS_THREEWAY_DOWN) { + if (isis->debugs & DEBUG_ADJ_PACKETS) { + zlog_debug("ISIS-Adj (%s): Rcvd P2P IIH from (%s) with invalid three-way state: %d\n", + iih->circuit->area->area_tag, + iih->circuit->interface->name, + tw_adj->state); + } + return ISIS_WARNING; + } + + if (tw_adj->neighbor_set + && (memcmp(tw_adj->neighbor_id, isis->sysid, ISIS_SYS_ID_LEN) + || tw_adj->neighbor_circuit_id != (uint32_t) iih->circuit->idx)) { + + if (isis->debugs & DEBUG_ADJ_PACKETS) { + zlog_debug("ISIS-Adj (%s): Rcvd P2P IIH from (%s) which lists IS/Circuit different from us as neighbor.\n", + iih->circuit->area->area_tag, + iih->circuit->interface->name); + } + + return ISIS_WARNING; + } + } + /* * My interpertation of the ISO, if no adj exists we will create one for * the circuit @@ -155,6 +181,9 @@ static int process_p2p_hello(struct iih_info *iih) adj->sys_type = ISIS_SYSTYPE_UNKNOWN; } + if (tw_adj && adj->threeway_state == ISIS_THREEWAY_DOWN) + adj->ext_circuit_id = tw_adj->local_circuit_id; + /* 8.2.6 Monitoring point-to-point adjacencies */ adj->hold_time = iih->holdtime; adj->last_upd = time(NULL); @@ -183,14 +212,10 @@ static int process_p2p_hello(struct iih_info *iih) switch (iih->circ_type) { case IS_LEVEL_1: case IS_LEVEL_1_AND_2: - if (adj->adj_state != ISIS_ADJ_UP) { - /* (4) adj state up */ - isis_adj_state_change(adj, ISIS_ADJ_UP, - NULL); - /* (5) adj usage level 1 */ - adj->adj_usage = ISIS_ADJ_LEVEL1; - } else if (adj->adj_usage == ISIS_ADJ_LEVEL1) { - ; /* accept */ + if (adj->adj_state != ISIS_ADJ_UP + || adj->adj_usage == ISIS_ADJ_LEVEL1) { + isis_adj_process_threeway(adj, tw_adj, + ISIS_ADJ_LEVEL1); } break; case IS_LEVEL_2: @@ -213,14 +238,10 @@ static int process_p2p_hello(struct iih_info *iih) if (iih->circuit->area->is_type == IS_LEVEL_1_AND_2) { switch (iih->circ_type) { case IS_LEVEL_1: - if (adj->adj_state != ISIS_ADJ_UP) { - /* (6) adj state up */ - isis_adj_state_change(adj, ISIS_ADJ_UP, - NULL); - /* (7) adj usage level 1 */ - adj->adj_usage = ISIS_ADJ_LEVEL1; - } else if (adj->adj_usage == ISIS_ADJ_LEVEL1) { - ; /* accept */ + if (adj->adj_state != ISIS_ADJ_UP + || adj->adj_usage == ISIS_ADJ_LEVEL1) { + isis_adj_process_threeway(adj, tw_adj, + ISIS_ADJ_LEVEL1); } else if ((adj->adj_usage == ISIS_ADJ_LEVEL1AND2) || (adj->adj_usage @@ -232,12 +253,10 @@ static int process_p2p_hello(struct iih_info *iih) } break; case IS_LEVEL_2: - if (adj->adj_state != ISIS_ADJ_UP) { - /* (6) adj state up */ - isis_adj_state_change(adj, ISIS_ADJ_UP, - NULL); - /* (9) adj usage level 2 */ - adj->adj_usage = ISIS_ADJ_LEVEL2; + if (adj->adj_state != ISIS_ADJ_UP + || adj->adj_usage == ISIS_ADJ_LEVEL2) { + isis_adj_process_threeway(adj, tw_adj, + ISIS_ADJ_LEVEL2); } else if ((adj->adj_usage == ISIS_ADJ_LEVEL1) || (adj->adj_usage == ISIS_ADJ_LEVEL1AND2)) { @@ -245,17 +264,13 @@ static int process_p2p_hello(struct iih_info *iih) isis_adj_state_change(adj, ISIS_ADJ_DOWN, "Wrong System"); - } else if (adj->adj_usage == ISIS_ADJ_LEVEL2) { - ; /* Accept */ } break; case IS_LEVEL_1_AND_2: - if (adj->adj_state != ISIS_ADJ_UP) { - /* (6) adj state up */ - isis_adj_state_change(adj, ISIS_ADJ_UP, - NULL); - /* (10) adj usage level 1 */ - adj->adj_usage = ISIS_ADJ_LEVEL1AND2; + if (adj->adj_state != ISIS_ADJ_UP + || adj->adj_usage == ISIS_ADJ_LEVEL1AND2) { + isis_adj_process_threeway(adj, tw_adj, + ISIS_ADJ_LEVEL1AND2); } else if ((adj->adj_usage == ISIS_ADJ_LEVEL1) || (adj->adj_usage == ISIS_ADJ_LEVEL2)) { @@ -263,9 +278,6 @@ static int process_p2p_hello(struct iih_info *iih) isis_adj_state_change(adj, ISIS_ADJ_DOWN, "Wrong System"); - } else if (adj->adj_usage - == ISIS_ADJ_LEVEL1AND2) { - ; /* Accept */ } break; } @@ -292,20 +304,16 @@ static int process_p2p_hello(struct iih_info *iih) break; case IS_LEVEL_1_AND_2: case IS_LEVEL_2: - if (adj->adj_state != ISIS_ADJ_UP) { - /* (7) adj state up */ - isis_adj_state_change(adj, ISIS_ADJ_UP, - NULL); - /* (8) adj usage level 2 */ - adj->adj_usage = ISIS_ADJ_LEVEL2; + if (adj->adj_state != ISIS_ADJ_UP + || adj->adj_usage == ISIS_ADJ_LEVEL2) { + isis_adj_process_threeway(adj, tw_adj, + ISIS_ADJ_LEVEL2); } else if (adj->adj_usage == ISIS_ADJ_LEVEL1AND2) { /* (6) down - wrong system */ isis_adj_state_change(adj, ISIS_ADJ_DOWN, "Wrong System"); - } else if (adj->adj_usage == ISIS_ADJ_LEVEL2) { - ; /* Accept */ } break; } @@ -350,12 +358,10 @@ static int process_p2p_hello(struct iih_info *iih) break; case IS_LEVEL_1_AND_2: case IS_LEVEL_2: - if (adj->adj_state != ISIS_ADJ_UP) { - /* (8) adj state up */ - isis_adj_state_change(adj, ISIS_ADJ_UP, - NULL); - /* (9) adj usage level 2 */ - adj->adj_usage = ISIS_ADJ_LEVEL2; + if (adj->adj_state != ISIS_ADJ_UP + || adj->adj_usage == ISIS_ADJ_LEVEL2) { + isis_adj_process_threeway(adj, tw_adj, + ISIS_ADJ_LEVEL2); } else if (adj->adj_usage == ISIS_ADJ_LEVEL1) { /* (7) down - wrong system */ isis_adj_state_change(adj, @@ -374,8 +380,6 @@ static int process_p2p_hello(struct iih_info *iih) adj, ISIS_ADJ_DOWN, "Area Mismatch"); } - } else if (adj->adj_usage == ISIS_ADJ_LEVEL2) { - ; /* Accept */ } break; } @@ -1552,9 +1556,24 @@ int send_hello(struct isis_circuit *circuit, int level) isis_tlvs_add_area_addresses(tlvs, circuit->area->area_addrs); - if (circuit->circ_type == CIRCUIT_T_BROADCAST) + if (circuit->circ_type == CIRCUIT_T_BROADCAST) { isis_tlvs_add_lan_neighbors( tlvs, circuit->u.bc.lan_neighs[level - 1]); + } else if (circuit->circ_type == CIRCUIT_T_P2P) { + uint32_t ext_circuit_id = circuit->idx; + if (circuit->u.p2p.neighbor) { + isis_tlvs_add_threeway_adj(tlvs, + circuit->u.p2p.neighbor->threeway_state, + ext_circuit_id, + circuit->u.p2p.neighbor->sysid, + circuit->u.p2p.neighbor->ext_circuit_id); + } else { + isis_tlvs_add_threeway_adj(tlvs, + ISIS_THREEWAY_DOWN, + ext_circuit_id, + NULL, 0); + } + } isis_tlvs_set_protocols_supported(tlvs, &circuit->nlpids); From 44b895115e74b68e2654aaac33a2bc5602392770 Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 21:01:21 +0100 Subject: [PATCH 116/148] isisd: P2P adjacencies should only be included in LSPDB/SPF when they are up --- isisd/isis_lsp.c | 3 ++- isisd/isis_spf.c | 2 +- isisd/isis_te.c | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/isisd/isis_lsp.c b/isisd/isis_lsp.c index 34eac676d6..b2ba8b3932 100644 --- a/isisd/isis_lsp.c +++ b/isisd/isis_lsp.c @@ -1034,7 +1034,8 @@ static void lsp_build(struct isis_lsp *lsp, struct isis_area *area) break; case CIRCUIT_T_P2P: { struct isis_adjacency *nei = circuit->u.p2p.neighbor; - if (nei && (level & nei->circuit_t)) { + if (nei && nei->adj_state == ISIS_ADJ_UP + && (level & nei->circuit_t)) { uint8_t ne_id[7]; memcpy(ne_id, nei->sysid, ISIS_SYS_ID_LEN); LSP_PSEUDO_ID(ne_id) = 0; diff --git a/isisd/isis_spf.c b/isisd/isis_spf.c index ee447d01f7..dc86d4c105 100644 --- a/isisd/isis_spf.c +++ b/isisd/isis_spf.c @@ -1152,7 +1152,7 @@ static int isis_spf_preload_tent(struct isis_spftree *spftree, root_sysid, parent); } else if (circuit->circ_type == CIRCUIT_T_P2P) { adj = circuit->u.p2p.neighbor; - if (!adj) + if (!adj || adj->adj_state != ISIS_ADJ_UP) continue; if (!adj_has_mt(adj, spftree->mtid)) continue; diff --git a/isisd/isis_te.c b/isisd/isis_te.c index 079340b4a4..5de936a6ea 100644 --- a/isisd/isis_te.c +++ b/isisd/isis_te.c @@ -549,7 +549,8 @@ void isis_link_params_update(struct isis_circuit *circuit, if ((SUBTLV_TYPE(mtc->rmt_ipaddr) == 0) && (circuit->circ_type == CIRCUIT_T_P2P)) { struct isis_adjacency *adj = circuit->u.p2p.neighbor; - if (adj->ipv4_address_count) { + if (adj && adj->adj_state == ISIS_ADJ_UP + && adj->ipv4_address_count) { set_circuitparams_rmt_ipaddr( mtc, adj->ipv4_addresses[0]); } From 58e5d748c9f8ec6d4f1882e4c08629975cb4ecc1 Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 21:29:15 +0100 Subject: [PATCH 117/148] isisd: add nerd-knob to turn three-way-adj off Signed-off-by: Christian Franke --- isisd/isis_adjacency.c | 2 +- isisd/isis_circuit.c | 5 +++++ isisd/isis_circuit.h | 1 + isisd/isis_pdu.c | 3 ++- isisd/isis_vty.c | 17 +++++++++++++++++ 5 files changed, 26 insertions(+), 2 deletions(-) diff --git a/isisd/isis_adjacency.c b/isisd/isis_adjacency.c index ece080347d..a6e1a55a9f 100644 --- a/isisd/isis_adjacency.c +++ b/isisd/isis_adjacency.c @@ -169,7 +169,7 @@ void isis_adj_process_threeway(struct isis_adjacency *adj, { enum isis_threeway_state next_tw_state = ISIS_THREEWAY_DOWN; - if (tw_adj) { + if (tw_adj && !adj->circuit->disable_threeway_adj) { if (tw_adj->state == ISIS_THREEWAY_DOWN) { next_tw_state = ISIS_THREEWAY_INITIALIZING; } else if (tw_adj->state == ISIS_THREEWAY_INITIALIZING) { diff --git a/isisd/isis_circuit.c b/isisd/isis_circuit.c index c8642b623d..2c443c71f7 100644 --- a/isisd/isis_circuit.c +++ b/isisd/isis_circuit.c @@ -1041,6 +1041,11 @@ int isis_interface_config_write(struct vty *vty) write++; } + if (circuit->disable_threeway_adj) { + vty_out(vty, " no isis three-way-handshake\n"); + write++; + } + /* ISIS - Hello interval */ if (circuit->hello_interval[0] == circuit->hello_interval[1]) { diff --git a/isisd/isis_circuit.h b/isisd/isis_circuit.h index de6e7f2d87..246279c6f3 100644 --- a/isisd/isis_circuit.h +++ b/isisd/isis_circuit.h @@ -132,6 +132,7 @@ struct isis_circuit { u_int16_t upadjcount[2]; #define ISIS_CIRCUIT_FLAPPED_AFTER_SPF 0x01 u_char flags; + bool disable_threeway_adj; /* * Counters as in 10589--11.2.5.9 */ diff --git a/isisd/isis_pdu.c b/isisd/isis_pdu.c index 8dd43258fd..bcbda33088 100644 --- a/isisd/isis_pdu.c +++ b/isisd/isis_pdu.c @@ -1559,7 +1559,8 @@ int send_hello(struct isis_circuit *circuit, int level) if (circuit->circ_type == CIRCUIT_T_BROADCAST) { isis_tlvs_add_lan_neighbors( tlvs, circuit->u.bc.lan_neighs[level - 1]); - } else if (circuit->circ_type == CIRCUIT_T_P2P) { + } else if (circuit->circ_type == CIRCUIT_T_P2P + && !circuit->disable_threeway_adj) { uint32_t ext_circuit_id = circuit->idx; if (circuit->u.p2p.neighbor) { isis_tlvs_add_threeway_adj(tlvs, diff --git a/isisd/isis_vty.c b/isisd/isis_vty.c index 02e28a73fe..66d79b2e9f 100644 --- a/isisd/isis_vty.c +++ b/isisd/isis_vty.c @@ -927,6 +927,21 @@ DEFUN (no_isis_hello_padding, return CMD_SUCCESS; } +DEFUN (isis_threeway_adj, + isis_threeway_adj_cmd, + "[no] isis three-way-handshake", + NO_STR + "IS-IS commands\n" + "Enable/Disable three-way handshake\n") +{ + struct isis_circuit *circuit = isis_circuit_lookup(vty); + if (!circuit) + return CMD_ERR_NO_MATCH; + + circuit->disable_threeway_adj = !strcmp(argv[0]->text, "no"); + return CMD_SUCCESS; +} + DEFUN (csnp_interval, csnp_interval_cmd, "isis csnp-interval (1-600)", @@ -2085,6 +2100,8 @@ void isis_vty_init(void) install_element(INTERFACE_NODE, &isis_hello_padding_cmd); install_element(INTERFACE_NODE, &no_isis_hello_padding_cmd); + install_element(INTERFACE_NODE, &isis_threeway_adj_cmd); + install_element(INTERFACE_NODE, &csnp_interval_cmd); install_element(INTERFACE_NODE, &no_csnp_interval_cmd); install_element(INTERFACE_NODE, &csnp_interval_l1_cmd); From c737c7bab3a598c231ceee1d9fed7afec88f5bbf Mon Sep 17 00:00:00 2001 From: Arthur Jones Date: Sun, 11 Mar 2018 10:32:24 -0700 Subject: [PATCH 118/148] alpine: minimal alpine packaging For building dev packages for alpine, we provide a minimal APKBUILD file and add a configure option for only numeric versions in the VERSION variable as alpine does not allow non-numeric characters in the version string. These changes allow alpine to be built, but don't yet provide a mechanism to build. Changes to do the build in docker are coming soon... Testing done: Built alpine packages in local docker environment, packages showed no "dev" in the package name. Also built CentOS packages with numeric version disabled and the "dev" is still in the package name. Issue: https://github.com/FRRouting/frr/issues/1859 Signed-off-by: Arthur Jones --- alpine/APKBUILD.in | 36 ++++++++++++++++++++++++++++++++++++ configure.ac | 11 +++++++++++ 2 files changed, 47 insertions(+) create mode 100644 alpine/APKBUILD.in diff --git a/alpine/APKBUILD.in b/alpine/APKBUILD.in new file mode 100644 index 0000000000..33c2859245 --- /dev/null +++ b/alpine/APKBUILD.in @@ -0,0 +1,36 @@ +# Maintainer: Arthur Jones +pkgname=frr +pkgver=@VERSION@ +pkgrel=0 +pkgdesc="Free Range Routing is a fork of quagga" +url="https://frrouting.org/" +arch="all" +license="GPL-2.0" +depends="iproute2 json-c c-ares ipsec-tools iproute2" +makedepends="ncurses-dev net-snmp-dev gawk texinfo perl + acct autoconf automake bash + binutils binutils-libs bison bsd-compat-headers build-base + c-ares c-ares-dev ca-certificates cryptsetup-libs curl + device-mapper-libs expat fakeroot flex fortify-headers gdbm + git gmp isl json-c-dev kmod lddtree libacl libatomic libattr + libblkid libburn libbz2 libc-dev libcap libcurl libedit libffi libgcc + libgomp libisoburn libisofs libltdl libressl libssh2 + libstdc++ libtool libuuid linux-headers lzip lzo m4 make mkinitfs mpc1 + mpfr3 mtools musl-dev ncurses-libs ncurses-terminfo ncurses-terminfo-base + patch pax-utils pcre perl pkgconf python2 python2-dev readline + readline-dev sqlite-libs squashfs-tools sudo tar texinfo xorriso xz-libs" +subpackages="$pkgname-dev $pkgname-doc $pkgname-dbg" +source="$pkgname-$pkgver.tar.gz" + +builddir="$srcdir"/$pkgname-$pkgver + +build() { + cd "$builddir" + ./configure --prefix=/usr || return 1 + make || return 1 +} + +package() { + cd "$builddir" + make DESTDIR="$pkgdir" install || return 1 +} diff --git a/configure.ac b/configure.ac index 0d6c99acfa..e85d19f687 100755 --- a/configure.ac +++ b/configure.ac @@ -396,6 +396,8 @@ AC_ARG_ENABLE(rpki, AS_HELP_STRING([--enable-rpki], [enable RPKI prefix validation support])) AC_ARG_ENABLE([clippy-only], AS_HELP_STRING([--enable-clippy-only], [Only build clippy])) +AC_ARG_ENABLE([numeric_version], + AS_HELP_STRING([--enable-numeric-version], [Only numeric digits allowed in version (for Alpine)])) AS_IF([test "${enable_clippy_only}" != "yes"], [ AC_CHECK_HEADERS(json-c/json.h) @@ -647,6 +649,14 @@ AC_DEFINE_UNQUOTED(MULTIPATH_NUM, $MPATH_NUM, Maximum number of paths for a rout AC_DEFINE_UNQUOTED(VTYSH_PAGER, "$VTYSH_PAGER", [What pager to use]) +dnl ------------------------------------ +dnl Alpine only accepts numeric versions +dnl ------------------------------------ +if test "x${enable_numeric_version}" != "x" ; then + VERSION="`echo ${VERSION} | tr -c -d '[[.0-9]]'`" + PACKAGE_VERSION="`echo ${PACKAGE_VERSION} | tr -c -d '[[.0-9]]'`" +fi + dnl ----------------------------------- dnl Add extra version string to package dnl name, string and version fields. @@ -1872,6 +1882,7 @@ AC_CONFIG_FILES([Makefile redhat/frr.spec debianpkg/Makefile debianpkg/changelog + alpine/APKBUILD snapcraft/snapcraft.yaml lib/version.h tests/lib/cli/test_cli.refout From 688818844fe662dea093082c2717481779319f43 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 12:07:25 -0500 Subject: [PATCH 119/148] lib: add convenience debugging macros * Add DEBUG*() macros This set of macros allows you to write printf-like debugging lines that automatically check whether a debug is on before printing. This should eliminate the need for explicit checks in simple cases. For example: if (SUCH_AND_SUCH_DEBUG_IS_ON) { zlog_warn(...); } Becomes: DEBUG(warn, such_and_such, ...); Or, equivalently, DEBUGE(such_and_such, ...); The levels passed to DEBUG are expanded into the names of zlog_* functions, so the same zlog levels are available. There's also a set of macros that have the level built into them; DEBUGE for errors, DEBUGW for warnings, etc. Good for brevity. * Add singular setting macros Change the 'SET' macros to accept a boolean indicating whether the provided bits should be set or unset, and map on/off macros to them. Helps condense code where you already have a boolean condition that tells you what you want to do as you can avoid writing the branch. Signed-off-by: Quentin Young --- lib/debug.h | 92 ++++++++++++++++++++++++++++++++--------------------- 1 file changed, 55 insertions(+), 37 deletions(-) diff --git a/lib/debug.h b/lib/debug.h index 3e6772aacf..d0fa27d3fe 100644 --- a/lib/debug.h +++ b/lib/debug.h @@ -104,76 +104,77 @@ struct debug_callbacks { * * MT-Safe */ -#define DEBUG_MODE_CHECK(name, type) \ - CHECK_FLAG_ATOMIC(&(name)->flags, (type)&DEBUG_MODE_ALL) +#define DEBUG_MODE_CHECK(name, mode) \ + CHECK_FLAG_ATOMIC(&(name)->flags, (mode)&DEBUG_MODE_ALL) /* * Check if an option bit is set for a debug. * * MT-Safe */ -#define DEBUG_OPT_CHECK(name, type) \ - CHECK_FLAG_ATOMIC(&(name)->flags, (type)&DEBUG_OPT_ALL) +#define DEBUG_OPT_CHECK(name, opt) \ + CHECK_FLAG_ATOMIC(&(name)->flags, (opt)&DEBUG_OPT_ALL) /* * Check if bits are set for a debug. * * MT-Safe */ -#define DEBUG_FLAGS_CHECK(name, type) CHECK_FLAG_ATOMIC(&(name)->flags, (type)) - -/* - * Check if any mode is on for a debug. - * - * MT-Safe - */ -#define DEBUG(name) DEBUG_MODE_CHECK((name), DEBUG_MODE_ALL) +#define DEBUG_FLAGS_CHECK(name, fl) CHECK_FLAG_ATOMIC(&(name)->flags, (fl)) /* * Set modes on a debug. * * MT-Safe */ -#define DEBUG_MODE_SET(name, type) \ - SET_FLAG_ATOMIC(&(name)->flags, (type)&DEBUG_MODE_ALL) +#define DEBUG_MODE_SET(name, mode, onoff) \ + do { \ + if (onoff) \ + SET_FLAG_ATOMIC(&(name)->flags, \ + (mode)&DEBUG_MODE_ALL); \ + else \ + UNSET_FLAG_ATOMIC(&(name)->flags, \ + (mode)&DEBUG_MODE_ALL); \ + } while (0) -/* - * Unset modes on a debug. - * - * MT-Safe - */ -#define DEBUG_MODE_UNSET(name, type) \ - UNSET_FLAG_ATOMIC(&(name)->flags, (type)&DEBUG_MODE_ALL) +/* Convenience macros for specific set operations. */ +#define DEBUG_MODE_ON(name, mode) DEBUG_MODE_SET(name, mode, true) +#define DEBUG_MODE_OFF(name, mode) DEBUG_MODE_SET(name, mode, false) /* * Set options on a debug. * * MT-Safe */ -#define DEBUG_OPT_SET(name, type) \ - SET_FLAG_ATOMIC(&(name)->flags, (type)&DEBUG_OPT_ALL) +#define DEBUG_OPT_SET(name, opt, onoff) \ + do { \ + if (onoff) \ + SET_FLAG_ATOMIC(&(name)->flags, (opt)&DEBUG_OPT_ALL); \ + else \ + UNSET_FLAG_ATOMIC(&(name)->flags, \ + (opt)&DEBUG_OPT_ALL); \ + } while (0) -/* - * Unset options on a debug. - * - * MT-Safe - */ -#define DEBUG_OPT_UNSET(name, type) \ - UNSET_FLAG_ATOMIC(&(name)->flags, (type)&DEBUG_OPT_ALL) +/* Convenience macros for specific set operations. */ +#define DEBUG_OPT_ON(name, opt) DEBUG_OPT_SET(name, opt, true) +#define DEBUG_OPT_OFF(name, opt) DEBUG_OPT_SET(name, opt, true) /* * Set bits on a debug. * * MT-Safe */ -#define DEBUG_FLAGS_SET(name, type) SET_FLAG_ATOMIC(&(name)->flags, (type)) +#define DEBUG_FLAGS_SET(name, fl, onoff) \ + do { \ + if (onoff) \ + SET_FLAG_ATOMIC(&(name)->flags, (fl)); \ + else \ + UNSET_FLAG_ATOMIC(&(name)->flags, (fl)); \ + } while (0) -/* - * Unset bits on a debug. - * - * MT-Safe - */ -#define DEBUG_FLAGS_UNSET(name, type) UNSET_FLAG_ATOMIC(&(name)->flags, (type)) +/* Convenience macros for specific set operations. */ +#define DEBUG_FLAGS_ON(name, fl) DEBUG_FLAGS_SET(&(name)->flags, (type), true) +#define DEBUG_FLAGS_OFF(name, fl) DEBUG_FLAGS_SET(&(name)->flags, (type), false) /* * Unset all modes and options on a debug. @@ -201,6 +202,23 @@ struct debug_callbacks { #define DEBUG_NODE2MODE(vtynode) \ (((vtynode) == CONFIG_NODE) ? DEBUG_MODE_ALL : DEBUG_MODE_TERM) +/* + * Debug at the given level to the default logging destination. + * + * MT-Safe + */ +#define DEBUG(level, name, fmt, ...) \ + do { \ + if (DEBUG_MODE_CHECK(name, DEBUG_MODE_ALL)) \ + zlog_##level(fmt, ##__VA_ARGS__); \ + } while (0) + +/* Convenience macros for the various levels. */ +#define DEBUGE(name, fmt, ...) DEBUG(err, name, fmt, ##__VA_ARGS__) +#define DEBUGW(name, fmt, ...) DEBUG(warn, name, fmt, ##__VA_ARGS__) +#define DEBUGI(name, fmt, ...) DEBUG(info, name, fmt, ##__VA_ARGS__) +#define DEBUGN(name, fmt, ...) DEBUG(notice, name, fmt, ##__VA_ARGS__) +#define DEBUGD(name, fmt, ...) DEBUG(debug, name, fmt, ##__VA_ARGS__) /* * Optional initializer for debugging. Highly recommended. From 6bd0508a895382a85bd21876708cac77b04997ef Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Mon, 5 Mar 2018 17:16:04 +0100 Subject: [PATCH 120/148] tools/frr-reload.py: process vnc settings as sub-context Signed-off-by: Christian Franke --- tools/frr-reload.py | 30 +++++++++--------------------- 1 file changed, 9 insertions(+), 21 deletions(-) diff --git a/tools/frr-reload.py b/tools/frr-reload.py index 0b7e80962c..208fb116e6 100755 --- a/tools/frr-reload.py +++ b/tools/frr-reload.py @@ -413,7 +413,7 @@ end ctx_keys = [] current_context_lines = [] - elif line == "exit-address-family" or line == "exit" or line == "exit-vni": + elif line in ["exit-address-family", "exit", "exit-vnc", "exit-vni"]: # if this exit is for address-family ipv4 unicast, ignore the pop if main_ctx_key: self.save_contexts(ctx_keys, current_context_lines) @@ -433,26 +433,14 @@ end current_context_lines = [] new_ctx = False log.debug('LINE %-50s: entering new context, %-50s', line, ctx_keys) - - # The 'vni' keyword under 'router bgp X/address-family l2vpn evpn' creates - # a sub-context but the 'vni' keyword in other places (such as 'vrf BLUE') - # does not. - elif ("vni " in line and - len(ctx_keys) == 2 and - ctx_keys[0].startswith('router bgp') and - ctx_keys[1] == 'address-family l2vpn evpn'): - - main_ctx_key = [] - - # Save old context first - self.save_contexts(ctx_keys, current_context_lines) - current_context_lines = [] - main_ctx_key = copy.deepcopy(ctx_keys) - log.debug('LINE %-50s: entering sub-context, append to ctx_keys', line) - - ctx_keys.append(line) - - elif "address-family " in line: + elif (line.startswith("address-family ") or + line.startswith("vnc defaults") or + line.startswith("vnc l2-group") or + line.startswith("vnc nve-group") or + (line.startswith("vni ") and + len(ctx_keys) == 2 and + ctx_keys[0].startswith('router bgp') and + ctx_keys[1] == 'address-family l2vpn evpn')): main_ctx_key = [] # Save old context first From 12cd053cd64904425cb19f4b3e5fb154a9a713e8 Mon Sep 17 00:00:00 2001 From: Arthur Jones Date: Mon, 12 Mar 2018 16:32:23 +0000 Subject: [PATCH 121/148] docs/install.texi: document --enable-numeric-version Document the configure option to strip non-numeric characters from the version string. Testing done: Build alpine packages in docker, run texinfo on the doc apk package. Issue: https://github.com/FRRouting/frr/issues/1859 Signed-off-by: Arthur Jones --- doc/install.texi | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/install.texi b/doc/install.texi index d0d56804b0..e6d4be61dd 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -109,6 +109,10 @@ of grammar sandbox. Turn on some compile options to allow you to run fuzzing tools against the system. This tools is intended as a developer only tool and should not be used for normal operations +@item --enable-numeric-version +Alpine Linux does not allow non-numeric characters in the version +string. With this option, we provide a way to strip out these +characters for apk dev package builds. @end table You may specify any combination of the above options to the configure From 2cf63c35614034ef83fe2a561cf79a638366cc5b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 12 Mar 2018 14:01:47 -0400 Subject: [PATCH 122/148] lib: fixup zlog_hexdump * Allocate correct amount of memory * Use snprintf() instead of sprintf() Signed-off-by: Quentin Young --- lib/log.c | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/lib/log.c b/lib/log.c index 9e33ef9102..5537d8d721 100644 --- a/lib/log.c +++ b/lib/log.c @@ -1092,41 +1092,48 @@ void zlog_hexdump(const void *mem, unsigned int len) unsigned long i = 0; unsigned int j = 0; unsigned int columns = 8; - char buf[(len * 4) + ((len / 4) * 20) + 30]; + /* 19 bytes for 0xADDRESS: */ + /* 24 bytes for data; 2 chars plus a space per data byte */ + /* 1 byte for space */ + /* 8 bytes for ASCII representation */ + /* 1 byte for a newline */ + /* ===================== */ + /* 53 bytes per 8 bytes of data */ + /* 1 byte for null term */ + size_t bs = ((len / 8) + 1) * 53 + 1; + char buf[bs]; char *s = buf; for (i = 0; i < len + ((len % columns) ? (columns - len % columns) : 0); i++) { /* print offset */ if (i % columns == 0) - s += sprintf(s, "0x%016lx: ", (unsigned long)mem + i); + s += snprintf(s, bs - (s - buf), + "0x%016lx: ", (unsigned long)mem + i); /* print hex data */ if (i < len) - s += sprintf(s, "%02x ", 0xFF & ((const char *)mem)[i]); + s += snprintf(s, bs - (s - buf), "%02x ", + 0xFF & ((const char *)mem)[i]); /* end of block, just aligning for ASCII dump */ else - s += sprintf(s, " "); + s += snprintf(s, bs - (s - buf), " "); /* print ASCII dump */ if (i % columns == (columns - 1)) { for (j = i - (columns - 1); j <= i; j++) { - if (j >= len) /* end of block, not really - printing */ - s += sprintf(s, " "); - - else if (isprint((int)((const char *)mem) - [j])) /* printable char - */ - s += sprintf( - s, "%c", + /* end of block not really printing */ + if (j >= len) + s += snprintf(s, bs - (s - buf), " "); + else if (isprint((int)((const char *)mem)[j])) + s += snprintf( + s, bs - (s - buf), "%c", 0xFF & ((const char *)mem)[j]); - else /* other char */ - s += sprintf(s, "."); + s += snprintf(s, bs - (s - buf), "."); } - s += sprintf(s, "\n"); + s += snprintf(s, bs - (s - buf), "\n"); } } zlog_debug("\n%s", buf); From 3fc174e18c080416932fff5e8cb3a08f0d9f8660 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 12 Mar 2018 14:04:56 -0400 Subject: [PATCH 123/148] tests: add unit test for zlog Just tests zlog_hexdump right now Signed-off-by: Quentin Young --- lib/log.c | 18 +++++++------ tests/Makefile.am | 6 ++++- tests/lib/test_zlog.c | 61 ++++++++++++++++++++++++++++++++++++++++++ tests/lib/test_zlog.py | 4 +++ 4 files changed, 80 insertions(+), 9 deletions(-) create mode 100644 tests/lib/test_zlog.c create mode 100644 tests/lib/test_zlog.py diff --git a/lib/log.c b/lib/log.c index 5537d8d721..f6dfa10923 100644 --- a/lib/log.c +++ b/lib/log.c @@ -1092,14 +1092,16 @@ void zlog_hexdump(const void *mem, unsigned int len) unsigned long i = 0; unsigned int j = 0; unsigned int columns = 8; - /* 19 bytes for 0xADDRESS: */ - /* 24 bytes for data; 2 chars plus a space per data byte */ - /* 1 byte for space */ - /* 8 bytes for ASCII representation */ - /* 1 byte for a newline */ - /* ===================== */ - /* 53 bytes per 8 bytes of data */ - /* 1 byte for null term */ + /* + * 19 bytes for 0xADDRESS: + * 24 bytes for data; 2 chars plus a space per data byte + * 1 byte for space + * 8 bytes for ASCII representation + * 1 byte for a newline + * ===================== + * 53 bytes per 8 bytes of data + * 1 byte for null term + */ size_t bs = ((len / 8) + 1) * 53 + 1; char buf[bs]; char *s = buf; diff --git a/tests/Makefile.am b/tests/Makefile.am index f4ab2a126a..0c9a5684da 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -73,6 +73,7 @@ check_PROGRAMS = \ lib/test_timer_correctness \ lib/test_timer_performance \ lib/test_ttable \ + lib/test_zlog \ lib/cli/test_cli \ lib/cli/test_commands \ $(TESTS_BGPD) \ @@ -115,9 +116,9 @@ lib_test_heavy_SOURCES = lib/test_heavy.c helpers/c/main.c lib_test_memory_SOURCES = lib/test_memory.c lib_test_nexthop_iter_SOURCES = lib/test_nexthop_iter.c helpers/c/prng.c lib_test_privs_SOURCES = lib/test_privs.c +lib_test_ringbuf_SOURCES = lib/test_ringbuf.c lib_test_srcdest_table_SOURCES = lib/test_srcdest_table.c \ helpers/c/prng.c -lib_test_ringbuf_SOURCES = lib/test_ringbuf.c lib_test_segv_SOURCES = lib/test_segv.c lib_test_sig_SOURCES = lib/test_sig.c lib_test_stream_SOURCES = lib/test_stream.c @@ -127,6 +128,7 @@ lib_test_timer_correctness_SOURCES = lib/test_timer_correctness.c \ lib_test_timer_performance_SOURCES = lib/test_timer_performance.c \ helpers/c/prng.c lib_test_ttable_SOURCES = lib/test_ttable.c +lib_test_zlog_SOURCES = lib/test_zlog.c lib_test_zmq_SOURCES = lib/test_zmq.c lib_test_zmq_CFLAGS = $(AM_CFLAGS) $(ZEROMQ_CFLAGS) lib_cli_test_cli_SOURCES = lib/cli/test_cli.c lib/cli/common_cli.c @@ -167,6 +169,7 @@ lib_test_table_LDADD = $(ALL_TESTS_LDADD) -lm lib_test_timer_correctness_LDADD = $(ALL_TESTS_LDADD) lib_test_timer_performance_LDADD = $(ALL_TESTS_LDADD) lib_test_ttable_LDADD = $(ALL_TESTS_LDADD) +lib_test_zlog_LDADD = $(ALL_TESTS_LDADD) lib_test_zmq_LDADD = ../lib/libfrrzmq.la $(ALL_TESTS_LDADD) $(ZEROMQ_LIBS) lib_cli_test_cli_LDADD = $(ALL_TESTS_LDADD) lib_cli_test_commands_LDADD = $(ALL_TESTS_LDADD) @@ -207,6 +210,7 @@ EXTRA_DIST = \ lib/test_timer_correctness.py \ lib/test_ttable.py \ lib/test_ttable.refout \ + lib/test_zlog.py \ ospf6d/test_lsdb.py \ ospf6d/test_lsdb.in \ ospf6d/test_lsdb.refout \ diff --git a/tests/lib/test_zlog.c b/tests/lib/test_zlog.c new file mode 100644 index 0000000000..790e65cfe9 --- /dev/null +++ b/tests/lib/test_zlog.c @@ -0,0 +1,61 @@ +/* + * Zlog tests. + * Copyright (C) 2018 Cumulus Networks, Inc. + * Quentin Young + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the Free + * Software Foundation; either version 2 of the License, or (at your option) + * any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; see the file COPYING; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ +#include +#include +#include "log.h" + +/* maximum amount of data to hexdump */ +#define MAXDATA 16384 + +/* + * Test hexdump functionality. + * + * At the moment, not crashing is considered success. + */ +static bool test_zlog_hexdump(void) +{ + unsigned int nl = 1; + + do { + long d[nl]; + + for (unsigned int i = 0; i < nl; i++) + d[i] = random(); + zlog_hexdump(d, nl * sizeof(long)); + } while (++nl * sizeof(long) <= MAXDATA); + + return true; +} + +bool (*tests[])(void) = { + test_zlog_hexdump, +}; + +int main(int argc, char **argv) +{ + openzlog("testzlog", "NONE", 0, LOG_CONS | LOG_NDELAY | LOG_PID, + LOG_ERR); + zlog_set_file("test_zlog.log", LOG_DEBUG); + + for (unsigned int i = 0; i < array_size(tests); i++) + if (!tests[i]()) + return 1; + return 0; +} diff --git a/tests/lib/test_zlog.py b/tests/lib/test_zlog.py new file mode 100644 index 0000000000..2ca2585886 --- /dev/null +++ b/tests/lib/test_zlog.py @@ -0,0 +1,4 @@ +import frrtest + +class TestZlog(frrtest.TestMultiOut): + program = './test_zlog' From 8068a649a79409737dfa5235a84915b544d4fff7 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 17:01:42 -0500 Subject: [PATCH 124/148] zebra: dont return a status code in zapi handlers All of the ZAPI message handlers return an integer that means different things to each of them, but nobody ever reads these integers, so this is technical debt that we can just eliminate outright. Signed-off-by: Quentin Young --- zebra/zebra_mroute.c | 5 +- zebra/zebra_mroute.h | 4 +- zebra/zebra_ptm.c | 28 +++--- zebra/zebra_ptm.h | 10 +- zebra/zebra_vxlan.c | 88 +++++++++--------- zebra/zebra_vxlan.h | 30 +++--- zebra/zebra_vxlan_null.c | 20 ++-- zebra/zserv.c | 194 +++++++++++++++++++-------------------- 8 files changed, 188 insertions(+), 191 deletions(-) diff --git a/zebra/zebra_mroute.c b/zebra/zebra_mroute.c index e9cd19ebe0..1143451d62 100644 --- a/zebra/zebra_mroute.c +++ b/zebra/zebra_mroute.c @@ -32,8 +32,8 @@ #include "zebra/rt.h" #include "zebra/debug.h" -int zebra_ipmr_route_stats(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_ipmr_route_stats(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct mcast_route_data mroute; struct stream *s; @@ -69,5 +69,4 @@ stream_failure: stream_putw_at(s, 0, stream_get_endp(s)); zebra_server_send_message(client); - return 0; } diff --git a/zebra/zebra_mroute.h b/zebra/zebra_mroute.h index 616c3a83ab..5bee7b03d6 100644 --- a/zebra/zebra_mroute.h +++ b/zebra/zebra_mroute.h @@ -28,7 +28,7 @@ struct mcast_route_data { unsigned long long lastused; }; -int zebra_ipmr_route_stats(struct zserv *client, u_short length, - struct zebra_vrf *zvf); +void zebra_ipmr_route_stats(struct zserv *client, u_short length, + struct zebra_vrf *zvf); #endif diff --git a/zebra/zebra_ptm.c b/zebra/zebra_ptm.c index f6775fa0b1..b0295d127e 100644 --- a/zebra/zebra_ptm.c +++ b/zebra/zebra_ptm.c @@ -661,8 +661,8 @@ int zebra_ptm_sock_read(struct thread *thread) } /* BFD peer/dst register/update */ -int zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, - int command, struct zebra_vrf *zvrf) +void zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, + int command, struct zebra_vrf *zvrf) { struct stream *s; struct prefix src_p; @@ -693,7 +693,7 @@ int zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, ptm_cb.t_timer = NULL; thread_add_timer(zebrad.master, zebra_ptm_connect, NULL, ptm_cb.reconnect_time, &ptm_cb.t_timer); - return -1; + return; } ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt); @@ -816,16 +816,16 @@ int zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, ptm_cb.out_data); zebra_ptm_send_message(ptm_cb.out_data, data_len); - return 0; + return; stream_failure: ptm_lib_cleanup_msg(ptm_hdl, out_ctxt); - return 0; + return; } /* BFD peer/dst deregister */ -int zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; struct prefix src_p; @@ -849,7 +849,7 @@ int zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, ptm_cb.t_timer = NULL; thread_add_timer(zebrad.master, zebra_ptm_connect, NULL, ptm_cb.reconnect_time, &ptm_cb.t_timer); - return -1; + return; } ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt); @@ -948,15 +948,15 @@ int zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, zebra_ptm_send_message(ptm_cb.out_data, data_len); - return 0; + return; stream_failure: ptm_lib_cleanup_msg(ptm_hdl, out_ctxt); - return 0; + return; } /* BFD client register */ -int zebra_ptm_bfd_client_register(struct zserv *client, u_short length) +void zebra_ptm_bfd_client_register(struct zserv *client, u_short length) { struct stream *s; unsigned int pid; @@ -977,7 +977,7 @@ int zebra_ptm_bfd_client_register(struct zserv *client, u_short length) ptm_cb.t_timer = NULL; thread_add_timer(zebrad.master, zebra_ptm_connect, NULL, ptm_cb.reconnect_time, &ptm_cb.t_timer); - return -1; + return; } ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt); @@ -1003,7 +1003,7 @@ int zebra_ptm_bfd_client_register(struct zserv *client, u_short length) SET_FLAG(ptm_cb.client_flags[client->proto], ZEBRA_PTM_BFD_CLIENT_FLAG_REG); - return 0; + return; stream_failure: /* @@ -1013,7 +1013,7 @@ stream_failure: * if (out_ctxt) * ptm_lib_cleanup_msg(ptm_hdl, out_ctxt); */ - return 0; + return; } /* BFD client deregister */ diff --git a/zebra/zebra_ptm.h b/zebra/zebra_ptm.h index 392853b599..2397d53845 100644 --- a/zebra/zebra_ptm.h +++ b/zebra/zebra_ptm.h @@ -62,12 +62,12 @@ int zebra_ptm_connect(struct thread *t); void zebra_ptm_write(struct vty *vty); int zebra_ptm_get_enable_state(void); -int zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, - int command, struct zebra_vrf *zvrf); -int zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); +void zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, + int command, struct zebra_vrf *zvrf); +void zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); void zebra_ptm_show_status(struct vty *vty, struct interface *ifp); -int zebra_ptm_bfd_client_register(struct zserv *client, u_short length); +void zebra_ptm_bfd_client_register(struct zserv *client, u_short length); void zebra_ptm_if_init(struct zebra_if *zebra_ifp); void zebra_ptm_if_set_ptm_state(struct interface *ifp, struct zebra_if *zebra_ifp); diff --git a/zebra/zebra_vxlan.c b/zebra/zebra_vxlan.c index d3ede66fb0..bac589a841 100644 --- a/zebra/zebra_vxlan.c +++ b/zebra/zebra_vxlan.c @@ -4863,8 +4863,8 @@ int zebra_vxlan_local_neigh_add_update(struct interface *ifp, /* * Handle message from client to delete a remote MACIP for a VNI. */ -int zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; vni_t vni; @@ -5008,7 +5008,7 @@ int zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, } stream_failure: - return 0; + return; } /* @@ -5016,8 +5016,8 @@ stream_failure: * could be just the add of a MAC address or the add of a neighbor * (IP+MAC). */ -int zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; vni_t vni; @@ -5045,7 +5045,7 @@ int zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, zlog_warn( "%s: EVPN Not turned on yet we have received a remote_macip add zapi callback", __PRETTY_FUNCTION__); - return -1; + return; } s = client->ibuf; @@ -5159,7 +5159,7 @@ int zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, prefix_mac2str(&macaddr, buf, sizeof(buf)), vni, inet_ntoa(vtep_ip)); - return -1; + return; } /* Is this MAC created for a MACIP? */ @@ -5212,7 +5212,7 @@ int zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, prefix_mac2str(&macaddr, buf, sizeof(buf)), vni, inet_ntoa(vtep_ip)); - return -1; + return; } } else if (memcmp(&n->emac, &macaddr, sizeof(macaddr)) @@ -5240,7 +5240,7 @@ int zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, } stream_failure: - return 0; + return; } /* @@ -5543,8 +5543,8 @@ int zebra_vxlan_local_mac_add_update(struct interface *ifp, /* * Handle message from client to delete a remote VTEP for a VNI. */ -int zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; u_short l = 0; @@ -5559,13 +5559,13 @@ int zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, zlog_warn( "%s: EVPN is not enabled yet we have received a vtep del command", __PRETTY_FUNCTION__); - return -1; + return; } if (zvrf_id(zvrf) != VRF_DEFAULT) { zlog_err("Recv MACIP DEL for non-default VRF %u", zvrf_id(zvrf)); - return -1; + return; } s = client->ibuf; @@ -5623,14 +5623,14 @@ int zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, } stream_failure: - return 0; + return; } /* * Handle message from client to add a remote VTEP for a VNI. */ -int zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; u_short l = 0; @@ -5644,13 +5644,13 @@ int zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, zlog_warn( "%s: EVPN not enabled yet we received a vtep_add zapi call", __PRETTY_FUNCTION__); - return -1; + return; } if (zvrf_id(zvrf) != VRF_DEFAULT) { zlog_err("Recv MACIP ADD for non-default VRF %u", zvrf_id(zvrf)); - return -1; + return; } s = client->ibuf; @@ -5705,7 +5705,7 @@ int zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, } stream_failure: - return 0; + return; } /* @@ -6512,8 +6512,8 @@ int zebra_vxlan_vrf_delete(struct zebra_vrf *zvrf) * Handle message from client to enable/disable advertisement of g/w macip * routes */ -int zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; int advertise; @@ -6527,7 +6527,7 @@ int zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, if (zvrf_id(zvrf) != VRF_DEFAULT) { zlog_err("EVPN GW-MACIP Adv for non-default VRF %u", zvrf_id(zvrf)); - return -1; + return; } s = client->ibuf; @@ -6536,10 +6536,10 @@ int zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, zvni = zvni_lookup(vni); if (!zvni) - return 0; + return; if (zvni->advertise_subnet == advertise) - return 0; + return; if (IS_ZEBRA_DEBUG_VXLAN) zlog_debug("EVPN subnet Adv %s on VNI %d , currently %s", @@ -6551,35 +6551,35 @@ int zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, ifp = zvni->vxlan_if; if (!ifp) - return 0; + return; zif = ifp->info; /* If down or not mapped to a bridge, we're done. */ if (!if_is_operative(ifp) || !zif->brslave_info.br_if) - return 0; + return; zl2_info = zif->l2info.vxl; vlan_if = zvni_map_to_svi(zl2_info.access_vlan, zif->brslave_info.br_if); if (!vlan_if) - return 0; + return; if (zvni->advertise_subnet) zvni_advertise_subnet(zvni, vlan_if, 1); else zvni_advertise_subnet(zvni, vlan_if, 0); - return 0; + return; } /* * Handle message from client to enable/disable advertisement of g/w macip * routes */ -int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; int advertise; @@ -6590,7 +6590,7 @@ int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, if (zvrf_id(zvrf) != VRF_DEFAULT) { zlog_err("EVPN GW-MACIP Adv for non-default VRF %u", zvrf_id(zvrf)); - return -1; + return; } s = client->ibuf; @@ -6606,7 +6606,7 @@ int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, : "disabled"); if (zvrf->advertise_gw_macip == advertise) - return 0; + return; zvrf->advertise_gw_macip = advertise; @@ -6625,7 +6625,7 @@ int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, zvni = zvni_lookup(vni); if (!zvni) - return 0; + return; if (IS_ZEBRA_DEBUG_VXLAN) zlog_debug( @@ -6635,26 +6635,26 @@ int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, : "disabled"); if (zvni->advertise_gw_macip == advertise) - return 0; + return; zvni->advertise_gw_macip = advertise; ifp = zvni->vxlan_if; if (!ifp) - return 0; + return; zif = ifp->info; /* If down or not mapped to a bridge, we're done. */ if (!if_is_operative(ifp) || !zif->brslave_info.br_if) - return 0; + return; zl2_info = zif->l2info.vxl; vlan_if = zvni_map_to_svi(zl2_info.access_vlan, zif->brslave_info.br_if); if (!vlan_if) - return 0; + return; if (advertise_gw_macip_enabled(zvni)) { /* Add primary SVI MAC-IP */ @@ -6676,7 +6676,7 @@ int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, } stream_failure: - return 0; + return; } @@ -6686,8 +6686,8 @@ stream_failure: * when disabled, the entries should be deleted and remote VTEPs and MACs * uninstalled from the kernel. */ -int zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s = NULL; int advertise = 0; @@ -6695,7 +6695,7 @@ int zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, if (zvrf_id(zvrf) != VRF_DEFAULT) { zlog_err("EVPN VNI Adv for non-default VRF %u", zvrf_id(zvrf)); - return -1; + return; } s = client->ibuf; @@ -6707,7 +6707,7 @@ int zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, is_evpn_enabled() ? "enabled" : "disabled"); if (zvrf->advertise_all_vni == advertise) - return 0; + return; zvrf->advertise_all_vni = advertise; if (is_evpn_enabled()) { @@ -6732,13 +6732,13 @@ int zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, /* cleanup all l3vnis */ zns = zebra_ns_lookup(NS_DEFAULT); if (!zns) - return -1; + return; hash_iterate(zns->l3vni_table, zl3vni_cleanup_all, NULL); } stream_failure: - return 0; + return; } /* diff --git a/zebra/zebra_vxlan.h b/zebra/zebra_vxlan.h index 7abf0050fc..af76a41d80 100644 --- a/zebra/zebra_vxlan.h +++ b/zebra/zebra_vxlan.h @@ -51,6 +51,22 @@ static inline int is_evpn_enabled() #define VNI_STR_LEN 32 +/* zserv handlers */ +extern void zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); +extern void zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); +extern void zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); +extern void zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); +extern void zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); +extern void zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); +extern void zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, + struct zebra_vrf *zvrf); + extern int is_l3vni_for_prefix_routes_only(vni_t vni); extern ifindex_t get_l3vni_svi_ifindex(vrf_id_t vrf_id); extern int zebra_vxlan_vrf_delete(struct zebra_vrf *zvrf); @@ -117,10 +133,6 @@ extern int zebra_vxlan_local_neigh_add_update( extern int zebra_vxlan_local_neigh_del(struct interface *ifp, struct interface *link_if, struct ipaddr *ip); -extern int zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern int zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); extern int zebra_vxlan_local_mac_add_update(struct interface *ifp, struct interface *br_if, struct ethaddr *mac, vlanid_t vid, @@ -140,16 +152,6 @@ extern int zebra_vxlan_if_down(struct interface *ifp); extern int zebra_vxlan_if_add(struct interface *ifp); extern int zebra_vxlan_if_update(struct interface *ifp, u_int16_t chgflags); extern int zebra_vxlan_if_del(struct interface *ifp); -extern int zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern int zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern int zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern int zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern int zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); extern int zebra_vxlan_process_vrf_vni_cmd(struct zebra_vrf *zvrf, vni_t vni, char *err, int err_str_sz, int filter, int add); diff --git a/zebra/zebra_vxlan_null.c b/zebra/zebra_vxlan_null.c index 1bac2cafb6..e6a3dd674e 100644 --- a/zebra/zebra_vxlan_null.c +++ b/zebra/zebra_vxlan_null.c @@ -117,14 +117,14 @@ int zebra_vxlan_svi_down(struct interface *ifp, struct interface *link_if) return 0; } -int zebra_vxlan_remote_macip_add(struct zserv *client, int sock, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_macip_add(struct zserv *client, int sock, + u_short length, struct zebra_vrf *zvrf) { return 0; } -int zebra_vxlan_remote_macip_del(struct zserv *client, int sock, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_macip_del(struct zserv *client, int sock, + u_short length, struct zebra_vrf *zvrf) { return 0; } @@ -182,20 +182,20 @@ int zebra_vxlan_if_del(struct interface *ifp) return 0; } -int zebra_vxlan_remote_vtep_add(struct zserv *client, int sock, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_vtep_add(struct zserv *client, int sock, u_short length, + struct zebra_vrf *zvrf) { return 0; } -int zebra_vxlan_remote_vtep_del(struct zserv *client, int sock, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_vtep_del(struct zserv *client, int sock, u_short length, + struct zebra_vrf *zvrf) { return 0; } -int zebra_vxlan_advertise_all_vni(struct zserv *client, int sock, - u_short length, struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_all_vni(struct zserv *client, int sock, + u_short length, struct zebra_vrf *zvrf) { return 0; } diff --git a/zebra/zserv.c b/zebra/zserv.c index 1a2ad7f8b4..f3ee38fef1 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -693,8 +693,8 @@ static int zsend_write_nexthop(struct stream *s, struct nexthop *nexthop) } /* Nexthop register */ -static int zserv_rnh_register(struct zserv *client, u_short length, - rnh_type_t type, struct zebra_vrf *zvrf) +static void zserv_rnh_register(struct zserv *client, u_short length, + rnh_type_t type, struct zebra_vrf *zvrf) { struct rnh *rnh; struct stream *s; @@ -722,7 +722,7 @@ static int zserv_rnh_register(struct zserv *client, u_short length, zlog_warn( "%s: Specified prefix length %d is too large for a v4 address", __PRETTY_FUNCTION__, p.prefixlen); - return -1; + return; } STREAM_GET(&p.u.prefix4.s_addr, s, IPV4_MAX_BYTELEN); l += IPV4_MAX_BYTELEN; @@ -731,7 +731,7 @@ static int zserv_rnh_register(struct zserv *client, u_short length, zlog_warn( "%s: Specified prefix length %d is to large for a v6 address", __PRETTY_FUNCTION__, p.prefixlen); - return -1; + return; } STREAM_GET(&p.u.prefix6, s, IPV6_MAX_BYTELEN); l += IPV6_MAX_BYTELEN; @@ -739,7 +739,7 @@ static int zserv_rnh_register(struct zserv *client, u_short length, zlog_err( "rnh_register: Received unknown family type %d\n", p.family); - return -1; + return; } rnh = zebra_add_rnh(&p, zvrf_id(zvrf), type); if (type == RNH_NEXTHOP_TYPE) { @@ -764,12 +764,12 @@ static int zserv_rnh_register(struct zserv *client, u_short length, } stream_failure: - return 0; + return; } /* Nexthop register */ -static int zserv_rnh_unregister(struct zserv *client, u_short length, - rnh_type_t type, struct zebra_vrf *zvrf) +static void zserv_rnh_unregister(struct zserv *client, u_short length, + rnh_type_t type, struct zebra_vrf *zvrf) { struct rnh *rnh; struct stream *s; @@ -797,7 +797,7 @@ static int zserv_rnh_unregister(struct zserv *client, u_short length, zlog_warn( "%s: Specified prefix length %d is to large for a v4 address", __PRETTY_FUNCTION__, p.prefixlen); - return -1; + return; } STREAM_GET(&p.u.prefix4.s_addr, s, IPV4_MAX_BYTELEN); l += IPV4_MAX_BYTELEN; @@ -806,7 +806,7 @@ static int zserv_rnh_unregister(struct zserv *client, u_short length, zlog_warn( "%s: Specified prefix length %d is to large for a v6 address", __PRETTY_FUNCTION__, p.prefixlen); - return -1; + return; } STREAM_GET(&p.u.prefix6, s, IPV6_MAX_BYTELEN); l += IPV6_MAX_BYTELEN; @@ -814,7 +814,7 @@ static int zserv_rnh_unregister(struct zserv *client, u_short length, zlog_err( "rnh_register: Received unknown family type %d\n", p.family); - return -1; + return; } rnh = zebra_lookup_rnh(&p, zvrf_id(zvrf), type); if (rnh) { @@ -823,13 +823,13 @@ static int zserv_rnh_unregister(struct zserv *client, u_short length, } } stream_failure: - return 0; + return; } #define ZEBRA_MIN_FEC_LENGTH 5 /* FEC register */ -static int zserv_fec_register(struct zserv *client, u_short length) +static void zserv_fec_register(struct zserv *client, u_short length) { struct stream *s; struct zebra_vrf *zvrf; @@ -841,7 +841,7 @@ static int zserv_fec_register(struct zserv *client, u_short length) s = client->ibuf; zvrf = vrf_info_lookup(VRF_DEFAULT); if (!zvrf) - return 0; // unexpected + return; /* * The minimum amount of data that can be sent for one fec @@ -851,7 +851,7 @@ static int zserv_fec_register(struct zserv *client, u_short length) zlog_err( "fec_register: Received a fec register of length %d, it is of insufficient size to properly decode", length); - return -1; + return; } while (l < length) { @@ -862,7 +862,7 @@ static int zserv_fec_register(struct zserv *client, u_short length) zlog_err( "fec_register: Received unknown family type %d\n", p.family); - return -1; + return; } STREAM_GETC(s, p.prefixlen); if ((p.family == AF_INET && p.prefixlen > IPV4_MAX_BITLEN) @@ -871,7 +871,7 @@ static int zserv_fec_register(struct zserv *client, u_short length) zlog_warn( "%s: Specified prefix length: %d is to long for %d", __PRETTY_FUNCTION__, p.prefixlen, p.family); - return -1; + return; } l += 5; STREAM_GET(&p.u.prefix, s, PSIZE(p.prefixlen)); @@ -885,11 +885,11 @@ static int zserv_fec_register(struct zserv *client, u_short length) } stream_failure: - return 0; + return; } /* FEC unregister */ -static int zserv_fec_unregister(struct zserv *client, u_short length) +static void zserv_fec_unregister(struct zserv *client, u_short length) { struct stream *s; struct zebra_vrf *zvrf; @@ -900,7 +900,7 @@ static int zserv_fec_unregister(struct zserv *client, u_short length) s = client->ibuf; zvrf = vrf_info_lookup(VRF_DEFAULT); if (!zvrf) - return 0; // unexpected + return; /* * The minimum amount of data that can be sent for one @@ -910,7 +910,7 @@ static int zserv_fec_unregister(struct zserv *client, u_short length) zlog_err( "fec_unregister: Received a fec unregister of length %d, it is of insufficient size to properly decode", length); - return -1; + return; } while (l < length) { @@ -924,7 +924,7 @@ static int zserv_fec_unregister(struct zserv *client, u_short length) zlog_err( "fec_unregister: Received unknown family type %d\n", p.family); - return -1; + return; } STREAM_GETC(s, p.prefixlen); if ((p.family == AF_INET && p.prefixlen > IPV4_MAX_BITLEN) @@ -933,7 +933,7 @@ static int zserv_fec_unregister(struct zserv *client, u_short length) zlog_warn( "%s: Received prefix length %d which is greater than %d can support", __PRETTY_FUNCTION__, p.prefixlen, p.family); - return -1; + return; } l += 5; STREAM_GET(&p.u.prefix, s, PSIZE(p.prefixlen)); @@ -942,7 +942,7 @@ static int zserv_fec_unregister(struct zserv *client, u_short length) } stream_failure: - return 0; + return; } /* @@ -1133,8 +1133,8 @@ int zsend_pw_update(struct zserv *client, struct zebra_pw *pw) /* Register zebra server interface information. Send current all interface and address information. */ -static int zread_interface_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_interface_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct vrf *vrf; struct interface *ifp; @@ -1149,21 +1149,20 @@ static int zread_interface_add(struct zserv *client, u_short length, continue; if (zsend_interface_add(client, ifp) < 0) - return -1; + return; if (zsend_interface_addresses(client, ifp) < 0) - return -1; + return; } } - return 0; + return; } /* Unregister zebra server interface information. */ -static int zread_interface_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_interface_delete(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { vrf_bitmap_unset(client->ifinfo, zvrf_id(zvrf)); - return 0; } void zserv_nexthop_num_warn(const char *caller, const struct prefix *p, @@ -1178,8 +1177,8 @@ void zserv_nexthop_num_warn(const char *caller, const struct prefix *p, } } -static int zread_route_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_route_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; struct zapi_route api; @@ -1193,7 +1192,7 @@ static int zread_route_add(struct zserv *client, u_short length, s = client->ibuf; if (zapi_route_decode(s, &api) < 0) - return -1; + return; /* Allocate new route. */ vrf_id = zvrf_id(zvrf); @@ -1277,7 +1276,7 @@ static int zread_route_add(struct zserv *client, u_short length, __PRETTY_FUNCTION__, api.nexthop_num); nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } /* MPLS labels for BGP-LU or Segment Routing */ if (CHECK_FLAG(api.message, ZAPI_MESSAGE_LABEL) @@ -1309,7 +1308,7 @@ static int zread_route_add(struct zserv *client, u_short length, __PRETTY_FUNCTION__); nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } if (CHECK_FLAG(api.message, ZAPI_MESSAGE_SRCPFX)) src_p = &api.src_prefix; @@ -1331,12 +1330,10 @@ static int zread_route_add(struct zserv *client, u_short length, client->v6_route_upd8_cnt++; break; } - - return 0; } -static int zread_route_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_route_del(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; struct zapi_route api; @@ -1345,13 +1342,13 @@ static int zread_route_del(struct zserv *client, u_short length, s = client->ibuf; if (zapi_route_decode(s, &api) < 0) - return -1; + return; afi = family2afi(api.prefix.family); if (afi != AFI_IP6 && CHECK_FLAG(api.message, ZAPI_MESSAGE_SRCPFX)) { zlog_warn("%s: Received a src prefix while afi is not v6", __PRETTY_FUNCTION__); - return -1; + return; } if (CHECK_FLAG(api.message, ZAPI_MESSAGE_SRCPFX)) src_p = &api.src_prefix; @@ -1370,7 +1367,7 @@ static int zread_route_del(struct zserv *client, u_short length, break; } - return 0; + return; } /* This function support multiple nexthop. */ @@ -1378,8 +1375,8 @@ static int zread_route_del(struct zserv *client, u_short length, * Parse the ZEBRA_IPV4_ROUTE_ADD sent from client. Update re and * add kernel route. */ -static int zread_ipv4_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { int i; struct route_entry *re; @@ -1409,7 +1406,7 @@ static int zread_ipv4_add(struct zserv *client, u_short length, zlog_warn("%s: Specified route type %d is not a legal value\n", __PRETTY_FUNCTION__, re->type); XFREE(MTYPE_RE, re); - return -1; + return; } STREAM_GETW(s, re->instance); STREAM_GETL(s, re->flags); @@ -1426,7 +1423,7 @@ static int zread_ipv4_add(struct zserv *client, u_short length, "%s: Specified prefix length %d is greater than what v4 can be", __PRETTY_FUNCTION__, p.prefixlen); XFREE(MTYPE_RE, re); - return -1; + return; } STREAM_GET(&p.u.prefix4, s, PSIZE(p.prefixlen)); @@ -1478,7 +1475,7 @@ static int zread_ipv4_add(struct zserv *client, u_short length, __PRETTY_FUNCTION__); nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; break; case NEXTHOP_TYPE_BLACKHOLE: route_entry_nexthop_blackhole_add(re, bh_type); @@ -1489,7 +1486,7 @@ static int zread_ipv4_add(struct zserv *client, u_short length, __PRETTY_FUNCTION__, nexthop_type); nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } } } @@ -1524,17 +1521,17 @@ static int zread_ipv4_add(struct zserv *client, u_short length, else if (ret < 0) client->v4_route_upd8_cnt++; - return 0; + return; stream_failure: nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } /* Zebra server IPv4 prefix delete function. */ -static int zread_ipv4_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_delete(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; struct zapi_ipv4 api; @@ -1557,7 +1554,7 @@ static int zread_ipv4_delete(struct zserv *client, u_short length, if (p.prefixlen > IPV4_MAX_BITLEN) { zlog_warn("%s: Passed in prefixlen %d is impossible", __PRETTY_FUNCTION__, p.prefixlen); - return -1; + return; } STREAM_GET(&p.u.prefix4, s, PSIZE(p.prefixlen)); @@ -1568,28 +1565,29 @@ static int zread_ipv4_delete(struct zserv *client, u_short length, client->v4_route_del_cnt++; stream_failure: - return 0; + return; } /* MRIB Nexthop lookup for IPv4. */ -static int zread_ipv4_nexthop_lookup_mrib(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_nexthop_lookup_mrib(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct in_addr addr; struct route_entry *re; STREAM_GET(&addr.s_addr, client->ibuf, IPV4_MAX_BYTELEN); re = rib_match_ipv4_multicast(zvrf_id(zvrf), addr, NULL); - return zsend_ipv4_nexthop_lookup_mrib(client, addr, re, zvrf); + zsend_ipv4_nexthop_lookup_mrib(client, addr, re, zvrf); + return; stream_failure: - return -1; + return; } /* Zebra server IPv6 prefix add function. */ -static int zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, - u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, + u_short length, + struct zebra_vrf *zvrf) { unsigned int i; struct stream *s; @@ -1623,7 +1621,8 @@ static int zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, zlog_warn("%s: Specified route type: %d is not a legal value\n", __PRETTY_FUNCTION__, re->type); XFREE(MTYPE_RE, re); - return -1; + + return; } STREAM_GETW(s, re->instance); STREAM_GETL(s, re->flags); @@ -1640,7 +1639,7 @@ static int zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, "%s: Prefix Length %d is greater than what a v4 address can use", __PRETTY_FUNCTION__, p.prefixlen); XFREE(MTYPE_RE, re); - return -1; + return; } STREAM_GET(&p.u.prefix4, s, PSIZE(p.prefixlen)); @@ -1695,7 +1694,7 @@ static int zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, __PRETTY_FUNCTION__); nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } } @@ -1753,16 +1752,16 @@ static int zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, else if (ret < 0) client->v4_route_upd8_cnt++; - return 0; + return; stream_failure: nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } -static int zread_ipv6_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv6_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { unsigned int i; struct stream *s; @@ -1798,7 +1797,7 @@ static int zread_ipv6_add(struct zserv *client, u_short length, zlog_warn("%s: Specified route type: %d is not a legal value\n", __PRETTY_FUNCTION__, re->type); XFREE(MTYPE_RE, re); - return -1; + return; } STREAM_GETW(s, re->instance); STREAM_GETL(s, re->flags); @@ -1815,7 +1814,7 @@ static int zread_ipv6_add(struct zserv *client, u_short length, "%s: Specified prefix length %d is to large for v6 prefix", __PRETTY_FUNCTION__, p.prefixlen); XFREE(MTYPE_RE, re); - return -1; + return; } STREAM_GET(&p.u.prefix6, s, PSIZE(p.prefixlen)); @@ -1828,7 +1827,7 @@ static int zread_ipv6_add(struct zserv *client, u_short length, "%s: Specified src prefix length %d is to large for v6 prefix", __PRETTY_FUNCTION__, src_p.prefixlen); XFREE(MTYPE_RE, re); - return -1; + return; } STREAM_GET(&src_p.prefix, s, PSIZE(src_p.prefixlen)); src_pp = &src_p; @@ -1891,7 +1890,7 @@ static int zread_ipv6_add(struct zserv *client, u_short length, __PRETTY_FUNCTION__); nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } } @@ -1947,18 +1946,18 @@ static int zread_ipv6_add(struct zserv *client, u_short length, else if (ret < 0) client->v6_route_upd8_cnt++; - return 0; + return; stream_failure: nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return -1; + return; } /* Zebra server IPv6 prefix delete function. */ -static int zread_ipv6_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv6_delete(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; struct zapi_ipv6 api; @@ -1996,12 +1995,12 @@ static int zread_ipv6_delete(struct zserv *client, u_short length, client->v6_route_del_cnt++; stream_failure: - return 0; + return; } /* Register zebra server router-id information. Send current router-id */ -static int zread_router_id_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_router_id_add(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct prefix p; @@ -2010,15 +2009,14 @@ static int zread_router_id_add(struct zserv *client, u_short length, router_id_get(&p, zvrf_id(zvrf)); - return zsend_router_id_update(client, &p, zvrf_id(zvrf)); + zsend_router_id_update(client, &p, zvrf_id(zvrf)); } /* Unregister zebra server router-id information. */ -static int zread_router_id_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_router_id_delete(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { vrf_bitmap_unset(client->ridinfo, zvrf_id(zvrf)); - return 0; } /* Tie up route-type and client->sock */ @@ -2052,8 +2050,8 @@ stream_failure: } /* Unregister all information in a VRF. */ -static int zread_vrf_unregister(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_vrf_unregister(struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { int i; afi_t afi; @@ -2064,8 +2062,6 @@ static int zread_vrf_unregister(struct zserv *client, u_short length, vrf_bitmap_unset(client->redist_default, zvrf_id(zvrf)); vrf_bitmap_unset(client->ifinfo, zvrf_id(zvrf)); vrf_bitmap_unset(client->ridinfo, zvrf_id(zvrf)); - - return 0; } static void zread_mpls_labels(int command, struct zserv *client, u_short length, @@ -2313,8 +2309,8 @@ static void zread_label_manager_request(int cmd, struct zserv *client, } } -static int zread_pseudowire(int command, struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_pseudowire(int command, struct zserv *client, u_short length, + struct zebra_vrf *zvrf) { struct stream *s; char ifname[IF_NAMESIZE]; @@ -2345,7 +2341,7 @@ static int zread_pseudowire(int command, struct zserv *client, u_short length, STREAM_GET(&nexthop.ipv6, s, 16); break; default: - return -1; + return; } STREAM_GETL(s, local_label); STREAM_GETL(s, remote_label); @@ -2360,7 +2356,7 @@ static int zread_pseudowire(int command, struct zserv *client, u_short length, zlog_warn("%s: pseudowire %s already exists [%s]", __func__, ifname, zserv_command_string(command)); - return -1; + return; } zebra_pw_add(zvrf, ifname, protocol, client); @@ -2369,7 +2365,7 @@ static int zread_pseudowire(int command, struct zserv *client, u_short length, if (!pw) { zlog_warn("%s: pseudowire %s not found [%s]", __func__, ifname, zserv_command_string(command)); - return -1; + return; } zebra_pw_del(zvrf, pw); @@ -2379,7 +2375,7 @@ static int zread_pseudowire(int command, struct zserv *client, u_short length, if (!pw) { zlog_warn("%s: pseudowire %s not found [%s]", __func__, ifname, zserv_command_string(command)); - return -1; + return; } switch (command) { @@ -2397,7 +2393,7 @@ static int zread_pseudowire(int command, struct zserv *client, u_short length, } stream_failure: - return 0; + return; } /* Cleanup registered nexthops (across VRFs) upon client disconnect. */ @@ -2532,7 +2528,7 @@ static void zebra_client_create(int sock) zebra_vrf_update_all(client); } -static int zread_interface_set_master(struct zserv *client, u_short length) +static void zread_interface_set_master(struct zserv *client, u_short length) { struct interface *master; struct interface *slave; @@ -2549,12 +2545,12 @@ static int zread_interface_set_master(struct zserv *client, u_short length) slave = if_lookup_by_index(ifindex, vrf_id); if (!master || !slave) - return 0; + return; kernel_interface_set_master(master, slave); stream_failure: - return 1; + return; } From 9bcbcae2e428bfd2b8d3a95368e459a338c14eed Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 17:09:36 -0500 Subject: [PATCH 125/148] zebra: add struct zmsghdr Formalize the ZAPI header by documenting it in code and providing it to message handlers free of charge to reduce complexity. Signed-off-by: Quentin Young --- zebra/zserv.c | 21 +++++++++++++++++++++ zebra/zserv.h | 9 +++++++++ 2 files changed, 30 insertions(+) diff --git a/zebra/zserv.c b/zebra/zserv.c index f3ee38fef1..3ecc82be42 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -2681,10 +2681,31 @@ stream_failure: return; } +/* + * Reads header from zmsg stream. + * + * Note this advances the stream getp by the size of the header. + */ +static bool zserv_read_header(struct stream *msg, struct zmsghdr *hdr) +{ + STREAM_GETW(msg, hdr->length); + STREAM_GETC(msg, hdr->marker); + STREAM_GETC(msg, hdr->version); + STREAM_GETL(msg, hdr->vrf_id); + STREAM_GETW(msg, hdr->command); + return true; +stream_failure: + return false; +} + static inline void zserv_handle_commands(struct zserv *client, uint16_t command, uint16_t length, struct zebra_vrf *zvrf) { + struct zmsghdr hdr; + stream_set_getp(client->ibuf, 0); + zserv_read_header(client->ibuf, &hdr); + switch (command) { case ZEBRA_ROUTER_ID_ADD: zread_router_id_add(client, length, zvrf); diff --git a/zebra/zserv.h b/zebra/zserv.h index 8519693726..a09baeff7a 100644 --- a/zebra/zserv.h +++ b/zebra/zserv.h @@ -129,6 +129,15 @@ struct zserv { int last_write_cmd; }; +/* ZAPI protocol message header */ +struct zmsghdr { + uint16_t length; + uint8_t marker; + uint8_t version; + uint32_t vrf_id; + uint16_t command; +}; + /* Zebra instance */ struct zebra_t { /* Thread master */ From 89f4e5077bd8162dbda0e10a3bbd594c2c698d77 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 17:57:33 -0500 Subject: [PATCH 126/148] zebra: standardize ZAPI message handler args A lot of the handler functions that are called directly from the ZAPI input processing code take different argument sets where they don't need to. These functions are called from only one place and all have the same fundamental information available to them to do their work. There is no need to specialize what information is passed to them; it is cleaner and easier to understand when they all accept the same base set of information and extract what they need inline. Signed-off-by: Quentin Young --- zebra/redistribute.c | 12 +- zebra/redistribute.h | 14 +- zebra/rtadv.c | 23 ++- zebra/rtadv.h | 5 +- zebra/zebra_mroute.c | 4 +- zebra/zebra_mroute.h | 5 +- zebra/zebra_ptm.c | 16 +- zebra/zebra_ptm.h | 11 +- zebra/zebra_vxlan.c | 31 ++-- zebra/zebra_vxlan.h | 23 ++- zebra/zserv.c | 341 ++++++++++++++++--------------------------- zebra/zserv.h | 3 + 12 files changed, 194 insertions(+), 294 deletions(-) diff --git a/zebra/redistribute.c b/zebra/redistribute.c index a7b2361ac6..93862cadc9 100644 --- a/zebra/redistribute.c +++ b/zebra/redistribute.c @@ -243,8 +243,7 @@ void redistribute_delete(struct prefix *p, struct prefix *src_p, } } -void zebra_redistribute_add(int command, struct zserv *client, int length, - struct zebra_vrf *zvrf) +void zebra_redistribute_add(ZAPI_HANDLER_ARGS) { afi_t afi = 0; int type = 0; @@ -287,8 +286,7 @@ stream_failure: return; } -void zebra_redistribute_delete(int command, struct zserv *client, int length, - struct zebra_vrf *zvrf) +void zebra_redistribute_delete(ZAPI_HANDLER_ARGS) { afi_t afi = 0; int type = 0; @@ -325,15 +323,13 @@ stream_failure: return; } -void zebra_redistribute_default_add(int command, struct zserv *client, - int length, struct zebra_vrf *zvrf) +void zebra_redistribute_default_add(ZAPI_HANDLER_ARGS) { vrf_bitmap_set(client->redist_default, zvrf_id(zvrf)); zebra_redistribute_default(client, zvrf_id(zvrf)); } -void zebra_redistribute_default_delete(int command, struct zserv *client, - int length, struct zebra_vrf *zvrf) +void zebra_redistribute_default_delete(ZAPI_HANDLER_ARGS) { vrf_bitmap_unset(client->redist_default, zvrf_id(zvrf)); } diff --git a/zebra/redistribute.h b/zebra/redistribute.h index 5edb06c3da..6ca3b57d4d 100644 --- a/zebra/redistribute.h +++ b/zebra/redistribute.h @@ -27,15 +27,11 @@ #include "vty.h" #include "vrf.h" -extern void zebra_redistribute_add(int, struct zserv *, int, - struct zebra_vrf *zvrf); -extern void zebra_redistribute_delete(int, struct zserv *, int, - struct zebra_vrf *zvrf); - -extern void zebra_redistribute_default_add(int, struct zserv *, int, - struct zebra_vrf *zvrf); -extern void zebra_redistribute_default_delete(int, struct zserv *, int, - struct zebra_vrf *zvrf); +/* zapi handlers */ +extern void zebra_redistribute_add(ZAPI_HANDLER_ARGS); +extern void zebra_redistribute_delete(ZAPI_HANDLER_ARGS); +extern void zebra_redistribute_default_add(ZAPI_HANDLER_ARGS); +extern void zebra_redistribute_default_delete(ZAPI_HANDLER_ARGS); extern void redistribute_update(struct prefix *, struct prefix *, struct route_entry *, struct route_entry *); diff --git a/zebra/rtadv.c b/zebra/rtadv.c index 5eebca163b..56decdcdba 100644 --- a/zebra/rtadv.c +++ b/zebra/rtadv.c @@ -43,6 +43,7 @@ #include "zebra/zserv.h" #include "zebra/zebra_ns.h" #include "zebra/zebra_vrf.h" +#include "zebra/zserv.h" extern struct zebra_privs_t zserv_privs; @@ -801,8 +802,7 @@ static void ipv6_nd_suppress_ra_set(struct interface *ifp, * if the operator has explicitly enabled RA. The enable request can also * specify a RA interval (in seconds). */ -void zebra_interface_radv_set(struct zserv *client, u_short length, - struct zebra_vrf *zvrf, int enable) +void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int set) { struct stream *s; ifindex_t ifindex; @@ -818,27 +818,26 @@ void zebra_interface_radv_set(struct zserv *client, u_short length, if (IS_ZEBRA_DEBUG_EVENT) zlog_debug("%u: IF %u RA %s from client %s, interval %ds", - zvrf_id(zvrf), ifindex, - enable ? "enable" : "disable", + zvrf_id(zvrf), ifindex, set ? "enable" : "disable", zebra_route_string(client->proto), ra_interval); /* Locate interface and check VRF match. */ ifp = if_lookup_by_index_per_ns(zebra_ns_lookup(NS_DEFAULT), ifindex); if (!ifp) { zlog_warn("%u: IF %u RA %s client %s - interface unknown", - zvrf_id(zvrf), ifindex, enable ? "enable" : "disable", + zvrf_id(zvrf), ifindex, set ? "enable" : "disable", zebra_route_string(client->proto)); return; } if (ifp->vrf_id != zvrf_id(zvrf)) { zlog_warn("%u: IF %u RA %s client %s - VRF mismatch, IF VRF %u", - zvrf_id(zvrf), ifindex, enable ? "enable" : "disable", + zvrf_id(zvrf), ifindex, set ? "enable" : "disable", zebra_route_string(client->proto), ifp->vrf_id); return; } zif = ifp->info; - if (enable) { + if (set) { SET_FLAG(zif->rtadv.ra_configured, BGP_RA_CONFIGURED); ipv6_nd_suppress_ra_set(ifp, RA_ENABLE); if (ra_interval @@ -859,6 +858,16 @@ stream_failure: return; } +void zebra_interface_radv_disable(ZAPI_HANDLER_ARGS) +{ + zebra_interface_radv_set(client, hdr, zvrf, 0); +} + +void zebra_interface_radv_enable(ZAPI_HANDLER_ARGS) +{ + zebra_interface_radv_set(client, hdr, zvrf, 1); +} + DEFUN (ipv6_nd_suppress_ra, ipv6_nd_suppress_ra_cmd, "ipv6 nd suppress-ra", diff --git a/zebra/rtadv.h b/zebra/rtadv.h index 2cae6d06f9..28019a3237 100644 --- a/zebra/rtadv.h +++ b/zebra/rtadv.h @@ -103,7 +103,8 @@ typedef enum { extern void rtadv_init(struct zebra_ns *); extern void rtadv_terminate(struct zebra_ns *); extern void rtadv_cmd_init(void); -extern void zebra_interface_radv_set(struct zserv *client, u_short length, - struct zebra_vrf *zvrf, int enable); +extern void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int enable); +extern void zebra_interface_radv_disable(ZAPI_HANDLER_ARGS); +extern void zebra_interface_radv_enable(ZAPI_HANDLER_ARGS); #endif /* _ZEBRA_RTADV_H */ diff --git a/zebra/zebra_mroute.c b/zebra/zebra_mroute.c index 1143451d62..e70b963cfd 100644 --- a/zebra/zebra_mroute.c +++ b/zebra/zebra_mroute.c @@ -31,9 +31,9 @@ #include "zebra/zebra_mroute.h" #include "zebra/rt.h" #include "zebra/debug.h" +#include "zebra/zserv.h" -void zebra_ipmr_route_stats(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_ipmr_route_stats(ZAPI_HANDLER_ARGS) { struct mcast_route_data mroute; struct stream *s; diff --git a/zebra/zebra_mroute.h b/zebra/zebra_mroute.h index 5bee7b03d6..3385153600 100644 --- a/zebra/zebra_mroute.h +++ b/zebra/zebra_mroute.h @@ -22,13 +22,14 @@ #ifndef __ZEBRA_MROUTE_H__ #define __ZEBRA_MROUTE_H__ +#include "zebra/zserv.h" + struct mcast_route_data { struct prefix_sg sg; unsigned int ifindex; unsigned long long lastused; }; -void zebra_ipmr_route_stats(struct zserv *client, u_short length, - struct zebra_vrf *zvf); +void zebra_ipmr_route_stats(ZAPI_HANDLER_ARGS); #endif diff --git a/zebra/zebra_ptm.c b/zebra/zebra_ptm.c index b0295d127e..0c48473aad 100644 --- a/zebra/zebra_ptm.c +++ b/zebra/zebra_ptm.c @@ -661,8 +661,7 @@ int zebra_ptm_sock_read(struct thread *thread) } /* BFD peer/dst register/update */ -void zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, - int command, struct zebra_vrf *zvrf) +void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS) { struct stream *s; struct prefix src_p; @@ -680,14 +679,14 @@ void zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, int data_len = ZEBRA_PTM_SEND_MAX_SOCKBUF; unsigned int pid; - if (command == ZEBRA_BFD_DEST_UPDATE) + if (hdr->command == ZEBRA_BFD_DEST_UPDATE) client->bfd_peer_upd8_cnt++; else client->bfd_peer_add_cnt++; if (IS_ZEBRA_DEBUG_EVENT) zlog_debug("bfd_dst_register msg from client %s: length=%d", - zebra_route_string(client->proto), length); + zebra_route_string(client->proto), hdr->length); if (ptm_cb.ptm_sock == -1) { ptm_cb.t_timer = NULL; @@ -824,8 +823,7 @@ stream_failure: } /* BFD peer/dst deregister */ -void zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS) { struct stream *s; struct prefix src_p; @@ -843,7 +841,7 @@ void zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, if (IS_ZEBRA_DEBUG_EVENT) zlog_debug("bfd_dst_deregister msg from client %s: length=%d", - zebra_route_string(client->proto), length); + zebra_route_string(client->proto), hdr->length); if (ptm_cb.ptm_sock == -1) { ptm_cb.t_timer = NULL; @@ -956,7 +954,7 @@ stream_failure: } /* BFD client register */ -void zebra_ptm_bfd_client_register(struct zserv *client, u_short length) +void zebra_ptm_bfd_client_register(ZAPI_HANDLER_ARGS) { struct stream *s; unsigned int pid; @@ -968,7 +966,7 @@ void zebra_ptm_bfd_client_register(struct zserv *client, u_short length) if (IS_ZEBRA_DEBUG_EVENT) zlog_debug("bfd_client_register msg from client %s: length=%d", - zebra_route_string(client->proto), length); + zebra_route_string(client->proto), hdr->length); s = client->ibuf; STREAM_GETL(s, pid); diff --git a/zebra/zebra_ptm.h b/zebra/zebra_ptm.h index 2397d53845..22cacd6fc0 100644 --- a/zebra/zebra_ptm.h +++ b/zebra/zebra_ptm.h @@ -22,6 +22,8 @@ #ifndef _ZEBRA_PTM_H #define _ZEBRA_PTM_H +#include "zebra/zserv.h" + extern const char ZEBRA_PTM_SOCK_NAME[]; #define ZEBRA_PTM_MAX_SOCKBUF 3200 /* 25B *128 ports */ #define ZEBRA_PTM_SEND_MAX_SOCKBUF 512 @@ -62,12 +64,11 @@ int zebra_ptm_connect(struct thread *t); void zebra_ptm_write(struct vty *vty); int zebra_ptm_get_enable_state(void); -void zebra_ptm_bfd_dst_register(struct zserv *client, u_short length, - int command, struct zebra_vrf *zvrf); -void zebra_ptm_bfd_dst_deregister(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); +void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS); +void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS); +void zebra_ptm_bfd_client_register(ZAPI_HANDLER_ARGS); + void zebra_ptm_show_status(struct vty *vty, struct interface *ifp); -void zebra_ptm_bfd_client_register(struct zserv *client, u_short length); void zebra_ptm_if_init(struct zebra_if *zebra_ifp); void zebra_ptm_if_set_ptm_state(struct interface *ifp, struct zebra_if *zebra_ifp); diff --git a/zebra/zebra_vxlan.c b/zebra/zebra_vxlan.c index bac589a841..f22d5160fb 100644 --- a/zebra/zebra_vxlan.c +++ b/zebra/zebra_vxlan.c @@ -46,6 +46,7 @@ #include "zebra/zebra_vxlan.h" #include "zebra/zebra_memory.h" #include "zebra/zebra_l2.h" +#include "zebra/zserv.h" DEFINE_MTYPE_STATIC(ZEBRA, HOST_PREFIX, "host prefix"); DEFINE_MTYPE_STATIC(ZEBRA, ZVNI, "VNI hash"); @@ -4863,8 +4864,7 @@ int zebra_vxlan_local_neigh_add_update(struct interface *ifp, /* * Handle message from client to delete a remote MACIP for a VNI. */ -void zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_macip_del(ZAPI_HANDLER_ARGS) { struct stream *s; vni_t vni; @@ -4886,7 +4886,7 @@ void zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, s = client->ibuf; - while (l < length) { + while (l < hdr->length) { /* Obtain each remote MACIP and process. */ /* Message contains VNI, followed by MAC followed by IP (if any) * followed by remote VTEP IP. @@ -5016,8 +5016,7 @@ stream_failure: * could be just the add of a MAC address or the add of a neighbor * (IP+MAC). */ -void zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_macip_add(ZAPI_HANDLER_ARGS) { struct stream *s; vni_t vni; @@ -5050,7 +5049,7 @@ void zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, s = client->ibuf; - while (l < length) { + while (l < hdr->length) { /* Obtain each remote MACIP and process. */ /* Message contains VNI, followed by MAC followed by IP (if any) * followed by remote VTEP IP. @@ -5543,8 +5542,7 @@ int zebra_vxlan_local_mac_add_update(struct interface *ifp, /* * Handle message from client to delete a remote VTEP for a VNI. */ -void zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_vtep_del(ZAPI_HANDLER_ARGS) { struct stream *s; u_short l = 0; @@ -5570,7 +5568,7 @@ void zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, s = client->ibuf; - while (l < length) { + while (l < hdr->length) { /* Obtain each remote VTEP and process. */ STREAM_GETL(s, vni); l += 4; @@ -5629,8 +5627,7 @@ stream_failure: /* * Handle message from client to add a remote VTEP for a VNI. */ -void zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_remote_vtep_add(ZAPI_HANDLER_ARGS) { struct stream *s; u_short l = 0; @@ -5655,7 +5652,7 @@ void zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, s = client->ibuf; - while (l < length) { + while (l < hdr->length) { /* Obtain each remote VTEP and process. */ STREAM_GETL(s, vni); l += 4; @@ -6512,8 +6509,7 @@ int zebra_vxlan_vrf_delete(struct zebra_vrf *zvrf) * Handle message from client to enable/disable advertisement of g/w macip * routes */ -void zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_subnet(ZAPI_HANDLER_ARGS) { struct stream *s; int advertise; @@ -6578,8 +6574,7 @@ void zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, * Handle message from client to enable/disable advertisement of g/w macip * routes */ -void zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_gw_macip(ZAPI_HANDLER_ARGS) { struct stream *s; int advertise; @@ -6686,8 +6681,8 @@ stream_failure: * when disabled, the entries should be deleted and remote VTEPs and MACs * uninstalled from the kernel. */ -void zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +void zebra_vxlan_advertise_all_vni(ZAPI_HANDLER_ARGS) + { struct stream *s = NULL; int advertise = 0; diff --git a/zebra/zebra_vxlan.h b/zebra/zebra_vxlan.h index af76a41d80..62c6519d50 100644 --- a/zebra/zebra_vxlan.h +++ b/zebra/zebra_vxlan.h @@ -33,6 +33,7 @@ #include "lib/json.h" #include "zebra/zebra_vrf.h" +#include "zebra/zserv.h" /* Is EVPN enabled? */ #define EVPN_ENABLED(zvrf) (zvrf)->advertise_all_vni @@ -52,20 +53,14 @@ static inline int is_evpn_enabled() #define VNI_STR_LEN 32 /* zserv handlers */ -extern void zebra_vxlan_remote_macip_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern void zebra_vxlan_remote_macip_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern void zebra_vxlan_remote_vtep_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern void zebra_vxlan_remote_vtep_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern void zebra_vxlan_advertise_subnet(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern void zebra_vxlan_advertise_gw_macip(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); -extern void zebra_vxlan_advertise_all_vni(struct zserv *client, u_short length, - struct zebra_vrf *zvrf); +extern void zebra_vxlan_remote_macip_add(ZAPI_HANDLER_ARGS); +extern void zebra_vxlan_remote_macip_del(ZAPI_HANDLER_ARGS); +extern void zebra_vxlan_remote_vtep_add(ZAPI_HANDLER_ARGS); +extern void zebra_vxlan_remote_vtep_del(ZAPI_HANDLER_ARGS); +extern void zebra_vxlan_advertise_subnet(ZAPI_HANDLER_ARGS); +extern void zebra_vxlan_advertise_gw_macip(ZAPI_HANDLER_ARGS); +extern void zebra_vxlan_advertise_all_vni(ZAPI_HANDLER_ARGS); + extern int is_l3vni_for_prefix_routes_only(vni_t vni); extern ifindex_t get_l3vni_svi_ifindex(vrf_id_t vrf_id); diff --git a/zebra/zserv.c b/zebra/zserv.c index 3ecc82be42..127913a63a 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -692,27 +692,34 @@ static int zsend_write_nexthop(struct stream *s, struct nexthop *nexthop) return 1; } +int cmd2type[] = { + [ZEBRA_NEXTHOP_REGISTER] = RNH_NEXTHOP_TYPE, + [ZEBRA_NEXTHOP_UNREGISTER] = RNH_NEXTHOP_TYPE, + [ZEBRA_IMPORT_ROUTE_REGISTER] = RNH_IMPORT_CHECK_TYPE, + [ZEBRA_IMPORT_ROUTE_UNREGISTER] = RNH_IMPORT_CHECK_TYPE, +}; + /* Nexthop register */ -static void zserv_rnh_register(struct zserv *client, u_short length, - rnh_type_t type, struct zebra_vrf *zvrf) +static void zserv_rnh_register(ZAPI_HANDLER_ARGS) { struct rnh *rnh; struct stream *s; struct prefix p; u_short l = 0; u_char flags = 0; + uint16_t type = cmd2type[hdr->command]; if (IS_ZEBRA_DEBUG_NHT) zlog_debug( "rnh_register msg from client %s: length=%d, type=%s\n", - zebra_route_string(client->proto), length, + zebra_route_string(client->proto), hdr->length, (type == RNH_NEXTHOP_TYPE) ? "nexthop" : "route"); s = client->ibuf; client->nh_reg_time = monotime(NULL); - while (l < length) { + while (l < hdr->length) { STREAM_GETC(s, flags); STREAM_GETW(s, p.family); STREAM_GETC(s, p.prefixlen); @@ -768,21 +775,21 @@ stream_failure: } /* Nexthop register */ -static void zserv_rnh_unregister(struct zserv *client, u_short length, - rnh_type_t type, struct zebra_vrf *zvrf) +static void zserv_rnh_unregister(ZAPI_HANDLER_ARGS) { struct rnh *rnh; struct stream *s; struct prefix p; u_short l = 0; + uint16_t type = cmd2type[hdr->command]; if (IS_ZEBRA_DEBUG_NHT) zlog_debug("rnh_unregister msg from client %s: length=%d\n", - zebra_route_string(client->proto), length); + zebra_route_string(client->proto), hdr->length); s = client->ibuf; - while (l < length) { + while (l < hdr->length) { uint8_t flags; STREAM_GETC(s, flags); @@ -829,10 +836,9 @@ stream_failure: #define ZEBRA_MIN_FEC_LENGTH 5 /* FEC register */ -static void zserv_fec_register(struct zserv *client, u_short length) +static void zserv_fec_register(ZAPI_HANDLER_ARGS) { struct stream *s; - struct zebra_vrf *zvrf; u_short l = 0; struct prefix p; u_int16_t flags; @@ -847,14 +853,14 @@ static void zserv_fec_register(struct zserv *client, u_short length) * The minimum amount of data that can be sent for one fec * registration */ - if (length < ZEBRA_MIN_FEC_LENGTH) { + if (hdr->length < ZEBRA_MIN_FEC_LENGTH) { zlog_err( "fec_register: Received a fec register of length %d, it is of insufficient size to properly decode", - length); + hdr->length); return; } - while (l < length) { + while (l < hdr->length) { STREAM_GETW(s, flags); memset(&p, 0, sizeof(p)); STREAM_GETW(s, p.family); @@ -889,10 +895,9 @@ stream_failure: } /* FEC unregister */ -static void zserv_fec_unregister(struct zserv *client, u_short length) +static void zserv_fec_unregister(ZAPI_HANDLER_ARGS) { struct stream *s; - struct zebra_vrf *zvrf; u_short l = 0; struct prefix p; uint16_t flags; @@ -906,14 +911,14 @@ static void zserv_fec_unregister(struct zserv *client, u_short length) * The minimum amount of data that can be sent for one * fec unregistration */ - if (length < ZEBRA_MIN_FEC_LENGTH) { + if (hdr->length < ZEBRA_MIN_FEC_LENGTH) { zlog_err( "fec_unregister: Received a fec unregister of length %d, it is of insufficient size to properly decode", - length); + hdr->length); return; } - while (l < length) { + while (l < hdr->length) { STREAM_GETW(s, flags); if (flags != 0) goto stream_failure; @@ -1133,8 +1138,8 @@ int zsend_pw_update(struct zserv *client, struct zebra_pw *pw) /* Register zebra server interface information. Send current all interface and address information. */ -static void zread_interface_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_interface_add(ZAPI_HANDLER_ARGS) + { struct vrf *vrf; struct interface *ifp; @@ -1159,8 +1164,7 @@ static void zread_interface_add(struct zserv *client, u_short length, } /* Unregister zebra server interface information. */ -static void zread_interface_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_interface_delete(ZAPI_HANDLER_ARGS) { vrf_bitmap_unset(client->ifinfo, zvrf_id(zvrf)); } @@ -1177,8 +1181,7 @@ void zserv_nexthop_num_warn(const char *caller, const struct prefix *p, } } -static void zread_route_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_route_add(ZAPI_HANDLER_ARGS) { struct stream *s; struct zapi_route api; @@ -1332,8 +1335,7 @@ static void zread_route_add(struct zserv *client, u_short length, } } -static void zread_route_del(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_route_del(ZAPI_HANDLER_ARGS) { struct stream *s; struct zapi_route api; @@ -1375,8 +1377,7 @@ static void zread_route_del(struct zserv *client, u_short length, * Parse the ZEBRA_IPV4_ROUTE_ADD sent from client. Update re and * add kernel route. */ -static void zread_ipv4_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_add(ZAPI_HANDLER_ARGS) { int i; struct route_entry *re; @@ -1530,8 +1531,7 @@ stream_failure: } /* Zebra server IPv4 prefix delete function. */ -static void zread_ipv4_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_delete(ZAPI_HANDLER_ARGS) { struct stream *s; struct zapi_ipv4 api; @@ -1569,8 +1569,7 @@ stream_failure: } /* MRIB Nexthop lookup for IPv4. */ -static void zread_ipv4_nexthop_lookup_mrib(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_nexthop_lookup_mrib(ZAPI_HANDLER_ARGS) { struct in_addr addr; struct route_entry *re; @@ -1585,9 +1584,7 @@ stream_failure: } /* Zebra server IPv6 prefix add function. */ -static void zread_ipv4_route_ipv6_nexthop_add(struct zserv *client, - u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv4_route_ipv6_nexthop_add(ZAPI_HANDLER_ARGS) { unsigned int i; struct stream *s; @@ -1760,8 +1757,7 @@ stream_failure: return; } -static void zread_ipv6_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv6_add(ZAPI_HANDLER_ARGS) { unsigned int i; struct stream *s; @@ -1956,8 +1952,7 @@ stream_failure: } /* Zebra server IPv6 prefix delete function. */ -static void zread_ipv6_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_ipv6_delete(ZAPI_HANDLER_ARGS) { struct stream *s; struct zapi_ipv6 api; @@ -1999,8 +1994,7 @@ stream_failure: } /* Register zebra server router-id information. Send current router-id */ -static void zread_router_id_add(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_router_id_add(ZAPI_HANDLER_ARGS) { struct prefix p; @@ -2013,14 +2007,13 @@ static void zread_router_id_add(struct zserv *client, u_short length, } /* Unregister zebra server router-id information. */ -static void zread_router_id_delete(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_router_id_delete(ZAPI_HANDLER_ARGS) { vrf_bitmap_unset(client->ridinfo, zvrf_id(zvrf)); } /* Tie up route-type and client->sock */ -static void zread_hello(struct zserv *client) +static void zread_hello(ZAPI_HANDLER_ARGS) { /* type of protocol (lib/zebra.h) */ u_char proto; @@ -2050,8 +2043,7 @@ stream_failure: } /* Unregister all information in a VRF. */ -static void zread_vrf_unregister(struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_vrf_unregister(ZAPI_HANDLER_ARGS) { int i; afi_t afi; @@ -2064,8 +2056,7 @@ static void zread_vrf_unregister(struct zserv *client, u_short length, vrf_bitmap_unset(client->ridinfo, zvrf_id(zvrf)); } -static void zread_mpls_labels(int command, struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_mpls_labels(ZAPI_HANDLER_ARGS) { struct stream *s; enum lsp_types_t type; @@ -2135,12 +2126,12 @@ static void zread_mpls_labels(int command, struct zserv *client, u_short length, if (!mpls_enabled) return; - if (command == ZEBRA_MPLS_LABELS_ADD) { + if (hdr->command == ZEBRA_MPLS_LABELS_ADD) { mpls_lsp_install(zvrf, type, in_label, out_label, gtype, &gate, ifindex); mpls_ftn_update(1, zvrf, type, &prefix, gtype, &gate, ifindex, distance, out_label); - } else if (command == ZEBRA_MPLS_LABELS_DELETE) { + } else if (hdr->command == ZEBRA_MPLS_LABELS_DELETE) { mpls_lsp_uninstall(zvrf, type, in_label, gtype, &gate, ifindex); mpls_ftn_update(0, zvrf, type, &prefix, gtype, &gate, ifindex, distance, out_label); @@ -2280,19 +2271,19 @@ static void zread_release_label_chunk(struct zserv *client) stream_failure: return; } -static void zread_label_manager_request(int cmd, struct zserv *client, - struct zebra_vrf *zvrf) +static void zread_label_manager_request(ZAPI_HANDLER_ARGS) { /* to avoid sending other messages like ZERBA_INTERFACE_UP */ - if (cmd == ZEBRA_LABEL_MANAGER_CONNECT) + if (hdr->command == ZEBRA_LABEL_MANAGER_CONNECT) client->is_synchronous = 1; /* external label manager */ if (lm_is_external) - zread_relay_label_manager_request(cmd, client, zvrf_id(zvrf)); + zread_relay_label_manager_request(hdr->command, client, + zvrf_id(zvrf)); /* this is a label manager */ else { - if (cmd == ZEBRA_LABEL_MANAGER_CONNECT) + if (hdr->command == ZEBRA_LABEL_MANAGER_CONNECT) zread_label_manager_connect(client, zvrf_id(zvrf)); else { /* Sanity: don't allow 'unidentified' requests */ @@ -2301,16 +2292,15 @@ static void zread_label_manager_request(int cmd, struct zserv *client, "Got label request from an unidentified client"); return; } - if (cmd == ZEBRA_GET_LABEL_CHUNK) + if (hdr->command == ZEBRA_GET_LABEL_CHUNK) zread_get_label_chunk(client, zvrf_id(zvrf)); - else if (cmd == ZEBRA_RELEASE_LABEL_CHUNK) + else if (hdr->command == ZEBRA_RELEASE_LABEL_CHUNK) zread_release_label_chunk(client); } } } -static void zread_pseudowire(int command, struct zserv *client, u_short length, - struct zebra_vrf *zvrf) +static void zread_pseudowire(ZAPI_HANDLER_ARGS) { struct stream *s; char ifname[IF_NAMESIZE]; @@ -2350,12 +2340,12 @@ static void zread_pseudowire(int command, struct zserv *client, u_short length, protocol = client->proto; pw = zebra_pw_find(zvrf, ifname); - switch (command) { + switch (hdr->command) { case ZEBRA_PW_ADD: if (pw) { zlog_warn("%s: pseudowire %s already exists [%s]", __func__, ifname, - zserv_command_string(command)); + zserv_command_string(hdr->command)); return; } @@ -2364,7 +2354,7 @@ static void zread_pseudowire(int command, struct zserv *client, u_short length, case ZEBRA_PW_DELETE: if (!pw) { zlog_warn("%s: pseudowire %s not found [%s]", __func__, - ifname, zserv_command_string(command)); + ifname, zserv_command_string(hdr->command)); return; } @@ -2374,11 +2364,11 @@ static void zread_pseudowire(int command, struct zserv *client, u_short length, case ZEBRA_PW_UNSET: if (!pw) { zlog_warn("%s: pseudowire %s not found [%s]", __func__, - ifname, zserv_command_string(command)); + ifname, zserv_command_string(hdr->command)); return; } - switch (command) { + switch (hdr->command) { case ZEBRA_PW_SET: pw->enabled = 1; break; @@ -2528,7 +2518,7 @@ static void zebra_client_create(int sock) zebra_vrf_update_all(client); } -static void zread_interface_set_master(struct zserv *client, u_short length) +static void zread_interface_set_master(ZAPI_HANDLER_ARGS) { struct interface *master; struct interface *slave; @@ -2554,7 +2544,7 @@ stream_failure: } -static void zread_vrf_label(struct zserv *client, struct zebra_vrf *zvrf) +static void zread_vrf_label(ZAPI_HANDLER_ARGS) { struct interface *ifp; mpls_label_t nlabel; @@ -2622,8 +2612,7 @@ stream_failure: return; } -static inline void zread_rule(uint16_t command, struct zserv *client, - uint16_t length, struct zebra_vrf *zvrf) +static inline void zread_rule(ZAPI_HANDLER_ARGS) { struct zebra_pbr_rule zpr; struct stream *s; @@ -2671,7 +2660,7 @@ static inline void zread_rule(uint16_t command, struct zserv *client, if (zpr.filter.dst_port) zpr.filter.filter_bm |= PBR_FILTER_DST_PORT; - if (command == ZEBRA_RULE_ADD) + if (hdr->command == ZEBRA_RULE_ADD) zebra_pbr_add_rule(zvrf->zns, &zpr); else zebra_pbr_del_rule(zvrf->zns, &zpr); @@ -2698,162 +2687,78 @@ stream_failure: return false; } +void (*zserv_handlers[])(ZAPI_HANDLER_ARGS) = { + [ZEBRA_ROUTER_ID_ADD] = zread_router_id_add, + [ZEBRA_ROUTER_ID_DELETE] = zread_router_id_delete, + [ZEBRA_INTERFACE_ADD] = zread_interface_add, + [ZEBRA_INTERFACE_DELETE] = zread_interface_delete, + [ZEBRA_ROUTE_ADD] = zread_route_add, + [ZEBRA_ROUTE_DELETE] = zread_route_del, + [ZEBRA_IPV4_ROUTE_ADD] = zread_ipv4_add, + [ZEBRA_IPV4_ROUTE_DELETE] = zread_ipv4_delete, + [ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD] = zread_ipv4_route_ipv6_nexthop_add, + [ZEBRA_IPV6_ROUTE_ADD] = zread_ipv6_add, + [ZEBRA_IPV6_ROUTE_DELETE] = zread_ipv6_delete, + [ZEBRA_REDISTRIBUTE_ADD] = zebra_redistribute_add, + [ZEBRA_REDISTRIBUTE_DELETE] = zebra_redistribute_delete, + [ZEBRA_REDISTRIBUTE_DEFAULT_ADD] = zebra_redistribute_default_add, + [ZEBRA_REDISTRIBUTE_DEFAULT_DELETE] = zebra_redistribute_default_delete, + [ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB] = zread_ipv4_nexthop_lookup_mrib, + [ZEBRA_HELLO] = zread_hello, + [ZEBRA_NEXTHOP_REGISTER] = zserv_rnh_register, + [ZEBRA_NEXTHOP_UNREGISTER] = zserv_rnh_unregister, + [ZEBRA_IMPORT_ROUTE_REGISTER] = zserv_rnh_register, + [ZEBRA_IMPORT_ROUTE_UNREGISTER] = zserv_rnh_unregister, + [ZEBRA_BFD_DEST_UPDATE] = zebra_ptm_bfd_dst_register, + [ZEBRA_BFD_DEST_REGISTER] = zebra_ptm_bfd_dst_register, + [ZEBRA_BFD_DEST_DEREGISTER] = zebra_ptm_bfd_dst_deregister, + [ZEBRA_VRF_UNREGISTER] = zread_vrf_unregister, + [ZEBRA_VRF_LABEL] = zread_vrf_label, + [ZEBRA_BFD_CLIENT_REGISTER] = zebra_ptm_bfd_client_register, +#if defined(HAVE_RTADV) + [ZEBRA_INTERFACE_ENABLE_RADV] = zebra_interface_radv_enable, + [ZEBRA_INTERFACE_DISABLE_RADV] = zebra_interface_radv_disable, +#else + [ZEBRA_INTERFACE_ENABLE_RADV] = NULL, + [ZEBRA_INTERFACE_DISABLE_RADV] = NULL, +#endif + [ZEBRA_MPLS_LABELS_ADD] = zread_mpls_labels, + [ZEBRA_MPLS_LABELS_DELETE] = zread_mpls_labels, + [ZEBRA_IPMR_ROUTE_STATS] = zebra_ipmr_route_stats, + [ZEBRA_LABEL_MANAGER_CONNECT] = zread_label_manager_request, + [ZEBRA_GET_LABEL_CHUNK] = zread_label_manager_request, + [ZEBRA_RELEASE_LABEL_CHUNK] = zread_label_manager_request, + [ZEBRA_FEC_REGISTER] = zserv_fec_register, + [ZEBRA_FEC_UNREGISTER] = zserv_fec_unregister, + [ZEBRA_ADVERTISE_DEFAULT_GW] = zebra_vxlan_advertise_gw_macip, + [ZEBRA_ADVERTISE_SUBNET] = zebra_vxlan_advertise_subnet, + [ZEBRA_ADVERTISE_ALL_VNI] = zebra_vxlan_advertise_all_vni, + [ZEBRA_REMOTE_VTEP_ADD] = zebra_vxlan_remote_vtep_add, + [ZEBRA_REMOTE_VTEP_DEL] = zebra_vxlan_remote_vtep_del, + [ZEBRA_REMOTE_MACIP_ADD] = zebra_vxlan_remote_macip_add, + [ZEBRA_REMOTE_MACIP_DEL] = zebra_vxlan_remote_macip_del, + [ZEBRA_INTERFACE_SET_MASTER] = zread_interface_set_master, + [ZEBRA_PW_ADD] = zread_pseudowire, + [ZEBRA_PW_DELETE] = zread_pseudowire, + [ZEBRA_PW_SET] = zread_pseudowire, + [ZEBRA_PW_UNSET] = zread_pseudowire, + [ZEBRA_RULE_ADD] = zread_rule, + [ZEBRA_RULE_DELETE] = zread_rule, +}; + static inline void zserv_handle_commands(struct zserv *client, uint16_t command, uint16_t length, struct zebra_vrf *zvrf) { struct zmsghdr hdr; + stream_set_getp(client->ibuf, 0); zserv_read_header(client->ibuf, &hdr); - - switch (command) { - case ZEBRA_ROUTER_ID_ADD: - zread_router_id_add(client, length, zvrf); - break; - case ZEBRA_ROUTER_ID_DELETE: - zread_router_id_delete(client, length, zvrf); - break; - case ZEBRA_INTERFACE_ADD: - zread_interface_add(client, length, zvrf); - break; - case ZEBRA_INTERFACE_DELETE: - zread_interface_delete(client, length, zvrf); - break; - case ZEBRA_ROUTE_ADD: - zread_route_add(client, length, zvrf); - break; - case ZEBRA_ROUTE_DELETE: - zread_route_del(client, length, zvrf); - break; - case ZEBRA_IPV4_ROUTE_ADD: - zread_ipv4_add(client, length, zvrf); - break; - case ZEBRA_IPV4_ROUTE_DELETE: - zread_ipv4_delete(client, length, zvrf); - break; - case ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD: - zread_ipv4_route_ipv6_nexthop_add(client, length, zvrf); - break; - case ZEBRA_IPV6_ROUTE_ADD: - zread_ipv6_add(client, length, zvrf); - break; - case ZEBRA_IPV6_ROUTE_DELETE: - zread_ipv6_delete(client, length, zvrf); - break; - case ZEBRA_REDISTRIBUTE_ADD: - zebra_redistribute_add(command, client, length, zvrf); - break; - case ZEBRA_REDISTRIBUTE_DELETE: - zebra_redistribute_delete(command, client, length, zvrf); - break; - case ZEBRA_REDISTRIBUTE_DEFAULT_ADD: - zebra_redistribute_default_add(command, client, length, zvrf); - break; - case ZEBRA_REDISTRIBUTE_DEFAULT_DELETE: - zebra_redistribute_default_delete(command, client, length, - zvrf); - break; - case ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB: - zread_ipv4_nexthop_lookup_mrib(client, length, zvrf); - break; - case ZEBRA_HELLO: - zread_hello(client); - break; - case ZEBRA_NEXTHOP_REGISTER: - zserv_rnh_register(client, length, RNH_NEXTHOP_TYPE, zvrf); - break; - case ZEBRA_NEXTHOP_UNREGISTER: - zserv_rnh_unregister(client, length, RNH_NEXTHOP_TYPE, zvrf); - break; - case ZEBRA_IMPORT_ROUTE_REGISTER: - zserv_rnh_register(client, length, RNH_IMPORT_CHECK_TYPE, zvrf); - break; - case ZEBRA_IMPORT_ROUTE_UNREGISTER: - zserv_rnh_unregister(client, length, RNH_IMPORT_CHECK_TYPE, - zvrf); - break; - case ZEBRA_BFD_DEST_UPDATE: - case ZEBRA_BFD_DEST_REGISTER: - zebra_ptm_bfd_dst_register(client, length, command, zvrf); - break; - case ZEBRA_BFD_DEST_DEREGISTER: - zebra_ptm_bfd_dst_deregister(client, length, zvrf); - break; - case ZEBRA_VRF_UNREGISTER: - zread_vrf_unregister(client, length, zvrf); - break; - case ZEBRA_VRF_LABEL: - zread_vrf_label(client, zvrf); - break; - case ZEBRA_BFD_CLIENT_REGISTER: - zebra_ptm_bfd_client_register(client, length); - break; - case ZEBRA_INTERFACE_ENABLE_RADV: -#if defined(HAVE_RTADV) - zebra_interface_radv_set(client, length, zvrf, 1); -#endif - break; - case ZEBRA_INTERFACE_DISABLE_RADV: -#if defined(HAVE_RTADV) - zebra_interface_radv_set(client, length, zvrf, 0); -#endif - break; - case ZEBRA_MPLS_LABELS_ADD: - case ZEBRA_MPLS_LABELS_DELETE: - zread_mpls_labels(command, client, length, zvrf); - break; - case ZEBRA_IPMR_ROUTE_STATS: - zebra_ipmr_route_stats(client, length, zvrf); - break; - case ZEBRA_LABEL_MANAGER_CONNECT: - case ZEBRA_GET_LABEL_CHUNK: - case ZEBRA_RELEASE_LABEL_CHUNK: - zread_label_manager_request(command, client, zvrf); - break; - case ZEBRA_FEC_REGISTER: - zserv_fec_register(client, length); - break; - case ZEBRA_FEC_UNREGISTER: - zserv_fec_unregister(client, length); - break; - case ZEBRA_ADVERTISE_DEFAULT_GW: - zebra_vxlan_advertise_gw_macip(client, length, zvrf); - break; - case ZEBRA_ADVERTISE_SUBNET: - zebra_vxlan_advertise_subnet(client, length, zvrf); - break; - case ZEBRA_ADVERTISE_ALL_VNI: - zebra_vxlan_advertise_all_vni(client, length, zvrf); - break; - case ZEBRA_REMOTE_VTEP_ADD: - zebra_vxlan_remote_vtep_add(client, length, zvrf); - break; - case ZEBRA_REMOTE_VTEP_DEL: - zebra_vxlan_remote_vtep_del(client, length, zvrf); - break; - case ZEBRA_REMOTE_MACIP_ADD: - zebra_vxlan_remote_macip_add(client, length, zvrf); - break; - case ZEBRA_REMOTE_MACIP_DEL: - zebra_vxlan_remote_macip_del(client, length, zvrf); - break; - case ZEBRA_INTERFACE_SET_MASTER: - zread_interface_set_master(client, length); - break; - case ZEBRA_PW_ADD: - case ZEBRA_PW_DELETE: - case ZEBRA_PW_SET: - case ZEBRA_PW_UNSET: - zread_pseudowire(command, client, length, zvrf); - break; - case ZEBRA_RULE_ADD: - case ZEBRA_RULE_DELETE: - zread_rule(command, client, length, zvrf); - break; - default: - zlog_info("Zebra received unknown command %d", command); - break; - } + if (hdr.command > sizeof(zserv_handlers) + || zserv_handlers[hdr.command] == NULL) + zlog_info("Zebra received unknown command %d", hdr.command); + else + zserv_handlers[hdr.command](client, &hdr, zvrf); } #if defined(HANDLE_ZAPI_FUZZING) diff --git a/zebra/zserv.h b/zebra/zserv.h index a09baeff7a..74ff31bcf9 100644 --- a/zebra/zserv.h +++ b/zebra/zserv.h @@ -138,6 +138,9 @@ struct zmsghdr { uint16_t command; }; +#define ZAPI_HANDLER_ARGS \ + struct zserv *client, struct zmsghdr *hdr, struct zebra_vrf *zvrf + /* Zebra instance */ struct zebra_t { /* Thread master */ From 1002497af5aedffc661cb457c8775634a65c3a19 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 6 Mar 2018 18:08:37 -0500 Subject: [PATCH 127/148] zebra: reorganize zserv, batch i/o Group send and receive functions together, change handlers to take a message instead of looking at ->ibuf and ->obuf, allow zebra to read multiple packets off the wire at a time. Signed-off-by: Quentin Young --- zebra/label_manager.c | 22 +- zebra/redistribute.c | 12 +- zebra/redistribute.h | 3 +- zebra/rtadv.c | 19 +- zebra/rtadv.h | 2 +- zebra/zebra_mpls.c | 5 +- zebra/zebra_mroute.c | 11 +- zebra/zebra_ptm.c | 8 +- zebra/zebra_ptm.h | 5 +- zebra/zebra_ptm_redistribute.c | 10 +- zebra/zebra_rnh.c | 5 +- zebra/zebra_vxlan.c | 49 +- zebra/zebra_vxlan.h | 3 +- zebra/zebra_vxlan_null.c | 20 +- zebra/zserv.c | 1585 ++++++++++++++++---------------- zebra/zserv.h | 15 +- 16 files changed, 910 insertions(+), 864 deletions(-) diff --git a/zebra/label_manager.c b/zebra/label_manager.c index 5bf0fce094..b58f0c9ff8 100644 --- a/zebra/label_manager.c +++ b/zebra/label_manager.c @@ -50,6 +50,8 @@ DEFINE_MTYPE_STATIC(LBL_MGR, LM_CHUNK, "Label Manager Chunk"); * it will be a proxy to relay messages to external label manager * This zclient thus is to connect to it */ +static struct stream *ibuf; +static struct stream *obuf; static struct zclient *zclient; bool lm_is_external; @@ -69,7 +71,7 @@ static int relay_response_back(struct zserv *zserv) u_int16_t resp_cmd; src = zclient->ibuf; - dst = zserv->obuf; + dst = obuf; stream_reset(src); @@ -87,7 +89,7 @@ static int relay_response_back(struct zserv *zserv) /* send response back */ stream_copy(dst, src); - ret = writen(zserv->sock, dst->data, stream_get_endp(dst)); + ret = writen(zserv->sock, src->data, stream_get_endp(src)); if (ret <= 0) { zlog_err("%s: Error sending Label Manager response back: %s", __func__, strerror(errno)); @@ -116,10 +118,10 @@ static int lm_zclient_read(struct thread *t) static int reply_error(int cmd, struct zserv *zserv, vrf_id_t vrf_id) { + int ret; struct stream *s; - s = zserv->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, vrf_id); @@ -129,7 +131,10 @@ static int reply_error(int cmd, struct zserv *zserv, vrf_id_t vrf_id) /* Write packet size. */ stream_putw_at(s, 0, stream_get_endp(s)); - return writen(zserv->sock, s->data, stream_get_endp(s)); + ret = writen(zserv->sock, s->data, stream_get_endp(s)); + + stream_free(s); + return ret; } /** * Receive a request to get or release a label chunk and forward it to external @@ -161,7 +166,7 @@ int zread_relay_label_manager_request(int cmd, struct zserv *zserv, ret = relay_response_back(zserv); /* Send request to external label manager */ - src = zserv->ibuf; + src = ibuf; dst = zclient->obuf; stream_copy(dst, src); @@ -247,6 +252,9 @@ void label_manager_init(char *lm_zserv_path) lm_is_external = true; lm_zclient_init(lm_zserv_path); } + + ibuf = stream_new(ZEBRA_MAX_PACKET_SIZ); + obuf = stream_new(ZEBRA_MAX_PACKET_SIZ); } /** @@ -379,4 +387,6 @@ int release_daemon_chunks(u_char proto, u_short instance) void label_manager_close() { list_delete_and_null(&lbl_mgr.lc_list); + stream_free(ibuf); + stream_free(obuf); } diff --git a/zebra/redistribute.c b/zebra/redistribute.c index 93862cadc9..5a239306fb 100644 --- a/zebra/redistribute.c +++ b/zebra/redistribute.c @@ -249,9 +249,9 @@ void zebra_redistribute_add(ZAPI_HANDLER_ARGS) int type = 0; u_short instance; - STREAM_GETC(client->ibuf, afi); - STREAM_GETC(client->ibuf, type); - STREAM_GETW(client->ibuf, instance); + STREAM_GETC(msg, afi); + STREAM_GETC(msg, type); + STREAM_GETW(msg, instance); if (afi == 0 || afi > AFI_MAX) { zlog_warn("%s: Specified afi %d does not exist", @@ -292,9 +292,9 @@ void zebra_redistribute_delete(ZAPI_HANDLER_ARGS) int type = 0; u_short instance; - STREAM_GETC(client->ibuf, afi); - STREAM_GETC(client->ibuf, type); - STREAM_GETW(client->ibuf, instance); + STREAM_GETC(msg, afi); + STREAM_GETC(msg, type); + STREAM_GETW(msg, instance); if (afi == 0 || afi > AFI_MAX) { zlog_warn("%s: Specified afi %d does not exist", diff --git a/zebra/redistribute.h b/zebra/redistribute.h index 6ca3b57d4d..e551f820cc 100644 --- a/zebra/redistribute.h +++ b/zebra/redistribute.h @@ -27,11 +27,12 @@ #include "vty.h" #include "vrf.h" -/* zapi handlers */ +/* ZAPI command handlers */ extern void zebra_redistribute_add(ZAPI_HANDLER_ARGS); extern void zebra_redistribute_delete(ZAPI_HANDLER_ARGS); extern void zebra_redistribute_default_add(ZAPI_HANDLER_ARGS); extern void zebra_redistribute_default_delete(ZAPI_HANDLER_ARGS); +/* ----------------- */ extern void redistribute_update(struct prefix *, struct prefix *, struct route_entry *, struct route_entry *); diff --git a/zebra/rtadv.c b/zebra/rtadv.c index 56decdcdba..d0b821bfd2 100644 --- a/zebra/rtadv.c +++ b/zebra/rtadv.c @@ -43,7 +43,6 @@ #include "zebra/zserv.h" #include "zebra/zebra_ns.h" #include "zebra/zebra_vrf.h" -#include "zebra/zserv.h" extern struct zebra_privs_t zserv_privs; @@ -802,7 +801,7 @@ static void ipv6_nd_suppress_ra_set(struct interface *ifp, * if the operator has explicitly enabled RA. The enable request can also * specify a RA interval (in seconds). */ -void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int set) +static void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int enable) { struct stream *s; ifindex_t ifindex; @@ -810,7 +809,7 @@ void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int set) struct zebra_if *zif; int ra_interval; - s = client->ibuf; + s = msg; /* Get interface index and RA interval. */ STREAM_GETL(s, ifindex); @@ -818,26 +817,27 @@ void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int set) if (IS_ZEBRA_DEBUG_EVENT) zlog_debug("%u: IF %u RA %s from client %s, interval %ds", - zvrf_id(zvrf), ifindex, set ? "enable" : "disable", + zvrf_id(zvrf), ifindex, + enable ? "enable" : "disable", zebra_route_string(client->proto), ra_interval); /* Locate interface and check VRF match. */ ifp = if_lookup_by_index_per_ns(zebra_ns_lookup(NS_DEFAULT), ifindex); if (!ifp) { zlog_warn("%u: IF %u RA %s client %s - interface unknown", - zvrf_id(zvrf), ifindex, set ? "enable" : "disable", + zvrf_id(zvrf), ifindex, enable ? "enable" : "disable", zebra_route_string(client->proto)); return; } if (ifp->vrf_id != zvrf_id(zvrf)) { zlog_warn("%u: IF %u RA %s client %s - VRF mismatch, IF VRF %u", - zvrf_id(zvrf), ifindex, set ? "enable" : "disable", + zvrf_id(zvrf), ifindex, enable ? "enable" : "disable", zebra_route_string(client->proto), ifp->vrf_id); return; } zif = ifp->info; - if (set) { + if (enable) { SET_FLAG(zif->rtadv.ra_configured, BGP_RA_CONFIGURED); ipv6_nd_suppress_ra_set(ifp, RA_ENABLE); if (ra_interval @@ -860,12 +860,11 @@ stream_failure: void zebra_interface_radv_disable(ZAPI_HANDLER_ARGS) { - zebra_interface_radv_set(client, hdr, zvrf, 0); + zebra_interface_radv_set(client, hdr, msg, zvrf, 0); } - void zebra_interface_radv_enable(ZAPI_HANDLER_ARGS) { - zebra_interface_radv_set(client, hdr, zvrf, 1); + zebra_interface_radv_set(client, hdr, msg, zvrf, 1); } DEFUN (ipv6_nd_suppress_ra, diff --git a/zebra/rtadv.h b/zebra/rtadv.h index 28019a3237..8fd67c8a63 100644 --- a/zebra/rtadv.h +++ b/zebra/rtadv.h @@ -103,8 +103,8 @@ typedef enum { extern void rtadv_init(struct zebra_ns *); extern void rtadv_terminate(struct zebra_ns *); extern void rtadv_cmd_init(void); -extern void zebra_interface_radv_set(ZAPI_HANDLER_ARGS, int enable); extern void zebra_interface_radv_disable(ZAPI_HANDLER_ARGS); extern void zebra_interface_radv_enable(ZAPI_HANDLER_ARGS); + #endif /* _ZEBRA_RTADV_H */ diff --git a/zebra/zebra_mpls.c b/zebra/zebra_mpls.c index 0af06806d3..1868b4676d 100644 --- a/zebra/zebra_mpls.c +++ b/zebra/zebra_mpls.c @@ -455,8 +455,7 @@ static int fec_send(zebra_fec_t *fec, struct zserv *client) rn = fec->rn; /* Get output stream. */ - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_FEC_UPDATE, VRF_DEFAULT); @@ -464,7 +463,7 @@ static int fec_send(zebra_fec_t *fec, struct zserv *client) stream_put_prefix(s, &rn->p); stream_putl(s, fec->label); stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* diff --git a/zebra/zebra_mroute.c b/zebra/zebra_mroute.c index e70b963cfd..042bd3769e 100644 --- a/zebra/zebra_mroute.c +++ b/zebra/zebra_mroute.c @@ -31,7 +31,6 @@ #include "zebra/zebra_mroute.h" #include "zebra/rt.h" #include "zebra/debug.h" -#include "zebra/zserv.h" void zebra_ipmr_route_stats(ZAPI_HANDLER_ARGS) { @@ -40,9 +39,9 @@ void zebra_ipmr_route_stats(ZAPI_HANDLER_ARGS) int suc = -1; memset(&mroute, 0, sizeof(mroute)); - STREAM_GET(&mroute.sg.src, client->ibuf, 4); - STREAM_GET(&mroute.sg.grp, client->ibuf, 4); - STREAM_GETL(client->ibuf, mroute.ifindex); + STREAM_GET(&mroute.sg.src, msg, 4); + STREAM_GET(&mroute.sg.grp, msg, 4); + STREAM_GETL(msg, mroute.ifindex); if (IS_ZEBRA_DEBUG_KERNEL) { char sbuf[40]; @@ -57,7 +56,7 @@ void zebra_ipmr_route_stats(ZAPI_HANDLER_ARGS) suc = kernel_get_ipmr_sg_stats(zvrf, &mroute); stream_failure: - s = client->obuf; + s = stream_new(ZEBRA_MAX_PACKET_SIZ); stream_reset(s); @@ -68,5 +67,5 @@ stream_failure: stream_putl(s, suc); stream_putw_at(s, 0, stream_get_endp(s)); - zebra_server_send_message(client); + zebra_server_send_message(client, s); } diff --git a/zebra/zebra_ptm.c b/zebra/zebra_ptm.c index 0c48473aad..67c7220b6f 100644 --- a/zebra/zebra_ptm.c +++ b/zebra/zebra_ptm.c @@ -702,7 +702,7 @@ void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS) ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_CLIENT_FIELD, tmp_buf); - s = client->ibuf; + s = msg; STREAM_GETL(s, pid); sprintf(tmp_buf, "%d", pid); @@ -819,7 +819,6 @@ void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS) stream_failure: ptm_lib_cleanup_msg(ptm_hdl, out_ctxt); - return; } /* BFD peer/dst deregister */ @@ -859,7 +858,7 @@ void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS) ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_CLIENT_FIELD, tmp_buf); - s = client->ibuf; + s = msg; STREAM_GETL(s, pid); sprintf(tmp_buf, "%d", pid); @@ -950,7 +949,6 @@ void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS) stream_failure: ptm_lib_cleanup_msg(ptm_hdl, out_ctxt); - return; } /* BFD client register */ @@ -968,7 +966,7 @@ void zebra_ptm_bfd_client_register(ZAPI_HANDLER_ARGS) zlog_debug("bfd_client_register msg from client %s: length=%d", zebra_route_string(client->proto), hdr->length); - s = client->ibuf; + s = msg; STREAM_GETL(s, pid); if (ptm_cb.ptm_sock == -1) { diff --git a/zebra/zebra_ptm.h b/zebra/zebra_ptm.h index 22cacd6fc0..0b41410bec 100644 --- a/zebra/zebra_ptm.h +++ b/zebra/zebra_ptm.h @@ -22,14 +22,14 @@ #ifndef _ZEBRA_PTM_H #define _ZEBRA_PTM_H -#include "zebra/zserv.h" - extern const char ZEBRA_PTM_SOCK_NAME[]; #define ZEBRA_PTM_MAX_SOCKBUF 3200 /* 25B *128 ports */ #define ZEBRA_PTM_SEND_MAX_SOCKBUF 512 #define ZEBRA_PTM_BFD_CLIENT_FLAG_REG (1 << 1) /* client registered with BFD */ +#include "zebra/zserv.h" + /* Zebra ptm context block */ struct zebra_ptm_cb { int ptm_sock; /* ptm file descriptor. */ @@ -64,6 +64,7 @@ int zebra_ptm_connect(struct thread *t); void zebra_ptm_write(struct vty *vty); int zebra_ptm_get_enable_state(void); +/* ZAPI message handlers */ void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS); void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS); void zebra_ptm_bfd_client_register(ZAPI_HANDLER_ARGS); diff --git a/zebra/zebra_ptm_redistribute.c b/zebra/zebra_ptm_redistribute.c index 8fddd400cc..fe788ac4d7 100644 --- a/zebra/zebra_ptm_redistribute.c +++ b/zebra/zebra_ptm_redistribute.c @@ -38,8 +38,7 @@ static int zsend_interface_bfd_update(int cmd, struct zserv *client, if (!client->ifinfo) return 0; - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, vrf_id); if (ifp) @@ -66,7 +65,7 @@ static int zsend_interface_bfd_update(int cmd, struct zserv *client, stream_putw_at(s, 0, stream_get_endp(s)); client->if_bfd_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } void zebra_interface_bfd_update(struct interface *ifp, struct prefix *dp, @@ -93,8 +92,7 @@ static int zsend_bfd_peer_replay(int cmd, struct zserv *client) { struct stream *s; - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, VRF_DEFAULT); @@ -102,7 +100,7 @@ static int zsend_bfd_peer_replay(int cmd, struct zserv *client) stream_putw_at(s, 0, stream_get_endp(s)); client->bfd_peer_replay_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } void zebra_bfd_peer_replay_req(void) diff --git a/zebra/zebra_rnh.c b/zebra/zebra_rnh.c index dd3fe17702..c9fb782ba6 100644 --- a/zebra/zebra_rnh.c +++ b/zebra/zebra_rnh.c @@ -995,8 +995,7 @@ static int send_client(struct rnh *rnh, struct zserv *client, rnh_type_t type, re = rnh->state; /* Get output stream. */ - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, vrf_id); @@ -1063,7 +1062,7 @@ static int send_client(struct rnh *rnh, struct zserv *client, rnh_type_t type, client->nh_last_upd_time = monotime(NULL); client->last_write_cmd = cmd; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } static void print_nh(struct nexthop *nexthop, struct vty *vty) diff --git a/zebra/zebra_vxlan.c b/zebra/zebra_vxlan.c index f22d5160fb..a8d1848723 100644 --- a/zebra/zebra_vxlan.c +++ b/zebra/zebra_vxlan.c @@ -46,7 +46,6 @@ #include "zebra/zebra_vxlan.h" #include "zebra/zebra_memory.h" #include "zebra/zebra_l2.h" -#include "zebra/zserv.h" DEFINE_MTYPE_STATIC(ZEBRA, HOST_PREFIX, "host prefix"); DEFINE_MTYPE_STATIC(ZEBRA, ZVNI, "VNI hash"); @@ -1158,8 +1157,7 @@ static int zvni_macip_send_msg_to_client(vni_t vni, struct ethaddr *macaddr, if (!client) return 0; - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, VRF_DEFAULT); stream_putl(s, vni); @@ -1196,7 +1194,7 @@ static int zvni_macip_send_msg_to_client(vni_t vni, struct ethaddr *macaddr, else client->macipdel_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* @@ -2566,8 +2564,7 @@ static int zvni_send_add_to_client(zebra_vni_t *zvni) if (!client) return 0; - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_VNI_ADD, VRF_DEFAULT); stream_putl(s, zvni->vni); @@ -2584,7 +2581,7 @@ static int zvni_send_add_to_client(zebra_vni_t *zvni) zebra_route_string(client->proto)); client->vniadd_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* @@ -2600,7 +2597,7 @@ static int zvni_send_del_to_client(vni_t vni) if (!client) return 0; - s = client->obuf; + s = stream_new(ZEBRA_MAX_PACKET_SIZ); stream_reset(s); zclient_create_header(s, ZEBRA_VNI_DEL, VRF_DEFAULT); @@ -2614,7 +2611,7 @@ static int zvni_send_del_to_client(vni_t vni) zebra_route_string(client->proto)); client->vnidel_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* @@ -3551,8 +3548,7 @@ static int zl3vni_send_add_to_client(zebra_l3vni_t *zl3vni) memset(&rmac, 0, sizeof(struct ethaddr)); zl3vni_get_rmac(zl3vni, &rmac); - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_L3VNI_ADD, zl3vni_vrf_id(zl3vni)); stream_putl(s, zl3vni->vni); @@ -3575,7 +3571,7 @@ static int zl3vni_send_add_to_client(zebra_l3vni_t *zl3vni) zebra_route_string(client->proto)); client->l3vniadd_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* @@ -3591,8 +3587,7 @@ static int zl3vni_send_del_to_client(zebra_l3vni_t *zl3vni) if (!client) return 0; - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_L3VNI_DEL, zl3vni_vrf_id(zl3vni)); stream_putl(s, zl3vni->vni); @@ -3606,7 +3601,7 @@ static int zl3vni_send_del_to_client(zebra_l3vni_t *zl3vni) zebra_route_string(client->proto)); client->l3vnidel_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } static void zebra_vxlan_process_l3vni_oper_up(zebra_l3vni_t *zl3vni) @@ -3724,8 +3719,7 @@ static int ip_prefix_send_to_client(vrf_id_t vrf_id, struct prefix *p, if (!client) return 0; - s = client->obuf; - stream_reset(s); + s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, vrf_id); stream_put(s, p, sizeof(struct prefix)); @@ -3744,7 +3738,7 @@ static int ip_prefix_send_to_client(vrf_id_t vrf_id, struct prefix *p, else client->prefixdel_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* re-add remote rmac if needed */ @@ -4884,7 +4878,7 @@ void zebra_vxlan_remote_macip_del(ZAPI_HANDLER_ARGS) memset(&ip, 0, sizeof(struct ipaddr)); memset(&vtep_ip, 0, sizeof(struct in_addr)); - s = client->ibuf; + s = msg; while (l < hdr->length) { /* Obtain each remote MACIP and process. */ @@ -5047,7 +5041,7 @@ void zebra_vxlan_remote_macip_add(ZAPI_HANDLER_ARGS) return; } - s = client->ibuf; + s = msg; while (l < hdr->length) { /* Obtain each remote MACIP and process. */ @@ -5566,7 +5560,7 @@ void zebra_vxlan_remote_vtep_del(ZAPI_HANDLER_ARGS) return; } - s = client->ibuf; + s = msg; while (l < hdr->length) { /* Obtain each remote VTEP and process. */ @@ -5650,7 +5644,7 @@ void zebra_vxlan_remote_vtep_add(ZAPI_HANDLER_ARGS) return; } - s = client->ibuf; + s = msg; while (l < hdr->length) { /* Obtain each remote VTEP and process. */ @@ -6526,7 +6520,7 @@ void zebra_vxlan_advertise_subnet(ZAPI_HANDLER_ARGS) return; } - s = client->ibuf; + s = msg; advertise = stream_getc(s); vni = stream_get3(s); @@ -6566,8 +6560,6 @@ void zebra_vxlan_advertise_subnet(ZAPI_HANDLER_ARGS) zvni_advertise_subnet(zvni, vlan_if, 1); else zvni_advertise_subnet(zvni, vlan_if, 0); - - return; } /* @@ -6588,7 +6580,7 @@ void zebra_vxlan_advertise_gw_macip(ZAPI_HANDLER_ARGS) return; } - s = client->ibuf; + s = msg; STREAM_GETC(s, advertise); STREAM_GET(&vni, s, 3); @@ -6620,7 +6612,7 @@ void zebra_vxlan_advertise_gw_macip(ZAPI_HANDLER_ARGS) zvni = zvni_lookup(vni); if (!zvni) - return; + return 0; if (IS_ZEBRA_DEBUG_VXLAN) zlog_debug( @@ -6682,7 +6674,6 @@ stream_failure: * uninstalled from the kernel. */ void zebra_vxlan_advertise_all_vni(ZAPI_HANDLER_ARGS) - { struct stream *s = NULL; int advertise = 0; @@ -6693,7 +6684,7 @@ void zebra_vxlan_advertise_all_vni(ZAPI_HANDLER_ARGS) return; } - s = client->ibuf; + s = msg; STREAM_GETC(s, advertise); if (IS_ZEBRA_DEBUG_VXLAN) diff --git a/zebra/zebra_vxlan.h b/zebra/zebra_vxlan.h index 62c6519d50..6f25ad1e24 100644 --- a/zebra/zebra_vxlan.h +++ b/zebra/zebra_vxlan.h @@ -52,7 +52,7 @@ static inline int is_evpn_enabled() #define VNI_STR_LEN 32 -/* zserv handlers */ +/* ZAPI message handlers */ extern void zebra_vxlan_remote_macip_add(ZAPI_HANDLER_ARGS); extern void zebra_vxlan_remote_macip_del(ZAPI_HANDLER_ARGS); extern void zebra_vxlan_remote_vtep_add(ZAPI_HANDLER_ARGS); @@ -61,7 +61,6 @@ extern void zebra_vxlan_advertise_subnet(ZAPI_HANDLER_ARGS); extern void zebra_vxlan_advertise_gw_macip(ZAPI_HANDLER_ARGS); extern void zebra_vxlan_advertise_all_vni(ZAPI_HANDLER_ARGS); - extern int is_l3vni_for_prefix_routes_only(vni_t vni); extern ifindex_t get_l3vni_svi_ifindex(vrf_id_t vrf_id); extern int zebra_vxlan_vrf_delete(struct zebra_vrf *zvrf); diff --git a/zebra/zebra_vxlan_null.c b/zebra/zebra_vxlan_null.c index e6a3dd674e..1bac2cafb6 100644 --- a/zebra/zebra_vxlan_null.c +++ b/zebra/zebra_vxlan_null.c @@ -117,14 +117,14 @@ int zebra_vxlan_svi_down(struct interface *ifp, struct interface *link_if) return 0; } -void zebra_vxlan_remote_macip_add(struct zserv *client, int sock, - u_short length, struct zebra_vrf *zvrf) +int zebra_vxlan_remote_macip_add(struct zserv *client, int sock, u_short length, + struct zebra_vrf *zvrf) { return 0; } -void zebra_vxlan_remote_macip_del(struct zserv *client, int sock, - u_short length, struct zebra_vrf *zvrf) +int zebra_vxlan_remote_macip_del(struct zserv *client, int sock, u_short length, + struct zebra_vrf *zvrf) { return 0; } @@ -182,20 +182,20 @@ int zebra_vxlan_if_del(struct interface *ifp) return 0; } -void zebra_vxlan_remote_vtep_add(struct zserv *client, int sock, u_short length, - struct zebra_vrf *zvrf) +int zebra_vxlan_remote_vtep_add(struct zserv *client, int sock, u_short length, + struct zebra_vrf *zvrf) { return 0; } -void zebra_vxlan_remote_vtep_del(struct zserv *client, int sock, u_short length, - struct zebra_vrf *zvrf) +int zebra_vxlan_remote_vtep_del(struct zserv *client, int sock, u_short length, + struct zebra_vrf *zvrf) { return 0; } -void zebra_vxlan_advertise_all_vni(struct zserv *client, int sock, - u_short length, struct zebra_vrf *zvrf) +int zebra_vxlan_advertise_all_vni(struct zserv *client, int sock, + u_short length, struct zebra_vrf *zvrf) { return 0; } diff --git a/zebra/zserv.c b/zebra/zserv.c index 127913a63a..ac2fe9c0e2 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -63,94 +63,23 @@ #include "zebra/zebra_pbr.h" /* Event list of zebra. */ -enum event { ZEBRA_SERV, ZEBRA_READ, ZEBRA_WRITE }; - -static void zebra_event(enum event event, int sock, struct zserv *client); - +enum event { ZEBRA_READ, ZEBRA_WRITE }; +/* privileges */ extern struct zebra_privs_t zserv_privs; +/* post event into client */ +static void zebra_event(struct zserv *client, enum event event); -static void zebra_client_close(struct zserv *client); -static int zserv_delayed_close(struct thread *thread) +/* Public interface ======================================================== */ + +int zebra_server_send_message(struct zserv *client, struct stream *msg) { - struct zserv *client = THREAD_ARG(thread); - - client->t_suicide = NULL; - zebra_client_close(client); + stream_fifo_push(client->obuf_fifo, msg); + zebra_event(client, ZEBRA_WRITE); return 0; } -static int zserv_flush_data(struct thread *thread) -{ - struct zserv *client = THREAD_ARG(thread); - - client->t_write = NULL; - if (client->t_suicide) { - zebra_client_close(client); - return -1; - } - switch (buffer_flush_available(client->wb, client->sock)) { - case BUFFER_ERROR: - zlog_warn( - "%s: buffer_flush_available failed on zserv client fd %d, " - "closing", - __func__, client->sock); - zebra_client_close(client); - client = NULL; - break; - case BUFFER_PENDING: - client->t_write = NULL; - thread_add_write(zebrad.master, zserv_flush_data, client, - client->sock, &client->t_write); - break; - case BUFFER_EMPTY: - break; - } - - if (client) - client->last_write_time = monotime(NULL); - return 0; -} - -int zebra_server_send_message(struct zserv *client) -{ - if (client->t_suicide) - return -1; - - if (client->is_synchronous) - return 0; - - stream_set_getp(client->obuf, 0); - client->last_write_cmd = stream_getw_from(client->obuf, 6); - switch (buffer_write(client->wb, client->sock, - STREAM_DATA(client->obuf), - stream_get_endp(client->obuf))) { - case BUFFER_ERROR: - zlog_warn( - "%s: buffer_write failed to zserv client fd %d, closing", - __func__, client->sock); - /* Schedule a delayed close since many of the functions that - call this - one do not check the return code. They do not allow for the - possibility that an I/O error may have caused the client to - be - deleted. */ - client->t_suicide = NULL; - thread_add_event(zebrad.master, zserv_delayed_close, client, 0, - &client->t_suicide); - return -1; - case BUFFER_EMPTY: - THREAD_OFF(client->t_write); - break; - case BUFFER_PENDING: - thread_add_write(zebrad.master, zserv_flush_data, client, - client->sock, &client->t_write); - break; - } - - client->last_write_time = monotime(NULL); - return 0; -} +/* Encoding helpers -------------------------------------------------------- */ static void zserv_encode_interface(struct stream *s, struct interface *ifp) { @@ -202,6 +131,34 @@ static void zserv_encode_vrf(struct stream *s, struct zebra_vrf *zvrf) stream_putw_at(s, 0, stream_get_endp(s)); } +static int zserv_encode_nexthop(struct stream *s, struct nexthop *nexthop) +{ + stream_putc(s, nexthop->type); + switch (nexthop->type) { + case NEXTHOP_TYPE_IPV4: + case NEXTHOP_TYPE_IPV4_IFINDEX: + stream_put_in_addr(s, &nexthop->gate.ipv4); + stream_putl(s, nexthop->ifindex); + break; + case NEXTHOP_TYPE_IPV6: + stream_put(s, &nexthop->gate.ipv6, 16); + break; + case NEXTHOP_TYPE_IPV6_IFINDEX: + stream_put(s, &nexthop->gate.ipv6, 16); + stream_putl(s, nexthop->ifindex); + break; + case NEXTHOP_TYPE_IFINDEX: + stream_putl(s, nexthop->ifindex); + break; + default: + /* do nothing */ + break; + } + return 1; +} + +/* Send handlers ----------------------------------------------------------- */ + /* Interface is added. Send ZEBRA_INTERFACE_ADD to client. */ /* * This function is called in the following situations: @@ -215,65 +172,54 @@ static void zserv_encode_vrf(struct stream *s, struct zebra_vrf *zvrf) */ int zsend_interface_add(struct zserv *client, struct interface *ifp) { - struct stream *s; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_INTERFACE_ADD, ifp->vrf_id); zserv_encode_interface(s, ifp); client->ifadd_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* Interface deletion from zebra daemon. */ int zsend_interface_delete(struct zserv *client, struct interface *ifp) { - struct stream *s; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_INTERFACE_DELETE, ifp->vrf_id); zserv_encode_interface(s, ifp); client->ifdel_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } int zsend_vrf_add(struct zserv *client, struct zebra_vrf *zvrf) { - struct stream *s; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_VRF_ADD, zvrf_id(zvrf)); zserv_encode_vrf(s, zvrf); client->vrfadd_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* VRF deletion from zebra daemon. */ int zsend_vrf_delete(struct zserv *client, struct zebra_vrf *zvrf) -{ - struct stream *s; - s = client->obuf; - stream_reset(s); +{ + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_VRF_DELETE, zvrf_id(zvrf)); zserv_encode_vrf(s, zvrf); client->vrfdel_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } int zsend_interface_link_params(struct zserv *client, struct interface *ifp) { - struct stream *s; + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); /* Check this client need interface information. */ if (!client->ifinfo) @@ -281,8 +227,6 @@ int zsend_interface_link_params(struct zserv *client, struct interface *ifp) if (!ifp->link_params) return 0; - s = client->obuf; - stream_reset(s); zclient_create_header(s, ZEBRA_INTERFACE_LINK_PARAMS, ifp->vrf_id); @@ -296,7 +240,7 @@ int zsend_interface_link_params(struct zserv *client, struct interface *ifp) /* Write packet size. */ stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* Interface address is added/deleted. Send ZEBRA_INTERFACE_ADDRESS_ADD or @@ -341,11 +285,8 @@ int zsend_interface_address(int cmd, struct zserv *client, struct interface *ifp, struct connected *ifc) { int blen; - struct stream *s; struct prefix *p; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, ifp->vrf_id); stream_putl(s, ifp->ifindex); @@ -378,7 +319,7 @@ int zsend_interface_address(int cmd, struct zserv *client, stream_putw_at(s, 0, stream_get_endp(s)); client->connected_rt_add_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } static int zsend_interface_nbr_address(int cmd, struct zserv *client, @@ -386,12 +327,9 @@ static int zsend_interface_nbr_address(int cmd, struct zserv *client, struct nbr_connected *ifc) { int blen; - struct stream *s; + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); struct prefix *p; - s = client->obuf; - stream_reset(s); - zclient_create_header(s, cmd, ifp->vrf_id); stream_putl(s, ifp->ifindex); @@ -412,7 +350,7 @@ static int zsend_interface_nbr_address(int cmd, struct zserv *client, /* Write packet size. */ stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* Interface address addition. */ @@ -498,10 +436,7 @@ int zsend_interface_addresses(struct zserv *client, struct interface *ifp) int zsend_interface_vrf_update(struct zserv *client, struct interface *ifp, vrf_id_t vrf_id) { - struct stream *s; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_INTERFACE_VRF_UPDATE, ifp->vrf_id); @@ -513,7 +448,7 @@ int zsend_interface_vrf_update(struct zserv *client, struct interface *ifp, stream_putw_at(s, 0, stream_get_endp(s)); client->if_vrfchg_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* Add new nbr connected IPv6 address */ @@ -575,10 +510,7 @@ void nbr_connected_delete_ipv6(struct interface *ifp, struct in6_addr *address) */ int zsend_interface_update(int cmd, struct zserv *client, struct interface *ifp) { - struct stream *s; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, cmd, ifp->vrf_id); zserv_encode_interface(s, ifp); @@ -588,7 +520,7 @@ int zsend_interface_update(int cmd, struct zserv *client, struct interface *ifp) else client->ifdown_cnt++; - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } int zsend_redistribute_route(int cmd, struct zserv *client, struct prefix *p, @@ -660,301 +592,19 @@ int zsend_redistribute_route(int cmd, struct zserv *client, struct prefix *p, SET_FLAG(api.message, ZAPI_MESSAGE_MTU); api.mtu = re->mtu; + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); + /* Encode route and send. */ - if (zapi_route_encode(cmd, client->obuf, &api) < 0) + if (zapi_route_encode(cmd, s, &api) < 0) return -1; - return zebra_server_send_message(client); -} - -static int zsend_write_nexthop(struct stream *s, struct nexthop *nexthop) -{ - stream_putc(s, nexthop->type); - switch (nexthop->type) { - case NEXTHOP_TYPE_IPV4: - case NEXTHOP_TYPE_IPV4_IFINDEX: - stream_put_in_addr(s, &nexthop->gate.ipv4); - stream_putl(s, nexthop->ifindex); - break; - case NEXTHOP_TYPE_IPV6: - stream_put(s, &nexthop->gate.ipv6, 16); - break; - case NEXTHOP_TYPE_IPV6_IFINDEX: - stream_put(s, &nexthop->gate.ipv6, 16); - stream_putl(s, nexthop->ifindex); - break; - case NEXTHOP_TYPE_IFINDEX: - stream_putl(s, nexthop->ifindex); - break; - default: - /* do nothing */ - break; - } - return 1; -} - -int cmd2type[] = { - [ZEBRA_NEXTHOP_REGISTER] = RNH_NEXTHOP_TYPE, - [ZEBRA_NEXTHOP_UNREGISTER] = RNH_NEXTHOP_TYPE, - [ZEBRA_IMPORT_ROUTE_REGISTER] = RNH_IMPORT_CHECK_TYPE, - [ZEBRA_IMPORT_ROUTE_UNREGISTER] = RNH_IMPORT_CHECK_TYPE, -}; - -/* Nexthop register */ -static void zserv_rnh_register(ZAPI_HANDLER_ARGS) -{ - struct rnh *rnh; - struct stream *s; - struct prefix p; - u_short l = 0; - u_char flags = 0; - uint16_t type = cmd2type[hdr->command]; - - if (IS_ZEBRA_DEBUG_NHT) - zlog_debug( - "rnh_register msg from client %s: length=%d, type=%s\n", - zebra_route_string(client->proto), hdr->length, - (type == RNH_NEXTHOP_TYPE) ? "nexthop" : "route"); - - s = client->ibuf; - - client->nh_reg_time = monotime(NULL); - - while (l < hdr->length) { - STREAM_GETC(s, flags); - STREAM_GETW(s, p.family); - STREAM_GETC(s, p.prefixlen); - l += 4; - if (p.family == AF_INET) { - if (p.prefixlen > IPV4_MAX_BITLEN) { - zlog_warn( - "%s: Specified prefix length %d is too large for a v4 address", - __PRETTY_FUNCTION__, p.prefixlen); - return; - } - STREAM_GET(&p.u.prefix4.s_addr, s, IPV4_MAX_BYTELEN); - l += IPV4_MAX_BYTELEN; - } else if (p.family == AF_INET6) { - if (p.prefixlen > IPV6_MAX_BITLEN) { - zlog_warn( - "%s: Specified prefix length %d is to large for a v6 address", - __PRETTY_FUNCTION__, p.prefixlen); - return; - } - STREAM_GET(&p.u.prefix6, s, IPV6_MAX_BYTELEN); - l += IPV6_MAX_BYTELEN; - } else { - zlog_err( - "rnh_register: Received unknown family type %d\n", - p.family); - return; - } - rnh = zebra_add_rnh(&p, zvrf_id(zvrf), type); - if (type == RNH_NEXTHOP_TYPE) { - if (flags - && !CHECK_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED)) - SET_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED); - else if (!flags - && CHECK_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED)) - UNSET_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED); - } else if (type == RNH_IMPORT_CHECK_TYPE) { - if (flags - && !CHECK_FLAG(rnh->flags, ZEBRA_NHT_EXACT_MATCH)) - SET_FLAG(rnh->flags, ZEBRA_NHT_EXACT_MATCH); - else if (!flags && CHECK_FLAG(rnh->flags, - ZEBRA_NHT_EXACT_MATCH)) - UNSET_FLAG(rnh->flags, ZEBRA_NHT_EXACT_MATCH); - } - - zebra_add_rnh_client(rnh, client, type, zvrf_id(zvrf)); - /* Anything not AF_INET/INET6 has been filtered out above */ - zebra_evaluate_rnh(zvrf_id(zvrf), p.family, 1, type, &p); - } - -stream_failure: - return; -} - -/* Nexthop register */ -static void zserv_rnh_unregister(ZAPI_HANDLER_ARGS) -{ - struct rnh *rnh; - struct stream *s; - struct prefix p; - u_short l = 0; - uint16_t type = cmd2type[hdr->command]; - - if (IS_ZEBRA_DEBUG_NHT) - zlog_debug("rnh_unregister msg from client %s: length=%d\n", - zebra_route_string(client->proto), hdr->length); - - s = client->ibuf; - - while (l < hdr->length) { - uint8_t flags; - - STREAM_GETC(s, flags); - if (flags != 0) - goto stream_failure; - - STREAM_GETW(s, p.family); - STREAM_GETC(s, p.prefixlen); - l += 4; - if (p.family == AF_INET) { - if (p.prefixlen > IPV4_MAX_BITLEN) { - zlog_warn( - "%s: Specified prefix length %d is to large for a v4 address", - __PRETTY_FUNCTION__, p.prefixlen); - return; - } - STREAM_GET(&p.u.prefix4.s_addr, s, IPV4_MAX_BYTELEN); - l += IPV4_MAX_BYTELEN; - } else if (p.family == AF_INET6) { - if (p.prefixlen > IPV6_MAX_BITLEN) { - zlog_warn( - "%s: Specified prefix length %d is to large for a v6 address", - __PRETTY_FUNCTION__, p.prefixlen); - return; - } - STREAM_GET(&p.u.prefix6, s, IPV6_MAX_BYTELEN); - l += IPV6_MAX_BYTELEN; - } else { - zlog_err( - "rnh_register: Received unknown family type %d\n", - p.family); - return; - } - rnh = zebra_lookup_rnh(&p, zvrf_id(zvrf), type); - if (rnh) { - client->nh_dereg_time = monotime(NULL); - zebra_remove_rnh_client(rnh, client, type); - } - } -stream_failure: - return; -} - -#define ZEBRA_MIN_FEC_LENGTH 5 - -/* FEC register */ -static void zserv_fec_register(ZAPI_HANDLER_ARGS) -{ - struct stream *s; - u_short l = 0; - struct prefix p; - u_int16_t flags; - u_int32_t label_index = MPLS_INVALID_LABEL_INDEX; - - s = client->ibuf; - zvrf = vrf_info_lookup(VRF_DEFAULT); - if (!zvrf) - return; - - /* - * The minimum amount of data that can be sent for one fec - * registration - */ - if (hdr->length < ZEBRA_MIN_FEC_LENGTH) { - zlog_err( - "fec_register: Received a fec register of length %d, it is of insufficient size to properly decode", - hdr->length); - return; - } - - while (l < hdr->length) { - STREAM_GETW(s, flags); - memset(&p, 0, sizeof(p)); - STREAM_GETW(s, p.family); - if (p.family != AF_INET && p.family != AF_INET6) { - zlog_err( - "fec_register: Received unknown family type %d\n", - p.family); - return; - } - STREAM_GETC(s, p.prefixlen); - if ((p.family == AF_INET && p.prefixlen > IPV4_MAX_BITLEN) - || (p.family == AF_INET6 - && p.prefixlen > IPV6_MAX_BITLEN)) { - zlog_warn( - "%s: Specified prefix length: %d is to long for %d", - __PRETTY_FUNCTION__, p.prefixlen, p.family); - return; - } - l += 5; - STREAM_GET(&p.u.prefix, s, PSIZE(p.prefixlen)); - l += PSIZE(p.prefixlen); - if (flags & ZEBRA_FEC_REGISTER_LABEL_INDEX) { - STREAM_GETL(s, label_index); - l += 4; - } else - label_index = MPLS_INVALID_LABEL_INDEX; - zebra_mpls_fec_register(zvrf, &p, label_index, client); - } - -stream_failure: - return; -} - -/* FEC unregister */ -static void zserv_fec_unregister(ZAPI_HANDLER_ARGS) -{ - struct stream *s; - u_short l = 0; - struct prefix p; - uint16_t flags; - - s = client->ibuf; - zvrf = vrf_info_lookup(VRF_DEFAULT); - if (!zvrf) - return; - - /* - * The minimum amount of data that can be sent for one - * fec unregistration - */ - if (hdr->length < ZEBRA_MIN_FEC_LENGTH) { - zlog_err( - "fec_unregister: Received a fec unregister of length %d, it is of insufficient size to properly decode", - hdr->length); - return; - } - - while (l < hdr->length) { - STREAM_GETW(s, flags); - if (flags != 0) - goto stream_failure; - - memset(&p, 0, sizeof(p)); - STREAM_GETW(s, p.family); - if (p.family != AF_INET && p.family != AF_INET6) { - zlog_err( - "fec_unregister: Received unknown family type %d\n", - p.family); - return; - } - STREAM_GETC(s, p.prefixlen); - if ((p.family == AF_INET && p.prefixlen > IPV4_MAX_BITLEN) - || (p.family == AF_INET6 - && p.prefixlen > IPV6_MAX_BITLEN)) { - zlog_warn( - "%s: Received prefix length %d which is greater than %d can support", - __PRETTY_FUNCTION__, p.prefixlen, p.family); - return; - } - l += 5; - STREAM_GET(&p.u.prefix, s, PSIZE(p.prefixlen)); - l += PSIZE(p.prefixlen); - zebra_mpls_fec_unregister(zvrf, &p, client); - } - -stream_failure: - return; + return zebra_server_send_message(client, s); } /* - Modified version of zsend_ipv4_nexthop_lookup(): - Query unicast rib if nexthop is not found on mrib. - Returns both route metric and protocol distance. -*/ + * Modified version of zsend_ipv4_nexthop_lookup(): Query unicast rib if + * nexthop is not found on mrib. Returns both route metric and protocol + * distance. + */ static int zsend_ipv4_nexthop_lookup_mrib(struct zserv *client, struct in_addr addr, struct route_entry *re, @@ -966,7 +616,7 @@ static int zsend_ipv4_nexthop_lookup_mrib(struct zserv *client, struct nexthop *nexthop; /* Get output stream. */ - s = client->obuf; + s = stream_new(ZEBRA_MAX_PACKET_SIZ); stream_reset(s); /* Fill in result. */ @@ -997,7 +647,7 @@ static int zsend_ipv4_nexthop_lookup_mrib(struct zserv *client, stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } int zsend_route_notify_owner(struct route_entry *re, struct prefix *p, @@ -1028,7 +678,7 @@ int zsend_route_notify_owner(struct route_entry *re, struct prefix *p, re->table, note); } - s = client->obuf; + s = stream_new(ZEBRA_MAX_PACKET_SIZ); stream_reset(s); zclient_create_header(s, ZEBRA_ROUTE_NOTIFY_OWNER, re->vrf_id); @@ -1045,7 +695,7 @@ int zsend_route_notify_owner(struct route_entry *re, struct prefix *p, stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } void zsend_rule_notify_owner(struct zebra_pbr_rule *rule, @@ -1068,7 +718,7 @@ void zsend_rule_notify_owner(struct zebra_pbr_rule *rule, if (!client) return; - s = client->obuf; + s = stream_new(ZEBRA_MAX_PACKET_SIZ); stream_reset(s); zclient_create_header(s, ZEBRA_RULE_NOTIFY_OWNER, VRF_DEFAULT); @@ -1083,22 +733,20 @@ void zsend_rule_notify_owner(struct zebra_pbr_rule *rule, stream_putw_at(s, 0, stream_get_endp(s)); - zebra_server_send_message(client); + zebra_server_send_message(client, s); } /* Router-id is updated. Send ZEBRA_ROUTER_ID_ADD to client. */ int zsend_router_id_update(struct zserv *client, struct prefix *p, vrf_id_t vrf_id) { - struct stream *s; int blen; /* Check this client need interface information. */ if (!vrf_bitmap_check(client->ridinfo, vrf_id)) return 0; - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); /* Message type. */ zclient_create_header(s, ZEBRA_ROUTER_ID_UPDATE, vrf_id); @@ -1112,7 +760,7 @@ int zsend_router_id_update(struct zserv *client, struct prefix *p, /* Write packet size. */ stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } /* @@ -1120,10 +768,7 @@ int zsend_router_id_update(struct zserv *client, struct prefix *p, */ int zsend_pw_update(struct zserv *client, struct zebra_pw *pw) { - struct stream *s; - - s = client->obuf; - stream_reset(s); + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); zclient_create_header(s, ZEBRA_PW_STATUS_UPDATE, pw->vrf_id); stream_write(s, pw->ifname, IF_NAMESIZE); @@ -1133,13 +778,325 @@ int zsend_pw_update(struct zserv *client, struct zebra_pw *pw) /* Put length at the first point of the stream. */ stream_putw_at(s, 0, stream_get_endp(s)); - return zebra_server_send_message(client); + return zebra_server_send_message(client, s); } -/* Register zebra server interface information. Send current all - interface and address information. */ -static void zread_interface_add(ZAPI_HANDLER_ARGS) +/* Send response to a get label chunk request to client */ +static int zsend_assign_label_chunk_response(struct zserv *client, + vrf_id_t vrf_id, + struct label_manager_chunk *lmc) +{ + int ret; + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); + zclient_create_header(s, ZEBRA_GET_LABEL_CHUNK, vrf_id); + + if (lmc) { + /* keep */ + stream_putc(s, lmc->keep); + /* start and end labels */ + stream_putl(s, lmc->start); + stream_putl(s, lmc->end); + } + + /* Write packet size. */ + stream_putw_at(s, 0, stream_get_endp(s)); + + ret = writen(client->sock, s->data, stream_get_endp(s)); + stream_free(s); + return ret; +} + +/* Send response to a label manager connect request to client */ +static int zsend_label_manager_connect_response(struct zserv *client, + vrf_id_t vrf_id, u_short result) +{ + int ret; + struct stream *s = stream_new(ZEBRA_MAX_PACKET_SIZ); + + zclient_create_header(s, ZEBRA_LABEL_MANAGER_CONNECT, vrf_id); + + /* result */ + stream_putc(s, result); + + /* Write packet size. */ + stream_putw_at(s, 0, stream_get_endp(s)); + + ret = writen(client->sock, s->data, stream_get_endp(s)); + stream_free(s); + + return ret; +} + +/* Inbound message handling ------------------------------------------------ */ + +int cmd2type[] = { + [ZEBRA_NEXTHOP_REGISTER] = RNH_NEXTHOP_TYPE, + [ZEBRA_NEXTHOP_UNREGISTER] = RNH_NEXTHOP_TYPE, + [ZEBRA_IMPORT_ROUTE_REGISTER] = RNH_IMPORT_CHECK_TYPE, + [ZEBRA_IMPORT_ROUTE_UNREGISTER] = RNH_IMPORT_CHECK_TYPE, +}; + +/* Nexthop register */ +static void zread_rnh_register(ZAPI_HANDLER_ARGS) +{ + struct rnh *rnh; + struct stream *s; + struct prefix p; + u_short l = 0; + u_char flags = 0; + uint16_t type = cmd2type[hdr->command]; + + if (IS_ZEBRA_DEBUG_NHT) + zlog_debug( + "rnh_register msg from client %s: hdr->length=%d, type=%s\n", + zebra_route_string(client->proto), hdr->length, + (type == RNH_NEXTHOP_TYPE) ? "nexthop" : "route"); + + s = msg; + + client->nh_reg_time = monotime(NULL); + + while (l < hdr->length) { + STREAM_GETC(s, flags); + STREAM_GETW(s, p.family); + STREAM_GETC(s, p.prefixlen); + l += 4; + if (p.family == AF_INET) { + if (p.prefixlen > IPV4_MAX_BITLEN) { + zlog_warn( + "%s: Specified prefix hdr->length %d is too large for a v4 address", + __PRETTY_FUNCTION__, p.prefixlen); + return; + } + STREAM_GET(&p.u.prefix4.s_addr, s, IPV4_MAX_BYTELEN); + l += IPV4_MAX_BYTELEN; + } else if (p.family == AF_INET6) { + if (p.prefixlen > IPV6_MAX_BITLEN) { + zlog_warn( + "%s: Specified prefix hdr->length %d is to large for a v6 address", + __PRETTY_FUNCTION__, p.prefixlen); + return; + } + STREAM_GET(&p.u.prefix6, s, IPV6_MAX_BYTELEN); + l += IPV6_MAX_BYTELEN; + } else { + zlog_err( + "rnh_register: Received unknown family type %d\n", + p.family); + return; + } + rnh = zebra_add_rnh(&p, zvrf_id(zvrf), type); + if (type == RNH_NEXTHOP_TYPE) { + if (flags + && !CHECK_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED)) + SET_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED); + else if (!flags + && CHECK_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED)) + UNSET_FLAG(rnh->flags, ZEBRA_NHT_CONNECTED); + } else if (type == RNH_IMPORT_CHECK_TYPE) { + if (flags + && !CHECK_FLAG(rnh->flags, ZEBRA_NHT_EXACT_MATCH)) + SET_FLAG(rnh->flags, ZEBRA_NHT_EXACT_MATCH); + else if (!flags + && CHECK_FLAG(rnh->flags, + ZEBRA_NHT_EXACT_MATCH)) + UNSET_FLAG(rnh->flags, ZEBRA_NHT_EXACT_MATCH); + } + + zebra_add_rnh_client(rnh, client, type, zvrf_id(zvrf)); + /* Anything not AF_INET/INET6 has been filtered out above */ + zebra_evaluate_rnh(zvrf_id(zvrf), p.family, 1, type, &p); + } + +stream_failure: + return; +} + +/* Nexthop register */ +static void zread_rnh_unregister(ZAPI_HANDLER_ARGS) +{ + struct rnh *rnh; + struct stream *s; + struct prefix p; + u_short l = 0; + uint16_t type = cmd2type[hdr->command]; + + if (IS_ZEBRA_DEBUG_NHT) + zlog_debug( + "rnh_unregister msg from client %s: hdr->length=%d\n", + zebra_route_string(client->proto), hdr->length); + + s = msg; + + while (l < hdr->length) { + uint8_t flags; + + STREAM_GETC(s, flags); + if (flags != 0) + goto stream_failure; + + STREAM_GETW(s, p.family); + STREAM_GETC(s, p.prefixlen); + l += 4; + if (p.family == AF_INET) { + if (p.prefixlen > IPV4_MAX_BITLEN) { + zlog_warn( + "%s: Specified prefix hdr->length %d is to large for a v4 address", + __PRETTY_FUNCTION__, p.prefixlen); + return; + } + STREAM_GET(&p.u.prefix4.s_addr, s, IPV4_MAX_BYTELEN); + l += IPV4_MAX_BYTELEN; + } else if (p.family == AF_INET6) { + if (p.prefixlen > IPV6_MAX_BITLEN) { + zlog_warn( + "%s: Specified prefix hdr->length %d is to large for a v6 address", + __PRETTY_FUNCTION__, p.prefixlen); + return; + } + STREAM_GET(&p.u.prefix6, s, IPV6_MAX_BYTELEN); + l += IPV6_MAX_BYTELEN; + } else { + zlog_err( + "rnh_register: Received unknown family type %d\n", + p.family); + return; + } + rnh = zebra_lookup_rnh(&p, zvrf_id(zvrf), type); + if (rnh) { + client->nh_dereg_time = monotime(NULL); + zebra_remove_rnh_client(rnh, client, type); + } + } +stream_failure: + return; +} + +#define ZEBRA_MIN_FEC_LENGTH 5 + +/* FEC register */ +static void zread_fec_register(ZAPI_HANDLER_ARGS) +{ + struct stream *s; + u_short l = 0; + struct prefix p; + uint16_t flags; + uint32_t label_index = MPLS_INVALID_LABEL_INDEX; + + s = msg; + zvrf = vrf_info_lookup(VRF_DEFAULT); + if (!zvrf) + return; // unexpected + + /* + * The minimum amount of data that can be sent for one fec + * registration + */ + if (hdr->length < ZEBRA_MIN_FEC_LENGTH) { + zlog_err( + "fec_register: Received a fec register of hdr->length %d, it is of insufficient size to properly decode", + hdr->length); + return; + } + + while (l < hdr->length) { + STREAM_GETW(s, flags); + memset(&p, 0, sizeof(p)); + STREAM_GETW(s, p.family); + if (p.family != AF_INET && p.family != AF_INET6) { + zlog_err( + "fec_register: Received unknown family type %d\n", + p.family); + return; + } + STREAM_GETC(s, p.prefixlen); + if ((p.family == AF_INET && p.prefixlen > IPV4_MAX_BITLEN) + || (p.family == AF_INET6 + && p.prefixlen > IPV6_MAX_BITLEN)) { + zlog_warn( + "%s: Specified prefix hdr->length: %d is to long for %d", + __PRETTY_FUNCTION__, p.prefixlen, p.family); + return; + } + l += 5; + STREAM_GET(&p.u.prefix, s, PSIZE(p.prefixlen)); + l += PSIZE(p.prefixlen); + if (flags & ZEBRA_FEC_REGISTER_LABEL_INDEX) { + STREAM_GETL(s, label_index); + l += 4; + } else + label_index = MPLS_INVALID_LABEL_INDEX; + zebra_mpls_fec_register(zvrf, &p, label_index, client); + } + +stream_failure: + return; +} + +/* FEC unregister */ +static void zread_fec_unregister(ZAPI_HANDLER_ARGS) +{ + struct stream *s; + u_short l = 0; + struct prefix p; + uint16_t flags; + + s = msg; + zvrf = vrf_info_lookup(VRF_DEFAULT); + if (!zvrf) + return; // unexpected + + /* + * The minimum amount of data that can be sent for one + * fec unregistration + */ + if (hdr->length < ZEBRA_MIN_FEC_LENGTH) { + zlog_err( + "fec_unregister: Received a fec unregister of hdr->length %d, it is of insufficient size to properly decode", + hdr->length); + return; + } + + while (l < hdr->length) { + STREAM_GETW(s, flags); + if (flags != 0) + goto stream_failure; + + memset(&p, 0, sizeof(p)); + STREAM_GETW(s, p.family); + if (p.family != AF_INET && p.family != AF_INET6) { + zlog_err( + "fec_unregister: Received unknown family type %d\n", + p.family); + return; + } + STREAM_GETC(s, p.prefixlen); + if ((p.family == AF_INET && p.prefixlen > IPV4_MAX_BITLEN) + || (p.family == AF_INET6 + && p.prefixlen > IPV6_MAX_BITLEN)) { + zlog_warn( + "%s: Received prefix hdr->length %d which is greater than %d can support", + __PRETTY_FUNCTION__, p.prefixlen, p.family); + return; + } + l += 5; + STREAM_GET(&p.u.prefix, s, PSIZE(p.prefixlen)); + l += PSIZE(p.prefixlen); + zebra_mpls_fec_unregister(zvrf, &p, client); + } + +stream_failure: + return; +} + + + +/* + * Register zebra server interface information. + * Send current all interface and address information. + */ +static void zread_interface_add(ZAPI_HANDLER_ARGS) { struct vrf *vrf; struct interface *ifp; @@ -1153,14 +1110,10 @@ static void zread_interface_add(ZAPI_HANDLER_ARGS) if (!CHECK_FLAG(ifp->status, ZEBRA_INTERFACE_ACTIVE)) continue; - if (zsend_interface_add(client, ifp) < 0) - return; - - if (zsend_interface_addresses(client, ifp) < 0) - return; + zsend_interface_add(client, ifp); + zsend_interface_addresses(client, ifp); } } - return; } /* Unregister zebra server interface information. */ @@ -1193,9 +1146,8 @@ static void zread_route_add(ZAPI_HANDLER_ARGS) int i, ret; vrf_id_t vrf_id = 0; - s = client->ibuf; - if (zapi_route_decode(s, &api) < 0) - return; + s = msg; + zapi_route_decode(s, &api); /* Allocate new route. */ vrf_id = zvrf_id(zvrf); @@ -1342,7 +1294,7 @@ static void zread_route_del(ZAPI_HANDLER_ARGS) afi_t afi; struct prefix_ipv6 *src_p = NULL; - s = client->ibuf; + s = msg; if (zapi_route_decode(s, &api) < 0) return; @@ -1368,8 +1320,6 @@ static void zread_route_del(ZAPI_HANDLER_ARGS) client->v6_route_del_cnt++; break; } - - return; } /* This function support multiple nexthop. */ @@ -1396,7 +1346,7 @@ static void zread_ipv4_add(ZAPI_HANDLER_ARGS) enum blackhole_type bh_type = BLACKHOLE_NULL; /* Get input stream. */ - s = client->ibuf; + s = msg; /* Allocate new re. */ re = XCALLOC(MTYPE_RE, sizeof(struct route_entry)); @@ -1527,7 +1477,6 @@ static void zread_ipv4_add(ZAPI_HANDLER_ARGS) stream_failure: nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return; } /* Zebra server IPv4 prefix delete function. */ @@ -1538,7 +1487,7 @@ static void zread_ipv4_delete(ZAPI_HANDLER_ARGS) struct prefix p; u_int32_t table_id; - s = client->ibuf; + s = msg; /* Type, flags, message. */ STREAM_GETC(s, api.type); @@ -1574,10 +1523,9 @@ static void zread_ipv4_nexthop_lookup_mrib(ZAPI_HANDLER_ARGS) struct in_addr addr; struct route_entry *re; - STREAM_GET(&addr.s_addr, client->ibuf, IPV4_MAX_BYTELEN); + STREAM_GET(&addr.s_addr, msg, IPV4_MAX_BYTELEN); re = rib_match_ipv4_multicast(zvrf_id(zvrf), addr, NULL); zsend_ipv4_nexthop_lookup_mrib(client, addr, re, zvrf); - return; stream_failure: return; @@ -1605,7 +1553,7 @@ static void zread_ipv4_route_ipv6_nexthop_add(ZAPI_HANDLER_ARGS) enum blackhole_type bh_type = BLACKHOLE_NULL; /* Get input stream. */ - s = client->ibuf; + s = msg; memset(&nhop_addr, 0, sizeof(struct in6_addr)); @@ -1618,7 +1566,6 @@ static void zread_ipv4_route_ipv6_nexthop_add(ZAPI_HANDLER_ARGS) zlog_warn("%s: Specified route type: %d is not a legal value\n", __PRETTY_FUNCTION__, re->type); XFREE(MTYPE_RE, re); - return; } STREAM_GETW(s, re->instance); @@ -1754,7 +1701,6 @@ static void zread_ipv4_route_ipv6_nexthop_add(ZAPI_HANDLER_ARGS) stream_failure: nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - return; } static void zread_ipv6_add(ZAPI_HANDLER_ARGS) @@ -1780,7 +1726,7 @@ static void zread_ipv6_add(ZAPI_HANDLER_ARGS) enum blackhole_type bh_type = BLACKHOLE_NULL; /* Get input stream. */ - s = client->ibuf; + s = msg; memset(&nhop_addr, 0, sizeof(struct in6_addr)); @@ -1947,8 +1893,6 @@ static void zread_ipv6_add(ZAPI_HANDLER_ARGS) stream_failure: nexthops_free(re->ng.nexthop); XFREE(MTYPE_RE, re); - - return; } /* Zebra server IPv6 prefix delete function. */ @@ -1959,7 +1903,7 @@ static void zread_ipv6_delete(ZAPI_HANDLER_ARGS) struct prefix p; struct prefix_ipv6 src_p, *src_pp; - s = client->ibuf; + s = msg; /* Type, flags, message. */ STREAM_GETC(s, api.type); @@ -2020,9 +1964,9 @@ static void zread_hello(ZAPI_HANDLER_ARGS) u_short instance; u_char notify; - STREAM_GETC(client->ibuf, proto); - STREAM_GETW(client->ibuf, instance); - STREAM_GETC(client->ibuf, notify); + STREAM_GETC(msg, proto); + STREAM_GETW(msg, instance); + STREAM_GETC(msg, notify); if (notify) client->notify_owner = true; @@ -2068,7 +2012,7 @@ static void zread_mpls_labels(ZAPI_HANDLER_ARGS) u_int8_t distance; /* Get input stream. */ - s = client->ibuf; + s = msg; /* Get data. */ STREAM_GETC(s, type); @@ -2139,27 +2083,9 @@ static void zread_mpls_labels(ZAPI_HANDLER_ARGS) stream_failure: return; } -/* Send response to a label manager connect request to client */ -static int zsend_label_manager_connect_response(struct zserv *client, - vrf_id_t vrf_id, u_short result) -{ - struct stream *s; - s = client->obuf; - stream_reset(s); - - zclient_create_header(s, ZEBRA_LABEL_MANAGER_CONNECT, vrf_id); - - /* result */ - stream_putc(s, result); - - /* Write packet size. */ - stream_putw_at(s, 0, stream_get_endp(s)); - - return writen(client->sock, s->data, stream_get_endp(s)); -} - -static void zread_label_manager_connect(struct zserv *client, vrf_id_t vrf_id) +static void zread_label_manager_connect(struct zserv *client, + struct stream *msg, vrf_id_t vrf_id) { struct stream *s; /* type of protocol (lib/zebra.h) */ @@ -2167,7 +2093,7 @@ static void zread_label_manager_connect(struct zserv *client, vrf_id_t vrf_id) u_short instance; /* Get input stream. */ - s = client->ibuf; + s = msg; /* Get data. */ STREAM_GETC(s, proto); @@ -2200,33 +2126,9 @@ static void zread_label_manager_connect(struct zserv *client, vrf_id_t vrf_id) stream_failure: return; } -/* Send response to a get label chunk request to client */ -static int zsend_assign_label_chunk_response(struct zserv *client, - vrf_id_t vrf_id, - struct label_manager_chunk *lmc) -{ - struct stream *s; - s = client->obuf; - stream_reset(s); - - zclient_create_header(s, ZEBRA_GET_LABEL_CHUNK, vrf_id); - - if (lmc) { - /* keep */ - stream_putc(s, lmc->keep); - /* start and end labels */ - stream_putl(s, lmc->start); - stream_putl(s, lmc->end); - } - - /* Write packet size. */ - stream_putw_at(s, 0, stream_get_endp(s)); - - return writen(client->sock, s->data, stream_get_endp(s)); -} - -static void zread_get_label_chunk(struct zserv *client, vrf_id_t vrf_id) +static void zread_get_label_chunk(struct zserv *client, struct stream *msg, + vrf_id_t vrf_id) { struct stream *s; u_char keep; @@ -2234,7 +2136,7 @@ static void zread_get_label_chunk(struct zserv *client, vrf_id_t vrf_id) struct label_manager_chunk *lmc; /* Get input stream. */ - s = client->ibuf; + s = msg; /* Get data. */ STREAM_GETC(s, keep); @@ -2254,13 +2156,13 @@ stream_failure: return; } -static void zread_release_label_chunk(struct zserv *client) +static void zread_release_label_chunk(struct zserv *client, struct stream *msg) { struct stream *s; uint32_t start, end; /* Get input stream. */ - s = client->ibuf; + s = msg; /* Get data. */ STREAM_GETL(s, start); @@ -2284,7 +2186,7 @@ static void zread_label_manager_request(ZAPI_HANDLER_ARGS) /* this is a label manager */ else { if (hdr->command == ZEBRA_LABEL_MANAGER_CONNECT) - zread_label_manager_connect(client, zvrf_id(zvrf)); + zread_label_manager_connect(client, msg, zvrf_id(zvrf)); else { /* Sanity: don't allow 'unidentified' requests */ if (!client->proto) { @@ -2293,9 +2195,10 @@ static void zread_label_manager_request(ZAPI_HANDLER_ARGS) return; } if (hdr->command == ZEBRA_GET_LABEL_CHUNK) - zread_get_label_chunk(client, zvrf_id(zvrf)); + zread_get_label_chunk(client, msg, + zvrf_id(zvrf)); else if (hdr->command == ZEBRA_RELEASE_LABEL_CHUNK) - zread_release_label_chunk(client); + zread_release_label_chunk(client, msg); } } } @@ -2316,7 +2219,7 @@ static void zread_pseudowire(ZAPI_HANDLER_ARGS) struct zebra_pw *pw; /* Get input stream. */ - s = client->ibuf; + s = msg; /* Get data. */ STREAM_GET(ifname, s, IF_NAMESIZE); @@ -2413,116 +2316,11 @@ static void zebra_client_close_cleanup_rnh(struct zserv *client) } } -/* free zebra client information. */ -static void zebra_client_free(struct zserv *client) -{ - /* Send client de-registration to BFD */ - zebra_ptm_bfd_client_deregister(client->proto); - - /* Cleanup any registered nexthops - across all VRFs. */ - zebra_client_close_cleanup_rnh(client); - - /* Release Label Manager chunks */ - release_daemon_chunks(client->proto, client->instance); - - /* Cleanup any FECs registered by this client. */ - zebra_mpls_cleanup_fecs_for_client(vrf_info_lookup(VRF_DEFAULT), - client); - - /* Remove pseudowires associated with this client */ - zebra_pw_client_close(client); - - /* Close file descriptor. */ - if (client->sock) { - unsigned long nroutes; - - close(client->sock); - nroutes = rib_score_proto(client->proto, client->instance); - zlog_notice( - "client %d disconnected. %lu %s routes removed from the rib", - client->sock, nroutes, - zebra_route_string(client->proto)); - client->sock = -1; - } - - /* Free stream buffers. */ - if (client->ibuf) - stream_free(client->ibuf); - if (client->obuf) - stream_free(client->obuf); - if (client->wb) - buffer_free(client->wb); - - /* Release threads. */ - if (client->t_read) - thread_cancel(client->t_read); - if (client->t_write) - thread_cancel(client->t_write); - if (client->t_suicide) - thread_cancel(client->t_suicide); - - /* Free bitmaps. */ - for (afi_t afi = AFI_IP; afi < AFI_MAX; afi++) - for (int i = 0; i < ZEBRA_ROUTE_MAX; i++) - vrf_bitmap_free(client->redist[afi][i]); - - vrf_bitmap_free(client->redist_default); - vrf_bitmap_free(client->ifinfo); - vrf_bitmap_free(client->ridinfo); - - XFREE(MTYPE_TMP, client); -} - -static void zebra_client_close(struct zserv *client) -{ - listnode_delete(zebrad.client_list, client); - zebra_client_free(client); -} - -/* Make new client. */ -static void zebra_client_create(int sock) -{ - struct zserv *client; - int i; - afi_t afi; - - client = XCALLOC(MTYPE_TMP, sizeof(struct zserv)); - - /* Make client input/output buffer. */ - client->sock = sock; - client->ibuf = stream_new(ZEBRA_MAX_PACKET_SIZ); - client->obuf = stream_new(ZEBRA_MAX_PACKET_SIZ); - client->wb = buffer_new(0); - - /* Set table number. */ - client->rtm_table = zebrad.rtm_table_default; - - client->connect_time = monotime(NULL); - /* Initialize flags */ - for (afi = AFI_IP; afi < AFI_MAX; afi++) - for (i = 0; i < ZEBRA_ROUTE_MAX; i++) - client->redist[afi][i] = vrf_bitmap_init(); - client->redist_default = vrf_bitmap_init(); - client->ifinfo = vrf_bitmap_init(); - client->ridinfo = vrf_bitmap_init(); - - /* by default, it's not a synchronous client */ - client->is_synchronous = 0; - - /* Add this client to linked list. */ - listnode_add(zebrad.client_list, client); - - /* Make new read thread. */ - zebra_event(ZEBRA_READ, sock, client); - - zebra_vrf_update_all(client); -} - static void zread_interface_set_master(ZAPI_HANDLER_ARGS) { struct interface *master; struct interface *slave; - struct stream *s = client->ibuf; + struct stream *s = msg; int ifindex; vrf_id_t vrf_id; @@ -2553,7 +2351,7 @@ static void zread_vrf_label(ZAPI_HANDLER_ARGS) struct zebra_vrf *def_zvrf; enum lsp_types_t ltype; - s = client->ibuf; + s = msg; STREAM_GETL(s, nlabel); STREAM_GETC(s, afi); if (nlabel == zvrf->label[afi]) { @@ -2619,7 +2417,7 @@ static inline void zread_rule(ZAPI_HANDLER_ARGS) uint32_t total, i; ifindex_t ifindex; - s = client->ibuf; + s = msg; STREAM_GETL(s, total); for (i = 0; i < total; i++) { @@ -2670,23 +2468,6 @@ stream_failure: return; } -/* - * Reads header from zmsg stream. - * - * Note this advances the stream getp by the size of the header. - */ -static bool zserv_read_header(struct stream *msg, struct zmsghdr *hdr) -{ - STREAM_GETW(msg, hdr->length); - STREAM_GETC(msg, hdr->marker); - STREAM_GETC(msg, hdr->version); - STREAM_GETL(msg, hdr->vrf_id); - STREAM_GETW(msg, hdr->command); - return true; -stream_failure: - return false; -} - void (*zserv_handlers[])(ZAPI_HANDLER_ARGS) = { [ZEBRA_ROUTER_ID_ADD] = zread_router_id_add, [ZEBRA_ROUTER_ID_DELETE] = zread_router_id_delete, @@ -2705,10 +2486,10 @@ void (*zserv_handlers[])(ZAPI_HANDLER_ARGS) = { [ZEBRA_REDISTRIBUTE_DEFAULT_DELETE] = zebra_redistribute_default_delete, [ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB] = zread_ipv4_nexthop_lookup_mrib, [ZEBRA_HELLO] = zread_hello, - [ZEBRA_NEXTHOP_REGISTER] = zserv_rnh_register, - [ZEBRA_NEXTHOP_UNREGISTER] = zserv_rnh_unregister, - [ZEBRA_IMPORT_ROUTE_REGISTER] = zserv_rnh_register, - [ZEBRA_IMPORT_ROUTE_UNREGISTER] = zserv_rnh_unregister, + [ZEBRA_NEXTHOP_REGISTER] = zread_rnh_register, + [ZEBRA_NEXTHOP_UNREGISTER] = zread_rnh_unregister, + [ZEBRA_IMPORT_ROUTE_REGISTER] = zread_rnh_register, + [ZEBRA_IMPORT_ROUTE_UNREGISTER] = zread_rnh_unregister, [ZEBRA_BFD_DEST_UPDATE] = zebra_ptm_bfd_dst_register, [ZEBRA_BFD_DEST_REGISTER] = zebra_ptm_bfd_dst_register, [ZEBRA_BFD_DEST_DEREGISTER] = zebra_ptm_bfd_dst_deregister, @@ -2728,8 +2509,8 @@ void (*zserv_handlers[])(ZAPI_HANDLER_ARGS) = { [ZEBRA_LABEL_MANAGER_CONNECT] = zread_label_manager_request, [ZEBRA_GET_LABEL_CHUNK] = zread_label_manager_request, [ZEBRA_RELEASE_LABEL_CHUNK] = zread_label_manager_request, - [ZEBRA_FEC_REGISTER] = zserv_fec_register, - [ZEBRA_FEC_UNREGISTER] = zserv_fec_unregister, + [ZEBRA_FEC_REGISTER] = zread_fec_register, + [ZEBRA_FEC_UNREGISTER] = zread_fec_unregister, [ZEBRA_ADVERTISE_DEFAULT_GW] = zebra_vxlan_advertise_gw_macip, [ZEBRA_ADVERTISE_SUBNET] = zebra_vxlan_advertise_subnet, [ZEBRA_ADVERTISE_ALL_VNI] = zebra_vxlan_advertise_all_vni, @@ -2746,19 +2527,255 @@ void (*zserv_handlers[])(ZAPI_HANDLER_ARGS) = { [ZEBRA_RULE_DELETE] = zread_rule, }; -static inline void zserv_handle_commands(struct zserv *client, uint16_t command, - uint16_t length, +static inline void zserv_handle_commands(struct zserv *client, + struct zmsghdr *hdr, + struct stream *msg, struct zebra_vrf *zvrf) { - struct zmsghdr hdr; - - stream_set_getp(client->ibuf, 0); - zserv_read_header(client->ibuf, &hdr); - if (hdr.command > sizeof(zserv_handlers) - || zserv_handlers[hdr.command] == NULL) - zlog_info("Zebra received unknown command %d", hdr.command); + if (hdr->command > sizeof(zserv_handlers) + || zserv_handlers[hdr->command] == NULL) + zlog_info("Zebra received unknown command %d", hdr->command); else - zserv_handlers[hdr.command](client, &hdr, zvrf); + zserv_handlers[hdr->command](client, hdr, msg, zvrf); + + stream_free(msg); +} + +/* Lifecycle ---------------------------------------------------------------- */ + +/* free zebra client information. */ +static void zebra_client_free(struct zserv *client) +{ + /* Send client de-registration to BFD */ + zebra_ptm_bfd_client_deregister(client->proto); + + /* Cleanup any registered nexthops - across all VRFs. */ + zebra_client_close_cleanup_rnh(client); + + /* Release Label Manager chunks */ + release_daemon_chunks(client->proto, client->instance); + + /* Cleanup any FECs registered by this client. */ + zebra_mpls_cleanup_fecs_for_client(vrf_info_lookup(VRF_DEFAULT), + client); + + /* Remove pseudowires associated with this client */ + zebra_pw_client_close(client); + + /* Close file descriptor. */ + if (client->sock) { + unsigned long nroutes; + + close(client->sock); + nroutes = rib_score_proto(client->proto, client->instance); + zlog_notice( + "client %d disconnected. %lu %s routes removed from the rib", + client->sock, nroutes, + zebra_route_string(client->proto)); + client->sock = -1; + } + + /* Free stream buffers. */ + if (client->ibuf_work) + stream_free(client->ibuf_work); + if (client->obuf_work) + stream_free(client->obuf_work); + if (client->ibuf_fifo) + stream_fifo_free(client->ibuf_fifo); + if (client->obuf_fifo) + stream_fifo_free(client->obuf_fifo); + if (client->wb) + buffer_free(client->wb); + + /* Release threads. */ + if (client->t_read) + thread_cancel(client->t_read); + if (client->t_write) + thread_cancel(client->t_write); + if (client->t_suicide) + thread_cancel(client->t_suicide); + + /* Free bitmaps. */ + for (afi_t afi = AFI_IP; afi < AFI_MAX; afi++) + for (int i = 0; i < ZEBRA_ROUTE_MAX; i++) + vrf_bitmap_free(client->redist[afi][i]); + + vrf_bitmap_free(client->redist_default); + vrf_bitmap_free(client->ifinfo); + vrf_bitmap_free(client->ridinfo); + + XFREE(MTYPE_TMP, client); +} + +/* + * Called from client thread to terminate itself. + */ +static void zebra_client_close(struct zserv *client) +{ + listnode_delete(zebrad.client_list, client); + zebra_client_free(client); +} + +/* Make new client. */ +static void zebra_client_create(int sock) +{ + struct zserv *client; + int i; + afi_t afi; + + client = XCALLOC(MTYPE_TMP, sizeof(struct zserv)); + + /* Make client input/output buffer. */ + client->sock = sock; + client->ibuf_fifo = stream_fifo_new(); + client->obuf_fifo = stream_fifo_new(); + client->ibuf_work = stream_new(ZEBRA_MAX_PACKET_SIZ); + client->obuf_work = stream_new(ZEBRA_MAX_PACKET_SIZ); + client->wb = buffer_new(0); + + /* Set table number. */ + client->rtm_table = zebrad.rtm_table_default; + + client->connect_time = monotime(NULL); + /* Initialize flags */ + for (afi = AFI_IP; afi < AFI_MAX; afi++) + for (i = 0; i < ZEBRA_ROUTE_MAX; i++) + client->redist[afi][i] = vrf_bitmap_init(); + client->redist_default = vrf_bitmap_init(); + client->ifinfo = vrf_bitmap_init(); + client->ridinfo = vrf_bitmap_init(); + + /* by default, it's not a synchronous client */ + client->is_synchronous = 0; + + /* Add this client to linked list. */ + listnode_add(zebrad.client_list, client); + + zebra_vrf_update_all(client); + + /* start read loop */ + zebra_event(client, ZEBRA_READ); +} + +static int zserv_delayed_close(struct thread *thread) +{ + struct zserv *client = THREAD_ARG(thread); + + client->t_suicide = NULL; + zebra_client_close(client); + return 0; +} + +/* + * Log zapi message to zlog. + * + * errmsg (optional) + * Debugging message + * + * msg + * The message + * + * hdr (optional) + * The message header + */ +static void zserv_log_message(const char *errmsg, struct stream *msg, + struct zmsghdr *hdr) +{ + zlog_debug("Rx'd ZAPI message"); + if (errmsg) + zlog_debug("%s", errmsg); + if (hdr) { + zlog_debug(" Length: %d", hdr->length); + zlog_debug("Command: %s", zserv_command_string(hdr->command)); + zlog_debug(" VRF: %u", hdr->vrf_id); + } + zlog_hexdump(msg->data, STREAM_READABLE(msg)); +} + +static int zserv_flush_data(struct thread *thread) +{ + struct zserv *client = THREAD_ARG(thread); + + client->t_write = NULL; + if (client->t_suicide) { + zebra_client_close(client); + return -1; + } + switch (buffer_flush_available(client->wb, client->sock)) { + case BUFFER_ERROR: + zlog_warn( + "%s: buffer_flush_available failed on zserv client fd %d, closing", + __func__, client->sock); + zebra_client_close(client); + client = NULL; + break; + case BUFFER_PENDING: + client->t_write = NULL; + thread_add_write(zebrad.master, zserv_flush_data, client, + client->sock, &client->t_write); + break; + case BUFFER_EMPTY: + break; + } + + if (client) + client->last_write_time = monotime(NULL); + return 0; +} + +/* + * Write a single packet. + */ +static int zserv_write(struct thread *thread) +{ + struct zserv *client = THREAD_ARG(thread); + struct stream *msg; + int writerv; + + if (client->t_suicide) + return -1; + + if (client->is_synchronous) + return 0; + + msg = stream_fifo_pop(client->obuf_fifo); + stream_set_getp(msg, 0); + client->last_write_cmd = stream_getw_from(msg, 6); + + writerv = buffer_write(client->wb, client->sock, STREAM_DATA(msg), + stream_get_endp(msg)); + + stream_free(msg); + + switch (writerv) { + case BUFFER_ERROR: + zlog_warn( + "%s: buffer_write failed to zserv client fd %d, closing", + __func__, client->sock); + /* + * Schedule a delayed close since many of the functions that + * call this one do not check the return code. They do not + * allow for the possibility that an I/O error may have caused + * the client to be deleted. + */ + client->t_suicide = NULL; + thread_add_event(zebrad.master, zserv_delayed_close, client, 0, + &client->t_suicide); + return -1; + case BUFFER_EMPTY: + THREAD_OFF(client->t_write); + break; + case BUFFER_PENDING: + thread_add_write(zebrad.master, zserv_flush_data, client, + client->sock, &client->t_write); + break; + } + + if (client->obuf_fifo->count) + zebra_event(client, ZEBRA_WRITE); + + client->last_write_time = monotime(NULL); + return 0; } #if defined(HANDLE_ZAPI_FUZZING) @@ -2781,26 +2798,66 @@ static void zserv_write_incoming(struct stream *orig, uint16_t command) } #endif +static int zserv_process_messages(struct thread *thread) +{ + struct zserv *client = THREAD_ARG(thread); + struct zebra_vrf *zvrf; + struct zmsghdr hdr; + struct stream *msg; + bool hdrvalid; + + do { + msg = stream_fifo_pop(client->ibuf_fifo); + + /* break if out of messages */ + if (!msg) + continue; + + /* read & check header */ + hdrvalid = zapi_parse_header(msg, &hdr); + if (!hdrvalid && IS_ZEBRA_DEBUG_PACKET && IS_ZEBRA_DEBUG_RECV) { + const char *emsg = "Message has corrupt header"; + zserv_log_message(emsg, msg, NULL); + } + if (!hdrvalid) + continue; + + /* lookup vrf */ + zvrf = zebra_vrf_lookup_by_id(hdr.vrf_id); + if (!zvrf && IS_ZEBRA_DEBUG_PACKET && IS_ZEBRA_DEBUG_RECV) { + const char *emsg = "Message specifies unknown VRF"; + zserv_log_message(emsg, msg, &hdr); + } + if (!zvrf) + continue; + + /* process commands */ + zserv_handle_commands(client, &hdr, msg, zvrf); + + } while (msg); + + return 0; +} + /* Handler of zebra service request. */ -static int zebra_client_read(struct thread *thread) +static int zserv_read(struct thread *thread) { int sock; struct zserv *client; size_t already; - uint16_t length, command; - uint8_t marker, version; - vrf_id_t vrf_id; - struct zebra_vrf *zvrf; #if defined(HANDLE_ZAPI_FUZZING) int packets = 1; #else int packets = zebrad.packets_to_process; #endif + struct zmsghdr hdr; + ssize_t nb; + bool hdrvalid; + char errmsg[256]; /* Get thread data. Reset reading thread because I'm running. */ sock = THREAD_FD(thread); client = THREAD_ARG(thread); - client->t_read = NULL; if (client->t_suicide) { zebra_client_close(client); @@ -2808,88 +2865,84 @@ static int zebra_client_read(struct thread *thread) } while (packets) { + already = stream_get_endp(client->ibuf_work); + /* Read length and command (if we don't have it already). */ - if ((already = stream_get_endp(client->ibuf)) - < ZEBRA_HEADER_SIZE) { - ssize_t nbyte; - if (((nbyte = stream_read_try(client->ibuf, sock, - ZEBRA_HEADER_SIZE - - already)) - == 0) - || (nbyte == -1)) { - if (IS_ZEBRA_DEBUG_EVENT) - zlog_debug( - "connection closed socket [%d]", - sock); - zebra_client_close(client); - return -1; - } - if (nbyte != (ssize_t)(ZEBRA_HEADER_SIZE - already)) { + if (already < ZEBRA_HEADER_SIZE) { + nb = stream_read_try(client->ibuf_work, sock, + ZEBRA_HEADER_SIZE - already); + if ((nb == 0 || nb == -1) && IS_ZEBRA_DEBUG_EVENT) + zlog_debug("connection closed socket [%d]", + sock); + if ((nb == 0 || nb == -1)) + goto zread_fail; + if (nb != (ssize_t)(ZEBRA_HEADER_SIZE - already)) { /* Try again later. */ - zebra_event(ZEBRA_READ, sock, client); - return 0; + break; } already = ZEBRA_HEADER_SIZE; } /* Reset to read from the beginning of the incoming packet. */ - stream_set_getp(client->ibuf, 0); + stream_set_getp(client->ibuf_work, 0); /* Fetch header values */ - STREAM_GETW(client->ibuf, length); - STREAM_GETC(client->ibuf, marker); - STREAM_GETC(client->ibuf, version); - STREAM_GETL(client->ibuf, vrf_id); - STREAM_GETW(client->ibuf, command); + hdrvalid = zapi_parse_header(client->ibuf_work, &hdr); - if (marker != ZEBRA_HEADER_MARKER || version != ZSERV_VERSION) { - zlog_err( - "%s: socket %d version mismatch, marker %d, version %d", - __func__, sock, marker, version); - zebra_client_close(client); - return -1; + if (!hdrvalid) { + snprintf(errmsg, sizeof(errmsg), + "%s: Message has corrupt header", __func__); + zserv_log_message(errmsg, client->ibuf_work, NULL); + goto zread_fail; } - if (length < ZEBRA_HEADER_SIZE) { - zlog_warn( - "%s: socket %d message length %u is less than header size %d", - __func__, sock, length, ZEBRA_HEADER_SIZE); - zebra_client_close(client); - return -1; + + /* Validate header */ + if (hdr.marker != ZEBRA_HEADER_MARKER + || hdr.version != ZSERV_VERSION) { + snprintf( + errmsg, sizeof(errmsg), + "Message has corrupt header\n%s: socket %d version mismatch, marker %d, version %d", + __func__, sock, hdr.marker, hdr.version); + zserv_log_message(errmsg, client->ibuf_work, &hdr); + goto zread_fail; } - if (length > STREAM_SIZE(client->ibuf)) { - zlog_warn( - "%s: socket %d message length %u exceeds buffer size %lu", - __func__, sock, length, - (u_long)STREAM_SIZE(client->ibuf)); - zebra_client_close(client); - return -1; + if (hdr.length < ZEBRA_HEADER_SIZE) { + snprintf( + errmsg, sizeof(errmsg), + "Message has corrupt header\n%s: socket %d message length %u is less than header size %d", + __func__, sock, hdr.length, ZEBRA_HEADER_SIZE); + zserv_log_message(errmsg, client->ibuf_work, &hdr); + goto zread_fail; + } + if (hdr.length > STREAM_SIZE(client->ibuf_work)) { + snprintf( + errmsg, sizeof(errmsg), + "Message has corrupt header\n%s: socket %d message length %u exceeds buffer size %lu", + __func__, sock, hdr.length, + (unsigned long)STREAM_SIZE(client->ibuf_work)); + goto zread_fail; } /* Read rest of data. */ - if (already < length) { - ssize_t nbyte; - if (((nbyte = stream_read_try(client->ibuf, sock, - length - already)) - == 0) - || (nbyte == -1)) { - if (IS_ZEBRA_DEBUG_EVENT) - zlog_debug( - "connection closed [%d] when reading zebra data", - sock); - zebra_client_close(client); - return -1; - } - if (nbyte != (ssize_t)(length - already)) { + if (already < hdr.length) { + nb = stream_read_try(client->ibuf_work, sock, + hdr.length - already); + if ((nb == 0 || nb == -1) && IS_ZEBRA_DEBUG_EVENT) + zlog_debug( + "connection closed [%d] when reading zebra data", + sock); + if ((nb == 0 || nb == -1)) + goto zread_fail; + if (nb != (ssize_t)(hdr.length - already)) { /* Try again later. */ - zebra_event(ZEBRA_READ, sock, client); - return 0; + break; } } #if defined(HANDLE_ZAPI_FUZZING) - zserv_write_incoming(client->ibuf, command); + zserv_write_incoming(client->ibuf_work, command); #endif - length -= ZEBRA_HEADER_SIZE; + hdr.length -= ZEBRA_HEADER_SIZE; /* Debug packet information. */ if (IS_ZEBRA_DEBUG_EVENT) @@ -2897,41 +2950,54 @@ static int zebra_client_read(struct thread *thread) sock); if (IS_ZEBRA_DEBUG_PACKET && IS_ZEBRA_DEBUG_RECV) - zlog_debug("zebra message received [%s] %d in VRF %u", - zserv_command_string(command), length, - vrf_id); + zserv_log_message(NULL, client->ibuf_work, &hdr); client->last_read_time = monotime(NULL); - client->last_read_cmd = command; + client->last_read_cmd = hdr.command; - zvrf = zebra_vrf_lookup_by_id(vrf_id); - if (!zvrf) { - if (IS_ZEBRA_DEBUG_PACKET && IS_ZEBRA_DEBUG_RECV) - zlog_debug("zebra received unknown VRF[%u]", - vrf_id); - goto zclient_read_out; - } + stream_set_getp(client->ibuf_work, 0); + struct stream *msg = stream_dup(client->ibuf_work); - zserv_handle_commands(client, command, length, zvrf); + stream_fifo_push(client->ibuf_fifo, msg); - if (client->t_suicide) { - /* No need to wait for thread callback, just kill - * immediately. - */ - zebra_client_close(client); - return -1; - } - packets -= 1; - stream_reset(client->ibuf); + if (client->t_suicide) + goto zread_fail; + + --packets; + stream_reset(client->ibuf_work); } -stream_failure: -zclient_read_out: - stream_reset(client->ibuf); - zebra_event(ZEBRA_READ, sock, client); + if (IS_ZEBRA_DEBUG_PACKET) + zlog_debug("Read %d packets", + zebrad.packets_to_process - packets); + + /* Schedule job to process those packets */ + thread_add_event(zebrad.master, &zserv_process_messages, client, 0, + NULL); + + /* Reschedule ourselves */ + zebra_event(client, ZEBRA_READ); + return 0; + +zread_fail: + zebra_client_close(client); + return -1; } +static void zebra_event(struct zserv *client, enum event event) +{ + switch (event) { + case ZEBRA_READ: + thread_add_read(zebrad.master, zserv_read, client, client->sock, + &client->t_read); + break; + case ZEBRA_WRITE: + thread_add_write(zebrad.master, zserv_write, client, + client->sock, &client->t_write); + break; + } +} /* Accept code of zebra server socket. */ static int zebra_accept(struct thread *thread) @@ -2944,7 +3010,7 @@ static int zebra_accept(struct thread *thread) accept_sock = THREAD_FD(thread); /* Reregister myself. */ - zebra_event(ZEBRA_SERV, accept_sock, NULL); + thread_add_read(zebrad.master, zebra_accept, NULL, accept_sock, NULL); len = sizeof(struct sockaddr_in); client_sock = accept(accept_sock, (struct sockaddr *)&client, &len); @@ -3031,26 +3097,7 @@ void zebra_zserv_socket_init(char *path) umask(old_mask); - zebra_event(ZEBRA_SERV, sock, NULL); -} - - -static void zebra_event(enum event event, int sock, struct zserv *client) -{ - switch (event) { - case ZEBRA_SERV: - thread_add_read(zebrad.master, zebra_accept, client, sock, - NULL); - break; - case ZEBRA_READ: - client->t_read = NULL; - thread_add_read(zebrad.master, zebra_client_read, client, sock, - &client->t_read); - break; - case ZEBRA_WRITE: - /**/ - break; - } + thread_add_read(zebrad.master, zebra_accept, NULL, sock, NULL); } #define ZEBRA_TIME_BUF 32 diff --git a/zebra/zserv.h b/zebra/zserv.h index 74ff31bcf9..a055a28c01 100644 --- a/zebra/zserv.h +++ b/zebra/zserv.h @@ -47,8 +47,12 @@ struct zserv { int sock; /* Input/output buffer to the client. */ - struct stream *ibuf; - struct stream *obuf; + struct stream_fifo *ibuf_fifo; + struct stream_fifo *obuf_fifo; + + /* Private I/O buffers */ + struct stream *ibuf_work; + struct stream *obuf_work; /* Buffer of data waiting to be written to client. */ struct buffer *wb; @@ -129,7 +133,7 @@ struct zserv { int last_write_cmd; }; -/* ZAPI protocol message header */ +/* ZAPI protocol structs */ struct zmsghdr { uint16_t length; uint8_t marker; @@ -139,7 +143,8 @@ struct zmsghdr { }; #define ZAPI_HANDLER_ARGS \ - struct zserv *client, struct zmsghdr *hdr, struct zebra_vrf *zvrf + struct zserv *client, struct zmsghdr *hdr, struct stream *msg, \ + struct zebra_vrf *zvrf /* Zebra instance */ struct zebra_t { @@ -197,7 +202,7 @@ extern void zsend_rule_notify_owner(struct zebra_pbr_rule *rule, extern void zserv_nexthop_num_warn(const char *, const struct prefix *, const unsigned int); -extern int zebra_server_send_message(struct zserv *client); +extern int zebra_server_send_message(struct zserv *client, struct stream *msg); extern struct zserv *zebra_find_client(u_char proto, u_short instance); From 124ead27dbd7e61e79a334533adc702fdf172ddb Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Mar 2018 11:23:58 -0500 Subject: [PATCH 128/148] lib, zebra: use existing zapi header struct Nobody uses it, but it's got the same definition. Move the parser function into zclient.c and use it. Signed-off-by: Quentin Young --- lib/zclient.c | 12 +++++++++ lib/zclient.h | 66 ++++++++++++++++++++++++++++++++++++++------- zebra/zebra_vxlan.c | 2 +- zebra/zserv.h | 9 ------- 4 files changed, 70 insertions(+), 19 deletions(-) diff --git a/lib/zclient.c b/lib/zclient.c index fa3a5f6691..20aaaca161 100644 --- a/lib/zclient.c +++ b/lib/zclient.c @@ -322,6 +322,18 @@ stream_failure: return 0; } +bool zapi_parse_header(struct stream *zmsg, struct zmsghdr *hdr) +{ + STREAM_GETW(zmsg, hdr->length); + STREAM_GETC(zmsg, hdr->marker); + STREAM_GETC(zmsg, hdr->version); + STREAM_GETC(zmsg, hdr->vrf_id); + STREAM_GETW(zmsg, hdr->command); + return true; +stream_failure: + return false; +} + /* Send simple Zebra message. */ static int zebra_message_send(struct zclient *zclient, int command, vrf_id_t vrf_id) diff --git a/lib/zclient.h b/lib/zclient.h index 1aa94b641c..c8574946d0 100644 --- a/lib/zclient.h +++ b/lib/zclient.h @@ -237,14 +237,14 @@ struct zclient { */ #define ZAPI_MESSAGE_TABLEID 0x80 -/* Zserv protocol message header */ -struct zserv_header { - uint16_t length; - uint8_t marker; /* corresponds to command field in old zserv - * always set to 255 in new zserv. - */ - uint8_t version; #define ZSERV_VERSION 5 +/* Zserv protocol message header */ +struct zmsghdr { + uint16_t length; + /* corresponds to command field in old zserv + * always set to 255 in new zserv. */ + uint8_t marker; + uint8_t version; vrf_id_t vrf_id; uint16_t command; }; @@ -449,9 +449,58 @@ extern int zclient_send_message(struct zclient *); /* create header for command, length to be filled in by user later */ extern void zclient_create_header(struct stream *, uint16_t, vrf_id_t); +/* + * Read sizeof(struct zmsghdr) bytes from the provided socket and parse the + * received data into the specified fields. If this is successful, read the + * rest of the packet into the provided stream. + * + * s + * The stream to read into + * + * sock + * The socket to read from + * + * size + * Parsed message size will be placed in the pointed-at integer + * + * marker + * Parsed marker will be placed in the pointed-at byte + * + * version + * Parsed version will be placed in the pointed-at byte + * + * vrf_id + * Parsed VRF ID will be placed in the pointed-at vrf_id_t + * + * cmd + * Parsed command number will be placed in the pointed-at integer + * + * Returns: + * -1 if: + * - insufficient data for header was read + * - a version mismatch was detected + * - a marker mismatch was detected + * - header size field specified more data than could be read + */ extern int zclient_read_header(struct stream *s, int sock, u_int16_t *size, u_char *marker, u_char *version, vrf_id_t *vrf_id, u_int16_t *cmd); +/* + * Parse header from ZAPI message stream into struct zmsghdr. + * This function assumes the stream getp points at the first byte of the header. + * If the function is successful then the stream getp will point to the byte + * immediately after the last byte of the header. + * + * zmsg + * The stream containing the header + * + * hdr + * The header struct to parse into. + * + * Returns: + * true if parsing succeeded, false otherwise + */ +extern bool zapi_parse_header(struct stream *zmsg, struct zmsghdr *hdr); extern void zclient_interface_set_master(struct zclient *client, struct interface *master, @@ -469,8 +518,7 @@ extern void zebra_interface_if_set_value(struct stream *, struct interface *); extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid); #if CONFDATE > 20180823 -CPP_NOTICE( - "zapi_ipv4_route, zapi_ipv6_route, zapi_ipv4_route_ipv6_nexthop as well as the zapi_ipv4 and zapi_ipv6 data structures should be removed now"); +CPP_NOTICE("zapi_ipv4_route, zapi_ipv6_route, zapi_ipv4_route_ipv6_nexthop as well as the zapi_ipv4 and zapi_ipv6 data structures should be removed now"); #endif extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *, diff --git a/zebra/zebra_vxlan.c b/zebra/zebra_vxlan.c index a8d1848723..256fa9e4b7 100644 --- a/zebra/zebra_vxlan.c +++ b/zebra/zebra_vxlan.c @@ -6612,7 +6612,7 @@ void zebra_vxlan_advertise_gw_macip(ZAPI_HANDLER_ARGS) zvni = zvni_lookup(vni); if (!zvni) - return 0; + return; if (IS_ZEBRA_DEBUG_VXLAN) zlog_debug( diff --git a/zebra/zserv.h b/zebra/zserv.h index a055a28c01..62707510c2 100644 --- a/zebra/zserv.h +++ b/zebra/zserv.h @@ -133,15 +133,6 @@ struct zserv { int last_write_cmd; }; -/* ZAPI protocol structs */ -struct zmsghdr { - uint16_t length; - uint8_t marker; - uint8_t version; - uint32_t vrf_id; - uint16_t command; -}; - #define ZAPI_HANDLER_ARGS \ struct zserv *client, struct zmsghdr *hdr, struct stream *msg, \ struct zebra_vrf *zvrf From 5530922ef7408fe8275a75675094c7c453186a2b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 7 Mar 2018 12:30:51 -0500 Subject: [PATCH 129/148] lib: zclient.h style fixes Signed-off-by: Quentin Young --- lib/zclient.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/zclient.h b/lib/zclient.h index c8574946d0..dd9c8973fa 100644 --- a/lib/zclient.h +++ b/lib/zclient.h @@ -241,8 +241,7 @@ struct zclient { /* Zserv protocol message header */ struct zmsghdr { uint16_t length; - /* corresponds to command field in old zserv - * always set to 255 in new zserv. */ + /* Always set to 255 in new zserv */ uint8_t marker; uint8_t version; vrf_id_t vrf_id; @@ -380,9 +379,11 @@ struct zclient_options { /* Prototypes of zebra client service functions. */ extern struct zclient *zclient_new(struct thread_master *); +/* clang-format off */ #if CONFDATE > 20181101 CPP_NOTICE("zclient_new_notify can take over or zclient_new now"); #endif +/* clang-format on */ extern struct zclient_options zclient_options_default; @@ -517,9 +518,11 @@ extern struct interface *zebra_interface_vrf_update_read(struct stream *s, extern void zebra_interface_if_set_value(struct stream *, struct interface *); extern void zebra_router_id_update_read(struct stream *s, struct prefix *rid); +/* clang-format off */ #if CONFDATE > 20180823 CPP_NOTICE("zapi_ipv4_route, zapi_ipv6_route, zapi_ipv4_route_ipv6_nexthop as well as the zapi_ipv4 and zapi_ipv6 data structures should be removed now"); #endif +/* clang-format on */ extern int zapi_ipv4_route(u_char, struct zclient *, struct prefix_ipv4 *, struct zapi_ipv4 *) __attribute__((deprecated)); From 107afcd10b59be3441e2b1f358942ca5e760daa2 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 15:59:39 -0500 Subject: [PATCH 130/148] lib, zebra: clean up zapi nits * Get correct data size when parsing VRF ids * Move some vars into smaller scope Signed-off-by: Quentin Young --- lib/zclient.c | 2 +- zebra/zserv.c | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/zclient.c b/lib/zclient.c index 20aaaca161..c720e2519b 100644 --- a/lib/zclient.c +++ b/lib/zclient.c @@ -327,7 +327,7 @@ bool zapi_parse_header(struct stream *zmsg, struct zmsghdr *hdr) STREAM_GETW(zmsg, hdr->length); STREAM_GETC(zmsg, hdr->marker); STREAM_GETC(zmsg, hdr->version); - STREAM_GETC(zmsg, hdr->vrf_id); + STREAM_GETL(zmsg, hdr->vrf_id); STREAM_GETW(zmsg, hdr->command); return true; stream_failure: diff --git a/zebra/zserv.c b/zebra/zserv.c index ac2fe9c0e2..4cdb97be42 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -2850,11 +2850,6 @@ static int zserv_read(struct thread *thread) #else int packets = zebrad.packets_to_process; #endif - struct zmsghdr hdr; - ssize_t nb; - bool hdrvalid; - char errmsg[256]; - /* Get thread data. Reset reading thread because I'm running. */ sock = THREAD_FD(thread); client = THREAD_ARG(thread); @@ -2865,6 +2860,11 @@ static int zserv_read(struct thread *thread) } while (packets) { + struct zmsghdr hdr; + ssize_t nb; + bool hdrvalid; + char errmsg[256]; + already = stream_get_endp(client->ibuf_work); /* Read length and command (if we don't have it already). */ From 41903a407407bcdf73dbd471dea3f53d2d056b0b Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 9 Mar 2018 17:40:16 -0500 Subject: [PATCH 131/148] lib, zebra: slight cleanup after rebase Rebased zapi-cleanup, needs a bit of poking. Signed-off-by: Quentin Young --- lib/zclient.h | 2 +- zebra/zserv.c | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/lib/zclient.h b/lib/zclient.h index dd9c8973fa..8033488444 100644 --- a/lib/zclient.h +++ b/lib/zclient.h @@ -237,7 +237,7 @@ struct zclient { */ #define ZAPI_MESSAGE_TABLEID 0x80 -#define ZSERV_VERSION 5 +#define ZSERV_VERSION 5 /* Zserv protocol message header */ struct zmsghdr { uint16_t length; diff --git a/zebra/zserv.c b/zebra/zserv.c index 4cdb97be42..f53baf65d0 100644 --- a/zebra/zserv.c +++ b/zebra/zserv.c @@ -636,7 +636,7 @@ static int zsend_ipv4_nexthop_lookup_mrib(struct zserv *client, * chain of nexthops. */ for (nexthop = re->ng.nexthop; nexthop; nexthop = nexthop->next) if (CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_ACTIVE)) - num += zsend_write_nexthop(s, nexthop); + num += zserv_encode_nexthop(s, nexthop); stream_putc_at(s, nump, num); /* store nexthop_num */ } else { @@ -706,8 +706,8 @@ void zsend_rule_notify_owner(struct zebra_pbr_rule *rule, struct stream *s; if (IS_ZEBRA_DEBUG_PACKET) { - zlog_debug("%s: Notifying %u", - __PRETTY_FUNCTION__, rule->unique); + zlog_debug("%s: Notifying %u", __PRETTY_FUNCTION__, + rule->unique); } for (ALL_LIST_ELEMENTS_RO(zebrad.client_list, node, client)) { @@ -1091,7 +1091,6 @@ stream_failure: } - /* * Register zebra server interface information. * Send current all interface and address information. From e049c5fcce862e994fc1b79baf8671c0aa25894e Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 12 Mar 2018 14:01:47 -0400 Subject: [PATCH 132/148] lib: fixup zlog_hexdump * Allocate correct amount of memory * Use snprintf() instead of sprintf() Signed-off-by: Quentin Young --- lib/log.c | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/lib/log.c b/lib/log.c index 9e33ef9102..2d856cc777 100644 --- a/lib/log.c +++ b/lib/log.c @@ -1092,41 +1092,50 @@ void zlog_hexdump(const void *mem, unsigned int len) unsigned long i = 0; unsigned int j = 0; unsigned int columns = 8; - char buf[(len * 4) + ((len / 4) * 20) + 30]; + /* 19 bytes for 0xADDRESS: */ + /* 24 bytes for data; 2 chars plus a space per data byte */ + /* 1 byte for space */ + /* 8 bytes for ASCII representation */ + /* 1 byte for a newline */ + /* ===================== */ + /* 53 bytes per 8 bytes of data */ + /* 1 byte for null term */ + size_t bs = ((len / 8) + 1) * 53 + 1; + char buf[bs]; char *s = buf; + memset(buf, 0, sizeof(buf)); + for (i = 0; i < len + ((len % columns) ? (columns - len % columns) : 0); i++) { /* print offset */ if (i % columns == 0) - s += sprintf(s, "0x%016lx: ", (unsigned long)mem + i); + s += snprintf(s, bs - (s - buf), + "0x%016lx: ", (unsigned long)mem + i); /* print hex data */ if (i < len) - s += sprintf(s, "%02x ", 0xFF & ((const char *)mem)[i]); + s += snprintf(s, bs - (s - buf), "%02x ", + 0xFF & ((const char *)mem)[i]); /* end of block, just aligning for ASCII dump */ else - s += sprintf(s, " "); + s += snprintf(s, bs - (s - buf), " "); /* print ASCII dump */ if (i % columns == (columns - 1)) { for (j = i - (columns - 1); j <= i; j++) { - if (j >= len) /* end of block, not really - printing */ - s += sprintf(s, " "); - - else if (isprint((int)((const char *)mem) - [j])) /* printable char - */ - s += sprintf( - s, "%c", + /* end of block not really printing */ + if (j >= len) + s += snprintf(s, bs - (s - buf), " "); + else if (isprint((int)((const char *)mem)[j])) + s += snprintf( + s, bs - (s - buf), "%c", 0xFF & ((const char *)mem)[j]); - else /* other char */ - s += sprintf(s, "."); + s += snprintf(s, bs - (s - buf), "."); } - s += sprintf(s, "\n"); + s += snprintf(s, bs - (s - buf), "\n"); } } zlog_debug("\n%s", buf); From abccc77544f973ad896d31f356ee6fc6df3e2614 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Mon, 12 Mar 2018 14:04:56 -0400 Subject: [PATCH 133/148] tests: add unit test for zlog Just tests zlog_hexdump right now Signed-off-by: Quentin Young --- lib/log.c | 18 +++++++------ tests/Makefile.am | 6 ++++- tests/lib/test_zlog.c | 61 ++++++++++++++++++++++++++++++++++++++++++ tests/lib/test_zlog.py | 4 +++ 4 files changed, 80 insertions(+), 9 deletions(-) create mode 100644 tests/lib/test_zlog.c create mode 100644 tests/lib/test_zlog.py diff --git a/lib/log.c b/lib/log.c index 2d856cc777..74e7be7c7d 100644 --- a/lib/log.c +++ b/lib/log.c @@ -1092,14 +1092,16 @@ void zlog_hexdump(const void *mem, unsigned int len) unsigned long i = 0; unsigned int j = 0; unsigned int columns = 8; - /* 19 bytes for 0xADDRESS: */ - /* 24 bytes for data; 2 chars plus a space per data byte */ - /* 1 byte for space */ - /* 8 bytes for ASCII representation */ - /* 1 byte for a newline */ - /* ===================== */ - /* 53 bytes per 8 bytes of data */ - /* 1 byte for null term */ + /* + * 19 bytes for 0xADDRESS: + * 24 bytes for data; 2 chars plus a space per data byte + * 1 byte for space + * 8 bytes for ASCII representation + * 1 byte for a newline + * ===================== + * 53 bytes per 8 bytes of data + * 1 byte for null term + */ size_t bs = ((len / 8) + 1) * 53 + 1; char buf[bs]; char *s = buf; diff --git a/tests/Makefile.am b/tests/Makefile.am index f4ab2a126a..0c9a5684da 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -73,6 +73,7 @@ check_PROGRAMS = \ lib/test_timer_correctness \ lib/test_timer_performance \ lib/test_ttable \ + lib/test_zlog \ lib/cli/test_cli \ lib/cli/test_commands \ $(TESTS_BGPD) \ @@ -115,9 +116,9 @@ lib_test_heavy_SOURCES = lib/test_heavy.c helpers/c/main.c lib_test_memory_SOURCES = lib/test_memory.c lib_test_nexthop_iter_SOURCES = lib/test_nexthop_iter.c helpers/c/prng.c lib_test_privs_SOURCES = lib/test_privs.c +lib_test_ringbuf_SOURCES = lib/test_ringbuf.c lib_test_srcdest_table_SOURCES = lib/test_srcdest_table.c \ helpers/c/prng.c -lib_test_ringbuf_SOURCES = lib/test_ringbuf.c lib_test_segv_SOURCES = lib/test_segv.c lib_test_sig_SOURCES = lib/test_sig.c lib_test_stream_SOURCES = lib/test_stream.c @@ -127,6 +128,7 @@ lib_test_timer_correctness_SOURCES = lib/test_timer_correctness.c \ lib_test_timer_performance_SOURCES = lib/test_timer_performance.c \ helpers/c/prng.c lib_test_ttable_SOURCES = lib/test_ttable.c +lib_test_zlog_SOURCES = lib/test_zlog.c lib_test_zmq_SOURCES = lib/test_zmq.c lib_test_zmq_CFLAGS = $(AM_CFLAGS) $(ZEROMQ_CFLAGS) lib_cli_test_cli_SOURCES = lib/cli/test_cli.c lib/cli/common_cli.c @@ -167,6 +169,7 @@ lib_test_table_LDADD = $(ALL_TESTS_LDADD) -lm lib_test_timer_correctness_LDADD = $(ALL_TESTS_LDADD) lib_test_timer_performance_LDADD = $(ALL_TESTS_LDADD) lib_test_ttable_LDADD = $(ALL_TESTS_LDADD) +lib_test_zlog_LDADD = $(ALL_TESTS_LDADD) lib_test_zmq_LDADD = ../lib/libfrrzmq.la $(ALL_TESTS_LDADD) $(ZEROMQ_LIBS) lib_cli_test_cli_LDADD = $(ALL_TESTS_LDADD) lib_cli_test_commands_LDADD = $(ALL_TESTS_LDADD) @@ -207,6 +210,7 @@ EXTRA_DIST = \ lib/test_timer_correctness.py \ lib/test_ttable.py \ lib/test_ttable.refout \ + lib/test_zlog.py \ ospf6d/test_lsdb.py \ ospf6d/test_lsdb.in \ ospf6d/test_lsdb.refout \ diff --git a/tests/lib/test_zlog.c b/tests/lib/test_zlog.c new file mode 100644 index 0000000000..790e65cfe9 --- /dev/null +++ b/tests/lib/test_zlog.c @@ -0,0 +1,61 @@ +/* + * Zlog tests. + * Copyright (C) 2018 Cumulus Networks, Inc. + * Quentin Young + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the Free + * Software Foundation; either version 2 of the License, or (at your option) + * any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; see the file COPYING; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ +#include +#include +#include "log.h" + +/* maximum amount of data to hexdump */ +#define MAXDATA 16384 + +/* + * Test hexdump functionality. + * + * At the moment, not crashing is considered success. + */ +static bool test_zlog_hexdump(void) +{ + unsigned int nl = 1; + + do { + long d[nl]; + + for (unsigned int i = 0; i < nl; i++) + d[i] = random(); + zlog_hexdump(d, nl * sizeof(long)); + } while (++nl * sizeof(long) <= MAXDATA); + + return true; +} + +bool (*tests[])(void) = { + test_zlog_hexdump, +}; + +int main(int argc, char **argv) +{ + openzlog("testzlog", "NONE", 0, LOG_CONS | LOG_NDELAY | LOG_PID, + LOG_ERR); + zlog_set_file("test_zlog.log", LOG_DEBUG); + + for (unsigned int i = 0; i < array_size(tests); i++) + if (!tests[i]()) + return 1; + return 0; +} diff --git a/tests/lib/test_zlog.py b/tests/lib/test_zlog.py new file mode 100644 index 0000000000..2ca2585886 --- /dev/null +++ b/tests/lib/test_zlog.py @@ -0,0 +1,4 @@ +import frrtest + +class TestZlog(frrtest.TestMultiOut): + program = './test_zlog' From 3413af0d748fd2adaaa9feeb072c5ba358796a17 Mon Sep 17 00:00:00 2001 From: Lou Berger Date: Fri, 9 Mar 2018 11:49:29 -0500 Subject: [PATCH 134/148] tools: fix indent.py to recognize all DEFUN types: DEFUN DEFUN_ATTR DEFUN_CMD_ELEMENT DEFUN_CMD_FUNC_DECL DEFUN_CMD_FUNC_TEXT DEFUN_DEPRECATED DEFUN_HIDDEN DEFUN_NOSH DEFUNSH DEFUNSH_ATTR DEFUNSH_DEPRECATED DEFUNSH_HIDDEN Signed-off-by: Lou Berger --- tools/indent.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/indent.py b/tools/indent.py index 91bb23f67c..139049b670 100755 --- a/tools/indent.py +++ b/tools/indent.py @@ -6,7 +6,7 @@ import sys, re, subprocess, os # find all DEFUNs defun_re = re.compile( - r'^((DEF(UN(_NOSH|_HIDDEN)?|PY)|ALIAS)\s*\(.*?)^(?=\s*\{)', + r'^((DEF(UN(|_ATTR|_CMD_(ELEMENT|FUNC_(DECL|TEXT))|_DEPRECATED|_NOSH|_HIDDEN|SH(|_ATTR|_DEPRECATED|_HIDDEN))?|PY)|ALIAS)\s*\(.*?)^(?=\s*\{)', re.M | re.S) define_re = re.compile( r'((^#\s*define[^\n]+[^\\]\n)+)', From b86543b804d9eb5c0b818ea542f59fbbe94bff50 Mon Sep 17 00:00:00 2001 From: Lou Berger Date: Mon, 12 Mar 2018 11:51:21 -0400 Subject: [PATCH 135/148] vtysh: restore some DEFUNs that should not have been reformated by indent.py --- vtysh/vtysh.c | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/vtysh/vtysh.c b/vtysh/vtysh.c index 7dfe7753cf..efef106d97 100644 --- a/vtysh/vtysh.c +++ b/vtysh/vtysh.c @@ -1205,21 +1205,30 @@ DEFUNSH(VTYSH_BGPD, address_family_ipv6_labeled_unicast, } #if defined(HAVE_RPKI) -DEFUNSH(VTYSH_BGPD, rpki, rpki_cmd, "rpki", +DEFUNSH(VTYSH_BGPD, + rpki, + rpki_cmd, + "rpki", "Enable rpki and enter rpki configuration mode\n") { vty->node = RPKI_NODE; return CMD_SUCCESS; } -DEFUNSH(VTYSH_BGPD, rpki_exit, rpki_exit_cmd, "exit", +DEFUNSH(VTYSH_BGPD, + rpki_exit, + rpki_exit_cmd, + "exit", "Exit current mode and down to previous mode\n") { vty->node = CONFIG_NODE; return CMD_SUCCESS; } -DEFUNSH(VTYSH_BGPD, rpki_quit, rpki_quit_cmd, "quit", +DEFUNSH(VTYSH_BGPD, + rpki_quit, + rpki_quit_cmd, + "quit", "Exit current mode and down to previous mode\n") { return rpki_exit(self, vty, argc, argv); @@ -1326,7 +1335,8 @@ DEFUNSH(VTYSH_OSPFD, router_ospf, router_ospf_cmd, "router ospf [(1-65535)] [vrf NAME]", "Enable a routing process\n" "Start OSPF configuration\n" - "Instance ID\n" VRF_CMD_HELP_STR) + "Instance ID\n" + VRF_CMD_HELP_STR) { vty->node = OSPF_NODE; return CMD_SUCCESS; @@ -1802,14 +1812,16 @@ DEFSH(VTYSH_ZEBRA, vtysh_no_vrf_cmd, "no vrf NAME", NO_STR "Delete a pseudo vrf's configuration\n" "VRF's name\n") -DEFUNSH(VTYSH_NS, vtysh_exit_logicalrouter, vtysh_exit_logicalrouter_cmd, - "exit", "Exit current mode and down to previous mode\n") +DEFUNSH(VTYSH_NS, vtysh_exit_logicalrouter, + vtysh_exit_logicalrouter_cmd, "exit", + "Exit current mode and down to previous mode\n") { return vtysh_exit(vty); } -DEFUNSH(VTYSH_NS, vtysh_quit_logicalrouter, vtysh_quit_logicalrouter_cmd, - "quit", "Exit current mode and down to previous mode\n") +DEFUNSH(VTYSH_NS, vtysh_quit_logicalrouter, + vtysh_quit_logicalrouter_cmd, "quit", + "Exit current mode and down to previous mode\n") { return vtysh_exit_logicalrouter(self, vty, argc, argv); } @@ -2121,7 +2133,6 @@ DEFUNSH(VTYSH_ALL, vtysh_log_facility, vtysh_log_facility_cmd, "log facility ", "Logging control\n" "Facility parameter for syslog messages\n" LOG_FACILITY_DESC) - { return CMD_SUCCESS; } @@ -2131,7 +2142,6 @@ DEFUNSH(VTYSH_ALL, no_vtysh_log_facility, no_vtysh_log_facility_cmd, "Logging control\n" "Reset syslog facility to default (daemon)\n" "Syslog facility\n") - { return CMD_SUCCESS; } @@ -2141,7 +2151,6 @@ DEFUNSH_DEPRECATED( "log trap ", "Logging control\n" "(Deprecated) Set logging level and default for all destinations\n" LOG_LEVEL_DESC) - { return CMD_SUCCESS; } From 1c9d288e496d0fc20baeadd2e792e927a6f50312 Mon Sep 17 00:00:00 2001 From: Philippe Guibert Date: Tue, 13 Mar 2018 14:51:31 +0100 Subject: [PATCH 136/148] zebra: upon associating netns with vrf, prileges are raised In order to create the netns context, the zebra parser at startup needs to have its privileges raised. Signed-off-by: Philippe Guibert --- zebra/zebra_netns_notify.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/zebra/zebra_netns_notify.c b/zebra/zebra_netns_notify.c index 4f55be45b6..98b36dd10f 100644 --- a/zebra/zebra_netns_notify.c +++ b/zebra/zebra_netns_notify.c @@ -92,7 +92,11 @@ static void zebra_ns_notify_create_context_from_entry_name(const char *name) zlog_warn("NS notify : failed to create VRF %s", name); return; } + if (zserv_privs.change(ZPRIVS_RAISE)) + zlog_err("Can't raise privileges"); ret = vrf_netns_handler_create(NULL, vrf, netnspath, ns_id); + if (zserv_privs.change(ZPRIVS_LOWER)) + zlog_err("Can't lower privileges"); if (ret != CMD_SUCCESS) { zlog_warn("NS notify : failed to create NS %s", netnspath); return; From 3bc34908e86ee01f8eb4f8d39a4075c865d56370 Mon Sep 17 00:00:00 2001 From: Philippe Guibert Date: Tue, 13 Mar 2018 15:26:03 +0100 Subject: [PATCH 137/148] lib: privileges are granted to vty netns command Vty commands that link netns context to a vrf is requiring some privileges. The change consists in retrieving the privileges at the vrf_cmd_init() called by the relevant daemon. Then use it. Signed-off-by: Philippe Guibert --- lib/vrf.c | 20 +++++++++++++++++--- lib/vrf.h | 3 ++- pimd/pim_instance.c | 2 +- zebra/zebra_vrf.c | 3 ++- 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/lib/vrf.c b/lib/vrf.c index f8e5a97904..6002aee514 100644 --- a/lib/vrf.c +++ b/lib/vrf.c @@ -33,6 +33,7 @@ #include "memory.h" #include "command.h" #include "ns.h" +#include "privs.h" /* default VRF ID value used when VRF backend is not NETNS */ #define VRF_DEFAULT_INTERNAL 0 @@ -52,6 +53,7 @@ struct vrf_id_head vrfs_by_id = RB_INITIALIZER(&vrfs_by_id); struct vrf_name_head vrfs_by_name = RB_INITIALIZER(&vrfs_by_name); static int vrf_backend; +static struct zebra_privs_t *vrf_daemon_privs; /* * Turn on/off debug code @@ -690,14 +692,24 @@ DEFUN_NOSH (vrf_netns, "Attach VRF to a Namespace\n" "The file name in " NS_RUN_DIR ", or a full pathname\n") { - int idx_name = 1; + int idx_name = 1, ret; char *pathname = ns_netns_pathname(vty, argv[idx_name]->arg); VTY_DECLVAR_CONTEXT(vrf, vrf); if (!pathname) return CMD_WARNING_CONFIG_FAILED; - return vrf_netns_handler_create(vty, vrf, pathname, NS_UNKNOWN); + + if (vrf_daemon_privs && + vrf_daemon_privs->change(ZPRIVS_RAISE)) + zlog_err("%s: Can't raise privileges", __func__); + + ret = vrf_netns_handler_create(vty, vrf, pathname, NS_UNKNOWN); + + if (vrf_daemon_privs && + vrf_daemon_privs->change(ZPRIVS_LOWER)) + zlog_err("%s: Can't lower privileges", __func__); + return ret; } DEFUN (no_vrf_netns, @@ -779,7 +791,8 @@ void vrf_install_commands(void) install_element(ENABLE_NODE, &no_vrf_debug_cmd); } -void vrf_cmd_init(int (*writefunc)(struct vty *vty)) +void vrf_cmd_init(int (*writefunc)(struct vty *vty), + struct zebra_privs_t *daemon_privs) { install_element(CONFIG_NODE, &vrf_cmd); install_element(CONFIG_NODE, &no_vrf_cmd); @@ -787,6 +800,7 @@ void vrf_cmd_init(int (*writefunc)(struct vty *vty)) install_default(VRF_NODE); if (vrf_is_backend_netns() && ns_have_netns()) { /* Install NS commands. */ + vrf_daemon_privs = daemon_privs; install_element(VRF_NODE, &vrf_netns_cmd); install_element(VRF_NODE, &no_vrf_netns_cmd); } diff --git a/lib/vrf.h b/lib/vrf.h index 6482740aa1..617405a77e 100644 --- a/lib/vrf.h +++ b/lib/vrf.h @@ -242,7 +242,8 @@ extern int vrf_switchback_to_initial(void); /* VRF vty command initialisation */ -extern void vrf_cmd_init(int (*writefunc)(struct vty *vty)); +extern void vrf_cmd_init(int (*writefunc)(struct vty *vty), + struct zebra_privs_t *daemon_priv); /* VRF vty debugging */ diff --git a/pimd/pim_instance.c b/pimd/pim_instance.c index f92da7fe70..60a3308a00 100644 --- a/pimd/pim_instance.c +++ b/pimd/pim_instance.c @@ -214,7 +214,7 @@ void pim_vrf_init(void) { vrf_init(pim_vrf_new, pim_vrf_enable, pim_vrf_disable, pim_vrf_delete); - vrf_cmd_init(pim_vrf_config_write); + vrf_cmd_init(pim_vrf_config_write, &pimd_privs); } void pim_vrf_terminate(void) diff --git a/zebra/zebra_vrf.c b/zebra/zebra_vrf.c index 9e13f4ed6e..64585c4c1a 100644 --- a/zebra/zebra_vrf.c +++ b/zebra/zebra_vrf.c @@ -39,6 +39,7 @@ #include "zebra/interface.h" #include "zebra/zebra_mpls.h" #include "zebra/zebra_vxlan.h" +#include "zebra/zebra_netns_notify.h" extern struct zebra_t zebrad; @@ -587,5 +588,5 @@ void zebra_vrf_init(void) vrf_init(zebra_vrf_new, zebra_vrf_enable, zebra_vrf_disable, zebra_vrf_delete); - vrf_cmd_init(vrf_config_write); + vrf_cmd_init(vrf_config_write, &zserv_privs); } From 6d16f234b8344b50c6b513e4969d2e87ab16dc08 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 13 Mar 2018 13:18:19 -0400 Subject: [PATCH 138/148] doc: don't check for sphinx-build on `make clean` Signed-off-by: Quentin Young --- doc/frr-sphinx.mk | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/frr-sphinx.mk b/doc/frr-sphinx.mk index 3d91e8f63d..df4056760d 100644 --- a/doc/frr-sphinx.mk +++ b/doc/frr-sphinx.mk @@ -11,11 +11,13 @@ PAPER ?= BUILDDIR = _build # User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -SPHINXBUILD = sphinx-1.0-build -endif -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") +ifneq ($(MAKECMDGOALS), clean) + ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) + SPHINXBUILD = sphinx-1.0-build + endif + ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) + $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/") + endif endif # Internal variables. From b7d08f5ab50dffae02feb146dde3a5e752c6b3ff Mon Sep 17 00:00:00 2001 From: vivek Date: Tue, 13 Mar 2018 18:14:26 +0000 Subject: [PATCH 139/148] bgpd: Fix enum, use API for log string Suggested-by: Philippe Guibert Signed-off-by: Vivek Venkatraman --- bgpd/bgp_attr.h | 2 +- bgpd/bgp_debug.c | 4 ---- bgpd/bgp_route.c | 25 +++++++++++++++++++++---- 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/bgpd/bgp_attr.h b/bgpd/bgp_attr.h index 5bf2377558..5403f32543 100644 --- a/bgpd/bgp_attr.h +++ b/bgpd/bgp_attr.h @@ -99,7 +99,7 @@ struct overlay_index { }; enum pta_type { - PMSI_TNLTYPE_NO_INFO, + PMSI_TNLTYPE_NO_INFO = 0, PMSI_TNLTYPE_RSVP_TE_P2MP, PMSI_TNLTYPE_MLDP_P2MP, PMSI_TNLTYPE_PIM_SSM, diff --git a/bgpd/bgp_debug.c b/bgpd/bgp_debug.c index 8b308c8f3e..2580d2e5a5 100644 --- a/bgpd/bgp_debug.c +++ b/bgpd/bgp_debug.c @@ -159,10 +159,6 @@ static const struct message bgp_notify_capability_msg[] = { /* Origin strings. */ const char *bgp_origin_str[] = {"i", "e", "?"}; const char *bgp_origin_long_str[] = {"IGP", "EGP", "incomplete"}; -const char *pmsi_tnltype_str[] = {"No info", "RSVP-TE P2MP", "mLDP P2MP", - "PIM-SSM", "PIM-SM", "PIM-BIDIR", - "Ingress Replication", "mLDP MP2MP"}; - /* Given a string return a pointer the corresponding peer structure */ static struct peer *bgp_find_peer(struct vty *vty, const char *peer_str) diff --git a/bgpd/bgp_route.c b/bgpd/bgp_route.c index 88e93f5710..de693a219c 100644 --- a/bgpd/bgp_route.c +++ b/bgpd/bgp_route.c @@ -82,6 +82,20 @@ extern const char *bgp_origin_str[]; extern const char *bgp_origin_long_str[]; +/* PMSI strings. */ +#define PMSI_TNLTYPE_STR_NO_INFO "No info" +#define PMSI_TNLTYPE_STR_DEFAULT PMSI_TNLTYPE_STR_NO_INFO +static const struct message bgp_pmsi_tnltype_str[] = { + {PMSI_TNLTYPE_NO_INFO, PMSI_TNLTYPE_STR_NO_INFO}, + {PMSI_TNLTYPE_RSVP_TE_P2MP, "RSVP-TE P2MP"}, + {PMSI_TNLTYPE_MLDP_P2MP, "mLDP P2MP"}, + {PMSI_TNLTYPE_PIM_SSM, "PIM-SSM"}, + {PMSI_TNLTYPE_PIM_SM, "PIM-SM"}, + {PMSI_TNLTYPE_PIM_BIDIR, "PIM-BIDIR"}, + {PMSI_TNLTYPE_INGR_REPL, "Ingress Replication"}, + {PMSI_TNLTYPE_MLDP_MP2MP, "mLDP MP2MP"}, + {0}}; + struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi, safi_t safi, struct prefix *p, struct prefix_rd *prd) @@ -7791,16 +7805,19 @@ void route_vty_out_detail(struct vty *vty, struct bgp *bgp, struct prefix *p, /* Line 10 display PMSI tunnel attribute, if present */ if (attr->flag & ATTR_FLAG_BIT(BGP_ATTR_PMSI_TUNNEL)) { + const char *str = lookup_msg(bgp_pmsi_tnltype_str, + attr->pmsi_tnl_type, + PMSI_TNLTYPE_STR_DEFAULT); + if (json_paths) { json_pmsi = json_object_new_object(); - json_object_string_add( - json_pmsi, "tunnelType", - pmsi_tnltype_str[attr->pmsi_tnl_type]); + json_object_string_add(json_pmsi, + "tunnelType", str); json_object_object_add(json_path, "pmsi", json_pmsi); } else vty_out(vty, " PMSI Tunnel Type: %s\n", - pmsi_tnltype_str[attr->pmsi_tnl_type]); + str); } } From 88fbc36fcb74f5cc3d009802b6aac537916164d1 Mon Sep 17 00:00:00 2001 From: vivek Date: Tue, 13 Mar 2018 19:42:41 +0000 Subject: [PATCH 140/148] bgpd: Fix warning Signed-off-by: Vivek Venkatraman --- bgpd/bgp_route.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/bgpd/bgp_route.c b/bgpd/bgp_route.c index de693a219c..fd0c87c8ca 100644 --- a/bgpd/bgp_route.c +++ b/bgpd/bgp_route.c @@ -94,7 +94,8 @@ static const struct message bgp_pmsi_tnltype_str[] = { {PMSI_TNLTYPE_PIM_BIDIR, "PIM-BIDIR"}, {PMSI_TNLTYPE_INGR_REPL, "Ingress Replication"}, {PMSI_TNLTYPE_MLDP_MP2MP, "mLDP MP2MP"}, - {0}}; + {0} +}; struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi, safi_t safi, struct prefix *p, From 78b4c54667566f3f567ea156db5fd6f300f69c46 Mon Sep 17 00:00:00 2001 From: Martin Winter Date: Tue, 13 Mar 2018 14:02:34 -0700 Subject: [PATCH 141/148] doc: Update CentOS6 doc to use puias repo for updated sphinx Signed-off-by: Martin Winter --- doc/developer/Building_FRR_on_CentOS6.rst | 34 +++++++++++++---------- redhat/README.rpm_build.md | 2 +- 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst index ca18f743c4..4e7861ac5c 100644 --- a/doc/developer/Building_FRR_on_CentOS6.rst +++ b/doc/developer/Building_FRR_on_CentOS6.rst @@ -96,21 +96,27 @@ to python Install newer ``Sphinx-Build`` based on ``Python 2.7`` +Create a new repo ``/etc/yum.repos.d/puias6.repo`` with the following contents: + :: - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-babel-0.9.6-2.sdl6.1.noarch.rpm - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-jinja2-2.7.2-2.sdl6.noarch.rpm - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-markupsafe-0.11-4.puias6.x86_64.rpm - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-pygments-1.4-4.sdl6.1.noarch.rpm - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-docutils-0.8.1-3.sdl6.2.noarch.rpm - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-imaging-1.1.7-6.puias6.x86_64.rpm - curl -O http://springdale.math.ias.edu/data/puias/computational/6/x86_64/python27-sphinx-1.1.3-1.sdl6.1.noarch.rpm - sudo yum install ./python27-markupsafe-0.11-4.puias6.x86_64.rpm \ - ./python27-babel-0.9.6-2.sdl6.1.noarch.rpm \ - ./python27-jinja2-2.7.2-2.sdl6.noarch.rpm \ - ./python27-pygments-1.4-4.sdl6.1.noarch.rpm \ - ./python27-docutils-0.8.1-3.sdl6.2.noarch.rpm \ - ./python27-imaging-1.1.7-6.puias6.x86_64.rpm \ - ./python27-sphinx-1.1.3-1.sdl6.1.noarch.rpm + + ### Name: RPM Repository for RHEL 6 - PUIAS (used for Sphinx-Build) + ### URL: http://springdale.math.ias.edu/data/puias/computational + [puias-computational] + name = RPM Repository for RHEL 6 - Sphinx-Build + baseurl = http://springdale.math.ias.edu/data/puias/computational/$releasever/$basearch + #mirrorlist = + enabled = 1 + protect = 0 + gpgkey = + gpgcheck = 0 + +Update rpm database & Install newer sphinx + +:: + + sudo yum update + sudo yum install python27-sphinx Get FRR, compile it and install it (from Git) --------------------------------------------- diff --git a/redhat/README.rpm_build.md b/redhat/README.rpm_build.md index 2de64b8f40..7deea54de4 100644 --- a/redhat/README.rpm_build.md +++ b/redhat/README.rpm_build.md @@ -29,7 +29,7 @@ Building your own FRRouting RPM cd frr ./bootstrap.sh ./configure --with-pkg-extra-version=-MyRPMVersion - make dist + make SPHINXBUILD=sphinx-build2.7 dist Note: configure parameters are not important for the RPM building - except the `with-pkg-extra-version` if you want to give the RPM a specific name to mark your own unoffical build From 65230b542e66532ebd5c73a1996208f42e1a7eac Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 13 Mar 2018 17:11:51 -0400 Subject: [PATCH 142/148] doc: remove misc trailing whitespace Signed-off-by: Quentin Young --- doc/developer/Building_FRR_on_CentOS6.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst index 4e7861ac5c..1c53ea6ba3 100644 --- a/doc/developer/Building_FRR_on_CentOS6.rst +++ b/doc/developer/Building_FRR_on_CentOS6.rst @@ -105,10 +105,10 @@ Create a new repo ``/etc/yum.repos.d/puias6.repo`` with the following contents: [puias-computational] name = RPM Repository for RHEL 6 - Sphinx-Build baseurl = http://springdale.math.ias.edu/data/puias/computational/$releasever/$basearch - #mirrorlist = + #mirrorlist = enabled = 1 protect = 0 - gpgkey = + gpgkey = gpgcheck = 0 Update rpm database & Install newer sphinx From e4c42d655aa93f94a8eb6ddf20c8125d192fd8ae Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Tue, 13 Mar 2018 21:06:04 -0400 Subject: [PATCH 143/148] ospf6d: Stop debug messages happening in rare case When we have a interface disabled in ospfv3 and we are receiving messages on it. We will spam the log file repeatedly. Debug guard the message. Signed-off-by: Donald Sharp --- ospf6d/ospf6_message.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ospf6d/ospf6_message.c b/ospf6d/ospf6_message.c index b75d5b70fa..f32cd6e7e3 100644 --- a/ospf6d/ospf6_message.c +++ b/ospf6d/ospf6_message.c @@ -1573,7 +1573,8 @@ int ospf6_receive(struct thread *thread) oi = ospf6_interface_lookup_by_ifindex(ifindex); if (oi == NULL || oi->area == NULL || CHECK_FLAG(oi->flag, OSPF6_INTERFACE_DISABLE)) { - zlog_debug("Message received on disabled interface"); + if (IS_OSPF6_DEBUG_MESSAGE(OSPF6_MESSAGE_TYPE_UNKNOWN, RECV)) + zlog_debug("Message received on disabled interface"); return 0; } if (CHECK_FLAG(oi->flag, OSPF6_INTERFACE_PASSIVE)) { From 31919191561fa9b978f8c3cf713e30ed6fb20889 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Sat, 10 Mar 2018 15:12:52 -0500 Subject: [PATCH 144/148] lib: Add nexthop-group cli Add a nexthop-group cli: nexthop-group NAME nexthop A nexthop B nexthop C ! This will allow interested parties to hook into the cli for nexthops. Users can add callback functions for add/delete of a nexthop group as well as add/delete of each individual nexthop. Future work( PBR and static routes ) will take advantage of this. Signed-off-by: Donald Sharp --- lib/nexthop.c | 51 +++++++ lib/nexthop.h | 2 + lib/nexthop_group.c | 315 +++++++++++++++++++++++++++++++++++++++++++- lib/nexthop_group.h | 36 ++++- 4 files changed, 396 insertions(+), 8 deletions(-) diff --git a/lib/nexthop.c b/lib/nexthop.c index cee34e85c7..fb7ccc169e 100644 --- a/lib/nexthop.c +++ b/lib/nexthop.c @@ -163,6 +163,57 @@ void nexthops_free(struct nexthop *nexthop) } } +bool nexthop_same(const struct nexthop *nh1, const struct nexthop *nh2) +{ + if (nh1 && !nh2) + return false; + + if (!nh1 && nh2) + return false; + + if (nh1 == nh2) + return true; + + if (nh1->vrf_id != nh2->vrf_id) + return false; + + if (nh1->type != nh2->type) + return false; + + switch (nh1->type) { + case NEXTHOP_TYPE_IFINDEX: + if (nh1->ifindex != nh2->ifindex) + return false; + break; + case NEXTHOP_TYPE_IPV4: + if (nh1->gate.ipv4.s_addr != nh2->gate.ipv4.s_addr) + return false; + break; + case NEXTHOP_TYPE_IPV4_IFINDEX: + if (nh1->gate.ipv4.s_addr != nh2->gate.ipv4.s_addr) + return false; + if (nh1->ifindex != nh2->ifindex) + return false; + break; + case NEXTHOP_TYPE_IPV6: + if (memcmp(&nh1->gate.ipv6, &nh2->gate.ipv6, 16)) + return false; + break; + case NEXTHOP_TYPE_IPV6_IFINDEX: + if (memcmp(&nh1->gate.ipv6, &nh2->gate.ipv6, 16)) + return false; + if (nh1->ifindex != nh2->ifindex) + return false; + break; + case NEXTHOP_TYPE_BLACKHOLE: + if (nh1->bh_type != nh2->bh_type) + return false; + break; + } + + return true; +} + /* Update nexthop with label information. */ void nexthop_add_labels(struct nexthop *nexthop, enum lsp_types_t type, u_int8_t num_labels, mpls_label_t *label) diff --git a/lib/nexthop.h b/lib/nexthop.h index 0ca8a0063a..568243d3a9 100644 --- a/lib/nexthop.h +++ b/lib/nexthop.h @@ -118,6 +118,8 @@ void nexthop_add_labels(struct nexthop *, enum lsp_types_t, u_int8_t, mpls_label_t *); void nexthop_del_labels(struct nexthop *); +extern bool nexthop_same(const struct nexthop *nh1, const struct nexthop *nh2); + extern const char *nexthop_type_to_str(enum nexthop_types_t nh_type); extern int nexthop_same_no_recurse(const struct nexthop *next1, const struct nexthop *next2); diff --git a/lib/nexthop_group.c b/lib/nexthop_group.c index e7f10487d1..2012fbdbed 100644 --- a/lib/nexthop_group.c +++ b/lib/nexthop_group.c @@ -19,6 +19,7 @@ */ #include +#include #include #include #include @@ -28,6 +29,56 @@ #include "lib/nexthop_group_clippy.c" #endif +DEFINE_MTYPE_STATIC(LIB, NEXTHOP_GROUP, "Nexthop Group") + +struct nexthop_group_hooks { + void (*new)(const char *name); + void (*add_nexthop)(const struct nexthop_group_cmd *nhg, + const struct nexthop *nhop); + void (*del_nexthop)(const struct nexthop_group_cmd *nhg, + const struct nexthop *nhop); + void (*delete)(const char *name); +}; + +static struct nexthop_group_hooks nhg_hooks; + +static inline int +nexthop_group_cmd_compare(const struct nexthop_group_cmd *nhgc1, + const struct nexthop_group_cmd *nhgc2); +RB_GENERATE(nhgc_entry_head, nexthop_group_cmd, nhgc_entry, + nexthop_group_cmd_compare) + +struct nhgc_entry_head nhgc_entries; + +static inline int +nexthop_group_cmd_compare(const struct nexthop_group_cmd *nhgc1, + const struct nexthop_group_cmd *nhgc2) +{ + return strcmp(nhgc1->name, nhgc2->name); +} + +struct nexthop *nexthop_exists(struct nexthop_group *nhg, struct nexthop *nh) +{ + struct nexthop *nexthop; + + for (nexthop = nhg->nexthop; nexthop; nexthop = nexthop->next) { + if (nexthop_same(nh, nexthop)) + return nexthop; + } + + return NULL; +} + +struct nexthop_group *nexthop_group_new(void) +{ + return XCALLOC(MTYPE_NEXTHOP_GROUP, sizeof(struct nexthop_group)); +} + +void nexthop_group_delete(struct nexthop_group **nhg) +{ + XFREE(MTYPE_NEXTHOP_GROUP, *nhg); +} + /* Add nexthop to the end of a nexthop list. */ void nexthop_add(struct nexthop **target, struct nexthop *nexthop) { @@ -42,6 +93,27 @@ void nexthop_add(struct nexthop **target, struct nexthop *nexthop) nexthop->prev = last; } +/* Delete nexthop from a nexthop list. */ +void nexthop_del(struct nexthop_group *nhg, struct nexthop *nh) +{ + struct nexthop *nexthop; + + for (nexthop = nhg->nexthop; nexthop; nexthop = nexthop->next) { + if (nexthop_same(nh, nexthop)) + break; + } + + assert(nexthop); + + if (nexthop->prev) + nexthop->prev->next = nexthop->next; + else + nhg->nexthop = nexthop->next; + + if (nexthop->next) + nexthop->next->prev = nexthop->prev; +} + void copy_nexthops(struct nexthop **tnh, struct nexthop *nh, struct nexthop *rparent) { @@ -71,12 +143,169 @@ void copy_nexthops(struct nexthop **tnh, struct nexthop *nh, } } -DEFPY (nexthop_group, - nexthop_group_cmd, - "nexthop-group NAME", - "Enter into the nexthop-group submode\n" - "Specify the NAME of the nexthop-group\n") +static void nhgc_delete_nexthops(struct nexthop_group_cmd *nhgc) { + struct nexthop *nexthop; + + nexthop = nhgc->nhg.nexthop; + while (nexthop) { + struct nexthop *next = nexthop_next(nexthop); + + if (nhg_hooks.del_nexthop) + nhg_hooks.del_nexthop(nhgc, nexthop); + + nexthop_free(nexthop); + + nexthop = next; + } +} + +static struct nexthop_group_cmd *nhgc_find(const char *name) +{ + struct nexthop_group_cmd find; + + strlcpy(find.name, name, sizeof(find.name)); + + return RB_FIND(nhgc_entry_head, &nhgc_entries, &find); +} + +static struct nexthop_group_cmd *nhgc_get(const char *name) +{ + struct nexthop_group_cmd *nhgc; + + nhgc = nhgc_find(name); + if (!nhgc) { + nhgc = XCALLOC(MTYPE_TMP, sizeof(*nhgc)); + strlcpy(nhgc->name, name, sizeof(nhgc->name)); + + QOBJ_REG(nhgc, nexthop_group_cmd); + RB_INSERT(nhgc_entry_head, &nhgc_entries, nhgc); + + if (nhg_hooks.new) + nhg_hooks.new(name); + } + + return nhgc; +} + +static void nhgc_delete(struct nexthop_group_cmd *nhgc) +{ + nhgc_delete_nexthops(nhgc); + + if (nhg_hooks.delete) + nhg_hooks.delete(nhgc->name); + + RB_REMOVE(nhgc_entry_head, &nhgc_entries, nhgc); +} + +DEFINE_QOBJ_TYPE(nexthop_group_cmd) + +DEFUN_NOSH(nexthop_group, nexthop_group_cmd, "nexthop-group NAME", + "Enter into the nexthop-group submode\n" + "Specify the NAME of the nexthop-group\n") +{ + const char *nhg_name = argv[1]->arg; + struct nexthop_group_cmd *nhgc = NULL; + + nhgc = nhgc_get(nhg_name); + VTY_PUSH_CONTEXT(NH_GROUP_NODE, nhgc); + + return CMD_SUCCESS; +} + +DEFUN_NOSH(no_nexthop_group, no_nexthop_group_cmd, "no nexthop-group NAME", + NO_STR + "Delete the nexthop-group\n" + "Specify the NAME of the nexthop-group\n") +{ + const char *nhg_name = argv[2]->arg; + struct nexthop_group_cmd *nhgc = NULL; + + nhgc = nhgc_find(nhg_name); + if (nhgc) + nhgc_delete(nhgc); + + return CMD_SUCCESS; +} + +DEFPY(ecmp_nexthops, ecmp_nexthops_cmd, + "[no] nexthop $addr [INTERFACE]$intf [nexthop-vrf NAME$name]", + NO_STR + "Specify one of the nexthops in this ECMP group\n" + "v4 Address\n" + "v6 Address\n" + "Interface to use\n" + "If the nexthop is in a different vrf tell us\n" + "The nexthop-vrf Name\n") +{ + VTY_DECLVAR_CONTEXT(nexthop_group_cmd, nhgc); + struct vrf *vrf; + struct nexthop nhop; + struct nexthop *nh; + + if (name) + vrf = vrf_lookup_by_name(name); + else + vrf = vrf_lookup_by_id(VRF_DEFAULT); + + if (!vrf) { + vty_out(vty, "Specified: %s is non-existent\n", name); + return CMD_WARNING; + } + + memset(&nhop, 0, sizeof(nhop)); + nhop.vrf_id = vrf->vrf_id; + + if (addr->sa.sa_family == AF_INET) { + nhop.gate.ipv4.s_addr = addr->sin.sin_addr.s_addr; + if (intf) { + nhop.type = NEXTHOP_TYPE_IPV4_IFINDEX; + nhop.ifindex = ifname2ifindex(intf, vrf->vrf_id); + if (nhop.ifindex == IFINDEX_INTERNAL) { + vty_out(vty, + "Specified Intf %s does not exist in vrf: %s\n", + intf, vrf->name); + return CMD_WARNING; + } + } else + nhop.type = NEXTHOP_TYPE_IPV4; + } else { + memcpy(&nhop.gate.ipv6, &addr->sin6.sin6_addr, 16); + if (intf) { + nhop.type = NEXTHOP_TYPE_IPV6_IFINDEX; + nhop.ifindex = ifname2ifindex(intf, vrf->vrf_id); + if (nhop.ifindex == IFINDEX_INTERNAL) { + vty_out(vty, + "Specified Intf %s does not exist in vrf: %s\n", + intf, vrf->name); + return CMD_WARNING; + } + } else + nhop.type = NEXTHOP_TYPE_IPV6; + } + + nh = nexthop_exists(&nhgc->nhg, &nhop); + + if (no) { + if (nh) { + nexthop_del(&nhgc->nhg, nh); + + if (nhg_hooks.del_nexthop) + nhg_hooks.del_nexthop(nhgc, nh); + + nexthop_free(nh); + } + } else if (!nh) { + /* must be adding new nexthop since !no and !nexthop_exists */ + nh = nexthop_new(); + + memcpy(nh, &nhop, sizeof(nhop)); + nexthop_add(&nhgc->nhg.nexthop, nh); + + if (nhg_hooks.add_nexthop) + nhg_hooks.add_nexthop(nhgc, nh); + } + return CMD_SUCCESS; } @@ -88,13 +317,85 @@ struct cmd_node nexthop_group_node = { static int nexthop_group_write(struct vty *vty) { - vty_out(vty, "!\n"); + struct nexthop_group_cmd *nhgc; + struct nexthop *nh; + struct vrf *vrf; + + RB_FOREACH (nhgc, nhgc_entry_head, &nhgc_entries) { + char buf[100]; + + vty_out(vty, "nexthop-group %s\n", nhgc->name); + + for (nh = nhgc->nhg.nexthop; nh; nh = nh->next) { + + vty_out(vty, " nexthop "); + + switch (nh->type) { + case NEXTHOP_TYPE_IFINDEX: + vty_out(vty, "%s", + ifindex2ifname(nh->ifindex, + nh->vrf_id)); + break; + case NEXTHOP_TYPE_IPV4: + vty_out(vty, "%s", inet_ntoa(nh->gate.ipv4)); + break; + case NEXTHOP_TYPE_IPV4_IFINDEX: + vty_out(vty, "%s %s", inet_ntoa(nh->gate.ipv4), + ifindex2ifname(nh->ifindex, + nh->vrf_id)); + break; + case NEXTHOP_TYPE_IPV6: + vty_out(vty, "%s", + inet_ntop(AF_INET6, &nh->gate.ipv6, buf, + sizeof(buf))); + break; + case NEXTHOP_TYPE_IPV6_IFINDEX: + vty_out(vty, "%s %s", + inet_ntop(AF_INET6, &nh->gate.ipv6, buf, + sizeof(buf)), + ifindex2ifname(nh->ifindex, + nh->vrf_id)); + break; + case NEXTHOP_TYPE_BLACKHOLE: + break; + } + + if (nh->vrf_id) { + vrf = vrf_lookup_by_id(nh->vrf_id); + vty_out(vty, " nexthop-vrf %s", vrf->name); + } + vty_out(vty, "\n"); + } + vty_out(vty, "!\n"); + } return 1; } -void nexthop_group_init(void) +void nexthop_group_init(void (*new)(const char *name), + void (*add_nexthop)(const struct nexthop_group_cmd *nhg, + const struct nexthop *nhop), + void (*del_nexthop)(const struct nexthop_group_cmd *nhg, + const struct nexthop *nhop), + void (*delete)(const char *name)) { + RB_INIT(nhgc_entry_head, &nhgc_entries); + install_node(&nexthop_group_node, nexthop_group_write); install_element(CONFIG_NODE, &nexthop_group_cmd); + install_element(CONFIG_NODE, &no_nexthop_group_cmd); + + install_default(NH_GROUP_NODE); + install_element(NH_GROUP_NODE, &ecmp_nexthops_cmd); + + memset(&nhg_hooks, 0, sizeof(nhg_hooks)); + + if (new) + nhg_hooks.new = new; + if (add_nexthop) + nhg_hooks.add_nexthop = add_nexthop; + if (del_nexthop) + nhg_hooks.del_nexthop = del_nexthop; + if (delete) + nhg_hooks.delete = delete; } diff --git a/lib/nexthop_group.h b/lib/nexthop_group.h index 561fe96425..563799dc8f 100644 --- a/lib/nexthop_group.h +++ b/lib/nexthop_group.h @@ -33,9 +33,11 @@ struct nexthop_group { struct nexthop *nexthop; }; -void nexthop_group_init(void); +struct nexthop_group *nexthop_group_new(void); +void nexthop_group_delete(struct nexthop_group **nhg); void nexthop_add(struct nexthop **target, struct nexthop *nexthop); +void nexthop_del(struct nexthop_group *nhg, struct nexthop *nexthop); void copy_nexthops(struct nexthop **tnh, struct nexthop *nh, struct nexthop *rparent); @@ -51,4 +53,36 @@ void copy_nexthops(struct nexthop **tnh, struct nexthop *nh, (nhop) = (head.nexthop); \ (nhop); \ (nhop) = nexthop_next(nhop) + +struct nexthop_group_cmd { + + RB_ENTRY(nexthop_group_cmd) nhgc_entry; + + char name[80]; + + struct nexthop_group nhg; + + QOBJ_FIELDS +}; +RB_HEAD(nhgc_entry_head, nexthp_group_cmd); +RB_PROTOTYPE(nhgc_entry_head, nexthop_group_cmd, nhgc_entry, + nexthop_group_cmd_compare) +DECLARE_QOBJ_TYPE(nexthop_group_cmd) + +/* + * Initialize nexthop_groups. If you are interested in when + * a nexthop_group is added/deleted/modified, then set the + * appropriate callback functions to handle it in your + * code + */ +void nexthop_group_init( + void (*new)(const char *name), + void (*add_nexthop)(const struct nexthop_group_cmd *nhgc, + const struct nexthop *nhop), + void (*del_nexthop)(const struct nexthop_group_cmd *nhgc, + const struct nexthop *nhop), + void (*delete)(const char *name)); + +extern struct nexthop *nexthop_exists(struct nexthop_group *nhg, + struct nexthop *nh); #endif From d604266ced3bebd0907c76908e70e70884a353cc Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Sat, 10 Mar 2018 15:16:09 -0500 Subject: [PATCH 145/148] lib: Expose nhgc_find command Expose to the world the nhgc_find command so that interested parties can find a stored nexthop group. Signed-off-by: Donald Sharp --- lib/nexthop_group.c | 2 +- lib/nexthop_group.h | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/nexthop_group.c b/lib/nexthop_group.c index 2012fbdbed..0cfbeb8f40 100644 --- a/lib/nexthop_group.c +++ b/lib/nexthop_group.c @@ -160,7 +160,7 @@ static void nhgc_delete_nexthops(struct nexthop_group_cmd *nhgc) } } -static struct nexthop_group_cmd *nhgc_find(const char *name) +struct nexthop_group_cmd *nhgc_find(const char *name) { struct nexthop_group_cmd find; diff --git a/lib/nexthop_group.h b/lib/nexthop_group.h index 563799dc8f..b22e083e6b 100644 --- a/lib/nexthop_group.h +++ b/lib/nexthop_group.h @@ -85,4 +85,7 @@ void nexthop_group_init( extern struct nexthop *nexthop_exists(struct nexthop_group *nhg, struct nexthop *nh); + +extern struct nexthop_group_cmd *nhgc_find(const char *name); + #endif From 1b7bce04d50b9cb5982813a76f844cedd01f02a6 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Sat, 10 Mar 2018 16:15:46 -0500 Subject: [PATCH 146/148] lib: Add the ability for other people to call a nexthop write line Add code to allow nexthops to be written by people who are interested in writing their own nexthop line. Signed-off-by: Donald Sharp --- lib/nexthop_group.c | 82 ++++++++++++++++++++++----------------------- lib/nexthop_group.h | 3 ++ 2 files changed, 43 insertions(+), 42 deletions(-) diff --git a/lib/nexthop_group.c b/lib/nexthop_group.c index 0cfbeb8f40..e486247244 100644 --- a/lib/nexthop_group.c +++ b/lib/nexthop_group.c @@ -315,57 +315,55 @@ struct cmd_node nexthop_group_node = { 1 }; +void nexthop_group_write_nexthop(struct vty *vty, struct nexthop *nh) +{ + char buf[100]; + struct vrf *vrf; + + vty_out(vty, " nexthop "); + + switch (nh->type) { + case NEXTHOP_TYPE_IFINDEX: + vty_out(vty, "%s", ifindex2ifname(nh->ifindex, nh->vrf_id)); + break; + case NEXTHOP_TYPE_IPV4: + vty_out(vty, "%s", inet_ntoa(nh->gate.ipv4)); + break; + case NEXTHOP_TYPE_IPV4_IFINDEX: + vty_out(vty, "%s %s", inet_ntoa(nh->gate.ipv4), + ifindex2ifname(nh->ifindex, nh->vrf_id)); + break; + case NEXTHOP_TYPE_IPV6: + vty_out(vty, "%s", + inet_ntop(AF_INET6, &nh->gate.ipv6, buf, sizeof(buf))); + break; + case NEXTHOP_TYPE_IPV6_IFINDEX: + vty_out(vty, "%s %s", + inet_ntop(AF_INET6, &nh->gate.ipv6, buf, sizeof(buf)), + ifindex2ifname(nh->ifindex, nh->vrf_id)); + break; + case NEXTHOP_TYPE_BLACKHOLE: + break; + } + + if (nh->vrf_id != VRF_DEFAULT) { + vrf = vrf_lookup_by_id(nh->vrf_id); + vty_out(vty, " nexthop-vrf %s", vrf->name); + } + vty_out(vty, "\n"); +} + static int nexthop_group_write(struct vty *vty) { struct nexthop_group_cmd *nhgc; struct nexthop *nh; - struct vrf *vrf; RB_FOREACH (nhgc, nhgc_entry_head, &nhgc_entries) { - char buf[100]; - vty_out(vty, "nexthop-group %s\n", nhgc->name); - for (nh = nhgc->nhg.nexthop; nh; nh = nh->next) { + for (nh = nhgc->nhg.nexthop; nh; nh = nh->next) + nexthop_group_write_nexthop(vty, nh); - vty_out(vty, " nexthop "); - - switch (nh->type) { - case NEXTHOP_TYPE_IFINDEX: - vty_out(vty, "%s", - ifindex2ifname(nh->ifindex, - nh->vrf_id)); - break; - case NEXTHOP_TYPE_IPV4: - vty_out(vty, "%s", inet_ntoa(nh->gate.ipv4)); - break; - case NEXTHOP_TYPE_IPV4_IFINDEX: - vty_out(vty, "%s %s", inet_ntoa(nh->gate.ipv4), - ifindex2ifname(nh->ifindex, - nh->vrf_id)); - break; - case NEXTHOP_TYPE_IPV6: - vty_out(vty, "%s", - inet_ntop(AF_INET6, &nh->gate.ipv6, buf, - sizeof(buf))); - break; - case NEXTHOP_TYPE_IPV6_IFINDEX: - vty_out(vty, "%s %s", - inet_ntop(AF_INET6, &nh->gate.ipv6, buf, - sizeof(buf)), - ifindex2ifname(nh->ifindex, - nh->vrf_id)); - break; - case NEXTHOP_TYPE_BLACKHOLE: - break; - } - - if (nh->vrf_id) { - vrf = vrf_lookup_by_id(nh->vrf_id); - vty_out(vty, " nexthop-vrf %s", vrf->name); - } - vty_out(vty, "\n"); - } vty_out(vty, "!\n"); } diff --git a/lib/nexthop_group.h b/lib/nexthop_group.h index b22e083e6b..c2e4c4d757 100644 --- a/lib/nexthop_group.h +++ b/lib/nexthop_group.h @@ -21,6 +21,8 @@ #ifndef __NEXTHOP_GROUP__ #define __NEXTHOP_GROUP__ +#include + /* * What is a nexthop group? * @@ -88,4 +90,5 @@ extern struct nexthop *nexthop_exists(struct nexthop_group *nhg, extern struct nexthop_group_cmd *nhgc_find(const char *name); +extern void nexthop_group_write_nexthop(struct vty *vty, struct nexthop *nh); #endif From c9a164dfb5ed5b96a77cd09aad76090b435c11c1 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Wed, 14 Mar 2018 08:43:17 -0400 Subject: [PATCH 147/148] lib: Fixup strlcat and strlcpy to be a bit more descriptive When I use these functions and am programming on linux I always have to pull up a man page for these two functions since they exist in *BSD land only. Modify the name of the size variable to destsize on pass in to give me the small hint I need to know what to do. Signed-off-by: Donald Sharp --- lib/strlcat.c | 14 ++++++++------ lib/strlcpy.c | 29 ++++++++++++++++------------- lib/zebra.h | 6 ++++-- 3 files changed, 28 insertions(+), 21 deletions(-) diff --git a/lib/strlcat.c b/lib/strlcat.c index 8186304437..be211f82a8 100644 --- a/lib/strlcat.c +++ b/lib/strlcat.c @@ -28,23 +28,25 @@ #ifndef HAVE_STRLCAT #undef strlcat -size_t strlcat(char *__restrict dest, const char *__restrict src, size_t size); +size_t strlcat(char *__restrict dest, + const char *__restrict src, size_t destsize); -size_t strlcat(char *__restrict dest, const char *__restrict src, size_t size) +size_t strlcat(char *__restrict dest, + const char *__restrict src, size_t destsize) { size_t src_length = strlen(src); /* Our implementation strlcat supports dest == NULL if size == 0 (for consistency with snprintf and strlcpy), but strnlen does not, so we have to cover this case explicitly. */ - if (size == 0) + if (destsize == 0) return src_length; - size_t dest_length = strnlen(dest, size); - if (dest_length != size) { + size_t dest_length = strnlen(dest, destsize); + if (dest_length != destsize) { /* Copy at most the remaining number of characters in the destination buffer. Leave for the NUL terminator. */ - size_t to_copy = size - dest_length - 1; + size_t to_copy = destsize - dest_length - 1; /* But not more than what is available in the source string. */ if (to_copy > src_length) to_copy = src_length; diff --git a/lib/strlcpy.c b/lib/strlcpy.c index b7681754aa..b0c33ca7f4 100644 --- a/lib/strlcpy.c +++ b/lib/strlcpy.c @@ -27,23 +27,26 @@ #ifndef HAVE_STRLCPY #undef strlcpy -size_t strlcpy(char *__restrict dest, const char *__restrict src, size_t size); +size_t strlcpy(char *__restrict dest, + const char *__restrict src, size_t destsize); -size_t strlcpy(char *__restrict dest, const char *__restrict src, size_t size) +size_t strlcpy(char *__restrict dest, + const char *__restrict src, size_t destsize) { size_t src_length = strlen(src); - if (__builtin_expect(src_length >= size, 0)) { - if (size > 0) { - /* Copy the leading portion of the string. The last - character is subsequently overwritten with the NUL - terminator, but the destination size is usually a - multiple of a small power of two, so writing it twice - should be more efficient than copying an odd number - of - bytes. */ - memcpy(dest, src, size); - dest[size - 1] = '\0'; + if (__builtin_expect(src_length >= destsize, 0)) { + if (destsize > 0) { + /* + * Copy the leading portion of the string. The last + * character is subsequently overwritten with the NUL + * terminator, but the destination destsize is usually + * a multiple of a small power of two, so writing it + * twice should be more efficient than copying an odd + * number of bytes. + */ + memcpy(dest, src, destsize); + dest[destsize - 1] = '\0'; } } else /* Copy the string and its terminating NUL character. */ diff --git a/lib/zebra.h b/lib/zebra.h index 262ad2e43d..923f6f77c6 100644 --- a/lib/zebra.h +++ b/lib/zebra.h @@ -232,10 +232,12 @@ typedef unsigned char u_int8_t; #include "zassert.h" #ifndef HAVE_STRLCAT -size_t strlcat(char *__restrict dest, const char *__restrict src, size_t size); +size_t strlcat(char *__restrict dest, + const char *__restrict src, size_t destsize); #endif #ifndef HAVE_STRLCPY -size_t strlcpy(char *__restrict dest, const char *__restrict src, size_t size); +size_t strlcpy(char *__restrict dest, + const char *__restrict src, size_t destsize); #endif #ifdef HAVE_BROKEN_CMSG_FIRSTHDR From 51e01fef9ed0b9c9b9a8be7df73d78c925ef2c6a Mon Sep 17 00:00:00 2001 From: Christian Franke Date: Wed, 14 Mar 2018 17:07:11 +0100 Subject: [PATCH 148/148] doc: document IS-IS three-way handshake config --- doc/user/isisd.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst index 139d024e4f..b6989809a7 100644 --- a/doc/user/isisd.rst +++ b/doc/user/isisd.rst @@ -337,6 +337,15 @@ ISIS interface Set PSNP interval in seconds globally, for an area (level-1) or a domain (level-2). +.. index:: isis three-way-handshake +.. clicmd:: isis three-way-handshake + +.. index:: no isis three-way-handshake +.. clicmd:: no isis three-way-handshake + + Enable or disable :rfc:`5303` Three-Way Handshake for P2P adjacencies. + Three-Way Handshake is enabled by default. + .. _showing-isis-information: Showing ISIS information

O=|W00C+d~Bt2Oo1{3gEe*aN!h|I-ouuC8Y9%~s6n;1BCFoQulq`z$V#sXqxA zxIe&bAJt&gex!QN<}ZWTNegZF5%x>hWdx_3-*W5<>8bab9Z7u}Txp3rm|Z7p^F=Js z?+n?`d%MTxSjm?( z9#cx!3|!QVYU({z4`Vx#KR&GbWR#GukhCTjQ|L+RK1Dvc^#8HHm%ma)L#1@OOV?4#2!JYeMty{Ai{~Z zGjq*#&s@)a-{(2!dCu!RujciN@Rw-F^80;1pZB{?vCqMDaYViPv(lx+Qq#$E|Dr2= zRBpWjp5Cu7VwIoG3-fBZY+mN3u?zCb7LTL)&IB!uB1;8+&P*+Aqw-{EZq!;QB#1iN zxj2?4jb|8}&Vm|*ZjC`cv*-K)s}lFgX&3M2Qo ztw^M+HInYLLz3>zLow>~clc_>MRcxRTwFFRA3{sd&J$8!|LKuO|3vfu41-~AODH53 z^{V{8V=;U#6BX-rQLJD+M}^AH>#{n6bQGdmFPqHgA0B7}Kd>f`P98`M!vOB|dj}r1 z4;?Egr2n6$kqu|?V@_HxogVHG)={g+toD>m9=zfd0&oj0g&PlJ?=dh7lU7=1#;aaA zZg`DnPc!gJfq?qIiQ}0sb(VJP|KGM04lEl-(4V~FC*!zvDYGujcX1p0)fVKi_?Z(w z;G;|osx8D_79gJJ3aB8fLHFh<@j^C+8_g3vX0Y863uBy1)KCzB7DSiyI|cs9r?e{v zzQTgJzws5)He`KR{*SNle_LPSzr;8;f{VhkH?+%5?zZ>w&yUA_0^{*`bjU<|sSV1>5j7IvnZe|-w?qLCF# zeV=6P`LnN+^~Pp+JkeePdA4Ni`W^G} zUBR^r*t{9t_E?cX^R_u|afV^>NgCj1$ay=o_ah*;T6y1eZ7G*S$2B|j;c!UisCK62 zns+AR7l=&d$tc4`SB8N$!ot3J2UscOg1h4(`a;W$CWI-l$7-S;?+8r<54~ZV;s5F{ z4BTu1GpgCjOW_F9&j__en&BCKNWh1Vt5)41w>vzVKXUqui8OzF8|W4A{oi4R^iXr{ zdU=pyYs1iFr~7f2I1bnL(OEjADR3?Pt4&dbHYK(A{`Dr)Qn<69CByiol@_qurE1Gp|oNmAyg?W)z7lLZ&7R{U3_FGBCEsIva( zd&|@HI?Hku+}RV!qgh`<6lT0Fy7zjmZ1TChFp@a2a|Ifc9j4jG>7oVAe@t5YfW z(L$c$V)3|}m8Vjtn)kw$fscONtv%uw=J~6YH{Ts9u!z3k4|n$Qp1yOV&f8Y0%cs27 z(DEz)IQqn43HwF>zjZ=g@Ata7Zu=eZbg-rq>Q^saLF50$ijocWD$y5bm- zfzv&}9W(I044Q6Yi-Qig&qA4@wYtUYehWa+rD zFqm;qeipCZs?L?Rx@@P_Rpelkds2=;w0%n%n5o8jGk7ix3NA~pXWh+^@Hjcdq?=Op z{i(lhmI?RWEHwPOV}9h%JLa|DcFYMvY$1wn_lV>cldzAhJqYUn`@Cd z_hxHT7Bjt56#C$OIJ51wmdwHtf-;M~+R*}bR<~^>KGcdm^r#1`8^D0!6lAZrPhuY% z7jJG+*cq{gCPoEh5Uk@=^6~FyW1eeDLDJf`xl6`zBz8=WyN=Z|VoVk?Twg?z%OCLt z!BYGet;LJqnqpH!x|pCf9>eQDJpDjkxml}98(=`2F(t>aB2*n%*G(6?pWN?+T7^Tm z+CbPJPI5Mr5LTccI+fUN{oWl50FWFl`BAI!mAf;0+;r&VbP=w;IeY{bAFg{ms%2<( zfSTSBlMa=%jTn^IT!g*rh0hW^yW(#`5Mg5BK{SiClqMs&a_mOHGKjzo|O3fW8BXx4l&)^EpXjq`L910GoGvwN??4%4G+1Lwu0h7l0Oqv%{yCztv)jk$(GGeHm)zr}WR9pVu3t^EV9pPaOky_Z zb~iE*nzO_%mfwq2J<}-Nh4Kv187^yiTT)Wkrmz`IA9IC>{)d!?xGl~pf{y`=O~NO8 zzhT*VhTgIvQQ7Hh_uT={(RNZ5{JLYSc8N9XnAg(cEhGMK>oQl4#teQzet5EEXJvJz zHMsg;PsE^VJ+}=n4f0yC)aJn#X*+9U66Sk95+77g@6=P+R}$M`=}_2gMA6g|Wp9&C znVPcLr&H$k_jb3F##zz(Yh;Tz*MbhJB+A63e*wT2d0+FzYSiOU+Izb2^5}*F>((DK$P`#X{a3VM9J7LU>OXz%;@D_>Fyx8}|Ix%5w5=#NS_V zy#x_k5SYs+-J^+QVKC7gjI#X?KviILzj4t6kZ+&%V>dd0bL1#D965FS&`zC)=nAk% zgx@$*$U7RObnV5?vH1L_kCf7Mup+n9lZD_^OtIRn(932y3Jm?$R7}5cw$=^x&8KenzY6l)+I!`SziRnD=_l%ErZHDo zWa}^2)e2cLh)?FKOiBYp2lJOZqa{0L8^UUHLgJw_3SZ@s9t+U6Tuq8K-TWoF%8q2d z(@)A==?l!e;a>2SBGEA$LI^+jp+9G;z7epZ?roPAIYm0ZV%Q`Z=@6%Qn}s3zSA<7M z$%FqO9|Hm03yDGXc&iLw}QXO%Inr4^{nUWvk^SHYn!lGe{A`l-4sdjs_O+ zei`8dKu~B&ryT0(f!*)$o>p^?89nsCD|z|8vW6SM3-_ljQc{lJUPAH&1i{uWwZ|9&7 zSxZ(`BXx6|L#2C`V|!-;0Pn|$4_zY-a&m)5(v&#zMJOhj<(2L*E=tjU8Q=G^Qg^X!i;Ji_|0Hys^~arYP~1m*JYZemHpAMUO|{>)kl^-5Hp-Bg}sLrV_r&WbWP6rN@Y> zRkRgREHtTn?awB=_;g9z3Rp0JHBsGa@k;8ogTv3gwBLGl6lpQ_NtddPe|`TuTOWBW|5YYqqVo zLR)W*w%-=gMnedU1XJ0b$_%KC5)jX$=aejJ?C@I3=6w|(<0hU7jHQRlg2;|a`n9`U z+pfEqjF$zZAS5kSKkD(rGPjKRJFa$>%P7zD%ykw$=Mp9|p9N#AM8N`wzI!^h)Q4Sg zL)y8XI(Y4^FU4Fr5?AFjLmsL*LK+^Z38$8F(4T}Vdsi!8^MXW1EAiUAmsotn$&$T9 z6)B9H8`AzrdbKL=tw2AnY-EM&2Nal7t8c{xR6=HvtA>t~1<@lJ+P673%0na`YjCEA z>;TpL7cURfhgfQP$Cqz_+dnD8(|$U*r$!xCmO@ZRLQoRR_X&kwgj+tRP*8nTa$;&? zgGEgc`YGbAQn%S4DWOTZHqK|%3nunhF_R?d{lYl(5hr_sKI2C%M_OJN3|^5Y$zs}Wlo zyO$8X+{)X39VtBvJ&Vur;Xw>4`(wj>YJCuhU5FTc2L`u*ubOTcT25y-UK#=BtXAq(gMoy#(6qbZtHf$q)NS;~Rq04W;`dj%7!TnJDKK@g?JG zG*dS&iyWzUia{1W{df?wPrDm4z$87E>(zDYh<;-4F=)LYSvs*7z%Om1QQ%&fDC~Md z#m3OLx2cCN9sfpuSvo8iW$V*&6;Sr>>HD^TY8J20pZZy^b2PHjBtH^^8K%TakNgrVA>*y zKV19QIa1ASm#)^+T$0XMb{l<-m?qigw1y|2@tI>@G^5-#pdzCGrSWAY;_y*Z&Tu77 z1<0FQaTy&2o2*sz_dzYEu$L2aNuFYS=){XERS#YvP-BZ%9j)JycVdG^`qzZ0!eqy0 zr!&Srf=kWCZ_~9kC%Y0_Iv;Uf6`vPbu7+`!iv=^cC+7}yqzR5mN$K)o`&u4yS3O2P zQyvH9ic+L(7E^c&X8g^V?IPLUA=+N@$BOQYioUPt!0MY^ImC0sR9GXj>sfmApvwHa z8yfeCA75k_q8n!S`IW2oC2@Hr7nMRY;raV0j&M8Gv#gYht`kR~&6CDIV+|CA)^=q> zTXtnGVR5O`(344qy|`NM#M+%z#SuiJ02a!2@#>orvHIzE{s}G(+w5I?tt>h0l$?zy zyPX#1*!^VglOqo(<7>T#ZWw!Xjfu;LaXn_3be>8`xK>r*ef)V!UcD%pdU^onL?9d&8 zKcx-rY0|vx`A4V&o8%d45!`;$H8)%=lP0sO_&2k6Y7TkUx z2;oPEFQIdml=0+o=Sze>dIK-c-O+qsa?ZnCEwFZ)(l&!|J#%onh2xl$pz&6*i1 zls#spP}^2=BhY!Ta4=8BL>#vHbhOoSZ136R_&b))Ubri2nI8~u*XJT8)wgX1j&{DV zXS}Rv@7-x@e@Ty&zrl7@*#oK>KJU@$5mnAsuG9`1b_HGwl{|R^>o=vx|EF1N)8w2qtSa`Q=|BLq0ZDR+ty+>81LiXHi8hp)Yze? znYUVqxkdNl6*prm9WBZn^-A_T;!>Wr7>-AYfo#pIp3P=CR=tHXm-cAxNv`aN&7?`g<`C%6aN+OAFb?OgbZ?Qie^?=HLmGb1go`A|EOj6u z&`T$)oHwW3myV0OY2x&(bn(2{1ZlRh-TaV zaf&-w^UgbA+rTiq1`hzrC}br1Vem1#CM}n!ftjnu@QRxzI>rspwUCvJzs@oK@X4j7ugntKPS3xPo0D)^7`9EM3qW!h*FaBA|ze+yeadxtoq$ny(<=^D-9?@-j8` zAE0j!uvl{>t<`>AU0-5P+tyCAI<7j<#}Me^S5mU+)U`R1sClyEutFWz_dc1^Zn z*!$>PM?CZRsE-sfte4E~pJeuW;7Z^eY#ZFQWXO&oF3hp@T>JG7ZAr`UmmTttD>oMs57|yN@W0 zcUux@9XS>Dgsd*OW#;I}>9Sk0f zl`R?qM!vm=Kbdg9@>J5VGIsd=cY9nu$`d!w_S~wk6bgT+41o6E zR2yrL2m~I2M9PReQm2C=Qh7thJ>+!=}Ohw=IX(J!~i=~ zj&L>dYa!3RQ%vZ2cpVf{4hka2>QYAH`61Yb{D|Yd&2HKO*3E#^S{5slfbHF_<~!eo zeq%!CB}bnQEiETC&sT2#^y38J4ltaZ(ZUH>vG<|NPk0+#5(V&n(aG6N_=ls^&7Udy z&ikT-G$vMO#+)N(SW;!yl`{3rZvjx1cwcE@Q8#~X^r43`sVc2R5F$7@J{nN-PW-CZ zT0Nt9GtNhQ>Whwo@dHY8=-=dg|B)5-7jx@>TO<8#Q2alfB>!)60N)c{j5Tnd9|sK$ zJ~k^!vD+(&kJot#L|R}b9x{}sZ#7lsWbFKQLDt32U0RaD+%YZ_?9w~eorVG)nRlr1S=jJT zj1YLX(FVTEKK&e#{%Ywk@(k&SPgE#NgPTqM&^7z=M(KPVV%bq-3EuV%aAFw2gk!x% z@EAT!89ux!th@m25IP}#{k^A9yE}~#T3WaMV_$Jg9@Ze#sJ-TT!i0j2wKnyT*9?Cc zhwRnyXUgjB$~>TsidNqRhNdFv_Nkd%2tdu z!WQoH)LJ;({RFO+5SCC?dI{~)To@>;J?k^K+@?zbxf$wo_`@jx_r5FJMRECsIS)2j*l4Iv!&ygRy3_WLmi6|__0Ne}Wc3k~Ws|C2my~1$ zx3x7SG$a^yWC}c;!+^5aE@ueL>ZmjVODr|}PD<}Pc!`879P#oq&^;rXmc!> z>7qu^MqM5!K8^3wz$s;8&SfMMnHJDpw2dptAg|C-&=5fgVHKILk4smkJlZk%;rdTdqO6pCf;FW^GIx~akgn|-92Xf zwZUWQ&xEvzn!=SX`ZL+UWEhHtP!~U-=QZCVY9ofucLdeykh0u=ES4 zWA)1~{Hv1j8#ao+2EE`4TcFqsrPx!CZr%8CqV}Sec=!Ozt7pqKhfD{iu6vG}dCoWM zHaK+B5@s7YAU*mWpOH6Z5XEON6B+A6xqim_Pz;J09cESFUrUcvglq5eC+<1UNvA-u zBb9FoY2J1ty4l+KEOmPX>L+L|efOb@^UiQLT(h9k>!$>5;r)nDMz$h8@EwJ$d3aibwzjqhCyF>HHGaj!UynD4#&0QOu1@usd3^y0%5h=GR zH)UmguY|>MM<+8dZb)Nt?bph()W>4wES)>|%a6c{=$n(eVvRn|zkDoa$49~zzEf`A zM@e74i2qgluq5PabfNGEepbiKT?gduL!l?XcN*XCOWUkfS;N%~5_mLggt@J%*OI3` zFiMowH4b-Nr}7-G{B@(UyGzhb0OXLuue?FYEuPxo(aKnFujZq8eP!!d>XV=7=PG~f zQit*UMIG~>ikc;d376&@6%rJ)syzYZcfvIiQ7vYCe^7cX^>eL~`6slMfBf_HTAi`zfP zNc|nsc&$Feh`Y0b^yWWTsD$92s%!5q&9UIR2Mz;)by8u2xW4FRwK>t==PwYdYqp8- z=H1?o4B?B=)$i3wr7K;PunWjUT?QjKFn#-%y-;X#h6n`L-L@jN>f^bC?((=vh6)5$ zsw>sB&OP8Z_r?#y{XSZ5y!JLtXr04-K+l|rDG0-L)0L((2Nv?6gHG~Clx8T2XhyXX zrM{QT_I7-NI8%^^2G)2ik<|wR!EKt14yNE5N3G|cIq;8KCjU0&s*iLc2X-ol`0Mwo z<{$0M@~3<6IJ$5-#L(|wN}`f4!Mw)IfgT6NPPF!%<09~O!LJNP`5)iJD0_arKn|sV zHl^*#gzcDChKpzf&dwuN&d$lYL%)=!&I7HwkB-mK34#$1Hl3 zVRj^M5%PGs<(-9PHr*+1uc+XdsIgI$^rm+FX6+}dO!&Ljcaaqgzw*7;kuSR!jPF>5PKj z_EobOzc!jg8*ju>LC~HQcsD1@#XiDjUr?>VgA@+bRAJF6mm)tELvYOEE}goeY4q-I{S*;BMu+rnahAo6MEg0o_*NLkHaIMOK9enqODW7(+>qpK9>8N za`0APx`dO_v?Q|QCp9M9j{BnOdQ>_88k8VT1y1)i)i|HPkj_ksjSP13u*MOrB3LM< z*{#W9`$irfo9EsaHc+KaADETQPYy;rH9Kcfo-nljbJQyg=pl=Pi>czeKd0GDpcFmX}-4Q4a$rXs@f}(^i(nrQe~K@CYEG8RGD^0p~H*^GnTRw)7Yx-x*6Nl zZu`!>?^C>mgAk?0g*u(NEwP(gY=-n|)#Gyf=o$bBv;O}~B_SX*pvDUVma#-8uY1>yeLp46C8L|l7%Ufex} zdHVT?I`gz$f&JCg|%-t(?7DyF2K^u|V5Qa8#XbtBS z>niM>IoSEOLtn0YvZ^JeK zEkOOE7>CbAd*m-wKg`CCg4~nhVALS5P1!wCvf9I0?efXrAjTp+X+cx6C$VPROPKAk zlAYSxUE6uFts+Gu&H~S6eBIeN&|&?X1#tIr6x!R_uYt5Oxl?u7GfSMkp1!`{e0coy zevRLT0$=M5k(b2A5@lDV{RL>1$LmM}|8o94t040=kx4_#zkwO|-H4-xEMS&A@=euc z*@BoPM$eP}G4Xjr%6^#-5>;5OyL}XJC6#=VmBW7W;sh%sYBEwD8nCmwpk>%eOrGPg zPZ;RK8<;A1x$_;%dD*=%8WOeSW5&TJ>azA_osT!=_PAW(?$2TX^It9!e;s>qu{ovW z7H^K}+@&S&q+GfC@$r~*)?%u&5K^_?mq|rw?1s>ER3X@g0WWb^y7V1utnL6X_G*$c zjz8s&3$b?}6SH4)S@WJGRsMwq^Vvi-?Y?{d+}MT}YH-~8IZI>e+$=T02j0$8Jvl+B zwteUZ`oyGT=p<8)UuKHfh{X6zR~9ET!VLIdFz>}<`hiXX%cc1eGsOFIDjf{F!+~xB zsw?OntIQ~K?X*2Y$++xPO?SL^u()mLGI%T9B&;)CXrt__dn%itkdC{@k{{|7sohq4 zr0l$BH}ahb+`+_+_)8;`!oJs}i#n+dmL#&YCa2`_{0CZylwDr6a(2FMZo7@eUahy9 zM+DfOA@9Y}ljKMPi1fh4k3yLPzL7KRuE`jcX#FFCHwFb4IQvMG?MV7WU_8Rv%%(nRM_#3#Mx zUfTAsK~93kKtdg%4|i#QXkqo!MCa{(O})@8oYnQkhd&{|6ZW~!u0q6!Fb6EVw7 z7w{o66?S}ED%h5wZ{Lu&nrg^&^R>A@i0aNzZ0?6W4*`2%-mHb4)U zUA0gkwz3O0d4(U(t#rKf-onF0y_1u)W4FQ}@!D#+o?`q?8Eb>D;~TR>mJRTyQRg-V zqz6IqDEi8)84`S|$Rt(43cEE5m>f$IKb2Ewe2`0;-tf^NX_qY-s?=48;M$`@|JHW^WTx^mh^Ky#*mMsV*{f-S2C73i_p^ zczLI+3MRZCIoeYm#Me%xKr{**f9^EpozphiMEfE@IhmbJPV=PkVMNaYp_L%PzF9xA zp&OtIbC23p?vKJ(?yvPJ4!O*>2Pr*!%OvUbF(4>~ zZ5qEMz{IVJe;cp#dt&?dZ99 ziZuWJd0p6|YMY|8iF1&q=^_3=f8pUZc(?yur!2*L*C%gxRzz@W9-oAc2d~uEtieJn z_%2|757}sJ%Z$M#Y7Vd2n_yiwE}@ImNvp=2&wSWIaG7)35{^emeN_8;KVqJJ+d-zMjoGnRE zPqAQw|EhA1Xo$1(P=MZ3u&IyJQJeKuo6`A#jT?;2%6-m_?2sb^nx!p8+};Yc1S>{z zZ*aojxaG}8f5k#1BfAoA;eFP#y;^8ovnX>cv&J)&@PI>4&7vk`u}H7|ip~4Y6#m@R zz>r6bl!&c1XS#(i!M?@eM;n=oj3kRvT`c0TJN=EjHbEtB<~|CVS(fX9yfZ5~(^2qN zw}otfe+$W-NqvM0Z*0CSACdR&wg(V-arThcDq(rWPs3~JnVT5sd&DZ^< z_I{OOey@jS+`xk26Pb~sxLbIZDYq^69d<^FCO->iUb77Km1cGs>4Z!bj5S)^DA$hj zlUQ`*w8?#UaId1i-mA3V?$!5tK0Ei?n1{RWa+d8%aHuaNvcyTGw_Lo2?Z#_*#v&Bl zon6r^sVVZDLPbv21Sy)rH7?e|tXq`2;g;BfJ5-16to+#Zs}@ zaCBF?g--!FM;wu}C*Qw%VW0;oj4IlcfDsjDsb`W+&FBL6s{0p z07rx5nf;1<)dM{PWZhA;4mz`D- znvq;=@;H{cl$Qatiwn*-j=3E094rlKZBy#Tl!X&UQ|$^cONNax+#Xj2cdF{_Eb69j z4|nOquNKgxi<7jM(fuvQcIUYno5!Zt^Yx|WJ?DpX2D!&ieND$(DVETP2U-CJnh-MF zk*h0mZm4FIc5hP^yIfXn3gXZGf+pAf>kIAw>Mdh(tGxZ%q$nlPTfAw^aQ45{=Q0m; z6ZJ9cIFl(Equy1sxp!kz@?fG~t%cYOCFy;1ecZtt2ZnvX_BJs9;Tw`VOn8JGwyBsK z$Z=J>r4!*Had|^B3lq4_R|&hcTn`U7<3fpvs~Nh?I4nK&HIqg&&jg`$I>ruO2y)L8 zOw5Bi(0vmcW|zHgi_agf`N*;EXWq^HcNdVk93pXVA9a-{i(p-CX15n_+T@Fi#my~w zRPrV3t_Lag2<_ZWnm+?)#7O?~0!440TL6 zjAp@$?bFcH8zcQ^iaNk))4{;R$uN}1roQZEpf4G2`o>|UNA--@a8z+-5j;CD{o7O}sCDAw^Bk9d z@58jod@sk4)n{NO&=bG4bQb48z&{pBy+_P>;? z?Ei5)VL6U0#AvR!SaCRSo3plvpf5wt)aN>xfff$;?dP325^wD^dpW`g8kBH#AP^&; z3yNOJNPUd_oZ4J`YaUpgU9yRkuAF{UGP`FA$k{Hi$(B`~{FM^XD{g;I+B#Cqi2FWe zvAHjbhS0WBbWlu$yawez4kcvHBVSUq<5h5NZM<_SB39DVnF)!ajGpA!I zp5}*26v#+Z_KY}q*{-86iUMRbn0~97_y0I!>~;S=q7n3FUrTqxhBC%oT7>iBeIAFY zoAHqeUwBxfsoOS83ULoHH{xEJD+doo(qiTJQvmsRozodn!}lhZoW~zF>kmXCH_v%& zN3XRlyySgy2*~{<<)F4$u%$>-)&2HXb#*3Z-b#o6Lej6w=*N3wCB5Q>A*$hP&SeQD zup-}t`{O|DCQz~8ajUj`!2+mId+PHFkW=s>Ym>}9PWJtXKSrZl?{c5FIK4C$gxdre zHv9E!JGJ7U;c>F8z!KXN`UTmZL3Uy35iK(nT4W`t_pHM!!AFi2V>Y%^-SwE~ZP*i~2JUeqmpw5vYE8@y4nd%7^a`|jcj0|Y3L##74^DZ1gScol-J7an+ z+Xn3RGbk_%hMXr+dPjH}B-kyIiCGzOkI%LtIoMEX=7h4a9op6P<+J&ST52H5Pkk)mHXpa}X#M1CtI=IXX3I|+?r3UaJZekZ{ zen1zpk{*_?B?-{K5ZNsDT&`BD6}E7st3+A}ie$ar+vvgby6?J|iTU#c9!E^a=eSS) z^F;+Itl10Ht@T9^FbT3rf7DAB1tEp%Gw4oW)5%8`8ju#Y&gd{cj@IlxLw-$|{eo0c zPa(?Ix@1br(rssWx^+Og=T`jc=dw>xVcg7i1?-2MGP#Rg>}0UKWTQ3=BP1oUdC5K< zv!2`)KU%JRW8f7kYw6rgJ2r$E1RLaFJz7NC0WP6fLrD^9^Sgn|;r}dG%5`Hb<_u%j z+|nt@GdAA@;==qUzwbpTzzS^yYQA)Qb;hpPWKnD?DVD~WXt3K{jgM)sjK<&wgt`fY zb8DrB#U+Bz8t2A`Er}wPJ}`D(=Q>$CFy(Pdfdi(!A|m;^>uXx?;jzVKS{>2@ja_-YMb3xg#G?usV$V?{U$Ag`ch@CsVtVe;c`p}W2PGHEln#+yaDYP#0 z)n*U#y38B3l=Dd$w6{MWQtDDpnw|BumpfUbO7JOZIi62ysHw&vuVW(YJFzz~eeLzK z;UKLe%}}+aYrJAil_JDV<5g&`LWLcnuEd_sx4E7TT}6hLI-?z3AR!_&?fG+r+TQc) zf^M*;^ZC>&mh1sqUR>YO8#-ff!TTsDUj?cO$P|EGn7k0u&-eO?HQQaI%n#?s9|We% zzWCI~GG$AsUGRwpU~ez(c~ChA-D_%h-S^|bg8A3&Hh;Kl(dAY`r9a7syJ4fr$u#lo zB(@I0yS`q{FZO%dY?WqW=*g89E&Tkt)mjf$ z4p&JTt%YVYg}cNw6;JxgBBU(y@bL2pUnJKApD%LQ?qi-iKViKg+|_)Z_zpP?W9+u! z6UnPnRV&Y8BA7C%^Cwv%YkW%{y}KZ%V0PIl_yNf;-z014$6S>GvBx*iHg&k}l*ArY zaY+u_1TC%mJ9-;@fkhQfXWzC;mmSqP_rT%V#Zlv7wW!4>kJ<{%@48W&k{N*)n_ex! zAxTg~Ol(M0)38&rVBmDD)-6uCIj!q$)^_=ml4lHN4g;GAKbK0I1Nr>7ZLWJT4@wxP z*~**cD?SyckebG#{vzo0kC2}T~QVg^N?EI;9;DT2&kjw!q zJJ=~8csnEwXh% zFV1&9TZ>~i5K>5W*DhLMLcL36b(e`^&R|mfE)r|}E)sj}*+e-0^7pA!S28ci{q6_= zGG;5ndw=GIe<7D*_m_-H;^CQ<3Cf^hdvpB8YqocCLvnj_^|_<= zct_5V5LC4y`1(W1^Y#gsj3q!Ad9Yvg8O&?PF$GXQUTR!&U*;l9+_{iZE8IKXJ)bd& z^XK=gMnK z#S7{kd#EN(Q3RCh(pSUwJ$_!llni)l;KwBKM9gLjx z!1Z#^{Yup)x4$3i{++z`&&=KbUtLl}W|<@oO_xX8nfmf0XQcX`9FDxIEV!&Fi!~LQ zW8gcjv8XMYbFi6SvUN!Ot`5^<@tIdfQ)gC#zK{6-&)M%OiUXg}pW)2^8(fmIRla%x zI1=(l{^N`XU;JF&2TCCAX7LYVrAgw&mQ&L#hwkUD$WM-+ixzt>VvOQp4|R5%{>YtC5D ze7U!=3*M{2N9`ypq8(TE_dsTJ_Nwvnc6Y5Vkp7Cjlk<$&@#Bxq$4Nvs<`;4cJ&=6P zmIbIFE|>F2D6BsWDr&Hp8`iR2eCs_%U+gK@0noK4lxKAZ* zZ4%cf1$D+y9=@6i1u#W6cUkxsugPV8S4q8hoiRPyvGd`Tl%JbR?mC>y#i&(+5&VnR z$E}Vut<(r6O6ZlCpJ9;5RrcfX5|YGof?e?0@=Efh(CK1D&EDvCY7GTcvsDx)Y`@37 z^5yor5y$fLt#a3?cVsySGZQ|UDrYCXP1IA!Xv0Iks9t2}PR%WkJhvPS-6qECart`u zcp+6bF1nXyRG}JXeJ5-%;l7Ae!SKxWO-ZMuQzyhFPVkE0>LF;x9Af=w7{&g^ve!{a zc=Eh`aha}7`HPy*ZXdOnErx(%Baj3k>6j~VC#rOfFi+%C6&qXxvA%1$birNQq161; zqLzUrz3{EJd1)T;7a{L?H%H#bg8YDD4oSKLGsmvkr78!3yH`^~YpcD(H&I`YUc7J~ zQ>ZDmCux+)^dc>Z@&%#eiaGO2^1K9VqwKHYimTxvhqfDCQo34YyMGKj18E+V?i2jH z_G1TMOReal^iG#%jABd))oyHL&M6BNzO*&yzEMP7raeU9CjF ztJOhQt0NA;B6z;C)BG6Y6XrRzh)O*9!OhH+1rW=b5{pSsqs?5xx%U+{=NK`ConfUI zYOY)W#va^@BEGo?0I%tHAZ3axKwU`gk|Y5SC{KGZp~U$xQv@T7|E8K}@xkVr^Sk8_ z(8{x!Z(G`BB^hiDD|`qriN1pv5L8had}#1ZYo8^aWWo>8zQO zE{#PdygcJBkxtZ8xIxYAqF7qm(H1T&yMM*0Rq)Ip$%Cu%)6|z#B3*0>Qu2*;LZ$Li2lG!Zkif> z6UdlDT0}1!bKA~ShMc4kH}#a1qC5k4I5iB-wO|9tHfIobdIZ2pI#z_Xz#!hT%xmua zuyDABoq2tBhx4(zF(sG&e$#cq+X8CL;2((W8V}(G_BsW8B3|cR&a9y>4ndWUZf{y64A!aeT>U{VwCe#j7a1=7ief`PW?RB9@C-6E?_iu#qumpwgA#I|KB3H1Od5Ng zCG6{e1{ZE{bsM=SpcVJLAnl1RO_7G)sY=SOy6a`M>G2<68FtUK-Z^U*`0m%6B$Vmc zk&uG_2_+*JAcZ!SSRcNVUG^%I<0L;v@6?MXm2)G35<8qtuI--Xs-M#DuY9`vRYUU^ z`U*g;(;e{-%#1IUi8t$*hKAKJ_i)oii1C>iMFNbcHHCgOxy83AHcJKNg#Pdn^ z>YhAyC~0_E1zT%^#;YIC!PW>p;F#4h=jjSBb<4BObhE?(vUUDbK zgq9h!xK`~Auu3C#Jr5t*@VW;41b`SRL}nuk%9)4P*WF(?mYZM_G}!kO>y+dlTSxaE*LV19p2~lyk66`zEZ|O0tGIpUEg>N-M^`u59OZ9FoEhtqbf|g zj^67VvsGQCE@CZJPBD>o+zzf!x86JY=@vUOc$l<)co*{*rjIY#Aq|9IEPEpV%(90c z{mrsB(b717W6X)2gf=~(_7zOCN+ z$22Gagl;AX)7Y8oTtrmWWuw++ZX3AydPKnZ235DtMl)RDY7|Yv_mzQ@@V9p!1(FEV zpfmX9)crluQ$22`T0%`j<4hgPv^B>h@?oOrk^ElXmcs<=7#i~_kS}pAlU@6Dw zK~hO?)1SioIn2LZl}bq}NjQ!|x29XF%gj}pyy@KBc$dsvNtvGU!rv2i%lMk^bmy#r z{-)xzf8CZ(Z|B^JqO9~qgISSsdB-iQUboxMLsTBrY&vvWT+E+|YmxS)dtPnj2JNgN z-VYi<_VJa>2I;@~n?Wykzd)m=(Nr}TNm~(=5!G6X(Xp;5Ef3Ec6+iVZZ^(tOQ z6=*em?OEI}J*eusH)mSX^#ORDJihGVqMz+c5*n`Gpb5`~gTc{&IEXT2>+XRYb#nnjgmy?JR?9Npvl&(%>rR-IpkZ(%*Owu+klgbX!&H zcZ@RSw;t?1Vl}uL!D3)0UeoRc{5W1tD_)u2R`QNHYKTAHm2${oo~^$d{>I*Z5^Prm_2)%&U8? zl2`YprL(s4J(wC=oMRK};wEL+jY`5s3vZbvVcYK839(^NZxtSIfOE5gTZ}}HAk9N7UjuKFI`bY0wQ~9wW1i%WH7ova# z+@x8ss@j@o$j=Q>@ix$}Q04E6-F6rS=oYFH2+G$<>~OqNqe&Hq1=bAa`1)hVoSB4B zxs7puyQ)N6n)j8Nt0qfMliaV7=qx<*tEkxuHVv-zCeZ4f@i7}dtjEHOY?rJu+PynPFzl3R1P6D+DMr(!NdA)4!-$-9;-mnCV-j_EwW+ z;Bn|}gl*9C2CGDEtTnVJZ~E+Eu{NbjBWWiaK7JglBT#LeS%&Owh?L;U??m6==;$Ve@#^tFC=6RJ*SG z54JC^{90qSW#W`=@dt8Vv$K?X&FAR<)1ia4c_sgvtF18SL}Wvv6EFe#Jeeirt9<9n zvb<@?>qY*NA)gS5qS}%daVB-Kww*UCyN`Or>yAX_+^FK2p=>jj5YFya;}t~>_+@c$ z1#o)HKmzTJJ`Dw9ZT2T7$7g7cJ)rs|pmmQz-8R~l^O}m7{Ri3~gVKs?NnFZhS6nZtO_eHNkS+fx*U1*$#UP;<@66Kie#;hM$FdDRNw&J(I+Wh}-ETWeX zIumm&h|gAIw3HKRT4`!=_kBWTDoG>zzLu^NvrYZEE`{tw+ZFYm2h`}n>HfkM)r#LE z`;}j+u`(z>Q{jlD|{hvHyc>ljurv^>c_KR+1sXuhBv9CK8>j8pNRfQ z1#E*?nkUG8hKu10%n`^68aGxc=DuV;3VujwnJdZMJCkg@2u-yXU>-_A5SNU+N!DH( z(6#^G2L8W_nbk12??0EfJb%0+J3ccn!)*!2_|WtJZr{HL=fqI$#CoEO7aB0|v41ol ze>z@Qsy*)Xn&{oHdwt(X6cQA4LMLD5PCYQ7Wt#Zl&3(cw^q!KQc{auPn!H;P#g_zi z!$>`za#4c|GtJBxvuP3jSFT0w#p?i-ob4I+_H9q#LoJUe!G)Vn5!H%D97VK(;tOLC^Fnlv-n_m&eBuLR)34e*$Qis0PeJl*L||T7pv0sz#fV3pYA-Duweg>RS`9}JDu;Z z8^P1I4|wqU?Rq?r%*R(!?*w|De307-zx7X|hIQC1eptL1T+*g z;95=omS7vtw;ut&mAudj9$R|dm`nxwbq2G)sWw{g`Ta>nXNyJ^uE*Lgj?IvAl5b_< z!yo-d4EKP(jB^I-=Q;O9xBR^_5;4>y+}^HDT2?;O9X z@-D?#=ji@d*+~ttpuYIKG2jxs-C}h-Su3OD?}1I{5BjsEAS+Oto2BzT|@>5|~Z zixWCB>F0lSM#s_h-yK2#V#YgVgyaHtUjM#1#63<4lW=yq6C6hF^q`6K?P_8p0j%Op z7aoSII3LJG$>q(qz}ZiUn{qH@B zzJOHWQ3=uUf#cRE$QRbKd+KtV{_|Bm57ONu*W#VPLHB?*yCLfbZ?;3%s{50Gg#?X8 ziFd0h--_^YhiVO{!rgBT-}lsEj0259k}DCcx!aO?i(D4OCq5T6YJ+5afAXX70fFZ< z{mOizR*iVGwx;LaFY8gXlOa~Y)> z1vYzm$vZx+-7Uw;KbR0V3iIDI^2A@Fq}QFmR~Fw5c-vI02Z>V$?(3K*RZCDb<`Rh? zW&7>~nfYq1oX6K11&z2=%dTsHnWvXLbgDdbP%=Cs*maK=32wef+X^Ochy!HR852^C z8*juVOxU_=X7$-?uJB-{Byyl)hl3R%4j1mZ`oJMF73w7d$pr5~wal%GT^R;bHq+L) zH?47OEafSLiCfG#{Fg=oNCTAUYF_PF7dfQVt@T8>!=56p(zxDXQXPj#tT;C{Hc<@2 zTMRcerrJ>~C)i`~75L7Hi_Wtevj|6UzWtraThnlNoHEtZQ=v@p7ex~o3ibN{top|5 zxxBdipII;aLlct8^Nu4o^~QH5i&x5+@LTf~6JnZmujQBs%W*#BdE@Z$RXyIG3sHq? zYYaP-jTc12J4Gahi$4N9?az%W@lm1YFG`6kbX6NYOZskk@<#veLASlk_RW-+ROok< zMbraA<5v735(|#p?k4D@-~eTNRYe!IgA6R(U-$H;VbfZfzd6Fq#_;Y6!i#vi93qG> zR5u6R$#>1sl*!Y4eF~thZQoZNa)ybQWb zzxEb__e#9o2x6&2zF5d4Ri~?Qa}C5Zh@Fs3O)T*ID{%VF>IkDkiD?-9sBaG^n~V*T>2n;bcC5!(bZkQxsS zSfi9X)P~i~1ZwN1>_xS|Dha=->e)9{Rw`8gr7&$PslMo2fBJE(3M$VtW;r@mS=!Y} znHs?Yne@6?wBx%lSmn;a&QxG|#v9tF$4?=5;q?6y&0fvMast-_Y76e0JYvV`w@{C@@xUR&O`L?<)Zo zz1D=Ez#MZU)XEyZTP?KtV5C?2oXo>}VR6$lJYi{!zRXW^% zTo=%)M&qvSc|ki|riTE^aNQiAxgbx|v7bWRV7e3bG48goY%5YrTH>WzaSWHN+9!2Q zt7mR0LBnsfyo)cdYJuVy)fbt@hZ+)1fTM;zFqMTdq_WU=Ot%O6hjroyqfJd`C{rLB zJL$^k@RZraYTHGqhI?{k1hJb}V2GM}#?lKqiQ+0+o6^|gMbt*-x7BogG&fbJLtT@I zd&tftrQSN>8%@y*&?PGcea*>I{TdLTu502Qwz$q!?}+5momzkN{nV5e zv$vEQzBIdD9>B22w1wi3yY_7?xN3*Qgr+PcZdbWwnnc2c>7IBu( zq6{1Mtg$g0E~$PQU9SR9cn(1$r@obbvf~ET3^B9QY{Mz{<81fb60DR)xfbRgINj1L zws`Dq!~ytD7wn(=P)}0=a3_Eb`R+$X)$CTk(`}gQ7YcDBzO|yI8(+5!*z6S~SYeyo z*Ve!2U)ujkBz*~MZwedU%U+wdT=&dWVYxwU)C|y(6D2N!d+OPtNAYD6)Qc`ZJe#)~ zh%;3+hbAv%@!p^`K3|_h=RTQXzQrf(NhRNF$5GiC-kMIy^v5@4=td2GMpkcgU2qEt zdp_QfrU*GyGOF(aVvF0Qgmy#G*z%a?rS%spsux#=28?48pr#sSI`_gY-)nbJNd_{b+3=GsrojEngd7WK zViq>X>PHcC_TOgwU4@V7#&A#M-GUNzwhF2hkt)WFp~&zp-OtB%8h3oq))EU7oRz~! zhG>nFj-z5m?u&~`aJ)nP6A_?dD*Kp_#V!wh=jY&rG?e$vNwU$?diC!U@a{JzucRdM zcjmDx?R=1wR|p@s%l}t~>W>}<@Qls-=>@R|iY@%#xdHxZ-1thyFq^p>A(~2k=>#L^ zldHJMll9XBS(#m9rD;6*({@&1!7RHN19ZG{{@Bcwjs3t!@W1b6M>7p#9aBBW_6OlJ z|7Pg^HmH~|u)+A3Phw-;>6I{g1!?{5tp=xl1wmF6_k}2fPgfsC+%Yn zlah}{aj7*&t!_x_Npoqtpv_{|$~HHokL09vff9BiO2qlhfBc=4iO6J!e*-yR-~6A7 zY<<~`xBl>F`F~WFY7g-{5`xda<~g`0*K{OlRea@As>N*xw>iUrJAj|ytNbm>`}B&S z57}aPBmHPW^l#kp3BV#)3gE-m5l{X>>;X60&10OYX&fG>G{lzZg$DJ_ezuraI zx;lMxdNI93>)uGQkJ-*YVSVbdVRbr;>cK?W-IW8#B?G$dvBzPiK~#tD;-|?_a*mrs zVRnVo2G8?2xj1agVM#I>)Dx8+{sAldFb)+pF5@;Mxmm<~BP;ijeW)n!Q-yQ~xw}GQ zim%?<4YsP5(e9Nw?5)nOoUZG+(^(G(=l8Eo){ncU?`EYvp}HFf%c{eVggun(j({55 ze?FvI?%?h|Z$&d&7vhRAacI6N{c7@EIFkQM)V$xWI4Yp6@}c7e_RB2fm0r;vx~G22 zL1s)3Etn$AxR017%o?P)iI`wdb(L(;ryO+@nuv1fYzpTwRG zSpORVF7XOgZpf`L8U|V=>x+E&3o-wq0fex7V}53=7svb_{hOk47gaYrFa3VhQ~hMu z)y>vee+i7VX88Y5V2#Lo5Z5z*ObbMKGn*?{@g8+=Gp(wODfzLiByQl!FDV90+c%jO z>Gd9yeLtJZTGf0F>>u{#+<)!c)v!mt8j-T1WO`mf_x2c^K%Ld(u>&7yMn6310xEjO zxY+9f+YaMp=t7MNG4Y8&xKzUI&Ge7n;p?YrYzeYfK3xkwmc|#trxiTH4{mrL|HX6F zDhgBh^SK)QSG#jede6h6D?EAd?<&eKqFHoO*s@;`+5t0#?LlC342V78ec$%j%vkeK{;(WA57L#t62=@ z)P!_il<5EJ)>b(AeO>3EmX;`OuFC8f7|jZVLO@v}7^Y$HUiRUMoxA$A zx95|vl2Lj_T}EgDm|sWz{C&+rDh#Km%6Ykhgo0F?B!NX~DyyF@8FveTjW$Y8+F$As zH$Sc!%>davoZhs>@5YXy6y5RSunBR2Tnrb`Y57ubFj()QS*5sDgQZ$|rdmPASd@^g zy3)cKAwl3fDLuc_LW+`ch9LP3F(6jU6+TpHdghAXZNd5nfhJMQ#YM!*?v;rK6>q+Z=V&}` zlSuLolE zT1mW_*Km=?8~>_x+N2Uh$hkI}jsbKD+ZZ@J|Lp%_0la0Aa({z0?4Z%XyUrpdcd!At zU*_z!nb)12f%Yt1hs|i993kH_HKN_^HbroNH3_KasE^|QDQ8q4n@AJTNe=92fRYOC z{^Zz#fHoZ;?JPQ;o?xR+iP$LLBlHeY!1wfC_`+Smpi}HYI)Rmxp=s9V_J=3#1@t(+VG*|`FvgTju&WC@0zf000iOGALyhy*o9UhMr>M|2j?K9jnIHp-_)E-@(CVx5x?Mw`--*gU_vtcqos*J# z(M6+-ZOf;o8LI(2LscMm$QF4OscD)D8zdh+rb!pWZMO|;$#2#;eQ2Zzdy77MUaIm? zf#w`#V^fLmnm^6Rt<~dXqTrJsChW1WU?}Nff4gU{-z{*kKF{+C*4C9?e?!ER@*=*V zam-tBAAHavwqhU5v5LIHnoe;xiEv(OB`%U&>%uupc0$}TN5X(mi@?FIR@a4xA0uG{ zLan0wX~3B^M#OM|@l;UveV@)f)$Pj=>H(5AFq z$sdoAo;dmEv+K09#2h7lt*DD8EyE$}U(U|dkBN?Oy<_vnk#?b6tK(N>7lj_=)umZO*7Sd5q3RbdsiEIp>6aNTr-gjC z5fO_h={kx_O{CAkqngf>v{GDZK**Ds`mNS?@|#<+SybD9=&r)+$}c6ZL}fkAtGLj; zeLYzCWzJfo^)EHoBWe3JkClt=Gia6y$rKj{J0oYmPWwXhX+}{erD`$Y4+|DJQW@Du zhX&%6rSP61Z9{MC_1jZ(teku_b%qktqgw73_KvM4u9r8lENPAHS137^lT(`@f@~{x zItaPLqxUGsf<57DBYH8t2eo>WAZ7I`oRgZmZZb%YHI4^nY#M7CYHNbt7dmp-#Lpzw zoB7PS7zwbL;vth_6E9MBsx;r#wLVNoOgR**&tI?a=PLsp)VP7`S{}}=RU6y06rx&A ztHXgiQ@(=RQ@&{!&1sBNIy@s~Yp0R>v=T(V1V^A?HX{DUY!VuFdcJ+>D``~F;7w-c z^>FT^S(dHmKk1#Hr@B`??K(33>?`DS3$BV1Sil8$VUBNG-;DgFN1yi&I>ORAj8eIih2)AJ*ye zrx&=q?EUOU&&}ngTobkNb=Mmh7ZcPL$tmU1dSd)sG*fEY0Y}scaaVFupPkGu1kXJ1 z?2daj4?gl8p7h}GWgj}e-9v2KOkBn3+t^Zv$9i6+ROdF5+oHzXps&NE<&3U5J9~7? zHZOh5&CE=g6jQQI!gKF52TDXcKpnK9c7uwSdhL6ZR!KA}_bSRQmZi3ZXzA)QsMhNj zQYyQWZ9#UD+R_~@2qh(k=PYgynQhabDiMRrRW64(muar!OUtWZAr#exab9kz5nmCT z*3o+50kbAuW}dn30AWW#QJkc0z5xWV(3KCcp*HV-zxIudQm7Z_IsWFc+wQ>;Y@x6! zR^Q zm5BOv!{^#~WDJ|CfvneD;Ma=EoR>?B?tXK7?IKqM9fv$QinZmtW6u7Kp^WX*Ln+>@ z$CI7R5rwbQR(dku7qp}>O7AabPVu`BPL=HIv_eNKVQ8dvWj`}|IF_rmu~=yBBXP@+ zo_y@_#Z-cI5S58lx$UnU8;SebK>JVts^xSZ*@bBVS6$H0wx z^(q3laJ1$9NTq!z>?aE({z<0~Q6%6;yLYI{HbF`^lQCBntaaI6+cj#dR(59BaLYQz za$!Pi?#oDs>Q|d|zBgeFKqX-dC0iH^G%gz6ClfQxnRue$eFxwk1y4hcG?ls8HCCj? zTQB#q8-d>L+;tuw-FZ1J{&OA0xj$o;RaY=Q*in^}syk*_mVk;clUl=M&0{y@vgG!C zCyW z7a1HtcM0zL9Zx83)Sz5UidHZPT=ERmzEWWH&{D@)rkY|Z!p@~ngivIEg|0U>)+;)@ zh<CeT(x#( z0#@w7FE$Utaka`A_+a~J$gzinW%rKw#@AM<6`HC=*j{Os#gH$Hjg*@C^qVI>r482V zU+a0I7)FCNR7|T}#mstTTO*(8=415JU1dGUeLizu6P=jM2r7uI##|p$ljaXpwEIFT zV2ucd60obg-h`N4JY;<7?!JqwN{#{4h?pa}`mE2e7z}jw9>0V-=-*v;geZ{IxyW4a z>s5n8|vxBi`7k9IdT2Y2Hw?!7kGh(`rFo?XZ}uf3R_FBBk7h!vlgj`LKX zrL~xk5G+gr-7i99l5H28V2i6*y<@70^JJ$7%R)66jv6Y&Qy^f$q4>f3_R06UlOrVr9go+ zO?}%vVmn{t)508eh_VJmKw~Q)V~&P6ZT3L-^d2<-229L-w7xtAaVk;g6Nm$N?szq= zME72ilY7J{R`?0T#a zhdr~0wuL&N(9?JNEMJJoiQU5jLC^Dqsm7P)aEbsq`$zHYgsa*|uQflyeaj^M7`pIU z+;9ZCdVGH?Y*B+Qib>nFXeZuY?;HEHK4u46B^9-ZOq24RveS;8S$~R>Hwa32?nMj6 zBd0R*x81QGC1|1r_e00aW%wdT`q&Prz}qF4!nirGLms=N+~E&e6%c=M@Guxtr8Km! zR)&;d?INU5oOfVr@1b8iteCkYO+rxU7PVNloK=b|xyOA7m zi93@iNYVs2hK~EKWLC2Mm{`?xm#sa(1RE0!hekw(RNHj?@L-PClu^7Ml>2su>*r4H z>{7a?%~-+H>$c{bau$q2NAG!cV6{!t77w*>_Af6P!;ce^x9$l$mtjM!E*2iY&^G1a5&Pp5|_t2xq?C#10*Jq*rtD37$R`mvaWhP3O#-+B;%w zxyyKajAm31jZtZ{O5jcq_ zF4PV64U>Nt2^o2zo_`FQN+na#nC518@p0}_YEp@_7yKi z!UY~j)P$wkUP-aeX~Wn+hdozmd5n$PzN7e@*_vKEC}x=CDR$fCG8VopB^-&_#x&T5 zE8N_+6`v5f`D_U;AoS=y#j55g+nG$~vTA30Q=cjBIqyZL3Uy_~TK(lw1HCz^)wN&h z2UIz|CExYw>0Sa!@xV3uQbrpdtqC zl$z(#;zAB)vICA}E2Qv0N|d?ab5zH#H(#evZyZNdeiaCMyVgoCTki5m)maSFku!L? zvTpCg#|i3TlXUpA_A*Iafu`n|KHZ%`1@x8oOpy)?Gg_P%c9NRER|UlmPZo56-k9s) zEvkcXIenKF3C3#^DR(PmAuGpgrYZP#{9Z8RTZp`}EHrdR=~a`dNuw0YT@^c4zKMZ;qISp@=l&ZeC44Um80->;FF-Qe3O@bQ4JZ=X+t-pfArJGtMDoEp2j?S2mGgYZJTo5T%7b*KDG!q}Z;Z4pL*6)tFN`j^@90e$ zV{*Bw5@#4PWYbEW`}*<+j^rU147%Pw*``}>*T|O!DAxhf!|{7sVPi+Cf~Aimb+gxQ z*u3ZO+$XngZTi5F{n>#}AT2QwfbdV%lbW>F0T@ zm1=Ltz~f#MGn#*8FY=+rwX{@IFto^QU&qXS)T`?h7tmm8^X?KdLx3dkbgGg!eWRsz ze6957J_bGg3OS1Ya%4zD8?vlMAWn3B7~cgpQzOqxn^A0hU@azd`&+`wBD+iL;7d|7 zgp00NVG7pCp9iEw-ro8n6KU@wrE%gSyTa^7DDgd%IRjS{b-q;_(Gqpc^;+qU-P~dL zbFnB~Qa$A|?i_gp6)fS6T{eVYnoLIp20U z%Fk(%0Ga7@u{jYF;2$7o3uoEBZd^(nu% zCi8D!snq-A;)O1{Ix74)HoC zaeC@z(FZK(VUQN}`_`JPC4Dr;`yoL z*!8Qtsg5*2QdR2@^znB^_JwqDuY%->;r12)PU@r6M2I~ zw&B1J;5_&_q&TkX2_%*h#~6O}qRMt!0z-~-L8#gCZc_|wmg@|{~(#u|$4ISy;` zuUBb4sg+qgZsH;8n^sgL6CTtloM@knotiaj+~V*0Ixv)N&n2d`30t;D(%Jl}%CBO*N$B_N;n4YlIsSYtUgSRr00 zK31MtC}RC;m7@r!owGT-p|Y!r`f|r{&u5a{AFLPJH#r z6(W%C!In{6SEr%jHFc@#5;8&k_M1t874&uy12Bon+KJZ zRJys8M?K5W`20{}k$JXvXhxh%de#wheg7>At&%KA4U|JH{Pc8Wb3DlqlN6;{6NP`F znp|4+V)4HLvyI2z5z@G`vVx=sa+ynmPKI{?$|wNXvA?<=DpRH6dAB?~I_|x=bBAcq zdrujQL|yfD7pdcSDO{x4+bX_7^ohl6y;uMucB6hqV>UgvtkT4BFrwxjn)lf-3}{#% zlRTD{cyHkoZE9EQpn_5Qrjx$r?Opqs5SZac4D={sx5c?Y!%09tTd5bJ5RY|uJL%5W zWX?Wj8~)~H-ikdH1Zw7+6Wet9u+&~X5;Z;RH`S8nJ}nPtW0*H@6?>Mg%Wv(6 z_je?uiaFXLs(rLzN&PvV{$CPx4=UE(%3B-r?W3h^Wn8X+bmhoK3+x>TXS8t7!|?yqniP$W^A>Kvf^9o=r>>BljLjXo79(d zU5uL&4<8>~WS7|8*|u-B>bqbsyw0d-v-^ZfPJeNl#Mibv&WnUHt3UP8nvvF?$gEx1s8ZFHk+pVD)^%mfjo@P|)ZY9Q z)uI}{x1)K#pTmnxBPt$r-G0`Pr~l0|NL|RfC`?LR82>WjM%0D=wL6RjUPrb%1QGts zj@$}$QEfNY)#O=?(VGOP8CN~jPG@B49Q%>K?>5be>|AP{F2l+!Pd!6SRoPtl`wJ=L zr*o&kgQ#z;iRVvKyX1Q04k%9NW&?bWrEA1bP3C2*>d8?pOv`qk@b6NDSB_<91z639 zohu<9&6C7I1XW}e>Q#iMjk?BB3(Y}E2V)_FPrVS%Q-=s`ZFBJ1kjXj+nCqekiwPWg zq|+<~96MGlgJMk-mDy?v8m^#S!@P{mu!(g8q}O%{wLmeNrOgqvwV-7)tE*2mJDMYU zzEQZ^SVY%1d>nge<@y7K=}>jubz#->uJLg_g=hxqNtZyijGKnK<@1(d9aoNsJx#rw z7DdcK%c>jEhtWlXjWDtW_ffmoZ+0#E+lz0qqo`u^eXqI)OSexyn<9_gp$~so({Ysx z<(tWMrb95=-NQYwx#&|3-ON;lr>5re$P3PQ#Ges`j}OS3<`|AXnr@?weAb+kxOQ_* z$M)cCV~%W#pSy|zpBfpB2rO)g+K)dnLut6 zlPZZ2E;aAX+WY!QYx;X-R0>YMSpnTe)m+j*{vCDxj}>E)BbxOA_HnKMV=Ljm)!Y8f zM-A-`Ii0wPp1Y$L6se~a6H431dTg|qApL9ohjn$f7@|CB>?(c zhu;JFKTMFu``$jdxSz(S&GCS$XUOE>i(_dVV_#a?JjiU&LctYL;0KZap+4MCN3i;ypO5c@zqpFT5uo3(RNfT(@-Oo= zU?SA8_xoLBrRq1>7PtqcKdHnZ1HTGwf zEDy>EynB+~_A;OE5Kim*IeaJTlZbAwymU{g_D}Hyla(3m%VIC!6EA^)!-Tu7_=(Jn zTGz6`J)K#Vx}gGi#%#S?SzYC;Q;G7dAy-)bd??1SWxKRd53K`oc-qF>T`4ohf-hkr72eM$f=kU@4Mj+H~tGG7viJrQahKg zf@Y^z_#Xpd6#>KsWSL%9 zOOm>kF2nXIqBFC2{~0|cYc_~UMv^_q?Kw16OX+oir)-JkiSHQdi9{`@BeAf?0^&7U zub&)D?A_X|_}!LOK~xwuxj2l3u0mL-B0W3af*+g~(;Sq~)V3HPk?gT|e>Y`}&FB1lnGw zt4%PAb&*yXrrcurs(7nK%fKd!Nmw#VXvpf(d!)FoFWuIAnbmqwoof8`B@T(5WzRM5 zzM*=y)-hw5Y1zSP05)N==v%LB8B&~B(>rv)S$lhGS_nC9^GvW5C64GR+Q9BhZP8m# z?ehh&PT5EDj;Zx2iu057yhTp&QQP$$f_4sdsE7z_b|3P8IPSVKqlakGtM$XtoX~Z5 z6;!FI%;x8~ExgS(W+`EBsoUP3Z3YDoekZQFvs}`MJs=u;XW#Z1))^C0(ma#MENeLc zL)|lFYvl@m&i-g_Hc8__QF`v}6KKMnt6+-Zt}EPDIRcp&XKw1Q$dJ-&Wo}a)_)FA> z^=TTq)D%$SBWlxPk3Km!DQe(NEVnIx%WU@n<=RB4`W(%XpWJp;u-qo)B5lr&rNbOt z?!+oqZ1@77&YXsCl#<68U-ULZC{X^?^S&<|Hi$qf&;&bN6c4j&`UxzJAUio)q*?x> z78IGU2^==qkg~GUY7P=lrCcVWz2N}%^-xcrTQi5EV~!1p7o3yAP#uEV)iiGG`f*f! z%V(=DOt(r+2w8MGu(A4J&1ywW=CYp$q+tQ?90Bq1kk5Fb$Y$`WS`9Y*kocZb&J~X*41l zyx>eVarN*i5Uk@Jr7wPI(Aq9)yVn~Ud9MZF<`t%V)Z+@?LZ9%woL>{~@bY<5)qOCN zTB@u1BsT-AAO>Jax-z-6DUyqq(r`9;?Gz14Eaqdv@1$YYf$B40A?tUl^v@ z*6w17fTkCGCw-pB+?aNUztnl5GZW0dz&VJp#!Xm7)fKOxc0E=-e}0ct(|z72dAq~w zjyGyw?NSeCPgZJ)hw{|pRz5F#G7n>1Yl5YKchkn2WK6P<`cK7mXEf2N=D7{zhrSZA z0BYOwHWglE>H3t}VBa7daK0QL;r3FmDu0oscEaqVk7Uot(1CmtizT@w`SE)V;^X^C z_mdji7w$PJG#y<(ejkU|S&GE{u^h|J)3@!mm7!X3A1$~vC-%8!?qf}iEr$l);qseC zxe0Pu(2AoG?)%|@_nSr~QW8%u5n~=>ZfddfwHmBaM+J5*pZtD^7%I|8vTje7>ABo< zd1dKWyMKMWL)p6k_~o7Ec*dR;iVo8C+u|8J+XXo;2f za;qqbl0Y9o&r0?mqRO!!d+%Y>4y{M{-vC5?7fUHf!YE*6hxp$#R#m56Nxwq878ch| z!r!r9%}<}c0BeeM15e0s{Jy>*S5#@K#?eC@2Y(a=;qZPE`*l)gs$W$O!h=>)U)GTt zbrjLdCd!^j1H(TfC40qEyFz>EzBN1_$NM)8cQOFPZX$P}CHqN$isKqslWko&--Fc? zso7@@ja^62;}tMR+*ORJO8WBpEeG}4_V;4cV$^>3OphK_CrU_%><^hp?L=??>W=}q zlKwcC&j8%ff+R=`Oe3U2b%E4k!r>}P0SnJDCiU`3rzH(Zpwz-c*%NtE>s8+kFQ@dn zT}M8&U66tv3!Z*)+yL^3i}WbWmPyGCR^AZruh1~&3m(Tcx>}~Z=Wz1a*;nksRtjXP zsiTKKLjP*kWXzDa`*YSL{MT7i`xLAtaj~2>@zXj{Q}?aZ!>vW`wPd=bVZ`%HlH*^L z!{tVS*pKKer49tvW_S>H%Rc!5El*^nc|b-7vrUR?w&q60No^?jdL zRzHMZAa;~_Z^}vx9&Cwz-u=>Z7bsa@BuISk~<>sB_5(cC5MrIRI&}q zBfEZOvfP^Dr|ol;jM=MKK<|sgvTVZKTvF$)y$0@T;nJ9bLj0%Mw`p-ZWPmu&pImzK z3YE<=S3M~HU#*?~)B2Xi7@8<;!7t&))H*Y0TH~M%xIT)Xn;4_PH6Yz|VNy27A5uK4 zD{5(==w%97Lz9_j~v!=Jo)(B4Vt zk5Wa%gR?Wu%pU)px$5u1#l|};q;P1G*S)~12Wgi~{HL;rj>%<9rr)-!mBT**Br0-9 z5yz7@8|nKgM~|;8;s>3+T!S7RRt%Ory2}(6@OG17eZ>9Jx6QKa;((+$y1Ow-PfF;= zPB;Q-+f3TuJv-dBPTNooeP62^__wfVQWy#;^cZ|njU$Z9^}vz$NQ#))-~CHk!`4QI zej}DmBp4iLP86cbJ=Ie-de2vSC=%zKY+I;`|7rPX5-HY6yxvLVzczdcpDsyXe-NIk8`bNPO>hLd!_UnJ>fw@N3=!2|Nfy+-wghd3kU(3;^EV z&-aiJZV;4&M^CXF!xftNCI5aCLsvR__ND(H=H3IUsjb`l)?+~|prG`k(nOj_??*ro zX(B2egh=lt^ni*|q(td80g+xq?}(I04L$T0X`z=8Nr1dNob%j!pZh-dz4sm8H^%o3 z1|`WJo4wXvYwopvbI$*aJ(TO4*Q^A>wxUr4xg}Irv9;w^xpcgq`1!bI0Mx3sySkJ> zcYIokAj{(DaA-}*4)G0>=-2kCw~*z(!m=-O8>bfrRm z6UFRa48pYqtjbfArOH*Lre4xGT~+OTKpYV2L%;Y0=K(}FW`PJLljf!v(yPvuC<;%> zESEI@P3nTf5Ml-R(^A@O5n6AVD-Z?Obv>|ZNM^XE+_1ZhK58hFz&S>GDA0N_yH315 zdyPq>Km8W1=p|dL=!yLvstU_<)Awe0srh2FGHXqS(5gAwpoOf~aeX=Z$X{tJ8w%0x zKwOfXsVB)aUb4g@M|uIfa|>r@Ew^bO>~1?I5z+nR>P2)=gVMSE-noNvw%1X;uXnc( zr_Vw}TGDy$borLOcDXL|tmv_sRVkECJ&8ndaktU*o64d2qd6*lRovT@1n(=8f*++8 zCQ-ksY|A8NCHt~i_2zEhY^rf7l{op)bTJU{5X`ol@{1<5!BEq*#6HEu_(p4hrcVAx6!%2WU3 zJ_fv_jhho1Pqh-edlmK8>np@LBR7&iTwMMLNolVN>-9gF`fa}xtd;g{OAgO~JSdE8 zkv5LBK&4Q~J#PAAZ{Xobg~#`{+41j*k3X!)DVw2+Y7?C(g>B{QBns-wVr zBqigJIa1~!s)eMwx8>54M7nG(a`6dDgM&?8mhJl~qhUV^0`*LIfte}QuYNm+M2+FB@( zXFbjw1qE&g{&CW1ibS0(BvJmy&Fk8l1#9u!N_%$hn~v7+7!Q&j{cpVz39({vY@O=o zS_=Nhr2*%oJ`w5-Jb$8)9GJEuy-mtEqIP9{4>XaT*yArwqC%z~qEVl-FB5xiv!zq~ z)e)r5BX_^sFUPDelADtlxGoYjCi#L{vF+@_=_OL1wEW%lpuoUGyzj9*G2EK#?LVl% zf3x$%y)2E24fNCJ66MKvwNg0WG1l5Ov$lP>Or_VjE8A2_YpI&8~}Ps=%Z!&6?a1&0=Y5&m*l&_5!4K$_!G%6#Ub znGyXzb>6?X6!jbLtEoT?U*`F@mah5ehkz$B4;l_n^u8MtzfSrLTz1`@=%ac})Oszk zJpQOe_@mW-wG$@{mG)t!l!SKZs!T4sw@Li7-TWsb`ro}+yHf~)qH&a`vy@pM)#iI0 zQ^C#*DVo8nn)zWNpZ0eY#fZ0B*ngi3l-=Q}OH_~^04MBN|2){XIQd1tXWi>vFmdka zgd%{xGwUcwVS71rH#S;fy!~kMOUWkDrAHV`+D34LqojzmG}f$U3u%z)kM-MM16tUd zkHhY@)9$)27a*kH7b(RVZz&r^3aJvg`!IER8QQi9AFh`W(85s<%*LHQid6V!;Y zE$l)^1CDYg)hhIR;e-zfyJ3~LvrwPqW5N$>^%$=REupSXT9STUJ~57D|BXQ?oU5C! zSCD3B<6+%%9gsY~T%=IRT02o>(t^1^ElkhmWgtf9mbXScbUv{^AHOL``3J@^+#TI;pDY;#ucne~ni{cd~DfqWp&@*TL` z!@zsZFUFgG)5m#rF{f&}#P7TGBVXEen>Z(ZX|6pwzrYkSCdsF#mP55n_?Fk~p+UcI zrU*Uy}djo!VV?9*mKM($mdkmhkF{=|qjEUP#(KkR)v z@IE5g@bicOo6hv$pg-vaT?u??)>ah%`K_XYmh1}BbR6zSn34cf1_7f zXWrV2`?;s#gwBcJNYqSW z&r7zX?1+-;mI4QGiG2iFCdgXiq^381W=FFv_V+&7D0f=2k?pZ|+Hy?3%p2GI?LdKE zlcwW6%2FXY`|%62+0>Zp*?EiAVRDBl6@b@75L52&IRgJ~;`I$OFl`bdUs?Ebamsa! zms#{0)3QjH>H}6H{JrCq?lTO6Kc0D}ibc81Fi%+YK z=7ma9+AHV?rJHUyO$m$$j&omrVZU}Q_7?eTc<=jl20~PZ@qPR4M@Bbrvmdbv3HoYT ztc=r8!08TzIt9>ps>#GNU|z|x>Qw2D1YBLUUqX~F>p$R77>y~3%6`VymwXp_8${4p z@y<);vX0zr$Pf;l4{zW8j}8QaR54S5De_DWF2pFp?@VhFgS61$ z)jXIxqXa{~1Vx8dPbG9BB(;n9i>aWr1Nr*(VM_zv<^jHFXf z@>G<6{;Wbfk!AD^y?nj(L8lp;GK-(!)KyuXAoGLPj~NVCQPUKYg1EPLgrYA`9yZFp zX2>7GYkVQ{iG{2E`kpgq4h^Bk$$7u65WAhaE}AO{Bx5&=m9phpvF9bAYJ)Z?+cnf? z)h+R!*J;&3SE%Y)g38(Y?#j$dbeRap)c-jSk^F5w@MOGE^@0~jHcfHp!>ERxp|ZYH zmVHJI_2hhbv2Z*^?3b6^R0e_3gsE}j@b>!$h74~G(z=GbE$-}HXJ1Cq#x-1j2-Bf@ zoMyk?r7XWd(z&+LHgszNBYGvM>JzB;t!jsZ69^IZh%vmj-$h=CcBlQ&wP)}y^|JS^ z@S$IdX6OrdL($*JS5>O(u5$hg zLU3`_yM4+Eb%|I?KscRrDxbJ*q$P#Z*VM5nY23-?27Lmrnm0pPWi&NzbrpX}`Bdnh-|5=jqVrS-X!GB6fb`4s8s?0rHIMJpQ|Rz1k*$N+TA$f2!id$u8w>E!aGEAczIvBYQ6kLOfGG` zD}`=HBCh0i1dcR*HI>h4U#3`rX4zP5E7`%tI~2u5xbA;1J}gw{P>vR^UJ<{)$RXV8 z`@r~<U%^drEQa`){>Sz9f3t}FKi!P~ZngIR<*7Gc zn~c*YfOl#3q96(X^P%!DH)>4(-I$j{{=E)$JbGzX0OcAHqa6RL& zfgM1pc$;1vhe3t;K;PAm4Oy)t+BKzb6bU>PQ!@CU~inSUL-z3|Y zYZu1Zo@>-iz|lM9`NuwvAqePRATYLEX$l=ccOS&fitN;K#`E^QsuWv8IOat%Is`eE zZeSd*Y~+l}XBsq(>))Fk<&{O~OvHx!dS5d-tP|TPE9o;I(u^84B~Iq5K`Kzb~-I7EZTKg@NLdbn z5l7&Thj;yJ0^xbD0^>>SksO=h*U>2pDVHZX<7?YF^n+t->{S0?|f49l+82mi>h{FjSpx;kBbOXC-eA#q zAfKe2N$B8~sdG-GG{PEjGO5GN&UuxZ>Izw-a})ze(Cfyq@!0Hk{TT#fNQv)85%7Y0+lN3VxC9$OY8V zs!B(}G4yNVYrlJEjAoVCQL970*o}-LH?#@8xObs9VpOf5NwbI=coQDN31dB88^KHV zeXLVGhdrqod78Fjv}XCx47atQVrM$d{ba4*Hml^onbo4Rcl7Eb{lHz)lKu+-1<4(D zdicrFZ7<_pK2d(1A(ijg6KP755|XVba=xC3j=1Vq)74d_*nTZms22AuB5{N#om?#^ zh^(dN2vfBNTy^GPux9noQh=|xvouxBedUMP{so8c$7|BT2RjPF)3^`_Q^Elpg?=3U5c^!$?k zlzX8&8!~5z=Iy@NE1__KxR)otvS_uC7Hia{U}QWy!lh-BaWYYKtrd~x-ot2Q2VB^R zMT!abfxH*WGpJPPzVrdCapOTwqxeX`SY|KxhMdens9)Q0mn&(MBZbGA#Ad433<&S} z$!xkDElRzKDeez_oON`ts#6i0`(V}e|ZKsJi#*Jcu>h}wn(hVJ*>}1gni|P zAR0^BPuvkHK_&bj@d8u zKbHlz7j;~XJp65^z1|5)m$=>4c7!4Zgi$N?OVS$a#$Sr5lV!Im%I^9%zM3^M>#mWv zZ7?w<{*ubwtc2F_@0&A6v!=9nR`(9E&kp<;tdBgT0i9l?gic+G$*q z1Nx`zChuRmay0LRu{Q&;v6Y15HXxU{B2xAT?Y=`W>|>Xc+%4u8<@HRq+Glciy)S4} zjB?bL8RgP?seA7k4n2dWvt^tZ?;Tyn(lleE$2!!@#pHOB;mIsKbVu(?f;wJ39H5&M zemEe(h@tcqS3-G5e8M`dBw71%6Bd{J#&yNBmzt!3HFc0^BvH~$PUD*?GThJmeRglZ z=%%Wh!H4X_9NVqFK(ORRYZ+U^Z|hTfb~_SzFN$`Og`?7~MR5Et^tZ4DF!RQ>Lytn| ztL~e|W0wFCKIRVL;|~9P`SEjJRr8m}h_B$`;77ULas}P!m6S`Txy}OmDb=WnhU*X- zA@KTirOzD#N6s4b>h@A)c81V$hfxG;SM;o42h zw=yM_S8)_rYSSw>zn*NDorF3zG*og6$p$t?cQuG~Wv=jwOjkW~XqGsc&eixFoJhKx zk{|`|_8;CVsH*fL?TUsghIqBk@EOrGo(Sg7`sCwpj52t|_|SUC?bkn(;_@LK`m(=i zQVC3UOQnT+O#Qks?8jgqxG#^iYPRaqZVngQFc$G8?H?0ETGmcF4d#~*I+GkN{D((7 zV^i}541?=dMgO$O+W&dq9)(>kLd&>RbL3z{6Gk*yuM9Wb=lf<)WA|#$#m(zd(r@NP z4sKKUf@v9l*$bIirMNGg|<@OP|iBuOGHRCwdx9R*E+5s$#tt&Ye;nid8EYedG4F z>ZJMEstmhVZ4!wC-mR~VBB2*HcDG(MbFqJLq_$cj2+r8IIX=PIu}3)C(?^!NM_|7_ zb__YIxm|anIC<8QqJp(h>%5(R#2v=sy;ShsAYi{7ep zF03{Z`z%IGhtv2&C=48p&2YBd>4WQdYK#)(+#Eoyip%IBbJ zdwep*+G!}QetNjPLgbVB;mxOWbyXq^X3dGRFSZD!2{;=LwUS5fa(a^@`)2o=ayXX7 z@L=Oi8(1)d?dLh`JTc-x{|h`<9PpFl=Z|dQY_Xz{px_ z183C;9u}c!1wlNhMw6;(N0Vq(l72|ZE<1!Q!&;$3#V7r*~a9l(+5X zzrECA(@l+rfzASNTuA#DpZ}-BftPvEPkG;=iMveQuP^Xd>+5zMnyt#6B?pb!&4jKi z9rX<;yDK2@N*L$oJSV92S+QOI*>vuMQ~kdYWj%pd$Cj-!xuB{ zKi0$qlD-@L3c^9CTtDIK6*~z;q zMQ8j|dx{p{Mt)=Ku)v##zww^9_R!d=-;7)Q-$JHJmOhr@>Ot&rMFhwIp>c1u=w!G# z90+kN+cFquU8#lj)h~wc9ziE5m&=xr;L&;GneN}%S614%2$(ZLT<`6+L^x29~z03WXDl~C7i$rRS) zHcg>rVTo3pi8X2cosQX0K|ehxy2WBBvRqdsTpWNLsr40-a^J%4S&|z5tQ-Y-Zsh@z z6=_z-xoo6RTZfsi9mp3{Zu&XCpDYTTW!q3 z#l5!Z_3rB)=eyL>eTSy>t@$)iU27(5LR>e>e>^(l74iU zRqQy&_STrU6jgK`X+0uP$|7bH|EBAp*$G>zaBKK5MVdC9HAE_=Uy>37!3YoIqz z&5+Ek!>IWVm#>#R6t`%UBKa?T1Oe4#gQ;61i}6k_=`{;WN~ZaqH@F?HzOvwzqkdO2 z@x`V5j*jQOV2Hp(Q}sg9C*MBJgfdmD56W+39bzIThsItG#y)-~QC@c2SmcAwntZHRHFhT+AN9($*0zgRz?~&uFu5#V zhmHEjQ_PDoH@=YBnp8I_&yiwNg>yPu6bn5^sMg@qXf((CMz?QWVSB?F9Rp$!rk0E= z+oM*hxEwVOlC9o8=_t=WtI)gXD^@SycGS4brZx_38U|Q)?|w=DV&WReZH! z;Y|P59P-r%1k1|R5XfaGh2C2{@Jm+!0f9uz3Akl1u;ZcSke4x@2yXJ%C{YvPb%qz{ z-f>tf7rSKYsOjuzw2{ zh^yWrsSG3t**uC@Y?05puqr)859JFf5jYd0=Rn+YGvwfjvPKiqWMg2mDaoe%@8;-Y zi^nzLX$gX^k*H;zja+1Wk9Uhnsvm8BJ|=oZB9~Z4&}RY5yA$hI{b*FOE$?n`Ezwe> zt=agu=6c;HR9W2TD2+w{%kn${q*Va$97$AK$e0 z574Mw{T$zGfwB4#Fh{08{So(Mrcpp2;DJ9*9CRR z%;w81NH=GJk=@{2nPgDm2%|QSP@zn+f44L|n@aNQ=A{*pI+y7?6Rsg6?7DkJi^|Q` z>3RaH(*qq~G;f6fD=s6)F^sT1CP|F&&2>K1O3V^8npirW{ z@43YCgbYJoZ9QI4z^NEC;crU2dXD-oxSDsRg6%xL#b`KXsUwD z=;GLTQ@?sgXEPD&g=E1#v`nXZlX9KH2P&(rMKPX__#F}$^G3*Mi4ztm`}p!~z3J9Y z#&MjmTaC6+j?K*Byd%hT7k?ym%i6i4AZ*}uns@Ka@XK$I!DvFaN8*=Y-Gz78oVm;4 z&rv&K7Ea++>iSNn6^mAQz9E%0)}s$>>U-4qhL=M?bze)MQG$um1wj13B$xDr>bI9P zC40l52>h0%t#e9D+E%sKCo5ZPlsi%_mMArQBj2hQzmlJS#+}_r_Fa!VgMi;JcW>sB zL0@3!fr)}o^!ijuJZsc;j*@GX@yq)B9Tb-nd~PH_T0cNupifKtqPtYa%gv=2*b}F& zFR;0cmk{6gIrR^-x`idz<|E)rYJQS2Q@2EFuY?vvSXGPE(WC0FY<76>nhwz{HWj@8 z?o&OY&&n)ROBrFG=5`*4HRv`+@x>dL(ifz7nuIZ2Ue9X$&Ne30-t=q}MYUJ!XCbsM zGN$f_ijrGk8w4Jbm{mrFNXEFuE$>{6B3mVRNUHQL@ zns1zC3Vu;kuCV`Vjp4)pHDH@zT5H5Vi`6%?+*1B$9atO=vEti^*9?{ZOjysG)q* zsAv|-1QllPsWV3YPGm-9+UJ}bF)im`55Gs{(&p~^iEME~wrY`*RcSEhr?F}FTYyYWpoXmcTQuPLt6|5>bE9HngWhV@z zHuu-rJh7qnF2coeLVz7`OdLc`spKTvsFPF%FRG-mbde z=Yi)nR$W^6c?9k&m-f`2DvrYs+pbJ3ocL~N2EDl8^X%+lmM*R_w5?Jab-AtnAgEY# z9|0t3j)Sy~7a3n3%CgbX>alD}r6m}#M5kkBzgH62u2FC>U~l`hJfhDp5vSrZ@v~;> z@{zPL1|7>)dp?emTzTK$KHpBi)abs!QS2DoRIzPs)-(-K^U(MJo&oYS%_1V@e6ZTB zX%R7{@^qJ-z;~R<%4!FPi38w>pfJP{ZlZMAuvdL&#B7x9!$#(hoCv?tq7y!M3J28% z&dV}mGdX)KtyR#HTmrwCiW+s5;gee9kH?Eo!rv4eJ#{F+n17tjTxot4eqb|2)z%;w zq-1!LpFhagJj*GzHoj%sszjg_-*wwPzq=QmP=7Igv4Lm@vD-AF5kkyCto#qm6E#=D zcyr_soUXq&>pkzrmz8`(?0e**>E^Cyckdrf>p#4t;A8b0d-n>hB($}#bgC2ctXp(eq;aV z^rRNS{7gdCP-D)9$K=4n7pW52n5Z)|jSzeGwkDi-}L|IbfGl0T*=xp3v4dd<-Vuw?`J=90;y1Z!0V8nM?1cK2OE^L2u zFchL9lJm|jS7{9I|5 z)sT{5o@2(F4Wkk_t_T*SdqH*|kI~)w(bpv0BVxX3pQcC&{$veQz0^&gaPC%%Wu1jH zm8_G6@@#nUxE<9~npN?+G}6H!h>Z4R6_TFS&M|a35DUZ(xPG5kkXfaNBH!e%B5Pd! zC`!(IX^Z5xi8C{7KPE(D-Sf;|T;yKX1N8NJVh-prFSYhgRrPwfA}N%HWQQu6T%V3s z@CuOYPD%aLBnw-b&RW-WC%6NY&^(m}{Pc;dHX=&8y*UU|ewIv{_b-QCf_Q=1wZ04jk|0-&tLknYNfGRf*M%|cp`MZYl0 z!@)+52FIw1`!_AZ$|q9C^g_#k6rmD{4R;A8_SJdIOpfM?fCVHhc4K)cFtd*H_XRVG zQ65=n=Y|EM&w>hIi_BQsVIGSpdR&+_jY$s&)Ojw;-M$T@OHAx8# zmS;`*6ge~GD5ufrrViD}Vq?Qcc;6ejfM2IQ^qR5%AX9?72EL4qebVOpR=T}jn(Nhu zREaVtQ%q_qi3R|ktZQ*kD$%zRx}sVQ7X$;9`%xNh9ZW=uUBv8>NXVU z1~2WHz|^qhqAG>DzmqtNbkIZZM$ z=g(Hzp;EC9ei<@J-tPgYc~fimS1=}bfG^@e>9#Q2iD#rTkNz?$0Hl9ES)3B?zCoVO z5e8qiZn#H8YUb)5<>}T?nG0ArE*v6w9kJx8;m839`pKnaSWltmh)Uf@17%`_qxWXp z;L`YOMLJA#rzK%7KNa@qkzw_-W-|bEIkkq7>_By@(@7AzuJ@X4-4Lu6LLNSlL6aCx zg7DvMfg&jS5$danbGKyEay4bYr=XLA#f7mq*x*0>(UsU6Eqva)=>n++oAIYOn(dJs z&3$5o-G{oi`Z~_4ow60k9l+Co?gKyN-d;XY%Uy5Km+A!||2vpY<2AWG4OETs`Fs-O zPEzt_xfg)WDJo)2;7JT~l*!^sLly({Eh2{jb`wnYKLE3`p6+RQ@42n6y~)^_zdG&U zyiJZzfvs$mLH^RA6D@t70K1ku@$7`HY2}bKZh!$eDk-^R@#0$S5nz9O7)L99KKk27 zVI+-I_>qPt1RpXE^Eyy>h#VK{dON{!A1irZ?!g?}^|Q?!e{Je7UDEC^Px6hwUud+e z(>=<7yh$E@mHc!^VJE%URr?W)(%cXqP3$!hm`NCn%H_1;2Y>e{wi9B>(Io4UK?}n&DaPUs5`uS^nTCFrAJsA~U zO6k6ES4I{J4zj=D*bg>zwLS2wwn!V`bjgl#J*E=a)9rpA70~JWbTdc8HVL@)jc?Yn z33U3fwQ2Fr}{MaZE!vdTaY(!^VUn_152 zOLv)Hcyj>`+hNKy{`NioOQ+nE3&2!)D_)jL%NIA@djE!@_z&6&hv4{~22e(+R;Q|f z`mnU$=gVa6%Vci!P7W3<6n&}+D;nvFWXOgmi;D&uNZS~Y2mjl6fi!yN`96C{ru3NF zQyt;FI{5IgXrY>VJr;SWgps+Quu1oew3l8y#>h zM`<5yFIEPd8`I!|6II)o^r+XUi-q)q^kclK9G=EVlLz}`%Ndlc>LX!u`CY_z%Wq_m)3&z&o%fI+1k)%vW2}I zqEMD|%kWhOK9jY%VjW-4MgA;T^%?X-m%L1feAuZvaMrj|0@5$f$<Q-yn&ftB#_nm|VwN8PH!MlM^nTTetcw!+ z{M)vO2xmgB0?z`iVJ{}~@KGXBf-l>@;(VZzwxFFhhz?x1iCR&((LC3^ccKeS6~Ls> zjT4xCmy%#y@8QZ7<=(J&9=)q3oE`#_lR86+Bb$@I78ug@b_Jt>B_yC=EbyY&9oa8R zEhca~;15fD-CSL>E}Ggd`E)AU%5E{W!5)R@u;efSFo^j4of{2DlY^v`{D~?KyQ*YQAQmZBml^3DQF90!c@3Rj_ zR4@p7w%O&f>*K%S#_U|=HBm%nI~^(8xzqJIu(l&VZz7z{yBYU;IOJ$IgqQIL7v~oH zcLJNV?{>ZPDl81)*#h(3U=q$US|lca#Od;Ux(3IJM!ihdeVn#ro_4V5KGp^d|8$u8 z$SzLz9CkRot;eFgBzE}|;?f}QvAivdA;eTBs@+2+T?rP-0VLv+7rGQ~%jkD+*J zfF1kH^AN(NwVWfT%$+Hok!$^;s0o{`s7$iW0oqtw2xpok$JF8P%KlJKfVIBO@IG8L0?DS!4DEja6?KSoEvEt=Q{P?7KQ|@h8^{dV zC0yI~kkXuVn~LZT`Ab|HjO@AGLXVedAM2hgmwu1ob6KkB(6qS=*Y;(o;YemTV1?$kyPQ8;n%y$1o>kiP~MSIAeL3= zwFy0FIA`BA=&(&Y5qhqAZnS_fvgpHoAR?`EwL}L6h)qv`1ro-U$MJ?g38R)rkzE8{ zpLnn%{}DYTyBA_y-}A}yxqV-XXlEFzVBfh$p&z--NRU)I9(mi8K$YAk9q>xPbG6)Q zBh$IA8?)6JCY3fgT?9FwGv`roAVl;T^}JCXxGaCAxpEc|f7s0Hl)dPc?OJt5bE)Z3 zf7BN6A7XT)6qrCzMkThuuOy&?*_b3(j(YdzXh2DC`FcI~-F7OL@G%80WLXIk!KTx+ zs3lK$j;4!Uh;cjYOP!7nAihG=<>Lx}uX=l~k{mWNg)HOOmgba=JKl&?bL6H?7Gl1N zcVq+*JGKmv_X(m>2j88y{T$N#!~+cAZ&C)bs9)q~oA^8pFd6;nuz{H{-c4n##;X&F zyT)Z&ab2UWonf{9s$MON;F@ppMBZBe9IENTEwMvQAi&o-x=HJ>)4usV^)GMgS@f^N z=^f>Rgx``}XhD0>!S;} ziLQ$_c;X~!nhpG7s7j28wcI5RYr~Qkh>wK>3{Tu#;cWzws*-5@QBf%pomb-zg7TNt z{vzC_4?B*uc42~j)=@0)p(gNXwtPCoA`@0NC5T{A#()`6WYw#K_x89O*f?-vX!Ohll6oI9Q#L~8#U zPVmJIc{dW02jz~YGEK9jJHm8-%)LmB?<)TIB(BKJ1mmp^huBHD9?|n)yz-|x{b$>? zUFrgjeh*1zNgwW}I;}1zru%ldgZEe;no5VaEJUVQ$XMu z;XJRUh3W&y#zU4|{OCw2sAu`m-X#hg>Gn!Blaq z$n|yF(r|cFoI%GO$r~l=UF)L(#l3vUJpb%O9ED zPLvU$sp?g;Od#jl&cZi;)BslCcuJ|jqyq-}!PETq6^gZBq7`51v-FUK5s_`dcm-py=+*eSj4!ZP{`hNqtkFrS+vaT*aFCSU8z<$e11-;i};Z0Y@9NfhRkGz&A8dE`YSS)!b(J z?BddPAY0&z<{-Gj34Rg<{2UB9IrIZtfVcH{6*bd7JegDwXljXa;H9=h`K7fp#h_{ByxyD()Slsj0*D!Xi z0R+39T%Wv;3Ot9#`iZhcyiVkjlU$i2*kPUxR(f@0q=p0u@*_@QM)h~m-l1kdQu;@q zEn{M+J#&_jz|nZZ7Gu*&;-$5Qklo=X24=tAVR*0%Babk{Yo+v7|e8)xxQEJrXT)ZqAR`lPvh>_-sR}{c|Xg~QX`8?YuzU206n~fO6T<^ zLwGVVzD=Fq8_o!aFj&$0T6EcJ^Q*Bm5sTA8v)1j+`Q=!#l@}yGtUiQ-_xUN%#Zbu2{Uvg0ebFgAhUrmO(%repM#5L|%yeo#t znr%%^2J?pegX=bnP5d9J?w-T9NE5B1BQ&qY?ewiElg+wiPtjsi{Y59ieaIh;cu}ECQ|24DKR{^x& z#-*IcwW+#}-KpXl3?;+Cyb}kBvh)?^9&7?~+63XFs08<9nF`?XKH}p%7|c71{z`;= zySB%&#jzI9@ti-Y{-q;(UZx5WzxssKlv*RcnwRO6CXF2(Y7QL64_lfL_e~bv`B<<~ zC7#n6fZRv`+!^W$UzDUr-=Qf{9c%LBMXOIvfQ;9+f{b%y+@@`zvequg$B9UszQ4As z+^{uUi5d2toyd^}X4ss@+G4+sEmq5dX^l`%+VkzLHk3aA-yZo8`@9me`I@40BuV_{bGH|t~kNckVBe=zMx zEK5z?*<OmeR7a`i**6H4PnvB!VR{LV z0FEmZwI>F9&K=c~l#>i>Tger2!LQs-Y3VK4pJx;())FwZH~ULI5^haM|3O$x3V3Wc z!ZXn_(q|Z-KLY!y@UbaOKXJI~jWYU!wlqoB8z|C@Ga47xd3RdH_r)a{VuuLoLv0E8 zGS@IKY=pN^`<)?}g2iRYTp{oSkIlqY%`0(`XoU}xs4BH4aypyOLk_uRjOjruFz1dEL6 zLr6acx)cD8OMQNkE&w#o(0Y_c6Q)o7EXP|fr!8M@IWANg6s<+9qG_J9NBVL--vGD& z6F=#2EPgicW5JG#m^6Baoz1-O)n7s0v%IY;OQq*~DPnq5ruu_S*DfTh;LZUx&@?f% z^U4B#7s=RE=E+bt%$9Zj6wcj!$FYP2uv!M9XYf%s*$Kf~S@@!Awi9%5e;xb0uVGXy z!u+eCxgR;omnIM!{cM{yZ;{w|9k{Y|dEQsW>hBph7H&kPTZ&Zhzw(sh^5_v_HOhno zdVFRS_#IG-8E1vV+rR1$5zel~$_@(`x7I>Y$0`Zddlvx4_WGE~F8rFy`QzjavmOrg zwf+aqq8e50-mKoEyzC2%jV%FL!0!0kioweF>G%!AUzLCaUV3Wsk^366Q>s4>ru_<8 zsz6SK`#BM{^2!rBkt<(2WQODfCf6%AbB)84P#lM1r`E_zar8oUgMBbI)wPn(O9fF zd5;RK`tr9QWYc>4I0Gp2JmcUV9FX@c`Ed>1y{0r)_$%3{C%@sL|$guOy`?GIS z^nuB*f{k;)_*!n(o!r<=cNg)9LcS^u=v0U_%AEac&=YN8-A6nG86}oSNGqVuJN8`9 z4l&1aikt6(Hj7gGhhXv;YqY+3ksCVin-fm`rv1#bZG6?xXyt7RtPb2K?!su6}nQLOSboz-bwjnc4zT>8Jjwn}#Xx8=uG( z>CU8GSp!V6XQ3X0U$N>_OXO>5$M?XXv=-Utzo~CA)vh3i5mTvs@=kyw2Ee&wN0{Rq zDV|sN>qB1Nt#AMyX5&`{Fg{2{^R#HFVSFz5;P$Q4XnoCMjP}TyDd(xH$A$?LC9DCA zFq^C8e|uTZ2pCBViIZIcD&W$XstvhdUWZnOrC{*o$(TzKIyt{}b3VL>Ke5rxPsY8` zBI3vpZ%BOiZ@<93p3dL-*7o~E@?buzd4;vc2=H69n13@xw_2Dk9s4AG=e9|et^*#g&qo7*N9tR~pv1tWK-}%mvV} zOhjzWhbWV$NV0R`%r$p1HNUZM9~>YI{UTs=3ZHs~)fX62S-)8e?mak1&d{)7s)S@% z!feN7>|;Z9U4~n4;1#OY)%#fC>+{|A*IH{hvDbv5p<=~sqwL0Jr56$0J1k?d+@}<* zI!I|Dia-!r`{L`pYlvDJzN2ecr7HJBJYCSBS&;YEsK#$YXoHNP#=+a1G%Ph6@!HEh zmV`WsyOzk-HpwpX(^Pa{?HSa?=WCT9Hu}m4*Qx9B_=}W17r^l1d;1@5Zaw~oXNfh} z+#R_>K~B@?=T?!sJ9<9jA4wc+6(2>qr)kLNBNv2Iw1lTA!P}b2zNNwSjBZThi)u+Z z4*E>zhjpI!yyhGu|Njbp*WUVCYLW6nPF)4z4#%g?FPawZyAuYos6XqL_62F`=u$Uw zZ8Plfj&80IeLg<)YGkKMQZilsQZ2|PIV73xy286MKNFYf*}OFhG0oHUL`9AK?Dnfr z0`IFLL@K$I9l#rz*Y-*>Z1aBjE%*yEf3b<_6c*g{^Bf(ED%QTzGI{$y!(UCAoep5N_r(44ha_Lw zYTW`Shkz&QQRcK{XMnHZ%WkyxHS&_i{P-sJrc?Ef>{;y1X6*kP5cpaV+`?q7N9XnN z@TX*zz4U$&Aar1uz$;C$mNWB90Gtag4d~huXF@@qPoL4;D~vqYlr#j~(BSWq$=!rJ zVBr85p@_8)`Va^Bkgekfa*Y@re~AOm1$=qO-u;wMzh+br5G6 zrG(z?0jU_r8wB~Bxkk^dV+!Msz>*gBI-dfA$h{~2nZo4<>6CIV|G=; zM|DDwF~wGFJMw1bU zM`YUZwOk;bOLWcV4qtZwyp!rE--P1M(omSD;f&g;`<76lhQ9lzN^)-x{fBN+{xXmH z%M)q;xStz79F%igl$U$k%%i9Gj|PhS&`}123aLfp*}RFd``Lrh>p2Z$`dJp-W_yr9yx5JIiRlR+s&QCno zq=F-cFV>zT7}|+2F19@3bA=`A&X2N*^Sr4ywI4~TaQ#GV%vrsq;1RK5Y&qi-ZcLm% zB`;Sxe`;W>bFJ+lZ8AZ298+ca@EAlU~rA}fEIZ+ZX=Y>f**c_wy7IR$;WOXXbH~VA! z9|(@j={u<9|ldnfyBbU`l>p!{#AOnZULyJ zV_DW4wO+DTo5#*$w5^Q??&Vqw7si!(2KnZD#mBuSYv=v=PG+`hdfau?!bH3+Uk8Y^ zpK4l5He`Po?8zGxKY~6$k+5 zrCNU&=Pq6OW?`;y-$A6If3slrlIcE!2AJuR_V#1< zS6H}?Qw07nC_kebK6R^GxOROp(Ytnk3h~LbYE^T6`@O`faqao(z2-U|GCCy;i$J)W zUj&alH1Ro0D&iC_Khp)~|3I$3IOCEpE50Ba%{zD+{wdoSTCM?~Uatbu+seJcbg|85 zmM02D<3OdX!SJMynB!An#?Z=DFWkI@5v1m;eSqt^@1kRM-7JJQVp&^l*#J0hW5;@w z4h8h=Vi}`wj#gEne25E>28_S2Pc)xkI`G-PJG?)ohqR#CIy2- zG*VTDKGetH)_1(**%U}1?AdTXB^$Q{t|us1O`Y@OKui*EXeI$RBY%SSz|D}J>?E+*`BzTTcRa9AJibe+a3IL zhh~l=a+q-7%dF23%&1T=+k0~D`}GNL1(`YUnf!zoUX8+&zH7>ncpB(-2a=sBJE}HE zHl0V^Bqe`CblK;gE)CI-Gv25FEx<9hJ@eAE+q@Z(iedYlLOsFOCf|7AYvixAM*8ut?y`1kNqQq?z!BYxky z)qzUkOh;SFSpFMRHG#nZnbFgW`lZxwx1QQWB<8rd;78A;)betb@8muim{uAp4Yh-v64IR_ufyvme*P+-lXld z7L!huX&kYICK6^EY4s|b1#hr{$5PX9YSCdScPM5W_=`X4g0F2$eWI6k=&W|Q5EZF{FmGUuSUE6+F zGh^LXC^hSnzh>om)ab#Fd{GycMIH0>lAbjoQ8CwVTrF|ZnJV4GHcK^%j`ziirJ%88 zVxxC+u>}pv%9@k@lh~V2vlhQKGEFD;5F;)KX_WYa#OZhF>~55u+bXunC~A0c*J4%0 zkP9)pRx>A)r|N$9IwQ8}_j6kg*&)shmA7Q35d00=f2Sq}PKa(x^g7C1C zn6p(Mo4xK!k`r_Z)+?486TOqw8aOSccLro@{rJ*~>!ilKv_;X++WdNa-d9V6u)AD>08MzJ z*8IcNGrtJ+)`-LKGd@M|hqI3lR5{Z7svJ8H_LE(OsN`{loRHh{kutWeIH!46+3rLR zoT4;6E3{Pb30%^tV^*D(ou)wyFKN3dnr5cjcP+`Hvn~&ekp}0n{B(8@8J>F!f>&}M z=65{3pV~`~bF=A8^(>UwSTi?QT|`_QQnDG7es`6nO-)Hcw>wmM4kS0jagsKXDaELG zWqm6M;@V@ER37TI8IiOMTZtP`vtc~mDbc)wujncc%hp&lpIqiyjfD9>|NPk5T=JPO zuI(ToqH1}me__`o!bg83U=^^Uly;>3D^fa$s{Ra{{&_>a@zBI_CUW%%g|kf#NRUF1 zX52Tjq>Qebu!9GWaM8(%)2V%?GS069I{n}nO+(3eqU2!&_0Rq_vKN6ghOX*wJ}$|R z2sICde;Wfk@;N@=Gu=QuoNOyad=H!TX%@2D`(nxG@B6kmO4Ls@c!MvWEJnHhnPGjn z_w(Z)bso$iEi@FX+q(;MmvQLMg)en-#X{Y4QM=@8B>P6WS*GlHrmxPhJHATvo zXU~GQRaoDNSm)?=C1m;Cs*OPC>x*8TcjD7#dTMMNv%f;KJAobGkNdpMa zNf(G~`gSrnh=ePifm|+!2zgICXBU(|o7H=VH6qxj;vE|jZ$GM<%HjiXp9kChU;aAo8feH(=u#Mb1gfbcKATUsVm<9EDW*QIzK?b zc{Mit6o$l!+t4IRoWz+YkBfN*$`G8BV6v7@iC#gz?&&XQ_mv_43m|b}A+r7HkV$Bf zLP=YGV~G@pcaOBbXWqa^X_itdq5SsoKNyeON8B@FFN?ZI7Q0weat6!m+mR_CZep^; zq8qig8CAA!Z_(Zyb%KL6d=~2V30>dpHmBRluSoQ$^Rk&F~^BLUh1}-o6?@egIQ<1 zIjtLH(n;S{5HFUV6~jJHoDXhkvZCJe7a+0(#kMLXmBTqBXWuQH@- z(9Z8m1cOPi8c;LLuDSd~pGd8#H>yA9V= zi1BOm*5%4KqTa*WMtl_3q8CfscP*-xb}hh}#tQA;BAi}JuT?hOyp>%uwu&`81+e-S z-n?@ikXGbu#}|Es5tlh2@rb)_pqyeHRpqjMOb)cG0HADjT0*|*Z(kt;xMz4%$~!+s zeT)Qx;9AQC9c78HwB3R}>p|@g(iT^H%e2(a)2K4A`3i@LLJk+OgCONE2g~pE?e>V& z*EM=1>xXHrFX+5iU!HpH?Es57MFxmxhcXYPzhoW_H#y3dlKSt|0qcTy+ckSL|8NQp ze;L#{4J>9eAZ}+uTK)4*!k>A5);*MZtn5oY3=*%B*Z{t2ww5mZ=%l}M;Le*a^JpM0 zpSdUPo&lHpc7QcH#Pb$<-2=24B1zegwbw>IPVg7v^Pf>PmQQ-S^a^r>weryjB;3um ze0h<``dPL6R&7xrY2(XRXi$#H7aIt%2eY>TOg&_*eT0msMGh(1hP`gL_erie*7O&u z@x2E`_Hld>wsZEp%3^EO-X^Waihokp(7fD4QNX<8C z4rCsM_eH0;_gSm|Lj=$wt5`N)XCDJ>4VU$jayK!=XL8v8Yr?GJ7?F>B5>dj5NILU3V`{Dbx zHvdlK5nv-1ZWMT@ZmN0Zt>3$DLHqR}3a_>&KXVZdgunHalz8XoJPps;3;5^YKU>If zF!+l(UDM1&LpOh}N|!<}ne0!WHoLrZ_KC=MD|76-+AWN5hiDLwMtb9gSrLISscAFk zz;R%WT{pcWk$6ZoO?)GD{XBx>(|&sfJoW72Jr~e?EpZca9Y8KZHy(XP;{sKFT}}_i z7@9&@*E@tkQ=88|0j4=^>>|1Q=-#JXzS*Wn1HnwSiyv<9_mJ0V8f0KW>`9-SorFev z(r-B6Vbk>%Wm@U~lnOl@_um$xh(KQQ{aj7AQR3%~#JjG>{06G5h!Dn*_UM)>QYkQ`Ly#VQfly0pb+Kh?~c>U&>*1kJaiF63k8l>{? z8x{RM@Fx=D_5*;XANRS*0ASYzH7t%=Lu}LM=l> zZ>5^xQtxnQ2d@s^NaBp|O#|?>KLLkJ9?j%4HF8BAocso<$OF&_JlxIl46yXnP=pn9sk~A~b z-NdU4_Wj&R1Kfy^$OlN112k+yImOlo-ty{dTPfS@2^KN=2Dh&3fW9oy(Tah<5u3~09YC27Av zexn}VUO&gN2O!S-eN}x$u7kV>xOh?LkC^EMQI*3A7AhoOZM!hIYLcV2Pl^Zl3Q_wa zg?(N;@UeO~nD$&yQymxKI$OUlFkr`BY)-;`&>R+uQHy^b3;-l&K&OvKF}tp)Bi%wY z1T>$wfB(V!b^oi^tr!J0GfOBdE*${yH$WKHycYVdUg|n$F`ou*@!qX{0g-i_VGBG9 zRs9g~HQP7mYGyZ&0VG7-%$DJx503b_fM*W`HOZ&kq$0e18B#`{TrT-ZI|gd z6htXPOkT!X>2G$iT%Wwa#y$j3kX9USh($^HA(Z>s%>>Tj3_&^agZkkL`=BqT9uRhr z$!IBzzyvOzj?4ehgE_8=O%7opsH8oTT$l|5@ zy!LU`g>_}-IMUZax>ui^F^zZ~*jT1nLwZFhiaq@ll6PAdg`hq!ms?EHnv&S>9|1dR z2iVlv z>ae$Y$E~Do^fS<~ctf^SsPULmZv!xxrlq~ha^GZ*n@LVP-l+a*(VNMT=(@0TZ$CmT zOcV*31yNaG&vDP(h$C76%c@3dea$<&;FtPY%Xt#;cExMx7mmR}q$C;3+h4$q!fveN z`@q%Aax+ZXSn0bIH!0aj6*n>G=uxr(uq}o~HM>P>(Jy5->!(PDj8|DH;keXez?=WO zL($MAcAZ~Rtwoe?XHoEGL$i^!RH#Xc0p-RToLyw10{yCNf^**f;n*tS zU?l2FzE|=g-ykg633YYF=ba6J)UVn@a`6WCsv{LO+`CR}X$yGQRCxU??F?MjbdP%E zjY0nU(3j43Z$<9F2~iPua4ibp(#NVsz_{PA6*^qXPyXutD9PP05KbGoXa&wOSK&kn z6q@DaiYh&d`_VZ26x}f5y*RaY1~Qqvr+OEwLZfQNE|<+%x$aQ1*&{wWy@LMHn4mVl zG${K<>s7^5QZ!ixTaMzOo09q zus_^lAd9#1G&S=`8tJ=~ZhAtJEU=>IcwEMH8~1o5qhO%W4gXbs*VP_zenzl{T5F~X z$qmd2vz9}+&~Q&X&TlObdIJesE4gc}*t6%R#P?+xIHhgS>DtWkSWK`0?31P_zD;Wt zgGZ$erl;{27l(nNtx%VdF+n_`9oj1O^j4*hhohMQw#Vp|JG($8()*DBHdDTI-BZ{K)nTgV{z88W6j8c zKHp%cTr^)s{12Za`OtQpo|^^b=;}M%Wr4z2$9&J1H9v|*)IzitCuSK(=s>gB03#Gx zNWG39Xa9+jAn0ym*J}03^S&MGrTj@+Y1(|11#~VMV8efJe(sCyhjJ`(HIXvQe~_*X z!V%Tc-@aHG)*!;7P==19e*`t|H4977s(;VK8GhsN&TGwN76<3{OvR{LzEVLY1!A6T z3AEct*5jkR-x$2AY<7E#)77$t$z3dkin@d4P%}~O+@-&9iP}SiNQMaoBaZ-Hd0fe6 zpN<_eqgAC06nHrAC^(+Cvt5X*hLf#AVWhNv<@*9?PzD!MWeMjGaa4N576; z=_bR79Ws~M0K{J^Qad!KAz8;2(({USM?|J8*MPVTg>bkh9zo@@r2`U-j|NLLcAb!t zbEQ>F)=Pz7J-2E~ZqOHh(PX6wmxcN)KU%|&mh|u65PvBy);zRbTXZ9zA^&ZQg&V$a zE|+{PAG6Y?KQNrW<4vAyjlgKwD8NaLxo|xl}B>lV*y-?Nb zHp5kK`gd{%Gq<|!#u|{IBD6)73KGZZ{E4{!KPnL%+ZB;{9cf__u7bKwdmAolDw^a#8RN_$rG^ zC!ji|UQ>eEHJB@ID~PtlaW-f@ZgC!S3Jp#ETwxN|L!pm9I@yyj>*f=SePW#OF?cJj zs_-*+SZFm{X>+Ld)?@OdKj33{Nk;3OmiDIKqT|L>N=r=J>d>vJD~Y^r-<~ZNYo{%2^*7!T%%k)au5OB%;PCPU+-lB5ZOUt4+m+6v?Hn4V65V)gZ||ke174 zTVEGly#}4LzMwJM*FA$nrnD{P)ham)^$z$h-J4shxz%SM3AWJlp{@hdU-iP@yN1ZH zwo9>e>vpgc4PF=VdsG0m=hB9wFysEG*uXQi9;^na8d|ywIy*JN$4RK6b7xTB3cEMa@+?!6y<=BFnKuu6Sy^UeyH*WK^C|)n(ozhJr=}qKA7|#er7e_^Otw#( z_faEDO;5X|>7xc8r?!u^z*|?eM^ntld+NS7-cQeC&NfJKT_pV|f>vW8oSaLP$Ud5W zQbG~}j$cphRqA&Y*!DP!jNfwZ{R)aw8zAa;r`^-1!PxDnjee|ZMj=j^^pPv&@DQat zo0KWHgfUeO`^TFdd^fC@2qRZJe;3bwE^84gbRNpBwH8!$e^FsANRT+Q{kd@`%6TSS z%w%Hfd4n{s?&DhvxFXe9U5C20hR#r_a*5{byG4lt&}Lztf$1~Wr^Ym{8eOsc7z_P& zddkw8t=ing$u%E5SmGJLsNTG$@63d2)UJMzT{u=EonziO64rhp8WCTdZ4aZ$_cu2Q zwpVX2=E=W+>0~*DpsU*rZ31nO3GB3Ulj5)C2|I83Zn6z>$IR*+l^*+oqMCa#c=fZH zp=jeP!n{>A_{^24NP%^n@)@i?OhCE|W;!(LJ_@axsXVE zF8fw+xeG`={W3-ZwCK9VH2x#86v@p4 z%x69^^rWcQ>ss&Ld=#gB0}IcZGkcT5DR*ysLC6{F+~LRU0~^C*Qdxa*x^lJe*Usp~ zSv`=lstBaZ3pbt>XcIx(o4@<$hqgS!WMp>h4ad~@`{f(&ov#YzIHvFfP@j%lLhtq@ zyf)Q?hNa*=!EqseagKqKP$SojpmKuDtwIc!?j1{xtZIa%)G{e^2K2q1DA6;en{AeG znynHp^SSI;-(68bI|-_^XaS|q$(^ZA^aHl*zuzf5f)pY<^rR0BQqt-XYirFr3+voY^&!t8lSV zGqw%u$FXz@JDihnJi8bSyL_AeuT*URRZI%`;P`E17*TKHSgB-{Tfx5exK z%xU;{u;c$aHwYjLS~9MxF&#q?G=~7Mz5jPEyOUbL(I|m$Q8Z!o89?25%E3cA-y@o! zbPvn5I8C~^mm zB=GgAPctv(k;8Z07{Zr=VW!6|Zmt1AF}u(WUw5fOdYy@*-rwlAev=!g+5Me!nacZH zSlH?m3hTYMwNmOs*>0hbw_D`)HnzyowUqN|8v1b!6!%>XG96F=YcJ=sx23|lGfNl< z7^pMJ4$AKMc&o4A(SzydDKxjUf_)9hv9jMU!}v0g^qP-KEqJP{$8=_~t|l<}%vM8^ zxYOb#U4!kI8hDM)*%O>uNCiqday#!gk%F_{dN*$8CO-mm5{P{tD3uerR6L-=$gCMLG|#-);$0VT4D@0V}lmB^Oo3uB$+ zx0@n0H=HLaMXKg(bYDJmQ(j!7C|U)g)l&78J3rJ(q?`XX|4}At(7h?5R8o-=zmoaQ z7!$1bWm4B>4KkWKJ2buQvhLY~=;sig4v-kA6?~r>Y!F&~-JyL&;uRz+bVR>QaH?W@hmc26B0J#ysU_ zjLj{WHtV1roPS06JA$HjvYqUWBr)a4To0Z(OoH8626-{mlvREq%rxS1YuX8Zqovd#?P;G|EGChx%A9idRa6hlK;?4b=iNE9p|L!h zEh4`=2p@;LKN5aBob+nh_+<#^4ygmwV~Dq#H1jiR#(wcE(ip~(4ZqSDJc(vCH|Z4! z67Uw^eTtd`L5fT~I2rNT+a37o$0MJ$UBb~V3GFH`$dJifB`5@aXVOiLM4h$8`}djC zqHs3`r|o;=g*>+;eS6%TyUR6l7i``ZUFR||i(oQoKix*%);!%#jVaPBKO#7Oyy}T@ z(fjyegD|aYp}v*Q<+vpynMTu`IGBEq_p_H=ULNK5jE)(9JMH${e&OGlmL1uR%hccQ zrD0`WGc6xA9&uNGh`icc(jSVObG2b!{DzUO;%8Q&5=@HZUY_I@d|8|5%MFw}JcET| zWi0VDwRn<)?;WaN&-zyZLF4tUyZYuYnkmkK+QP(>T`rS+&)mkM3PNs1Ems|BYe!EX zx1h3^TD92y~LN9kU*`{gVL zOcG-vxhT`oM-D%Bcs76NzG>|L_|sfNH;A77argflsl)!`h~yzV7)f?m;u)(iQ85kO z`j=%ve$Kk2N&XpjlEAy_{1~eLY9#)b<0iRTpAfD&%#a=$qqI>zvwLNcojgFfR8=HL zL~q_aoAA`7WoO7}OHb3=2_lexg$|JB%2;9Y$^{xhCxzD%Z69TUHRs>&ar8(gxB??w zMN8*SO1WckWkAp+mrFiYXa=9+_OW*E7Nw0#AfA$|26iGy>dLnTmt_sMqh46`3WN*n ziOW1gT{Fd-tY*N(;N{iP0q}^nSDK_aXn6qe4fJZ-l-j&fagzNZe)~r4o30>RcVP!! zpYWyNVe=*Fi=}iP;#qn|xqpJ|KEc0QGQ((2#6rUwPwr>|>uqSMQcsE+}AcYj<@ zc5IM%%|(&8Km6zG43uks=jNbC75zy1PKC)mZv-e{D;G7@^dnoB3souBRl3DGQ$YWkFC^u6#Z&l%>mt;#{zA#qm3Ln~dR^3nh5QFEB_51MhjA@;Mh3!4hS z+!?xM*!AWZz2IfScl@Ej7p04Wz+k3?@hx)5I#w!y_Ph8o z@A4mm%38YMkQ0+Tm4p5wnY;#C?=+3#UnFPzj`I)=c#t}KgXPx9?<(k!N;}_d%-Qer zui1R>~1d5L`|ZJrP2za-f@aor+98Bt-ayR7wWVW zsZp`HMi`zyw;3C%Zq2%oPS|>zaz@=0IlB~4U4VSfsrIrfwt)Uw_t`U9{~J%^|M_R? z;B6-bh{{DLNt@*%)o~*JK#IWCZ6|U)GGfVk^F%lN`sn*IgVo&~Gt5%fFn#jI9ld5p zT=ecKnVqHDtuHwy>*Qg;d7f!&bA_tvwfH}JPk&=|qp}C=oBw%Ff9?$pUefu4Y^#3N8&{m+0AavbFQ#rJ&OC^C zyFKCX;e7t?c5x5l?zKxn?`*1>zGo87-@;h&*m^CvKDRNB+h{r0q_0Z~V^%!ld9LBg zbUXYw424MStG?4HI?3V?Ql@Cgm3I#1k6UXgMj`h!yqg6+&?glhJ7hZ}fjnW_IV13a zP^H_h5R-RVluM8#b#Ba^*SJVHQcYr$89EcO-HG#zrJS!1lQm$oC?PjH#5oxFu7w;= z3$FCPi03k|tCf7_VV;QQZC0G{br%$i^c~0jn+RD`;oghTz1bC|4dI>bDW6*M?)KE- za@Fip8XsV}N?Yc5B>%lgE8Q=jDv)b>+z@#Uc27m8oUhmOWqko131A1pW0y2g{Flcw z?3lBsOvdhZFArfv2cy01j%t}hD{!hDNFi+GI;t6W%(~1?IE1}2w{GcdK8Oy_lqm)^ zH-C`X*hsKiH!{C)LzM7alV$j9bywdm3ZZn60*l2KN(66LJxkD@1$iKHr_gVC-#N!z zygGRv_Hkfi9Tw2sJGP51iT#c!#oS(g9Vv8{3B(d zr{9h3Xx2LHvft(gFPccHo$V(skrSllRI1{=#gQQnSWtS*_?~BqF*>k=*KJ{f=j)VU zs@Fx~t;v-SBMWicKg3>GV=l|@-YvD9i(+Q*wR8V$;5hQ3h2sHSz%rq^Cr2C7lLRp9P*gvN|7?duYTYm zoskJUzHF#6`3dp{Ckz!YLN%ytD`)P$G7KVw_=w-)?4K2;JP;Fv%0^Q%u&6q#oyoG8 zwa4%-*Lh)>htC;k?u<*Fuv47xbtKhTk$_W@D{qQ8Jeic$-gKUA$$i%Sn8M4 zJP&umxKz`5a#%wycgn?)vab``rXGkMwJxVNk7Ig{%%sqMJ0GWT@@8$#gXi}=&D2@LRKGn- z@_*rZweI+htJrw|GdFHr-X8Om(H#L?FW8F;%odWXei96Hbhj1?qrSK#`zeob++;5b z209`KPM7}BbK;h5*FrV`#^#?dwhfoB1G1)R1L!As0RKP#lc?Qh38_s+O;PGF0 zR#V)^i#nwF4YHByyKe;5i+@^Ca6J~{oJtO*-B>dkY&f+~bJ*EBBt~F4wZfjPrtGsL zz-FO&Dx3YOt_!C+gJh$fZ<<$sUldB^y2noMN1%bhwW8mOAuU5x%+~BS=#Ph`Ry8&f zv_`a+dt}6ibOtMgIJ9E@=c){hYJaQ*v|S@fKV|ey6n)azdXw9#SMGl`t@tH6->3ki zp-LU@ARnnWz?kieI~UGkV(iO$&eb>vV#Pzg25}3Ku=r}P2Y3=%YpbC z=8`>!&i51G@h~@^jI`q18-2cb8+>d~%^ zga=cuL2jdW{NxA5X5nUtVd40h*T4V`{$;#Ia-fXmXdZ4~s#K75n>nw0FfRc$=%X|c ztGIH!|3Zzz(DmERPz+6&k?YoP|9o%1MkXd~_8|^0h3sbTnGaO?8085a;%xY9LX_%D)xuc4?UZ9r{= zZJI~!M0vt^c(Gi?ZMXrc>;~MHH(Gfn8kZ|1&}u)XGwo!!%FKxxI5`Tv<+o4tpuGVv z^J1}!1>0~*Sih=CMtVjVghK7)dq6Fl;TuU9(FL8?eb(j9ndYUNeM)vJ6#``vrGQ1{ z1J=OeSRB0HrvC-&t-T}0#C?Oz%np+z6#qU^B3aCF{!`rt32_;obQMf1Kqk0>6xwcu z83>eq4Z~^r1qAg)na;$c>zZ8`7&w+H?LAbdN~81N1ICni#}0FCnbJBQJCfM@-0}=ZTBkC|ccQ!E}kJdv#lT$(^M&50jzOo~D9} z@2U%!HtUUtDhsP+=u$8Vr-_`aUFn4mM?6glvG{3+#wVR)lm=;&En#-Y8ADQ zH^hnWtg@MQhCA}jtIChKqdk6xJ0mm&7l*D*hPQ-@KI4_OI+zG;9wQXZGA|pK3RwB5 z{QVVwUfy^(8?O?HsR}35B+z>97a?rmL6{+j&tq`cqa~zJhQp~7ad_D{RUqs{i$aKO z_{m?Ze%e#KD7xkB_vSPROZJ{sO4oSbu*B~`T{|{yShYk!;?C5+R6hw)6^@BCWa>za z-#`2HgR_^mux{mO5${C(kp8PhJoP=@+4!|or6;sE8;t*~JGhHAu`asMlzzVk)iu?l zLQ3!!7&cKD&7c#U`Ln8iZj>Dil2dMPlORXgss;YG)N<5PR*5E)e8CLREx9ncENmT; zlS0DJA~}8LQV6Lnu(LztJzWb%ZR(NQ0Ux+BdH6FoyU!p`M)0XXms|Dj+ixwn z;lFDdN}F|nchA-g+(@?$QReX9+Rj4=IcSYuZ3oji@zEvPmwEKhvKX4P!lmfeG?&lz zIV6g=yxK6)92M-Gqr6xBZN{f3sDiOMusz z&T{TduJFG=v)YtL7W2sKL@NNXE!Mb4N_#|_>TS}5Dsr@7t zS;PdI&{~*Fikl9i+({w^B_?fx86)X(Q7yT4k~gG^vIwm@G!4MP!?en*fKfU#4hlC%7%01GX)u$5wGENe0rKqO-A@mBzNKDl40_gi) z!UP0iaI<*Bq-e3iKkxK+!fmP>@-Z()cZ(BENnJ}cI z^N{`3__&xVV_S9SUP%!<&k@3K^FZ(w=WQ< z0}9eJ3ro%2PmjEVoTI(x#WvIP+sarIsNzW#l(YG`r>v{`;yai|4`N^D7+R)P6=GIv zK05C~pr*13k2QT-{~9JTw9c0p1LA)&xMH=aS8>7DFS0n#vY!JS+LJD+=+Q0JjO9_| zj@J16nTPPWIN=}Hh1-@eN3)^C|YHENv2&=>rQHm^?fA2&GLi#f#kzilYJ z3UQ>(6Kvjy8;UDF{ef&dDBK}26AaN!*UEJ@iys#Iz%&@=UetVN=o0aBE^o9RibZlV zQ8%OsT|-+e`HT#fJho?!vrZ`9K8BNi*7OYb&dK1G&iu!=(8sEHF$Nxv2I$y#@NhR%_pwP9BjUp_VzC$PYne~n*N=~e79WIWPJ`P!H}BW*RJG-vHc>CCF@AV1lt7VGCDceQk#4~JX@ zOC48_ub^D47fbBezDIT$Z%%uXjv_w&JmGCmQXSY@MX9-&Ol~lIG1mwN%rjO(W!uu) zIaFS#8V?X6x-8&j`h9L4d0Eo#H$d(sC9AaBB*=R`NUD3IZ?=gnx3K=Sd)-8-D-M@Y5!a-brEhzRM2HWBvje`X&_d=O^~PtZhE<-yw|3mZr=^I{lms3 zsI$(ml)CL<>z1iV>c|%x4r5W9&cNs(bF(82+plr{t7lJ1N#4AKsSCJaqDMzXyff5) zLgZ7jLu=u5?z(y~6Euk}n64ij6aaqYkW=0)YJ5Jh?&JCSfIfLwEurue?3mkjQO!Nl zoAZp3V57p4QI#UMJ4vXlN?q=>gtQ-NGXKbBD04J_R?eG+ z%^g?+vdnH{-a(g4Qb{)yohr0NR{-eyH23awIfA~W(fxZ?^(3GPJcndD`+7qjR&ZS(fSP zI#Va3rH^XtLqm-_a1@cnCPaiKY1pxANW8|e2C*E!gzBgL>g-rr8z1$=B(c>T>W-ml z)v<5CMw@6EoLX^l)n6LxyW_g`loI;VOQ39+vR=MQ;$m$LL(-=s9a>waJ&DHhvTT;b zZ`()%QcXuox0OA|YqI^)HlE_44|iCyUlY!oUQCVqlt=ZEE3pC;pZIN6zTgZSg3Unf zYtse3S(C?S?nH9eOOm58UoSWo_3gawQI+Q> z`TlXkkVz$&-`w_+d3*Pnf3f@Uz;^ojkDRZe^&-r5PC+Z>p)eiRRI1Hy979x|{fXo~ zs&@LiJFgngBX#cisE2|?sB}HvUtcF`JCFwbUc4^G|IzvVtw}WocFj~nVu_ec{7m~& zFt}i{)J^l$g1Ke-S9|oAoUfueOQc2RVIpqqtj754;MpDp=b@8zOJp@3b>YB{;mu6Q zZo1p*-n++DB+XCy(vsE~^FU=-F!97ROs>;Cd85U;G=2Oj8dmQdJ{lt;z!ILB7;|3~ z*C|l#-F8d=dzDu}+%`qoVo?$0^wat~LBYT5Vf&J}~Pkw@b@?3S_45K(S=x`5<}$Gf%8k3M*4ExigA zV6al&hV3LQiwPpPJZp=F?3LgZq{*e$PE@NI4^BD?0?l{ym7#5!5HjSt0{q$j;1mtG zMtG)Hzb@hzw^E*g6>$u$WX|)l>_r0=!uMiJD5 zmd(yof|qwjbIX>mY5eU(-btP$A$v`=$9NAZ`(EPAySKJBZK?|97%#}J+gA`j5Dvmh zw>3i*XP+{nKLii;c;Fsv$kk4iZa+4zrD{LP=Xskdiq||gKvM4cyx*6>#S|Kq#_Mfm zg1Ua+&I!%`7FBhPS@)^{($7M>H01Z``+S~lvIT}$1gy`T(p7tYDbS_6(G}=7)%ACd zgoaB{GiImNs3nINIs_m0yNT&me(nz9V;JC=W#6Xbdp&KZYndoZS1>o=!tGR-gM-s!TzcCcc#~iJ&9?!H^LDHIbwUR6gU{z=jmXZjf)30z2=`h z*gkEG422wdY;@ZqM<4zV*ZSM3_K(HTH#6euN&ATH7}Y!H36AEURr>p4e_j6YdOz#( zA2tSowR2ViQHNsXMt@;2#FP1FP5;kF{=9*MoBihtxY{D@s{U*l@ugo|=AR2c$AL-) zd>oG0x&|1)WN1pdkNw$-|Dx>Anwbxojk?v=?#MNGek!mVX(&5*K!>e?fB)P7=Bj5! z^;g6H!|lj1Vu~p$aZffuwl<#O8Tc2M05WRb{N*k0LVI3U8wdM|TFoN{3+}ki;pE^`N0Aj67 z*;Dq`!YHJ*FrQuA3Q5q1ay`)ZtH^uG+LkUP5d^}Pq10MG@S zN|D+Op3}8>Yz(80Ohp#aorgixewWDx`z|C{IWHy!o3sR z-1FB&D9(8U#6i@ZJZj7cSzk6k2ycD{ql6D@zDGd?$!`TVaOIx%JL!6h$@GJNy=L_5 zYm8>j43n!s+Infuvu$>D79R%R^*uFItrM_)klgg$|BB9qmF(v(1j%b{#;3g$-rV4Q zPV<`cE4WquUTbwprA64@XPHv(mvc=el_BLdipRuH#L1k}cnDm>Uvn*m!9ymN;|H3ajnl7Sg#MOMLHz~ZOsE7tR7o| zC$LU$O3kS418j^h*fVxAX6ea*%Xq;8v4HV$)nH-wPI+L`N$g{3Ubl@x#J0h(luDx) z>U~~FTy1k`az(n#IhvXQ9>o7c-FrYam92lnbH}kOjH0Mi1q7uky)%k}NK@%uKnNY_ zB_xa@B3(dwiFD~543I>+)X)Q=L~4Klfj|;@x<>+UpDMw`!==wL*`?7(%*H67KEWoy+KL(vwuM6x=KDBekV1~iFJc} zDMU{7<~i#ubTTxYcJxQS!%s&gJGs29!A_>X*ztVyPu_Vx9h^EW*>VJ|9kH1gU~uU! z$d)?WtlLKw_B#Fsa$E2KM%hsd9pm2lh@SLjmcxq|IUW(J{h|hS`!FpK~Ngeh|rBVj>4TIM(Rt?n2-uGa21~Fvb2!p=}Sw`@)NRr+5Dg@@M zPlD}z@U)7ooa06F^V@Y>rhI&PoFljzoCk@zPMuJ@RUn#+-2te?4tP!4dU@z0EeHYL z%E86>OGi0)X9Z!M-UHJTvAi)vb#h8bk}pGCE`W#WzWTo0p%EAJL?Z$-E%rrM{NuPyFV{YBa`@E9bo#hr_p4`Sv(86nWEh3b_f}O zso)exe25^B#$eA}SxTXiy-Uy@c6(ga%54sPR)M085n$KA8)}2j7AJ$dFVLa*E zEElUfocD*DlQ<91$_Ih6M|^T+i{H~Bx+=nLk0hovsuPVBqCsz9hmzZwpQk3tjrYPw z=21)pTsmbZa{k6g{B4kK2mV1u`fweA3Rk3L{IXaE0!Gj-DC<;63nzj^tnb+g<|tBp z-a7W{ij%PX)^*-@U*hw*9gOyI3SEa6?CrJyJV03Bm2N zA3ga#)}gy;Nsei{&K%uU@q_n}uS35^9e-Jc#1c`n&gv#De;xNYOp@=$`A21}%`192 z<0DtclZ_pcgAxTPKf+$k?tPL;Ph1eADw7R{Qys+GeXiY~yf;btRLz1W)pXVu;R4r0 z4t24UP6=L1?|?|5yU4YN5I}>nu6&M4`pzrg?BEQ4 z{Vwi^HuY5>@{z}%d>Z`dpGmElWNAY(8{B1pF%!sS`99#}v!4anjG z2OD;6hELVW)iq^N_MH(ujhUaq#t`1c@GEhj4QbEjyilZ}xjB3sIGe4jHHjKgkGq9}ypMEZkt` zc=@p?eX}n1bNy55aD=M5)r+j~nDEL0;4R&a$f_y<lG z8r7Dt{JatMRtdG{F9xUfqC+Y{`gB~VyF;$}rxPvp8NchN;L&7DmpYx<+p(1h zj)&gbV)X`4CWOP83M@L`)Eg-8Ff{#H1V^>kxF*~t)BC*I^O`WO5h$qhc0EAGjkZ3N zw&gZGi{}By%Shhv8F`cKTqt?Zik5RaHcK$YZ&RU9r==Q@Y|a8#M$_mw6E75b*&Waq zWebi1_&I-&;-AyD73B?uUgMT3b5~4|a((;<2WSjn`E{(P+>yF%r^M63N~K*FwzW&h zwM$tnwjgWQ#|9FetCFbuM~_zY*BJ(B`F9acHCK@++ra-$kMH6z6W=>s%^>^C{1mJ5 zT{renX)Ug=zUfJ=UD0S1Y02n@k^V%!&Ned*CEA^ji0*EFMmh$ilQ%v z?n=rx22TH@?LI>VZ^uIEJD>hlGP|u==SK!3y2-~`4DbP?5q*axxYADx>-JBaL+N@R zf`5}lS&$Z6IIF#*IWn6{`(4CTB$NJ~Y^UvrrR8bCmheQ!+K1nmVeB?JCcbA^tX&$t zT??-=p}mvusE}WpfmR+VA#??XR$&7f8QbRyM)dm;dpbXmDBlzkBjgyGj-cVQBH2kSk=X5!F6hGuFWU z?Kk?0KE6NcD@@WqGx(LH&b!)-@|tJagpxVU%S4ZuK@=TWkRaC5u;0Z1KD?h-xp+hj z^*wP(IFPlpjlml5(J~IH`!fBbeg!_0Aq@PTcOeuj5Huz+q%MPjW_E1Y4NDc0R|f08 z_1S8FPXW;zxj437!hA$s^ds@mGMq7fs!u4`POJDr7>!zZ)3e#6ue0+TQ97c;v8tN( zl%fBCAzTPgiT$t<(o|+$;bq*fhlMFd&eT*6fg>KQ-*jq^t)%(|vfideaV0ke-EWi6c+HFK8f38F zzwIBr6O~OVvA(LRP*Grg&eeG2&RgGdLRCRQbaZA_dAR5HZCik&o%+Rbj+?RQ6FaG9 z>(3n3)yNBh=^GmDcz}hP*1CGDvfveJ0+gTzd-pu9ncMD%65tt%gBLmlJ5Ci{WSjR8EiA;bAGI{C);FwcadCl zDE-*MW4v5+Sy^YH=WCUi1)=2bGKR{dmYUNTc|I#%Pj0-8ewkCJVRuL-a|vwgX`@r< z?d!~q8aK%jyPaqe+jo$XQ+5xQVJ|Js!1SA=zQ{lH(hj4-q>=c(;D{rgM$v`M?@{Eq zEkL)#`U~W3=pv!#z-(w-cGMlSr{v7Y8Akv<`C*ol*Kn~5ewqkSvAe3>lnp?n>n!Be zP8#Y_S@q_8wfT|WpLzLRwF?o71B#^DZ&1++==o5qj34Xv4!jDNYx8vF0qX~@mR^mW zdkIl^iDaW>N;(5_pKc}!c@^j`^5o-ylFnS~#yFVTY=miw7B69%gUsh$8qzU>{vKOyr_y{|#n$L2)`Nr z)(TLqioul6yumQ@`%pls%>%u$u$9 z(B6V>(7wjqVC0%WtRr8mOu60}9DN#aO=dgO#iF15h>vj zHvKYuGJ5M`X3Df$;!J( zObJU#2%?zIDjzZkKA~}N4LpUvXN>t`-bpz*pXFnyQM!I8%ceKqx_*sNdUpsBK+o7z z{`qamS_b@p+nmfdCmjoQ&$GmAU-~qDs5nD&w3N%VSIK_Tett@TfSb~F_{tAZITqnQ zKQ{4bA4j`8PR+DLBbGsyNUHpD9twMUn$66p_Em3TjJ0dnthyRDxZvu`dF22I@W4th z=>Y|81NpQJzTd{Kk|4hwY>&x`6Ic8YpS7P5w{J%mjNIQ5T3r#@!L+BAYknFKC!Yyd zt$$_9pR34~10Eq=k|x!v%v5vifH-&kMltM}2@MBx(z;txPslf|d7R)5rOQny?a;~| z5~Wrn{ppHrq6Ts;qcAC9&HoAXu=EfZghH*^23fu=LBa&)(b%oJ*fZne70wf4nS=pQ z2z8(Dlk>c{+L_m>t3aA$7Z@_UQGcLhzjO1MKQ|rYeSG$7a7kWo=a95);mgdRP3Drj zVYFJGh~-S~S?T4Q!AOXn2g$xU?dtgl%>*oJzqwk5c-|4hSGSr9wXjWdc+_@#`^#II z1h*yVA%p8Ds^S$by1CcMs!_W zZZ7CSpn@Y2L-YMP-JAdkqp7IUY6KXc)f!A{@xWqGyECP$qMJDdkQoQm`w+p=c< z8cM%c|LSYo=EGaHUA3yH=GUt6~OV>UnP7Ze3S=kL(`J{T)xw!4tea(JP1Yz|@(Qap+#A~!l2?`{frX~HS?#Kw5w*HI zfTiu4bb$EAs?-CgqZuLbO8-poKcf08QfMB~c~9S(dPjvQogsj&>WhQBhe{%tey-1PWABB3 zgKgB55sw>H;$dRPn*3y_yp{)k*6_ z1CiVcOZd}Ui%y3)BXMFtg~eRiltnt%r2i0^Xs}S`3S%TyWgt1!`7RuV7Btp&NkZKW zV(HbfrF#b!GRL&MUcDIL7$Ns{U`Ow!THOK{dJAvt>#X}sJ{V&zXWbg|TQ4~rCC7F% zfwXW}a3*3E?Wy&V4c4(OsX)s7GU<|Tkw{p`68~j8Y~%oU_Z1G<({jErM_L2aivP3S z46j>XFlhgdpCb)ia4z00re5_#S_a{=C&bV_sF(zf0D}rn?0Pdt-nk5Gd;ZDKSmXYF zDexI}$3!Y265n_wKREa@(QgyBIy=r=uk?6RJI!*Y0kl+gm`Q>q$#CgVO+onO#CgYH z_a#tjzG>qJL8xv6yS!v-aE(OM?Qd5Mc^uEz5EuV3|*k3-aS0#Hx1Gnc!H0D~Qx#o83 za>cc@V~Zojcu3ZzWo*svWCc5g%OExu=Nu!&0@&&!j?zx`LaUC?QXETljO3d@esA_t zi4wATjD#p4!`)>e3mPHEE!V<$OIB0m>6J?-)H8B)Jzsb>obw8U&hV7>BSMK}`xqm- z=!!%s5G8+UuepjY>Czuyjb$v{VxDPA!q&NHt{?PPAC?0t4|mf9knC4XKrsV|{WS!l zufopgN$k~KG|h!u$j&l03)r{o_Z1F3TtnW!lD+5S%@cJ|B~0M{STlLL?lH9e=i@XB z`5tA63J-nYuv&|ytJ5&zc#WH&o2GA#+p|);Yv#H0@}*Td=gUNY_L(!$@riPt@*aCW zdl|%1jotxm1#MQ_k6@XWFZdD8e!2}ddya4?edw*Q!1?!bW7a*|8|un^k6W=Ohrcj6 zmu6eEaPWwnU(u+L+uQ8MleUb_3hEAhq{`9h>Ou{=x+uS44t$^m@1At>{fbZZjA-cZ zxtXtBx!Fm+Xc=)(Nzvcf$q%~6h&UBG^$PTWP6=>T-PZ3#<(?exR2|Pbi=c)H=6tdH zl+&|jGI4rurAg;_Q|2fOwTLS^+h@ES+x;PkEXIp(3a+`8EiZ6uLrR5~UlXk^D(}Ic<{cU%m>XSA^RD5TiDey+I(Cb&>i&u7h$? zMnR>dznbJZ{^3Zvok)w^WO*c=tzI(HNKrR!>i)}*cO_I!_>AnIBKtkRdJHQ%T|oP5 zIs9a-a`<#tI468~5NR#wmiB%WJbmYKY?`itt2yyXTRr7-T0zU}`AEQ;ia57vyCttp@69Jaq0_jkxWbuSy1Q|f#w;Jd(75LGpbD0DKEm0Q?fF0RpA z$k02W{w%B5j=cyvrF^OPLHo+6-}6Alg6576#zS5N`|PAK5If)91{P@9A#B_mk1irX zTxvdwd_D&l=aI`$F3_7h7o}oAqoF|rzXn+K19~KLhwrB{0o?2Sk~v-dlcf>2(ZSf( z-4_Qq%?2Z5;9gB0G76sCTxw)_f9lX|w39wsZ`t4~gC*@R+24C4?%dzqT~3^Oo33bKbc^fu2?)h%||`k$@PsFf~YvKv?_khX`pG? zJN%}2TpDb$@4dFNXf$;C7@c5!Aor|aHDZol>K>d8J8N<<+dG&2w z^{ZFefUAvjVfLE`4eNqtzAoxI84q-_j>WZCPT>-U;zFE$ycC> z2f{rgZ&QRRY1aIS)&rYl$x^ISS1Pyfx~Xr-P&Q}0ruWr#zNJJ18QSQ%{!E&6g+W_i z?tX$0g?ZK?jtFTCTt`c}oJnsjD4)FvicS4^^5qW<3o8z$r3Aq_nRpKhyibHN zw_1N_4D?uHlMUixni14VFp}1Syg5etf$7`-#J*i&3Y72v1>4?w?@-1oeVJx9|9o6B zh3;Jz5@gj#@|6`{6~-x-&wV4J&ByN9)estuA@kfp?|M;KToZic=K-cm`KOa}OJ7T?4h;fe6 z7PkLC82VT#;I2+#)m>zopLZIdzb+lKkxGP|;7)e_ppp7P&Z}%dNQa7S>fuyJyQKz55^Tb{6epKKJ{I=yh@8Z+j_P zuI6SPoy)(OoWb&6r-S=P#2-G?@5CSWc2^~n=|F1k;a{eMP{wo+$Bv6c7}EWULr>$h z(vGJT*k04xXTs7|Liy`{l$>;;gx=IM8=X$;epI8-u(u+wf$}N!IIuE*q&(D~*8h>M zRFku!S2D#3-7jxyE8{`CRup6izJhZ+uQu6iUf!5Sm)8=>s96XUE>E2KW{@1mc1}Fb zs$7aJ)b%vdfb8OA9ba1nRbRIb-+_9^a&*7uu$V!j0gaRpu{q)QcrSXG(V><9>{si} zA!HLuD)=Wg7PvH%_!V8VwyUFKd~yw3yFr@?-S9go9;jhkItp@cV|>7oUJ9~$g7GS^ z;ACk4=t`Zpvxp8cjTTEFJcZt)xg2q*f`Zkj z1FxjzY4KCe+>_!HmRqL1Kf6zf^K}_+^3y-NX0nUwhn;NTxKhmt1hV_zuDiD_Yrz#7 z6w6nkDpu11^ubxrWiQDPDuhunm!vK>?h9HERu-wPL}i^+ z?iXVSr5%(4Z>lR;S=8F&SzC@mL22X6X8b{ED#{|&d)+{w!xnugFt+o>V@$;>_uYOr2I{OV-v9kH?-PzU=*n+|J4 zXy)iGrj7TedgHfN^VHvyZg*qxC;%hfPVEA2H;b2zVQQ?qrV_f2^dttK>P+FhcbxGP}7?JYScsCt-2%ehtiExu>`KPdcJ{>_azlb4pRO1TQIQnZ@ z^+R<(NL5{5!)R&=sVR}UT9rRp)T#E>y0tT}c7Q3O7S0(sSbEahh(GP?H)qv%`KW?~tMzk7&AKMm zJL5&wn|pZzXDyF&rj5+KWi-|Jq)u{n-gCq5;1KS>mFG*b(?H(a4T<>W zMsYmjSANpYMZBvqx$6F6Gal`qHDDx1el6h1gXLWe8Vzd6LJReLj8adu-b@cvLC@|^ z*j?-Fl8b@(mz}hGa>6di{Mv4ATmo3qlc$jGIUHMXj#0WnxNT3CIy9BMJ?v%7z@K7c zxr1qBNbo)usdBhoF@i_zA0*$=Y0H7`V@9}%_;1))`T=PN8;j`64?eWS7+dYvQ4u5A zR0Pj;n5KAG;EJDZlqmA2y7PRUdjn-Rq?U&!pT4+e*HY=+(jZ&;-QmqAS14s+ z`C1~+Q_Uvk0zY+k+!!HZJ6i7ClahUJXI@bBOWOLwyO!M7S;A)ngJt{h^Vd@=(M$Kl z7phM(8E#i)1n!vM!0-kf4)&%dZ;Jb5Xn#m87q0R8=K1a^nX-heTT!fL@hUsiig}h? zYb|J&d9vkAfM}xrV|bCz%qa5NmR4~~w(dlziuA7*&#z1z_kDHr)#1F(bJzG1sM(#c zY2y-(XNO6V{8n}r>zh-*+R4fq2jqbuWdWqowfD(}sVJ(6b>!2K5Sx!Fk01|-5RS@Q zZ4+$e@9f_Sy>^kmc4qm|3x+&I2B~mQje=rDo4QzF3mvZPC-2EtjFbIUsv2i=iUxshZl#k<8EGtdTtBGeY-j{*ce67Enif*O6sE`-9C8*iPR{9-fCOxu}_Sy zpxs;qOQ}V#fUdp6&O1iHcZ&USXw9eXSuvvp$|?xuNW44G@JQV`!59%CB^zVxB z1T=u)AGLv@NT9M9%Y^{L7fdYg9**i<&(xWhcB(?O*7LIe6c0KGkj}}PqKDY3Z08{} z7f8?*f2HHOG#!4=*eQGghjxLYSJ@-CM;+0~IA!tUTwk}=^#iZBF=XPwuycIm-KAIO z@JU)zj%XL{z!@yn4NWa0oPkeW;wr^^&<{9AN+>&m$2ZAN85GadG2alwLywu8aapPF z!Z5rSm}7?xm5Gb5MBUSrv$>MEIyl5MM%(UDd#uFT$~3w>(jALMwO!O6&2I(ZL|T2} zr6ztCMEeq>mp{$g%!F>1pW?uddxs7VETh;sUYykAA{%=PCFwJDJ3B2U@2r)lj=5=H z>v%$L8MtPmkr)Y+LO$fZmPr28Q4Ce_$T;@lvfFt>a;b7{{WBRz5pgCc%c%TNPyJ_o zT3ReunRnji6F*j*&hYrGQv1s#;Bm9c z<7V8IcCfu#_%h-x`J)Z&bC~bh`se?fvD=toDgdh?B7eJ=QJ%}%EVxtdvrWyv)g{~Z zrfoZd`h(Bo?{%bkFmJHBwETDTHJWgmeI7aUU#<&&%4|GZ7w3HF?9VL7$XIn~`2D{& z-K{4AGU`veR6J)tWxt@izN1Vl#bcw)_67gFos=(_NwD7Wu)jHB^Sw6B#zpm|PpecZ zwQ9rW9k+3Ldv!(^v#@)uX5~-+YST(dvlV4bBBG_u{3wI49r64m%YvwajJTN0W(>j6 z`zuYnlQ2bi*zsug(XK`yJjW9-fisQ~Ivk&1#-Wvn7owv7%e66fQNvviAiZ$g$__Wb z$g-;K+WDX`Ddks6cPbi=9QLPyleA%Zf$!B4Nnnq`v4TvgKmHJKazG;8Qsq$_ow=a|8Ns2Uz?(iWSE>RXRe&2!ax6H zw*QZR??^|!+_0^(>;LCX)c@N}#K>qS`qeC7aH;y;2kuqcUw%97|IH~gSIv0O;_r9; z<>dZymtZSPAyUA?4gB-K<9Z=_j@I>CGhY>&bmU!o9bcBI_?)jzvdc2CNCQ5|5{d$ij ztiV`+W4{&#&;%j)y&K$we=&^hVu?z64a=}V_mxM`1zql!#dtt8+wX-e5|Oo;EVvKN zaY(=Y_jo8FRQH2O?R>Aztv1cY+gLmQ+sa=<6pw5nS&;$4F~lmRFzEHIsb7>s zd`uZ?7tbhm>#X0e)ScqDmE$XO6-13;`PcLL>jC~)Rp_FM&i|#AkPow{lp{qM;`1ghg3&M+99XO8918=9}C;s&^11Vbj-O!4!*pi@dEP)d9$Fct`g()MX9$p26 z{AEi<5V5dVEXuH zAT?If@;?u!q@z4?MJEgc;Yq$-Qrly(#}#z&7c?=FF=$(`D#Qd+Xkr=}ix0ghh(eXM zzo3azH5q7Pcolrl`QW99))T;`(aAvRsuJ??Ad_nfA96{za0jXj1&bB#jA2ZDpOkRg&%Y?G&hePcYtoy4b*|!3foc6} z^@X#&TLJyX6ZHd`K>CMe;rLUJ@rdzKyNv^&6S~umIp^OvGj z`GVY6+Oc+BvV{Tc{MTF(^n_G*QpvJ;^&F`mj2>kg1zg0DO{m;6T2omm?;Bh=(NvNv&6GbkAhp(1`R4dL2};VmKK+x2X= zbCvZD0P>3^LrNFe2TICeTEpYZCv(pU4AH;6T{WGxb)2%WNhyHmZ@`9zlnN$Im(9?$ zlKRhfQJ1=5sQKJ2Fce>eah%3YPozo3*Dc1599Q^qf=Z$b(pygKo9$h_#wMp`>_ZLe z#eT&{5o;Ebb&_w>f0-JY_iwNz+1~$;wKCu_xw(g z>yLjogZtZQ-QR4)Wm;QctNi;qbGOF{70KdMKnL>Nx*vp+I27&+c=czW?B|g%|i7d~7YY%Wlu5no-#kq{M(2oN}Prp6R@E z&hd8%(^bds%p|McD!VtxzXQ9qsMq>H6*1ee3%Q%T34iHrHNj=(sEo)ZQ9rsYP~qtP z-f9@QTs!-n=#IkWi*Wl5CAGH%=f-tW#5Zv}7SyJ8XJ5nDE{>haMZel|J2#}XdJLN) zlBLY&l2QY-K6WO%JIlQ~*C}9vGLpVg$*s0FJ!d|sxC0`AIZyPLV-(WW6???4NbNbes<08^Q~fD`29mA;pI`?(c3{ehCDZ`6dnaR!sF zC2P6D%gg5v&<2*h3cY7l+N2wcgbp&b&s{i0vSf1p8F>*o(5dKtjpK?WUXSFZw4C^S&M4S*A7a9GDFvE<4-a^=Xv20RylieKL~0te zrV7|mfSm5QqPiue$D~;j5F(T5_AcMFnDKhF#IQkOE%hD8OhljUSed@_AvfZ5CtS=T zHnBI|>0(ul8X%0IkZH5psc}WS$*E~h<>jK1`4`kM_D0EiTd2Ir<|*ejGyo;FM|U~g zu0ys3E=8z=)X8~Tj39GCx2Dljn21`MRf6BJC30z`v!0!LxygO@MPWTRaoaVCh)Tm$ z8CXuDB2COWcGK5?T=aNB{2>RL%!2AjPiB$1K+m=id65HBt;-w;Z8nzONbvZ_G8k5P zmm7C2p^zde1g(|_p#&4DR_Kc9YO53lQ8FJTJxg8BZLpj}g8WvaN&K$vyL&WPcx~b&>UF;xJ`|6FZQOJaVRd#)D@f~vNn^wlqWM>8yoaa z7@eSTj}&7Hix4cSFDOnscv1$~1fz$$29t)1mAs`riUtEp_CLGBGD+KLY2jlpqR-{m zUL5wcoKlr5KP#G1T6Kd4`#^$g5kWoup&$-ndWtETuhj!RWp9Msz!-YV3#h`sS#6eK zB7u8dhr{vsEI+?_AZZS$rQ}LV>Ybe{u&4#8+JGQC0=dr79JX|Qmld!3-A28qgfT`v zfTtpxSYM(9uxcT!PTQ7?<*ak>331nxZ!iT}FL-IEY1njn0lF%Gzb$TNWihs7W+mXf z6R%*bR$2)x%5|Zm2s^ZZEMC7H1!h7Uybek1jPwiP+TYYI|_leg80oU$<4>HK%_^{tkvym9M-Q%1TDs zwT6PZ%@Y8lbsL?m4^@nSL2Ey~y*Xv3ZS#a~rAMzZ94LVIke4MgKTG>yhU@%S6nt$X zU*(F3PR`{Dh$WLElG(kP{f4vF+cpL6&kLXDYLZ77;$2rWa;48G zr(5Qw_6eaExOOMa`}Tzs;;~fpT@N7XrGq+;w!RC`c14iB+n~-bTqC4Yr*}$Ija_1j zWE%ovcO)CHvM_nxrZwv%FT>fr-;29YE1UVPYq`j{B_W1mZKX5|T^95~bu-DoHMnfc>f-F$*SqjuUQ9k% zC{ABL#K3SSd{A z+p={WtBCqq(lW*E#sF8*?I&9eFiFCDb?WExO{*WGI)5O&fx5d!^d#u-Zh&0$?niQ4 z+_kCT53krOxPaJNatvzz!gA;ms*2(Nd(&y zd(-i3wvHLX;C_aTc2=l_E(rbOZ-I{Tx3rsE05GNIQt&+LsWJ3KSQW!jk(|~K; zWe!|#@?a+d#*OohIhC&Ct`Du(e;?0R~`()LiG zTld1T@rw0$6#ICve?LxXyL$dQ38tyz9-S)Y4Ux?eKOgaRX_WLyNo+8~*`Kh#n75bt%XJWq>saOCpRHtEfh*BDI4qEM1hjjCv|%VBFu zQZf=rua3-yhZr?*FRE0PEkhk{B_9a(E!QPmo5hTHM|$XOXSzKuF3u`-t{lYcp+*lr zoz*il9XXF){4j5UQ=ao&80=U`GYamUr>3EN8NUez`S->UNS;bd3#YznR#ht*Cq%?( z#w^>ZH+mJvHwao&NH24r3cfM=eM%-*aZAY)V(K@^=HPw#QIA>n<}}H05oAE6;;crw z085?EqQSCoEGk8`L2~9xsb(baF(}ZWX?C5`WvBo#_7O3Al`K*Lb8zdlPXp+-HZf&b2#L9D zJKlM6aG81Ibj0Qe{_Jhf62Q;>yXVqY8V5GL$Q^~>-1+bmo4#S3aaXw6bV z+VBdU&Nt<&(nYo>e33fK2R!{LbJKJdl-3w1w6trdx>UDAgfklImO_38UPg>WZdpAx zMU3Zd_0X-hT`6!uSXxLSioxZ}X?+-E!jb zT+UK?9ua|xL+0&B_Gr4lpjv&byE+l{gTiYDiZbi-_Qoa(ZZ zpU+3YH)Frop@FumHIx4+W+g>>r7)sSrG5U9%;gMQm0k6nspll#+Vs+AIQ}TSn$Ht9}=V5`f8@!gq zH4BXwjSfu8O(H{P!)6o*-GsSuP78v+pv!|}Fe5r$|zeWF;tAliEjZjKJkF(uXupnnQtZvJw%`Ae^m|8^k9J%VlD zi9dryE!5~L`^^>U$yI^7es5;{QHZx!`~yyi^>Ie8he2~2YCL|g9m(D7uM~5ga@YRY zxO=G2{O$2>cAIF6ziBKYtFhV6GqDyLI%p*84q#@`wOT@Lpz+3fXA|_Y|EpxcR%>H+ z+(D(=%7zOE=9t*lk78T%C&esdc^`qJ5?=kK(GhpY`#5L#6%P28V=CG4R1~8q@>?i0 zH}2q$->$E84F1&>#sOi3;q4pMc2zgiKX8^n{I==!rM^ILC1H?c0#T|XVDm%C&jPY* zMY8joY;J%&#uWCb#0H28cz**Ee7FtyPGzR^oyx5By2ipXAy_wf6p;&2IV4XZ8K2_G zhZG>l7PO68qesY(eAMaCP;Qg1S!V4Ps;hQ~Jf1J+_LbeefjN&MBa4_F3z7fTD%8egKn-kP4W))l<*^omX96t;70 zy&yZ~yxkK&nU^Y)aF;KMv;o8A7oHw>Uwz(u^735RX34^WFk;NrY(ggB#X;S&pGzX3 zM_F_tJQtkcc1Muqq`=kj4nCjydzlf9pY$?ajU$cUJuWzY`WeM)Q{rJ3l3)?PO3Xax zg4w{EmxmEBRjg9NWx!~SESjg-rU;sr4#*4AD~OYlT=w8fglT}2&;Me$H~Hg>;nVwh zhS%3l>Q@B*<9zw1%klMp1ahC80G(RFpPockW8B&$S0nbumlMsJ1UKCZ-d*@vO<_YrLd+d$E2{>hr*Amq*abikl*sOpCIr zaPdL&=ZYZ_)V-O!Y^lDp6}X{zyl;gC$t>u4C*<{wk1q} z!6V8yZQRM|9wio-(E5@g4XO@bS>ft+6CsOK%^E1o2EJ*JFmtz%U5uLIWxX1`Yuq%r zk}GRuUha`87W+=F7liy2-mY8RtEr}=Cfj$8D=fRMGW?nt(?w31Bn*kXu=M19z}@&e zfY8ic?D$2aSf&-()xxNApJUE%x;*$Ogp7D0uaqFY8mui8pz55WwFnVjR59NC8J=y~ zl5Yv0Qug8{ci(xpzaRwnRoiU2wHabJl`}AFrNVED7SE|>0Y9BQl)#fbz zFfHJ%m&HC5j&=DaZo5;rf@Op#{b;4o0`l=N(yXnG5-=;6q(5T1?5cWT_e@z(#sMFj z7l(W(-QP9nHas^N9IRiBHO?3&FO1~+fb|LSVnU%^OLT1_Odyy$J~a}z23#g-)if@K z4Cl&SMa~3fwr*@}F3Bs&Kg4Y^yH`P_nisjA6W*S-qW=29|9V?ycY8^!lM&a2+?B?U zWqK?3IEgpU2X%D1ep`*uR=lb7v0rF2TxncU;YM%y{H2o?y1atgb> zpWVtxuS#7YyRJ@(3+RgCt5!X21fwqM8bQ}4e4l}4olxwZL?0hMTN=v(wlQ$``COt2 zBDYv&+;*d`lKTqES*_k)!Fys&!e7}@MT`(7Q2sF2)7$5br4Tyo&BYr7iM#8lTQ zxo?NNsI1Fv@;inV%ExFZYi`;3qv-sXR)rt_+smfpgp--N+_ha)Y^7gjWP19DcJZe7 zZ6%Y1M6X6<1_DNFzgJ>e3M;7Jki;kHA2g%iRW#}N4>x1i#wQBwGN(s${2Nu3b^Oz| z?@1S+_G4#(73+-L$#4}7yqJ~mJn~f7s#koZ;!CCNE|<|gH(agUgFVghTPdMqYA8aJ zZa}F9$Z%XH0izw%$KksI}YzUhK z8oi>@)2I-GnH%#|7)48GoYT~kSL3FEmt_UNrWuuMdC;!rtDl=mwiS>m-;@!_K> z=7{T=vD+3ai%RSMmNbXie4WDq(+z`k5vf3E4G}!mpVWDr>rL+G#BSkli24hjZX5xudXC79Q7ln-dNNhyu0Q`kX)XP<#?j1WPp8jxLT0vnzeEXck+DP_V%ziiX z*tfBiXn@94D)+I4XOB5Hhh8YAf-!5itcL*w=bB6s`{K4V)i*K~-#;DMUdLAb3ZKe| zO|j4VFL{x~T;r3y@z;Ay5Os}qi!bKfHfrWGn2!M zgeW|n@cbAM{L|*E(10KQ$XNLwrxE$N^6q|5csWwC`I~XcUj`QcXM5`~#<+lqBHm?^ z^C06!97XLHVr>Kn@bX)gvL#Dy0{~^yKL>oy17mO#-!>oX#M>!Sn1}p3XPQRG+k#>j zx%$m4FC?#)V3}Z|Z-tDY3Qfj0jB@dh0~(FGHD=QH6^#xwGxOnm1i?mr?tTTXC8LO- z?n=?dm6>fL6|W7c*U>Y1&-@Y$yUcN#qqwO_gK3pQ`ITPRbj9JrLw>~l%}9pe?nKFf z*?xb#A_?~o22;+KS0vnNo!7;r+G%UpX|4AdE^@5?^Z4cctKSENj4@$kVRIB!GjiMW zb5^dJ&b;0Hl3$6;o`nC=xav1cCeJ;jJusnhCxg$SyioNW z(M2Gi9Y>(WIiqq)u+8T*cQyAlAyTq(ZU{>MP?xhZiB3sxZ@9A^Ik{(begjocKB zIe1y+-?qikHyAP2|BzdDD>|h5zvh;;zW7-<2y8(K_J$Oc5nLY$njL4adWhhw_I5MS zIHyZ>%Tq-qnCVAGhwifgx8YPju$2;+N#*4C zjm&gNuZoALPi*5K>sxe=!;l_OvnF2m%8L>Pl+S^w1gw-#;UZF`0t7aQ=E}U9G0SKu zHcu|tEFiqt4QBPvuz;6zWNZjn!ud|`SJT(m`h{B*Innts;kRjnU}??kI6T&L)5}8V zd5^qkVf!4H_PrG_{@Ix_d_Q{9Lk=UPHz<%xTf<@$FP{#7z!Ud~kAcfL`Wgnu$6SzF zaI|QgUSn5#`m$=$&+SVsd!<4{NI{9r*4vE}mOw93m&;=Gi;q_L;MQM)B|ew{sO=F8(`!w z2VFY;2^RC8Q9b|lY=cdI!=F&8hW`aB^_S}W%R0_g*vYh#7I{v90W|HsF-01y$Xdu{tje_6^d(V(6l6I}M!c=O~htcH7ESPgX} zX8 z_=`Fd?lJs~B`IW^5hz6{tWmzl*tyx4Z+FimF_t_DZyT`HUrOLIxo}?g%+hMZu`^Y! zj*evlvk~L~13genw^wNiZS`DD)s`P{UuaWizFV)JIkG61gu^Cb3w9YmY2Pg%06=xddr=SrXs_d68n(jJoc^OR0+%369ZE63aMr@FXwDR{7#Mgo)SA% zjQh&13cUR$gSza!IhudxOs+#pYvLgID_5(sFGGW1@{^y!@;oI;)8g{>yb-EqTL z-mkf5RpG=&wqK{ixeh-Gt6ftWCRvmg+3dEFEQWRWmok#8f~4<5xyUkKdR^I zw@}Gv?F)EG7MVrPV4gaovZRgEW)jHTqF7SAjqtv2X+=61wmpjpaY6=)**>+f#OgID z15h1Ji!h7TrY0*Ys{K~K%d(}hvmA!C+71+$1I=O1jJ zCC)R!EA2DZ1Am#hI_?@cxp;Xn z9KFvXtjKy!r)ECLs`ksKflCy=J=t-2%rSWe@eK0krm;NwN8p<6KM!|zBjTK#IEX=m zXo7-cRNHV@ZKC z$bWCGwjx@|JZfPM&hxS>lN3elT$w39{u!u==ayfmtZF+@MgG9g^KQrhF+|10KUMSZ zEB(h_ci5zQa_vA7(3;Set+TDqARqJoY#CE+bkq9c{pdRzn5Bb@GY40`w!Zti>0|Ms z^sTOM|Bs8Az|#|YUF5g5JJiq%k$LW@3UWm<5vb;ry ztm;SEYyVPglV`vY26)t;ZLn9%^=P`QJu`D?E(w`LCpLFiPj&}8b?j#U(N}*;=r6+m z>pA&pby1MCS{Upx&jBM)rmyLYguJf1^Ym};DS&`R|2jlg5pl)k(Yxw1FUzCNr$Zrh zr-638(P@({kLCx&9}9>-@K5poZ{19~;5a9|f4!;Z7}U;r^mXYONSQ+Qs;4xr3$5hc z6t6NCoG!7HsZ6bULy(2rmlO^wIIZ-x6dymL)wQ~ukI7?5C^N228{6m04Opf4>y2xn zKgq(MTe0lVqTC)ky{qUbBel#;svjt)Kk=QYsWO0>c*NAAjTT2g{Er^5hr>qTjbmE> z_6a0SHPTBlI?ium0Fw@GR;|5`uQ2j(PDCr7{=BE1*&rkBk~6Bb`$G5g3tiBJP{6Is z`8Yw(UHyDpo6L1u8sUu=`85#<8kKhcDu(7yarwX3W`$!D-31^j4y&l2$TuKaeznFwquULV)dM@aKI0Lq-gLUqgrG>YlVgIoEaIuWoG36=sTSn{#_&&XB%=E8m8o5yt)qRkvbfu%x za4SYpaB5ST^GG4k)Z98QDP!63&1y;Q+`Y^I~W~97ezcj`H z3%H@{WhVP2TU}GUQJHhiP>d+~6DRM!loF#lS<7IndDBO{ zZavjPI|-YWi)xh(4$W}(=5J+WmF%ya0XwVC83-JEando)H@xp+h=J&{Ox(#p!KALS zu9}SbZ+es%SXeSe36{~6V6~_;M}JG#CtE546IEC;7*wNZH;?$iQeY+9J(xu8yrHE@ z%P4BP>1vz@!x&i**2h0VVNxqTttbG)5Mir*@Tm7iXRRt!UfH6h+j}C1i?G6T<)ix-GTI@#3R(W}WA{w%%y(YXUos{GPbD!&Y09uhgBfTQUZx^4duIN za^t$-Q?IqsOU!=xN|hew8n0B*LmTz>P?$PzWa-f>B6Dn3WXr3K$s}}-0Pc=Et~rR@ z=fzuuErD5PGaC`ob6u16GuE>9)dP2Uf@KtWV;1mt9HY*WA6gn31QQ?qE0f3#Z@A)t zROF1$r|X0K&Jlc}*H@&sB()$4QbM2^#}myDe5PS|GQhT1kk}P)T|=B$zv#mX5w0J` z<}G@7^wUKKaUIOEL3gLIg-l*MwbQJ=q_oO9Y)Qh^_axe;6V$v|%XB}281OcPQsdPG zZMRr5XT=le!PYLl=*KSojXwAaXgTdRen+9KL)EoY#aC+eS%}YHbjB{>H8GD8fw*^< zX%9qvJLLEEN#Q0-0S;qJXg5}3FlnmDEjN(0-)`0 znEq2b&{l4cJi=4FLZE-U%-6s8QorJOouz(UhH1bac~j)Hqf5e+;CM0WuE<xK`Fq|~pq zx*H^OB>unj8vdV+1i$A`i8IoG`LnGe7~n5d{^lL~f6eCn1pGzKu!7&!c@wIjRSfJO z>0oA@@cLdvpme2k!@V^t_0x$R6aw=SwpZc& z-qq~2Iha$YoX1+z@h|09mVEylHUIgJ`M;fwMRjK@2);Y`Mg>Pp_mF(Y^ijqc#r;H8 zzkc7$?aa4z&p3WhDx7lGkiXr6UrRaoUU_wI%d>B#<*+_yQz>uCixOXqe%s5N+Qa)~ zt9KbXO1r2cwbr;^UwvX+(BU!I-P}x%Pvuv+yRiW(OHTR;R% zM`FJ{xHgkNNoV&!;O`O;Foks0|H0~Jzf<>_NJ<}&Ywv-)o$8qCE~QU5^>sZ`YD2~y zI{r*bDB+Jp812u2>!iLWw>JnLl?Isl)I<`Ws`lBF^)d34*Zy}>nf8pWw#rC_r~W8v zb-v$LH}sF+0~vYH?4$&%;8Gl=izE-UqSIv9lihPO0qIAozQ;4T`g4h*R;BMcY>>p1 zzx?RW3jD(t50srOA(A6A&aO4Vp~{bsqP=1PS{;9Ne(Kd=(3EOdtp1laZ#HWuxDZtD zi>j4`0+j5)BAreMRed#goI4c@l7?fSZkHP9dkY+{=!q{~$xHOfmW96!KmoDW?rh#J zubjUyqr$tfc*`@oaI-ltQc+OYQ#VHi#h)d<3>EWF-pF640?rG|4~hNDRn?w7h0daw zN6!6JYM5L4%S_QVi`kx%^|VJYOo1$Q}G{@z&XF#K2Bfo)e*Xar$vO z6I^EZ23c2G2`u=wM>4ErIy}y?Pj?87Uxq%%dBhHzDD`&fMjhLj>ta{H$#~lb$=Sh! z7;E5tHL7JAr{!JQSu@>RVB{j`k2#IdYD!UG{~)6-wl{R?}aK-v3-fVSqxF5h+J?G(|fEUjJG z#dMzCxHkxkk(wkAuH*{!9)5#3nMZ8+%4FN4ISa;rG!5p6K2fOU6T4;20&7`!PEn3qD}qSS+0vOLmF+3#06l}FKy%rWBH=nFF>Yi zqwOq?$EjgdZHmD)uU|JbaJ@C({t}7t`P3g}oO0H<1LXeH?ujaayLK#zH(|Gv)oYh; zV#{Ov{9aK;bif14f&AS)cQ_RCjS93Jm08Yzym2n5sN&_PNEC4ZJEW77$k^iDDQeby z#rxrWPT9;(DrP7XO&zQZDQbbdrQ8$EOe5!ideEvn;X>xLl24jT61^^>kl$^ye}Wdj zXW~U~;s8>11Z{HJ)YOFtgOJzk<=ewbwyl82&6U$UtEo&gPdR@*2oVQSCK)siDlP?T zOXRw2z2!;A%`}R{*8oUyL2_B$x@C$zLBK|GPOH}W)1V_<9ZvPyxLc>EwEF{ILrV6b zh;!@1P5YX3)oB>H+j~pvm~SV))G*?C#N~S{`&UCFpiqYg*8D^rt&N?RmIwZNmJ(Ig zk2gk>$6W_MF?{K4?V~ZfE_Mzcim~-h!k+T^_3j$U!wX1P(lvM<>^5{rwNMOME8yFn zU$W=m76Kwngyb+;=p-ua)0@8)*0pF&R zey7~&wkjSapx{#ksrpAeucZs*fZefV2aH3wNh=YJDpF~e-WpGiEP>jQ)tEgK?x2R$EB zEo6ZZa+Be7)GX#BJkoW1d~5nr89EXeW@@GjD9@&Q(=NxUVCuknwh#ExXU>Q@Mp1G# z&_$~SAk$B0;fRrZA<{qyd2RIhdP_1kNFi6iZ3Pc#nzmrtrsPak*@0VPJOB9L0JgbUTV>W`hj9I2v%Y;)5YTqg{nvzz$ z9Ni;{Bw0tpwQBJ}08vqlChFsIV@}UCYzY)MOdc~2#ZiCIEg>p4zHD<|*o#wi?k!O9 zZX8yuH+N%yBv&F$NYjrFt1kP|z$de+L0Hus_c_~ZHXa3C-MHgou2oGhwxL>9Qaho= zhV(6%hj*48bcdBX+~>(vEehZb6wO2^8``jX`QejYE+=5l*K!Q8wv`CZIuB#Qd5Q_V zb>nq)@0}H)ZBUEgrv&mV^X-PVfam+Og{n^*LspV=bjx5{D`Iucb{UH&c>IlKiV1N} zs&og@qerl4vsq}KX#g${_L{RGaPGI*7uCFLTsrKoN#bcMIw+poRoon99Uu3w zZC>>n67QGqp00}UMi#7#ZafLo*nGBWiniQHcQm!#k1MUYwe^8mvh)hNWU^$>HSVpWvTvY3UU%6x%O2 zGyXVp(|2xa)}+(CSa{;7!zwTV7s0O!PuNJR=}HYDN>4B{O=MkH6{b`aX>)-A%>L|| zNt>~o(79ws@1_cW-8(k)5Rd1216I+eqGl}d?K~X55$3j!Fg(VegRNNicP5LUp`4+J zBa5L~)&+6WQ&u1Iqo3ycE$HNfu3}R^9Xmt5_g-*j?LHIF7U*gADNgpsy$o*xuip%* zX+&&uI(Uz1A_JQ+C|S>jTq`=l6U^>XeL?LDd^Ak_FM zHF{I}a@fL+(6G}{RTo+ix@gZBuqT2zmoVh&WscR~KJa9i^^EE0ClhW&WyuAV?nD<$ zT2p7+$FkIzR_**(o9fXi>n%4~m9;AB6|_a0xxEp7eqEdWTvlbczRj8yjZe#f4-AR==t4#FNGR+BVA!1N*mzzmjc`*7CH791)~`mDkXlJ&fdvC%kd*nOfx5PM z@$2fln=0Nth1BNP=yJ4Q3mDm#8`9jj%{a*{{Pkb$JJW)q&OTH}l2Iz~PmZ>+v!-i3 zzOBrxWOTr+H2WLG$O~GlG*DS+3cbNrv{v)jh?Y5ByBu7e`Jvb^FlwL0o5Ntv_&Pjd z;}hq5*As8Hbn7rS_$RNUJNRFK|BpxEZ%nvt?yk-#gVo{!jqq>e?=eVzkmVJdX@Vte zvEOoHQ~C|3Ju4C86MU&|Q_}g(#xBwzckmtN=o_cCebsT~$W|^!t2H@LyrLt4a{In0 z392*i_AzK0ok8hjJZ$z*ykW{8TAU3Q9;+sc zdUc_Wb%F6rK3qj9b*lq4F$;-?q}|-a83py&F_l8@1`GU(qv_)O8CU|14VPsRLo*@E zgkl~9;xSs}3Yy?l(EVm7yvNp3B$TIP=16{O9$T`nD%XT1qnlA~i$^<@11k1_su4A} z2?Mk~F59&9XbznWjnrk$HCJvsJ*>@8z6UIJtRji{Fr|tpFn>A`h~{%&(d_agxLZ`> z3x*-n-mcEg%uUCb_~_eVx0j=eoL?I6$d2c;O`PWgv9)jH(dF-XXL8TpKU4DS>U@rv z+}WAq^lT2yfxnGX{2BCOxZ_CEyb|Aem$F63JI$A)ujEvA^N=CnLpc>|y2+a|_QGQ?frewTq7<#mz|wuKMaa8o0AcP?z@2F^#d#@q_dd$yU)xItWJR{B8%76 zS^bu7UfF zwjNmH+gTgm@Mx$p233H9ZmJE553M1sSof9$HWoLzVxjxvS!h#I0wZxtOK#D5f8!eJ@IDJLSHNP<6QF5v zE)t5>>EZDSb{YjeiIIjc3!SSH9aDRIxG&|$F!eT)#V<6kc>D$t@XN>%;7}6w4~!C9 z8Vruy%H`TA0V8Fg^>zsldDHnDVP`r$bz&bBz0>fRd7{J8)@dJ}@0@t>K7s==bRBUW zZGDX2demOIT^E~7Ecue2eHO)d8gQn`oQyYE+%XonOuEao)M-| z?geHhy_+2I@b|x1#mR3fGDIl~;BFl`1hR&ChZ%U9>8?`iX}{v24X*IKPcx#a=I%Ei z=Y~K#glUcu?)$rHvUWtwW+NAqZuooo^kSxDDjONG@FEK@Ew02e*19D_Sm1A z*86DK;R(92X^?lOAb z+PcqCyUP3e)LGO6Cuc@|K$UHw`=l4$lu_Pfy}uGu&LnKXaF+C#iS(FucCxWsbn3fR z9>klxrN^&>-1%wF;pv~)OzRrVI`RNE(-VHy-#53AK<5lGBHXKd?FUX%?1 z_`UwO4bfP3e1I+g znx@z3iWqy*H)O6FvJc$HEVxM6Z0j{_7=w{f^PvD_Dt8T{ul;W=^rP&vJlIVDYB*F`2w@mOutcM~orEbx+7_O9Zw96gFcX>^YP%Mup|{g>*eZ;9-$&^P?Nl??{D31^q|e-kvmGGm_H zIeB|>RV6upI5*Di8nBjf1=gZ%aO|n$w&{cNy6>7=D zO>35`j32z-`5r+GvfKP^<9X)og&$^?h|0<3nTx`OYFfd1QqM|^dy0wIGfFkOt(ex! zq9HJq;vJ<+qo}lQ>tScG)BISQg5||oBRZW^ESEODB$W41NeeKq`wB9|Rb2lZUD8T} zdvwrxpJ+((<9Fv<7w$s7T zfT0|*)KmG)yO(FKn@=ap?A}$WpP}ncqTE$dTRW9)=a<&u>Ktt~)Ndx|&L=IYZ8h~= z8LDWR)F>P3wwUWgxIv!sc6VgRh78`aNs*B?D2}qKq)wIfl$fVSR*VOwd5^z#R5UJ? zBt67m3=e`=Z3x7qMrO8K;XV82Z1U?oBQs-|D@GSCROpjaCWV@Kz0dKLnsX>6hACO+ zd(8NljLzR#AwoIkQEmL-pf^8M5ND^uz}(HzCDC<1O8~`TeK`U7 z0WLUtIS^Uvk*3tipr4V}1dFzcL55sj4QP%H5Kiiw%c~Tx){CSZdA<#@wD6NneUi=C zA={@69d1>tu}f=k_B<>lC|qQOAkpO;61yQg)k9&Ul|v-?WW-fji+op(QXZ@P)guw~ z8gspF7LphbQ}Pf+&A9#Q`_wCS&m4pHQXTs2B%9--n9MvI#*v&1|pGV6kJ@t>WHfBvX%}RORhY> z$6?G|(K}n2d;z{K-3H>5&o%VDZm^wGhiy;Tz0}L#GBshh;v6n`j6O%ZbT(AeCH6o( z_BeUk&wdK3TqxLk2`&o&dX$L{^e1je2i0|DtS0Df2X69>wzn0;U$e}2EqPTJkf&(5 z8+uR4Wq^{vQkY^mS$p9?9Cd8S=k@E7L<;+FRYN4zep>_Co4jN-1 zP0NoCc=t}p48I=*K|})Ui5_Iz!D@W}DqG{;X#Sd+-8JQc^J|+W1BI+W-LRTeEu>9l zAr4vR`n=3!t!N}p``~(OKq3jJ<$!|F9wBJr-IjofaUkJ9Yv+0y0Z?QujK0=lW9rWL zTOG~o78=htC)n{iFRW{}h#&&=^@xPF%89ZCvDQqbG787i>uRC5lg*QgkO(j&V#uo? z=t9s~^M$SH%PW9-XO~Z%J62EZtJ8IK#!AYFAtsEA7X}?M>d;@I)`L4ES-ullJ;(aBf_Je9 zPu+PtZmms#Cpo(0N$Z27*LE_Trl|`*@F3d5LJq{mDTWWu@7pFDWPWs8I*4GR-?5xO z5T}&A4<(o#lpdi!Az^dvVScL}fNq6wOP#Z0Dj^^>2Kl`K1DA0@u^1K)upgX=gdKam z<={qZz_bd%{G|I%yG@N{Bp+0n))S^%C3Q8^e~QfPuTzHfrPm0t)VdPeW$iYa(BJu3 z9LY^zoPOO?N&HQ=t5KG}G}OZ)JkeHrWNp@9fwd)Tvh?=2tGSyo(MBRWMP_BZ;|J<3Ka~PKCh}XO&5?BrmBMt zO;|^$JpN)`Rvokh;Q;O13G;NNt8L(b8eA5Lu&8)Yc>$=|ZA$|KSgSsg!FFrCB*Sk5 zeYqn?RL}1xdYkE=f~Mm?E(#V-!1tv9Y1&UGST7;?j4rT>yS@-NUFctosCo}0+L-PU zL;*&JF4*zpqIhM%)bIMmX}Sp^zt70(^Jvu;5{Efy)wHR7G?Icg6Orw>Ky?hEJ>af^ zdMRAX|-7f zrVKzqnM#tb4hTq9YjKKHZS4{dXr4?SEYV9__(2WP9(yU?`Z&cW5TE5|3(#^*>+uAI z%9X*`DbVQ)jh1c7lh7LelkpX@(d(-dKOSqmc-9ipp1gJ$`Wp{aSj~Rt97rhwpyU7; zJ}xki#(X}wNHE_Tk1=X$PoS%Co$&CXcdg5YEMH>w2#`jJNI>3#rcX#_oq&}g?`Z%t->t*b*7wL zk1Q9&fZ&L(G>OO)EougfNdbQJvH9fJVWzWk_T^|3(LpiB*kF#j*)2BG5-2~oLD%VE z(dCd$dJ+zd)qC(fVyM?WD!IDAkB#UM7c5@&mEGJFd%#+Eau=!HN`JR2k+lX+f9G+u zZaF5GJKoS-0tA7+#2bs00_H||$sX9DtAU>fHpQ}(axy_!Te6rQ8&lF1VzzCBk5gm> zLU{-Su{uOT&4zB-f%rf5FzWsONYcS*QfHFd10H7Mrrsb!8*89NrcVqj>1u@?(L{0A zFu3Ug*3&73s6{2$i5^l;%2^C-9q^E$8B;R9mSp5qLpQKU5&b zucN_@*G!_CKb)w4CBK=zSVYNF*(p{Dhnm(q&~m$gOWvqx7PhpO*~rH&n~Hh7U@~3k z@Eqa?<{)fGd|~=6wz04`X|qcJY)IgQh~;o!F`vzZW(-UFQZOY2v2`G&1~Zn}wIs>s zlJrZ-QYQk5R~xObeuFJY*Q&C{NA6z%otQ8dMy-o7nRXoJ$<@#a;V)eBo%W=Zl{6VG z`jb29a#fB_#rj1@GNxFE?dvV%Y+QDu;}6yKM4l^4K|Z9f*~5w#xZlG!BCN|c?*83W z#bRP4wYdma83w#ZUy@gwhyhqc`}+$zzi#p#(~z|=X*JVMN!E=53g z#t$GKX9~K2`K%{@3U@HNzAF;{yFz|(=yD!h72?cL<+=UkDRsI9KjBw#`sDFCaz=@a z0LNOHR7!@DKgix$(G-bt&_8wn7<1q~yE+czC4wG`WuU*@h!o=ol7dS`YBTRJYQTfv zKEUMjhdCBiQG|R{VL!2apnq0PoO$mod^Hs`YNU-#-=Hql9Gr-81E8w=BEcH1YN5DC zbSXT9GM!WoEsH8{gOf3f5NhC-UF&ap87t`9o?NnRCzbS5@ z6g=3S4wDqqY_uBWt?VA}Al;gwC*E97@MOfNf!KHGEyZJkZ!PE^9lkd zn%4x*H<2sqmyNJJ8NP4SD(y=;zXu&uUTV=kf?f#3mmH^b2`e{$3@hQvh6B%FxVpBs z(ocrwJg@#>7TUeSGUUJM{N~#N4e`$TEbazbuugf zDUij+>8z%Gu%^o>z{la&Dz23~8?&FY(om(un_dxTcAPa4Tb?L|%&m&^OI@j2Vq+zNd=tT0a#6 zZ)>1AF3AJ4=~E3@{+BVd2Y;eJ2EN16T`fed7Sg8(>g+^N6SnCsv-aVD4eDfm(Zd8T zp_B>W@Gg*bm$4%1O5os{Ip3~GhRSe$$auL+f+>1AE7B)U`*$N@;fxPpZ26dfx*c?% z2sVE*qxKXBhNS_+TctODtqFXexD{5lD$w9#_ZsczuLMVoVKMFbxtF$pkQvUm4YciJ z-5fB$)3}r@v%ofQ@2kZ%oh{SkVEF)jp%7km^wtJ0+crEyuF@z2(-#ItUsN3|yR3t> z@C>lT{W>;78z<_W%umnVs_T%gIMc#RpcJ4T+u#Tnz%}4FRf9SZfy}_naD3?3Legq7 zItvY#Dk{$c{cjq+!dpr%*$squ9Tsp+g@Pby(}e>CBYA$4d2@|SrY8fv+QY%?=&*q8 z4y6OXwFD@jx}X$ zKETANA~1ree^ka}dQ|-;%~I_V1MV~~UwPM|7@oH8par9f2BZxHFQSx7IEvx^j4lPY zpq+<8tu{9@k6t6bg|8Y%d2h*2pO_chOFo|l95O3JH3U||LF>z!#TYCi<_3bt zcvrL8VSHf$p3jto9X`Ce-YY-7ydabbcu_X$oC+cTfUpIXgQwc0%6yf7hbiLczh zLyYpa?Jzx9*1$D;&E|N?799FqnOu?)vypj#_UWyP(OheJ^Pa{T<)I94Ug3&mhGbKC zF2R>Ov5lSW>`J;j^# zuVAuUOrg1EQ`Kav#18?0XA`aIVnk;!{77$05JV+DpkHw9vzDpp-3Xt)6%~R~?AS~# z0`dOLQG^e&N{faaRy=$Fu7NOmciM?aIdWcgbFN+0u#QSz-{5G40!sPa-U>SZjxEQT z+2)-hYHtji`Qa~i<6Vi3%RaMZI?&7p1Zh~&c`$cq%Av`U)QZW{BI?_X*LL*A)Hflw z+E)MN%-KG82HQqUKclNG!A2>E!I>5~@(Hb-Ap2=6{Sea0aZh)spi=r;E0 z->9MDr1t{8ul0boY9Mg__KRY5k7yhZ<=_f+j?Q<$b#qs1O*`)=G0mJWvkBrfZXMqj z;I-f>!6r2o7Nfg`9*S4&%n;Q}RN<;d)X<85_cj1DTopZV! zT<+_NV#f>s$YqROn4=i|AYI46RT#AyF;mVypjQHO`DV7gB-!T2(j_govZK;Eb6f&Y z$i(bZ%GhOz!ikbw4>KdVCQQ>!lXr48aBIS~(7oPT*G55jvCVY@j?o=+1818s2N`+7 zx@aBO6j6U~Hr}-6&Wh2}*-WT7m#=6cB{SSZD-%|o75g%KlZzQ)9Xsc$Bqvbp5HX{H zBNrnK_WA6X56`kRF6ixdu4P5<_9{YpQ=8BHGIPHMSxy5&>0Dih6X*yjDn01DamW!b zAb~3Dyz1KEB1Om6t<2RCq~s_d10nkdu+y=%3tqFOs<%MCFwU~|B6V=WMvNh`gPnFA zC5G#SnC~kJNIH8Yv&sP6Ne?h&<19$Fa+)n4mP!hAT=YZEIQGytb-M>2$;X*H!P~R{Fidup5+0 z(*8r9WO+Z3vddbL9mA$oKp10#%R-S2{i*&5_&dSb_Km8=)w=1elra^Lo!AK&PLcEB zeo4rK%mh00f<~wLopGWao#WdZ0_p51-<+(LajUk+av9FXVLS!EXvLX5JIJ`Hz4j9* zPerV8m7HXBINadUTh%FHu7-(eHSo(?U=l zuLKwJZ57xuaTu1Xv0Yecic4%val9C-djNS@)@`;?r|L=Mv~V?YGgmNoz$O8?Xz!mOf5@H z!#%EpyIDY6Ct42Y>u)x4i35Cf?3R?fD)5CO^VLh%ZGu6kEStSKcY)sxR!uDQj2IK| zN0qG=qm+e{Vh$Y>E`MgvHmw&w+QrM_SLB^~o3q5P}t0UlVm!|)-LqdSb9rm4vu>&I|mlSkNhX@}Qw;H?hdP}?2`b`6(&kxLDwq2iY zZQw-{0^TM0bQpJ-i=cJp-D4|?a>T^HQgQ#C=i+4Rawb2sU)1s=Q|INoqR=FNmXo+& z=d%hPA#G>9bj1wK2ZOlsScazDR9Mh`2wY$mkrObfAl=5S$5qlzQurW!+4I~<@^G#F zo;Z;nt5_vlb^_l9(RpqO-A-HBrgbx^JEOo-G1>4*RRpaUq2@@pR$WrasMEB2^)f6p zi`mUMt>Ly^h~MlBsN0dlyWDF})Ec)|v%+5rF~C_R&sy_blI+E6m?(aGv9C?PvYz+y)! z3)@G{^M@*usoN%c26cP z@W`XFbvB1-Kc~_{8#>B4o6C0IwUuW)t4)NWu(GI+buT=|i4HPs31@?~TrzT5=jFpi zL7wHxK;*5Q?jsT34dX~p;;f>;p=Q=h8p>^Vwm}uz;fvvpT|Z>LN!$+n5TcEoAIh_q zj4m=mA}2_vN6eJ<_$&%uqnh?#6r8+k^wyaO0)!r_TAV3+?y|dQN%fttqUTFtN#Q%U zIP%kx7rb<80%Ml?tJjfFi9XhI=?0W(xn|kK{CQ?0KaRN}1Hb37qei(=cVx*pPKSr* z(Q-MWpkR3_U!9R?bZJLpcN=?pZ*J~jwUF#2_-_@^JsnzyfpAN*Fmf0~sl zRDd8zu3J_IaXsv)v3W;NJrlH)-RftgLXF?5Ext46d$lx_@P3SIeMoRDvpg1l9${`O zH|*@S)HwXJ0J=dCrGRdIViZ{0B2jP#3llGaOcrK&lfQp%Gm9NVTmVG-z~!l{~y-V4PN3^tBG2&b{NOLg2FeD$zozoL`} zn?u2m7?;9l#u%6`b&N60m-PtVICY$wsBuNe+k|nU%k{ym;czUQ?#R>KywPs&s?@25 zA?@Z8Zz40fQG3H~WJPMlb}@nuU9BbCl4P#xnD5h3;DCrIG)=PSxg%L8pmnyuXRHxC zp)_ali9@&d{oKR!btm)-yO5CHpKq_>C2$?_0$c5p$0oxuV(Ud#hN@#4$?d4ndkzof zZ{J(d6X@%ceLj3Kw*!-Qk36QSMxgZP=qpVj#B^?}$F;`kEf0NeysbX?TQKgnY5AvI z(dLFV!k73YEVTw$2N9Z4%U!uALv9Z@8IEKUGW5np?OXE`wQnbt>iZWr#JCb@z8_~# zSgMozze&(aopX=Y-|AAD6Dce99{=Qh(KPB1+6d0(UiutB&QNF8skcj4RIruE?lmk& zC>`quKbW6+$LL%)`3^?QaI#YB`MBem@&T4-H_=mJT4;0rJMRR=xba;ur6wjj_z}tN z2`}q`{AanT?*#Q$KYj;iq)YU&DDk59J`xCTKAMoo$4o)A#jn`J}AQtJhMP%dJZ zb|`*kJ;Y{J85?Ce<^6SAZMWDpSKk0OQe{can(sQ2Iy43IE74qVBh%`9V>opy{jZ!_ z(-boC3G($VS6+aj;HX%n)2CaTLR$cN>at&5^Q$IMuwUV&wJCQ2keJJir^55Z{47SR zwdo=dNB0PEk@Of>(qRP3a5@ROw(+8Ws6gK2!`_8k!PzxjnG7D@t+j94WD>v&2^F== zkr8oCCr0d6HGJeHs>K#efYjB4nc3asI(iS%J?MY$8Yi(lz)o(RpJxosFY)lkqnV%HVr-CY=`fg+t?yP4M$Fs3n=H6M7Ie4;_|MZM5`V z9>b2V^f4N05fkTl5EgVm`;mIB#r|}H7S|n6{qTM3r zQ#)wvRGg!~fr$5ZoA+-#lc#BOR!?~bTG5W%k1&poTfu(D+?88xl_7U@@BQJC`@2hK zYVngF(Dmzd#{x z^6~y7o!X$VLPx>O`QSXHKFXUsh_!qq-9-xk^r-34Jf=I?t6R; zY*oliqNz=g)2kx(U;V0p8P6Cta^l;sxJ;D=iz%saAS#>K6KZ-@Jv@XN_FuK{5v2zB z*AKt993wW47B+D22~EE(JvFmaSK7!&q{A>%KV4Rx;>oah6GZlB6mvQkO36B6M6vn+E>%jQJy8*}$3!>&symSay37P zAJ+0vpU^%rQMrfU-6Gz{)|OQ^oCkzhwRN83wl7Ix$ME4?0N3%xtJaW1EO9pDHO$Ld z44%All|y``-hL^!uWmm&c_8>uE=<-f+V5kgTaWU4AI_iXKJXk%GMx)T6$A|gZ$_!D z-rOJL**M9P@J9dGcx{w?^!^aMnD@iHH2 zkNqr8niQ}QTf=>{>SAYZQ-T~i06tpC*_2>4dY=u!g8?|&CgFkX(uaTP`y}4o;Mtj0 zbv^W;D)4jmL{@p=6B=jW@_`yI%t-C~p!p#T(7KAiAE+mL#XQprLDfM(pEF@ylEGac zc!*3?p!}vq6s}%DXvV==EF&4a;PKX^rPpVR@U}DsE8eNp8bcK6Ub`W?YP=*kP{owV znqEiJ^++EOQl(RxmU4w&caF+b>zbeU8%V3LW^(OleKvE-)kga#=qWkZQ?+t!ki`sZ zS7=kSWR_>+pk&rC9ueK z$5~jrBrI`j5-Y%B5;1$6c-6|5GVqag3W zx9g}3gnOLQ5P+1SsOM$qE@-yunsY{afh0! zp)4J3!=9kvvKxCOB$PuF#OwR?vy8G6mV*3qN zPv?*zuPx%jJ?Kl&*U>aGjJt9LPyYa?>V1o7C>7aqr(zWX_~m0QIFOcqu4 zzwxxU6o7*4bDH{*mM8n>{QP)}&N2=FJZ9OxVldfSxZmS`*Q<^G(K$!~4!`Ier|dc1 z*vFr_(wpc3M;o>gf;;oqnSP7$j+9AYI4#1!Y8J`RRDM|xF{V)iI873iWTY_ zR6iHqcC@t!pLxtDpQs2cJe;a(KU5*M#w~~-ER0IJD$p|M$`S(;3~3_g!L>IJ_B0FI z!b2t(!e$m~F#D5MW2=|6=!$zyArBxo+GHzq`VnRuQWskhA?6X{6H@F)1GD%MTuNWJ z&WdS7fx0}Xj|D-@>D3}X3}k{$>8rev-?W3+s+oEhkT{HY9!^*~1|kjoCVIw2R2dI- zNY1+=UTbrl)AM0#Avp#vIr7yucfq6KGOnD-`iriydG-PL>5~xT_X=$4P5GqrG_I)# zU%Kkx(tCrqENNlJSE0?Ke2+YGTtKjJ0{!hyPMuk zOYR5-hN=%J^6LEu6EVGVD?!suRk+Iz65^xMhRlA^1v0Vjmq3~DjE*sY@k_4Kcvr^7 zPM>WR-!glFWVOuArnK~bwggI9+@~ZtRlKT5Jj}tE%R;W zG{YW_cpd&0xc{v=$ze5Sccr!mj1{+`i}0ug>7oSWAI=r%)^~-wKix_lB`QwxkisZd zLI1G9ENyI+Rz18%k2cKAl^St5%<1_#+F4$^Yi0ZO$EaMhdhq)8>s>rGs(*n$nv%Oo zr~e}EsM&G{5oY~D=FEZvnY)9+J-Q$Po8#i2|ToyNX4jg*7XuU;P6xyT5xBp%;xZ#@*$%-m3kD7!z2kXBFAW znXwwAJ~t+q+umCTKQLt?sKi5WZ2j7z@u2%Hy32Ltx(}FDc=_p`xe(}BrWl$4$6A?7 z&dU1oziV}s?YZx}V6zH{b|Gm|u^o1>k=Z6sQMVVi2zbf5|X1%}_46xX4wiocfSUYTeI zEI~xU3Cj@a(F4SdB-*iit1iBSYx->j}{++}~R4 z@^?~YZJ|I^ns1p5#&`AyyZYnRH{f4zQ_TOV1PkC!$VxgH7k*J@zwm|EoWW!51W<_4 z?GRb9dx3G5Nz%Gur9T^=g6zM?0~x#zQnaHOTn3DcLDC z4l^|#qtg*GC0sqS!wJ}p)B=%vXxc@vfOT9_mZvR3Ks*JkYpa*Ycb-XW*)-AME?V$6 zu}NLF*PJCe$(f~+L*ANpJD9htJ6*}8W>9i#uENMd&Dc=ylO!_*qy3FNm&xQU(>3Mp z!$Gmp+O>99OmKLZpZntn_$rL+(F^tN&zN9pp=YYWu-=z@*K|p=-t3e%=$@0kb)ll< z7ONHcSUbyk-CB&?b#9yr2)D{{r4_Zn47W*b*&0YqfFcQ+=_m$yO97{bn=GUr(l?9l z)vgNLOdZr`ZJMbU8L^@HplSj~wIjiuFszW2|MnEc6&LqcjB-Ex2Jv zFk1|Nnf*i8ihQmyw++$4virTV#iB=qS3tG2ANSI;)C=biOja^jktT$EK?0qUY3;$`qLG`hFjs~>LIlJ0?U{aJRs)6r28&q zrq8YUNkwd$w}jAh_`0f*KKXjl4`)>xn#=UBJ-78tQ&{Im{LW+FSQAQ4PSPePm4E-( z;d9o6B|BYS(?jF!R{lL2&1DkiuA=>*khn0hNZa#~eC@C?Fi9(RqbpBMwzqx7Oetd{ zX=U+U6v=mfbi#OcGrg3=v7r7=zIk*4!*R)>f4)9d7Kz!F1w$13E!X3Hy~BeJO3Cvgn!r)!>(0N%K;^C;)KXV zyPIM3t*Ke@lgHV5qXW@1dPWmwucK?uT;Ld3&0xGXtgnil{5p3v>9JyNIuFYwd5lAw(+JfZ#>yg6eJvT$Ohb%Wr%^h&yB|-g>hxN9 z#_EdLQ825L#JvKzYO;(jRf22c#WZQr#v}uj+>5x?P%<)i;aZU>Ev>VaTiRw>Fl~4? zEeq=IS>2K!J&NO|8q)JMd+dKe?j&yYi5AU*KJ}#PPJPRV%Galj4~URy`7~px&sgH; zCfRUxl+HZBw&&8&DlIDZPkemk$(fDINBlIUeMcpVIHKFEl`d<-&nd!{+i&F7J98(} za8j*#$guW9-x3BBVcEEMLY1z!-0q~7p!G@YPNM4e8r=_% zVdgYA0_(|-T+E)CjhAMxKQ>FgZFbXJc`16V3l+@hQ{1MEaY-_`+jH`F%K`z^dEe~f z&;he->sBR(NsWR1u^zp zN{K9#$R$Z-wB{?emd+|JG5n~X%)5I8kL*)uvj6rrX^P$!B-Ak!U~Qg*fveM}!3GxH zXQG@j2v_^>q=$_|*vzT3Lp3gw>gTn)76#D2<#)Ee^xY_~^K&;Knad|AjF4Zeg}5RFxmiXh;{G1(D*fOWR zLIR!DruB$F2eX;-KTs3%PD z8b4h$dr2bO=Qr#^2Di1&_k;d5VFMOX?Ei8^EzU-DS`bpaJz|7k2Qo|os*hCB~!PJnmVyz z!31+bOX1vv)umvVFEm_I!RAq+NpO)+N$R=ple?o5Bt>PTkQyav!3-UmkpR6{2k)g| zy<6mvYKXQmV#cvhG@My2?($Aag<0+eUYN>|itl-d-7?#-zYwI6?F>RYJd9QH{#|7I zd$Uw^Mdk3avtoB*khP+3zJ-9q@%N^?sP8j=nTyfUZSsXQbVFA@JcA=Sh2SszaPwFE zgqEfI6IN|imD2Zae4y-0(tPO@(fJzDp0P4ZSA-jCTyi)+(PT1bPwW`sLr3H6w-j4n z-0vTDa#4@=lUcT1d=iThqO#7#k=f6NT)P|MsnX&Rh1)JBF3kF z)TVsh>LA)RPkMQ1*le6o_Ak+{Qg*oJt48T6lZL9FLEGtNP`{mlMTvR7ClIqn_sHEN zH;>)98Dz|a;O*9Hf~s@P8;l+O&q)G>bbHsBAUX7Y=Nm!0%yq z%2wI9e&gO|1>o#VWOqV!T|qS-J1kaZi}@{XxJKU|Fn4C{-0ujBar z=4+URPFSmQ%8T!T|8jlj0=EZv71PO-zbekd5-rC6o4amD?4U?&Ieo({wqKU*&# zLD<-V{KtubSpCY?y|uN+;1+s@$Ifnnc<}q;lnC8$lp;EqGRJK(CPiJ7C(Q*66M z7^d#Yi`$D2ec5t1%ms`)*x=fw$y&Mr#q!Ve6!*194A@FS+`ciMJ-5j@4ralCNoy1;OT4N1^)&-gQge*{=}Xt-)P~6R z5FAe=mou&QW;>jW)RvyNK-vil?F6-%VC#P>2uf=u;_6RY>+CBD}2Xb*-ohbE`ohGk!H=S}KwA)Pj>H{W=Ldb&%d z2D8x07$n);^)J;EoJbSj9#zgldmsENByFc5an0SaHRKKi(b;rdXLolp!3ZT{GNuQ+wY&*LBvK3b=Whl7llXJ0KI_i%-X=B$FR;@#%eFW3YB6Ldgs|JN$vR1m*B!N1m@7$q{s@fk zXrvf;q`k4TN_u0Lw)2eY*|UnCS17ot^FI8Qk$1@Q#8ly<9ZYzR{r;_rq+1N(st&&z zUXN9)Z~EqNR$|@hQaoschok%tv1o|W2{z^zx*TZJUea|PxCa&D>ergXO>1nT%c-em&FUhN+4snXEat({~i zG+NL3uIJH(-J7MJrd_8TL)R4RW(J~z#6*hoBni6)0P=8~j0rkw%^tO99$tn;=zcXW zOQTtY+nsp*__u$S%@U=BM|2LwB}I?74mRY1!rtFP2()04YTCHK%*96&C!U3)s^m`a zz5SRLjE;a7uudnj_~>Qf;DFs<57Q)nQrK0YCKc6@Wi#r9Ze06D zsW$0-fra=|rOtrT-Voa=4yRarPSnsCsEeH#@G{S~aIfTaMDPB{sWjiB8G#wsbg*)r zBZ*`GbkOw#4QVC1b(4p<2Q`nR$)`}l{Ld%;cuVIzk}SsrqExqfxwzrR{jtm7ii{cl zoA$lD2T$=^V1;Jt;|$Kf94pHytse5Nf81B^zhK@0dY*%IjD{8TmaeAz5>;$_>Zu*G zz_*oBts7W`N91B?G4s(o2c4*c(#qO=b6J%fto9hppI}}Xx%WueZP}{;-Wy1wKV{BG z>MHLA&8kq$qZ`~i7jvQupig#xX+^bsC)BBTMuV;X)CKy#bT$5CU*zWlppe2|Q!$6s z#;-v@3YSgv|GP}jKkMdyeVfQh=s81h{S~CX+XG`(X?bOvz%xXE0hnW^Ldj=j!W))I z;k<7S0itGm7yo4IMmGg2N(8iX6pIf1b3MDukc>m0oe;2L={YnXDyl<6<$)T?@^1S) zEh}h5?C0%X)p+^j4SRn;D?3S8P|=pHA}t_PpR^We^m2UXyccY_{Nn6=#@TjxN%74%+qoek9F4O zP}^h^85bC;5M>@zw3QhBRVww%nvt;N-z(ffwL{%xqU*9L%82us;9h6-rH@QD4=`(T zDS~j`Y+B?x-LKNQG!^m|DUv?yp}bmuH3zOzO#4Va%B0G8rv%S?RdoT}{O8f)QU5|G zah;s9&Z|1ID5R|zr-MS=1tZxN=fJj%#GInpR5~nVJ-Zjno~5i4qHF2l6JEF=i8H~T zDek2XydUAzTJilOM=$-MYfC>2j9Yv);2+qgzgk;4eqOT}6Wv*NJm#BYYQ}P@TEZ0j#b=t+xjXN9|d*5$npJ z1O#xVZgIv?a3j7U&HTsp2ACupk>eQh$Svc3>A57gZ?{E4DBQ41UXaaWzJ#+o5 zOA_oIw+8>+B?)UiC*Hx93_=U4D(2YbXWL5HSMVjD;^P`~qw*4YBBh;bU5sp+uVn~r z6=F;(j+2(SrHWeBqQVpOxq9Hrb2hc%IOehLWPomJvpL$G^1BO!y>r*5s*$sQNl1HD z-DeQ9Lml*2*5K)`$e6urza$rBR#@+3z!>{kJJ9HXcX8Jdy!Rrn{QKkb9QY-+b#%4$ z>Aq&tsf_2ZG6&;VYc#URif;Q1XrUw*WX>6+2GM+Z(w`_!Dec>KsoC>XJrnZz*7Vuu zgEPlEjCO9myMOonnWFExnMk}vsy2XCFRlG>{S-^2n0jjyL7$R=^!Tz2Wt1u;-%wC{ z&Y*k!Z)uwzmp^=l^%+{RNk?{961lp$Fq0ufa%UW@+Z#w&=4rffb#Vp7%MzVfQkE|5 ztR4gogU26yW^go_$=KnGNx_XSlD*_|o~8yx<=_~aEOOLyo=ogcPrsJHuDzekK^4n2 zpsl#Ln1vx2R0$dE;7^ksm^GM<<`+`y8P5o3`P}w1mUHu7cCm+zfAky6mJM;=E1MrO z-j5G7RAF-Tl%E7`UPqd}70EPr;0MRwo*s`F;%@TLL?y_By}&4)etT6X+Xe9(nfN~C zu3A@FPO66YJB4dS8by^KrOh z?*y){nVnve2#+uKP8k1KiFw^hr;?9(lLq zr%p|}zwm5XzCmEPPI<^33;nEb#jh#oE%9ocK2^8HI1=Rs_9jIc5U-h$g2CQ9rN`efb1(f9?oKQh7|oY5fN0)gUf@o_Z`ar z3#&SbRFhzpicoCTc&9hFfWC<*AN;bf)eqe@@?O_`Nk|Ixl&K^;1``p-ws zE|wVy6Sild+V{NN*BASy2bJ+y-qRKE&!+GglX_0W8r?0sr<$}X=_$3{qkm_i{{!J0 zojw)woPlzPQcsmJ^Y)rixlme@{}-w{n(%+7ssmm1CY|~OqKf>VdFzxNb@yzm8=j)P zSNVm^4r4tOlh-%>uEzz42f!?+p^ATkfurmOmg}J!Si<+Y7_GT8l~nr;MA)mlteM{I zo9mB&D{8uIx*E8NV9D~&2`bEL%~|g0X_Fhy_9*&JhgX3`3`VvanD8xM&>i{TrzZaY z)#rf<74mCj@h<>?)^1uGPS09d{rXvV_EsRfCmQ4+o3t{=l)c)BrR|#p%y8dl7;oVy zSs3qU8kalDd{9StSN-kQ5jNyAM6p}eoA>@Ng{)(p>GXZc1vj=!p+PS;{Rl_?n^J0pxfqr0l7NhsfIX}?2Noch=e`|axrzWZj4!`7AM zGVfB3pWPC1R0_#5)hRM4P}KEuQriajo!4E|!nnyl_-Fs{dAIZkmW_sl&PGrn-L0g^ z93tW>?mSa)Z{BxbCDB@WP%{$Ai# z*LGcj`#3QO8qyIKQ$_7c^fhiUDOt#LO;9CAqIL6(fsMJZ_23=TH+C4$%5 z#H7-)XLKc-?CI?EtvCrTF2(|PxD5Ecz<(*L*L8VVZw9}K#1^iq`EOj&JuE1HRE29S z)yq9SXIsiiOO4LsodxWao^!q`#ls;ru@YPvFRGQcK51EZ4f_58iH9Fz(j?nL|4bw% z=ds#9pMBhRu7ozSm;R=5r}AQPr_3aOC*k*b3@U}HUvSET7}qC zpFsmIn&{2b5f!t6+{N(|j~zDNLOKcp^CYE`Y7@}Ys$G)F-zpfP_RpU~QzWoflD`^I zEv?d?+;nx7T;^(RtnI;Hwgy{?ySxx(g!QV+-nLQ_U^ZZzb3ScSjq>-)iVQuW?qJ?$ zB_E-#!8Pjck^Xhcty`gUdPP1&0i~a8-+q;F#xK7gY2fxYdl?9N|~}5LTd-- z9$V>Ck>VTuqD@BShe8%gr>`s#{%B3y(rCDYetcGEGDk(qoBXkQlI1Gg^=fFQl9A_m z<6waYwz*n0xdF8D2yIPmnB2B8_!a&D6I71XC;Pk>g07zga+gE*_k0g`@j8 zu}BI^x)Iilxcex|RcTY@O~rP{Hs_0{klzzCS?8ZrumxYIi5i!t{%H6PtSePNTVUPn ze#uBc4H`9ZCKdObNBrZfiLWp1lje0uF*b@GPZmaclv0vwZVHwn$2xnulefiVmx%yV z=G65>B}DI(xmD`^5?UXe<`FWxki-1+7R|4Ms+I4V=U`~o5%#)@wG_mZuB#K^o zS3Rj{87s3012^_eyCy;|@7rJ67gZ`x_4Bl*)k3f(lu9Pbid_2*P{e=ZSVmT_rd*|Pzr z*M0(~*J?{%0eyH;Qs*nK=U#QYUrXpwT(A(k39qtpb%DbX^3F_=Vl?cD0rW@HWSSOO znh8Hk9<02^LKV5{CKCI}-Or$Q6HZEB=o7tAlp*j=nMcgaw8hpP|WPR}2~7RV1? zc|w;Xp{%Nfofn+CFW*UoW6R}+=6>vPyxNPLx6_qw{>0hongqj4$s(f zcHA<^fGT2%b{_hm-B5Nf{RY+o#%xOc_p9MWqX-90NGP|Ch}T13y-GEFZ%*}R|DGdIrq`pl+d2Fa zCJ0;3{wcRlW*3N8Ed-vBNdacRq9I>Nmn27vD@M$+?~F;mLTgKosjX(2u6*`M)|3mb zAtXl#axYzeTcN>L(EvTc0+-nl6`D_PkmF)tqVx+=#CK7@T@#&CpvcG=<}JHdb$g1c z2&Z>iq(ypp_?t%U68rLWFk$BD8gX(WF((~t#nSfN7iQ>0wu#sub@=eRjQ0_l)ZdDJ zwdW+3N&PXCpM$+yR;{LH>F)WXOy;O)@2`%}=bU{9oD?UEc^&RtSZ;Nmp3ucvCLEvt z`()m|yXz}v%*s!R4}A$gyu%si2Y8>2P7LrZvoy4>mNqaiuV(DdMT7PQF3%VK#$7EX zJ+W#B^ZDp5aN}!4>MSS!_T-xHAWA?m0Kax4~u(-8(>LRR$P5FlLoD1vvRTj>FRSU1UKp@wM zbxM(KG*j^HkeVch&tyKd;`bol1;{&FSl^MN2HZ>xp+82;oin^WB!b0g^O z^6@J12sU8QHK!9*9cylP-VMZiv9++Q%+`S^mW+blb6**?h$z}aR~BSjNY+hXw9{?V ziP@sckGanz)eQ@Bx9jALEBi@IJWU*4lsluy!+Sg$*m>I1qGXU4}`zh1} z=SZ(uN@`Tv{10xSGs)%ExwO~oYT{braXFo&*XP^k#MkhhQm+@J&(wJRe=8Tx@`v~F zH|k8wSg5w>^ioZW(E?uSO3{R?biW0&jGEb(Yma;xU>0lCU`zaLM4#htNOWD=luBi- z>bHu;uS-!^8Z4lD-^n~0n5JKP#`gsYN}u8jzP2!wuxsY;9k;rH4lU#$)K;ynt=@~!suYY&yboy5YcPu3n?ShL>S600Khlv4v9>An{_RM)^u zXpWx-oTs%|W$`o`kV{^KWSHZW8s?hRf?A>(_B6*bD=#8*{a*w0;Dh~h6t`o0-IDv~ z4AEltVm!8G2kP1p>x8%PQw4j7BO^CC%)0?%$*qyczq95lBeZwGxgx|)c;r*ddv6yd zZ`~yNX!iY2+Uteddi(766+b~A&|c`+B_61LA#&h+c+&xw_DYxW_*iZUXiEwel+tH- zO#SXx{;2mDOoPWHq6rY# zk_FZiXAG_IK*m5zj$on$FCf|U1`K*2fI}Y zR0?3Z#a6FEzeIYM=+%@rYmJ4NbR<(is!*3}yIb%-p$VQcHm7d<8kK7;Ff9oQLdPS^RD^R^6;@uVJLdOot+1oDpZ|t4!rh@~9s_5JE2c;O-l{^HE z6xSL(3uMpT%obVC5jiOW{p7L>76V`~P`0w5jJxKGbDrx*)DPq+;bIy&ZcDsrXP9F* z=s*eb63El=eZWf-cWbSRF4|_P9L~qsf!lj zz2-iA2laHp>WRVS0v7g4L0pxfH)%^0^8TPsGmf!O#C~>r+ct6b5W0#G*KFENT1`J4 zRZshplr^c+<4`1LmoQeumblJ-aLir9#k&s^OJEE2IzcZE?XGOM*PC{0&KcX4b$bqr zQ->!DBRvt+A3j`NydyK`GW-TRe)?MgnE7?p_$DjG z>SySP4Mf5!)}Cw!REh(NOrf23ssq;*Z3^IvQMNM|4o;r0Un}_)RN8`uAXWUpuAaLk zoJJm>Xh|JXiS&EvccqY~oPWkG%->C8e5_lW$an#GCc5qh5{$4F_)9}oF(aUbfcb@} z#`yVi41$=GvV8Qq{u znQ+Rq9=2Kr;3G3q9>FP5b_s?xO$}w?l_h*S-t=ERQ;a=FbCu0z4)ac&5jN@XVJdDe zR%*d!b5q^I2jV6`!O8C(GG0BX@7cLZ5l*y`>>uMu8YfxXxys!`$SxV$_HDMT=Mae6 zH8m@9?^L(0Zj;OY>o&(=H^{94EwtDDFMC*W2~l}QJx<}K@?D!IDvWK_>#Cw6e^+c5z+s7upfpwA4>$bA&%e9$&L(S4s!BofZ+T-i?O z=ALdf+PazU9kynJ+b;dQwD9l*`BLsRYHd$c$Vor|`?QDXbAFA58Nm;m)d#BCD~iY- zU2BerokV4wyxlku^5B4E%%OZlMSg&n76uB>(`S^wvHeYWbiv;VO7T}&$sj*C^i9i> zl^yFGdj}2)({^EJgF=Nivprdm!Ov4D&KxV$`}bxmrb;mF-jZ{w7tvz)!0EDW_%sYs z)Hm8a-*f$%$;{z9!7Gl0h=wgZ$|q9KJ?ldWzcK1}Ah@W2^XoTCnhCI8!sKd#7?5^z zh+Q_?>6PgK$1dT~SlTTYPbMd^4QGnNUS+*fxIKUg0(4$>t>o*)9Nko|R$-o?k%R1= z=VA@MR<6&1W;V65SqHf?VwaTQ8eyYSs{PY8WrvN%0k&y*kb#*mp);+I!1m7*@c}I1 zQBUXA5~}(KH5!Q5xd7)-cv|yHH(Z1zbID6tm?S|(bsr0EIeIMCaU4f_EiDhG#A zaf$l#2(FxUdti_G6=+031`F-)hYCZ_9Vnh|Z;L~Hvj8yaAQY4wk@fZJKUBRh zp>>7EfD5``)dCZY*0Zizv*88Wybj@40O=T`>YW^#Jbn1ytg##}M(RnNs8G`Ykh7Cf zmHX@8kaMH!ohOlv6q^Xm0e2J9n?g@=>F#&R?cjH`E9plY7Gl*70Lj^@hqbZDy|%#5 z0QyF80*$@{A(t<#yy^PGygb-k->5Kot%|44-@;_>d5%C8p8^Gl?NBMso_LcFRqDB@ zZrXa#N~oM%d4m-Q^L5t5<%%3qkw2mfO@+jp*^sWU#L#7xzrj%o(m9nO$Wv{4Piz&Vz<6v&8)I>-Rg4RH%HeioJ~1o{(p&jEj@pru zsns6>r78N~avl%I6(IdyADyk?YS?ulj>Wre4PqBlW-Dz=-bcHo)Bc!tDqYelsWU&EmB)BY78MGU{20~|^xp8Tu_JaCqtrq1 z5D-*5;C0OfoPH?f3A4v&;-K%#CHyjAJmzRW-SpdA?k9}A$hYPPvb2QM&}E!FlSB2V z$rPAxaNI#V_?TN{b)85{a1j9h%b`{~W4=jdf-S_TR?LXwsgx6I8w2Yw5rMKLOhBRQ z3t;~n*>1l9K?@ouoywpt>VUJDnq7UvJHOJIx7wMy+RAazIImckO(3BzuMhSeA?JyK zl)I)7c8)fj?OF!yI*_3UVQ&j36_DwV5`XSM*)2)urgf)`?TW860(mB?RkCmnqe3`9 z2JR6$uqq%+XE{0 zR?IuY=7m`souP}vcB5nbDn0ys)oryS2U%g$wWil6yYtNzCEs*A1^{*=<(sEu5nr{| zmJ}>#G@z%jbZcNQTbd%#VB9gY#Utl!=H%KPqXC|YRREtQQ0t2LBUjWDg7iI7d^=j= zWsyT~hXmZTZJRJ|xy9DP^o{!Sl4c$r6@KwL^Z^Td2~?n^YL(Ruol&DAOV~T*`$Ou{ zABXL}d?Z`zG1K{?2RuO5id8tXTHj#VtsDenFsBUtSzV59Qp0oeT5=a>!*Z~mawgBn z8i&euf1n4CtaG|{{vOY7lz_-?lgL4`omse`%{Zb_4k#`eoL71&jEM#&=<{P~Lb(^?iYXRI;a zC7vWMCeBWpYD9fi{5Uct4X4Tu0yO<0n&!ibV38 zkuwwP%LDu1$|&TZsat9YkLQJOplQ0FHdeG9bAC1}kls$T>bQ{|;gmuRJZc6D6)UJl$5Y zcmNMhw7{WXtLPI&wzcnB^LUi|BC>OecTcIjn|1nuyo#bm3FISNIz;RIOu0x*0HJ2s z?(EkAa_lT2n{J411!z0sVxOdIi4@7Z<#q&bRkw^Jh2mAkfMDW zlQLiP$~cY~vr?atT+8T=**}5lbz)gfG4H?N?*DCtLp*N2)vuK>%%_g^AR{{845<_9 zu9n;&RC%7lXu1Z~?93ak6DH$=u)I|T?yZ!zsYL5cBW!!~BjeT{*P?&^NK z>;Oq<5eXs(U;&0xmM$=HnVTNC>0>S6I^Rd38DUukC zC7kx`mQiCZ7cahjU0NH{aqv28C>MWmyJJ}MPc6_p_1|lOpbGc|S7LC32;R6ML`DStDXw;eS7d_VYe z6#QGB*veAQI&Bs70R9m#Icn%^mnL_P$*;}XlnlBwkndq_xv~|bKxdcD+vQZ8rJ9Y~ zF9La^)0^96YdM}b+&0F%Y4?HM@W>(lJTZHF^IOa1VZoYWPjn_Z$S2qknRza4)miEG zLTdx~bWzSsW~CLu zlwix59H$@KzgZVT1A_LRcVCEb;d<}aS){2*KTt0H+zTJr9v9G={OBPRoGfYy3duMS zJIB^TqK1A1fTnW`2A@aIZ3C}$rGS{uRXMh9n-f&Bj)@*5T|kaHSY6@>+K^qtfI2P# z&Lma|#1kc)ZphlUmC{G+sjywlZITIlUMyZ8PcIikxwl$HwI+-cM$U|iF>!AS1s3|5 zmUJM^I)avwYXI)~y2LNCpj#!{(kqZKJ|*cx6~_%wT%*?$u*LmwK63>CtzGAYuh{pu_tayqq3-XCUgOJ@ZU*<28k_`uEHzm(VKgo>D7qwmjGY=CZRi!fZ5>+PJ+ zFWA-dzrPct;Mlr?k>c@n%soR1%wm@;tmOnBtZ zc9jFj)pR~x3XGwxsKGg=(T$tVz^Qbk1^6Ueee__1JH`10$YSPz7N$(av$%go^!ocY z&z#oDm@BzGeVg;zS3}ijK}C_t)7_vZhjkdn=_=!1*FfhSoFS3sTMq5U|JGEtTc^tIioIFWG-WtW_XP6!Q*-g)#=CzP45eiO5>f#YUM%nIg?Gea@0QE|N1i ztLo9~%+_M(#X2F#<>S7ZT!?iips%zDAq1T~NIgw>G=#63`L9Eho6c_$#i?I%w&#I} z&^=BsGhh&ijZWRZNpwGY>!BrYQ0>nlLv$}ve6L3l#$oDL>;`#^VK6Oi{DBe%#+Qz- zCvQ~x*{w2p;OH`8lIcNX111a1(3O59$Q2gZd(wSEE?3%b=$qg$&JM3Re=7#GD8j9NjgG1L+N^1ZEmds>UAytCWy?mNwH(_c18Amey%19T)p}D=6@M0^ZEg+vEGHq%1fE zLGD%Y1NY6vq|j3l)I`YlicMR_z_Z4?Yacq*LPbj0099L$vAPVgIpevfZ6uQ>DzAlxG65VwDXZ1>r3l8zjeh$c;`%4Z?W{? zL<`4kzG{3y42+&7;epu=hkkw$ZWoIfKtcZ)Xf_pK=#1(!MOi zsZl3d?x)c1WjU9cvfRO28agq2r}R0G3C*=yPoE?vd?6>uua3Vk4>G8{{41o^ku@eq z1q@6`-(L7~hP3u-?6FRf&Kf2@oAVHif(q8W-W zCwR_a%Z3YP(u?fg7LB>V$J&P~RSnQbH7+PD^KchxVTmK7@!!m0I$C@dNPTR0e6J_b zUBxl~RsnxOj)`*CPW|w$+GpZI0pq28+-0~AePG1~)Ps`;yZkST-{5CV7mu{*ncC%C zadn*(XJm!Bgrc3#TM@?5$!n~w2C`(w6{I}(n5A^!rh|8c(}+r}Hn;Bu^*x=)#rzE2 zPq^wMo6Y-uWJVGe)oQ#dT*aVhtb0`R7%gtLd`VX>gU)MOkkDrc zE3X$EBfI@>is5_CxmloHkE*^a4}TI;^0K}KfG zsac;q9!L~Ku|namwa4R>mL@p}iLG%zQY@p6nwGoVJg2>jv)N_&%%U5dQLuX70AHU* zCYNtp8BLs=AGBT~W-gTsc}Ts<(he`I7R{^Aw9Vrj3@;+Q61_^;8dM3R=x$UOE;NO$ z`VDn_qfsd9le4VjpjItsYl*sKO5}kYfYRVc9F;UWG|j zU%6bBU>vSoaADJTM3Umud!2AEQL&Bj7KRra?pN-9{Z38apx<3n>*+bDSlwbvF?SGrV0hf^}4=n~dbcQ|v*oSbp_-U?NB zBJau5c2eq8ysiD)>t=Un2`8!z=jo!8>t*u{F4^-AN6){`K%USj*whym_hRtIu6%Yw&}oSKRq-IBqzhwGERWVan}K=OX_L=UjbkwG;- zx?dYovukfz8-`?2wzPM-Jo#tJ#01(~V8Qk$P{pzgvox@yAPz|?b zgsD#4zRXzU6yM(LIkz8Y_gU=pWO=Y|oz$36UsW#B6mwZSY8nsReXyc%-+No2FKbng z3jDmA?iKWkST)y5)u-a}SIlqGF&V7r$SeH~|d8Pc7syRq^bz*HOSbIU* z*$!71`5bnDc!uty=HYUQ_39HLuq`L6Sg`gIu3<>IY8KQOYDkUxVw$`J$snhU^jde{ z{5UxWx=?=ex`mabIo_j>B3trIn?UUMRJgjh=Kl^gNl1CSwWriBxCO0Xf44BOIE+M^ zpbO?NDa*au;7v{!n4Q%a`wTMS;yaVQLR|^|I^Xd0z3@88QceSdF!rieJY40a zmNDd+iEMWXS4qvx(C*0%FgsrYW{nz38ujyGMwOdEYrgZ-niGPw`Ai&=D(DDuh~-e? z4}{qHkRQMz*a<~S^9hxgzAS&avifjh=Ktzm#8qs)N4swmqE6KfEli1`jnbXo1JIR$ z+Q7`%GXAu@$AqW(Z_Y(sfRy)V7j>op3q$=a8V4JT9xZ56x%iOO@N@7N?rJE;s2rTy~CQy*8cCAaRf&c zR0O2Yh=M3ZK zw+r=(+Gp0?CN`5cNyba*#(&25ja1X$RIsV+X`G!JqEpDHC!fC#qQ~+IxK5po9>R|p zeF}l)jBe)v0O0nefe4a>NqGomGenoUb%BH$l_koxC|WAtxOanaQj+7BLBT%gQpukA zNfdJ+N}-xZgK#PS6q3i6pY^MWy4dG#51t}S6uIHhZ&_`}@onYqCw1=gh6u~)J$`V0 z{Jc_#&k-+?6q#_gp5Sc_(}W4_otcY8Hmz@G&%)fWZ5DDn3Om_x`rKGs^b6x6J-?Om z{oyD6FTw@qcSh{vxGF%0<>Yo(Iz^IgKRv&$Yh&#Q>cKM1u|) zUYmJv6r6WN-)@J%dV24bc_K(ln3z0=zM}KUr;_XR&F;Nuvn9ax?TMW5zr>mG z;Z8FGGX_uCfO!MK+)r$^oi6sja}bX_!_HT^w9P)hN6k*%&z9~np#JHIJ)IC)g`X-z z<3}fWH)|d~EtDCZ;jwOF@OwF3ad)PvGu04w)e%PJ`8};IH=Re;s_;>wzFYDdSR~5& z3@7N;j)9`Em>=0rVM}GVYL0+TKiy*RFai;!CGa!q_Ng%UF^tYQ5Bht~B%Qb;V8`a% zL~rE8EP#6xR{n>%6RK~2$S9X=*zbj`&HIYZ5cj%Y~Cx9=VJuY3qN?vL#vE|L)^ zM#ugMM5hLEZ(J=DXj7YIt!Z~6fXCNq6pJ5Eerr3ZF`!+9EJT(C=b{+u?9(pN8(P(! zy**bbkH*#}#OzpAZL40c><745H0;9LVm*3Z3!xQvl6@%@zk94qzpsK%igFTp48md% zanc5Rv^4|vHVz)SOL8inj@)4?yWM)i9fW&tA`J~9ch^vG&ZnCaYm?4EGiIws*g}}K z;jsM}$H%mxg3J1~Z~L0UuGS)Ncm-sY{gOAlkY2J~mNr&z*hv<;ssM1qFVC~H#K`p? zhYN$Pr+fx#Wj9qDma?8o^wn2WU2MTQY`y_At9l~6kb<~D@lUCy+7<=Nar}E)P!Hv6 z2aF!1jBcBwhTks_Pm4$vx}hw|Avi-l^uW%B7AQ=0{eX>U_buy-4%MsP7nfH2tb$M2 zP}g9$Osw?MMAm7E2|eqtsy0hPDN2_G0aNu`7TQh7E%Ba@^$@olVb)Z_M40zZFE2K@ zqCW_ixiL3X&^;=rbgXRsCwDRUOG}jmB0xu|=$B*o`7bA7F=6?2btyAxvH$&Xz=k<;C(yPoa?y7S%2g5 zY){3c3G8y{2{PQiJMsv{gXJO8o?K(( zO)maiQT&QiVRgkfD%5fjl{zICsWm5*M zd3_%TeSTVx&VOb7ZsHcs1ODm(JPSU~kOd90vs0dl(9HV_UB42;ZCP2f%3DmeO6b|7 z&xuq2pA&AFNV(V%7hRDi;6?gpCl-ccHNWH2pf6vaDvgA|0FPr}0R53nc)rFT30#0` zkYoJXVvy#$W%#dBMBdcNsId9`t-U+w0r3`Y0y~ArR`^I4(~CF$thjU;3h(t)kk9U% z^eE=vTghYp@&U@nqm(zZ<-cWhSZn>g9)GJ)K7Efm#UK>VKK-w3f~Rh|9QJc@_9C|v zLjRY!kQ3yvjSs;;_2aiHG(XSkh$x1B`tQEze>RZ7Am=$?LHf;CGgwh!4i-5`w+kmu zvBGT>yL6knf=Y1jQdQ4H{i_62cJqd=I6QoHsOL-Np#Z=ZPxwt9w{OYY#&E(>4YzD7 z(DO1uhjcXsw@Q6^sORq~A=U{jV*gJCKZVQxt8WVCKqr&b3F#{8m(qlP7ZvAO`vvd+ z7!@b*joSGiM&$MC;PWB3A`Re_JAA^!^4gWA>s0V%3RrC7Cg$=%|5zqJF@5nAJ|w&S$38R(56(kSI$LmSm+-}(Y&3p#)jvE;PF!-YR2EjxInc}ZEGOf54wz!NHB0WjbTL$Z z{I>pKOp4y)F+H z>&LMl6nC;kUX*b~5o$AD=(J|qe~WE=n1{Z8CxICsyf;LxG$+5)tkJXvi`r%B1p{aDBaZP|_1rRSC+e%GTWZ!N2E!-XY= z=jLyc0|=`Z$?2e_xifR@H(iajoo|wrgWZz1ALH-&@&w;DTBc5UxcGK+_OMMM%LwrD zp5RKvVHys(qp~{2EHss+eJIuE(Y}+RV)k)aiC*SI1{Vca~>9VleIstACe!Kg5-LM`po|ZEgAmH#*$S^ZOS9 zmsI>ZXEL$Su;eSp61H-}MpFm;s(*Whc+Mwb>aZs^d$Xt3sPmP5Y}6vK<4>`7NL+ig zQV;XOQa%Am2oWbQLyVJJXL$scsRroygXnB8Pcz<_@Z) zEF6!;V7^h)i7g^dLqRL2#$XR1J)u7k8Lg@z?}FRRUq5`ZvK|gI88crO8i9YKrnhf> zqo(!!zfsf9iPI&S5u@A7Txxpfiq=~EW1Xd!o~;g)d!e7(qH^d^%Eu+Svqyy6br9 z+quRLs=VfMb1KNYjdjXibI-&5Q345y%;&)ogS>{=jSGHr6)L@9S(IO0X1h-mReN88 z>E$V7^AenUc1~d8GHUvU=1|xEv(h`m?B6K8%c-p`9Mh4Mb180@aVg$VL0E(uEg!#b z-=rRVRv@Iqd;z&uSJdK#QB+UJQ;&C^6~Uaha%t%H5YbfZA!=Q$DUWmRwXHOB$#gjb zNLe_nlF$wOgiG-})Jh_1^+~$K$eWu@p)u#XNS6-fV^dt%Hb(Ux+#zfCV2t3;zV&0bsli!4!>qRvmR8`lLXM2Ppx5lF z-}nD^b|{fgl@ru=3~)%)!(H8HZuEz1;Ntj}o3cauHDev!qfliKNtCdZZG;TF$A85^ zy)kEgc2faYY5;^@PZ9pl73 zgRinuxAx~@lsGEMS-gH5cMKxGF=@hWUH*}EjPt`7~5rK|BGxpw$xzq z7As@;QRlW7R|fuAq`V^+%<()2&32LIEKhBET98tghU_8S>T;mt&UD|ir4jnpql}Bq zbEp6=J(&AKy>nHXqiM>)T($9q>owc?7>)fS)PIFzS8kB7yX$Tyq!e2~c?7AzpmsaD zN`zT6Hj7)D?)7^jZ8y_ZuA;J==@H@WqxWJ=Q z?is-mK%Q^<3NFsplxQihd!YRPFx+WjoeaM)LMjJrqhw= z^ehB)!~XC>^RaW?nFT`)74MZHdI*QO(wWBDnx(FLhAM3wj<{B6&lFf$?P7pP-ZLdt zyv)|mKO6GJlPfs7A5o*HY-u?ey51@J6IW2%=Zoi{{wFR9rmc~C2etCO_&3B6Ppeb< zKftk@_i|56cMd+Q5=v6jAUNe~H!ch}l$%=a?u^AlL zn%mq3(0h3=Vk1n64_8QDtpjepXl{d#MfP>Ns7Y{#p)&avkq46L!~vnLy*Zty0&LFpXOe>{ z9d5e&xlK-V>GkK-qU8g;p;8e3Z5Hs%`Gs`?lI@`ns*LGj4nV^FG+Lj46gGJT> z33;Ypb$FPIA$b23 zhOW!c4E?J0uA;K?Gzp+GO?6y($}x4=5k3#S5Y(6XdO*J9E6JbAB9b3mwVQRYJ4UDZ z4>2!uG0qfXYVUg|rkwK#EAF#-7#-a9f>mFJx~yCD~4k(@h<4n7Tj*i;kj!2Tg* zyFnlR;k?B9asnZhtPNFpuZ3?UzoHYi$c{|(AofqPn z?5woP&arR0==)xpAqc(%K^!6FEh;UC=48ut8z7_C9L_f8duZ(zQuhDSI|L^=i!8+2^|qG3<(>nJVPTSrT)ct zD;NOnt-L4^|Tq|LYCC%>BD%vcvS|N0VL_DDM~dH+1=nvl1nZ<9rcW@x`eJ zILvkUG1B+Os+i1hy=8Fr^Uhpnnu;%;$C$HN-Ay-o`K@E-Gxs0MtVHV8C^rN{{2wb< zK~Iog)QOMkp7gTU^ERk!xhY+sZ@loXa;Jdf8%3Sf)I7dgP!)-g@_Z~;#Tw66pUYMT z8|u7P{h01Oot`S>B?|!=txAdrhkaT!UWrX&#c-B<%RDt+mr4uNVs4Fooh1O5bzW1A zT^tB6G#;3I{aItkc#YoRNRlht&0ydaH1$Rj5gIKg z;4)Lbuqw=T5UG=?li|F_&C3VOI&r6+!Ms;xq?SRX=F0Q<#hg$?k{$3-jo9jl5SqTN$R_ZjV)rg9BcdmJ|4%ju+D4&ZQF<4!*i^`X8pY!ro)~ctC zao!m!zHv-!Ildu(LY-V%l{fQldj;duN?-=NiR;$~HO^~RjFrs+?TYnpZi|*PTh)`) zINd0CIK-CQhYZerx_uFj@8vw$4ck;uX0Ri6zwZV%)zHph_M`9+wzqVbiFvEDsp znOnGdXcnJ4b?qeX{kS01*7`70y&=eKwINibn>)hN^cBk+pKzSc#rSGwB5 za&nM%=8(o^U*o zIQZ;hgFaH;t{ndL9~u>Yl7dR|l^b#UX28RHrUc*JERQ_}#J2I-QNT)HakLPnn8RhW z8HjoSU+E6jqO;nuI-*Agj$xF9{h?#ut$Sv#cc`(AQL^wQUAxYx9KNArIMe{}6z7c2 z&inMF{6y~m!G!#Va=7icA6bqg$oF3%Br5dx$|v%cRks3T%Fe1*!Oa^;gsM5$>VaERFUbnynG#0`hwP6Q-0{MM3>OX}G$S+BpSu zU8`qeOYiCkLNkK5KX+7=$i->43(R3145$y~I*|GNG<-P6eG>7IoVZp$OEtDj8S@Pi zFQtfJ(alPjgi#`~+@Wv?eL*Cvx7HC4sK|Jhg1qa6mv$8xqz(Yj&`vzO&$7DHzSot% zMI_+OD^S8d4%3JCJl8HyNB8O9TU`{K_xU93)3VX21a`WEyKki491V!5o3iUNv-LoK{kA0UsGVEu#^w;Ti9$JobQ}(T8oR(y ze*{sMguGy^w=i5X_WJUJw))nVtU)zE^QxUmBg%o|hm1GdR@4bE`-1f~0(2;OR6Jsa zo~3Vt4>_(w9;bB^G!DejSPvyRTD1v-nQj#1MH0HMKDr>Z*nUc_b@O@))XOXWL3LGVh;GwXq*O(|a*!o) z{+^LN=437A=&^-huZUBa(2^BeTRG~6+`YYElKUCzXUca`kX0vUrI)2B1&b+3|#!6p$F z16Ex*-VRlZC0?zM1?IN7lF^$jq`1vM>xel%1Pu|5_Y(df^N1+Pi*9~UCRzRV~%48W+TSO1;jmyJ;S>1Wa* z?WBpf=%Nz!uQyxKBKs?}Vo8|BcF@zg%8cBJYUq=i^9o8FBCuZIKC)~;Wf;N2sD6R~ zq_~0VN8}*x93Gq$Mz&s2t$4TlMi`d+`Kmp)!yOFz#(s~K__xsq)>yie~Eu07=01|Z)pUG8&kH*`PPRB|9 zoz8X~EKSa_=hE2*QBL?!>y_3q(NR>`3uU##V-*Pp3!J zt=erUsF>o}wIpRL2lBYXCd35#^=LWO+ReQD6qQ+uww0#Y7FPuKOc_ni+3DZnbaiN; z)8f(Q(&bUYrqaAvrwm{qz{C;t?A1uIoDNC-&1j;9zAeD1!7K!`a)*6}iF z&cw%oFz)f0!{!G7?;bm+>Br!Q+AU%O7j4D2xDx2&Nz#GMhFx}iMh=DikW;wiVW^iA zbZz40WRi#u8Jt)ZQ2@hz8By9ii1?J!`l!lLhku82-MkIuq3dFK_!$g7aMS}PWMags zH$D`YI8ZT>0SyZlr};}D=Nxg*K1Miydg(L(tjC7y(MGiAf%IrDp%1C|vUi|`ap$oG z9{8&!4vLNR04Jd8(6+3pRcN5_G+{V5fAC0W?eb?a zm}>X=_>#g5c^LtvpyfFhaw*|r_4)MabZ(%>Z>ou^U)G+qOfgND6?a~{oKhZ((i>Y7 zV7f%Na^r_XRW`oq`z@si?rERNQ+oLDiUd$#IAq^Mw2;;0iG>LT;=r>UD|6wuJ%fIp zixIev_`E<>m%fYjYh{AMmx8oJf3a6|k>-o_IOo(Pa8zNq1fkgF!hAkqMS5Xk@Bi4Ssf)%w{Q2I(zb@R+qlQ(8dVH3LMITI_Z-t>m%-KE z&d*bhaf3{ccd6AT7pM9^(do>D>PlgJ->3PmXmEHBqfP1eoDcR>hHuv)jj>Cw5$Tu{ zV(s^JQ&8a=?9&x{Ut{IVc9-j3kb0KBa)s@6ez!En?{~~a-Uj8PyF*hvClNVqYqcLD zkL+DEXaf!ubu~WiGnMMkD!As7*Cz@JR4<+ZVr#XkU^}9{Y!Tb(p=jnPtSl=TCqn#` zi#;vII6KoaU09`78uG3 zO}-j#eb6dl=g{rB@HO)Iu(P$HNUR0!@NjUH`$F)`htx+y&Lgd_%;oeXd2+P^!!tDl zZO`|d<Nimn37Ay_dUlZq7DzV#J*O#r%P;o|CZSJp`Y^c{OR_ z^NEJ(O2N*hYT|coU>Mp~q!Whx`!CN@uRBByTKt-NO14{bJy*m0N14ZSeR>cPT6L`6 zva>mHdV1KXx9>X1_=c^ycGaoizW4<9|8nA9v(N?%0kB zoHew#|4j4GLjE!Tuf_lWAjjvDMUO8-Z?$3P>i@fY8isn_z=;-fZun^NUo2Z$A-|ZD zFMr`$?mt`m4|9ZHD9k)n1i6ou2DN?9|M0hc5}&@~)qMBgY-Vc4o)rl4CHDEl-s^r&7tX#I+u{m2|0~LSoycj|C^s85t6`;rn?T)0?_+I&KYRl7H;9Z-u zGs_{i7`Yei0=x>#}8h;-#-~*epeU-?9v)3t{Ktu zIGzJ?9vl|E`-&2v)Th2+v{O3Iv2XR!y=lq|Y`qRaPhv?{<1fg;ZDUspFD? z;?YFy@sNH8@1|WL=y|s_*Rsd+gD{!pN~7m`MJb@WRqfBFOF!!eUsqTfY%Yxg0|&kj zI)9eGENb)1TkX(t^TwXnOP}=fw%u|1lS&y$5iew1E^8~uZb>#N%f11kTplmIR5)aJ zw@4sv=6q3aY30=AEDeaXHri6)(;Zrs|^tpB~C`)%hNw=xcvd$Y}u)@BD0>h?c%dkyL@>|axU<#NQdIu zZ2Gn#&+5FTfsdpyt)nJAc|EIm-8&Zk)KkXA)>Ug^tFt-L^EI_&lyBho;WVg91sMpL zzhs)CepXR~d0#K$WKrT%Pd^*LU}u0!c8H2%jabGBcj`;xHWX1#wu1ykTgw9Pze==v zk-Il;Jsl=FEupxa20x#IuVT=P8A$v#@9C=wm!!m^#UC zHS&kf5U!eTo-696vL{B5YV`Mk?CQ=H)k6|+x^bQrwEG!f?=X9NFiAjgNH^Zofs}P@ zh}Kz??z=uBUQt1rq%h$w z#;Bqj8KaHv-zIMh8JK+*YwhxN?7C3NiI-GUG<{8H)<)-;4&wT($sKk44$W7G^n&EH z8`Md=It-| z2RTTRaT$AhLKeSvRHe7+#Jqhnp7O51@xz#3vs@Cl`cfS#J9f8x`a^=YpK7X~OzI8- zP7JHKWO*PI&Ll_j$B}@L;8&rtK($Mx;&5+6f?UX6#J3KTy%iR%tkPGN8QeQzg+*;I z9fa0iS!fO3?x$>HGEak^Sroq&S;i1jzgm@;iU_!;16c@yaDyfxDB@x6kBdP)hyZ6r z_G}d&^4xnz!t=24gtj`yk4@i~pdCT2;jI$1sE>dQ%&%5@Vcml6Hz8Ncb9VWF0WqQB+rsPdWU|Y_xS7JEXtCZ*UZ6 z*irk|d-TpR?CvwS;buzc%%eE&7FT@|1*rGeFth@oPlU{>!<2(8pnbwBzv6RLc6N!AlveBV@ zfGK=iig1+Cfg+}Vl%o~vX>B=HmrzqYIg13B%h(^jy-q!*5w7*wu{u3+9WO)>qVN5* zDAh^NN)4cX z9X>C0_iW;llGn$hU2N@x4bI&n$Pm}2o_gv9dEmXwSr1|`s z2A-g<9$I2@JtT209O7XE?+x)clMevS@}bt|F-S?yg=4|1VPaVsb7I4-djtgV0jH6b z0aXSe-1?n_sT9qJ=mJewB3#6P4~pYG6H0a@haSIBsh7uGzzj2hoTEdf(!~j$O_;$` zm0HwUN6g@0PtvIi`Zp{wJgh8@<=gnA-g&td8KPd*ApKT9D=OsBuO|)LRaFkIT4&qk3?n$N2|c4+6+ZvIpnIL&tZ5OZ?02|k zP3xxxC6YW;Oar;3+DG38%=!oK+e@k87}kT9Tboc^nbMU6x<0LzT@9G@`+mo6U}I4W z``Iox%`3t6z5b+#2hIUw(Pbm*1<&ZSwOrg3Chvu%l@DM}L6`dDOmb^BE36dhB`iqq zL{>h_m=XHn#7YA;^hTtic^H2KTPyS7p>)Ps{AF_|QYo3%-Kq|o&Wps^`0U0p>hg{^Ic#0c(MMrlJTXmFHOC&D?<&eI_7e?NG4ui zuQN2YY)u}IhXT7Y&McHb&r#JLUI2g4e(^Gw_O|oLG^{BX%}~$H^mS{#c)v$0IPoyL z6J@m`jnxcmI_yI|3WnySQ|s4VA)Mb%6hllzzBrjWx@c#PK|!gOx2?e7Re#tZYLK4d z-~HB(upPdvlP5caN3hoM5SE-a%JVjQCBD-E zf0<*l(+mq*t53r2MZyTC2dY;RQ(+>a)qPiH1jhl{W-6M($TJ12E=h{VYl6Kd|FRW zUl&4WP*;kpd<`JBExl-Xw9S!z>O8ItwG{GY`wL}=L~2)lFw~Xtpz8stX=CBF_9cY2 zQeU!eL|_kQg}pn`qIdJlV?Lr%?*`vot?uj?^_MQuUmk?T@u$2$T0CHXETeB<`WU+(*{R}rhuYla`qS|Hf_6QR8k>{r+ zae-^MkqToGNh{P&6F;ckSU*h>grPltXCYqIgPA%&j#8wC2rN765CMa-F?dw;3JNjl z@N+20&L@b8Nt}WaLYHaA4uaT=m17}u7ZKt2DrR5eE}|BGztnXt1=Vu}gj*@rj~pH= z1vwF?RYN(^&}N?UqRoN&5F|c zthHVdAS<~LxX|GuuCA8Fte+-J>5n7*rlV_}>gpCA#vqqGevdWN4@2ZRvE+l?XD;lM z?hW&gjf6@ex_ru#?X2PMZh9GHb(tW+qp4KAdtuA5>=%~1=>a3u>m!kI4U%TQ4sxpC zq`QIwsXUzc7IvkFR(|ocNm02_I(hHGp0C_GYXWb^ z)`@KnA;nfrBlOgin0XD?#%sLB?}JD`7;S0z2eo}p|3DX#*sQT>JDT}f?pzp6e-Y0J zDu(lHZ53P;vjtFuRcb^$^m>(cCpdwn2Y7khyT}2O1{+ayxL|uRHJjsYW}~x z=zl4dLJMp{kI>Q64R>q(IDCS z;o>d#q;>#|@e}u=uSfqZp=Kqc*Ae%IlKq207)9={d7Klm4h**sji}*znc5v8q`eDZ zcGuGDi;JD5hlBk>xaRbhg*B}#X$_=!O@>-P6Ii+E?>y)TJ#15)p%Ly}A%);b7L6)9 zPU9coidX#m+x0sB@3hf>(KY^MD}%5FQ>UMUdx(gYqRf2X|IyQ^N~5pj<59hKw8`UO zr>y_JBmT>8`=kHTa_Ym)Z@2++`CX;5pwvC+GH<#S%WU&D*+z_*|8CvJEuFx_Ze7M*vuxiDu&=dae3m< z*etUW2iKrDE-VlpoPDqqzft9$Zp|~AEWVIq$9&P(s97*k&n^YN_?UXmChKb#G@;1W z2WhCd^%kP9nuU2eboTk(j=4WG%&r@Ef>%{DubJr$g$G3vLu;{8d29MD{7(aPfOmBa z-y&T{(=!?VG{$V5;uXq4ze9iPPwT_V6_mm}7WrXwa$Vk5#-j4HZObpPnSbnV6G={U z*=N+cX5;{@C)}?2XD9sHBgbhb?o}ScL1vHO%~Zj^=5bCWE3s5vC+(I9&&PKU+9@IA z{36OOh9VTpYLzMj^m2U}@(RqmU36sn>*wLOnXxpnhV!0P=$P`Mb7C#IE)_65eQ|u# zvnhA;A>h=1GqwDu7X9xgr~lIuijZ#-RMd1PmvY)6``x?TTI3H6m6*^uFZLgS3X}A68`+l$Jxnz`+bzf2W>?4)eP_e#3WYwpgK!2h`o z|I(m;-_fO+*p6pBi3zDuRsW1@p835o*j2steY(lAaqjdIx@;`{qW^L{C~G#RDdey1 zXr=yH3;n*Jh2g(790GR)dE5-1_7zFZp*P4+7X(lDR^KFs*Ds$BUK7QF##32S!)s#? zrR=)up~ek<$@x}f?ejj)1~edh|8hpX_~LKd$B)53iqL=tG$yj&=LNYfV!4Zx_S%to8C11N8UP1y)0FB2inL`)}+^yb{-lx#qo zMzQ|f1hVUwJ*GN*+23+Fncos%Bx2s6nseDdCieV-&eXs7i`%*R`on+ti+lI(@4pH; z3ND(jN_v|AL!gPbXRIsLltWv{&w@}y=FJ7=7EQ_e3d*M@(bwAuRf8~`0; zmOvVlyOrQfOb6=3C&3)x)@-^)zfMo>m@8_X{zfa7aY$`5tDa_&kT%+QLMixszdf4L zr@C@3V8X&(e$7A3J}bzBJmKc3t)Kg%D!rI`7uv7q=D2?WfW6n$Ymww>Oe}_~DCz@D z`BK_lY+EvE!zwEs5Y#ac#+CFD0m2kwAvkm?&N#J|Rk;);7XAigx0I3*0z@3O!29*qntSdyv#>@3joG zsOihcv~?vhZG9!5CmcUdDmeL@N=^BE;xV;^aEe z1mR-2j~iNVb&%IoErR)a^B*-A?n-qezY4>XoihEq#iKXEEcE*dfwDpOr|J#n4MU9j zdJQq=JHu)Sbub zq8R*oDs2>6JUWUEjeS$T_O^)q@R9Y=)TS=c7kk0J56iEwm9u}A02#PMfefdYhgrNk zO01_AH0e)-p^*FZu&AT<1IwScbuw4<64SH}QHq-r5?b!lzU$*pXsMoTS0`G~Lpq$s zXw`>%`gd}tygt#8E~kh)P((#a^~zv{ODg=O6ByuqI;qIaPIfxhr>QXWqZLmc%Iz$k z*5I}9ey=a-`DfB=vnEy1p_{~vVD_9pT8e_the$G~EftFC=+U}an?Ui)4Gj-DB|6n>}JlJ!{} z?hk({o}73KMpwhVCKgCs;Ge9=2qIbDL2L|ipNFsATHMNkB&e5eGRUq4*5p3<-SXOV z=!M^#I-Fv6ZKTIR~L;mcWo>len(VFigPFUy1S=sWdtJ?B=!JPOMS5Y{79MiX zplD^R(CF`!495r@apr;GV5Vd^yKGiF4*A=Eoofdf_Ckk%@@V>%k+~(8~}9b=DZr zMHW4e=6JY3`H_sVx6T--r-pSh#vY99dd+`=w5jI~Yn1YHB4h>Sq;e|7gXDamGv7fy zN9EEFQ+V!0(wFleO`LY5`AJ(Fj(RP}4fp{J-p}B&A9HHmaCsCAdj#TD8wJ-)rJ(mg zc^Uj7NrIQOA}SWfXo@Yh=zS|hGnB6eHdw@nYEy?K&o?!JQhkcm=kqb>d2+S7!e`Wi z0*j|heN|b~(P&Xk;s`j(9|CvwZVIk~^60Eqx1}?$m`{6DPdAO835fi#Zm%2^c>rW( zOzgDQ0+LZZ>4+y-q*Fqgn&s*~FoS=uGw$U?*koBhbgM;F@a<{~ISA7P(F`Qsb0Y4Y zL1XaSjLRyJ&(_zvkZtI66UG3&>=uu~uSgsOxOzHe&W>spHS17P$f$F$}NWP7LvLw^gp zTE8N8f(cL!4vHCz)ByUz2nO1FA>QJgr#I%4fB728SZqFgb791esuK#?rY^3p&xq77 zl1%D>_3I8h0k`tb96%bJu1784+Ub3;yw+GEGia}cWh10r*P2`p%9Dc88@wCuj^=NU zhKc>+74|Htw&N&j!29*tLftbS0~a9FsL18DMBc;K-H-xTKR0i ze6S}mmRh%YN62Z=RZ7WKr&2B~bN!<~kNN@I=?CH!Ja;1A+wOnJ`Z?|$Y)JpYWyqk- zyxzoMPt2(ciI;0s4@d8D{%_=3PhL}>{slSemar1+1s{u(`nWIrSAi7#m4`n_YLd0a z_kBm+jRpd(#P#7vyq2Vb1oU3ULc^c(EVYf`P6Gq5{fzG`D%0aehWqTwb3T8s_cStj z}|X9NFvs-#ttIe5VOz5jA(^n-}g?AKgHGg#Ajf-2z1&K)7OaYPPPEAz@Q%#!kxHoyQoofN1YFf|U0%MWSnI zGD~*M=b77up=DazWI}(ZRaj-&T6D^=uinBmp%Qs|M1|r}n>+-Rm7e23A}9{usu!03zLIL{~6)*)nG(@nYlhvRx?>s{n8&hIpR0}nz1mbV zxMWkOj{5V|-r=F|8G++Lh_uD;#-zG}KlozBkl?YNFo!-KH&jgC^h3!pN3x=saQ_<8 zaV8vQ{cEnI6yF4`WYY1PTYv%V5T5*S5_@;nld1M((lHpydL!u zqVl@GAa3;NU)*h~+_1A^mXB;9#9&IjAjm+Cu`z{SSrC&!S(C2Jxg*|q?sR9}V7=x} zws8FS`uqY0ku#^LV4xV;aLC_nwtWiPjwRIFI=~Y{7T@b@%AQ^UZH}(p-wg5N5kD!Q zIdOYK%d#B5opa&Qg@V1@lLM9sH}Fp-&87pu#^%p)$|%|5^Y{WC-~D_&M7s=Nmj;=2 zEGoUdlNBskqhzF)amLJ+cGa!cl-^4TMta+&Q~jGN*N=))PB0XT2Y}oB0^LqT1J&sk z;IB&o4n7JxQdhCdOmKZx0o_dNrTC;#mUbl(Gz4qVSc?v~~Gkp@? zF>XMF?OF?I0aM#P8Sv&L&-b9~x&bGgyt7(?aL1)J0&!&3)VqQGrf_5?dR&J#g8D61 z*o+Y~J@j-VXfr zl@wHc^i~Rwitl8rf6_(edYo&^`+s~Evv)O1*a(`L^UP|X`@*1!o!^O@ZzP4=;S50m z^QrX8_5(%(=A)K^W!8Dqym zFAvZ15PlWEzmK!UIr@=@keR7|nX~ouZ^z8b6X!YzZ}y7Tf^vws4|9(kWs5TI|2lEz z>FJP?M6|W)Lvg~}E1;{KGLC3)3iwNDZ)4P((H>WOuq>@V-_hi#a#qVMq+E2MgceF~ zL8WOuAYQ${;2$eyO^p1wcDnDze82#Y-`}hDmy-X@PEqOMv?^N@Q6f-q>#^h0)0|pO zME`L|6960kNdA9*OrMtVYFK02HlJqe^@44RClma2R$nGj!*@@4TPKJbtT&o|@7Cy= zwS`y&r7a4xu4bJPbZdN=6+Yi0>riC3CFr(MYuX)$y~6_Gbz*$hCpAB>KXH5JQ*Da+ zEZ6h(Y;B}zLh`L5!K7q|S<%q#IMrLS-!fjCrheTCtWhn2jGPGaPB!zY%T4vFjbH{CfcFw78bYYQ1s*w`ZGRa!e zg*Rj0pq4v7)bJw9Z_kgV>(s+Hi8Rvt+j z!Gw@;(Z`I^+DcWmGjjw>*LaIZR$Gz)#dL zCQU3>XGUC~PCQ!Lp05L3GJM`#?i+I=eCXNgubo8}g*c%!u=LxH=`i zSD_jopRm*qD|)!Bd?XG>V2f(Y*p6d0o$0MjPTH`$w&a{AMQZSJQ(mXYd9#J^>##;$ zFFQ=fo&C?$Ww8t=(F_lVC|g zT{Br=zGtW+v-xu3p%;H1)W?m6i6o^Pr2ap>eP>itS=;vG*hUeVv4Dz@v4K)VKtm6f zK|n-o^Z+8#LPA8El#oG2P^yCT5)q^Y2sHsh5;01IP((TbB4Pj&LV%EjBm}-V^Uln( zzUTeEAMcNMt-a1Vd!K!meXn))-sjxcbxt?gFT5=tBX2QLL`)U-( zaiEjFsh}6pHxK^QnIy;JL_|8s0aqe-^V~TBp>t$SdGr!ZWtRL=*+|d#rd;u%F|AH9 z%z$eBp0AI%wNwpa9UiJ#xTC4}YS)w!I1A@Nvoocj%wlheh+&l(`$5d=4*mYuR9rlp{W35lrHF!T0-A>tJtaw~L!va-4V+z*{t* z*&Qtl}2=`{n_5hijtnegqX3&QUAO=Pscb`LtznN{cD# z^S$jNm$T2hrc!Zisi|7dQV@k{heRO&P~Z56K@Gig5#T=4cQ4T5J5~zsUKH)sW~}+r zC2sD|UT5MrT`f>9+}3cuu94gZbz6WFB?)3w?BjWXn_wB2+qZeyF!M!CIhb@r?TSF|2xqUX((rrBj` zyp#t>1`Wxuu9$0Gaa}RtvzJ7hq$1jK@f)XaZDeiF&-#AAZuo300@gj08>q-@Euk9| zwvt5OS9o210+Wf>Uc>Tyvu#8X3E=iIytbhMYAHP7r2-ya6f zyZMetNVlSRPN-tQxtP2XrO$gK~P%gL1yvkk=HvagsPBcAYMVHa0@xyN0W^}O75<4@|%qXEm8C_|Fb2PFu$LB`+Oks}!+BZ|ipUPdw&g2G5^XwhY7ds^2~QO=o_gj#v?8;pA_E@{S+Z zaZWCOXW-UkU4{6K7Cn9dcW?ZYs(+&M9=b}GwMY^77M41lp?trn;H|8`!c55*&e%-$ z0WXoOK?JlLTE$2HH|Reg$~${f6vnfY>{13qA;KdgSIuCe)thX4Sfu^>VLR;B^!(`X z*vsk2>x?Dv>xO0PmpyRP;m(XkVMNVY;kW*g`M2-1+wu&bQfIIfv(fSDraBrM-aJvm zdajJXZQ4z+z7=a7M0CL&-^OT%WwO^^G)Si~VBd#g3us_ZV=&ssN5HP_pqTf-8TmO7 zhgn}Lnv~FfRP5YyYlQRMg#M~l{F3r+SIrS6-xx)CUDmBI@NZz(vS}7Iu>tDOk(}C$ zLcC(z<8RR-EnLRX^pE$4gz@rbxd|#*AM3b`w6mq|dlSxLg30P>UK$U+AU@5fjRG&W zYzbaRt5gTIpU+PIF*iKJD4??5^6EvLSz@@;yTMP`3R|H29Zv>|6`CN9SitY(^ofz*mEWA8I9^s)Th< z_jQbe^~*jS=jRblgz5(|koVQsp(G59Rr%?eeAoi`_y=-0R2}0qQ#~06N&%nI03yOO z>~4qW3MS(V)Rafe4hA0{SCD%&4Kt<2xH~bP#9tO)Qf|Mr>qzWRmy(|xiDs)_HHp<{ z{1TgYCRYEdp#9kgzLAWgxsK75UlLL;s%Cuf`E7c*{(a^+n4qTI(OL5e73L8^FMH%; zq2ED#Td4dYscT8mzUJ|*-KF`Ht1upcy6vgG_tSDbvm^Vi8jtk^=%nKOns9C22kcZp z$}dsAkrG*D-oqnLh98%VH$mkUUWeo+LXBX9&srX7?N0R7$-P5Cugq@^NYoFp2{s=K z!2io~_{29OXVe_*0vD(8pgLl_#XCh2yz#1gjpyxdI?Lyng?)+=-;fjVG^6qZ#*a_j z*q911Q{LO8!jBzvVCOA~+7(q4nCS3Xy6y_En%R$s;Ee37e!XCPZ_`u-gchTQ3Wkuh zy5Rz`A=}~10kFU21&3s&XmTL+huNF=W*3ot@P5mTy~W+7lfz4Gwwe1soEYDKS}S>{ z&5i!Z&PQ*mdK-DHk(yij6NkRdc;+4vR|e{dgCS0` zbIEqCqdU;5LHUe4#JPz3E1*JI#m2MPbIyi_*uX>0N~oGfO|{&F=VmrmQ_66yyG&RB zD|8@epB~mx%xCoBTxu<#CoN*u*=c>qGuH)GPbPhDIVcko4Sb-7>keG3wFmeV>LWnv*s`v;tEf)%X2$(W2yf3cHK%kjmmaVzLwzZzFogc85pI2g@$eO>7NR*``om}lPF#W?g-M2TY^jc^28RLb+y!*%z?Y;7)H1(fb zvt{aaS3~jP7x;8Ny`NTSK^^7?!ny|>*)^H7t>Y4hlciu)d|!Q|MFqCdM!?-so7rN# zvI(%TZq78U!ODvYt-{%V|A z$n!UG7xe1FbrJVmBK7(&dyswa7r6%w-hL1La2-DaM|=3AU*3M-vFf%0dU=pAH;|D> z^0_!OVeNZk*dJYOxfgUtO{jub7Plz*o-zFlBoJxKk0K*zBgGk~QITOiaf()(zTLJY zSenxzkp4#Yk$eN&!iFZStg40DO4_wFeyyGM(VE(+)dRJN;DURPQJJ%rj;5Dps!#Vh zj)sMoRL-|9c;454hIsh6a61KbFsdp0$dk`ow7-s%O*Z}Ck2n9bY%|A!ib%c$NcloU zw5CYjEVl@ZRIEJkJ;$^od6Lkfo=coK;}NW+CcD~pa}-xAz5*9F;=g2N*4bAIVGNi zXXAD!$%-P}ajL67u>VbnewuRxlVIgyq?3zk-TdqKydOjp0)_4|YD9z}N?SKc>4jr0 z7FBKxuJ9`D2i0aLjm{*&)m<$iJE$``uYFdsi`%t$qUjG1&9e-1vd@T&Y#hIJ*>Qw( zh1T4yerb5_kV}zYP*Qc@xt0QAHGwGTEwG_6^5VoAe_#d1bcZUE;;B;t2u-`Fexg(} zkU2!`a;KV%*(>8hA~*Xv$hqfRfYToyUAl7D-e39yRVygC2Bo;9>Q`<3ySIwO#{dJS z7hA8z=j)esp49k?d)L;Z?=Su`cDZzyNa-!GeS0q_FSL@TfKj-xk6DGXXEw6>{^BYO zX!+=I?%H#Za%khPN(+ToY?aH$usXB>foJ-Rx>)dWB)yFDxK`7mTRe>-&w%TY^LcoV z$x=WKFJ~3xIC$DIw{qG$#(fb@pEj}fMt3~8B>Czl2F(PVG$XlCfVIJyC+jnttx6Mt z$2+7Dg08K(Q|PnXRiQrwolNLv;0;~%b`%ndBiP<6abRtWmXNT7S(&;d<5OIv(#20}v%^|k z&C)j^_}=^!W~vLmvY2}!sKLn6t%w0P$ev|pUCag>Y( z0fU>Qtg165%0T+hlx?!Nk{gbVx>MTkr%e}WliX#TN8ZX~YaVMt|2oaz=ZrtTrP}A8 zR@djSe>n&JXU{)`Xf7I#y8aU77nKJE*KswEtL&jMUPc;yr~XvP?-||Jttx%_xXY>Q zW7wt{d+r3qP$DKAkT4A#Q zxbROb{wwwoa46biI*4m@RdB{OZ)SJB5w_L>IaP`2Q68w|SWyw(H2Wk=8sJ1Yr8zKN9iif%>(F z-P^y*)Nsc6!Q-Z%(-A~288lBO_OQ-8{73q4P4wezsxh`ZG~~Ns9F4fiPdN3L7k|4G z3Uj+-im2-d^^!IT{81v~MPbL{ceVdr!3T(?h;Z-k7d^TT{^5+&A9$w8V66*h)&TFK zhG|aYBy-xh_)#gDFsO?f3703hxT6+aVM3#qC z0*UI#(`p`%UTcFYbzCvI#k=*8+*fV9CU=qRrI`R5z&}226nJC$)m@kq1pPB zYH^B-?bhtsK|yD-clxp&G1|ZmC55BhragL>2cHP&DfHa&i0v^Uxtw|8kXwdri%W(l z-0t<-B4z^3M`|aCz#r`C zG_C75e@NfwaDyeK5q&PeaKNdlT_dTqKyT@L9VdQ8-JH%=>-PhUWa!qt;ykWz2~bY& z;mYW_rpjp9Eq>I8Fo8?1@#D}#xjGeG2G*FVzhvdzET}=lObTU#f1+xl9+TArqs&!a zGXG^1lIwF8iakY3P2W*dVXR0|wd-XEwky$I*@2#)vLaN?>4zE~$v4M7x6(of^7Q&{ z)SV4saVaG|r(izVXanrf!19kSa*Z(G<+Rw=i6*N{E~ug!`mu;=Gmk(Jz~7DS92fT$ z!v+l9boV%HY#Fkzt)dTk=cFa&K1~9IE%=m4`9(uh zx~duTD=q=Qalmd;CVejLfFYgpCuac%Jz65%+kcc|8dkKuN*r`vBQP=nQ~eY5rXux$ zs;lFM64MAXom=#nP^&rm^KhQdAY#={2yr$Y>6Isc$L`*k8W|0q&`13gNFUo*s|vZR z1dBI^#S_{GmQDtINo~;T@Nz@zg1$3_st0T`fEPtu1JmFWHj`6Q2cBff8_qZL1-d0$ z83DuVnt*9t8;nFsX~+T|E%Ee3m|QgGY7{61PH_HU_2fudJ(H9M?La9%NGSKjdp6k- zCV72>-0gDy2-e3)ljb2^DNx1fy&2nPtrd%A4m8qJ?M!L|U+VS#x{{rJpd}D-p?ADN z<6$4=N~_1ZuuM4X=PNlJ-jW&hj({b*iUn7P329tj^l;Lon7?bfA#H`dX*$nU%zwvi zN#lOoF>6NPb5DHhtPFtnt4IB&Mpy6=He zIgjB&v)p^lk30I>xi5Pyc`V0{r{&*3uqlF&Z0|5JSE$TGgtD7WIwXa@4=oufVD=Aa4|V=)o9r*uKDuQbOC zX~s>-4MZab^rc_pYzRYf#_P6(v^q-cJcxzP+x$44qd4r5f+jXUPm12%Pfcd0cPE4i z*42=<>mq|+2C?bk3+<3rx@VplymYfU&zP&}_^TE6mKeNlnc+M=?V z|GWWbAQziYf%Wu9Q+8o%z30};yuNG!ZUb0^K2P<1Jy@5`zm;Ouf;Bn5=i4V=JU;F6 zdpo#lE%i~boc9f&)fanDLZtrAoD-`q)XIp=BXVFhEouDPtmqv?tj+YR%SZv=A_OGvCG(>*;UGts@QsgV`UTQE&giy7`fv0uv95 zHITehIKDDB>vU#+8&1WP#$k0E;sksTLG7k6N7F+u5xLE1EooNdqfGb(t+}m)mkR&8 zmF!opFI2__hdqZTMFx+XJFGS|wZmrkx8P~svR+B_$Bi@K7rc5I-M(vMb5}Y`xe15l zmz~*YoEd|!tEj+-3%w4ma7$)O#`EE*u4UuUNz;Sb0-JRag+kGS_rd`R^(k8LdfZ?p z4!%y=Sfe9z5NNlfytBHdUD=cHg*73ID#!foJvVbu4??Ce`sc|kR_Q3+9%b4Z_w9+)nNwT=SHqGos-hiV; z6dV94lA05FF5zsDt0WN}4+-@^PvFPcl#SI_QBn0_u>wdhuX5B-JnOg^RpQz#?4M=s zW5FjSf?*6QLyHuVs|mss(CzBg^a#^5v|0f+oKItzc1MX{NA_L!ocS*Ku{ zY3_0{;zKC^tPO9|l~~(yQ}ji}?T3y)IuMcJgSo>j8#mG#Tah_4tc_f~ghp|-|R7N7iwE19|O({`n$ETVKw+j9=x6}qBLwVI+Uox|z=-si(J&ROj`G|vkbrSe%~o4LYi}@{323srgx~q z?S`OrONro|Ues=ePs;kbnE8SUmQTWu##;|~K|cwHz?bi@+Sjwb1UEAu^_^ze^tur% zflPe2`s(yF#@X6`KZGb0`!%8Zb-zyE5P;A5!0E$66=W};s%AEVY(fu z9e}F{FWE6%S`Jzt&3i2piRmQ!iZj`3>teh5joY4Xwbw6O)mH4W-Gmjnv3Z_FL83h5 zPZ*|~QSw=F_Ay*??USyM%rsh^1jgg)Ex>8zHx5L7WItlR%G%63ZTri*2ccuZ0VckH z*w5(X#HYspLhnf(<(%joM509wgKl}GjlQ);(WU*XK@m43;T1NgnPpM-{^fj;%fYpU zlp(#LpC~4SPyJ>i!)mt-enXmC5v#^i?UG=Q>ua=MM2@!MPa|7iaL&bbj8-w=Br1Sx!@(w3(aAe%EW*LF>WzGAdLb;@h$y_;fpsPYw;v%Y9l z5a}QwHLD1SG!dm20U;tyxV%bLP(6Gv9OO0%8sy zJ`@;i{r&y`SN{M{<06gTV+|7uU;7{cwt|@Eu~TkHxit0NV?usd-#~|r~9(+ zpMT-~_~q0E4w6G<^+1`6K+YJBJ>RoYkK=YM!omPJ&W>D^PZSV{22dTfIb(919vEkw zHHL$-H=#T8Q=BDcDu+JL@!#3pSc9^vnB@Q*yJrrF26N_nd~ldI9pF2h-LV!9V-d<; z!|aZc9ksa~**hE&_O2s)ca2GFsfQPHv5_>+QvG~AYi?(c1#Zp?ki&rP0yqfH${42y z%E0U*961!uHiurUwG9pD_!PmR%%Cg&y8d0|dpAvSc8Gg7abSA~i?gnK7Xf9~F~QE5Yhw+F7W^3+PWOQ_spLJeFlqIioi$GI&Nh>uNiN3#&@9?o z4|`_=6==`GAlK{n8owJ-5YED5fDkxm6Tm6w&{CmyeW1|d3y+x-=mPbPAvvh9Hk2+k zX$g;VWOu_byMd?lQ`no9Ja=&}!QPgRyr)NKg!&fkX-^?3Ns~ZA7#>LW9h%#|Uop`HT>i{Ba zu$xi+Ka}fy841|BN(hEt5T(J9D* ztEAby>Dp`D6XEK`T~%uls1-u}a7FQK;$y+sENQktBvS+lT6^02oMuHoJ9AWo&9Y#> zARA93ON;>rwP7EZ=5xdAYlGJYtw+fZv)^a+C6SQy-e>(aL$)gmWBn%nPCCNEdDS9W zZSk(5SA*NG&*;WOEN~vcd4`rn>a}3}R?T5}3bq#^rnKcg;X={B1kY*&ozhZ|j_`5c zxiA-&*q$}N+I^pCE0hf?rv;s&AylijpTe&Tw~iRzE?w;^dU=<{kHN4gwFo}fhw5f` zpyFClT`#*n_$;Aa#OjKMs|*QeUvJ`#*H)^_u1-uQ0v%t3-O6cq?e7XR@?-R81gGKO z0oFiuX#6>?Z4{!m_OeD{>3h&aCkx(=$xZRG4}>=gd`{1dncEXzShU?i zdVoFzt|A3bl-1s!C0f@s=eQ^>EJ}<8kj#(+x#FVZv~W!RbDQDXG_gm*H(?O{fx1Eq zVz9Hp1JBP6aQmuE|h(TMNV^I1>PB>qVu zccAEmOLL8S|Lq>a`((AA%|$IOp-V5F2ika!2l^I-R&>0x)CC=UN!8k~>-|a+c5Uoh zO>y}Qkt@O|{FfpIsuz1qQFj|f4Iw#r&E~ayu%M;83^^~ZO-q$$WTv!i)d&r$%M9Q( zPs~d=1}<+g!h(?)04K(7$Y|ww6PpWU|if z&@bB1c}$TGYa%77yJ+g!(s75)4@LVfFXGD%JFf=(Gx2f@e`d@pblT^=N{7t zci>hQCaSNH#UjcUfsNR=cA~=_eer%96^@{p_qWPruw!?E)lO+`CqD+;Ylw4~e>xOO{_ITQg+a=(BbMi+r=wnb%gPsmz0bJvDlP|jE*gFMQi}IF_-6H91K_^j zeq7&&O!T?srFg~5!W7vbhAjvSzx0?q`HdSZUnvf>AM0r;me`JhY%WvA-V8$lfW~ddBQ!O z;{4{e4W8oOWZ_=6ol3GB_Ne~xmBKRSnZv*k*RCaD*HSirN^QnIuilz@+3AqWQ!4!I zGx7V?S06C^emuL_d3rHARf6wHc#;_L&G*v-3hH5IC@UkwTDU7x%iqLwr{;xMC^kEY zr3rZ>HxGH`J?IW3@T`GzTmn?)>)5|!ue)2ydc68NWHGWtUgooxDVTxk1y|F2%-aRG zH^o;C1&!uEl&)w*PZ?(K96{BOGa6~j{b4qB_CEls7PtDtV;zhOxC{7=rtjopjk=Lr z;Y#Bz;W4W*M<82mT#S_%6CmpigHRc^8Xgk_bXDsB$(fwHFNnO-c0NsCX;Jv&+0hDz zABX|%F-PAI@t^*LuJo~L*-Lw_T;g=x<8OmR3$VYs6T7`SJ$Rv|zmihy68Kf1gU~vz zO8qxE{#g#|-Y6lmT97qfUG=bm^wN<@f(l zc)yB5(6ObvqnS^(E=9RyNtsc;u6nZzl+Wu8vrxPoQ>3Kg|C)AS>e-)>KRcBJQFZ6s; zV?xi*T92~Z^Zlde4xAY1Fm=S?X2aR@9W*FshfO3$`8cw-b=$0YCWfFQXiH89*@pv$ zK%va3OvajRpi|%`!jXOH(z)E5zZ9I5EfR5PosXZd3@?NvK|z-m3IM?SdB#ogwOQhT zKpQ>0t{C+MAc4PQ31yu+)}8!uaVKyqae-Q;zP(T~mXY{Mx-WWen zNiBQ0)l0g44!))+qpLbUh&1k)^i|>35Mg@vJg^LgEk~@w3KOM*X9O#k`_m?8CPL8Y z^<4{o5TABNSq~S!LeleS#;5%Ma(O7L(`5eK4;u;W9jRMoUVmVo=wJ_Es|w2c>srN< zLeScj-7>GZTFDS^Ug^PmKI|}DV`JrK*>~cwYiY)$Y!}Kk)m~7MP}Z*dW^$iSnIlfF zOHt@eq8mNBGqVLGobInV8U>(S%;d0?dm(gW*}*z!3jF-*#eQ`sf>Vzu)dv20cX-^pvMW0 zByN7V8r=T+IZ2uPAmGvSoXTY06YZGr8nqP(3XtW7PMIWgYc6`_N^*rdq)MzKBCBd#yvAwNlG z#4F@8ad;sE2HViCkVc@!b`VRb_d|x~x3mYenP=SET$!uYVqJ69-EPQ<#~qKV3eOM8u1WMD%A-p{9tgX=j62Osl(%l6iHca3 z9UrMgaV{?wg_Ng{%GbruSO&k$f&!|%Y+(XL8iheKE3aVX8tFT)6ao>DL2@G5A@~x& zJovWiaMpRt^0m>dO|C`zMq~~tpk&I#yjw%C$G@X#Xoeu)#YL3oC-?#OYSIlsnZ!w( z6XY*7nhWPY=y8FE=nA)M<}G3afi2jD(5xkbde$2dw)R9dE|_r6W+!)kQDw7M8bu;W zG8+{Mo=k16A+(&_ba7aBfju%-k(OOU=HAvYc2IR^lw?;+=_LsR)~Z@M5wF>o$tUnb z({UNvL63!pApxwz8p^msfmtUIQ#+AFSoTDmL3W=~#WeScMdw$39v>H1{PEWv>@aUn zDWV>+zSqD@6$u{f;u^iYPR0a6_5w%QE-9cN=Of$X=sWTV847n{02_5nv>W0Dc95~9ZIMLlP|J_tM*q|@dd=4YdkUQOd zcz3LK*K&39S$Pzlo#uDlz9i2!VEcQ=6m{St&5;(>igUeFElm(6m@#7EeFgh?&25T z(^n+u-6({`IU8f*BxCi=fbM;9JiE*w7Zo;Kf#UHLFi+M@a7VB*KWkJ$H-v@#|U)_c^#$hQ!OxdIy6r+M>Cyu=Kf7ix960YbNoZ4y2Xx#j#!uX zTcyo4K4SbEMP2Sfy|3ceop?K%*BvQwN2GL*S&hDUe?u=ecn-5PhuQVf1!Z#K0>h4l zUpvNrIL5uQd?rgvfv@DScCjSP*-W-D+luwfij{%CnetRl+e>TSUU(+AI6XF`O%z{$ zVmUtiCPNbBn7{m4&NRKMN>TTlcJ^SJ7)!cne$kw-GRQ*@*W)=axsaC1r>}TEC3jCy z+pT_Lq}J1^x!n2Y5?2rsyA!SGh3mbhZEzWnxFYZ~Q{o;EsK<6jTm0~n1o^iT;K|e4 zaccL7S^G!7Jq8<@qt6=e1-l1}$HGeeAcT1Dfe~Jawd7=0;qs7l`IrDCZOchESK5hF z7+6Ld9FSw2y=eN9pRAEwK_1qkWqpE`R%FR-#h~4qMtgpVUw7dh3pHz%?5p#Fzf?g_ z>yrn^V?IlTzHtXE?ok~rOANE*GRdcx^+5G(V4=2v_<=^HF{|5jd$Y9_@BVUpr4?S3qIDhW==M zYTl}E{4!g>YcAn%9iT98Pn=SHcQ4Z;A?*1nEzt9bNnUZ`4S(@tN6V~Jh3Oq zXq~pkE7soD-Lp3i?B}qG?ZW(xjyF_t`(}UZxEK4h=7!4BloAvqpd$)S*E*J0b+<2z z#VZPxHdOpdJ2M0;K=h3w+HwI#jK(`9#qw^Rz}#$=;!qnE`8t4^DY9qMpjA=^WTzK{ z((Ne8x}G_xI5t1T6>ER9byC+~5YAJjpiOxes>n(wW>4L8TvA-B8%zy>D;K}8wIQF~ zmE16_&Yn_#E4n-0dW9XW#wd=Rhoxm;I~lkMP)?FlVI$3}aen%YCN~ZIL2MHr#{Lfg~534R@lAoXNMr`3Q>=nHc~X zz!%RGx>`5O{f)zog*fNO&S~Xobf4-@nn;yA;E_-kBwh0RQ0?WC(ghfe4v}wH@U7U7 zo{!Uwy~6ekuXMJKUaO0;)1VHXeRr*XnP7l6il0keYb=?Cb*XQv?LFUR(P1*t<~G}V z^u3{z?~#x>z^m=`)O5%x{s%}J7okO3f2Zo(@O|3e*1zmM$~KM(nw@6IM|y5KX*;2` z`zGa!9m-9s^?J{b5{I~KdELt9cVoLs!uquP8hUl%`FhKw0V37C-IY|QZ+B|*thSe) zw#@0UbK+Ul`Ek@-?vU2Zz)0^D3lyNgda}|mra(e}Z_ZE=QE|5ORN1IdZ>GEp7gCT7 zqD+q7T-AyI*kUI~P0E*7+WdD6EAiP|PW#nALG2s40c*@anss{(1q3{y^ld`=0d7&D zy-RRTIyxEw7*6nk_7*~`tj5o-ZyDb9j`qFoY-cG1JH?Avj|r_f>7THf{rKJEHp-?P zy$X~hdUG|=$a*tPi+jb~8lN4tm8Tgj(^{Yf>q*(ul)25vR^n8Sc)ix$!b&k}ECi); zmZxm4mppTJY{_tWVZNkS(hobbHcSZaw*o~vnr+`Fko+t zt6fv8if)V(U~R=%>(u|~8q08<7HW)TGbUEsQl8abv?ZFHSazqfjks{WUGQX6S$*}* zw#YQZHETakIOB5b_U)8j`Jjs@ea95b!i}b1eU@pm85aTUZ_0yQW8UXkOHA9|uxRYi z*T*b-Ed3fIRdqy3VKzWYnI30j7`~F5QAfkQh8+MThXCqzc)q$+T#7XH6G=K z4iV)GtZEoKXl&wQg>8pcN=#ME4r-LUlw6-OkEykF)uO9& z4q(WXYeK6W=iP*FFVL&NH_;m&lPR+%zfDt(ma@Kvl-MW6`u!O{hF+JGTjjtsJXUr0 zGryjMUk48k(!_6GRI*Tmjj!wtA8Bp(pMzT^c;GeBL5CH}iE*YcUxYzIm>2js#Y!%8 zNsl?4t2A)N8+_ZQE9Y(&U@Ir(WBAfXZF5QerCB`9cXRW>2B&h#ORfEyHex?zh0csT=9OC#zySr zcO$c51&dfiv)Sx0c+tf87PBUduOCPc&<6k^5NH^a{taMf%`?Bj#}N8h>J^xxmnkP? z$D6&kcEuB!%qiT`un(??t2hzJ+8oOX9oK*VHkT1wq@!QEnY8lgC4n;pVW9#qusSx* z#7{%zm~bM8MplVZY|js!<=^H6MKjB5^@A3D8|EBBmNm5SM>=}8R1EqjKbO+gH7rA< zV=;B^S)nVdR`=0QvyZ!ViB@YOZ?mx))$1qK=abYF9}G61Kx@P*H;v0MC3+3vO8 z;F5b<$nQrkeXf#Fz7#qe5~#b-0>R|(S6KPMTS}oJJMxRy72F5wgX>9UC-E8&+wKj% zR+G!;d88lKIY@opEyKJ~HvUTE^ge2C1bmlY-M!js0l_`6v7xXYHfN>(BqT4-(|Nwc zr^@i8y8k=$^Rpo1i1sltXN2foMA)&R!cf}rk%72(ts`Q+TFi~WjIbVvaXNHBgluj3 zvSTdKJDHiHnf+3|wzmGlyZKC06YTgt75Q^F&NoG{0Se1v5f^he_B$+}5#BR$ERNOe z+f>@bk9Ff3$LhJHU1ZcN?BTC#!+iE@Y=j4EPsM<*((6KS`keOYw@>Um%d%gnc=7ZP zU@A-4ars`tS#=o_6VH9*V&1BHIz`mIZOyk!IQ&cOwF;h~N?+uSwx=lPd5hKWp-(VY zPwa2lejfi``+L9>`+NN32ZH{%XkPJ_;!?Oeez4NE)mvc}`xxjl)w=!GB_LK#A}D5D z1`MdQtwDi=%!m1X#Q6?cKa5Qv_4-poYB!FAuwWliM; z*&7=?@wu;+FA>Nc(^M>r@}L!DGMVPf@^~8uBYHgR!DJXW*!1<|D{Q zH1M2+k9}J#II{f75uUvG z_4?B@wr!f7lG}AOkHWKwolu$SFG2nqmq1`YKP{X1kGBpLg`7GUpIR07IQptaS9JNq z5iaxYQiI;jdpa2fQx_JJ^U+@!fy?vxIDokPuhk~1DWz{uYo4a+pV3mqIsz|DrNwm~ zTH;}%zf6}#xNfiEVf;?okCaT+h`j0e*T{(=WvCgLc9OZ$Ah z;68zEnqL;EY9IP+`1I#2r@@bqb%uiua{1PV*LU7r1t3+Da>G{K2#HV?R$vhBQcEP52w&5Qd#bs{f2@7Q)G{ z*$p0sjDJnC9=Z;6*E0L~3B$>+y+7Ub0}5_Vlcxms^g>dcvjl+ox!7{K=@*ll@%MoYsw)t_Yrwqwf#?%vL~v(ImJ>VvzX^t+QnMqo%H9+V3n zSPQi%hZ4RmkP6~6V?qSNp|e)Q3E1T$aFxpJk{0dpotor2`Zr}Yc8aw>^b^8(-TlQy z;BD|^(IorZ((OPk3%l%n*W;we==t!+VB;>K$;8^VsvpUk4?z1}hDw#Y1)%7j9ZIn$ zi-%fM>pLJ5E9G4|gG>&ZPibe@X$IA`v3E+hKt6@XF*7QUOq(CuUGOU}d~nfWI(9K- zTg2RV+d+6tVIiuDl|hPevcMj9vJgDx$Y)4*Tvfd2LstB367Pm2L*$*9VZlVL5PS8k zk+jl%9nID5HX_%n+YzE#GvPgoQ!z4XJ^d&@Lg&VoHm=qgXFIAd8s#rXZ7f2uGQB2W zdJ}EmjHfm{4p;P$=%AW`*3R+2P7>AZ%qh?+#Vs183vj2$+@2UwN=;&Fz5HY(gexMlT{#JDe%S8ki&5y?18n1 z!O>5fc2O!2T~-FBeD};_)7y?7K}*DB3`6T~Z7+WC0SPDkNjYNdB|cE#UDq$39gL8r ziqM(hfV9}Lxl`@+%b&4)XW#2ArmYe@CtY*33ADiUUIo;nP)I0~((NvD$>3`UNhJN* zXzNlC%t(B-&Otf=-V=4~8e@y9;@&;U}8Qb1rMI+Y$Bxnl&3E0MZ5)^66~ zm8Qq9i?9zB=j0S8K;Cm-gtjlJZ7JoJ(VlIBZggnFa}ZpCM^a;kY)5Y4Usv1_Mt}Tnx z4}_huo&OLujWxYrPfr88ZC8SJqI8;Nkj=HdX)R7oK%+zJc0ILGfR`$h)7;=O4{&Pb znDbINDU;lUcWSEdaF`f3uPyx-j{ed9f23lYp7f?WhoAkkDK%XJs~Ix6^-oa^vtc(^Sq0yRF|`Wu z{=YSWvjuVIs?2^y)9+?s(KQRl|0xA#Shd{sj5LOL$alYS%CVvr5@E8_!HlZOZKKLI}ch5Rdr*f)74YE2```iIt(*Wj>3M*G^#o1NY0sbd`=zT@ zYGfUPqX{l&!)9@8I)lxo)~jt#)e}Au7ECd_ckgh=Oq&UP3Qiv8u1#$MEqztqo>BLm zihp+^5qEO_OFwh%&cV9IEA^;1n0|ZHsa`MfkYk>A|_}@eJV6xw6O;Urk-X%d zYfFJtF9c&Z897_7fiv>y?Ga7`EZ*bakVBuQ>Z zu$zBNOE-Jh3KO;II*8jd{b;glUZ=r6tiZ*D4u`88tIM< zmTttVXBfZ(slR9wdyn63lo#@!B}n_>>^Yua8NC^}WG0DJ&+75Tve@*5E2;O$f zln2&6EbAWGBE@@_hnn5!8o4V`2U{zj9E)LALOh|o;ee?QYU(O&Ua5{u%2=SC-lNXb z_DGz?I`|c+5oC`}#&wX9?)%2I>r8>%dvtSL2ep!=yG5Cvn9cCleT>Up!ZohI^EQ9> zJ;xnglTKS0a90;h2kK7W6qy|`*0F4F_|flJTXxdUx!oUK<@ZXE^DEIsitRh&@sYa0 z+}Yz}BAoMjO{qP8ukH=zIGe#@XHi<5J%MN4DFcbjvDVw(aj}ME^N9a6gW}+|p;u!I z7D}U!yEex*8pNJJhx8D`~M`|U6ut%!Hp1oXhwdL&P zot)&I9L=3q(s{?)sge=j?nA6a?zPuC<`;z^PXGqC7ygxH00uZqmMii}r(gZ!we+9; zRsNXc|D8k2|Mxf0ob0>cckqe#FZlaIYyc5ecd?yHw30zBosp7V%4&5WL^~MHraM?j zF$Y*aX{TlTd|60{9$)_ihj&ApLP8}%qp{Ijy8i}%YhXyNt^m1leVo7ZAW^>~w^MM+ z?hf26aJj$&U8J2?zy{8Y;cWE>p+c~^P8O|-)5wNWNLFKH%e$XMM=0n5PQA`Fv{b7~ z3f6L*)~$nEQ3J(G#^%k$#m;B|HhO*ay_QG8Sy{!JeC>`?H73s}6GuRESq0u2<7M+i zx9f?Gi7@p&C@#fd+xGRLr~zWM#)%4M|2YYbuqdy`uA;(qMdivR2f2C@R%-hv{ZE&~ zC1!QI5Rie}(6b{4VoZ^~3@VF_zIN&|`itcLj!H#kbz%reeIx5d7>r(ngRQ-M7IYv9 zH47Bwp@l#)t~CWT-63U;d6~Z7-_NU7%m^i#_flTI!h+eAXt$4!GA{gLt1sxvkEWyU=FXqY_hLc*1IkPE!4EkKFDkg5PqM}Pfm z&O;Mxh;brZJCnSLV}{EKdEm|@sCN_m^S0kbhBsrk*h*f+o_u?_%5H$o6xcj9IxGH8 z7D>SfL73T0yOmlQB3oJ>N1G?A&{CLh6gjzCv(;s%VC51smuNB}nx_LFdiWUJ=um@a zW>@a_{Gy#@kQdTdFmyyX&jqZ8-hHF;bGROR*M_b^V+1{MUEOZrhTI$_p^itJxIkxv zR~bzw&^}XW7(0$@E%*AC*G{-7E??%88bdW@1T#=mnl}_gxiGc9wm3bZ`$WcbkPnQB zJ;}0<+$pP!>6?nIKcc2`6?Y|Q5ATcmSG=#XXoGt35hk=5Rb2dOTdXw)^P)1S9drin zB>mLaDj+s~V==Z?X*8bfQUalR75lGU2y8p!f!jd>ba-6KYGN)LN*YS47AWO?0|pWH z*O7;D`pD?YPX4y`c+Yy7K9v9v>IB?U5dLb6eAcD}(S@`AT#0`}rxruK&yU7@c3K@| zrn>EeLv}FM7YpR%NYg$c8pr)S8-nLVvXWM!1H+EqEti|$GxpDK1Y{*SXBWRaC1@+G z8##f?yLkb^EV>vsruovfIFsZhbKZT-=*?|IX;m%cL?~pD=(7^5CaYF5eX?Ug( zD194DcEFs;7*MiiNZWJ{f((-40^gc3&1D_jVA%CAwr?m5*o3d<-ax9O%IGt1<7Sk# zu+m>CQCGn$XQ5W~4hP#|xI=ypv3oasvo@Z~olNNJap%*~K;*d)`YrQ!(ob}jyoiT&Vh9(xbJqTV@Q=Y!yQI?ELJ~N*72v-2YJt9At zfanjtrxi0h12?iZwG0rACHY-SdMdmZojrSx1&#N&+_%RlH_xxVql;T8l!#ZpY)fDt>>>joU<$ps(IEs= z3sO5qf@bzx-ZFbfp8f0sfq%CJB0a`cJmR(A z?PWBt21KiA>nOG8W7#5UbXgEnRf+z-w`^XTCiNgmD=R3sr7x(g@kFzv)OXXDDUJ*L zEg#u(o}W%!KlN1=*x=V!wxLS;j_rxUW%)~AVO)jlNZ>@SqovF2u431W>J0irtjr4L z9{mU(I9(^`mGquZzAA0DtdG^m?B0o$Ln3s59E`=%NpWP1onq8LI4pGF4zb7mKC9p zx!v$p*g^(A^l;(#*F3Mkjv!M^LDg5HEMG7}=~SYQAUJ!&SX=w)xVUphwAcB%7uqKo z>GwLVw2$$(JsMd%vDpT3IU);@Ncp0?IGdu@?j+Hlj}lW!yh4YE9tc$WjnO%eZjT87 zq_CL^x!YBV^~>8I+oM$4Lxj*rn>*dWTC2~(x7LMoBQGoI#?aS}_lCsJzw zka>T(iRAFB*5?*tV&a=y(|BACdRY0S*RB?aZ?<<<#owDWFXR&(;L9~;KT~gg;mNG{ z3FG7c=J{9rtNX~&gbJxs{Cb~)z`n-M>gk+~Npl+fvEc?FlH z=c%mTh+UNwnLroGrf{F^$c@w3qKV66mFpR&rztOp!piE^`P11@lv&W(4qJorsv8x;PVGtELgZ7sLErc#k@QoV~_`$3U8Y?82r=Lv? zalHdzL;azYFn_3NoFTTp{k^KyykEyf@~J3+pSg>Dlh5DYY7-%(i*1+k)Kk?P&)+0j zEq%>IiW|17DJwAE{usLF(E~?)MzmC`Z)9&?oRy#~Jmb3+F0Sq*8MLu^`(|AL$@=zb z{+mVbqVzAlMEKBZw%}wLjr*gu^?%DGKynf(v$?JL++x zid*RNl~0v8ToA`Op!`8zAL~OfD&N?9wYEWLW+x$Pg%R2wW<>ik?lHx(Lx^6!Wb!gm z;mua>c+6UGK#P82hkeo+F&UM!8?R@aPBWz19m<4l)0NE?-hdN80u~ElliloV+Q=rT zWIJx$_(_)39}~#7f3B=X@u=2?x-R`@Z+V6v&%lD;K|_7ZKVxNZIp*c^U_Rv%W6j!x zJ+Fo*S1&DgPBVAMBU1HaI51hX-66G7utBsIt=G{_6dz=~JZT7Koj8!V=5{@!HiWHQ z$xe^iHeDCo`4d$4cOaQ+vyI#8Xw;^MvaXYa*h`*L~&wTvU-iy`g-&}@uye{$AD z4ka@^>fV2qLfDuMptp9t&( zWiel?C!E1xQ>hdH5Y1tB&>W#aFmtn9&bO>;I-5;dM=^k*f8!ElX@ITT2uxv4R^!TpnvhDZXnRLO07a-==k8Z?;yiLX^MDkWOV^K50aFcVey3 zjdp*k5i+q^0h=7x+RqAwy3oKx(v(V#{+DrD58i&#=N8Bt_%m%4jao3F7WfDGEZ(qx z!Kk%V z03LOaf{jK=3Wfk@5C%FT*|=nkl%w6V@dO8;{zgAM z=h)j{kH?P%UQHv8HMo<>2S!Iy?`X?)#D_AT-MO>OV}C8`CaE=GW0g>LMtFpZ$Zg_k z--VNi%OAlB&;lYieAMNY6J`^$e^S)AK^9IaY4ykTG zaSC}rvF_9vz8KxDj$=iQk>)9v3q~RJfK#2-uSk0^?gy*%ru{aXS(e;4zzyUMsi${% z`Cr*Q-g#(YV{mNFp{Y=sjukkXLm{^y+Y+=q_IgSG^eD? zIRUPHU7pqPfgI@~d|)XqUXgzb7?}9#_Kp!5I8=xBoZNQ*CEmm%!-v3AIh0T|r1gB| z4oYHWM?JRB#~tF;3~)p=*7uGj(fGYKvIF1kP=6^8QzG_x7~H6?t^MYW1^kCM*0S_B zZ!DfO7YTA83Cu0(v;{5Z+j6Tcd9H-%N4llgSGfA*uM-!FXEfGONw%-y^8Da`4Ggo& zika_o%PhA%U!G}6Q?NXv=xvNS3rYLa49P8oGgoq*P2kq(=>Ko=({zentcd??8l^o` zb*WhaAE)Ni8{*P0_*+uF#Av0t;wIo*{0~AEXJ70K_h;vPbGC}VZD;&_>*5<0cZL6|&_5IYMEl#I z5+IZQrS}j>`wHdbgkba^;dJhP@FPO_9z|B^m{TYC5o6>J?c%TU-dmIK0`+%=HvC($ zJbxFMf$gX{WA=LOD}LGXPpG;Z@HEx@ukybMzBnMpmt=Lz`Ra=UGdH9Q93|9(EAKA=zs3I`xN`QN;T_sz`r68$nSQR! z1l+@qtNrIL{G&hiWbXD&w7-gTDWY2S$3McqN`9D?#@%n{cIMM7`j@}<f6y)?r(Zhu*`D(^{;Uje6x@WtP;l zT(mpY*FZ_g9ZP@mNqmj0Z}{?Syu2b{ok9P_&m;vEZt0&C^5~A;?rHx|&pp8^As63R zXX|CVcIh-;-8(8#elDMOjdsO1ZP7)2JX5{CDg z1;3jhDU8ALzg{_s@(4sseD3b*d-%B{R1Ach*9^Mrf#dRk`4_tdTNIPZ1~qHWQ%fwz z;&sSdeNt~=MhJT8oa7l0b3@3j?{Y@PdFYDXciD{(LqL}c6P%70w`m|0U!pM7^wmgk z3Mz^JH^mYd2e}Qaf-S-AF8af*V2zBKtmR{Hx5k(o9yQZhJreOLuw-Nc=Cx^Y=p6^Z zLxEM0h~DR@^J<<=&6+m5&=R$&nmzaH4sFv<(JU*q?H|Hbbp;CKnf;whL~JQ`zI8d< zO2{C3X+w$WnPi|KG!wycf{p{IQU4Dvs_kq(g?f1h+VrQK=Ata4($jC1e9JTa3yCdw zsSL;0D|8y4+LnNt4gKo!gKkbmq>QH%m+kl`zPkV0V7ZIo^cCOvoge-;nSZS_rNQ@W z`wPJii4Xtxwf}?Z);L~Olj$qk`~I)l|Gm{>-kA-)t9g-I*Fja`MWVH$SfS28)vKWd=+FuxmJ1QdZckj`qU;Zznpg z({d)`-5S|6p{Kd{6j_Th)9sRN_AFRXO_5{Y3A(R>GpEh!)qR4f;*HgVwh6Ou)IuI z)Y7I3b^5nY=@>-?ZLb%EKG?8^SbWm!7S?46^pD9^)gx&IR?W!pcP5$O!ue$@t1Kap z6HA=w6-n4L5$&w-B9DMTpEr@=zIph7FWJ4@C{T#4DHY{g+LG_6?Td#6a=2Uvhj!HVS+-_>PX7{kxY-7~+(}#;>`n+;?VNa#Y^sSRd_uK2I3DY{tdg}<{~U2I za}D9&u;tzJaBn|&S4(_`kpD)Nm74HWCD}VbaZ{^_lAQvV*SEm0j388b(8bd~hq@qa zQ9Ls#POJVr=+ANU@tYBZSj{4l`C9Dy-gaEm@krW4({n$gIbT%sVymUX=%51wcH&nN#cw|bemt3Ttd-qu4v`vGH@-l-SGV#x}Z$+8EFLz5j^Xn94>?4fqgfirXnW z`5F53UE-7iQuK^~9*=*8Ny~FF-o!hH5|5Ll??&H^c_Sf!HGP`Cf zXgi=mSiK{bc-{xmLo?YLlK4`G_H-tzYF8>)(fq z5Njz3%2mtM$+RH9asTcR9#w)nl(r@fFJ1^-39!gFyEpkPKX~f#fuTe%AmvLXs=mTq zWP>ekT!ujAV7Y>ea^Z2jJwah=N-TCj(h)j zGX`YNti{U8%nU2fe7?`;Yd?7&bvpd=ZAA3*@U9c(ntlDOPm>+ro4zJkEjiyuFmP;N zk_3Npe%({ivgvz6cfCT3^$P^d1I}mtAaeCrb$frs_w{N<6F*MRO3gfR321#+otFB_ zkzn|CL$m3I#7|K#(BS1*nJ-;hz(ex$-j7#DPIYSnnuG;th7;jh`YXJ0;pBV}XQ|7C zLO5zCSj1f_+(`Scd^&$8tE}ATCs;wuw9BWKe+l8Xk|<7Z7}K%#78Md0EwD_9u=6TU zR+`1`-^i8{7}EF9i-KHCk$!<5@6rgR8r`iROHPr!@1}zS8AZ*%CsSFJ&P|QTk;LRd zfNs~|<k|u7DeW%=@-j8mq9B}<5(@p)swFS)h#oRz=U&Y9yb!zVMHhR9y`+V&XG#fQ3R{Th ztdW|NZsXb8Y-(7GPF4i?j@UU5N|MzfmZ>im_S2=cSU(>DR!dj8(dQl;`>EGt*ZJ%M$O{NNCVNK()55U#bHY11t;{N^ln;)-Jpt z4}}#eN^~Pbl-CIzJba_y%ME4V*RPr2DUl?jr!t+XkDh*#BUV-R@O$=X*Ghm3qnU5X z*6MEQdYlAh1}MiFN?E7EdvxYC0$^d+S$>))@ixIhDK^hJIVy;%mcq&7)pL)ln$y;e z2ReFKN*h@jqnj$EsXwk2eKKB?<~ zl-(^W|I^^r0j^yQf&xLY zi2sXESn(JUljCVOubiSL(m%+bn&n&o(SH(E$>$gOs#&N*r{G{ zSuzZ-0v#YJxg4IO$7Um_Hr);W%}Ungw01u3iUFpWVvPcEwl0L&ty)rYu_3fA(r z3i55QdoF%G;@U&gLcL`>g8)}%1GY*JZrk^n{yu%bPThONmN{zDznI$fhP#t*+CW)f z&56u7+iCH-DfMB-c0KZOe8zTK^1`wbZ`+dG(bcINdg2}?Ay{UoX>2dqK&B6J*{(oH5M4w z;8FF12S2oWN;_vH``Z2g4afiGjQYPghyL(^V{x|aicg?O>n-x_{hzHw{X6G}byEAH zxDIq8830zHeM+{t9E8~7Fy4G@3#fVMCF*ZOSaQ)X-*DTFR_avIZW`|WCgGaWziJu5 zilib&D~yo>jx>OG7?UZe!W|@msy&!!Aml2P4to%CW}rE;40jp>jR5Z87cSTq3^pmO zfX(^025>`C*XLSRjPtQQQl=r>z4Jemck+$tXq!nw*PL%;taVRzTI_94g^+H2&ysIr z)x)vwYuD>5qOGJ739_5u7;zO9OmT@N++(~ug_$D1I=$#(oUN*pflW(~ejTqD@?Yf0 z`Rh1Btlz~@&#&`LDO7sDJwN&OADt%}15H^l4f>notKZ`jX64g{lKL?+8U|5{AB63W#zCvTT|_XHyTTa z<4c`B@WbYdip8;5eN|LFwhTQZVxne|Pg$ zj#DYI2v%45zq!An1#4r306`Pvem$@#LE#gL`(JK=PzL(PiFw*`#9RmoxH35 zfyGcMF%_~Q*ZXZ!T|=wLmA7)MQidwcpt_Dj@Kzgs_QIBqR{Qh5#ezNZ82HkzL@-wq z3xRTlFgo1P6(4+$1?c_3S?6%sma;tiBsSBEp_6AXlKmOO&M~6l^PAt6wf)@VfmFjM zzj%D`{h3ANcD}Dq*qax7ecQKVNG5C^zunpe(s{1@;IuHs!jnGnP0EZDhjzhM59Xym z05a3;iOe*+AT!PWiuIg(f#v`z4l^CT^-=>}cw@Jc&ZzJ|@4R%QB;y(%HMMjue;nMV ze4$?uFsycQomhI(l)3oT=w)7ut>`Rz`Os+1>_LF2%?@v**Xs(??WPYeo|<=5N5kj&-*Y&HF!*@<(maaSfJfuez+K;Lx1sYB#m~6nHJ| zgwY31Hu(?i207c5GWoX>8*+z=3$qUxL8+6;{4=Y)q7T6IeKHFU&-S zxUTj5wDU?beYqzg)Pe%op|#x&hqxxZ~a$9Q?VcQ zBig$MFSvAz0h@$AbKU$_yj7;$^4@#(m~B!S8?0rtTOs-zpVPtQ)9J(S{G|O#ChVxd zR(i}P@)xJzse|c5OAFY_?B$AKCMm)K6Z$KtlI}*sHsMg3DRM5|knV(I&<9ITf=!#S zkV88&G}cbNn<_(>$@{tD+fCy|F7>37grS|5WvMrTg9>L3vr!^RqUdFBoi^Iq?IUtV z<_3_R{%-C;$Q+jQ@*FaHS&x&cMUh<9>(}JfhUwjz%$!OZ^NxvK!Eu>>hkgL zzj1Ltz^gK!d zmsNO^J9}R=cEJ;`mR?q`&Q1~fPQ{Twdj1{KWPk6VI4UAb%<=)!S6b%H&@mlC>ZnQ^ zlyEcQW?S>4{GS=RB@Tv&Y#qMB%8yfL5z%v9O ze$oAEBEq-Kao!?@`Hn*08R<;{KHNk)GYqCS-A+KP5Jtmnb^^kze&2>&Cz5Y^s+}P= zbonMnxyPL5L)`(o!X-XFVh2rjis)0 zP$y|Z5q8XE*{J@5K=mc}vrMq?v-(C{xxxI{tatU#&E<&}uRg{uc>9vbW{dq^zO3_R zi$8mzVaeB|jOF_g4u>kYS!@VeLL$vM7gETO}+Xt|L)ovUg~@aWkyA zwAk>-1m})7S5uc+ciS$p<&#{77eW|W%Ak_c!BM&HT%v`&`;dzxE!txRczDhwGkz?r zuK$39w7jHci3{2U<&T&QkWPHS=cjtX?^>PIm5kiw;G6{Udsk^%%_{tE1ZSboj)(sc=sacQ?1 z#OVkH8dwd!&L7hg<6}T{zi2t~A&9+$ORWi7+pZi&w1fsClgw}4l~E-EF#Y+{#okt) zk)DI4S1hfAOfwd3F0M^xiVB-?4}<;r-q{=4Kgk!quLL3~n1@W$XRB>eCAH`3&y|l8 zxt6kQ&h^aS#Xbz3l(NDO_EKhwhiJrU#*s$LHn?Z?H}40{HWc1EVpbtPW>`1aX*4!?;ovvAKlDOZmA zM^{zEFB;?CG3aScANR~1okursmd1&PeNnTHN(%q@d3}{Qd$@4{*1r~>1T9>vrpGi+ zj5*E*O#8=VZZs%b%46jOx~sOLIC9%>b0Y&&J`BkcXwj{^%X88@mtre7}J=&3;7|;=5f4#rCEl?%6q#47^T+i=C$p?Egl!C&=>TIcDB{nlU+BV@F zv05c|(OBC;Y>fM4Iu_ouRN_td!74`HkGa`;yDkNMHRo3sTA&hMz|p&>OhKt_s{HC; z6=3SkS#$HZgZdA{2Uy3V8^^djmHC6*B$HbOOu=Yr}6~sKbPFwEk z)hxU(DEN;M>c0&-?bwLV?jHExhA+G*v-RNmkL)ny;da?v8B2%8l4F!md$pnn-C>(F zKXU?2`jj9vwI6VDJFd4t3}z8N+UUTrq5eZ!`=`=Y$=5Y!i8l57a!hR@o@R&gA-97hp*ki&|1Q*PittLn% zeJVv0HTPWCu3$P!(e7*eUh*E?b+CqVk2-lZB3N)me`z_lH_Q=mi8%dQ zP49NP5g}0fcXhB@M9oE5d)@@97vVjnyI*O;KN^zuzSVsS?D|?+Eoxs3Ax|O)MM5#M`jrRUK2Zw20PUef~k_vC}kQl#{{~<5_(=ljG zr?7Q=4E+n#gAd<}eoPt&UJ`X`B{DCG{;}iAjPsZd1*h=|IVKBOeX=xtr(Q|Z^4j9c z7Z_&bRqeN{bb)Y0HI3iqz@OXE9@}Iz8Z34K8G>!?18=#(0e}84Q&;mA`fufwgg+^# ztU~d>Gx@95s9w}+%V4RQ6-}yHRCZ9|e3S{H?v?eY7L| z8+fHONNX#zf^6g++8p`xEhl^~h2uBR7<~~(uW7?wWp!<%nk91Jwid|Cg0xjJxUj59 z6WcizgPugA*Yze8pgZ_UOIt?Ba!4qIA9|=(L0(!dm-BNmUtBcc|IA#G%@$oG@5+<} zEI2M61cN^`SL|=NbUbX(TWn_zi3mLfGfF;s*4%zw+J~~0Y%#0P_nzlkLOODC*>CB~VY+PUgdkEL%oiWpZeC-hv zR!!Rz8=9r43zbKp(FrVen84P}cLFOd?A>PczLH4 zO(1n_#kBBFJE-!b{Mp+8Zc#mK^ovQ>S|=P?1$>|vQN=%ZKK7*$dq+#K*e+jZ3%}Z! z+$E9s%v|B_YyBC~anKm$TW81GZU@KQ<(e;9*e_SdTb_2b2SRmuE~n6PAFgj3vV7x5v>-mK%j4AV3JB#HD+ zfyo2@D-#E?Od*ffoDgTAkvPv$!eD2FlrVjI4!9SCZ?L3W}ykeQ>z56dX z$dQex33{ZQwj~?qe|q_Ud?f)D4{$fQSau)MfayyLNQDdybFP5EAIGmZHD|sFP*C)W zqry?Ul}y=|bW@uOcxfKAuhE(W+A_pLPFUl?L>t!$ z<~~YW2&2mdQnU%$KH$lM^RD7H<|)H#m=BI2d~qn_wIZ5pSJyJr-{3SqilVT`lmJFT#3XR z|5Z(RVBtlc)aP2VS8sg~a1IT^4$clz_>?d72$9>iI!=M`he)JlzQdDM#>7G_JEMO> zytU-zRK1=Yh#*&)(7KkKB(JUH=jK-RNhps-kzEh;{VH66N*40ZqA#YQ$zy!11Zm7&g0Y|T{3P-fvkK8y0dQgaU;_*5AB7rB^K;l}43EaxCEkc5{FEc`wJXIf#23k;VW2x5 zEq;Pxn?Fp51OAd!_DV?1;f$U|tV7Yv=^Q`oWF6V}tJEc<#XY%0o+ffD{MX13E-(U? zNoG+BkL!_Xl9l`aT-zeifxBa2udB zi&$D+@LL<99a_0UrSXku*g5Z_Oae zmW+~VCmHyq+}S3?a1s2kW2DeHV0uwe$W(s%ejPX8YCk6!{IPYB{v+Q$@eQDJ)n}vW z{OZQ5c8C4C_LT>9(4PHYLzl@e`^H|?QOnISfCzplsn$>rZvWo z!)wR>bIg(6zT~F2PY&bVk=`0}*YqE2Sm-9Vdt*<~8(oyKZ6V%+10miY@X11B-!Mv~ zO<1pNOjADZ;L!uMFhvn}BYk@u;13hMinN{6W%_8ywSU>32d}YW zT1jOp|IQtW>Z|L)Hl6MWecI3r-4C(8+f=*!1@mUp_j^S^C@1}HiMdb2-xXglUkBK0 zAv9de51!epda*(9e^s)h@$6Vga}RVaX7BXk_t(*5=eai85z@AHrUx+b-wx>?N4-V@ zgZVlAaX=c7q?CuTADx?cmkw@HLSl@#X@krAmv_=RJR7Hg&P-K-`UNt(GPkq;RnLFr zRv~oDn7V@uBabpR>C@^=Lkq%@d_f4^%+>;Nu#()&n)u0A=>DZq$=gV()Do3K%e{E? z3Xm&Ed>ZjSd12~9Wo zrrd**rH!9gLy>K6;ji|mR*IQ|>Ww9y35@QxHAvKib<;agE+px2~XoG7Rl zD^M;>esNAxR4BRjcHgTU6~HRiuHa{p2%ocq&yB-v`tZR?XgWcl{zxp%zo7qaJ9e8> zHvr)A#VNYQ)Iv7{+)e(j@Ew8s0tPO;4J+sB_(WSJla|D*d@CF@bB)+Xg|Y-p<^k zTR97_p_B!g?iuT#od1O0x zsCoY6Z7!EIqX5(^5{QJ~sZ@}b9NDgC-yR5Vw~*> z-8P?gQmBAvg39!b*2l&mzM|5QL34Q1Y>*B4JwEabWE%|zjP-QBXg378gtOP@GW`Qi zhUP2#+V7U{?aBy97HN7o^ZvBJj$O%6XW!Sfm!-HcDc;Af3$IU`w1o9_hP7wmUDQoe z;O}y|f|G}DDyO|5bkBI-1;X}QfCd|uI^mZ+7thXO7FRIu`Wfv%5=IBb>me`L^fZu` z?;?ja_ET$Dz^dUJol?mmB_=dVl>^!tXsqD+HU~TTH zDdl7~)IRHZa+gmjC$=H{Sx>a`R^Mil^kGVIY)$k^YsPCyJ!Rrwl8+hk>0dkVAuoq` zXi6t9c=il`ZMGZf5E$TDhfdKdB(%#Pkh6JHEtTG#wx2)L6Pwy=54X_Gvfl~JSMB1r z$((nb!IMw_Iq|cQryT?L_%Iylx4#d$e}`U2k~vq-2=m>wdXO>1{WmK9 zVom;C;qHXMgqz2>RIa3(#!iX-OflGN85gRH?$yP@2l*xLf1u<4cudDHF!W*Cm{ml; zx*{x$Pln1jTS%*y&cg4PpnQthEScQ>#%KEaJM1-M70OKh`D7cw`5}I;$E==Ic$~l6 ztk3xys#Uo+?me6T9asu8{Wo@eVgt1k+{Zb)uDWS|V(X>y!LYqoa{GlMC}<2|^-GUM z4qSN)*0IMOZ|RL`KAus-Rr}v_OTIS3XHNk;|f=|+`{fy4`xitniXsXx;2d*|#u zRXy5Nk0#q%S2z0O_kG)Jj?%{~sL=Xvonuv*Rm!+dKDE9Zc5c6F@1jI!CG^IYttt3x z-+BIXQpffw7)RD-QO2g5Xr$@tcY^`eP&jG1A{Xm-0j1W!Pwv>wn+!hnvO*{t+qv#uy>9`6tPQ|8QMguYFd_;Dx;Yn2djztQ6{5aKTF@T zE!c7FzQs~K)3_xY#l04KW0quv?ijo~u04?LJ@-ys6loJ1Fkj)Kqhq$^g<4{D(9uBnWcB_~Db3xxg!JfR{^)c_b?Q0z+mRFg{zs&jJgN%gx zYv9W)%}GI2b=91L(Y@P;kC91{YSJ6P?H(RW??m4y%Y4vZjAkCEi$C?H!w#9 zpF5TKW;Zw)zNR3WV!U}#ASpt*YE30d1#oO(;$YskT@dYAT1_bVK6yeaWFgrEk6C3i zu(ojURKuzZ4j`LMyV4wVld~*mPHtK30n7A`s{xS&$V=-4fdw7;~So2Kllio^f3eruhUR~O$kgPFRFyH+w>wp%4! zQ3i(?YpKh?{AUDz-MR2F2zIEQ?;EQe(|TlBY@^{D;THT!ah9{=8z*H#9~s9Pk@H=n5C9SB<(C7OGiG(%48b3kjn973l)mgv=w z2C4x+5=?e#t|KawnxoTY8{4<2+-}IdgWZq4l7y*x4{OVDk0^hk8kun)7U?eQh!xzd z@_B2^rN>lgC&YGN@GPv5D=_WVZB(^5JvyLYI^>$=lMuueu6VH<&G_Q}>mIPp!2DVq z;K>S=nftt_lwQ-r$;~1IktE+JQLl>(PN%FTQ`GJxfvAQLNb-92wUST#-wA zYu}zpvYy0*utP>gBSPzQ%^Tk~wLw?ptS$GHbH_cdE)dnmtl^xz0xqS;2ua@;fKj#pMR#|yD&dumb>|kgzi@k%6*fEyNoAxkP?Pu_x_Jmd0H?>1ZWIC6k!n$6&c&2&|8R9yG>jb z5c^R{C5X>i-QLefa<4z_D~@*lBUF_r*K7JkBWFws?rq;}qoTB?#Ec)-J#j~P+h$9< zWJ92wD{MuY+?x?Ib^9p|W26mvT9Gu_v^Y2q1bg%Dc61KY50uHj#{r7!&Pbw#LiLqX z&^Fd_U|5|63l8N(TK`~)#qB+$pTj~#GQaiHmrC(=^AwHpA_$HyY)^)4xtTP#E~?Qc zM?6)>onW_#y--BQU2RLn@%a_RGg`;O1$5`x<8^mRyN%X{U2q zzU&KtCdQ+WsuU1$8#l8@`lxru9*s1BNSO@?uV$+*pRNz(7lev${>W~=nu>K2(t21V z@^xB{4%uE_z6={~sDBn*LW_&4M zaQaI7j81Y%6oc+?%)O}Fh>6=s=IRJZ9}8dB@ZPrr%{?<51y^VjQ<4m3SN(m}m_|w= zVDD5^5!AM_6*^`2V$uO3AYm5|55*5Wyk4U|cdrz?&f9S=`Po`f zYjYRByeuhjUBwVW6y^Ymg?{sm^S$AE(a;(0HfGX}b)#2DrQYZEfr2e^aCV z2gU2Z(WJOru*vXGOzC-ERqxJVb$K0y~sZ;TSGV7OCCN4}VJ z`Q9c!ETBJF6u~@riU!vjpuJb*!Z6VZq%gcak>$6BNvB0* zjOH4ThcWuT1Q><_6?Dj|_DFC@JpEBYyhdYBQX`-k6dhcPn<+;-&NX2B^fgw&)r(Q{YJE;K~C1A!zJ z6GmuoEQXpgKAzU9N>KEu_*Ok>g13XVLk}?@+2xUzu*0lTc2OkoNH@@{*@-$b}>M@yJ_ox6H|jy*lf zx`!l%q(?}*_r?JE{`$Xaee{1=S^jT)&i*F~HU1sh`u{ui|2KF3Lv;1;f))PXnElU= znL^7{t|okb9mV&qs9qgAB4J&&+^7Et z8BR+Dkr8VeHWInw`@1Vd`t&q5^kDahEIM}1%svao9zTDsxj0R-wGXf z9o<)BRhC2E@-Gi6#emWumH z$(U={YN+wuI+#1$zOofe@SU(N_2(_`98=oybw&t+qm7LBm61tpY+G(DMZ>tpULQAW z)6_d^aWYOXT{?26i}b{0H{8aT*pZ8Jxj!^V+w*Vrz}yT?aA2ynpHqUIF;CZyuB_#JZ?$mz$ zGnv1kxv!>le;dN^{De{VTx`sI$@_zJ4yV~qq2AI*xGAMm^qGmg@dDJ70)=G1`oXxF z$>c_qij1I^>DuW?o;)QHBSCXZc)cY+ZN**dH`OSaG9AF@8xLl+!b|+sUXi)5E-lpF z)3~1t7HzwgN-x?r-y3&ZXLPJ8Ul45SkbFjv)*ZK8H(D$qV#@p659KpXR-l)(Dn_d$ z6k4m{mbZN*Sdm-29$|-!pDV_c=Gb)2wS7Xe_Wmf-^FO&)+wluEc~B{XBfeV~JZI~5_HGCZ^mPMS z5ylGpz2_Hm7MJJYcKGs-BKt9gvViH10aWe^o2A zc$vYyAQEt&EeP5@W|uy|*e(Q|C1@osG%rnz@ZI}*8Sw1|z3ZyB%o;6r$N6_$6VS0zBRLt5zGiJn>bkon>{?Sia`K7T zGLG(a%JGNmp^hD;kBfgJC%|s$C})#}>aS6?yfOAYc%<4dW4=E~x3W2<2X;6?9LfBH zC^_PmUR%4ZSgXlbN+m=?#0w=vHd|#yt6ZXl6~rXMmkTgmYy~_q8a|Y8>m-$(;QR znA&V6 z3(QhvV7q{-n1m|8sU{+7ueQq0+6yZ(@l4q~X^-rL{n#Z^qU7cJ!OnXq@Uv>3=CTzV z7IkO5cYTfW4FaXqi*W=lYWJ<%{92;quaY|5HPfG3O{CO@JXs7fbaE#u^sWcHHMUc; z@b$v4uX#PM{b7Qgtkdw*X6E*X8aZBE%9zd}=soG&G>gafnLx)iD!}(g*itwxm-H8A zw3P{V>($Fa+*Nsf+;Fm+s+hjXe4weL;r1%q@dH=3hftrgFdVfzq#z+SG z{6I2;UbC|oh_aw9W%^H$@FAgFs%Xq2Ax>Hmw$P^6gR)*#SFXHj*G{lY7ppyre^qX_ z&mrkP7jJ@9T<2X|y223b$O`76CLS0~CFpIb_meBZYAv04J=Ig*D` zuix3k<)PT?cBVf2D)JDVOd*hsZk3B7p*{fCO7TYxjtznuQ)l zeW2Z+3!QI?$AA7W7Wl@$Z6`O!cCNl2)nEy1&gmu7RaseM=>nT}{8fTzQVY|kB zL!b*iW_+^@jepInSNnO;`oC2EI*OgYLw#? ztk9(l3BFPG-6ht%lB?D|z(Ud5mt`HSYbP0FH2)HO0xLJ;sl2n|*f_+GmRw_@e{L$1TyvMBE^t~^VkKv2z2d(VeZKZ; zf{Xf^@qOFhcKP3QM@*&WsnADvVa91NtF3)oszS|RFi9aJ8T!$=#jt_Dgf+4Zq?Z(~ z_Ap@LWIuWDUFVC}3<7y?2vgJ7f0)FyBUPwc!(A5Zd1tc5!pX+`X(xsE`qoRn&0H$| z6#~Wl5QF=1ITOQBg@hr6*ZX4|3i^BAR$s+#49$3}Zlq+OejDd^DsEhfeibY8O^&&m zIHb1Z^RhEMQ1!FJr9A)3`92bziqRF_1f>@Lj8B>(Uuo}pkxS<)vC*eMIDm=V8X0#h zsX+qK|5TsDr&p!oy7OsdYIzA%H~UTW1mV%U9TQuWz#=AFeE8v<9WdmBn6r)3c&~S3n;ywoJ75%b;%f9tp~w}H`o*SEzR9iO2l;}fJt~Y)8wMazU6?O! zRoy;!ICD5zBvNI9Zb*>)*y;E6AWUGev^ic|;4#q2!@-<}Kti=lPTJancFx_^YWJAq z^pMM$_&VSsHl&sh$vvOUQ14n z#KDpL+QEY$?aeF@cx*tNDvI;F6)@2*1VJM31qbS;G<^O5U3JGUyl`B571zkp7*80a zNA2)ud2cB}w8_hSjX9v5Sp1;Mf9k*}5YW}iWyHbvt;jk&I~VjNz9x@0WKh-=k2mM2 znE0mIdkq{ZbLsbEnCH_J#i)ZA$KnG%wfN>gIV4{rR+|i73RM^3ZIld+{WcJ*JQzvY zUxi7|rmjKbY$s@UiH;*zTt`)MV4lgkB`&V4f*9L5v7q8N^?}~KQ}UgwHLXAx%3hFQ z100K2_`5M}mabDOhJr9@)UqNrK7^rQnV9j?F!C5movP~ZVRfLawq*xKfICMjZ@Zfo zL2N(jxuHd?gNDkDpk~0B*(J|Av&rW(9uteLumu@X@*!cbDe3KB;Erx>*LO{^DuFDV z)9b3)RKJLqJ-@{AX*cJbGnjm*0>A{p^7aUDkzDf(W5=$3+qZoZJEb<<7-9+L5>54Q z4z)!6Bb&kPwSX5q_j9pT+b!p>UqqKd0Tl+^x5N8aonCFN>z98iYTJ%g<*e=-3Mq3zn@foWqpsP0r4K=1dZD z=^k~7OlBsVT-_6H9`c~N461j+aa}6M^|&8ImK=msbG<~9C#dBpiB!F45%;G_(F->Zx?>w!3 z89Wj6!YcYj?r;r@%{pf!x+iS)Zb{20#Xxt$)sAek4Cmo3>(Ezfp6Hm$MEMR*`cCzb zNOhj{CvkX|XHjF#0(FRUE}{Cu(lEOQKbMZMS|Du~d? zT4IFs{1zg}d*%f+>TsnI6A4PIajK50<*VRx5f+99AAlWK=fHeyc%IM@VR3p6MuLqu z0O&oD1?^M0!k6Ljgt%hM+F__Z#jA_^_P}uN@s_S*(~={62TgsO;ist6gI0gTcsnAK z8P!_jwwLiXsWwy8AyZAh+8!_*Y=zTNc}P(b3P|VE?l+#G^!k1=BAcqwu0SOL``c43 zXf>1I?%c3-w5+{T_&T>rglX9N(UxpM{|^zx*dZp)z#|4r+tZ~i3C;;x@0pi>>@SWa zWGy$3?=DvasXX2mW@FvUUVfwcq#KR~KUn|Vm{%{(20^3+J5dt^h$njdrl2%mdZU?S z!~hh65$K8Rp-uwz-n9Y=ja(i#>9s>iv4Y)IqKbt(%Ap~};vD<($l>%Pk5`7!dFg6X zPEb#~Vx@Cgk%F&YU z{8nM9j!x}u%KG2ccZu$eforxK$b1_)vfNy{6LA6-STM0iyENy(~@e>#p}-8&>2 z(sKzSghrAHAfJ@$Rj8s_YNt{~G9fXWrb|@z9u=Ob;LiHtTdPuBt9}CPL@7;hqhXAg zWKruSPw<*7s<1T$s9Mh&UrY>mnyEIf+#3>_&+6YWqt%p@H;%J)Q8(7IwF-M&2D7)T zHK!#!!~}7>kks4=0;{032CtzVOEsW*^bHljluKBgk#Ap zs6A1%2Vk)!F0C-5Jwmp7VBzo(5d)Ac0IR=U+#N97jvyrt9QLCI2P^o)`iGVzzGSsO zA5G$1NU`?uHhOTbrBT*;;1=hJ$H_l!sqEiVm*p!{%@H{mZ_~*Ir0C2wn{l@d3^FxC zMMf%2CDByd8FS6AaHI58qn>*k9^XifmtG0&M1;70Z4L$}1pW4f2@hbTEjQnLpmgMZ z^@p~FFV7zxTTp-g%ai6`A)LZow#6!(QI6=s$>f{2coS~QdM?rBn`p*XI}~{8tLw+L z>Z+5DzZ&gUigHD|q6@+Mw}pZ&u6o>Hk0N2`LriC11Kh&hV z>H`D@%`=8-WatL`kM_;HVx1_5CT(a5|KVikdmc^4I<6P$@jT~~lPOHC-et1YPno-w z9HpW|%y;X!p8s?G83UZMm-jhHdDj$^HQ;96t8igc>7C6|V1PD5=rFlL z(l}rlRiJNanR<;$fZ(j2TzF2pVSK}w6P@p_MdRYT?{gS7Yn zEl_l$6tz4Y;@1YbUYs6(tlCR!$+*rpbtpoa3lF@%Tw#M25WRsRQ82cdhhO~BK;Dxao`}^9> z%fv1hUEy6iHNuY&Zy4;`mUbGn4J@7MK#F@bzxDWh04ZQ9{N|L{kJW;<(!gs@hDRTq zKEGmKP@`7eba`DAt$ZDR--{0rkK&%-`tdFWM*>)hTV;{{WJV70SJ=h;A zCf0DWo0nhv)RU!UB$!Q6+DcTaHNrLLL(ygQvRYrfdYaR|!{v@p6vmdjGhcH!;+r3R zGTUm!)Plu3JxdhXt=Cy|iH4h7H(D>V0V5x|aGi49P>mzsRh*FpKY@eCPjuQHFK6AA zcKdXJJ5-F_4y>jQux**8qXN($wtwtv(CLmKTa)*D(~=Gn6GY9bXhu%V+|8z#uQq2G zvf!n6Smgxt+CumzSPa`y&;-N3X}VUQuMF8v_%3`^gjuY)ypc&=+4ovOzt;ndC8^QA z9mcr*WPo;L8v*Gxd9;cyfn`%V{Mz@u0JyjM=A%Jg-x}%*$okH53{aac$s;=&Z*t&U z+Kr5uw_Z@rVYlBuktR>2hDKt-e77T;GfYa`(gSUBmqS;EkFi-Vuv_IaO6O(gb}RSV z-#T2bnH2OUk7+}@zCDMv+u3Fz>Z)r-*bh#=U$eG3UG1(ls{iTN`<)kF$yS z8Jfhg+A68FTk&1c+0l+!W`Rd^=YXJfl7*>>MXq4!0Ua zR!;;R(_rDR%n6@`@Dcd+({6xleM5AXgC#wc2j@gG}l`ydno4W=)T)@nj-&+O0P zhXe-r7Jpgny0WBj!wI59T0Wl@Wx$s9iFO8)_trWSUZI4|UG+6N(vc+^I=z(;Ka0nfKbPddKLpUh3bj3mZo8iRBpTF>;(nmA);$%X|?C z_$EC~uKl*u*b4-d?sp*ipEtWmu6E{j0mOH!4H(cm$l&-HXv%7pySJBzGa4@VT_b+; z+!A#T=eUduP8B{)y1!e2HpFw$Z)V#0P_H7EI?oA}A5C3mcv7>k$&g%pfx4i}dT`X( zQmTTjfoPW;$Q#K)RR*sffvtj=}sEL+blvGMr8nTa$W;jlnIz`aY=; zvdOPgreK+iW1C@cM&GSw()O_R^dkCnlUS9itZMlE`P8q_iY_JW1yX!#x=gLE)pay z(zhGL%_l4D7Z|5Dac*|Pq26EVMJ}I7E6p_ntB%T6Pj$S^S&JGEzE?GB!9WqGCf_k6tVDM1l>>D zzSoxfisj<@%lJ(blr&iON#b^~am7tb!kqu$VvrB7XB8*EOb%z-+oY15IJ|5* za8Pqn342c^NE0hJ1`3d1P(1D+yYI|@ym1+Jc}a{Xy*?OwkC?qD9+20g_*MS1f)PJZ3&__rrA7q$yP^itPH}&V(^Jj!hY=Z$B?F zc+mTVFuJ|$gE6XI)bwer+PvkNC>!0}NfpW?@035uoGk7X1u3V4*R;+$49_vR?F^h& zmnOCH&rAcYYP)|0Y`phjd*8;FJA+h%pbc)X8M+{4GFChk_w*5hD< z9L%VyY^Ux02iDBxz^YXYL&mZ)u{RqR!M?I9SNpqPGIBg3$^(2RhnwMO4>^*rOps7t`Y2t z#}O^|E1IgEJtB+~wtgA~I$BFR_Z?(3=3NKAjuQ%!tK6Xy#{a zEvXjU$n!$JDMkNM+E9l?3DNK zt!m{n2|-WDNmxh8tB7~VEm36jWxUjy!xuaK(h;bb;+uw^UZp8RnyHfv(s?0cDoDf2 z56XB9V%K1E#37&~Zw{FeOLZD4s(kpQdacgl%fWE6GfC844JfP&cH@vTfKSVw88jYT zQ>n9`CQO_c=TVkfvkLL&*lHcv+T2mi6U^1ndD0-O1`;CE1bIHpXV~G4OM{_VaXttC zRMY(a#)H#;Dh2*C59^y!V7u2k{6SsLX~japPg(TJPp1K7{#Q*vp7z;Bl=R8)QcS)n zvr)CLdPxp>I>o3nzpi7-|9X6Qo7&8^Ysb-~)#;T|rXb8Rr=^l_FKX(*-=BP70y50Azo#Cr6py{mpYMpE$Ml?z7!}XHoSLi;7bh@TO`m|4*Mj6w}Tx@h!{gI(X(S-5x z_wGc!S?_yfM3IpErt=1Ca8W>Dp=wk3vUMP6)7v`HcP1Fm;;8S%C!l8D0yz-ISbt(D)bC@u)zC+TBe|ez3ua7g26#URGJdFXbz zA=n~a61%aF~_~+Uz4AXpAVb4AsfCg0=Q5+GZRJe!Rx7v*4~syaIUJ5k)p)= z%PM1!QYF>mSO83D5Z_LQQ(2M$YBqPz-O%AzeMHkx`9+*Cnqzu4kHaF;W6w?)H|QIl zO7E&yhu3ug^0ZO)`dk+ONgccrJ{!;vMFMr2E#}H6)eZ!_ot;+8L3K?=rlc zYc=1@QjG8%jJVJ{9Z{|bS}&Ni%Yu4cS7(}LGaRpphh}U53H{%iJ<`~bJeJJ;m5ZixbaD(=U zkXy+E8Hdlw;QgT{I-dNt8!7Y!4m$`!$ph9qbuw^w?}Q;HS`fZc$|2$7n}C8JQ+-P$ zT&~GhIsf`#5JU$k5^a44Sr2v)RWz6gD~`opr^VvKqwla5VB7F-N&bOM|E~+Iylp@> zY!e-M?A`$A0Km*<#gb%m(xKPO4({z zRfDFB<9XXWHn{&TKy-8;^(kz@G=N~j`?qJv0A>|t{iC%FTK z-kof@TZOBr(0R)X>eb5kLoILGC2z8_<6uO$7D}jvRoRAza@t7^04PGOovAtRkTO;Y z6YRS+|5x0*$E~YKnxIS}QBWco-bsH0BDDtBN)}~5_g?BusctHL-p6Fx!OhoEKA+$? zu)#(9b(O3-LZuqmrHWXXJvB136ULCLgqP78_tvpRYnu=buM5)?ltM?(=Aux@dbHb| z8$s(szjeo=U^Sv_e5O7^F*=O$3Hnm+mFILs06YeOIoi|fv9Gb-b9BC_BcWVZ^1f>G z6r~v)D@*RlMJ1gAXSZg&KxW8Xr%s>baIy|O9q^4~eYe%Ogl%m%V!o#G)^Ebx4+Tc& zW(qzf-Fu{Ika)c~m}&QzSsG+@aoPk;YO~y9wk*&;in18H1@momR4sP@W`cWZ1MC_} zj0Lbn`9FY~jnX8;b_%zWN82;!^BJ3CB|+9tfs-HLP@iTk7HJ6Nuyz&SOex zSU6t8A)ya=5@JaQ#=9=jkzb9r3iGGTu@Cx=-5y1b`dX{q^b0JX#FN;uMWfN=kKom; zWmXtn|859+JH3GzJVs}HIXktIqTXu*ZrfWGciZkS z`|&;VX?kX@yqI$H5LuVe7%99h`{tJAmFY)LD6f}Z7I}7aKgUNJl7i{k5JKAns#Q^o z(`6QNsAPZ76+u1#<;@0D2U+XRU#15`?Hi~B*BRei%)y_5>y4+CRYbVnxnCk1E_UR# zpgKV8Na6knDV z)bFKnx38n@?A?cw>bCTNGNRPq)ShyUwa$@W_~N@E3uXAT|QoSBNn z(U(i5Dp|iQUI{q`dc#gkD?6${d!7KS7XmPz8*t9izOu8Kw5Fg2oos56s}gUPg?@K> zsF3CHik*0ydqC?~r8hIJlvr99JKgHXu|petZJrOMA4$(0WsjpCr8_RCX7cCow^0Ta z)CofDbY(}^UNk2g?exD>=uTz3)c=Y~Zqg#O3YHzU-KjlQq))iwX~Q*k2zs{awsYv0 zqZ^^$((M1Tcxmxc2p3xGKg!^xJ9ecm=(2a|BSD9~`dh9Ip;S2Fg|H+~ulL>5vE3n6 zFjjn8?y;r*Cbklbk11k&*eU8j1|eKc&bh-p5wT%lD(h|&vUo?%L^?{xdV3>o41jY_ zNftFlxh^4&RysKDA5gKQG+He>wO^hDy~zw&C_fL0D`Eu0+T>Cx=MpzpNqV#k{c~|r znm9T0aI8G4cWAvOrSOt0;%JvBf)f0e zIC)l^QRZ6#O&CqScCa64eK&9>^nU|H`8&PiPl8JA-NwodvoXP%aBShp&nEidO)yEROn-#m3b_!B{Zw^4yY7(pztvgjej1ZXjVm-iN9D_qbk8syeh zhW?+r%P1+CjWMzyE9P3m!5F}Ta6`*)vNDhV8SH?T6ObXv;}E?h#L*cF56E&~6O@EE zkV8n6#FlTJi;UsJ3NzOzRBohm?HYH`YWr4N@7uXCK>Aa@vGQKX_9XiQ3O0CLXrL0OK z@}9CCTxAlVvY%%du88ix0&vbGVs4J+?Ra5>q6niElm5=N_K?e~M#gw>X@a}VYQM*c zociWdy&1a>4|{(1FP4m!)|kLWP@Z*2D~AWthQWm9YCzGTG}%EaGT7LHN?MgOM#fT{^MI4M4u-bM$zhiZ?{^+of1E4*2Z~3o! zSF{+ja~ZKuvHj`vHk`%ofMKr=peLMP3w${`z?$0etbNp1Qv$2G>!j`Tue(!XlioSf z3ESG;U;du1vSyjxjmDLQxV9!&YY@*E7T(pd(K1$OKO1B|42Mgh@X{XfvIO{y;VhxT zI?h^pVm&JOz}ZSpoR2-lpxL>6L4X~p8x_NzRrr5(!GmjWH6^DhbghuEMQE<{p**Vg z*oTyyXaKT#HxgRB_BBNK&Md72d%RP)6jqDvZc$>ut`J-ZXnz+0Tg8_e+Z+GX#>v2} zsO?X|SI9qgv{lAf&4JS8 zO2IA8y5U%br8k9r{DE4@jo|q8UQ4EBJ{j_!%U_opBLG@;N}Av0#uVvH)zW5MwQMTU zTW7p3au5v|Kd1k46n!RUoF}-!@|qt`Dx+}e|TFU3(^9l9lm@B-X81w z%#;!DM16NHurw9;Zf)Vc=qufTRv}$Z2sb+_r55nSP$|_(gwJ8hsTYG#SiCc_#VT*c zB=Tk}64wc*K~!&$pI$9|fcX=Y_is<9Ds;9Y*tu87qc^R{T-3kMbGUM&@?Sh7vNq_W zWFUwkHqSeC+pX)Qg&}wAB`gmKet0ll@iqX7Z|huK4?Oe&uN!5)l;QO}?L_vKwqA#b zHwHL&K7KyAu~a>!AD>=APRziiIX#K%-IFUd4bs@3T{@F7nr+TnBPvFZJC9Oy`|?Xc zjp1hd-X#4Z~T(CgJ+uafNO3lMYl4EprG zKwQ=@J_uNdg*TliK6Pwuvsu#EGq84QdM;L4$xZXpzYD!N^Bdhc^z(K^(L3N^2Xu07b}{b(*OFgK9AqSHPSaL6#Z8WH%_+m4VdocU;8?QUGn_OORkEh<%> zH{3N9;?PPA2tvrbxH0okJd8i=Yf>ROaP35+y-m#p-LwI2MC?j}X%sl=^VofBq=NpO zx6X83P*e}8UcbYfCtk59P5YS)>~Vg0x1h!otnp1NRe#^5%&pbRgBkqiY(Y58EF5Ug zH5MjjZ5+5!G7>p|Oi9#~c=OYUpMx;%m`&x5pYZC})lDT*SkJNP>*L@Cn}MC*N-ck} z$yNYOix+_^ulhKMcs$cjhybtLwDjLm^#>?5BtRVdqr!{BF59Oz2zIQQ^Ni~x``^jz zybiEed)OFPGLXyIT%_k`q<|9^vzGWz4ySSHJvOYYmM2)6lw>zPdqIJEJSn)>vZGwc zm!ffc9d1F>wTehJ>I^sG&e=&TW)jx9_h_2c{C+i#VWQKKG@|dJvC^OcLlymMA`5bz*Rjs_xCrre?c6(oYelUFS;qAS@X0GOr#v^(%YA@^S4pk0!MS3ldxG zQ+@M4P!$9D(X}oj!`ZKUUplKZrM3-qk>+&vd?jzg#O4()yL)3zc5@L#?K5o<2sTzYXa(9tpG_0nrM9WyaODj_EL5a-uxa{-BW7 zEH2|e@doS>u9j6I=gL5sIH6&vI?waYg`KZKn)ls}Rn9a!i*O0(w;rtw#4Po_xuMGE zkaWss_bc~+ce4w0<@D7v34mCBy&>hBTvnE8M*;BUqm-p8o{rc;!_Iu-%5Kehs}d1q zpl{>6HuGv#c9KZit8Ukf>g4M-awUkWD|wt;ddCDw*C^N2m&B~qMQq8;U?o@k5sMt(63ELc2Mu>oz5;Dk7OTHNekc{zXCJwWeraR>j zy?~MR&3k^gxmZw9)%bGl^4(Vjz&%n5228VHjX#F+XHNwNVrM{3Ux5l5GQBM~mFrD3 zD%1Vfhn6=xY%CFtb-U(Ck=}Y&CW{t;KeM1@Kie>fWlK$YQVvFz1B)}v zXxma9yx1UljFd+QuyCTlGxxnq8z)5S9$8EQS{cnr{$LnRjL_kuU% zXOK4@-W4D8c-JCodRb)`u2uXXxBczo?w}_>3c-O&@bl>vz{~LWTHV>ho#lMND$P*C zX0>|tr+q>uqA#n>j9RzJbHz z&>FcB4=+aXJn~I)uHJ1yVfawS_kwA53cG&n8l|f$ciwv6;Zc?vKiMzPq3L0EPd26I zU6wWVlWEv3Hunx{7pjWMDT38sO^>%raFd6aCCP_It%;oUSdp|85LdI*&r2dcyU~6m z@%g#NI~IM1$19qM-Hptj9Lywx@hkN;y+}>p7^=MFia_efJd{(WHS2lC#$ztkyl`N= zxBWUa%;X|FN@pN|6a9m^Z6H?~gKVLqpo^jVH(NTTMm~b6XgIwi^wMho{pdY}lgX zw5|R77vUDy^o`&~1`sb<-%nUA1~stpsi`knmV*>rTRI63cHEhqwOf;eBn+roV%OXR z`Y4UD*7cIoq_~rK(EInwd##L>eWk?&J0o%fBu{I~{Ec$+R!6dV7BvTlvB;- zGVhLi&S_oSipSsC%n)SE4TGC2wu5tkh|W@^zJ{pXt>30bn7odWnN{=<9ak<->Ssm& zW$w}4)(>ZSkljZyTKr%jrxEorVlFKuKdr-k%KM`$XG|yK^vqmY31^ZH(Dp)K=~_~+ zO<^=RuE27JG#;Re%@~b-7m+zp;x3W##>aZ~(VL~g^y{v9$^OOOZ+_wH zWiw0D+LCT-l3U|r{96|P|J4NW$r)AOQIInnTqznqoBH8SsT0MfnTwH+wnv+Mwku_{ zP*;xsVZzLQ&1)6>Zy(WKRL2t7<7+kMuKLSc5n%X@_C#DJ{+HjjN#U#vuFRVMdV@Wt`) zC6W)Z`>KbPuEk{XtR3d$gzE%|CE~v#ze%d933ud-Ol5mgrdu}OqRZ|{@@Vm67=e0` zI_9tTyI`VwJQlZvR4V@dgVduQE6-d0VLVpgZ$Hr13asOa?SJZ#l{Iuz>|c6hjkI2I zh@oGmiqfL)s@61{iQ2k+PQOq?)xNq)-He!?9RRm}vfDz0GAbFD>mALVWOz!CuLYvII+&O6`)81Anxq7F7Eq{e2d z=I4Rt%3XI%UiUAB><)qCxFy@)C)kne;kfZ_%9MPd3KXw7b;<$Bc;hRQrltBtl^Q+~ zxK`B3@1M_k7mItb9If!Cy5AetA8GWq8)UQ|4F&eXwqU9cGgeQT|I#4e>g(Wo@xICB9u)HyKU$rp(5#A^| zbYtjmTxV-FP*1)9M2(pNVbh(pr43)68-!-m%S^C%y1O7oQoY$j&$L&Ls*M6PwlAtR zxA_h2_1q#hHH$2P`$_Qa%h_8&XJZtvAhDkT!PMPQR8R#-vFQ?X@y6D|g?eOv9DAxM zb5U~dnVN6V#FgDU!Lz>21FQ@|L9kmtPf2rsY&An1KZgF8-P;i0nBlQmSRRYb;7+a6 z$xv~e?~u90SMd%cV}JWQ94K6T_tQlN#NXj?prvy9NK!nYqiJjEmrwkNuR;q6Yo) ztpv;JEFEHU12LJ-G-AX>#iOi~AEvB>^)edIQ1`{2tc@W8V=jnp z4Tc;j6rn59oya{rJ>yaA*%Hcl6sNCB%OHIZwHtCf{GcHdTdvICj+V|Hh3L#%L^nde9-L zKt%MxC$yUZESecfk5m;UDK5kJ!w&`kbT-`CGm|dS5+Fb~H$F(+8Jij_pWW|EntF4N zz^4Rimz-BsMN8Bs_Ug=d*st-`%J3d_;Q!$Du;VuG(Okh_)%MrvTdsoNInj3fXPL5` zZx6mA*gR=j&Iu&Q>mBRX2i8=I_VP(|#J8>4?Z@qR?uyPM$}-3%mDomJyMBM({9$>+ zjuc*3$Kqt=QFX?}N5;fQ%M@vF48Q(FG1oBS8MZ$c`+{BFgaQynW^m>Z{=^C|Nx3%W zbMMwnLT3Xe>UJp}rn#%rqq?mHQejKwzTMdSEi^jd7eKcAZ#IM`PDcS`L++YqeBWnR zk?cRP)}-N?$JX`7nccTOT6rFj%#Cdx!aT@7Z_aS+DA-ya-WO$4uv5biQh;Z+X`A%k zG2e57?^$%b&V@$&9WRZ2)3x=H>Jx2`u5%uD{rfmnYl>oPbsI0WW)XT~=5jDa#c7h3 z9)SK#g%XuSu>zCLfCkS<*=J5ZTMq@AZ*+7M18a|Cd8wxZ-=j7LG~U0&MH9@`X9I{`n1)Pqs| z_RVolM{0G)CiCdJRL3@b6G13-~wcz%CJ3sJw_uj)>*(i^$lk|z*Afq z&@sgC?(+=9JnkBYv)y1vR{wHm8XHmW?)s|KtX6bM z?BoR1$_`seqN>_S?TPM0l)Z+yp7ifI+G8|9>tjA$KMDqY^?VK)F&iir_GVt}TQJ&O z6|XOGE3sa4XKwwvR8>TRUEWrS_-8>H9m8v^u?COW3;}~;f_7umFqWr5#Zgg-uS0d(w*|~!=#Iu zdTmx2D&XW|~$(j>^{#zD^MbL9|kGrqUjHJ6ET?J7odrhJhTisr(<6dp5iXvDg) zimBf_0b5Egs%!)k;AR4y80;>@@blf#a8$>5t5P~wsbNUyH@I`OOk|jhFA$R^hpj-1 zc}brqhjMu#6-V8TyTH-p;5uxJngU4`+x>D~nzVj7$a|6UE~Db{w&l5XWy{3egWC4p zN(j9|YYic_5E&WMq&=ghl3bVQ_h@qbqeUUcm1>#`d0nWqM;v!@HO{EhX9dgT$1|?2 zmN#2n2oKUo2m|XveMJc<0O5>{8$F1W0fGa0>8xww0A zq=ahcI_7mvt2nB(NtUuz6W@@LljkV%VEgm?pkmat!4aht3Z&W%ICRe69_A<;v*F7MV)5%{=XIzKpkaEnL zr3ut|nqW9ZYDz^na<-K}(EVcnpOH+)TE3(!H0CJV;XJ^?Oa~4AP(z6y)z$5t{gS~O zR%OpKWSdd0uWx?OK^A-d(MrP?1^k_q$94w8W*EHLCUuIpS38PiikH?4*i;gJ*4=n1 z6*x=)Mk~`A$B1!GBHtV|A#>D#yndc(r+g0n+WQDsV#Sj@TJ@AvM?3hLo2WNARNs9E z2LVYuvr3lPfs!*%%=cyNEKH<7ot^PqMC@9blD6cV!DzWhXL zWAV=1W(`~z?`vHdZ;hbZX|t7-g3x0C?t|_DXC-RS})D`5fanED#)YP5wmWHkc zdMw_101d$J*ooC;wbN&#x%)5OYK&_pe2P+h z+skdk8=ju3zPxlg<@&2RobE``0qfc-B{m7@f6v1C)v?a85p*gmy5yQaVIQ&H3hj?Q z0a&uyS{F&XLWY&HX3&$bo_s3iBwwqfe@EF>aWVgfvithREpL{4{79>i?d)7f-OIHD zqckUD8+x9*TGO?)Kw@?KQ#QHzS)P|~J~Y=>JOh|6=!oz=OHX@bAwFo)duMQ*EJ!E} zF$>P;bP`UNz9-!9wyE?>FrSlfVQ_BJYSJ-COk#ha>~t->B3uk8b*{h0#EoZ3y{*er zcO21v<-bDgTA6=9>{j+1Q%ptL$NXKN)mZ;zuMk6goUUN0CA1pX|LB?*YN2P0zKC*Y z&Rh2#2~<+P|K~k6V=vCe?58?o|D{HD0Pv**&&j&U`qidNJdA*otE^VF+84 zx3fhjr2q-pCgxgUJ^@y!2C2Ia#*g8x^UwD+$x}yfz+6!GU-8R_Y71Vy6zG z&eQ{q{qFL^l{p!h!qDrcv`qWMLG|HcoQmt+0Y9W&zn~$u}y$5;eB@NgoAzgPY$G7@|Q5cW{H?^o0I1030@_IVU zqU}|TBI_D5;|+2?uaB$+>wTMt?j^WCx4xFUHV)!)gfMphPTp~)HnBA&cNu1Y!l3ny z3!FmgHW(vsfg;zKc*#ItVBrv?I7B5FPfGzGG&mbuH;&E`=D(uC-#VD)N);~bUe_W7 zdOo&B7Gdv&GdgnawJM?%%2YG3`W};%^PN3c09bo?7`v)w;l>-*wOU z%qb&E(jpjBhY5~f`*X^91HkE%)0nSCN5Jds!Qp{e6`;yzi8HL;7X<~x4;%{*XVYT) zk8FQZRx4ptR}$Cd;xfQqL^bIzIZDRcsw$RWzSz?(Q~>-Rb<)t?{F6#2AFYm_d_=gZ zxN>9z0?Ow!p?@sU`B}gIvpZ5wN!FZ%yUi+%88n4sUdbpGHO?KMzHjN!G8%95aqInm z3z+>Zxc~AD4>Wmze9@?Ye{*XHDpuY2Mr?Ru4Wexg1oOWc%BMYuFN;5gi&U zrr;(x)EW=YU@@v^1i$`vRQ1b`Tmioy`fnf0bp>@1(AVqT9DgO6U-vC(Yu^&SoOcJ{ z3hci_3c=JT9m<-%f(XgPI$FI>6>Z}6P;SHj9=(6`pO*Pwwq$o%^+v!`!1waKI!$Ol zq2jpytW6)UI_=wf!37DhkDlN^syQD+MxLFHIp{KRQ3*7iAFIZNrSy;&-)c-s zMyBsuIgLQ(Pyhdm7(%#=J1>Q|{^KHpA04heT`O(+;-H)B>u=#-xyoJPF8hb}e*AtBiX;HU zfjD398GI|K^HD$<S@9{z?hHC zkLMZI?>m&L;QhW(s`oaQhlqsi_})pgoW|#Y5lp?BMC&M+^psPCfbLSB`W~mk=8Tcw z*=&F6^vnOTz5bWB^^aryFWX^f-V$$7P&3^T&w8V9!+#2vSA6@2?=Q>GL;0pYx&C#= z{-czQdxG1?o~r+KPxx2cSt?K5w58g?HP>4O)5qCr@XiT!pOhL+j6Ti99^1Or=nbi# zyVG?+We)}HvsxD}M)U{0^P0eROu25pK`D5HFU72nYx%Rvm!8hd54mh*=+BooV|(og zxP`{13{P%Ko9c+pz6=$N2-d6L;}=hpt5{JNK-di78mt>p!;M&-AWVBYt$UFYpT>vm zq<`iUMazXsQ7j(LJpECQaG#~foNuZe1$qZ;=n?i#BXsyLQvM@tpeWhRr=4x1Sk*+F zD|v4l;$Jw zr@@A6Nbou61}3@Ps3q##Ue~9L$;`C{ihipi7zeIh4AC-&^EkNAgsr@7w)n%;@$a?& zPrLHx0%o*5^{l@jD~h73a4C5<2-x-7t?L$K{F+L@_j2R>n>W)x`2XW@{jo9jvBQ`~ zAAYl^IZaH44Bb;zAy?V-(Z;%Kz?-QxdSV%#>!1_Cf~`}@b)RO^mBzOebL!>s?;3%f zQ{7}dz83l}B<7tT|E6-kF3drYE&+It9}}S8N!fXI)3yA`qtzvT_Ivdd-N5u7!*D22 zKmA!bCU>UuGWQA?Tr9m>!*3o^eyE;&BN-WPK0xdKZZgzErdKRjOQ=_*II`WV`g5Fe{M2^c`ByMrg}6wxHgzD zP`RI3`NfJX=Yy3~-VBnf@XirXm>quhEr3DN(1x&4relX&iHy!m@`|ct`fw%^+)bk; z6Dst|Z&IhD_10yB(_dvR6i??dm9cS8w`hs^qLH0msy9MOb+>*5pY5=FjC?p!^x=Mr ze&JsK8*^dN!UK??D_3^Z%9ELq(q>I#t&~x$GpBF{CBut~0uX14xNtL&;>X}V$a?=O zq~yM1KBu%q2649H;q@g0we(&wco z>iVs5^(cA4ylC6hYKHsukGeyxIsE9|Ns%=nFW;>w`r*B|H3#Yw^uzAZ33}Cz3(5NF zqt_K-6-hO~f2_fY)R$+(j?9P|iazhX1K||0mDFrYc}P3$cSj9a^@76~kp9l!>f$+n zhw+U&-zl*L=2xF1KwIE5UgUVy1!3 zzbe&y^j^EoM18RPU>CWS$+cD#XawsjqVrpgl)`i;>z$4mzt0&=60>LwYKZg0<@`az z%-0^TPjyKjHS5%3z|!$#ZzX6?FnxwxKeiWPhuvBzS5f2H!(wNJytaaaU|7t|q`!qN zSO?MDftSaY$#$;yF-?htyePv%sz$_XtJtY{y9Zs(G;AMaVY1q^DkKuwC=+u?Wvk#u zV#oScbXp;zv&f`f$W$P!6Tn!$*{_X}p(_q0UTs~e>j1T{Y%y`dDp5z*%6h+=271!U zEkHZsuq|=RS<#KS#Qg;+V82ebb*R4iBcN%jzDn>H+&URYA4>a#%a!W624M#tIV|&x zPtngu+@t00NM!{UyUV)fC7YaFJ&oOL>A82svc~#`vMzfPEuXO_DT$A_?qSCbmX}yH z%CG}5qVlKgd*NTC?JK9Uc$*MUmb2LLzZnK_tI_xE^=QVWjexvqh>eNsB>b^umkUzHmzFV*R-p|%f zv5^eKuC-^aN9D^RlH_;|^ktyl=`gG|@l&N_Hs*#AQekBxUTit&as$4lR&OVnV_*l> z8w4P!=26y`4yvL@v)91y_4X*FLj}v7&o>CQ)cleO4_t)1gm13?n_C_7s|AQcO#O@I zkJTfYf&|BrGaaSxT~f#0d$6mg(Q>fB~jZypg*xFCZ0+ORS8VuK>< zbvmx2{e5(MMmp~yG~`5nq|>AipNB2~VhQjC{o;P@=vi^?#qbQ|yKhped;>7RM z;KQ>0*|wT<9A30Nfz|3oYH*9;oJE9-NFJ{xR(rI;Nsw^dF2z_4y_vjm+T6VI_l<7* zHJ_{0?5|`Hz`sO;|7$v4@)DrGj9jpOUGoAv)D(&7`w<>alo_HnJ*^G00B!5aR`J=B zXqZc{{h+c{Z6{AD`~YE-Bu6j(L6ZEAlx#TUdvukvEr=axed2U^1{+b4vzE1%HLcy4 z=qE$Anm|=STxgH{1B@DJ(q0K-vej+FS*||OrPdS1UcDA#BUW0lvJ-j?($T=vRFoy% z>ZSG!(sKneAO%I#=EBV-p`Ine6rSpBwd90m%HR;~yczvKO?yVjX~lOxm*P;d&AgM) zEZX^=hBBcOPHPj;HY<>;l2E|QT;vXVyZ%>g>&lRo4Nh&im#)vK8pAy8PZw zI#F=6Zo&6TV)Oa=p-~kJddf>}>srqh*Lf)@Q;E)D-KaM%Nr$5rRmUCGlotA=< z5xGdDI{F+FxXl=#sH3@r(POT+ zbM&oU0~q`<^H)eR#7e}%8i|kO%H-4VGFSc7dc}%&*E2Ho-dW} z%B_XMfx}q1e-=keecXsHO--)dELF@X8KTLX=a8<`K4e3W=hELUtsU$iWKyQ{2h{zQ zjpa0)*rWa+J2{@A5fbP8jdPgmg3n)vKN#-X0g}ai&uf9doFKYx>nZ^|cHW@ zKVg!r&=cLm%L;zHJu|7t1t_L zz3)BlWmds_RMiUbi4(74xF_z?P|}-fL3(-wrc*Jl=j!8~;||ZB7*!bUI2)m^lwdTD zKpw+pjI~x^#?>Yh!7|SVvmPwi2@}E#DYD^cpckvCi{-ak{C>I3JUv~w3H*3VLiOS4 zw=eqxGlN?&bL~*ISQn`rvnt8>f!0veaD)ZpT^!xp9$4-xAK1?MIg7$HuGO>T$|(q% z#4m*>-T&gW2Ytm|?Wh@!E`5$NkhT`aNK6pYxfCvnJBp0C_BFzHR79gCJJv08A&C7_ z_1;=nnPrv^$!b;ogHEwqna_!RBOsaqT|WyUcWaxyuz(PPGnZL!>eM$Yt-hE|G)n$|yE zug6yD>R_r6^~++9x)VbO20aStIc~$#5+fxq?YLNuAepV zj9gvhaqqv$xn?hQJwZZHrMY%HI_*10kk89=GEHp7(l+)2TgdR8|)3OVDKWr47%h}}MK>#OH>Y4;en*Y(%kDEe25QAqzm@?aEV z?^o8|FMu6!(AShEJWg4%!oE*2JfdPOwQiKIDB`RAu%4xRFX`CHN@N5*CL_V-U@F0; zd9Xaj=T7f)n+YL+R!7 z&3ScvipZ9|mT0-%Rs@aZPf_Ey+A1ZuVw$v@ouXGNW^h5lUBOu9UKS9xTWroPqH;kl zdhs0(h9R#q8fi<-8V0XOC*ku}Q^-{Y?R6*`M2@T(+DglttITw~P8z~Tov>Fc z6AG3HRR;c2a|!v*xJ!a(>w%duZ@0ukd=XhxKtZuANHAnmODUs!__OAwNFZ3crf%Zt z53`d`8lSwiE%}gH{V3%=rt0!nRMll?&p37gRkhvhUl-3fcC6I5|DMGtHIX%0fS7ei zbg<6RPU8I5#-8@(-bDl)`^Q4nNO$Xk&8mCVNI|WEXDd+-)0Lze7}nJC?XPU$#FMHm zc2Qd{L>wkRU0((8J)@k+KeBUKogzp@*CaKGjv6)yj&0xzdprs!K+rFa_fv6`PB zo4|LVtpuemU>&w*oTRuXDqV=h3Bo!p9oZq>nlq#8wF0zBUEeJuWAt*7mUa1joYjE2 z>}}6x$^O<0Sb-7=Wohs&QnE0a zZj8HSP1Pen&hRzij7xXihOvUX z<+?9TYd$X9b@kmwuPQterXEXuE&7!wQ~X^$YKlqNIwm?{;MfuX z^e02(^Nyxt@@fVzTC0Ps+RBV>WljpI2_<^BN zIyo6oFE(-D3$NNdp5@c8tJx+t(?*->FLq7*JBN!hW!52 zW!~PJ3;rh}DpFt%7W^$ebdT~f?qVJ5oTM+zNRudmNA##0)Rnh`(II>4d)KCJV)jq| z>}9w?lEtR`eq_;SN%Qst8a!wEbOqwL#5Ql^#sQY1P#g=h@NB%8siDiL8mX8MoJ1Wo zt_Rk9YC9_1iC-J$`z+)#_1^*J1qe z=-Yy|!wRQ4WAd$RwIWEA>G-Tg-oE^y0XxCl-R6cw)-`oYx%|D45#XxS&nZn|bE&R! zYQ8ee$t`PeQe?uvy%XZn zK9C*>zvyBd|7R-NfhPf!9lrJ7XLx^K5^lzT4`|X4qR&7FIBDMA76-s1H`;hM4y}Z* zGraxzCd>DRnG9salM5BoiP_Y%dZ>3`enV| z4-xc43_LU8Q5XD++_~9!ZadbQqRlYVpyFl3M7Q|sfOEC6_-uB`;dKhXS9;4u9vw3#Fo3% z$+2q$uy_Fy;d2_BMnx78pEZozJxQq&A}Izis%6Vgh`>jGYCu(lZ1gp784u|98@=Bh zj1Uf{yIrG>=q5?SKjwbiQlM+iiF<9G0mIwEGM(+Sv+jFOl(xkAUojdAc#RnwaNOFs z%CqFhrf`f8go&yT7F%Nd^n)+IG>AD7$JI$4UCc$_F!CbX7{kP<3No8RuhFER$-^h| zl;;$^Qk#ypeN}$pFlF*Ge^xCZ)c=`<#6J1lni$L|!ZUqORXjsP{2nyen#Mf&$KPUX zC?WTWh|*Z&tV}tX_A5Rbh(~zWwwUforSk|%>&8XJJB}1Bftr#qm#(+r2c>hmz{HhB zii$#Gm%Q0>ik5WSZthsx(*2jHR<9L%3(QK1u4`+`yAeB|i1iQ1>vM#=c&(luwymAv zw%d2~XlSUl%yvRdYIN@^Azq%p-tIZFv)$%{Xj=bJ;gsZVXK zD&^fKE~w%LEf`b7^eNljZ*j4il?4;bDZgh}*(?pfdvQdj#Jv)y^xybAe2>#^Yo@^l z`W0n^9C$>? z@}Flh6;XNOD%(h_lY&7v9O)mr7AMwJi=NCXDx(yNha3fd-9UtGKHCU4{t8u^eM9g7 zXOB+2xF!pLo7Z8QalVryR#sv!0C`4o=pt)@m=fjcN9!6OP+*w!RNgOh?+g_(BHkp8 z)(N%V#P@!#2gu%vlv?Jt?{0?)?}jIf;m;TsLHc7wXKn|mc>_fNk6OM@+(AqriVwU43FEv zL1lnTaXil8FU>%_)XO^2XM#ZuT^WCERc-q1SA($D#CAIm@GK0E~F@?s#oPHkN}xd?Rg7n%8~V<<7Bjq_DNhe1ik&Tl67yT<`0V9 zJ1qs-mhy%7sI&Oqbnrd*#m01JVbMptF2%>s0VPP{Sr5h5fv-SE$&)YsR|wqinZ?Qi5_`0YRs z;ejUKSxT7X#s1!LYndAD^Bb5if3V?;@S|VE`rLodW)8Ewa2L+Jy!K*l=j?UQ*KT08 z;vv64%V?E1Y|!rxO0T>|*Pi zFjI!!s$|}@q2}r`Q&0T+1i}xyA3OkYSU3vNSZ2$)m06OIrZfWQ>Nh#&y1oops6RX| zSHu0UQrCZIUa%EA?zQ)pW&e)@fj^><*hY(T8*~Kh*@WcTej(Z( zC8fm}S+RKj|0{l}>0|f2tAAS068A^-iEq7=M@l?D{oBhhi@i9A{-ea&l9F%{E4=y+ z(RS?f$(cu+#LrG3h>Z7k2b9Q_=R9hRqJ*sGmB4yZ?;uv=7Pew`T!V6N)1P%WZYhF? zH-{|6hrd#s(2g?(7|Dd=nvoaIRRjkAhttYH4G$O8)(({UXQqTK_j_m5Oh-ofJOOWu z?ZAM{<_VPsAK|gs6E4jnuUa}mX1w{bKYg!cf1cVOCo<7rnf0MzRWf!(G7pg$HV9x6 zw6PJflD(U$A?rR<+lXGO3sU*-X)}Lj!Bl#g)6$RUmq|HJUmY!drbu{z@;dWxFD5kb z^ws(Ef7b24*QoEs0ygYDtj#{qampS9H;# z@pRCe$o;#W`m1G5oX=eBNe0(K-mvD!@UNULery`6!TDCs7prIZE3x*fDh0>;^PB%R zTPVd9>Rh>kN790H$9}9y=}Isb){keM5TA@$NdjJHbghWz!e0Zg?@4a`%Dd&En^iVD zGdmMTC*a`+ti4SpqJRtvW1WiBKAq7PjtEO^c}_zgG&iwBeZ{=2%_a?$#x4~dzGeF9 zedyOh8I9JhkO#+n1XiCs$~UvmgO~z_r@DcP1}}t1NX(tFkF?{e7Ho@7-$%q5$$X7F zM|NnBNX~;ZZMohpiQ43*Q;gj@laTUpmHrukW#{rpM{TC;LM4FaK{(}8nPo!8`y!E$ z;MHDQ7YiyT)uv5!ck3Vc{aTN8OYSJDYt%e`6>~mJ3$P!US@5V`K`0=I3{+WJPOD$t zBKat_RwC|FBl28%pSfJ+DgB@p7klUKl>BK-C45aW%F`{o?@FzV?7Uy|;KiN1ZLhoB zu2x^V23wP40+Iz7nwa}z4^PoF&_gL9(s38zH7*OtzQvpU>cZqJfX?oj$L8wxgWUFw z(~88ah{UbJ@*;;Kv&+xvy^R=R%xz`5@79$~Cecb=H8%7?fECdl0baV#zdLOXuBmPr zpZtSf>fz>deiuZaxbFk>S-$mauz1e?%sJu{yni5x2Jk;SF~gQt6^5MTcE~-3YgdZ! zjIGumYh(PNH^^qNFXh zyc6r$hK(?nhu0yB(;Ctlp9#3G)02%a<^jiU@Av0eT=w=&!D~N#=(9!hqd(ahc1x*y zWEC~8n$ps59VF1TS@Y;&qoJ;8ZP!r?act=X0Sj?D(7gXv;OVOm8)Ghr{l@nicw15R zBA>Bt*R|mQ&#=bE2fF@`_(w`3c{97oL6?vtG#NfoD3Dm~vS&<>dbXzr7sy z#gYe836Q4<-!IM^3MdWJDSiIa%Vp{#$Q3!&(?uQGshz*KtfBU^g6eWmJ10TDwOuho zA%saY+b>rrgWt$oTdEi2O-3q)Y3mII{V{J*3t5bz6{E>lo`o-Op;xV@D3;Te((uWS z6@pWHyg!)a-WKOxokfAK2aud5vhD)4r#{#0m38TqiB*X)TR zo|?&~dfHWD7`&>-qp>BvH0~_(W9M!Ia>Og>t5=9eGeN|!`AY4A$nZ!3iu^v#^~spP z9E|*as4&bM2<&8j%1Pas0uP5G2lQpOv!=+H!M%Ez|3v)a#srjf#^$c3S5+P*%9nJ6 z$H6y4vt=yV7mC2H_UfzMDiGOvguA-M)dQYQXn;MGVLSFxGJ)65Cu8nY#VjM=*7JB& z*H-c*fJPmR@SD)HBF~`^k^GPAg=AWk+G}a|tnc6fIvYH&R>q3zOmc@oJ@A^)x*|kz zh7p@PUf~ zQQb&}Y=9m(L@>(u*k)VU12ZUTTkIgIop>fV;;@y^zEM#gcGw1F*+qV7#rYMHn}*eT zH&yOMs)D@5XS)Yi*Rv~l6HT6zm`?9uAlteJ&_t6+mveb#O^;>~MXqZBcKFrGM(hPK z6aUZ~Jv_3YvjKSelk@$MX{>Wvb!cU`k61s;BetsZfz%lp*6<&WYm$1V&_Ro;vX^H@2< zhl$5%<%|)}y5jM}b)Ql2N05O>S_Hi+>Z`Ee9Bxu$qw%w+itVnKU1f%LFj<50V4OEz$NY6`Sn>aSeyxD?I zrGA@aGY+^nK!u>n(j5@nyFA=*8Bv~}Ug9YjtK-gr z6Th0xBlU0&$>0^Rbfb6EjeFb8apW+?{R)$277vBaH0dDK=OW_6y3G@%9E}ya6Avdzd6o3gb2fZ$wwpA6SrdfGst6S78t+yf z-Io!RemLJVI;5FqS0kj(N@Jr4f>H7@Hq5TmZECG>!wqnb@o~+X_`nZU=MZD7Eidc` zhHg#nZjyp?VaCj`fu%cZ1iM6W?sw9wp>HYjZy(|D;*OU%zWm%h2?nomm^Srm$5&&w zUTisSvO12kq+>i&qEw6ez19@y9=Ab0w`RNbnGde>m7NE5e%@aFMNCN{ZiH&ahpC?$ zFTd6PEUz>*I`9YPz~&E4GkeL{z_IUM)twCjS&~4{=Y;4g4lQEK4FyupM%w6Jtj26{ zZND&XaA@Y+MB;?F+*bwcO0Ud7e+$?K4Tjh4Ue~7Y2X`mNCP{JJv$Yo-4%O!xWE)s@ zq$8zZ@-eZMZ@>t*zg(;@;_d`EiGkARBUEE_rs4f8WCqYP7<(N+%sbbWW9%`cJs8p3Ri?LlQX1g%Yl|`jHYYiYe$pl)vjm z#tkd3m%!fA6b{>f#93&NkpCi57;J_dv#QkW!jB(B{^JCr~LTtEk zQ{0f6G6FvQIbr_LJ^@Jnz`?0sWy?W>`W z+astPL;kkZu;19cAE4|h*26*UWkPR;k~ovvpQR@#8H{a#P3XP!Jn1Y)z=(>RN`+%D@Gd}9B_Zk{&QlQh5= zMtoUU+B-12%tjn6vk?cyIh;o3Om%Q2ltk9{?)KQe=2Fkpz8ELZK70Xog3qC)yY=O@ z`#=4F8{Fr>4RH3~;Rdp7xIqU8ZV>zfZg4JmdAH(l9A?q+;FZDnJ>bP7X6#zfRLep{ zpPoUgGybx2$kHz@o)6bDK~FiSz>=3WPJBd;ETyJIJBZA+N$h}KdM|+dWWoo6#h$IJ z$~Cbbo`ZA=qVV?Pley@#qZ|Uqo)4oUFoFH3krRm&S7Po zA~ohw9ga<`w7p}q4LT;TWw6->D4pJ`qXaW)Hrt?(!#40>vkf|Gd(9C7abKq^$4F+c zdo(=YwSSyF&}LNKCPth^Pr|{pm)ub#kX=LgZ$H=u(ZRl-cE?@V-A`wS0Gn;Fr^sn? z3yuM7w!sdYZQ#jf8x&h?SA7l46J@gvyuPyyYM3(Olk^y|$kiWEh8`=iFo?okRl?^o zB>XyP;-A~{>dY#D~>6spf~UmzYL-{LlVWa$EDLM7FC&|gJl(cY{G#) zhj7rY|5d^YEC##NGU~E$`4$8HfKQ&U0zEgq*?yEFu7t;My8iC@sDz}xx9^P%ROd%A z1@N#C_bU8$UzwNev}h9tD^lVZCJw0?tBmuK>rUN3`%o5B%bMP?#vNPGPGHiPhk2Ch zq_YbR%h>3&p0~-NCUVO~_mVZ55x`AUQ{rXr*CNMm6RTgBit#I7;`AgnSY7z~Bg9vr zl{WK|V{D`0I%QyxP0I=VJ{3u%IP`e$P5g|{(8&q2jiQNfhj|W%iS1bXDdie-+jwRe z2orGRT&?d{U)gO)$oI=HvhP$B^^)zx>{UVtES&?;`BG5l)A1Yevjk(Gz`7Dm2%dar zY^K=0iW0>6&c@yu{*v=R=tlEv2a(qYj-Z;brpvtcJu0U?jW2gLIjL8XhEDA`HK^Om zoK(28TeU>ZjmQa~ZQ_25J}CZYxPh0Anz|H{12<(kOhCQ-+V&yo7&&8(jSk zH<-LvGB~*A6d})s8we4VIhU~}Hr$|(12>2bwu1i&H*o**!r10PQ^~Ze%WTtRS!^0R z{h{%2=H)!$t0jIPjFOHoD^iH3q;wx6Tw$iN@KY_=5p_oo%~M+wG@WoYJK0WJG$Xj6 zG$QOZIe)j~*0{~e!hFG`O_|;0>E;`i*H_(X`Tw~ivV@F zKBXfF(mXFgz+n3qOxY#`aNZg7gN;f`EE}8fj$tk|=-v27Xzr|YV~hKM_r-1E+H3IS zZxLk{UO9FdyBZ_VLRb9eKz*+bAuy_1L#eFC;Pps{2qCG&Fom{j=T|3Ur=wnaNLRY> zkmN-dX|E-yL5XqskbghhE)csC^b?bd?0hh7w{p|oP5A!RMQn%0Qsd1O@3>H)O<52m zv&@hHU1OdvyV5Cp(kI%A&}1l?2q*+Kz!F%eA&Zd1%$9X$!&U$?<&_t@&YopI8Zz4! ztQ9h0bKK6$m6WGVxPDq`&Gbp#ez$q%OCeG2RB?p#xVVFS$np0!ehppwQ7D)p3d_ug zZBbK$2u>JT`Og`;% z)r_$AJHu&{WKt#Nl^3E6S6cuNG^~fU?{(j)63c1=+SPwzyUe}O^7u09qx-|v2 zT%)`*DC#Dm?j%a#)mNJRwtCI9_~@aT`wfzA^kr8(e`fz|@^pq#+X>>3qE5kFG~+-F z#r49PZp{VeR0e$f8s@P$>lJz!J`&A1D@Nzh3=#F*{l-f1n&?@Ypx;KX_#+wj8|Q(A zA&xRxnY6sspuP}~>0-Q-_QKZh?qy?77SC(>V%r@fgTwr1Qf{!(3;{Nt)7HE4suqW-^GQpMpGx5qg3{+J!#{W>B(2s+3jjRU zFAP`;d9XL@6N_P8S0=#`nOI%I&C^irx;R}GHs|0IWZZ-0#$Lg5KU8MVs(Fs}7~h2- z9Hqo`oR^<_Nw~+ZGE$p2QBf`OO4p1Mqfg8IN`|i^x;q%mv=v>f?($7sSKv3<;C}xb zqE`ry=scm&=I3YMS(ZS}h)-tcUGc1eV4e)rA5_abO25xe^tywipxo-`YR407prBuP za*l_nM(VBsJxNPvUQZ?1cwX5ra!0JGZqPhaL{C(h<#w`c&pw|8&`cnB3KV^XvG)yKBSS}krUHw#Rr z4L63$U5ij6Bh-!TYRcnjJ0H|{7no#z=iN{CEl;?y7eGR!7j|wb1wSFu%Pxtn-d2y& zL^wslWys5S5(5$gxD68nobQfJh^BUE4vLN!$lo^J4gusgW&@sFHWz8iXO8YrUixIk z%*+;g~hDb$#p3KVDqq zrzzUzcJbWjLfmq%!6Es(NS%6~|!wb7o!gK^|mr=>Ip|BdAHr+udcL?=yCWG(#1tCNcw-uCMKLH=Mm^u`-DXOBgO(yCwz-2c^+HNqgxTTw{}QB zYC(ueWCS@zJXdS+&q-z)_uM!QpGdinVU2uZEv=pOz5FTo^7B!JEyHHzB=V=Sl8ELn z%5;fYo34QKbmJh87`hjJ(+cyDtD%k!K2AJR-nRabOMUz^kH1_Qcx~6mePrk}$Y56=+wIWn{2hug#VNeq8mx z1{%mOt8vOCKF^&9q-svL>m{`VN34vqa}ia*{N0*+f@FK&)CJ7P-SdLFLz`b3unoL_ zFAd${n1YfZ0F4nTOINDqx#-XHw?zbnN>N3Ef}(DGXu_X+?gDTbReK>qw1l5)crHTZ z93)Cq(euLJj%$&9IGk0j;OAfo-lJd%o)iC?zD7M|#l`I`@^EbYA0Y%6FL_8v8m=c$ zh+U-5={$S3=eNI?6MF&0B^B~l_2nJMfO5|7p;s!N(F=$1K^7Z|<+(uk^k*+!qE6YS z4_;x-y#4k`{-6G~^Z#5xf*ooVFtveOY3RkaeiY=tmT%Z!3HF_O%0hzD*=3pHozGlf zBT~4FJ%QjWok6mj&@TG8idEo6NnbhRepgbdZd#XOpbpgDHVUjz;u6yNqUq&VF6_5+ z8qfW2P#;eYtca+-P4K_*=N!_btj~cr81F?4o6`MnXuO4>$!~LnKgnI;`bG~_#oHe8 z5@<2s+cC}o=a`A%N<13;4hDL+-8T5s4&G5Z_{3`- zBW{fkCt_%`3%8Ki*t|cglKifcD4{!r1mVL4qz{8{@j_jZS@*Sq4bGFqE5gKnuLmsc z{u0`rV`d(tZ0>6lfSotEzfv5``1WjsOI_*)h5uKK(Y=x9FtvNC{YNC6Y9umiB<*$# zJ?!=z_0?uq4=KfD`7F$9D;i1~0Og3cOd&?U8QCPf;YN**9#NVXZ8{gQ!lmsBmS0pP z<~6#ziplu3(H}k+>gS{|{=asS3(kTvD&F=|>3T_`b@m9g2Nk-$7j|2L_&DmGS2D>G zfR()gk_VD4qYsn&0KQB>1x+n5tr<3$fCa_@^Vm_csC+ca!3qnsVrSv&nde6P&0p zK3bQGL%-W6B!_)F@!xqTc)ts{)Tybcz;m8?v)$?S1+_VmKmIgK2vLBhwvU2M6_hVl zY(D%~Cxw|S-plWa9zbQK*C)JvL^%noV0KsVDYEI=xxBEt%_M`57(Ik?(bzU*2etLtxPZHXUHyj2)-4tvA;8mX8Zbw zQ?oUjQzVnQTG&Sag^jCv#x8?*rCJcw6V#XYFfPZo|M>06I&DM>NCV|k@~klxPhA(E8uuL(2~IR-?EvC(Y#XOW)N#raB{Pd8Tf{S={=87tHQ%a`K#M?&EBG<&NzgO-Ilv!tS^}@`Zb+?5rpDBI9ka+WMv(o64e?$A`(8#s%o{%VwUBl2zKwmAgaO0T5gF2=4;&Ajr=3-j& zxP9hVkVb~IK;Dg^?gS_&!LrSGCf9Xhnc2&TARiyoFQ><(8!nY%%qC}xXq9P5+j2&JA zFHec)SsC#3XKlqZ8QpeER`=CboUd->A>JNN2`X7)ohH9t$$i{2JF|^U&c?3CoI&w= zmb9PUS)Wp!;HKv^UM5dYaPe+jz&?~?)N+9n|MyDI@7+8Bxw##M^79bX{HLooKvm*q zM!957MmXyeqpE^nsZGRYE(AQ@q*^fO$2z_}f2-Qe}nG9qB%;h667`zoNC=Z@jZUxbAnUwO#(x)aY~FOtogf=$8n*Mhs|3X$3T>KJxv)4 z_hcdD<#Bk#`eU+-^0G}YddAN#%VzrgxzZCWc-7HhjrPO=FPZja3=~nH-tTGf`dNj) z-~>MIZFN7`18zfq_l`|n;jm+h(OjK%L9{>)w#7kp=bC@nSvO4xV>$Vq$&5qK?&BH5 z(3>2DORyqYlq|~LL}N(wXHBmr6~t6LJm^&7^IgCmdjaPGy~hT>*f6|;l!KH}YzR!S zBGqLE5UQ|KE*O&9!?S2DhDI*^q;J`}r6;3X^{QHa1hUiHbWD>*c5Fse*pdoLKqFyP znNi{1jQwW!{`Zt>Y9;*8Qft>9v|sggu8fE}e#0_JDp>9-otO}YObdAcB->^|MxAd5 zX>=9WnHON!tV<;WvXV^@A@}DeAqUk3Tb6IlAMecnpV)b3@Wz!K>zX)x3 zX%Rrvcqd1m_=5NQg6V}kwkt-EkN}Zlx|135M8#U;x35ki8ukt$YxpMy4XW?r1#s6z z5_(i^9NvL?C+;3uc08vJv;aD7X_S2J@90j8gpSZU2uOl`FFEXw<5b(--YwOtoiH`O zlB3GhR3QZ04pKIwuprVr?EIKCE_|}tb;?KPF#v#^sfuE=W6koh;vRG3-X zh}If4pm<$?H2Xr z$bg**Pa%VgSi^PJbgG%-#0;3Ag*7R~+YUz_Bjb`{=lp%9s11V(Smz;wQ<_F!-CY4b z8L=$>sJ_rU9?QiZtaCe6=+w`E_9>EcNk|#EBZN3MuHW)WlsQKmgg0S)7Mfl+tQUe@ zu&nbT(fYIAwgF>}L>b8GM`aLyMrShyNk0hu{;>ecOF15@=rG_5Cv5P7LE-JA91 z!%h4{c|zpvoSAO5`xLC54~b>b50YvR9<;IK^6OT6ILAHO!DHj@7+D?(AX@YQ5#PuZ z!Cs4AoBc3%h(G}`@>j5C)@gNXLVr@F?ptGA!3wf(IL1-G8VT9#HG|mAS~&{nc0Dl$ zp$(AOfNsl24$278gwBju8lT!H!k3;|0-WZt(R#q2(&_(0LR~m06 zw{HKJi6Q4KwVgG+LrL(7VqJ2NZxwSZilya?!++GozGZA6nnsDP@2^_*i)^(Ax8Syb z1qrU#liM~uus!*Zuh@^!YfnlixX^vS< z^v$CbN|Hi4B?h@|v|N^-lxSU>fzgJ86t4SEDVB#&xn-dnqy|!8j*2O`iNx0Z0msuAKxIe^=D3gM}hwYcK?wup=(7Y^Ab0MA8Ou z#HWh(OT%n#m;KO}n$WVg_*p4(v;S-PwTd7Xk3Ch}jI>jEmCGxLD`ulP;K{uL5$sKJ zRG60nsSfjzZkwB8xdN!0h3C&HXGfi8554Enpl$X#9X)y^nja zxw3V+q&p=9_HFYDM>_*s>UpD)&%=yXGYGSaRL#VfwyiJ$IXny9=_8{KrY4xU^5Emjv<;K>B$uHX0gxbD|j_CpTSK)ZX+2QuxJ z3r&TKj5_oJ1g-z3eu+>sun?j@NH%`U8r^{n%H(b{^JYO1PoE|05fdGebmzq8nnx)n z1#4*xyRjg~aEJh2ygLr=GNF)&Z*x<@Quot#7)akBLcLdF8hXXL)N-t-UP;3|sIGCx zSAOJP$7+X5(N%%Z6h1KjV}0=$|e z*P@NTOA&?(*db7a(&qy0WQfEXX1B_je#4c}-7IL*Q)Wl`u9rEyd&5HKa_iq#?ASS1 zGxe!Jwzoigv@?^pa_3?9u6uI{TO>gJ8I)`Z60infk1-T8jbn6P_x&=RQ!Gex zb-5+Rk-lgq?Dux0NGVAu#Yve7Smf6#DBwZ2=8B)aZPsH$y=AMWHQ!6_P5d=HnYqs& zI&p-lz>%xOz^r7pCD|DU|Ezkc&8s?x`BU{0J-G|`uc8;%e-gb&{X_K9pt`KQ@?G;X zu%xH+Zak-l-(5O3)nW;JnG0sB6FT0*k-UukL-L~ZdVg-I^TnBqM`S!ZOxwjBTUUha zUmnD}JDp}RJ_k&nEJm1c;fRysvLfEUy9RIGYr2v*`c}>SdMdWJQvZW+AuOxXNAll- zY)w;m`%2W}%dp%}IJ0T*(+_}YBW=_L&B z6*Hv=`J4hh6N^2u5_dh~y7MMP&6h7lFRh}~r#_ioRIiur4o8Q}-4-*LM8$#O>=+_H zhTy0G7huQVRUdm1F?qlBN;N9kOMZ{Pd*M5!pT*r2W}jgBhR-Pqx}FV?VQWtOeMbFP z7vyBy=*fq+9w7ve@6wSPIm6!Cv#?a@^)`c#lHUGy=d(fE)!(3Q?9DYZRQeH>S#9}a zWBpcR4g-Y2AL1Ch^f#7yhDd$>Qw3Ek^_K8B0aDBG^Sx2U$*l?zv1qEXTaRW~uk^+% zU$Dc{OZQ5Q<7;IKzsl2=^ar+L8NDGvp&L@qPzG`ib27o(NIeSl02-XG& zZcP~|s5r+K!T{%QHS%77T`h*Y+kp|s6iRomIa;rZOXO4O?oH$V$AO+&3Z=4~FGW%Z zv(*_gtChAL8n2=NUzD519NWVdi^ts+95sC%t=%a6Lw60NLu5~7R82GqywbPE+sCwD z8fXT&GqZfkNgbCs`*s*}iLE>VDWN!Wml>x_l^mnSZZ)6VnW<`JnZ1x?fnF8#7}=gRWOiX*!_J2xJ!vI+LK`5&IOxFcSK9X!(s_4$-_gqPx4Xc_P` z`&7X~51|5zw%u1>(5VmD4eT>Sg3|~a9Qto}zuPm!yg2#~37yy3A>NM#vZDpsIbsHk zy4xki*IYa_-)GfaK_u_ICUFf9iB|ZZ^0`Ymmtx|0(5B!n$yZR-&$1pq22MGP$ToP@ zKCVDrB=!GS@k@=E8K+75dAY;c_od3cp3ZUmO8A=V%HeF7_8C&hBu)CNt|@9+VX14& zQ67QSZW^Y?@P~8TE|3OYq;_JZuzW%!2sD*I1 zpq$$_njWQf_m30UiZmY?P4LWa&H^oFlzB3$X{WPY!ns!n)D8@Ba0kseTI%kiUO_rL zfG>9|BKpsz>`Qx5pT|4Z6owfdTCnPo<_#0!GMo^dXp(+8wuiTXz8xj6zm@R?q zk=VHqvn2|u8G!0Wuy4bkjfs$cC`io0;{M8RZEI~ZI=dAdtz&d&#}PmDqXP-NmwYL& zS(lF3@^SZV6XThk^RVH!V<;Ul=pyDdMNy)X1ZA9FxNZTnR=E{`wJ$bSkfW5t=6-hE z6I>lSg*tGUdaM~Y%`5k7O*oXqRw(f`+$IiQUHkGAWmj2;gfRMecQ7JTagF$tN8|-{r;c9fu}|GVAD+~ z+Wav`-1meh{BLqI)Lp*KvWz(M=%}Z5+9jq{bE?d-&$KOt&< zLo83qJhgOfO=6W+G>;W<+HhKEx{$^3_8E`28}54Uh?<`Op8W-d=jOL>?M*nc96o)#g;%6xX%lAh&JOa&g}DD7LX5_Nykylbrcv%yHD+!jJMcEjk?8%kB-wBqhH8Bw%4L93F@=&*{_StS29&8P6GG zCqMsj8N|7MA7r0uUNsWE9EOmdc?rI>SgH0Eu?`EQhlKVWTy-qg!G*#zZ5zk*q-(T7 z%P0ZmBpUC;Gch{!fV=MoVo!!@!w!TTCnY ziyy_pgpD4ztI8doi-J_};XerJKYkumujs}Vs6VI_>aLbl0|i>FW-;H~`EawK=+~Pa zxw5+Er(U&IUsYsYm4Y5VurSxc4#pOzM&HhL ze(d^yu)o&La+U-Go@6kNtXG4_Pb)9Zo<0*D&1w>yXd?)u>Xi=xEdH1TQ7VL12MCuo88?xntf31 z%i-x3Sf%T_BT%DG6)GYfn+oQbC-w>gDjVe<>{k*jH#Vs_CJrYb&Q1VoL1=~@P_|h; zWuVsg_qv7mncKO0B8@F98i~asfnY0e^3toN&t)wv$km7wRc|Ke64~)Q!$Twwc;9KK z6ij};M)QHFpfAiz<}ks~A$XQrV2Z$R<^6J3U3F<1|MB7U>pP=dy;F^@>5LpaE-W*`58An2y1UM@*?|S+^y{I8K%N+v^vNUN&Sq)nJ-1T-^ddB$zxPXdgb}9vZti#k z1n=}C7U;J-SoilR^gjo3|79?luoPRM`#KNYuzU0$Rf+ILp>X2P^4rXZDH=7v(zqld zbjtqQ5P(X`a8_qnJ~H1=c@$O%pB~{q9V@dgTE`Nd2oY)QO{ZJZAG3~$+F^|)fGt@D zbWUIoY(`a#Jt3XZl2ea<7ggxlps#yP?2E?#Jjk37@CZZPIy$8#eTayHeveDNq#=VO zt*Qgj%SD3gqn!J1#XH~cze@v#IoV6L9S5nkS$Dcz!Oyk}!27-pk7VV%h>PbiFQ#vJ zC?L)j^INGK5UcCZ#!2^s3&Eoo-Q69M!r7+d%_;)S+Lj3ql`0w(QTGVzv|}a34yTp% zD*rvO##`yocBM3|U^Up2or|g+AJN~VmwKo}_zI`kVi4?@pYNYBzve$l|X{K<&Utq0N?Nvg#R{?8~yDic9rt{x7 z4eHv;I9A$b-QRw~2)%XQruuF%1yS$xY?ADIw1I5eqm7Oyjv5lZ12hC@Ng+1jJR}M=q|&)5CSr0=u(`|Y^iaW5M-{mozPu;)GuKrfNIbsVR%y)OtAC-M z0@onexk3f{%~$gS^fX})#@4{=8g|hH2>h;X$a>4peV6R6B0D3^AA`b_KIB+8Ncn-i zSrIx*3hUkzLWo;)p-r4wuh}1*HYbmNp+8A=uvji^m_=HGViu(W&H#B1%3@Nr*9~Cy z14ip};B|<`tLfh7u?3HEM8vX6QjUjY#*bB2SdiU@hw0dYi*`Qj ze@K?j@XFy~9sH6JtTTN{CJTIU0r)W4PtB{+D?YMJwhVn=S#?Q-`u0(%o!UGA=V>a0 z1r4t@$mw>ss+jf&OLJ?3(32CXY1|pII&o4{zKkr>VSD1+~YfB)GI|DkccgKG& zP;C1W`>Lqt$!HDR>O7Kdb$)KxF6=qmcENOx5WO6@!_MAuZnufXre5b) zT4;WJuI3t4qH1Ypyh1MYC+0o2uL_dwb)FNF1Y3voco1#OqJ*{_Y2yImrs}S6{$Kwt zO(2lUMJo+DE7SDP{hxX?|3mQd|Mg18+J(}@QSy7@qZ0K2Bp7)!{s z6M7a$fe2rZLB@(>%bS|!BXmqycn)L6_u%SH&)K5hb=Smtz-yk7dM0D{?2Z{}UX-4* zunVgZm8Hp&yUiP5iM*!#qn+k$?hA3rfD&T62DZs!9iSdKQ6=1IJb|@-*@ed}l4W*o zcV#dir!hb5r_x1YTm_O^R;Len{5A61Lh(4ff88|Yu$5EXK5WotSevayfrYR!Kj@i0 zdA3(e@zX5OXz5y21QQWT{f#egF&Bi@JY*1laySX`Q~= zPKviZV`vNV&b?G~(o8R}c(UyF=zeRo9#bUse&2Zqb(pytp7PE}jyV78o+HOa0R0O6 zg~3X0G46A0EVEXvUQ?Jvb5Sg$H&xkBJ!oc7xF)ed8ut9uY-FgxJgYT=Y|6W>oIQR@ z+S9YZeAlzuWm6SA+w#I?T8rR0(N1#75mYA33o5T#AFt2w(^ksS7EDAR^V7dl8b2|r zQCg9Gpst%Dn>C;FIpO#Xr`H?!?vs+rj?pZVKF}ZDq^o3|HGR#^BF8k%*!(gL;ghPY zqBG(Xe)GwJPWZ<@@H9piUf1Mzs0C~Om^LC(wUi}jt+WghheTFJ&EHpvd5^JL6sTUm zs+u&RdOBtGG*m1=4^-R`2-LsbVd9aZdQmE)qo{a!P+`JA1}QBekjt;W<Wz< zRBlv|Fw#GRwB^4bZEgNbPktF)@j+a3QI$u{u;D4G%F@S9qcgow(&M;~IjL(=rCYDJ z8sU?f7XORA?~ZFCTm0SCUAv&56lp2~(nS=c1r-q$1QqE`Kzb7)KnMw|D2OzX8YvMF zkWQ!)N|Y9Q=m7$W(gFz(2_=w_@Ph8$Th_hr-rxJY_t*O*Bva1G%p^0MIp^B~3htsr z8P;hKdB&W0*kX@!%*RXy?;PNmXr}~2jaDhRqIMKD@t!)E_Hm;4qgx-SAo4M*Y#jru zw=q!6UPt6n-keLdChciI~(j}D6zls z=wew2=mw>Vi%M4vd?!mp;rH z|4F6PPxDKCcMRy^f~)7VFE3_8J?%ckT5BK+c4<-zQ+{$%>nNxl(t|x(&uUVgziT-# z<5-JdU84_(u@!Y)H%jt5jxvLjagS$5;J$=#2Gmt-(OrLLJGbJNh|acE&es?50#`Kbc!4WG~TU~Wcz0RPT<4z)|_@w`fFO#MqTGS05XQ0dAe$Q=FHjv92zC;aa(OwgN_C_0w#VVjH|s!)xu+tcmf_vr2;8fl-RpP_qlCLWRpC>%bwam5(^{YGI>?qP`T)5%0tdd|) z%8jB#+t20p_%*C(p)lQn6r-M>mlq;lI$=ucw3d~CwWgY9`0y9qyc~cVkk1F0PH%pH8U>#@7W4 z?F}qN%&)(p3tw4N7@iE{L&LDic_taqlH10D+9i@sbd zmzQcVJOh<96uDjmZ2e{#N`(Sg%)y!VOnjEXRvW(m6z)3UUZsAGmYSFEJk+<#5s<6K}7d_sGbxl9S^Lhw$wax4*+W zv#0#&lTQVoTR$Zompiv{XBftJ#yuEW+2Cb+qR{C_f4}2)vuk^C3TJu9j8T0$bfLIK9BGP#POo3(9*v5KX^sS)oBby@4L&aJ zret{qg}-~bG&?GYcWfyB<$eC&PpN-v8usHx71|#-_k5xW68;yw**_ZeKW}9%-_9qo zt4>VBFFNht6#J)UUAY4pui3-fVbNA4IXiy?KmQXYc5`5xA7CsJZ5EiCzU_ulitGUA zQIpF+=gQ6)%N3F9`r%*rqJkZZLWY?`2@JFd-tQvD^pTLyp_Im)Qc3p%>^EZ%LtCRH z_H3RR^FFA=bQ5FL;%DF@Fk{3TcC-m?%IHXf7TbTJnsnMyvOPYwO)bR{9{9{Kxg;#m zOtzmxnMweMdGQ$Q7Yd#N8zR(<`kCn9Jnt)MYOgIsfO*xXPi**aPWnipfBO9_Xd)^+ zlnFr``r~J2{>Cb7TgUyn>Tu*NKYlb~YLZR(Yz zxrZFX?7;Ro9P@SyW+Ou85n(B>FjG9a} zvKOwMPBp3{0XCXre(m!=ADhjkB!$YIT;Z`1SPF;~U3?HA-FfUEPEy-LT73=S9%-D3 z)rf_cice=&1B&!2%0)iK2NX@TNVp>jYq6>mV3gFd+PO1(UV2-%4zgovn9cGsXFPvq zv_RQ?$*uF=4y#^AOs?aE{{F%La3LHC1)_}ZikaHQ>|7h+S$3A(f5l8)a+>J8H18NU z%DM_!lwS9pf?;sDh2vnGZXQhnZF~15QKahnL$FobwL(rV{8_hNOTub~J;!5a@71=t zV>yql(1zr+eazba4X^wKedU;V#!WKdlt9_e6PLy~3vjk77K_=|yjImVyvBtH4d^$g z1xl95!9>eE461lBn^r5rhvQ>*f)GO82N8MphUn``54EabOds*}T}_&zJ0ArR?p#_4 z_yUb_8`1H;&EW2bYVVY3XgZ}E%1!TzATvVo>$t!LGcM_x>FvxvtLk&Vh7X{G33da!;qPstLLWw3dfaOG0C2ocK)O zbj!3Jk#%G*L4Gs9`Z314Oc>McWYc!SH`j2m&Oi+#agbq|?hjxLCK1hxKfGxRP~Wh> ziBBxJmwGpB$RhTDm9f-4M6zMf5uYa$K~_Tu`MYk+PYo(n_QcBqHZYDZnn$;br>0i| zW32|z`e@p6;n8f(i0o!p>cS&?M(T0VQDTD($|&fTj3W6|cFhZ#_m< z_#~1w`UZu-nHqOOubX*)#m?7Y1LgcqM+@K)GtMzC1p8SJxM~k@sv6sKSgn|hG#RP8 z-q8or?_HT_IlI24dA$ek^Kuxn$s8nPxw{s6STLY3gw*?ULU;uu+(A%IjMK);8FAq7r8Tdsd)6N$hGkylTdUXu zB%c{{yn|md&8Mdt!GWr{sp8}JUml(Ao;FvDVw?@;oM;SehKy04X_Em}4kwzKG?f;^ zC7)6A&diA6vCmRp_qv@LJuF+=62I-iTwi8_C~V+HyO6d}q)8pZ0~=uyhVDs8Da!Jl`;Gr7FDw3&{}p$0cG z)QPp_*MgO7SZaZsO=tJ%{1TVSVPpd9Z_uX6iPXm3dV>ln+#W~V+*>vdj`2Id=2-6P zHy)S|;D38u0wLq4Z)eI>+# z1GS1lBrH6Eapj$7wOO@W5w4}`YnKGYL^QxxLld^K6=?91lffLXaB}c(=pKjiXafnY za_idF|Ar90L%#kS=Mrp;_Z(NPVB8{6YBY*_f34#DJB_^F3V%~F?0|GJ>3;hIfFkB( z?BjRqpqd0idsZ{W=Xj@!-38H8@F>b4JbJTp@iZb32p2I><#}<&L&0mwO*4Oy>!p(J z(xRbQf;DMls%?xtAyGEMg7Q_rjW!ExV?Fv6eNxVQDNz*|$GX3mN zrP-_aspH$uQr`lnT0u|$0xt-)JqG*k1jP=0`4=as%DNB7k}6NjrBH$kVoIf`LjzdK-#0X^N7i8b6oFxt{}nmNfDo; zP8V90qXP`0Fco@%OuK*<`RgrwCCN$E`zx^0UP7dWL^#M7_VO(w0Q#EtVKwz`sUC*k zDqLnHljs}!xaHZtXB$v?bDcZp6DL&IoKh!Myz1*~L`3vygqJ_#HnN=zxDy&-w4ZA` z@r0up*?&+yr~Wxq-?yT&X#==D6dUgfKxK#h zll&$Br4PBq&XMi9M=Y(SF|}gyv+18U>XO}zj=v&OAM2@(UA|H=e*Kl(*?XymsRZ*> zr^FbU6NbyR1s_DfU8Bz5hRGhrm3A0R1rn`sv`DpR?WUo_+&>LA_?I<)9Npn-9)1Ii zTzUR$cRm(4jURd0+W}9%pX#?yYbcyt8!}Z+XUpH>q%@RTZqmDczDNa^DsMN z_SW+l>7X$5tM5e3h0eN`+dq9w+B|8UD}g;!dGI6$z4V(Y%~rC-SFv)I^cua^$X{0^ z*}Lk|P<0+mg6*gl-ddSz0lQ!I?!4G>ZtPjZL=(*_$e!8S6=xfco^OuV>rJ6qX6L$B9RrYjo3E&>es=_N_tr z%WHztD?$BTjnT<37EYhBJ6k;TS;NGvPO|G1&gMmv^mw}<0zV6CJUqC0-{|o+tn$p1 zz{{>^M!^$C=eZYy*Zo|QJg=T{_c>7e$+LANYB(xyz0l)!H=>DmxvPoy@!aVKfNx*t z2Z@DSp%WUNUh3##)%@L3y4oHm=kgAxy02zOPwR0gWg62{=*Ui?UuN~h?%~Ni$0~^vuFDC+OMs8DR}LN zKD~B&5nJNqbV=r(^8PYevA*<^vFRy|(}5x;PA^;2aSBwP>`!&}Ua_1CxFJ5vGgo<+ zCZru(6%xAj63&L2yiRsNUh{ScWWLGKd&b?mccR9pjF+mt`Qjq}0VjB*NqC)B#0x94 zo?akpS4IB-qO1HV<-k_F)Vh+Bmk-{iBoGIMpYEG$!j811;`^J24*l4 z{n0~z#3QV@K{72cOfYL!;eZ-DORi@_VB)QSZ-{5_VdNF%xjjFaNzWGW5m{}jZTcWQ z6&QKk{ySPIi_Lkxw^c}8G*s!RLdCs3b}k?|2#)yP&G~&de)x8M^uADStPy+%bA#C?x5LvADC^YB51bF$usCs_*SeYRfp9kvMCxo z9kUgSk|mZbDeHvoO#jmgO)8CA!^KGV`uanh@#^ug=PFyYd7VwQfM5m%$6(-4^j;A{ zCwFIvO)!HPzrAi??fBIaKNrMWgvZ#KAK106p=N@zy0@;_7xL(4LSx;VjklQXNT$X# zYJMXT8`9HIVCMS*L7sPl@x*4R;r@XDm`*q+d_;$}z z7u~dEN7Vxfa~HPWFLCp-e3tCz7GCxUmUof6?pp)4c0Hd3-nQh(0+k(R?GZ) z--NH53_&u)Q##~p+-=Qp4F8mmD)PXAi}|^iZLD8DBE4uBw1d6xYZLZ48Z(oHnF*Gd z=$F&hNGL9Db04&u10Ns53LCAMPiXbl5giIN^oeejox^0j`Qq}k&&?UeYzt_pK3m;h zp13&xO)vOtL5uVg9y?E}&PmKNFljjee5KcWWqBl>d+|A!7(S#>Y@ka+n$8a+y$9yQ zT#--1z$_~NT3)TfPUFXwVCz zhGgViz^J(b@~}dIfwAceA5E+b<*#*j9_~Un1tJU9szp)dNi;tZKSJNG_WKte7xs6H zDz22U#W^nK9DausR5>IrP6{UZ>N+gcXh|L;M496-o2kjo;|giCcC45B%*$(I2J{!! zaSsf}bRRoZE=0yOb*8tSfq57EPV%}-yl{RiEn|B9r@l`A;hDl%bI}$(?U@vwqlaG@9mp{CE5mx{TK& zndefPP1H|U)^VCdpM;7BAkc!~sD0SIHmYJqGWSOZ9CD0cQFB51jksi8 zfABEP`MihXM;*^!-bW{lSE_^DLK-E!js={;Ap)%lyG|FMd{2qRQDW<{pE^^IE6bRl zW;5{xHYEVna&LE8>;pp57oF~G+By)JUB?5o*9s%9nwnY76U-bmXAQ{}rDf7?S+G(# zn;mTu){trJkYnJr`AdBsNi{2Lko0j+2>-a%?K9eraj28mrs|vx&n7)-(|4_6aIE(g=Z=?Q{l^%w;g}kF zMS%@(HQBR|b$g`Ih>){q>rGqSJnn$pib*HkMbqLCu1t3{(+#qVt=6*gV2)r>Y-ab! zFfY5aanO@YV|(x^A&NvmR$n^VORK*x_22Ot{1juBQ?a5v+`}8FZ6NJBMVpIS*H~n< zR8tli_dBndl|_}k+mQe?QqPn-T>GXGJ8O8>@C9du7_PNKy;TXcC?o3NWHZm=z@8oM|J;BexV15He!w!N zWlg@dNFh?CsN7?yn|KnTT1)K4NdKv^wZ14E;#D?6c2#Il zrlM6nWLKFtmDiehG7W}C?_8L`FO8iHa`N$5KWF0LrCaoyA)bIUp$ z1-)uBYfaxp8_6wC0>svLH;s0xCu+3VEUG|Vyxe9N9J*okEyx8iU(-zE0?pqXT{y>2WcrK#bCFc{2(6}oEbU05yhDnCgojj z&RB&(x8qW^i5XBRpHhjMYq1C&*|~Pm=rJNF<7La&kt@ChwMPtx4rwl$&z6=j{8#UV z-8y8u=mKj(WHc>zWi;KD_PvC^G4}|py1H*^c6=`fn{E7}iXDOMpe&Pk91vV7cxC$) zVLD?(=a}eIn)Xqya2GXV4kX$mTBn5r7Fxv@)pBC!uA3EUwIQcju4c^DG{j|?o)$qE z^%!cXEHx^kKV8YHB=jsWchy2c&ddiR)cQP;9OcN@u5*OVA~-*U6R^-y)-!f><`UR`d@7DeE)J67HJRqN>0 zIC|;jON37<$82vu->0RkJ!f9w*;4?UWLyUKVh0Bj$JUP;l*U}sgFGJ4xVG;k1upN_ zf1{2a*YNP`Kg2aOC%-Pv(?#st%}Xa8G$=$@&7>0~Qns5ecw7&m`}+a_V@r(@*Yf&H&i1C(>Xp4hkfECf zHooc;evb1_!WmAZUhe6j_W`v~F*NmR*xo)`{0pD>p_`M7xxx~OC=VO#t3zh$^_-r* zgurvb1XX~oE#S+rwcx^sqN|1@F7;;#w}?zU;3axkLmQdGd^C^KK0=- z?!_dXYk0$L>*Csj@B8zED2E*SPLu;>Uc!TB_6GA_g;OlsfSW)+N$3!?o!$3iT#ypj zUGXU6zeXI>K`|Q21Q>H|#D=qHp#;qe{PPPygT0LI_Wx5G{%@u>{Ohl}cAMN7de8y? zno|wk^B;`C|2{Im*2UNt=C>5w3}{>sJ>;~0)KSFtPcJ!3Xh373;y>pz{Eo)+voB7b z;Y}wSo}gU}lXCfkjIz%qqo_B3ggI}-V+3k|f`h?~nG(1ri?)KM1gAFyZ?5U4ieGW( z*oM&WvN-Sr7Gs^oS}y^tqG{A->Srv0r83WZ1NDpQ?it!#fX1(15`3O|)AqN}9!_7h zH+-eRHXLZ-e5J5)W>Gwk_g!||mD8~|d~)CB!&8UPC_0GE(5@QBYmlssL|ZOsxC@9$ zbM-yS8xw^boWw?K!3%z+TiHVw9DfC(@18F`8|=3G>3Smrk|HP**!1j%UMSK(?q%%e z;P#OEuT!g+(wj12IowKSlJ4k^RDrt{s`G4mX6es2ocBI&E%hh%v|G11jp*(qVC{@^ z?~HYtLGpQGg@mWf>1f!bPwr%-=(`T8+Ggxcu8d%#VDYc`bxUg7@HKkl1n+&8B) znyMe$InFSqkLNVuZ?0=VsyZu8wQzpV;ek;R+eszd#}(tv|FXlze^WoX$3Yc{X^@-w2#0 zBJ?RR$QtyO?6sZRp#*w6)90~DWz@ur_WD>xH{Fc7gw8%G=&i5Bf?Z-%psZ(~*}?hmEt z0o#mIUdtQ@=H*9UxCHen^?9zSnWNwb@JhW8{BlVsnS0_*#JI4|ya1>9>bT3qo)_8; z6j%vhYJ7gjVXSLgUP`D7x##kj`QDH1rLmPiT`$@DxhE~I{uSnXSR$=7#v{1Ll!c&d z*P!9j(lIJL#?bLpdq`b}hp>I8NqUl=Q{qD-`0aZny#(U>MyO*0%CSrFHnc}6rh`SH zo|+U(_2Bo@af^x7tZq=Ere>|o0E@>JF|zshJ7Xg@xI2+mEp1qNWBZs-SFx!5N*`F? zQN@34P5yU?u60jpBmz+vn}&L=?&lf$&6=#i#}=;G)ZousCR9M=A6*?c>6TyfF`2IO zS z@P*so2kK@pOzX-uuNsyMTQRkq<|uowb8E&g*0dgpiP?{CjK%(X`leb}3fVTswfb3R z{cA985WMW1)>dgju5{uYkzWTB5jvyayvZg4NBj)VtrQ+(yX+`CVi9Sm-`K`r9%{bu zpP~GW7WtCCV(_B!e0mIVed7W+#ClXQv!`>DRZ#&EAikPEIzIe5QlqGl^VffN`}*em zg%y$C|2MC&JE3$8e@U``-7fq}G)^%+Qm6z@`{A|FZg_mha|ar)`7en)CEpTx*nakF z=v$h$upS3t&RmkArY07Bi@#?^g-G3m33p1(sHJaJ(v#KXFWn~!Cwy2RuUk*ua5I>J zynL;7XO{9qSg}eui8l#J<@zNFtJFhA`kjizwu)#7#LSi3 z2}pHfifvLX@Ma)=J|m2KC-(^5T1$R3+gcw~%{G|zK8Vx0+Y)wz1LUh|!DQ_n^;PRb z>{G_w46@4oav0R!gl-54@jE{$bVz69CWXQ1Ta3`xat9XnW!M#Llc$dy;MfcHxVLFN zb+3pVHKn&P)qz=W$rvOng8;3drEn^$cPQp_|n8P+qA1d1iKW`!iZHygH<8l zV+)cbQC_WvL1vzs6C-J|Nv<|ZJ8Ic$@Wjd;O8|6kJ9NAY7b1XeAa(A*j|YQbg_>%? z$E)e*B}jh^gE-<>q&(JdVjp`t5DK#6CH2#9EXZDmm337$a6u*AqMHuUbH5qUklM?- zDWvAu_Y#~twg?D9KO%P#HC`25%j8oY7-H#Wumz{RRomY}6d>kTG(7qM-J?h@1#+2z zVboWbU)L&(HY%P5jy1J93)%#YRnZl9RJR8iidK=o&FOwH@?Ul8hu3Vd^k$}P*+Vb) zb1HTW%`aS6daKrPtRp_+ycp~w(;P-Uv@Xk^W!ZM6hLu`ncMa6gvD_YT4J>-qB!VwV zPi=T?Zs*IhBhH={=wU57vu~sg`P*s9g+& zYX966zDu(zE#LrK_PW}r)L=QKgtYRiptul9PAkdtcyq;z;a+x^?-=Aqc9VOB91b{i zOm@bnZj`npN+PP00yQ3sZFMJCNlcnR(Idl;<2>u!*vS;`832zR!+n9_ zsr~#1aSP^kJ0UHwAanOM?f{J;=A|z)>G!n0d9P#OG1JrRU%gb`a4b+}y@3mnU_UFS z^3DAKbMm;c>b=}sdsbi|zwmg`N{r7;RosrVB1uT0N@V}$0ysl6t(a#DEUJLX>m0sH zfcqM1x}Ta=tG!g?jI3W9GwNT|EoVnBmgj2dRWt3 zvVbsnEDs3;r>4{;)zpJ6_k!igHz)`LpgiO?*pdvAcN3#{qY~;DOvk{5BgvMo2i$?gjK2u(*Rb#^uE5eN_6as047aF&i$F?&5 z3<+MZ_3HWYzpsds3V+pELQ@W`Y+Tw@6*>;_0MP%0iqPMfwg8kn%E<(JB$FKU`7)XNP& zcHi=vC{e92xFIdvAVe7DU8$YhV1E61W!3A&Xt19il&O9B`Gw>9Jzm0Cb{ z1snR0;C4H_n#$?BQs=Z6b4c^42>+@m;;U%Jwq?}B`@I`6PKEMkusmZO={|K?@oOW8 z{j`LZC4tQfKEdU&REO#|2?~4z^eHrjYbA@DAv4pdmwPZ*w`uKchYJ1bSCc{Qya+&G zee8psUVI{PO0C`2Zb| zj*H0y<&@Ht-&m?aYKsRJ-l!gQ-~{rtR`KInZN8N7;d1mpsok;>+o{X04PDqni1s21 z%?Qm|a2bZk&E zKxe*Sn!UXlq3jZ_+E3L}IFJr(cg?lh{XAo6AwBZclEe5w_2jB^G2|1z6q9ctLv7g2 z-1o>dyeVZcW>5P5=0OEI)hxug*vI zt>v_N@p+*Ry6@Y?+eFR6B`5vzYTXv@d}$*YbG^NN{VJPpQ0{rYmDj))M?@_Gyj6Q& zyHpO3VMuOAJ*DhUTKYF%mL+qW$E(smjw??%bA~|SuYU$LN>OG3&+7q&crpIP2kM5- z{Gr`=ggLL1NJ8xF?WI}aJWWR^dJ=T{b!Jj~LLD&h-*2+Ia>R~h4u*b0L%)jW8%_4TkmgW;Wt(l6zqJ~b!^nt z@~ofGVM?fewKlpTNj-YSvM26%I&qpsK6?HPw}Ug5994YY0$xs-QGj?^btw0^txZYs z2G5eBw8eCpGX8|Fz%IQyt(N1E7JMz1mPna=M(b@MWfz|T+!r(8i5WoO7eE?S&0WGf zshiJQ;PVRnw$6&g>+^vRrFbONPNQ-|xlkWM`#)urCua8hUX#_v3SVXLF>jctwG~Nq zQA+9CD+Al`F~_u<-YbAL;3A=jF=u|wQvrT8W$9He1zU_vM*hvdkW+j2l0(Y{@|m%V#-0AAYcUe{x3zGms>&Y4 zU)Rwi#nia)Uq{EvW=>SLb2l0*-oR3@^F|dEwfq<3MnkEU;MH&R}|$C=bEk zPX+pKUlxo&_%AS9*6~%us(SrWe^Ff$A?cE{wHF@V8*IlIVdX$Hs$v!?-4uKF%o`^3 z!UM)S@+MTXc^v`S0i1%U2M#;h}FGB>MdMwaR$DGS;1!Sa+9Ydb`*1Vw_y1EE5D6vdwc zs)uH^;d4F^`hq!0^u@q_-SbGy$$Ws8hNjJ^y^s&J=|O|!W`=24bS1AD*qbyK;Vl-1 zXWk_Q`_w+Yws3%2YISAdr9lcV+i6MY@*vXxr+F$r4R_x}A?=~)t@$`BGu@JsJS^+} z6C3nEA=(8?9*pQXEcOkwZP#2M&p7sya$=^%2OyF2QQ~*Z*7cgy^>iI}pZ*Nn9d75X zUr_Sdr}Q|oXueLD9*HmNWhM-rwV*FqE0FZ~%kX>~l=y((o;$)()d3wb*%5$Iq*Dis zgQ2Gy7x&UvO%!`h=qIb5qp@8v*cQ`~{02|Hchdb!t83$;W<@l`Td$gdx)8lf)QA3e z6}M~CGRHlgsdW!k73=3Sh2g`s=y`8