Update openconfig-bgp-common.yang to support ExRR #1319

sachendras · 2025-06-19T17:10:24Z

Support for extended route retention (ERR) which is an extension to graceful restart.

Scope of Change:
This pull request introduces a new feature to the OpenConfig BGP model called BGP Extended Route Retention (ExRR). This feature provides a mechanism for a BGP speaker to retain stale routes from a failed peer for a long, configurable duration, independent of standard Graceful Restart timers.

The core of this feature is a flexible, policy-driven approach. Key changes include:

A new bgp-extended-route-retention-config grouping is added to openconfig-bgp-common.yang . This grouping includes new configuration leaves such as:
- enabled: To activate or deactivate the feature.
- retention-time: A configurable timer for how long stale routes are held .
- retention-policy: A leaflist that allows an operator to apply an ordered chain of routing policies to stale routes.
- default-retention-policy: An explicit control for the default action (accept or reject) for routes that do not match the policy chain.
A new bgp-extended-route-retention-state grouping is added to provide operational state, including extended-retention-active to indicate if the feature is active and remaining-retention-time to show the time left before routes are purged.
The description clarifies that this feature is distinct from the IETF's Long-Lived Graceful Restart (LLGR, RFC 9494) because ExRR is a purely local behavior that does not require BGP capability negotiation .
These new configuration and state capabilities have been added to the BGP model at the global, peer-group, and neighbor levels to allow for flexible application.

Current vendor implementations

Arista_ExRR_Implementation
Juniper_Implementation: Search for Extended-Route-Retention)
Cisco implementation: search for BGP Extended Route Retention

Snippet of different proposals below

Path: network-instances/network-instance/protocols/protocol/bgp/global/graceful-restart

module: openconfig-network-instance
  +--rw graceful-restart
     +--rw config
     |  +--rw enabled?            boolean
     |  +--rw restart-time?       uint16
     |  +--rw stale-routes-time?  decimal64
     |  +--rw helper-enabled?     boolean
     +--ro state
     |  +--ro enabled?            boolean
     |  +--ro restart-time?       uint16
     |  +--ro stale-routes-time?  decimal64
     |  +--ro helper-enabled?     boolean
     |  +--ro local-restarting?   boolean
     |  +--ro peer-restarting?    boolean
     |  +--ro peer-restart-time?  uint16
     |  +--ro mode?               identityref
     +--rw extended-route-retention
        +--rw config
        |  +--rw enabled?                      boolean
        |  +--rw retention-time?               uint32
        |  +--rw retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
        |  +--rw default-retention-policy?     oc-pol-types:default-policy-type
        +--ro state
           +--ro enabled?                      boolean
           +--ro retention-time?               uint32
           +--ro retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
           +--ro default-retention-policy?     oc-pol-types:default-policy-type
           +--ro extended-retention-active?    boolean
           +--ro remaining-retention-time?     uint32

Pat: network-instances/network-instance/protocols/protocol/bgp/global/afi-safis/afi-safi/graceful-restart

module: openconfig-network-instance
  +--rw graceful-restart
     +--rw config
     |  +--rw enabled?            boolean
     |  +--rw restart-time?       uint16
     |  +--rw stale-routes-time?  decimal64
     |  +--rw helper-enabled?     boolean
     +--ro state
     |  +--ro enabled?            boolean
     |  +--ro restart-time?       uint16
     |  +--ro stale-routes-time?  decimal64
     |  +--ro helper-enabled?     boolean
     |  +--ro local-restarting?   boolean
     |  +--ro peer-restarting?    boolean
     |  +--ro peer-restart-time?  uint16
     |  +--ro mode?               identityref
     +--rw extended-route-retention
        +--rw config
        |  +--rw enabled?                      boolean
        |  +--rw retention-time?               uint32
        |  +--rw retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
        |  +--rw default-retention-policy?     oc-pol-types:default-policy-type
        +--ro state
           +--ro enabled?                      boolean
           +--ro retention-time?               uint32
           +--ro retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
           +--ro default-retention-policy?     oc-pol-types:default-policy-type
           +--ro extended-retention-active?    boolean
           +--ro remaining-retention-time?     uint32

Path: network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/graceful-restart

module: openconfig-network-instance
  +--rw graceful-restart
     +--rw config
     |  +--rw enabled?            boolean
     |  +--rw restart-time?       uint16
     |  +--rw stale-routes-time?  decimal64
     |  +--rw helper-enabled?     boolean
     +--ro state
     |  +--ro enabled?            boolean
     |  +--ro restart-time?       uint16
     |  +--ro stale-routes-time?  decimal64
     |  +--ro helper-enabled?     boolean
     |  +--ro local-restarting?   boolean
     |  +--ro peer-restarting?    boolean
     |  +--ro peer-restart-time?  uint16
     |  +--ro mode?               identityref
     +--rw extended-route-retention
        +--rw config
        |  +--rw enabled?                      boolean
        |  +--rw retention-time?               uint32
        |  +--rw retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
        |  +--rw default-retention-policy?     oc-pol-types:default-policy-type
        +--ro state
           +--ro enabled?                      boolean
           +--ro retention-time?               uint32
           +--ro retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
           +--ro default-retention-policy?     oc-pol-types:default-policy-type
           +--ro extended-retention-active?    boolean
           +--ro remaining-retention-time?     uint32

