proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-06 04:36:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: update docs for find REGEX... command

Browse Source 
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
This commit is contained in:
Quentin Young 2021-03-18 15:42:36 -04:00
parent 767f67a456
commit fdd40d514d
1 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/user/basic.rst
View File

@ -513,32 +513,43 @@ Terminal Mode Commands
Send a message to all logging destinations that are enabled for messages of
the given severity.
.. clicmd:: find COMMAND...
.. clicmd:: find REGEX...
This command performs a simple substring search across all defined commands
in all modes. As an example, suppose you're in enable mode and can't
remember where the command to turn OSPF segment routing on is:
This command performs a regex search across all defined commands in all
modes. As an example, suppose you're in enable mode and can't remember where
the command to turn OSPF segment routing on is:
::
frr# find segment-routing on
(ospf) segment-routing on
(isis) segment-routing on
The CLI mode is displayed next to each command. In this example,
:clicmd:`segment-routing on` is under the `router ospf` mode.
Similarly, suppose you want a listing of all commands that contain "l2vpn":
Similarly, suppose you want a listing of all commands that contain "l2vpn"
and "neighbor":
::
frr# find l2vpn
(view) show [ip] bgp l2vpn evpn [json]
(view) show [ip] bgp l2vpn evpn all <A.B.C.D|A.B.C.D/M> [json]
(view) show [ip] bgp l2vpn evpn all neighbors A.B.C.D advertised-routes [json]
(view) show [ip] bgp l2vpn evpn all neighbors A.B.C.D routes [json]
(view) show [ip] bgp l2vpn evpn all overlay
frr# find l2vpn.*neighbor
(view) show [ip] bgp l2vpn evpn neighbors <A.B.C.D|X:X::X:X|WORD> advertised-routes [json]
(view) show [ip] bgp l2vpn evpn neighbors <A.B.C.D|X:X::X:X|WORD> routes [json]
(view) show [ip] bgp l2vpn evpn rd ASN:NN_OR_IP-ADDRESS:NN neighbors <A.B.C.D|X:X::X:X|WORD> advertised-routes [json]
(view) show [ip] bgp l2vpn evpn rd ASN:NN_OR_IP-ADDRESS:NN neighbors <A.B.C.D|X:X::X:X|WORD> routes [json]
...
Note that when entering spaces as part of a regex specification, repeated
spaces will be compressed into a single space for matching purposes. This is
a consequence of spaces being used to delimit CLI tokens. If you need to
match more than one space, use the ``\s`` escape.
POSIX Extended Regular Expressions are supported.
.. _common-show-commands:
.. clicmd:: show thread cpu [r|w|t|e|x]