[yang] Extended sonic-bmp.yang YANG model to include BMP collector(s) and policies by kalash-nexthop · Pull Request #24965 · sonic-net/sonic-buildimage

kalash-nexthop · 2026-01-02T23:32:05Z

Currently SONiC doesn't allow configuring external BMP collector, and instead relies on hard-coded local BMP collector config with only pre-policy support. Making this generic so that a user can set potentially multiple external collectors with multiple policies, as FRR already supports this.

Instead of just creating a PR with yang model, I added the vtysh cmd conversion stuff to this PR, so that I can demonstrate the model and corresponding vtysh config that's already supported in FRR.

fixes #24962
Link to HLD: sonic-net/SONiC#2366

Why I did it

Currently SONiC doesn't allow configuring external BMP collector, and instead relies on hard-coded local BMP collector config with only pre-policy support. But some customers want to use external collectors with both pre and post policy config.

Work item tracking

Microsoft ADO (number only):

How I did it

1- Extended sonic-bmp.yang YANG model to include BMP collector (potentially multiple collectors) configuration parameters: IP, port, stats interval, retry intervals, monitor policies.
2- The new yang model is similar to FRR's bmp yang model, but instead of using nested lists, it does below (3) so that SONiC's yang parser doesn't complain.
3- The model to allow multiple targets and collectors is similar to how BGP_NEIGHBOR container block is used for defining the neighbors, and then another BGP_NEIGHBOR_AF container to define afi-safis on those neighbors. I've verified that yang validation works for this.
4- Updated unified/separated mode templates (bgpd.conf.db.j2 and bgpd.main.conf.j2) to use BMP configuration from CONFIG_DB with fallback to default values
5- Added BMP handler in frrcfgd.py to dynamically convert CONFIG_DB BMP changes to vtysh commands for runtime configuration updates
6- Supports multiple configurable monitor policies per target: pre-policy, post-policy, loc-rib
7- Default collector IP is 127.0.0.1 when not specified to maintain backward compatibility

A sample yang model based on the new changes, showing multiple targets, multiple collectors per target, multiple afi-safis per target and multiple policies per afi-safi:

{
    "BMP_TARGET": {
        "production": {
            "mirror": "true",
            "stats-interval": "5000"
        },
        "monitoring": {
            "mirror": "false",
            "stats-interval": "10000"
        },
        "backup": {
            "mirror": "true",
            "stats-interval": "3000"
        }
    },
    "BMP_TARGET_COLLECTOR": {
        "production|192.168.1.100|5000": {
            "min-retry": "30000",
            "max-retry": "720000"
        },
        "production|192.168.1.101|5001": {
            "min-retry": "20000",
            "max-retry": "600000"
        },
        "monitoring|10.0.0.50|6000": {
            "min-retry": "15000",
            "max-retry": "300000"
        },
        "monitoring|10.0.0.51|6001": {
            "min-retry": "15000",
            "max-retry": "300000"
        },
        "backup|172.16.0.10|7000": {
            "min-retry": "10000",
            "max-retry": "180000"
        }
    },
    "BMP_TARGET_AFI_SAFI": {
        "production|ipv4_unicast": {
            "adj-rib-in-pre": "true",
            "adj-rib-in-post": "true",
            "loc-rib": "true"
        },
        "production|ipv6_unicast": {
            "adj-rib-in-pre": "true",
            "adj-rib-in-post": "false",
            "loc-rib": "true"
        },
        "production|l2vpn_evpn": {
            "adj-rib-in-pre": "false",
            "adj-rib-in-post": "true",
            "loc-rib": "false"
        },
        "monitoring|ipv4_unicast": {
            "adj-rib-in-pre": "true",
            "adj-rib-in-post": "false",
            "loc-rib": "false"
        },
        "monitoring|ipv6_unicast": {
            "adj-rib-in-pre": "true",
            "adj-rib-in-post": "false",
            "loc-rib": "false"
        },
        "backup|ipv4_unicast": {
            "adj-rib-in-pre": "true",
            "adj-rib-in-post": "true",
            "loc-rib": "true"
        }
    }
}