Path: network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/afi-safis/afi-safi/graceful-restart

module: openconfig-network-instance
  +--rw graceful-restart
     +--rw config
     |  +--rw enabled?            boolean
     |  +--rw restart-time?       uint16
     |  +--rw stale-routes-time?  decimal64
     |  +--rw helper-enabled?     boolean
     +--ro state
     |  +--ro enabled?            boolean
     |  +--ro restart-time?       uint16
     |  +--ro stale-routes-time?  decimal64
     |  +--ro helper-enabled?     boolean
     |  +--ro local-restarting?   boolean
     |  +--ro peer-restarting?    boolean
     |  +--ro peer-restart-time?  uint16
     |  +--ro mode?               identityref
     +--rw extended-route-retention
        +--rw config
        |  +--rw enabled?                      boolean
        |  +--rw retention-time?               uint32
        |  +--rw retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
        |  +--rw default-retention-policy?     oc-pol-types:default-policy-type
        +--ro state
           +--ro enabled?                      boolean
           +--ro retention-time?               uint32
           +--ro retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
           +--ro default-retention-policy?     oc-pol-types:default-policy-type
           +--ro extended-retention-active?    boolean
           +--ro remaining-retention-time?     uint32

Path: network-instances/network-instance/protocols/protocol/bgp/peer-groups/peer-group/graceful-restart

module: openconfig-network-instance
  +--rw graceful-restart
     +--rw config
     |  +--rw enabled?            boolean
     |  +--rw restart-time?       uint16
     |  +--rw stale-routes-time?  decimal64
     |  +--rw helper-enabled?     boolean
     +--ro state
     |  +--ro enabled?            boolean
     |  +--ro restart-time?       uint16
     |  +--ro stale-routes-time?  decimal64
     |  +--ro helper-enabled?     boolean
     |  +--ro local-restarting?   boolean
     |  +--ro peer-restarting?    boolean
     |  +--ro peer-restart-time?  uint16
     |  +--ro mode?               identityref
     +--rw extended-route-retention
        +--rw config
        |  +--rw enabled?                      boolean
        |  +--rw retention-time?               uint32
        |  +--rw retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
        |  +--rw default-retention-policy?     oc-pol-types:default-policy-type
        +--ro state
           +--ro enabled?                      boolean
           +--ro retention-time?               uint32
           +--ro retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
           +--ro default-retention-policy?     oc-pol-types:default-policy-type
           +--ro extended-retention-active?    boolean
           +--ro remaining-retention-time?     uint32

Path: network-instances/network-instance/protocols/protocol/bgp/peer-groups/peer-group/afi-safis/afi-safi/graceful-restart

module: openconfig-network-instance
  +--rw graceful-restart
     +--rw config
     |  +--rw enabled?            boolean
     |  +--rw restart-time?       uint16
     |  +--rw stale-routes-time?  decimal64
     |  +--rw helper-enabled?     boolean
     +--ro state
     |  +--ro enabled?            boolean
     |  +--ro restart-time?       uint16
     |  +--ro stale-routes-time?  decimal64
     |  +--ro helper-enabled?     boolean
     |  +--ro local-restarting?   boolean
     |  +--ro peer-restarting?    boolean
     |  +--ro peer-restart-time?  uint16
     |  +--ro mode?               identityref
     +--rw extended-route-retention
        +--rw config
        |  +--rw enabled?                      boolean
        |  +--rw retention-time?               uint32
        |  +--rw retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
        |  +--rw default-retention-policy?     oc-pol-types:default-policy-type
        +--ro state
           +--ro enabled?                      boolean
           +--ro retention-time?               uint32
           +--ro retention-policy*             -> /oc-rpol:routing-policy/policy-definitions/policy-definition/name
           +--ro default-retention-policy?     oc-pol-types:

Support for extended route retention (ERR)

Added container for extended-route-retention under container graceful-restart.

Update for ERR support

Update for ERR addition.

Update for ERR addition

Update for ERR addition.

Indentation fix

Added ERR under AFI section of Global BGP config

ERR definition at Neighbor level and Neighbor AFI/SAFI level.

Added ERR under AFI/SAFI level

Indentation cleanup

release/models/bgp/openconfig-bgp-common-multiprotocol.yang

