Add BGP Monitoring Protocol (BMP) support #1283

ihebboubaker · 2025-04-22T13:47:44Z

Add BGP Monitoring Protocol (BMP) Model

Change Scope

• This PR adds a new YANG model for BGP Monitoring Protocol (BMP) as defined in RFC 7854. The model provides configuration and operational state for BMP at global, neighbor, and peer-group levels with support for AFI-SAFI granularity.

• This change is backwards compatible as it only adds new nodes through augmentation of the existing BGP model without modifying any existing structures.

Platform Implementations

Juniper: Juniper BMP Configuration Guide

Implementation output:

  routing-options {
      bmp {
           tcp-keepalive {
              idle-time-before-probe 5;
              probe-count 1;
              probe-interval 5;
          }
          station collector1 {
              connection-mode active;
              local-address 192.0.2.1;
              station-address 203.0.113.5;
              station-port 7039;
              route-monitoring pre-policy;
          }
      }
  }

Arista: Arista EOS BMP Configuration Guide

Implementation output:

router bgp 65000
 monitoring station collector1
   update-source Loopback0
   connection mode active port 7039
   connection address 203.0.113.5
   connection keepalive 5 1 5
   statistics 60

Additional Information

The BMP model includes support for:

Global BMP configuration
BMP monitoring stations with AFI-SAFI granularity
Station groups for managing multiple collectors
TCP keepalive settings
Route monitoring policy configuration
Message counters for operational state
Per-neighbor and per-peer-group BMP configuration

earies · 2025-04-22T19:06:50Z

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

+    "This module defines configuration and operational state data for
+    BGP Monitoring Protocol (BMP) as defined in RFC 7854.";
+
+  oc-ext:openconfig-version "9.9.0";


Is a new module proposed here (which is not a submodule) thus start the versioning at 0.1.0

earies · 2025-04-22T19:07:22Z

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

