diff --git a/content/cumulus-linux-510/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md b/content/cumulus-linux-510/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md index cfcdfe5551..19d115208e 100644 --- a/content/cumulus-linux-510/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md +++ b/content/cumulus-linux-510/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md @@ -366,7 +366,7 @@ NVUE manages the following configuration files: ## Search for a Specific Configuration -To search for a specific portion of the NVUE configuration, run the `nv config find ` command. The search shows all items above and below the search string. For example, to search the entire NVUE object model configuration for any mention of `ptm`: +To search for a specific portion of the NVUE configuration, run the `nv config find ` command. The search shows all items above and below the search string. For example, to search the entire NVUE object model configuration for any mention of `bond1`: ``` cumulus@switch:~$ nv config find bond1 diff --git a/content/cumulus-linux-511/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md b/content/cumulus-linux-511/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md index cc4cba411f..6b192ec287 100644 --- a/content/cumulus-linux-511/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md +++ b/content/cumulus-linux-511/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md @@ -121,8 +121,8 @@ The `nv set` and `nv unset` commands are in the following categories. Each comma | `nv set platform`
`nv unset platform`| Configures Pulse per Second; the simplest form of synchronization for the physical hardware clock.| | `nv set qos`
`nv unset qos` | Configures QoS RoCE. | | `nv set router`
`nv unset router` | Configures router policies (prefix list rules and route maps), sets global BGP options (enable and disable, ASN and router ID, BGP graceful restart and shutdown), global OSPF options (enable and disable, router ID, and OSPF timers) PIM, IGMP, PBR, VRR, and VRRP. | -| `nv set service`
`nv unset service` | Configures DHCP relays and servers, NTP, PTP, LLDP, SNMP servers, DNS, and syslog. | -| `nv set system`
`nv unset system` | Configures system settings, such as the hostname of the switch, pre and post login messages, reboot options (warm, cold, fast), the time zone and global system settings, such as the anycast ID, the system MAC address, and the anycast MAC address. This is also where you configure SPAN and ERSPAN sessions, telemetry, and set how configuration apply operations work (which files to ignore and which files to overwrite; see {{}}).| +| `nv set service`
`nv unset service` | Configures DHCP relays and servers, NTP, PTP, LLDP, DNS, and syslog. | +| `nv set system`
`nv unset system` | Configures system settings, such as the hostname of the switch, pre and post login messages, reboot options (warm, cold, fast), the time zone and global system settings, such as the anycast ID, the system MAC address, and the anycast MAC address. This is also where you configure SNMP, SPAN and ERSPAN sessions, telemetry, and set how configuration apply operations work (which files to ignore and which files to overwrite; see {{}}).| | `nv set vrf `
`nv unset vrf ` | Configures VRFs. This is where you configure VRF-level configuration for PTP, BGP, OSPF, and EVPN. | ### Monitoring Commands @@ -142,7 +142,7 @@ The NVUE monitoring commands show various parts of the network configuration. Fo | `nv show qos` | Shows QoS RoCE configuration.| | `nv show router` | Shows router configuration, such as router policies, global BGP and OSPF configuration, PBR, PIM, IGMP, VRR, and VRRP configuration. | | `nv show service` | Shows DHCP relays and server, NTP, PTP, LLDP, and syslog configuration. | -| `nv show system` | Shows global system settings, such as the reserved routing table range for PBR and the reserved VLAN range for layer 3 VNIs. You can also see system login messages and switch reboot history. | +| `nv show system` | Shows global system settings. | | `nv show system version` | Shows the Cumulus Linux release running on the switch.| | `nv show vrf` | Shows VRF configuration.| @@ -150,31 +150,30 @@ The following example shows the `nv show router` commands after pressing the tab ``` cumulus@leaf01:mgmt:~$ nv show router <> -adaptive-routing igmp ospf pim ptm vrrp -bgp nexthop pbr policy vrr +adaptive-routing igmp pbr ptm +bgp nexthop pim vrr +graceful-restart ospf policy vrrp cumulus@leaf01:mgmt:~$ nv show router bgp - operational applied pending ------------------------------- ----------- ------- ----------- ---------------------------------------------------------------------- - applied pending ------------------------------- ----------- ----------- -enable on on -autonomous-system 65101 65101 -router-id 10.10.10.1 10.10.10.1 -policy-update-timer 5 5 -graceful-shutdown off off -wait-for-install off off -graceful-restart - mode helper-only helper-only - restart-time 120 120 - path-selection-deferral-time 360 360 - stale-routes-time 360 360 -convergence-wait - time 0 0 - establish-wait-time 0 0 -queue-limit - input 10000 10000 - output 10000 10000 + applied +------------------------------ ----------- +enable on +autonomous-system 65101 +router-id 10.10.10.1 +policy-update-timer 5 +graceful-shutdown off +wait-for-install off +graceful-restart + mode helper-only + restart-time 120 + path-selection-deferral-time 360 + stale-routes-time 360 +convergence-wait + time 0 + establish-wait-time 0 +queue-limit + input 10000 + output 10000 ``` {{%notice note%}} @@ -365,7 +364,7 @@ NVUE manages the following configuration files: ## Search for a Specific Configuration -To search for a specific portion of the NVUE configuration, run the `nv config find ` command. The search shows all items above and below the search string. For example, to search the entire NVUE object model configuration for any mention of `ptm`: +To search for a specific portion of the NVUE configuration, run the `nv config find ` command. The search shows all items above and below the search string. For example, to search the entire NVUE object model configuration for any mention of `bond1`: ``` cumulus@switch:~$ nv config find bond1 diff --git a/content/cumulus-linux-512/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md b/content/cumulus-linux-512/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md index 61635847e8..1e40b71b54 100644 --- a/content/cumulus-linux-512/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md +++ b/content/cumulus-linux-512/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md @@ -41,10 +41,10 @@ cumulus@switch:~$ nv set interface swp1 link state ? down The interface is not ready up The interface is ready cumulus@switch:~$ nv set interface swp1 link mtu ? - (integer:552 - 9216) + Interface MTU (default:9216 | integer:552 - 9216) cumulus@switch:~$ nv set interface swp1 link speed ? - (string | enum:10M, 100M, 1G, 10G, 25G, 40G, 50G, 100G, - 200G, 400G, 800G, auto) + Link speed (default:auto | enum:auto, 10M, 100M, 1G, 10G, 25G, + 40G, 50G, 100G, 200G, 400G, 800G | string) ``` NVUE also indicates if you need to provide specific values for the command: @@ -62,9 +62,9 @@ If the command you type is ambiguous, NVUE shows the reason for the ambiguity so ``` cumulus@switch:~$ nv s i -Ambiguous Command: - set interface - show interface +Error: Ambiguous Command: + set interface + show interface ``` ## Command Help @@ -77,13 +77,13 @@ usage: nv [options] set interface Description: - interface Update all interfaces. Provide single interface or multiple interfaces using ranging (e.g. swp1-2,5-6 -> swp1,swp2,swp5,swp6). + interface Update all interfaces. Provide single interface or multiple interfaces using ranging (e.g. swp1-2,5-6 -> swp1,swp2,swp5,swp6). Identifiers: - Interface (interface-name) + Interface (interface-name) General Options: - -h, --help Show help. + -h, --help Show help. ``` ## Command List @@ -121,8 +121,8 @@ The `nv set` and `nv unset` commands are in the following categories. Each comma | `nv set platform`
`nv unset platform`| Configures Pulse per Second; the simplest form of synchronization for the physical hardware clock.| | `nv set qos`
`nv unset qos` | Configures QoS RoCE. | | `nv set router`
`nv unset router` | Configures router policies (prefix list rules and route maps), sets global BGP options (enable and disable, ASN and router ID, BGP graceful restart and shutdown), global OSPF options (enable and disable, router ID, and OSPF timers) PIM, IGMP, PBR, VRR, and VRRP. | -| `nv set service`
`nv unset service` | Configures DHCP relays and servers, NTP, PTP, LLDP, SNMP servers, DNS, and syslog. | -| `nv set system`
`nv unset system` | Configures system settings, such as the hostname of the switch, pre and post login messages, reboot options (warm, cold, fast), the time zone and global system settings, such as the anycast ID, the system MAC address, and the anycast MAC address. This is also where you configure SPAN and ERSPAN sessions, telemetry, and set how configuration apply operations work (which files to ignore and which files to overwrite; see {{}}).| +| `nv set service`
`nv unset service` | Configures DHCP relays and servers, NTP, PTP, LLDP, DNS, and syslog. | +| `nv set system`
`nv unset system` | Configures system settings, such as the hostname of the switch, pre and post login messages, reboot options (warm, cold, fast), the time zone and global system settings, such as the anycast ID, the system MAC address, and the anycast MAC address. This is also where you configure SNMP, SPAN and ERSPAN sessions, telemetry, and set how configuration apply operations work (which files to ignore and which files to overwrite; see {{}}).| | `nv set vrf `
`nv unset vrf ` | Configures VRFs. This is where you configure VRF-level configuration for PTP, BGP, OSPF, and EVPN. | ### Monitoring Commands @@ -142,39 +142,37 @@ The NVUE monitoring commands show various parts of the network configuration. Fo | `nv show qos` | Shows QoS RoCE configuration.| | `nv show router` | Shows router configuration, such as router policies, global BGP and OSPF configuration, PBR, PIM, IGMP, VRR, and VRRP configuration. | | `nv show service` | Shows DHCP relays and server, NTP, PTP, LLDP, and syslog configuration. | -| `nv show system` | Shows global system settings, such as the reserved routing table range for PBR and the reserved VLAN range for layer 3 VNIs. You can also see system login messages and switch reboot history. | -| `nv show system version` | Shows the Cumulus Linux release running on the switch.| +| `nv show system` | Shows system settings. | | `nv show vrf` | Shows VRF configuration.| The following example shows the `nv show router` commands after pressing the tab key, then shows the output of the `nv show router bgp` command. ``` cumulus@leaf01:mgmt:~$ nv show router <> -adaptive-routing igmp ospf pim ptm vrrp -bgp nexthop pbr policy vrr +adaptive-routing igmp pbr ptm +bgp nexthop pim vrr +graceful-restart ospf policy vrrp cumulus@leaf01:mgmt:~$ nv show router bgp - operational applied pending ------------------------------- ----------- ------- ----------- ---------------------------------------------------------------------- - applied pending ------------------------------- ----------- ----------- -enable on on -autonomous-system 65101 65101 -router-id 10.10.10.1 10.10.10.1 -policy-update-timer 5 5 -graceful-shutdown off off -wait-for-install off off -graceful-restart - mode helper-only helper-only - restart-time 120 120 - path-selection-deferral-time 360 360 - stale-routes-time 360 360 -convergence-wait - time 0 0 - establish-wait-time 0 0 -queue-limit - input 10000 10000 - output 10000 10000 + applied +------------------------------ ----------- +enable on +autonomous-system 65101 +router-id 10.10.10.1 +policy-update-timer 5 +graceful-shutdown off +wait-for-install off +graceful-restart + mode helper-only + restart-time 120 + path-selection-deferral-time 360 + stale-routes-time 360 +convergence-wait + time 0 + establish-wait-time 0 +queue-limit + input 10000 + output 10000 ``` {{%notice note%}} @@ -191,13 +189,13 @@ Additional options are available for certain `nv show` commands. For example, yo | `--filter` | Filters show command output on column data. For example, the `nv show interface --filter mtu=1500` shows only the interfaces with MTU set to 1500. For more information, see {{}} below.| | `--hostname`| Shows system configuration for the switch with the specified hostname. For example, `nv show --hostname leaf01`.| | `--operational` | Shows the running configuration (the actual system state). For example, `nv show interface swp1 --operational` shows the running configuration for swp1. The running and applied configuration should be the same. If different, inspect the logs. | -| `--output` | Shows command output in table (`auto`), `json`, `yaml` or plain text (`raw`) format, such as vtysh native output. For example:
`nv show interface bond1 --output auto`
`nv show interface bond1 --output json`
`nv show interface bond1 --output yaml`
`nv show router bgp -output raw`| +| `--output` | Shows command output in table (`auto`), `json`, or `yaml` format. For example:
`nv show interface bond1 --output auto`
`nv show interface bond1 --output json`
`nv show interface bond1 --output yaml`| | `--paginate` | Paginates the output. For example, `nv show interface bond1 --paginate on`. | | `--pending` | Shows the last applied configuration and any pending set or unset configuration that you have not yet applied. For example, `nv show interface bond1 --pending`.| | `--rev `| Shows a detached pending configuration. See the `nv config detach` configuration management command below. For example, `nv show --rev 1`. You can also show only applied or only operational information in the `nv show` output. For example, to show only the applied settings for swp1 configuration, run the `nv show interface swp1 --rev=applied` command. To show only the operational settings for swp1 configuration, run the `nv show interface swp1 --rev=operational` command. | -| `--startup` | Shows configuration saved with the `nv config apply` command. This is the configuration after the switch boots. For example: `nv show interface --startup.`| +| `--startup` | Shows configuration saved with the `nv config apply` command. This is the configuration after the switch boots. For example: `nv show interface --startup`.| | `--tab`| Show information in tab format. For example, `nv show interface swp1 --tab.`| -| `--view` | Shows different views. A view is a subset of information provided by certain `nv show` commands. To see the views available for an `nv show` command, run the command with `--view` and press TAB.| +| `--view` | Shows different views. A view is a subset of information provided by certain `nv show` commands. To see the views available for an `nv show` command, run the command with `--view` and press TAB (for example `nv show interface --view`).| The following example shows *pending* BGP graceful restart configuration: @@ -215,10 +213,11 @@ The following example shows the views available for the `nv show interface` comm ``` cumulus@switch:~$ nv show interface --view <> -acl-statistics carrier-stats dot1x-counters lldp-detail physical status vrf -bond-members counters dot1x-summary mac port-security svi -bonds description down mlag-cc qos-profile synce-counters -brief detail lldp neighbor small up +acl-statistics counters down neighbor small vrf +bond-members description lldp physical status +bonds detail lldp-detail port-security svi +brief dot1x-counters mac qos-profile synce-counters +carrier-stats dot1x-summary mlag-cc rates up ``` ### Configuration Management Commands @@ -227,7 +226,7 @@ The NVUE configuration management commands manage and apply configurations. |
Command | Description | | ------- | ----------- | -| `nv config apply` | Saves the pending configuration (`nv config apply`) or a specific revision (`nv config apply 2`) to the startup configuration automatically (when auto save is `on`, which is the default setting). To see the list of revisions you can apply, run `nv config apply <>`.
You can also use these prompt options:
  • `--y` or `--assume-yes` to automatically reply `yes` to all prompts.
  • `--assume-no` to automatically reply `no` to all prompts.
You can also use these apply options:
`--confirm` applies the configuration change but you must confirm the applied configuration. If you do not confirm within ten minutes, the configuration rolls back automatically. You can change the default time with the apply `--confirm