Skip to content

Commit 989197e

Browse files
committed
doc: add information on ospf debug settings
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
1 parent c0646d1 commit 989197e

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

doc/networking.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,6 +1502,48 @@ routes`.
15021502

15031503
admin@example:/>
15041504

1505+
For more detailed troubleshooting, OSPF debug logging can be enabled to
1506+
capture specific protocol events. Debug messages are written to the
1507+
routing log file (`/var/log/routing`).
1508+
1509+
> [!CAUTION]
1510+
> Debug logging significantly increases log output and may impact
1511+
> performance. Only enable debug categories needed for troubleshooting,
1512+
> and disable them when done.
1513+
1514+
To enable specific OSPF debug categories:
1515+
1516+
admin@example:/> configure
1517+
admin@example:/config/> edit routing control-plane-protocol ospfv2 name default ospf debug
1518+
admin@example:/config/routing/…/ospf/debug/> set bfd true
1519+
admin@example:/config/routing/…/ospf/debug/> set nsm true
1520+
admin@example:/config/routing/…/ospf/debug/> leave
1521+
admin@example:/>
1522+
1523+
Available debug categories include:
1524+
1525+
- `bfd`: BFD (Bidirectional Forwarding Detection) events
1526+
- `packet`: Detailed packet debugging (all OSPF packets)
1527+
- `ism`: Interface State Machine events
1528+
- `nsm`: Neighbor State Machine events
1529+
- `default-information`: Default route origination
1530+
- `nssa`: Not-So-Stubby Area events
1531+
1532+
All debug options are disabled by default. Refer to the `infix-routing`
1533+
YANG model for the complete list of available debug options.
1534+
1535+
To view current debug settings:
1536+
1537+
admin@example:/> show running-config routing control-plane-protocol
1538+
1539+
To disable all debug logging, simply delete the debug settings or set
1540+
all options back to `false`:
1541+
1542+
admin@example:/> configure
1543+
admin@example:/config/> delete routing control-plane-protocol ospfv2 name default ospf debug
1544+
admin@example:/config/> leave
1545+
admin@example:/>
1546+
15051547

15061548
### View routing table
15071549

0 commit comments

Comments
 (0)