Merge branch 'command-ref-org' into stage

CumulusNetworks · Nov 25, 2024 · f4ff0b1 · f4ff0b1
2 parents 3521f1f + 2b98fde
commit f4ff0b1
Show file tree

Hide file tree

Showing 17 changed files with 293 additions and 213 deletions.
diff --git a/content/nvue-reference/Set-and-Unset-Commands/API.md b/content/nvue-reference/Set-and-Unset-Commands/API.md
@@ -14,6 +14,28 @@ The `nv unset` commands remove the configuration you set with the equivalent `nv
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
+## <h>nv set system api certificate \<certificate-string\></h>
+
+Configures the X.509 certificate to be used with the API end-point.
+
+### Command Syntax
+
+| Syntax |  Description   |
+| ---------  | -------------- |
+| `certificate-string` | The certificate string. |
+
+### Version History
+
+Introduced in Cumulus Linux 5.8.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set system api certificate <string>
+```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
 ## <h>nv set system api listening-address \<listening-address-id\></h>
 
 Configures the NVUE REST API listening address; you can specify an IPv4 address or localhost. If you do not specify a listening address, NGINX listens on all addresses for the target port.
@@ -36,22 +58,24 @@ cumulus@switch:~$ nv set system api listening-address localhost
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set system api state</h>
+## <h>nv set system api mtls ca-certificate \<certificate-string\></h>
 
-Enables or disables the NVUE REST API. The default setting is `enabled`.
+Configures the certificate for client validation during Mutual TLS (mTLS) authentication.
 
-{{%notice note%}}
-To use the NVUE REST API in Cumulus Linux 5.6, you must change the password for the cumulus user; otherwise you see 403 responses when you run commands.
-{{%/notice%}}
+### Command Syntax
+
+| Syntax |  Description   |
+| ---------  | -------------- |
+| `certificate-string` | The certificate string. |
 
 ### Version History
 
-Introduced in Cumulus Linux 5.6.0
+Introduced in Cumulus Linux 5.8.0
 
 ### Example
 
 ```
-cumulus@switch:~$ nv set system api state enabled
+cumulus@switch:~$ nv set system api mtls ca-certificate <string>
 ```
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
@@ -69,3 +93,23 @@ Introduced in Cumulus Linux 5.6.0
 ```
 cumulus@switch:~$ nv set system api port 8888
 ```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
+## <h>nv set system api state</h>
+
+Enables or disables the NVUE REST API. The default setting is `enabled`.
+
+{{%notice note%}}
+To use the NVUE REST API in Cumulus Linux 5.6, you must change the password for the cumulus user; otherwise you see 403 responses when you run commands.
+{{%/notice%}}
+
+### Version History
+
+Introduced in Cumulus Linux 5.6.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set system api state enabled
+```
diff --git a/content/nvue-reference/Set-and-Unset-Commands/Bridge.md b/content/nvue-reference/Set-and-Unset-Commands/Bridge.md
@@ -52,6 +52,100 @@ cumulus@switch:~$ nv set bridge domain br_default ageing 600
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
+## <h>nv set bridge domain \<domain-id\> dhcp-snoop vlan \<vid\></h>
+
+Enables DHCP snooping for IPv4 on a VLAN under a bridge.
+
+### Command Syntax
+
+| Syntax | Description |
+| --------- | -------------- |
+| `<domain-id>` | The bridge name. |
+| `<vlan-id>` | The VLAN name. |
+
+### Version History
+
+Introduced in Cumulus Linux 5.11.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set bridge domain br_default dhcp-snoop vlan 10
+```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
+## <h>nv set bridge domain \<domain-id\> dhcp-snoop vlan \<vid\> trust \<interface-id\></h>
+
+Configures a trusted interface for IPv4. Cumulus Linux allows DHCP offers from only trusted interfaces to prevent malicious DHCP servers from assigning IPv4 addresses inside the network. The interface must be a member of the bridge you specify.
+
+### Command Syntax
+
+| Syntax | Description |
+| --------- | -------------- |
+| `<domain-id>` | The bridge name. |
+| `<vlan-id>` | The VLAN name. |
+| `<interface-id>` | The trusted interface ID. |
+
+### Version History
+
+Introduced in Cumulus Linux 5.11.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set bridge domain br_default dhcp-snoop vlan 10 trust swp3
+```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
+## <h>nv set bridge domain \<domain-id\> dhcp-snoop6 vlan \<vid\></h>
+
+Enables DHCP snooping for IPv6 on a VLAN under a bridge.
+
+### Command Syntax
+
+| Syntax | Description |
+| --------- | -------------- |
+| `<domain-id>` | The bridge name. |
+| `<vlan-id>` | The VLAN name. |
+
+### Version History
+
+Introduced in Cumulus Linux 5.11.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set bridge domain br_default dhcp-snoop6 vlan 10
+```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
+## <h>nv set bridge domain \<domain-id\> dhcp-snoop6 vlan \<vid\> trust \<interface-id\></h>
+
+Configures a trusted interface for IPv6. Cumulus Linux allows DHCP offers from only trusted interfaces to prevent malicious DHCP servers from assigning IPv6 addresses inside the network. The interface must be a member of the bridge you specify.
+
+### Command Syntax
+
+| Syntax | Description |
+| --------- | -------------- |
+| `<domain-id>` | The bridge name. |
+| `<vlan-id>` | The VLAN name. |
+| `<interface-id>` | The trusted interface ID. |
+
+### Version History
+
+Introduced in Cumulus Linux 5.11.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set bridge domain br_default dhcp-snoop6 vlan 10 trust swp3
+```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
 ## <h>nv set bridge domain \<domain-id\> encap 802.1Q</h>
 
 Configures all interfaces in this bridge domain to use 802.1Q encapsulation.

diff --git a/content/nvue-reference/Set-and-Unset-Commands/DNS.md b/content/nvue-reference/Set-and-Unset-Commands/DNS.md
@@ -16,7 +16,7 @@ The `nv unset` commands remove the configuration you set with the equivalent `nv
 
 ## <h>nv set service dns \<vrf-id\> search \<domain-id\></h>
 