+
+    leaf idle-time {
+      type uint16;
+      description


units seconds;

earies · 2025-04-22T19:07:39Z

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

+    leaf probe-interval {
+      type uint16;
+      description
+        "The time in seconds between TCP keepalive probes";


units seconds;

earies · 2025-04-22T19:08:32Z

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

+    }
+  }
+
+  grouping bmp-tcp-keepalive-state {


The same grouping can be reused for config/state (reflection) vs. redefining each node again

earies · 2025-04-22T19:09:19Z

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

+    description
+      "Operational state parameters for BMP monitoring of specific AFI-SAFIs";
+
+    leaf afi-safi-name {


Same comment as above re: duplication.

earies · 2025-04-22T19:10:05Z

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

+
+    leaf uptime {
+      type uint64;
+      description


units seconds;

Recommend using this type for all the timestamp leaves:

type oc-types:timeticks64;

earies · 2025-04-22T19:10:57Z

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

+    }
+
+    leaf flap-count {
+      type uint32;


Suggested change

type uint32;

type uint32;

type oc-yang:counter32;

Likely colocate under a counters container

earies · 2025-04-22T19:11:31Z

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

+          "Total number of BMP messages sent to this station";
+      }
+
+      leaf statistics {


Suggest better name as this indicates "sent" messages

earies · 2025-04-22T19:12:41Z

release/models/bgp/openconfig-bgp.yang

@@ -68,7 +68,14 @@ module openconfig-bgp {
    whereas leaf not present inherits its value from the leaf present
    at the next higher level in the hierarchy.";

-  oc-ext:openconfig-version "9.8.0";
+  oc-ext:openconfig-version "9.9.0";


This model doesn't appear to need any edits at all - no version increment is needed

earies

After minor adjustments, the tree view looks as follows:

module: openconfig-bgp-bmp

  augment /oc-netinst:network-instances/oc-netinst:network-instance/oc-netinst:protocols/oc-netinst:protocol/oc-netinst:bgp/oc-netinst:global:
    +--rw bmp
       +--rw config
       |  +--rw enabled?              boolean
       |  +--rw connection-mode?      connection-mode-type
       |  +--rw local-address?        oc-inet:ip-address
       |  +--rw statistics-timeout?   uint16
       |  +--rw idle-time?            uint16
       |  +--rw probe-count?          uint8
       |  +--rw probe-interval?       uint16
       +--ro state
       |  +--ro enabled?              boolean
       |  +--ro connection-mode?      connection-mode-type
       |  +--ro local-address?        oc-inet:ip-address
       |  +--ro statistics-timeout?   uint16
       |  +--ro idle-time?            uint16
       |  +--ro probe-count?          uint8
       |  +--ro probe-interval?       uint16
       +--rw tcp-keepalive
       |  +--rw config
       |  |  +--rw idle-time?        uint16
       |  |  +--rw probe-count?      uint8
       |  |  +--rw probe-interval?   uint16
       |  +--ro state
       |     +--ro idle-time?        uint16
       |     +--ro probe-count?      uint8
       |     +--ro probe-interval?   uint16
       +--rw stations
       |  +--rw station* [name]
       |     +--rw name         string
       |     +--rw config
       |     |  +--rw address                 oc-inet:ip-address
       |     |  +--rw port?                   oc-inet:port-number
       |     |  +--rw policy-type?            route-monitoring-policy-type
       |     |  +--rw exclude-non-eligible?   boolean
       |     +--ro state
       |     |  +--ro address?                oc-inet:ip-address
       |     |  +--ro port?                   oc-inet:port-number
       |     |  +--ro connection-status?      connection-status-type
       |     |  +--ro uptime?                 uint64
       |     |  +--ro flap-count?             uint32
       |     |  +--ro message-counters
       |     |  |  +--ro total?              oc-yang:counter64
       |     |  |  +--ro statistics?         oc-yang:counter64
       |     |  |  +--ro route-monitoring?   oc-yang:counter64
       |     |  |  +--ro peer-monitoring?    oc-yang:counter64
       |     |  |  +--ro route-mirroring?    oc-yang:counter64
       |     |  +--ro policy-type?            route-monitoring-policy-type
       |     |  +--ro exclude-non-eligible?   boolean
       |     +--rw afi-safis
       |        +--rw afi-safi* [afi-safi-name]
       |           +--rw afi-safi-name    -> ../config/afi-safi-name
       |           +--rw config
       |           |  +--rw afi-safi-name?   identityref
       |           |  +--rw enabled?         boolean
       |           +--ro state
       |              +--ro afi-safi-name?                    identityref
       |              +--ro enabled?                          boolean
       |              +--ro route-monitoring-messages-sent?   uint64
       +--rw station-groups
       |  +--rw station-group* [name]
       |     +--rw name      string
       |     +--rw config
       |     |  +--rw station-names*   string
       |     +--ro state
       |        +--ro station-names*   string
       +--rw afi-safis
          +--rw afi-safi* [afi-safi-name]
             +--rw afi-safi-name    -> ../config/afi-safi-name
             +--rw config
             |  +--rw afi-safi-name?   identityref
             |  +--rw enabled?         boolean
             +--ro state
                +--ro afi-safi-name?                    identityref
                +--ro enabled?                          boolean
                +--ro route-monitoring-messages-sent?   uint64
  augment /oc-netinst:network-instances/oc-netinst:network-instance/oc-netinst:protocols/oc-netinst:protocol/oc-netinst:bgp/oc-netinst:neighbors/oc-netinst:neighbor:
    +--rw bmp
       +--rw config
       |  +--rw enabled?   boolean
       +--ro state
       |  +--ro enabled?   boolean
       +--rw afi-safis
          +--rw afi-safi* [afi-safi-name]
             +--rw afi-safi-name    -> ../config/afi-safi-name
             +--rw config
             |  +--rw afi-safi-name?   identityref
             |  +--rw enabled?         boolean
             +--ro state
                +--ro afi-safi-name?                    identityref
                +--ro enabled?                          boolean
                +--ro route-monitoring-messages-sent?   uint64
  augment /oc-netinst:network-instances/oc-netinst:network-instance/oc-netinst:protocols/oc-netinst:protocol/oc-netinst:bgp/oc-netinst:peer-groups/oc-netinst:peer-group:
    +--rw bmp
       +--rw config
       |  +--rw enabled?   boolean
       +--ro state
       |  +--ro enabled?   boolean
       +--rw afi-safis
          +--rw afi-safi* [afi-safi-name]
             +--rw afi-safi-name    -> ../config/afi-safi-name
             +--rw config
             |  +--rw afi-safi-name?   identityref
             |  +--rw enabled?         boolean
             +--ro state
                +--ro afi-safi-name?                    identityref
                +--ro enabled?                          boolean
                +--ro route-monitoring-messages-sent?   uint64

Some overall comments:

You are anchoring global BMP config/state inside a BGP protocol instance within a network-instance. I would question the association to a "protocol instance" here if this is necessary and also the NI anchor point vs. NI reference as seen in other "service" definitions (e.g. dial-out similar technologies)
List keys must be a leafref to subsequent ../config/ or ../state/ nodes (e.g. stations/station/name)
Am I missing where station-groups is of use? I believe I only see a definition but no reference/use

earies · 2025-04-24T23:25:50Z

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

+
+  prefix "oc-bgp-bmp";
+
+  import openconfig-bgp { prefix oc-bgp; }


This import is unused

earies · 2025-04-24T23:29:55Z

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

+
+    leaf-list station-names {
+      type leafref {
+        path "../../../stations/station/config/name";


leafref does not resolve

earies · 2025-04-24T23:30:06Z

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

+
+    leaf-list station-names {
+      type leafref {
+        path "../../../stations/station/config/name";


leafref does not resolve (do not duplicate groupings)

earies · 2025-04-24T23:31:06Z

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

+    uses bmp-route-monitoring-state;
+  }
+
+  grouping bmp-station-group-config {


You are defining a relative path leafref within a grouping. If the grouping is intended for reuse then it is subject to dependency hiearchies that sit at the same level anchor points

dplore · 2025-04-25T22:40:42Z

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

+
+    leaf uptime {
+      type uint64;
+      description


Recommend using this type for all the timestamp leaves:

type oc-types:timeticks64;

dplore · 2025-04-25T23:32:40Z

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

+    }
+
+    leaf flap-count {
+      type uint32;


dplore · 2025-04-29T16:38:35Z

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

+        to BMP servers or passively listens for connections";
+    }
+
+    leaf local-address {


Minor nit: In most OC models, we use 'source-address' for this leaf.

dplore · 2025-04-29T16:49:27Z

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

+    }
+  }
+
+  grouping bmp-afi-safi-config {


I don't see examples in the referenced implementations of being able to enable/disable BMP per afi/safi. Is this really needed? We should only model OC for the features we are actually using (or have an open, active feature request to use).

dplore · 2025-04-29T16:52:41Z

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

+    }
+  }
+
+  grouping bmp-station-config {


I think we probably need to have some support for the BMP station to be in a different network-instance than the BGP protocol. For example, we might have BGP in the DEFAULT network instance and a BMP station in a management network instance. This could be modeled by adding a 'network-instance' leaf to this grouping.

dplore · 2025-04-29T16:56:21Z

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

+      }
+    }
+
+    container station-groups {


In concept this seems ok, but is this really needed? For example, are we using this in production already? I don't see any example of this in the quoted implementation references?

dplore · 2025-04-29T16:57:37Z

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

+    uses bmp-tcp-keepalive-config;
+  }
+
+  grouping bmp-state {


as noted elsewhere, you can reuse the bmp-config grouping instead of defining an identical bmp-state grouping.

dplore · 2025-04-29T16:58:45Z

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

+  augment "/oc-netinst:network-instances/oc-netinst:network-instance/oc-netinst:protocols/oc-netinst:protocol/oc-netinst:bgp/oc-netinst:neighbors/oc-netinst:neighbor" {
+    description
+      "Augments BGP neighbor configuration with BMP parameters";
+    uses bmp-neighbor-top;
+  }
+
+  augment "/oc-netinst:network-instances/oc-netinst:network-instance/oc-netinst:protocols/oc-netinst:protocol/oc-netinst:bgp/oc-netinst:peer-groups/oc-netinst:peer-group" {
+    description
+      "Augments BGP peer-group configuration with BMP parameters";
+    uses bmp-neighbor-top;
+  }


I don't see peer-group and neighbor defined in the referenced implementations. How important is this?

dplore · 2025-05-13T16:32:50Z

/gcbrun

dplore · 2025-05-13T16:33:17Z

@ihebboubaker reviewed in May 13, 2025 OC operators meeting. Looking forward to your responses to the comments here.

OpenConfigBot · 2025-05-13T16:34:34Z

No major YANG version changes in commit 4c4f1f6

Add BGP Monitoring Protocol (BMP) support

4c4f1f6

ihebboubaker requested a review from a team as a code owner April 22, 2025 13:47

github-project-automation bot added this to OC Operator Review Apr 22, 2025

earies reviewed Apr 22, 2025

View reviewed changes

earies reviewed Apr 24, 2025

View reviewed changes

dplore requested changes Apr 25, 2025

View reviewed changes

dplore moved this to Ready to discuss in OC Operator Review Apr 25, 2025

dplore reviewed Apr 29, 2025

View reviewed changes

dplore moved this from Ready to discuss to Waiting for author in OC Operator Review May 13, 2025

OpenConfigBot added the non-breaking label May 13, 2025


		prefix "oc-bgp-bmp";

		import openconfig-bgp { prefix oc-bgp; }

Add BGP Monitoring Protocol (BMP) support #1283

Are you sure you want to change the base?

Add BGP Monitoring Protocol (BMP) support #1283

Uh oh!

Conversation

ihebboubaker commented Apr 22, 2025

Change Scope

Platform Implementations

Additional Information

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

earies left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dplore commented May 13, 2025

Uh oh!

dplore commented May 13, 2025

Uh oh!

OpenConfigBot commented May 13, 2025

Uh oh!

Uh oh!