And corresponding vtysh commands in vtysh -c "show running-config"

router bgp 65100
 !
 bmp targets production
  bmp stats interval 5000
  bmp mirror
  bmp monitor ipv4 unicast pre-policy
  bmp monitor ipv4 unicast post-policy
  bmp monitor ipv4 unicast loc-rib
  bmp monitor ipv6 unicast pre-policy
  bmp monitor ipv6 unicast loc-rib
  bmp monitor l2vpn evpn post-policy
  bmp connect 192.168.1.100 port 5000 min-retry 30000 max-retry 720000
  bmp connect 192.168.1.101 port 5001 min-retry 20000 max-retry 600000
 exit
 !
 bmp targets monitoring
  bmp stats interval 10000
  bmp monitor ipv4 unicast pre-policy
  bmp monitor ipv6 unicast pre-policy
  bmp connect 10.0.0.50 port 6000 min-retry 15000 max-retry 300000
  bmp connect 10.0.0.51 port 6001 min-retry 15000 max-retry 300000
 exit
 !
 bmp targets backup
  bmp stats interval 3000
  bmp mirror
  bmp monitor ipv4 unicast pre-policy
  bmp monitor ipv4 unicast post-policy
  bmp monitor ipv4 unicast loc-rib
  bmp connect 172.16.0.10 port 7000 min-retry 10000 max-retry 180000
 exit
 !
exit
!

How to verify it

Manually verified the generated vtysh config for above yang model in config_db.json in both separated and unified mode by doing config reload.
Manually verified the dynamic vtysh config generation by frrcfgd.py for above
Manually verified that config reload as well as config replace don't complain of yang validation failure for above model.

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

mssonicbld · 2026-01-02T23:32:12Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-02T23:32:24Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-02T23:37:13Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-02T23:37:23Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-03T00:28:52Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-03T00:29:05Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-05T19:11:57Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-05T19:12:08Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-06T03:50:30Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-06T03:50:40Z

Azure Pipelines successfully started running 1 pipeline(s).

…ially multiple collectors) configuration parameters: IP, port, stats interval, retry intervals, monitor policies. - Updated unified/separated mode templates (bgpd.conf.db.j2 and bgpd.main.conf.j2) to use BMP configuration from CONFIG_DB with fallback to default values - Added BMP handler in frrcfgd.py to dynamically convert CONFIG_DB BMP changes to vtysh commands for runtime configuration updates - Supports multiple configurable monitor policies per target: pre-policy, post-policy, loc-rib - Default collector IP is 127.0.0.1 when not specified to maintain backward compatibility Signed-off-by: Kalash Nainwal <kalash@nexthop.ai>

mssonicbld · 2026-01-06T03:53:15Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-06T03:53:26Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-06T17:22:46Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-06T17:22:59Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-06T22:58:08Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-06T22:58:20Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-07T20:31:03Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-07T20:31:18Z

Azure Pipelines successfully started running 1 pipeline(s).

Brad's commit c833bde (sonic-net#26587) rephrased the BMP table-dump descriptions into the "BGP Monitoring Protocol (BMP) ... configuration." and "Enable or disable ..." voice. Keep the rest of the BMP YANG consistent with that style: - Replace "<CONTAINER> part of config_db.json" with proper "<purpose> configuration." descriptions for BMP_TARGET, BMP_TARGET_COLLECTOR, and BMP_TARGET_AFI_SAFI. - Reword boolean leaves (mirror, adj-rib-in-pre/post, loc-rib) to the "Enable or disable ..." pattern. - Tighten leafref / numeric leaves to describe purpose rather than just restating the field name. - Add trailing periods to enum descriptions and the 2026-01-02 revision note for consistency. - Expand the afi-safi-type typedef description to spell out AFI/SAFI. No functional/schema changes; descriptions only. Signed-off-by: Kalash Nainwal <kalash@nexthop.ai>

