From 76e3366ee0302a9908228dbf0d08ed2217883cd7 Mon Sep 17 00:00:00 2001 From: "Alexandr K." Date: Thu, 16 Apr 2026 16:21:38 +0300 Subject: config-sync: T7784: Add command to diff configuration with secondary node (#1808) Add information about a new operational command which compares configuration between nodes participating in config synchronization. --- docs/configuration/service/config-sync.rst | 45 ++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) (limited to 'docs') diff --git a/docs/configuration/service/config-sync.rst b/docs/configuration/service/config-sync.rst index 4ea7a240..a8984a0d 100644 --- a/docs/configuration/service/config-sync.rst +++ b/docs/configuration/service/config-sync.rst @@ -58,6 +58,51 @@ Configuration vpn vrf +Operational Commands +-------------------- + +.. opcmd:: show configuration secondary sync [commands] [running | candidate | saved] [] + + Display configuration differences between the local node and + a config-sync secondary node. + + This command allows operators to compare configurations across nodes + participating in configuration synchronization (e.g., primary and + secondary routers). It helps detect configuration drift and validate + intended changes before synchronization. + + **Parameters:** + + .. list-table:: + :widths: 30 70 + :header-rows: 0 + + * - ``commands`` (optional) + - Show output as a list of configuration commands instead of raw diff. + * - ``running|candidate|saved`` (optional, mutually exclusive) + - Select which configuration to compare: + ``running`` (current active configuration, default), + ``candidate`` (uncommitted changes), or + ``saved`` (last saved configuration). Only one of these may be + specified at a time; if omitted, ``running`` is used. + + **Examples:** + + .. code-block:: none + + # compare full running configuration with a secondary node + show configuration secondary sync + + # compare only interface configuration + show configuration secondary sync running interfaces dummy + + # compare candidate configuration and display as a list of commands + show configuration secondary sync commands candidate + +Without a built-in cross-node diff, operators may unintentionally push +changes that conflict with the remote configuration (e.g., mismatched +interfaces, firewall policies, or protocol settings). + Example ------- * Synchronize the time-zone and OSPF configuration from Router A to Router B -- cgit v1.2.3