Skip to main content
Version: 5.4.0

Auto-Correction Validation

After subscribing to events, use the procedures in this page to validate that auto-correction is working in Bridge. Auto-correction automatically rectifies network configuration changes to maintain compliance with the desired configuration.

What Auto-Correction Addresses

  • Link Down — Interface failure
  • BGP — BGP configuration changes (IP deletion)
  • ConfigDiff — Configuration file modifications (for example, frr.conf updates)
  • NetQ Agent Status — Switch reboot or shutdown

Prerequisites

  • NetQ server onboarding — A NetQ server must be onboarded in Bridge.
  • Event subscription — The relevant events must be subscribed before running each validation scenario.
note

When a validation scenario triggers a configuration change on a switch, open and resolved events appear on the Events panel on the Dashboard. You must add the Events panel manually before running validation — see Add Events Panel to Dashboard.

Add Events Panel to Dashboard

The Events panel must be added manually to the Dashboard before you can verify auto-correction events.

  1. In the sidebar, click Dashboard.
  2. Click Edit Dashboard.

Dashboard — Edit Dashboard

  1. Click Add widgets.

Dashboard — Add widgets

  1. Select Events, then select the Events dashboard widget.
  2. Click Update Dashboard.

Dashboard — Add Events widget

  1. The Events panel appears on the Dashboard.

Dashboard — Events panel

note

Ensure that you have subscribed to the Link Down event before proceeding.

Auto-correction — Link Down

  1. Log in to a switch device:

    ssh <username>@<switch-hostname>

    Example:

    ssh cumulus@leaf-pod00-su01-r1
  2. Retrieve interface information:

    ip a
  3. Bring down an interface:

    sudo ip link set <interface> down

    Example:

    sudo ip link set swp1 down
  4. Verify the result:

    • The interface state shows as Down.
    • Bridge auto-corrects the Link Down event.
    • Open and resolved events appear on the Events Panel in the Dashboard sidebar.

Auto-correction — Link Down events

Validate BGP State Change Event

note

Ensure that you have subscribed to the BGP event before proceeding.

Auto-correction — BGP

  1. Log in to a switch device:

    ssh cumulus@leaf-pod00-su01-r1
  2. Retrieve interface information:

    ip a
  3. Unset the IP address of an interface (excluding 172.x.x.x addresses):

    nv unset interface <interface> ip address
    nv config apply

    Example:

    nv unset interface swp68 ip address
    nv config apply
  4. Verify the result:

    • The IP address is removed from the unset interface.
    • Bridge auto-corrects the BGP session state change event.
    • Open and resolved events appear on the Events Panel in the Dashboard sidebar.
note

When changes are made on the switch, the ConfigDiff event may also appear, indicating that the configuration was modified and corrected.

Auto-correction — BGP events

Validate ConfigDiff Event

note

Ensure that you have subscribed to the ConfigDiff event before proceeding.

Auto-correction — ConfigDiff

Scenario 1: Create a VRF

  1. Log in to a switch device:

    ssh <username>@<switch-hostname>

    Example:

    ssh cumulus@leaf-pod00-su01-r1
  2. Create a VRF to generate ConfigDiff events:

    nv set vrf <vrf_name>
    nv config apply

    Example:

    nv set vrf test-config
    nv config apply
  3. Verify VRF creation:

    nv show vrf

    Auto-correction — ConfigDiff VRF

  4. Verify the result:

    • The newly created VRF (for example, test-config) is auto-corrected (deleted) by Bridge.
    • An open state event appears on the Events Panel in the Dashboard sidebar.
note

When a VRF is created, a virtual interface is also created on the switch. This triggers both Link Down and ConfigDiff events.

Auto-correction — ConfigDiff VRF events

Scenario 2: Delete frr.conf

  1. Log in to a switch device:

    ssh <username>@<switch-hostname>

    Example:

    ssh cumulus@leaf-pod00-su01-r1
  2. Switch to the root user:

    sudo su
  3. Delete the frr.conf file to generate ConfigDiff errors:

    rm /etc/frr/frr.conf
  4. Verify the result:

    • Bridge auto-corrects the ConfigDiff error event.
    • The deleted frr.conf file is recreated automatically.
    • ConfigDiff Error and ConfigDiff Info events (indicating that frr.conf has been restored) appear on the Events Panel.

Auto-correction — ConfigDiff frr.conf

Validate NetQ Agent Status Event

note

Ensure that you have subscribed to the NetQ Agent Status event before proceeding.

Auto-correction — NetQ Agent Status

  1. Log in to a switch device:

    ssh <username>@<switch-hostname>

    Example:

    ssh cumulus@leaf-pod00-su01-r1
  2. Reboot the switch to generate a NetQ Agent info event:

    sudo reboot
  3. After the switch comes back up, log in again and shut down the switch to generate a NetQ Agent error event:

    sudo shutdown -h now
    note

    Shutting down the switch takes it offline. Power the switch back on before running additional validation scenarios.

  4. Verify that the Events dashboard shows the events as illustrated below.

Auto-correction — NetQ Agent events

Auto-correction — NetQ Agent events detail

Next Steps