mssonicbld · 2026-04-21T23:52:57Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-04-21T23:53:08Z

Azure Pipelines successfully started running 1 pipeline(s).

kalash-nexthop · 2026-04-21T23:53:56Z

Hi @kalash-nexthop, the pipeline cannot be triggered since the branch has conflicts with the master branch. Could you please resolve the conflicts first in order to trigger the pipelines? Thanks

Hi @yijingyan2 , Done.

yxieca · 2026-04-22T23:14:38Z

/azpw ms_conflict

yxieca · 2026-04-23T03:12:27Z

/azpw ms_conflict

Replace the raw string type (length 1..64) with the canonical sonic-types interface_name typedef (length 1..15, per IFNAMSIZ from <net/if.h>). Matches the convention already used by sonic-loopback-interface.yang, sonic-vrf.yang, and sonic-smart-switch.yang. No frrcfgd / template / test changes: the CONFIG_DB key is still `source-interface` and any valid interface name that passed the old 1..64 bound also passes 1..15 (real interface names are at most 15 chars). Signed-off-by: Kalash Nainwal <kalash@nexthop.ai>

mssonicbld · 2026-04-23T19:00:34Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-04-23T19:00:46Z

Azure Pipelines successfully started running 1 pipeline(s).

yxieca · 2026-04-23T19:12:18Z

/azpw ms_conflict

yxieca · 2026-04-24T23:07:26Z

/azpw ms_conflict

yxieca · 2026-04-28T23:17:32Z

/azpw ms_conflict

yxieca · 2026-04-30T03:18:00Z

/azpw ms_conflict

yxieca · 2026-05-04T19:12:02Z

/azpw ms_conflict

yxieca · 2026-05-05T19:12:32Z

/azpw ms_conflict

mssonicbld · 2026-05-06T19:58:14Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-05-06T19:58:29Z

Azure Pipelines successfully started running 1 pipeline(s).

kalash-nexthop · 2026-05-07T00:16:15Z

/azpw run

mssonicbld · 2026-05-07T00:16:18Z

⚠️ Notice: /azpw run only runs failed jobs now. If you want to trigger a whole pipline run, please rebase your branch or close and reopen the PR.
💡 Tip: You can also use /azpw retry to retry failed jobs directly.

Retrying failed(or canceled) jobs...

mssonicbld · 2026-05-07T00:16:20Z

No failed(or canceled) jobs found in completed stages. Only failed(or canceled) jobs in completed stages can be retried.

Stages in progress: Build, BuildVS. Please wait for the stages to complete and then retry again.

@patch

…ection The merge from upstream/master pulled in test_bgp_neighbor_description_injection but its two decorator lines @patch.dict('sys.modules', **mockmapping) @patch('frrcfgd.frrcfgd.g_run_command') were lost in the conflict resolution, so pytest collection failed with "fixture 'run_cmd' not found". Add them back to match the master copy. No functional change. Signed-off-by: Kalash Nainwal <kalash@nexthop.ai>

mssonicbld · 2026-05-07T16:07:23Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-05-07T16:07:47Z

Azure Pipelines successfully started running 1 pipeline(s).

kalash-nexthop · 2026-05-08T03:18:10Z

/azpw run

mssonicbld · 2026-05-08T03:19:00Z

⚠️ Notice: /azpw run only runs failed jobs now. If you want to trigger a whole pipline run, please rebase your branch or close and reopen the PR.
💡 Tip: You can also use /azpw retry to retry failed jobs directly.

Retrying failed(or canceled) jobs...

mssonicbld · 2026-05-08T03:19:02Z

Retrying failed(or canceled) stages in build 1107866:

✅Stage Test:

