From: Quentin Young Date: Fri, 26 Jan 2018 20:52:30 +0000 (-0500) Subject: doc: fix cli documentation formatting X-Git-Tag: frr-5.0-dev~165^2~72 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=29adcd50089793e31e9ed182a0b370763827ed27;p=mirror%2Ffrr.git doc: fix cli documentation formatting * Use new 'clicmd' directive / role * Convert old style range syntax to new style Signed-off-by: Quentin Young --- 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 - -``[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. + single: no log trap [LEVEL] + single: log trap LEVEL + +.. 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] - -``[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``. + single: no log stdout [LEVEL] + single: log stdout [LEVEL] + +.. 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] + +.. clicmd:: [no] log file [FILENAME [LEVEL]] -``[no] log file [FILENAME [LEVEL]]`` - If you want to log into a file, please specify ``filename`` as - in this example: :: + If you want to log into a file, please specify ``filename`` as + in this example: :: - log file /var/log/frr/bgpd.log informational + 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. + 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] + +.. clicmd:: [no] 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. + 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] - -``[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. + single: no log monitor [LEVEL] + single: log monitor [LEVEL] + +.. 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 - -``[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. + single: no log record-priority + single: log record-priority + +.. 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} {}