From 1c4dd2d81c615bb6c188b78a25bca41418b1f964 Mon Sep 17 00:00:00 2001 From: cumulusAnia Date: Tue, 7 May 2024 16:53:30 -0700 Subject: [PATCH] edits to command ref --- content/nvue-reference/Show-Commands/BGP.md | 87 +++++++++---------- content/nvue-reference/Show-Commands/EVPN.md | 19 ++-- .../nvue-reference/Show-Commands/Interface.md | 2 + content/nvue-reference/Show-Commands/NAT.md | 1 + content/nvue-reference/Show-Commands/OSPF.md | 12 +-- content/nvue-reference/Show-Commands/PTP.md | 3 +- .../Show-Commands/Router-Policy.md | 8 -- .../Show-Commands/SNMP-Server.md | 3 +- 8 files changed, 68 insertions(+), 67 deletions(-) diff --git a/content/nvue-reference/Show-Commands/BGP.md b/content/nvue-reference/Show-Commands/BGP.md index c81f8208b1..82ec744774 100644 --- a/content/nvue-reference/Show-Commands/BGP.md +++ b/content/nvue-reference/Show-Commands/BGP.md @@ -1425,7 +1425,6 @@ Shows BGP IPv6 aggregate routes for the specified VRF. | Syntax | Description | | --------- | -------------- | | `` | The VRF name. | -| `` | The IPv6 address and route prefix in CIDR notation. | ### Version History @@ -1951,7 +1950,7 @@ You must add `-o json` at the end of the command to see the output. | --------- | -------------- | | `` | The VRF name. | | `` | The IPv6 address and route prefix in CIDR notation. | -| `` | The path ID. | ### Version History @@ -2583,7 +2582,7 @@ Add `-o json` at the end of the command to see the output in a more readable for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The BGP group ID.| +| `` | The BGP group ID.| ### Version History @@ -2644,7 +2643,7 @@ Add `-o json` at the end of the command to see the output in a more readable for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The BGP group ID.| +| `` | The BGP group ID.| ### Version History @@ -2696,7 +2695,7 @@ Shows the number of IPv4 routes for a specific BGP neighbor in the specified VRF | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -2732,7 +2731,7 @@ Shows information about the IPv4 advertised routes for a BGP neighbor in the spe | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -2774,7 +2773,7 @@ Add `-o json` at the end of the command to see the output in a more readable for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | ### Version History @@ -2834,7 +2833,7 @@ Add `-o json` at the end of the command to see the output in a more readable for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | ### Version History @@ -2892,7 +2891,7 @@ Add `-o json` at the end of the command to see the output in a more readable for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP.| | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -2951,7 +2950,7 @@ Add `-o json` at the end of the command to see the output in a more readable for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -2985,7 +2984,7 @@ Shows information about the a specific next hop for an IPv4 advertised route pat | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | | `` | The nexthop ID. | @@ -3018,7 +3017,7 @@ Shows information about the peers for an IPv4 advertised route path ID for a BGP | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP.| | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3047,7 +3046,7 @@ Shows information about the flags for an IPv4 advertised route path ID for a BGP | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3075,7 +3074,7 @@ Shows information about the bestpath for an IPv4 advertised route path ID for a | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3104,7 +3103,7 @@ Shows information about the AS path for an IPv4 advertised route path ID for a B | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3132,7 +3131,7 @@ Shows information about the communities for an IPv4 advertised route path ID for | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3157,7 +3156,7 @@ Shows information about the large communities for an IPv4 advertised route path | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP.| | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3182,7 +3181,7 @@ Shows information about the extended communities for an IPv4 advertised route pa | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 advertised route. | | `` | The IPv4 advertised route path ID. | @@ -3207,7 +3206,7 @@ Shows the BGP graceful restart selection deferral and stale path timer settings | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3228,7 +3227,7 @@ Shows the BGP graceful restart stale path timer settings for the BGP peer. | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3249,7 +3248,7 @@ Shows the BGP graceful restart selection deferral timers for the BGP peer. | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3272,7 +3271,7 @@ Shows information about the IPv4 received routes for a BGP neighbor in the speci | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3295,7 +3294,7 @@ Shows information about a specific IPv4 received route for a BGP neighbor in the | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 route. | ### Version History @@ -3319,7 +3318,7 @@ Shows information about a specific IPv4 received route path for a BGP neighbor i | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 route. | ### Version History @@ -3343,7 +3342,7 @@ Shows information about a specific IPv4 received route path ID for a BGP neighbo | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv4 route. | | `` | The path ID. | @@ -3597,7 +3596,7 @@ Shows the BGP graceful restart selection deferral and stale path timer settings | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3618,7 +3617,7 @@ Shows the BGP graceful restart stale path timer settings for the BGP peer. | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3639,7 +3638,7 @@ Shows the BGP graceful restart selection deferral timers for the BGP peer. | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | ### Version History @@ -3662,7 +3661,7 @@ Shows information about the IPv6 received routes for a BGP neighbor in the speci | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP.| ### Version History @@ -3685,7 +3684,7 @@ Shows information about a specific IPv6 received route for a BGP neighbor in the | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | ### Version History @@ -3709,7 +3708,7 @@ Shows information about IPv6 received route paths for a BGP neighbor in the spec | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | ### Version History @@ -3733,7 +3732,7 @@ Shows information about a specific IPv6 received route path for a BGP neighbor i | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3758,7 +3757,7 @@ Shows information about the IPv6 received route path nexthops for a BGP neighbor | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3783,7 +3782,7 @@ Shows information about a specific IPv6 received route path nexthop for a BGP ne | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | | `` | The nexthop ID. | @@ -3809,7 +3808,7 @@ Shows information about the IPv6 received route path peers for a BGP neighbor in | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3834,7 +3833,7 @@ Shows information about the IPv6 received route path flags for a BGP neighbor in | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3859,7 +3858,7 @@ Shows information about the IPv6 received route path bestpath for a BGP neighbor | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3884,7 +3883,7 @@ Shows information about the IPv6 received route path AS path for a BGP neighbor | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3909,7 +3908,7 @@ Shows information about the IPv6 received route path communities for a BGP neigh | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3934,7 +3933,7 @@ Shows information about the IPv6 received route path large communities for a BGP | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3959,7 +3958,7 @@ Shows information about the IPv6 received route path extended communities for a | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | | `` | The path ID. | @@ -3983,7 +3982,7 @@ Shows the number of IPv6 routes for a specific BGP neighbor in the specified VRF | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP.| ### Version History @@ -4006,7 +4005,7 @@ Shows information about the IPv6 advertised routes for a BGP neighbor in the spe | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP.| ### Version History @@ -4029,7 +4028,7 @@ Shows information about a specific IPv6 advertised route for a BGP neighbor in t | Syntax | Description | | --------- | -------------- | | `` | The VRF name.| -| `` | The VRF name. | +| `` | The IP address of the BGP peer or the interface if you are using unnumbered BGP. | | `` | The IPv6 route. | diff --git a/content/nvue-reference/Show-Commands/EVPN.md b/content/nvue-reference/Show-Commands/EVPN.md index 685dc6fa06..79c34c054d 100644 --- a/content/nvue-reference/Show-Commands/EVPN.md +++ b/content/nvue-reference/Show-Commands/EVPN.md @@ -272,6 +272,12 @@ Vtepip es-ref-count nexthop-group Shows EVPN next hop group information for the specified VTEP. +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| `` | The VTEP ID. | + ### Version History Introduced in Cumulus Linux 5.5.0 @@ -427,6 +433,12 @@ cumulus@switch:~$ nv show evpn multihoming bgp-info esi -o json Shows EVPN multihoming BGP information for the specified ESI. +### Command Syntax + +| Syntax | Description | +| --------- | -------------- | +| `` | The ESI identifier. | + ### Version History Introduced in Cumulus Linux 5.5.0 @@ -657,7 +669,6 @@ Shows information about the specified EVPN multihoming Ethernet segment ID. | Syntax | Description | | --------- | -------------- | -| `` | The VNI name. | | `` | The ESI identifier. | ### Version History @@ -695,7 +706,6 @@ Shows information about the specified EVPN multihoming Ethernet segment ID for r | Syntax | Description | | --------- | -------------- | -| `` | The VNI name. | | `` | The ESI identifier. | ### Version History @@ -721,8 +731,8 @@ Shows information about a specific EVPN multihoming Ethernet segment ID for the | Syntax | Description | | --------- | -------------- | -| `` | The VNI name. | | `` | The ESI identifier. | +| `` | The IPv4 address. | ### Version History @@ -1286,7 +1296,6 @@ In Cumulus Linux 5.3 and earlier, this command is `nv show evpn evi rou | Syntax | Description | | --------- | -------------- | | `` | The VNI name. | -| `` | The route target ID. | ### Version History @@ -1340,7 +1349,6 @@ In Cumulus Linux 5.3 and earlier, this command is `nv show evpn evi rou | Syntax | Description | | --------- | -------------- | | `` | The VNI name. | -| `` | The route target ID. | ### Version History @@ -1394,7 +1402,6 @@ In Cumulus Linux 5.3 and earlier, this command is `nv show evpn evi rou | Syntax | Description | | --------- | -------------- | | `` | The VNI name. | -| `` | The route target ID. | ### Version History diff --git a/content/nvue-reference/Show-Commands/Interface.md b/content/nvue-reference/Show-Commands/Interface.md index 327a6449e6..372cbc7409 100644 --- a/content/nvue-reference/Show-Commands/Interface.md +++ b/content/nvue-reference/Show-Commands/Interface.md @@ -141,6 +141,7 @@ Shows specific bond member configuration for the specified interface. | Syntax | Description | | --------- | -------------- | | `` | The interface name. | +| `` | The bond name. | ### Version History @@ -459,6 +460,7 @@ Shows information about a specific gateway IP address for the specified interfac | Syntax | Description | | --------- | -------------- | | `` | The interface name. | +| `` | The gateway IP address. | ### Version History diff --git a/content/nvue-reference/Show-Commands/NAT.md b/content/nvue-reference/Show-Commands/NAT.md index dd820583ee..6f550377e2 100644 --- a/content/nvue-reference/Show-Commands/NAT.md +++ b/content/nvue-reference/Show-Commands/NAT.md @@ -214,6 +214,7 @@ Shows information about the source NAT translate rule for the specified port or | --------- | -------------- | | `` | The ACL name.| | `` | The rule number.| +| `` | The port ID or the port range. | ### Version History diff --git a/content/nvue-reference/Show-Commands/OSPF.md b/content/nvue-reference/Show-Commands/OSPF.md index 232f7fcce5..6f981e111e 100644 --- a/content/nvue-reference/Show-Commands/OSPF.md +++ b/content/nvue-reference/Show-Commands/OSPF.md @@ -293,7 +293,7 @@ Shows the specified OSPF area configuration settings for the specified VRF. | Syntax | Description | | --------- | -------------- | | `` | The VRF name. | -| `` | Area | +| `` | The OSPF area. | ### Version History @@ -325,7 +325,7 @@ Shows the filter list for the specified OSPF area for the specified VRF. | Syntax | Description | | --------- | -------------- | | `` | The VRF name. | -| `` | Area | +| `` | The OSPF area. | ### Version History @@ -352,7 +352,7 @@ Shows the configuration settings for a specific OSPF area network subnet for the | Syntax | Description | | --------- | -------------- | | `` | The VRF name. | -| `` | The area ID. | +| `` | The OSPF area. | | `` | The IPv4 network subnet. | ### Version History @@ -376,7 +376,7 @@ Shows the configuration settings for the specified OSPF area prefix range for th | Syntax | Description | | --------- | -------------- | | `` | The VRF name. | -| `` | The area ID. | +| `` | The OSPF area. | | `` | The IPv4 prefix range. | ### Version History @@ -1066,10 +1066,10 @@ cumulus@switch:~$ nv show vrf default router ospf redistribute static ------ ------- enable off ``` - +