Job Trivy vulnerability scan (docker-ptf): retried.
Job impacted-area-kvmtest-t2 by Elastictest: retried.

yxieca · 2026-05-11T23:08:43Z

/azpw ms_conflict

yxieca · 2026-05-13T03:15:48Z

/azpw ms_conflict

kalash-nexthop requested review from lguohan and qiluo-msft as code owners January 2, 2026 23:32

kalash-nexthop force-pushed the bmp-configurable branch from 935a389 to 6db007d Compare January 2, 2026 23:37

kalash-nexthop force-pushed the bmp-configurable branch from 6db007d to 97eab6c Compare January 3, 2026 00:28

kalash-nexthop force-pushed the bmp-configurable branch from 97eab6c to 7c47bfa Compare January 5, 2026 19:11

kalash-nexthop force-pushed the bmp-configurable branch from 7c47bfa to 0dc9ea0 Compare January 6, 2026 03:50

kalash-nexthop force-pushed the bmp-configurable branch from 0dc9ea0 to 920abdc Compare January 6, 2026 03:53

Merge branch 'master' into bmp-configurable

fb17fa7

Merge branch 'master' into bmp-configurable

fbaf568

Merge branch 'master' into bmp-configurable

90eec33

Merge branch 'master' into bmp-configurable

406e683

Merge branch 'master' into bmp-configurable

ab1c0da

kalash-nexthop mentioned this pull request Jun 5, 2026

BMP External Collector Support in SONiC sonic-net/SONiC#2366

Open

Conversation

kalash-nexthop commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why I did it

Work item tracking

How I did it

How to verify it

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Uh oh!

mssonicbld commented Jan 2, 2026

Uh oh!

azure-pipelines Bot commented Jan 2, 2026

Uh oh!

mssonicbld commented Jan 2, 2026

Uh oh!

azure-pipelines Bot commented Jan 2, 2026

Uh oh!

mssonicbld commented Jan 3, 2026

Uh oh!

azure-pipelines Bot commented Jan 3, 2026

Uh oh!

mssonicbld commented Jan 5, 2026

Uh oh!

azure-pipelines Bot commented Jan 5, 2026

Uh oh!

mssonicbld commented Jan 6, 2026

Uh oh!

azure-pipelines Bot commented Jan 6, 2026

Uh oh!

mssonicbld commented Jan 6, 2026

Uh oh!

azure-pipelines Bot commented Jan 6, 2026

Uh oh!

mssonicbld commented Jan 6, 2026

Uh oh!

azure-pipelines Bot commented Jan 6, 2026

Uh oh!

mssonicbld commented Jan 6, 2026

Uh oh!

azure-pipelines Bot commented Jan 6, 2026

Uh oh!

mssonicbld commented Jan 7, 2026

Uh oh!

azure-pipelines Bot commented Jan 7, 2026

Uh oh!

mssonicbld commented Apr 21, 2026

Uh oh!

azure-pipelines Bot commented Apr 21, 2026

Uh oh!

kalash-nexthop commented Apr 21, 2026

Uh oh!

yxieca commented Apr 22, 2026

Uh oh!

yxieca commented Apr 23, 2026

Uh oh!

mssonicbld commented Apr 23, 2026

Uh oh!

azure-pipelines Bot commented Apr 23, 2026

Uh oh!

yxieca commented Apr 23, 2026

Uh oh!

yxieca commented Apr 24, 2026

Uh oh!

yxieca commented Apr 28, 2026

Uh oh!

yxieca commented Apr 30, 2026

Uh oh!

yxieca commented May 4, 2026

Uh oh!

yxieca commented May 5, 2026

Uh oh!

mssonicbld commented May 6, 2026

Uh oh!

azure-pipelines Bot commented May 6, 2026

Uh oh!

kalash-nexthop commented May 7, 2026

kalash-nexthop commented Jan 2, 2026 •

edited

Loading