summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2024-07-27 10:14:58 +0200
committerChristian Breunig <christian@breunig.cc>2024-07-27 10:14:58 +0200
commit0723f0410130c25d964eabaa973b13364cdbf27a (patch)
tree85b66563a73a60967d4a65d5655b294161123b3a
parentce6663604fdc88fd45a0e67f79be43f60c19c5b6 (diff)
downloadvyos-documentation-ip-ipv6.tar.gz
vyos-documentation-ip-ipv6.zip
ip(v6): improve reset help for BGP neighborsip-ipv6
-rw-r--r--docs/configuration/system/ip.rst30
-rw-r--r--docs/configuration/system/ipv6.rst24
2 files changed, 37 insertions, 17 deletions
diff --git a/docs/configuration/system/ip.rst b/docs/configuration/system/ip.rst
index 5d0a0145..7b5e1503 100644
--- a/docs/configuration/system/ip.rst
+++ b/docs/configuration/system/ip.rst
@@ -110,14 +110,26 @@ Clear commands
Reset commands
^^^^^^^^^^^^^^
-And the different IPv4 **reset** commands available:
+.. opcmd:: reset bgp ipv4 <address>
-.. code-block:: none
+ Use this command to reset :abbr:`BGP (Border Gateway Protocol)` session to
+ address.
- vyos@vyos:~$ reset ip
- Possible completions:
- arp Reset Address Resolution Protocol (ARP) cache
- bgp Clear Border Gateway Protocol (BGP) statistics or status
- igmp IGMP clear commands
- multicast IP multicast routing table
- route Reset IP route
+.. opcmd:: reset bgp ipv4 <1-4294967295>
+
+ Use this command to reset :abbr:`BGP (Border Gateway Protocol)` session to
+ specific ASN.
+
+.. opcmd:: reset bgp ipv4 all
+
+ Use this command to reset all :abbr:`BGP (Border Gateway Protocol)` sessions.
+
+.. opcmd:: reset bgp ipv4 external
+
+ Use this command to reset all external :abbr:`BGP (Border Gateway Protocol)`
+ sessions.
+
+.. opcmd:: reset bgp ipv4 peer-group <name>
+
+ Use this command to reset all :abbr:`BGP (Border Gateway Protocol)` member
+ sessions of a peer-group.
diff --git a/docs/configuration/system/ipv6.rst b/docs/configuration/system/ipv6.rst
index d1322df2..05bcaddb 100644
--- a/docs/configuration/system/ipv6.rst
+++ b/docs/configuration/system/ipv6.rst
@@ -180,16 +180,24 @@ Reset commands
.. opcmd:: reset bgp ipv6 <address>
- Use this command to clear Border Gateway Protocol statistics or
- status.
+ Use this command to reset :abbr:`BGP (Border Gateway Protocol)` session to
+ address.
+.. opcmd:: reset bgp ipv6 <1-4294967295>
-.. opcmd:: reset ipv6 neighbors <address | interface>
+ Use this command to reset :abbr:`BGP (Border Gateway Protocol)` session to
+ specific ASN.
- Use this command to reset IPv6 Neighbor Discovery Protocol cache for
- an address or interface.
+.. opcmd:: reset bgp ipv6 all
-.. opcmd:: reset ipv6 route cache
+ Use this command to reset all :abbr:`BGP (Border Gateway Protocol)` sessions.
- Use this command to flush the kernel IPv6 route cache.
- An address can be added to flush it only for that route.
+.. opcmd:: reset bgp ipv6 external
+
+ Use this command to reset all external :abbr:`BGP (Border Gateway Protocol)`
+ sessions.
+
+.. opcmd:: reset bgp ipv6 peer-group <name>
+
+ Use this command to reset all :abbr:`BGP (Border Gateway Protocol)` member
+ sessions of a peer-group.