-Configures the domains to search for name matches.
+Configures the domains you want to search for name matches.
 
 ### Command Syntax
 

diff --git a/content/nvue-reference/Set-and-Unset-Commands/EVPN.md b/content/nvue-reference/Set-and-Unset-Commands/EVPN.md
@@ -30,6 +30,22 @@ cumulus@switch:~$ nv set evpn dad duplicate-action freeze duration permanent
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
+## <h>nv set evpn dad duplicate-action warning-only</h>
+
+Sets the duplicate address action to only generate a warning log message. This is the default setting.
+
+### Version History
+
+Introduced in Cumulus Linux 5.0.0
+
+### Example
+
+```
+cumulus@switch:~$ nv set evpn dad duplicate-action warning-only
+```
+
+<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
+
 ## <h>nv set evpn dad enable</h>
 
 Enables and disables duplicate address detection. The default setting is `off`.
@@ -118,20 +134,14 @@ cumulus@switch:~$ nv set evpn mac-vrf-soo 10.0.1.12:10
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set evpn multihoming ead-evi-route</h>
+## <h>nv set evpn multihoming ead-evi-route rx</h>
 
-Configures the switch to advertise type-1/EAD (Ethernet Auto-discovery) routes as EAD-per-EVI (Ethernet Auto-discovery per EVPN instance) routes for EVPN multihoming.
+Configures the switch to advertise type-1/EAD (Ethernet Auto-discovery) routes as EAD-per-EVI (Ethernet Auto-discovery per EVPN instance) routes for EVPN multihoming at the receiving end.
 
 {{%notice note%}}
-Some third-party switch vendors do not advertise EAD-per-EVI routes; they only advertise EAD-per-ES routes. To interoperate with these vendors, you need to disable EAD-per-EVI route advertisements.
+Some third-party switch vendors do not advertise EAD-per-EVI routes; they only advertise EAD-per-ES routes. To interoperate with these vendors, you need to disable EAD-per-EVI route advertisements.  The default setting is `on`.
 {{%/notice%}}
 
-<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
-
-## <h>nv set evpn multihoming ead-evi-route rx</h>
-
-Turns EAD-per-EVI at the receiving end on or off. The default setting is `on`.
-
 ### Version History
 
 Introduced in Cumulus Linux 5.0.0
@@ -146,7 +156,7 @@ cumulus@switch:~$ nv set evpn multihoming ead-evi-route rx off
 
 ## <h>nv set evpn multihoming ead-evi-route tx</h>
 
-Turns EAD-per-EVI route advertisement on or off. The default setting is `on`.
+Configures the switch to advertise type-1/EAD (Ethernet Auto-discovery) routes as EAD-per-EVI (Ethernet Auto-discovery per EVPN instance) routes for EVPN multihoming at egress. The default setting is `on`.
 
 ### Version History
 
@@ -238,6 +248,12 @@ cumulus@switch:~$ nv set evpn multihoming segment df-preference 50000
 
 Configures the MAC address per Ethernet segment for EVPN multihoming. This setting is required.
 
+### Command Syntax
+
+| Command |  Description   |
+| ---------  | -------------- |
+| `<mac-address>` | The MAC address. |
+
 ### Version History
 
 Introduced in Cumulus Linux 5.0.0
@@ -324,7 +340,7 @@ In Cumulus Linux 5.3 and earlier, this command is `nv set evpn evi,`
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set evpn vni \<vni-id\> rd</h>
+## <h>nv set evpn vni \<vni-id\> rd \<rd-id\></h>
 
 Configures the BGP Route Distinguisher to use for EVPN type-5 routes originated from this VNI.
 
@@ -337,7 +353,7 @@ In Cumulus Linux 5.3 and earlier, this command is `nv set evpn evi <vni-id> rd`
 | Command |  Description   |
 | ---------  | -------------- |
 | `<vni-id>` | The VNI ID. |