dplore

Is this the same thing as https://datatracker.ietf.org/doc/html/rfc9494 ? If so, please modify naming and add a reference to rfc9494 similar to other OC models which reference RFCs

release/models/bgp/openconfig-bgp-common.yang

dplore · 2025-06-20T19:06:08Z

/gcbrun

OpenConfigBot · 2025-06-20T19:07:52Z

No major YANG version changes in commit a154667

release/models/bgp/openconfig-bgp-common.yang

release/models/bgp/openconfig-bgp-global.yang

release/models/bgp/openconfig-bgp-common.yang

rszarecki · 2025-06-24T02:12:04Z

Is this the same thing as https://datatracker.ietf.org/doc/html/rfc9494 ? If so, please modify naming and add a reference to rfc9494 similar to other OC models which reference RFCs

No. This is DIFFERENT then RFC9494. It is non device local behaviour.

 The Extended Route Retention (ExRR) is different then IETF Long-Lived
    Graceful Restart (RFC 9494). The fundamental differences are:
    - The ERR process stale routes via additional policy, as statead above.
    - The ERR is purly local behaviour of GR reciving speaker (helper). There
    is no BGP capability exchanges and negotiated. This allows enable and
    use ERR on one side of session, when other side may do not support ERR";

rszarecki · 2025-06-24T02:24:07Z

@sachendras

Can we use "ExRR" or "XRR" instead of "ERR". ERR sounds like ERROR...
Can you add tree view to description ? following will render tree:
pyang -f tree -p ./release/models/*/* --tree-path="network-instances/network-instance/protocols/protocol/bgp/global/graceful-restart"
pyang -f tree -p ./release/models/*/* --tree-path="network-instances/network-instance/protocols/protocol/bgp/global/afi-safis/afi-safi/graceful-restart"
pyang -f tree -p ./release/models/*/* --tree-path="network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/graceful-restart"
pyang -f tree -p ./release/models/*/* --tree-path="network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/afi-safis/afi-safi/graceful-restart"
pyang -f tree -p ./release/models/*/* --tree-path="network-instances/network-instance/protocols/protocol/bgp/peer-groups/peer-group/graceful-restart"
pyang -f tree -p ./release/models/*/* --tree-path="network-instances/network-instance/protocols/protocol/bgp/peer-groups/peer-group/afi-safis/afi-safi/graceful-restart"
Please add vendor implementation references:
Arista

Updating from 9.9.2 to 9.10.0

9.9.2 to 9.10.0

Addressing comments: - Enable policy chaining: The retention-policy node is changed from a leaf to a leaflist to allow an operator to apply an ordered chain of multiple routing policies - Add Explicit and Reusable Default Policy: Is reusing the existing oc-pol-types:default-policy-type - Add Operational State for ERR

Updated to include "bgp-extended-route-retention-state"

Update to include bgp-extended-route-retention-state;

Updates to include bgp-extended-route-retention-state for state.

ERR --> ExRR

release/models/bgp/openconfig-bgp-common.yang

rszarecki · 2025-06-24T14:24:59Z

/gcbrun

Updated ERR --> ExRR

modified line on LLGR based on review feedback

Correction to remaining-retention-time with more clarity

dplore · 2025-06-26T19:04:01Z

/gcbrun

rszarecki · 2025-06-26T22:20:13Z

           +--ro extended-retention-active?    boolean
           +--ro remaining-retention-time?     uint32

are meaningfull only under neighbor and neighor/afi-safi.

retention-time? uint32 is 2^32/3600/24 = 49 days ; I think this is too little.

i description tree for Path: network-instances/network-instance/protocols/protocol/bgp/peer-groups/peer-group/afi-safis/afi-safi/graceful-restart - the last one, seems to be incomplete.

Update openconfig-bgp-common.yang

2540dd3

Support for extended route retention (ERR)

sachendras requested a review from a team as a code owner June 19, 2025 17:10

github-project-automation bot added this to OC Operator Review Jun 19, 2025

sachendras added 12 commits June 19, 2025 11:04

Update openconfig-bgp-global.yang

25fbcd6

Added container for extended-route-retention under container graceful-restart.

Update openconfig-bgp-peer-group.yang

6994d95

Update for ERR support

Update openconfig-bgp-neighbor.yang

a09266e

Update for ERR support

Update openconfig-bgp-common-multiprotocol.yang

7e5a929

Update for ERR addition.

Update openconfig-bgp-common-structure.yang

058a4eb

Update for ERR addition

Update openconfig-bgp.yang

a0aefb3

Update for ERR addition.

Update openconfig-bgp-common.yang

c811832

Indentation fix

Update openconfig-bgp-global.yang

9ecb6fb

Added ERR under AFI section of Global BGP config

Update openconfig-bgp-neighbor.yang

10a92ab

