From 70335e0a8cd3adf17a8ae4bc1d015f146fdbf3b4 Mon Sep 17 00:00:00 2001 From: Rafael Zalamena Date: Tue, 4 Aug 2020 18:47:54 -0300 Subject: [PATCH] doc: improve neighbor shutdown Add more neighbor shutdown documentation and reference the RFC. Signed-off-by: Rafael Zalamena --- bgpd/bgp_vty.c | 4 ++-- doc/user/bgp.rst | 6 ++++-- doc/user/overview.rst | 4 ++++ 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/bgpd/bgp_vty.c b/bgpd/bgp_vty.c index cfdad6d6c..c53286cb3 100644 --- a/bgpd/bgp_vty.c +++ b/bgpd/bgp_vty.c @@ -4388,7 +4388,7 @@ DEFUN (neighbor_shutdown_msg, NEIGHBOR_STR NEIGHBOR_ADDR_STR2 "Administratively shut down this neighbor\n" - "Add a shutdown message (draft-ietf-idr-shutdown-06)\n" + "Add a shutdown message (RFC 8203)\n" "Shutdown message\n") { int idx_peer = 1; @@ -4420,7 +4420,7 @@ DEFUN (no_neighbor_shutdown_msg, NEIGHBOR_STR NEIGHBOR_ADDR_STR2 "Administratively shut down this neighbor\n" - "Remove a shutdown message (draft-ietf-idr-shutdown-06)\n" + "Remove a shutdown message (RFC 8203)\n" "Shutdown message\n") { int idx_peer = 2; diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index a56532765..98e84c8aa 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -1203,14 +1203,16 @@ Defining Peers Configuring Peers ^^^^^^^^^^^^^^^^^ -.. index:: [no] neighbor PEER shutdown -.. clicmd:: [no] neighbor PEER shutdown +.. index:: [no] neighbor PEER shutdown [message MSG...] +.. clicmd:: [no] neighbor PEER shutdown [message MSG...] Shutdown the peer. We can delete the neighbor's configuration by ``no neighbor PEER remote-as ASN`` but all configuration of the neighbor will be deleted. When you want to preserve the configuration, but want to drop the BGP peer, use this syntax. + Optionally you can specify a shutdown message `MSG`. + .. index:: [no] neighbor PEER disable-connected-check .. clicmd:: [no] neighbor PEER disable-connected-check diff --git a/doc/user/overview.rst b/doc/user/overview.rst index adc20936e..ac6a1e5a8 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -290,6 +290,8 @@ BGP :t:`A Border Gateway Protocol 4 (BGP-4). Updates RFC1771. Y. Rekhter, T. Li & S. Hares. January 2006.` - :rfc:`4364` :t:`BGP/MPLS IP Virtual Private Networks (VPNs). Y. Rekhter. Feb 2006.` +- :rfc:`4486` + :t:`Subcodes for BGP Cease Notification Message. E. Chen, V. Gillet. April 2006.` - :rfc:`4659` :t:`BGP-MPLS IP Virtual Private Network (VPN) Extension for IPv6 VPN. J. De Clercq, D. Ooms, M. Carugi, F. Le Faucheur. September 2006.` - :rfc:`4893` @@ -320,6 +322,8 @@ BGP :t:`BGP Large Communities Attribute. J. Heitz, Ed., J. Snijders, Ed, K. Patel, I. Bagdonas, N. Hilliard. February 2017` - :rfc:`8195` :t:`Use of BGP Large Communities. J. Snijders, J. Heasley, M. Schmidt, June 2017` +- :rfc:`8203` + :t:`BGP Administrative Shutdown Communication. J. Snijders, J. Heitz, J. Scudder. July 2017.` - :rfc:`8212` :t:`Default External BGP (EBGP) Route Propagation Behavior without Policies. J. Mauch, J. Snijders, G. Hankins. July 2017` - :rfc:`8277` -- 2.39.5