-| `<rt-id>` |  The route target. |
+| `<rd-id>` |  The BGP route distinguisher. |
 
 ### Version History
 
@@ -454,16 +470,15 @@ cumulus@switch:~$ nv set vrf RED evpn enable on
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set vrf \<vrf-id\> evpn vlan</h>
+## <h>nv set vrf \<vrf-id\> evpn prefix-routes-only</h>
 
-Configures the VLAN for the EVPN instance in the specified VRF. You can specify a value between 1 and 4094, or `auto`.
+Configures the switch to advertise IP prefix routes (type 5 routes) only in the specified VRF. You can specify `on` or `off`.
 
 ### Command Syntax
 
 | Command |  Description   |
 | ---------  | -------------- |
 | `<vrf-id>` | The VRF name. |
-| `<vlan-id>` | The VLAN name. |
 
 ### Version History
 
@@ -472,21 +487,21 @@ Introduced in Cumulus Linux 5.0.0
 ### Example
 
 ```
-cumulus@switch:~$ nv set vrf RED evpn vlan 10
+cumulus@switch:~$ nv set vrf RED evpn prefix-routes-only on
 ```
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set vrf \<vrf-id\> evpn vni \<vni-id\></h>
+## <h>nv set vrf \<vrf-id\> evpn vlan \<vlan-id\></h>
 
-Configures the layer 3 VNI for the EVPN instance in the specified VRF. You can specify a value between 1 and 16777214, or `auto`.
+Configures the VLAN for the EVPN instance in the specified VRF. You can specify a value between 1 and 4094, or `auto`.
 
 ### Command Syntax
 
 | Command |  Description   |
 | ---------  | -------------- |
 | `<vrf-id>` | The VRF name. |
-| `<vni-id>` | The layer 3 VNI ID. |
+| `<vlan-id>` | The VLAN name. |
 
 ### Version History
 
@@ -495,20 +510,21 @@ Introduced in Cumulus Linux 5.0.0
 ### Example
 
 ```
-cumulus@switch:~$ nv set vrf RED evpn vni 10
+cumulus@switch:~$ nv set vrf RED evpn vlan 10
 ```
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set vrf \<vrf-id\> evpn prefix-routes-only</h>
+## <h>nv set vrf \<vrf-id\> evpn vni \<vni-id\></h>
 
-Configures the switch to advertise IP prefix routes (type 5 routes) only in the specified VRF. You can specify `on` or `off`.
+Configures the layer 3 VNI for the EVPN instance in the specified VRF. You can specify a value between 1 and 16777214, or `auto`.
 
 ### Command Syntax
 
 | Command |  Description   |
 | ---------  | -------------- |
 | `<vrf-id>` | The VRF name. |
+| `<vni-id>` | The layer 3 VNI ID. |
 
 ### Version History
 
@@ -517,5 +533,5 @@ Introduced in Cumulus Linux 5.0.0
 ### Example
 
 ```
-cumulus@switch:~$ nv set vrf RED evpn prefix-routes-only on
+cumulus@switch:~$ nv set vrf RED evpn vni 10
 ```
diff --git a/content/nvue-reference/Set-and-Unset-Commands/Firewall.md b/content/nvue-reference/Set-and-Unset-Commands/Firewall.md
@@ -148,12 +148,6 @@ cumulus@switch:~$ nv set acl acl-default-dos rule 10 action erspan ttl 200
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set acl acl-default-dos rule \<rule-id\> action log</h>
-
-Configures logging for the firewall DoS rule.
-
-<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
-
 ## <h>nv set acl acl-default-dos rule \<rule-id\> action log level</h>
 
 Configures the log level for the firewall DoS rule. You can specify a value between 1 and 7.

diff --git a/content/nvue-reference/Set-and-Unset-Commands/IGMP.md b/content/nvue-reference/Set-and-Unset-Commands/IGMP.md
@@ -229,5 +229,5 @@ Introduced in Cumulus Linux 5.0.0
 ### Example
 
 ```
-cumulus@switch:~$ nv set router igmp on
+cumulus@switch:~$ nv set router igmp enable on
 ```
diff --git a/content/nvue-reference/Set-and-Unset-Commands/Interface.md b/content/nvue-reference/Set-and-Unset-Commands/Interface.md
@@ -583,12 +583,6 @@ cumulus@switch:~$ nv set interface swp1 link state up
 
 <HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
 
-## <h>nv set interface \<interface-id\> storm-control</h>
-
-Configures storm control on the specified interface. Storm control provides protection against excessive inbound BUM (broadcast, unknown unicast, multicast) traffic on layer 2 switch port interfaces, which can cause poor network performance.
-
-<HR STYLE="BORDER: DASHED RGB(118,185,0) 0.5PX;BACKGROUND-COLOR: RGB(118,185,0);HEIGHT: 4.0PX;"/>
-
 ## <h>nv set interface \<interface-id\> storm-control broadcast</h>
 
 Configures the number of broadcast packets per second (pps) that signifies a broadcast storm. You can set a value between 1 and 4294967295.