ERR definition at Neighbor level and Neighbor AFI/SAFI level.

Update openconfig-bgp-common.yang

41efe7e

Update openconfig-bgp-peer-group.yang

6721108

Added ERR under AFI/SAFI level

Update openconfig-bgp-peer-group.yang

1624821

Indentation cleanup

sachendras mentioned this pull request Jun 19, 2025

RT-1.35: BGP Graceful Restart Extended route retention (ExRR) openconfig/featureprofiles#3474

Merged

earies reviewed Jun 20, 2025

View reviewed changes

release/models/bgp/openconfig-bgp-common-multiprotocol.yang Outdated Show resolved Hide resolved

dplore reviewed Jun 20, 2025

View reviewed changes

release/models/bgp/openconfig-bgp-common.yang Show resolved Hide resolved

OpenConfigBot added the non-breaking label Jun 20, 2025

rszarecki requested changes Jun 24, 2025

View reviewed changes

sachendras added 6 commits June 23, 2025 19:41

Update openconfig-bgp-common-multiprotocol.yang

972d3ed

Updating from 9.9.2 to 9.10.0

Update openconfig-bgp-common-structure.yang

9de36e7

9.9.2 to 9.10.0

Update openconfig-bgp-common.yang

e943dc4

9.9.2 to 9.10.0

Update openconfig-bgp-global.yang

9cf7fa9

9.9.2 to 9.10.0

Update openconfig-bgp-neighbor.yang

be2623e

9.9.2 to 9.10.0

Update openconfig-bgp-peer-group.yang

e4b39ba

9.9.2 to 9.10.0

sachendras added 11 commits June 23, 2025 19:46

Update openconfig-bgp.yang

427c3b1

9.9.2 to 9.10.0

Update openconfig-bgp-global.yang

a09d22f

Updated to include "bgp-extended-route-retention-state"

Update openconfig-bgp-neighbor.yang

fa0d80d

Update to include bgp-extended-route-retention-state;

Update openconfig-bgp-peer-group.yang

39f5228

Updates to include bgp-extended-route-retention-state for state.

Update openconfig-bgp-common-multiprotocol.yang

92294b2

ERR --> ExRR

Update openconfig-bgp-common-structure.yang

f701b87

ERR --> ExRR

Update openconfig-bgp-common.yang

ec5a1ae

ERR --> ExRR

Update openconfig-bgp-neighbor.yang

c3e5c34

ERR --> ExRR

Update openconfig-bgp-peer-group.yang

104a044

ERR --> ExRR

Update openconfig-bgp.yang

2b54149

ERR --> ExRR

rszarecki reviewed Jun 24, 2025

View reviewed changes

release/models/bgp/openconfig-bgp-common.yang Outdated Show resolved Hide resolved

sachendras changed the title ~~Update openconfig-bgp-common.yang to support ERR~~ Update openconfig-bgp-common.yang to support ExRR Jun 24, 2025

sachendras added 4 commits June 24, 2025 17:40

Update openconfig-bgp-common.yang

7315711

Updated ERR --> ExRR

Update openconfig-bgp-common.yang

7346e09

modified line on LLGR based on review feedback

Update openconfig-bgp-common.yang

d8b6476

Correction to remaining-retention-time with more clarity

Merge branch 'master' into patch-11

a154667

dplore moved this to Ready to discuss in OC Operator Review Jun 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update openconfig-bgp-common.yang to support ExRR #1319

Update openconfig-bgp-common.yang to support ExRR #1319

Uh oh!

sachendras commented Jun 19, 2025 •

edited

Loading

Uh oh!

Uh oh!

dplore left a comment

Uh oh!

Uh oh!

dplore commented Jun 20, 2025

Uh oh!

OpenConfigBot commented Jun 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rszarecki commented Jun 24, 2025

Uh oh!

rszarecki commented Jun 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

rszarecki commented Jun 24, 2025

Uh oh!

dplore commented Jun 26, 2025

Uh oh!

rszarecki commented Jun 26, 2025

Uh oh!

Uh oh!

Update openconfig-bgp-common.yang to support ExRR #1319

Are you sure you want to change the base?

Update openconfig-bgp-common.yang to support ExRR #1319

Uh oh!

Conversation

sachendras commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

dplore left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dplore commented Jun 20, 2025

Uh oh!

OpenConfigBot commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rszarecki commented Jun 24, 2025

Uh oh!

rszarecki commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

rszarecki commented Jun 24, 2025

Uh oh!

dplore commented Jun 26, 2025

Uh oh!

rszarecki commented Jun 26, 2025

Uh oh!

Uh oh!

sachendras commented Jun 19, 2025 •

edited

Loading

OpenConfigBot commented Jun 20, 2025 •

edited

Loading

rszarecki commented Jun 24, 2025 •

edited

Loading