BMP YANG ModuleNTT164-168, Carrer de NumanciaBarcelona08029Spaincamilo@ntt.netNTTSiriusdreef 70-72Hoofddorp2132Netherlandspaolo@ntt.netSwisscomBinzring 17Zurich 8045Switzerlandthomas.graf@swisscom.comHuaweibenoit.claise@huawei.comCiscoCessna Business Park SEZ, KadubeesanahalliBangaloreIndiadhpatki@cisco.comCiscoCessna Business Park SEZ, KadubeesanahalliBangaloreIndiasnprasad@cisco.com
OPS
GROW
This document proposes a YANG module for the configuration and monitoring of the BGP Monitoring Protocol (BMP).
The BGP Monitoring Protocol (BMP) provides a mechanism for
monitoring BGP sessions. This document defines a YANG data model
for BMP, enabling operators to configure and manage BMP sessions;
control the data exported to monitoring stations; and
collect statistics for each BMP session.
The model is designed to
accommodate both simple and advanced deployment scenarios,
supporting granular control over network instances, RIBs, address
families, and peers.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY", and "OPTIONAL" in this document are to be interpreted as
described in BCP 14
when, and only when, they appear in all capitals, as shown here.
Routing Information Bases, peers, monitoring stations, and
initiation messages are defined in .
This document specifies a YANG module for configuring and
monitoring the BGP Monitoring Protocol (BMP) on the monitored router. The model provides
parameters for configuring the session to BMP monitoring
stations; configuration of BMP messages; provides operational
metrics and enables resetting of BMP monitoring sessions.
The model is included in . In this
section, we provide details and examples of each of its parts.The BMP yang model is placed at the root of the YANG tree. At its
upper level, the BMP model lists each monitoring station. Every
monitoring station is identified by an ID, which is a string
provided by the operator. BMP allows for active and passive
connections between the router and the BMP monitoring station as described in . In
an active connection, the router establishes the TCP connection to
the monitoring station, while in a passive one, it is the monitoring
station which initiates the connection. The BMP YANG module
provides options for both types of connection using a choice.We describe each type of connection option next, and provide
examples of their configuration.For an active connection, the IP address and port of the monitoring
station, together with the local endpoint must be provided. The local
endpoint can be a local IP address or a source interface. One can
optionally provide the local port for establishing the connection.
If the monitoring station is connected over a network-instance
instead of the global one, this one must also be specified. An
example of configuration is included in .Active connection example1192.0.2.157992192.0.2.2
]]>Note in the example from
that there is no network instance defined, so the connection is
using the global network instance.In a passive connection, the IP of the monitoring station, the local endpoint, and the local port
for the incoming connection must be specified. If the port of the
monitoring station is provided, it must match the incoming
connection. If the monitoring station is connected through a
network-instance instead of the global one, this one must also be
specified.An incoming connection not matching a valid entry MUST be ignored by
the router. includes an example of
configuring a passive connection. In this example, we specify the
network-instance where we want to receive the connection.Passive connection examplemonitoring_station_twotest192.0.2.1192.0.2.2
57993
]]>The BMP module allows tuning various parameters of the TCP
connection supporting the BMP session:
The maximum segment size of the TCP connection. See .
Enabling MTU discovery for the path. See .
For configuring TCP keepalives, the connection container uses the tcp-common-grouping from . Note that the implementation must support module ietf-bmp-tcp-dependencies in addition to the main module to support these elements. Please see for the explanation of each of its parameters. The device must have the feature "tcp-client-keepalives" enabled. See also
Session security. Provides options for authentication using AO and MD5. This part of the model was taken from the BGP YANG model . This feature also requires support of the ietf-bmp-tcp-dependencies module.
Figures and include examples configuring the previous TCP parameters in the model.Example of configuring basic TCP parameters1192.0.2.157992192.0.2.2
153301500true
]]>Example of the Configuration of TCP session security.bmp-key-chainAn example of TCP-AO configuration for BMP
55aes-cmac-prf-1282023-01-01T00:00:00+00:00
2023-02-01T00:00:00+00:002023-01-01T00:00:00+00:00
2023-02-01T00:00:00+00:00teststringbmp-key-chain658756aes-cmac-prf-1282023-01-01T00:00:00+00:00
2023-02-01T00:00:00+00:002023-01-01T00:00:00+00:00
2023-02-01T00:00:00+00:00bmp-key-chain6587monitoring_station_one192.0.2.157992192.0.2.2
bmp-key-chain
]]>The model also includes the following options to configure the connection to the BMP monitoring station:
Initial-delay: a value in seconds that the device must wait before starting the connection to the station. An operator can use this delay to let BGP converge before starting the BMP session.
Backoff time: Configuration of the backoff time strategy after failing to connect to the monitoring station. The model includes a basic exponential backoff with a default initial backoff of 30 seconds and a maximum of 720 seconds, as suggested in .
In the example in , we configure an initial-delay of 10, an initial-backoff of 50 seconds and 600 of maximum-backoff.Example of the initial-delay and simple exponential backoff.1192.0.2.157992192.0.2.2
1050600
]]>The bmp-data container defines the configuration parameters for the data that the device sends to the monitoring station using BMP messages. See .The BMP model defines options for the initiation message, the statistics report, the route mirroring, and the route monitoring. The first three have simple configuration options and are described next. Route monitoring is the most complex and is detailed in .
Initiation-message: Content for an information TLV type-0 for identification of the device. See and
Statistics-interval: The statistics report is enabled by the presence of the statistics-report container. The statistics-interval is mandatory if the statistics-report container exists and defines the interval of the statistics report. See .
Route-mirroring: Route Mirroring messages serve as an exact replica of the messages received by the device. See . Enabling route mirroring messages towards a particular BMP monitoring station only requires the presence of the container "route-mirroring" within the monitoring station container.
An example of configuring the previous options is included in Example of configuration of initiation-message and statistics report interval.monitoring_station_one192.0.2.157992192.0.2.2
BMP device supporting the BMP yang modul\
e600
]]>Route monitoring messages are used for synchronization of RIBs to the monitoring station. See .The next 3 requirements were defined before designing this part of the model.
Operators might not want to receive all routes from all RIBs in a network device. For instance, some devices contain a considerable amount of data that might overwhelm the monitoring station. In these cases, operators might want to only collect information from an arbitrary subset of RIBs, address families, peers.
Operators might want to configure the route monitoring messages for different network instances differently. For example, they might want to receive different address families from the global network instance than in L3 VPN network instances.
In contrast to the previous points, some operators might want a simple configuration that covers multiple cases (e.g. same config for all peers, or same config for all network instances). This would not only make configurations look smaller and concise, but will reduce the need for reconfiguring devices when you add a new peer or add a new network instance (which happens frequently on some type of networks).
Based on the previous points, the BMP yang model is designed to flexibly control the data sent through the BMP route monitoring packets, yet it provides options to facilitate configurations for simple cases, such as when the operator wants to receive all routes from a RIB.The route monitoring configuration is divided in a four-part hierarchy:
Network Instance
RIB Type (e.g. Adj-RIB-IN pre/post, local RIB)
Address Family
Peers
Absence of the route monitoring container will disable the route monitoring messages to the monitoring station.We'll offer an introduction to these hierarchies before going over them with detail.The number of RIB types (e.g. Adj-RIB-IN/OUT, local RIB, etc) and Address families is low, and their configuration should not change frequently. Therefore, they are configured explicitly in the model. That is, the model does not provide a way of providing a default configuration for these or configuring them in groups.On the other hand, Network instances and peers require greater flexibility.For network instances, the model should configure not only the "global" network instance, but also other network instances. Also, network instances can change frequently in networks with customer connecting to Virtual Private Networks. To not force operators to change configuration at every change, the model provides methods for defining a "default" configuration for network instances. However, to provide control over the configuration, each network instance can be configured independently, if needed.A situation is similar with peers for the Adj-RIB-IN and Adj-RIB-OUT RIBs. The model includes a way of configuring a default for all peers for simple cases, but one can provide configuration for type of peers, peergroups, or each peer individually. We summarize the requirements stated on the previous two paragraphs next:For network instances:
The configuration should be simple for cases where only the "global" routing instance is enabled.
The model should provide ways of configuring all Network instances (kind of a default config for any Network instance that is configured in the device).
The model should provide a way of configuring network instances individually.
For peers:
The model should provide ways of configuring all peers, kind of a default. This would be the most common case.
The model should provide ways of configuring peergroups.
The model should provide ways of configuring type of peers. For instance, only send routes from eBGP peers.
The model should provide ways of configuring individual peers. For instance, an operator might apply a route-policy to filter certain prefixes for a specific peer, or disable route monitoring messages for a peer that is noisy yet not important.
To further control the route monitoring data, the peer container includes a route-policy option in which the operator can further filter the data send to the BMP monitoring station.We'll describe each of the 4 hierarchies, and provide examples for each, in the next sections.The route monitoring configuration starts with the configuration of network instances. A network instance can be configured individually, or it can be configured if it matches any of the selectors from the "bmp-ni-types" identity. We explain each next.The model currently defines three bmp-ni-types identities: "all-ni" which selects all network instances, "non-global-ni" which selects all network instances except the global one, and "global-ni", which configures the global network instance when the device does not offer an explicit name for it. The former can be used as a "default" configuration for simple cases.Network-instances are configured under the container "bmp/route-monitoring/network-instance".An empty configuration disables route monitoring messages for the selected network-instances. Operators can also use the "enable" leaf to disable explicitly the routing messages for the network instance. The route-monitoring data for a network instance can be configured by at most one element under the network-instance-configuration container. There SHOULD be clear rules for which element to apply to a network instance in case multiple elements can select it. We provide rules and examples in the next part of the section.The rules for selecting which element configures a network instance are presented next. Each point is evaluated only if the previous points do not hold.
If the name of the network instance is referenced in "network-instance-configuration/network-instances/network-instance", the network instance SHOULD be configured using this element.
If the selector 'global-ni' under the "network-instance-configuration/network-instance-selectors" exist, the global network instance SHOULD be configured using this element. Note that if a vendor has a name for the global network instance, the previous step (i.e, network instance name) will take priority over using the global-ni selector.
If the selector 'non-global-ni' under the "network-instance-configuration/network-instance-selectors" exist, any non-global network instance should be configured using its content.
Any Network instance not referenced by any rule above SHOULD be configured using the all-ni if one exists. If it does not exist, then the network instance is not configured (and therefore no route monitoring messages from the network instance are sent to the monitoring station).
Any extension of the bmp-ni-types SHOULD provide explanations of how to deal with case in which multiple elements select the same network instance. We provide examples of configuring the network instance level next. For now, we will focus on the configuration using the BMP container. To focus on the network instance configuration, we mask the configuration under each instance using "Configuration X". Examples of configuring the network instance level for Route Monitoring.monitoring_station_one192.0.2.157992192.0.2.2
all-niglobal-ninetwork-instance-twonetwork-instance-onefalse
]]>In example from , we have a "default" configuration (Configuration A) applied to any network instance without any explicit configuration. The global network instance and network-instance-two get Configuration B and Configuration C, respectively. The network-instance-one instance container disables the route monitoring messages for that network instance.Example of configuring all network instances.monitoring_station_one192.0.2.157992192.0.2.2
all-ni
]]>The example in shows a "simple" configuration. In this case, all network instances would get "Configuration D". Note that `all-ni` would also cover the global instance.Another simple configuration would just involve configuring the global network instance. In this case, information of non-global network instances would not be sent to the monitoring station. This is depicted in Example of configuring only the global network instance.monitoring_station_one192.0.2.157992192.0.2.2
global-ni
]]>Each RIB type is configured explicitly in the model through a container. The model currently provides containers for adj-rib-out-pre, adj-rib-out-post, adj-rib-in-post, adj-rib-in-pre and local-rib. An empty configuration or absence of a RIB-type container disables route-messages for it. Operators can also disable the route monitoring messages for each RIB explicitly by marking the "enabled" leaf as False.We provide an example of this, together with address families, in the next sectionAddress families are configured explicitly within each RIB type using a list. The key is of type `ietf-bgp-types:afi-safi-type` without any further constraint.An empty configuration or absence of an address family disables route-messages for it. Operators can also disable the address-family route monitoring messages by marking the "enabled" leaf as False.We show a few examples of configuring RIB-Types and Address families next. We will mask further configurations of address families with "Configuration X" to focus on the covered parts.Example of configuring RIBs and address families.monitoring_station_one192.0.2.157992192.0.2.2
all-niipv6-unicastipv4-unicastglobal-niipv6-unicastipv4-unicastipv6-unicastipv4-unicastnetwork-instance-onefalsenetwork-instance-twoipv4-unicast
]]>In , we expand previous sections examples with RIB-Type and address families configurations. The expected result of the previous configuration would be:
For the global network instance, adj-rib-in-pre and adj-rib-in-post RIBs are enabled. In each of them IPv4 and IPv6 address families are configured. The configuration can be the same or not, depending on the requirements of the operators. Any other RIB and address families are disabled.
Network instance "network-instance-one" is disabled, meaning that route monitoring messages are disabled for that network instance.
Network instance "network-instance-two" has adj-rib-out-post enabled, but only address family ipv4-unicast is configured. The ipv6-unicast will not be configured for this instance.
For all other network instances, adj-rib-in-pre with IPv4 and IPv6 address families are configured, thanks to the configuration of all-ni
If an operator only wants to configure the IPv4/IPv6 of adj-rib-pre-in for the global instance, the configuration in plus the peer configuration (coming in next section) will be enough. We note again that even if the configuration of both address families is the same, they must be explicitly configured for each of them.Example of configuring RIBs and address families.monitoring_station_one192.0.2.157992192.0.2.2
global-niipv6-unicastipv4-unicast
]]>For adj-RIB-in and adj-RIB-out, both pre and post, the model requires the selection of peer RIBs that will be transmitted to the monitoring station. The local-rib does not include this container.Peers can be configured using different "selectors", which can be one of the following:
An individual peer, using a remote address. For the configuration under the "/bmp" tree, the model currently does not check if the remote address exists, that would be a responsibility of the device.
Peergroups.
A group of peers matching a BGP type. i.e. eBGP peers.
One or more peers defined by an `bmp-peer-types` identity. The BMP model currently provides the `all-peers` identity which select all peers. For simple cases, this is the value that would normally be considered.
Peers MUST be selected (configured) by at most a single instance of the peers list. For the included keys in the BMP model, the process to select which instance to use is as follows:
If there is a peer address matching the peer, it should be configured using that instance.
If the peer matches a peergroup, it should be configured using the peer-group configuration.
If the peer is of any BGP type listed in the peer list, it should be configured using this instance.
If there is a peer instance identified with the `all-peers`, it would be configured using this instance.
Finally, if no instance covers the peer, route monitoring messages from this peer should not be transmitted to the monitoring station.
An empty configuration of a peer type disables route-messages for it. Operators can also disable the address-family route monitoring messages by marking the "enabled" leaf as False.Note that if an operator only wants the information of a few peers, it can enable them individually using their id. If no other configuration exists, only the messages from those enabled peers will be transmitted to the monitoring station.Any additional bmp-peer-types identity created SHOULD describe how to unambiguously select a peer when there are conflicting options (multiple options covering the peer).We'll provide examples of the peers configuration after describing the filter containers.The local rib, and the peer containers within the rest of rib types, include a filter container. This container includes mechanisms to filter route-monitoring messages for the specific RIB.The policy-filter can include a routing policy that, if existing, should be applied to the outgoing updates to the monitoring station, and would serve as a granular way of filtering the messages that the monitoring station receives. Note that the policy-filter contains an `accept-route` default export policy. An operator can change it to a reject-route, if required.The policies created with the routing-policy can perform a large variety of actions on routes, and can filter them based on multiple characteristics. For the consistency of the data in the monitoring station, the route policies actions MUST be restricted to accepting or rejecting routes. Furthermore, the conditions SHOULD only match prefix sets.We present examples of full configurations next.In the example configuration from , address families IPv6 and IPv4 are configured to send all peers from the global network instance. This is an example of a simple configurationEnabling Route monitoring for all peers in the global network instance; IPv4/IPv6 Address families, in the adj-rib-in-pre RIB.monitoring_station_one192.0.2.157992192.0.2.2
global-niipv6-unicastall-peersipv4-unicastall-peers
]]>In the example in , the global network instance enables the adj-rib-in-pre. In this RIB, the IPv4 unicast address family is configured for all external peers. We assume peer 198.51.100.1 is external, but its BGP configuration is not shown in the snippet. Peer 198.51.100.1, however, has a specific configuration: it announces everything but prefixes matching the test_policy list. Note that there is a default accept-route default policy in the model.Configuring address families differently for the global network instancetest_policymonitoring_station_one192.0.2.157992192.0.2.2
global-niipv6-unicastall-peersipv4-unicastexternal198.51.100.1test_policy
]]>In the example from , all network instances have adj-rib-in-pre with IPv6 and IPv4 configured receiving all peers. network-instance-one is disabled, and network-instance-two is announcing only the local-rib/IPv4 unicast routes.Applying a general configuration to all network instances, except of two, which are configured specifically.monitoring_station_one192.0.2.157992192.0.2.2
all-niipv6-unicastall-peersipv4-unicastall-peersnetwork-instance-onefalsenetwork-instance-twoipv4-unicast
]]>In the example from , we configure the device to only send to the monitoring_station_one monitoring station the Route monitoring messages for ipv4 and ipv6 from peers "198.51.100.1" and "198.51.100.2" in the adj-rib-in-pre policy.Sending just BGP messages from adj-rib-in-pre from 2 peersmonitoring_station_one192.0.2.157992192.0.2.2
global-niipv6-unicast198.51.100.1198.51.100.2ipv4-unicast198.51.100.1198.51.100.2
]]>The non-configurable container "session-stats" includes various metrics for the session with the monitoring station.The "session-reset" action resets a session with a monitoring station.To facilitate implementation, the model is divided into two
distinct parts. The core model (ietf-bmp) is designed to configure
BMP without deep dependencies to other modules. This
is an attempt to facilitate the implementation by vendors.Additionally, a supplementary module,
ietf-bmp-tcp-dependencies.yang,
enhances the model's functionality but rely on the IETF TCP
models. This module can be adopted by implementations that
support the dependency. file "ietf-bmp-tcp-dependencies.yang@2022-01-27.yang"
module ietf-bmp-tcp-dependencies {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bmp-tcp-dependencies";
prefix bmp-tcp;
import ietf-bmp {
prefix bmp;
}
import ietf-tcp-common {
prefix tcpcmn;
reference
"RFC 9643: YANG Groupings for TCP
Clients and TCP Servers.";
}
import ietf-key-chain {
prefix key-chain;
reference
"RFC 8177: YANG Key Chain.";
}
organization
"IETF GROW Working Group";
contact
"WG Web:
WG List:
Author: Camilo Cardona
Author: Paolo Lucente
Author: Thomas Graf
Author: Benoit Claise
";
description
"This module specifies a structure for BMP
(BGP Monitoring Protocol) configuration and monitoring.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2025 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.
";
revision 2025-01-02 {
description
"initial version";
reference
"RFC YYYY: BMP YANG Module
RFC-EDITOR: please update YYYY with this RFC ID";
}
augment "/bmp:bmp/bmp:monitoring-stations/"
+ "bmp:monitoring-station/"
+ "bmp:connection/bmp:tcp-options" {
description
"Augment the tcp options of the BMP model";
uses tcpcmn:tcp-common-grouping;
container secure-session {
presence "Means the session should be secure. ";
description
"Container for describing how a particular BMP session
is to be secured.";
choice authentication {
mandatory true;
description
"Choice of TCP authentication.";
case ao {
description
"Uses TCP-AO to secure the session. Parameters for
those are defined as a grouping in the TCP YANG
model.";
reference
"RFC 5925 - The TCP Authentication Option.";
leaf ao-keychain {
type key-chain:key-chain-ref;
description
"Reference to the key chain that will be used by
this model. Applicable for TCP-AO and TCP-MD5
only";
reference
"RFC 8177: YANG Key Chain.";
}
}
case md5 {
description
"Uses TCP-MD5 to secure the session. Parameters for
those are defined as a grouping in the TCP YANG
model.";
reference
"RFC 5925: The TCP Authentication Option.";
leaf md5-keychain {
type key-chain:key-chain-ref;
description
"Reference to the key chain that will be used by
this model. Applicable for TCP-AO and TCP-MD5
only";
reference
"RFC 8177: YANG Key Chain.";
}
}
}
}
}
}
]]>This section is modeled after the template described in Section
3.7.1 of . The ietf-bmp YANG module defines a data model that is designed to be
accessed via YANG-based management protocols, such as NETCONF
and RESTCONF . These
protocols have to use a secure transport layer (e.g., SSH , TLS , and QUIC
) and have to use mutual
authentication.
The Network Configuration Access Control Model (NACM)
provides the means to restrict access for particular NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF
or RESTCONF protocol operations and content.
There are a number of data nodes defined in this YANG module that
are writable/creatable/deletable (i.e., "config true", which is the
default). All writable data nodes are likely to be reasonably
sensitive or vulnerable in some network environments. Write
operations (e.g., edit-config) and delete operations to these data
nodes without proper protection or authentication can have a
negative effect on network operations.
There are no particularly sensitive writable data nodes.
Some of the readable data nodes in this YANG module may be
considered sensitive or vulnerable in some network environments. It
is thus important to control read access (e.g., via get,
get-config, or notification) to these data nodes.
There are no particularly sensitive readable data nodes.
Some of the RPC or action operations in this YANG module may be
considered sensitive or vulnerable in some network environments. It
is thus important to control access to these operations.
Specifically, the following operations have particular
sensitivities/ vulnerabilities:
The session-reset action can demand a considerable amount of resources
from network elements. It SHOULD thus be protected from unauthorized access.
This section is modeled after the template described in Section
3.7.1 of . The ietf-bmp-tcp-dependencies YANG module defines a data model that is designed to be
accessed via YANG-based management protocols, such as NETCONF
and RESTCONF . These
protocols have to use a secure transport layer (e.g., SSH , TLS , and QUIC
) and have to use mutual
authentication.
The Network Configuration Access Control Model (NACM)
provides the means to restrict access for particular NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF
or RESTCONF protocol operations and content.
There are a number of data nodes defined in this YANG module that
are writable/creatable/deletable (i.e., "config true", which is the
default). All writable data nodes are likely to be reasonably
sensitive or vulnerable in some network environments. Write
operations (e.g., edit-config) and delete operations to these data
nodes without proper protection or authentication can have a
negative effect on network operations.
There are no particularly sensitive writable data nodes.
Some of the readable data nodes in this YANG module may be
considered sensitive or vulnerable in some network environments. It
is thus important to control read access (e.g., via get,
get-config, or notification) to these data nodes.
There are no particularly sensitive readable data nodes.
This YANG module uses groupings from other YANG modules that
define nodes that may be considered sensitive or vulnerable in
network environments. Refer to the Security Considerations of
for information as to which nodes may be
considered sensitive or vulnerable in network environments.
IANA is requested to register the following URI in the "ns"
registry within the "IETF XML Registry" group :IANA is requested to register the following YANG module in the "YANG
Module Names" registry within the "YANG Parameters"
registry group.The security considerations section will have to be aligned with
https://trac.ietf.org/trac/ops/wiki/yang-security-guidelines
The following tree diagram provides an overview of the base ietf-bmp.yang
data model. It also includes the trees for the module ietf-bmp-tcp-dependencies.yang
that adds some options to the models in case the implementation supports this model (and their requisites)
file "ietf-bmp@2022-01-27.yang"
module ietf-bmp {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bmp";
prefix bmp;
import ietf-yang-types {
prefix yang;
}
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-netconf-acm {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
import ietf-routing-policy {
prefix rt-pol;
description
"This module is only needed if the feature
bmp-filter-based-on-route-policy is set";
reference
"RFC 9067: A YANG Data Model for Routing Policy";
}
import ietf-network-instance {
prefix ni;
reference
"RFC 8529: YANG Data Model for Network Instances";
}
import ietf-interfaces {
prefix if;
reference
"RFC 8343: A YANG Data Model for Interface Management";
}
organization
"IETF GROW Working Group";
contact
"WG Web:
WG List:
Author: Camilo Cardona
Author: Paolo Lucente
Author: Thomas Graf
Author: Benoit Claise
Author: Dhananjay Patki
Author: Prasad S. Narasimha
";
description
"This module defines a YANG data model for configuration and
monitoring of the BGP Monitoring Protocol (BMP).
Copyright (c) 2025 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.
";
revision 2025-01-02 {
description
"initial version";
reference
"RFC YYYY: BMP YANG Module
RFC-EDITOR: please update YYYY with this RFC ID";
}
feature bmp-filter-based-on-route-policy {
description
"This feature means that the device
is capable of filtering prefixes in BMP monitoring sessions";
}
/* The next enums are temporary here until we resolve how to deal
* with them. Taken from draft-ietf-idr-bgp-model */
/* BGP AFI-SAFI Type Identities. */
identity afi-safi-type {
description
"Base identity type for AFI,SAFI tuples for BGP-4";
reference
"RFC4760: Multiprotocol Extensions for BGP-4.";
}
identity ipv4-unicast {
base afi-safi-type;
description
"IPv4 unicast (AFI,SAFI = 1,1)";
reference
"RFC4760: Multiprotocol Extensions for BGP-4.";
}
identity ipv6-unicast {
base afi-safi-type;
description
"IPv6 unicast (AFI,SAFI = 2,1)";
reference
"RFC4760: Multiprotocol Extensions for BGP-4.";
}
/* End of temporal objects */
identity bmp-peer-selectors {
description
"Generic Identity for selecting peers";
}
identity all-peers {
base bmp-peer-selectors;
description
"This identity selects all peers under the RIB.
When used, it acts as a default configuration.";
}
identity bmp-ni-types {
description
"Identities for selecting one or more network instances for
configuration";
}
identity all-ni {
base bmp-ni-types;
description
"This identity is an explicit way
to select all network instances.";
}
identity global-ni {
base bmp-ni-types;
description
"Identity for Selecting the global or main network instance";
}
identity non-global-ni {
base bmp-ni-types;
description
"This identity is an explicit way
to select all network instances except the global one.";
}
/* The next types are temporary here until we resolve how to deal
* with them. Taken from draft-ietf-idr-bgp-model */
/* BGP Peer-Types */
typedef peer-type {
type enumeration {
enum internal {
description
"Internal (IBGP) peer";
}
enum external {
description
"External (EBGP) peer";
}
enum confederation-internal {
description
"Confederation Internal (IBGP) peer.";
}
enum confederation-external {
description
"Confederation External (EBGP) peer.";
}
}
description
"Labels a peer or peer group as explicitly internal,
external, or the related confederation type.";
reference
"RFC 4271: A Border Gateway Protocol 4 (BGP-4), Sec 1.1.
RFC 5065: Autonomous System Configuration for BGP.";
}
/* End of temporal objects */
grouping bmp-ip-connection-grouping {
description
"Common parameters for establishing connectivity
to a BMP monitoring station.";
choice passive-or-active {
mandatory true;
description
"Selects whether the device initiates
(active) or waits for (passive)
the connection to the monitoring station,
as described in RFC 7854 Section 3.2.";
case active {
description
"Device initiates the connection to
the monitoring station.";
container active {
description
"The device starts the connection to
the monitoring station";
leaf network-instance {
type leafref {
path "/ni:network-instances/ni:network-instance/"
+ "ni:name";
}
description
"Network instance used to reach the monitoring
station.
Defaults to the global network instance
if not specified.";
}
leaf station-address {
type inet:ip-address;
mandatory true;
description
"IP address of the monitoring station.";
}
leaf station-port {
type inet:port-number;
mandatory true;
description
"Port number of the monitoring station.";
}
choice local-endpoint {
mandatory true;
description
"Local endpoint for the connection.";
case monitored-router-address {
leaf monitored-router-address {
type inet:ip-address;
description
"Local IP address to source the connection.";
}
}
case monitored-router-interface {
leaf monitored-router-interface {
type if:interface-ref;
description
"Local interface to source the connection.";
}
}
}
leaf monitored-router-port {
type inet:port-number;
description
"Optional local port for the active connection.";
}
}
}
case passive {
description
"Device waits for incoming connection at a local
endpoint.";
container passive {
description
"Parameters for passively accepting
a connection from the monitoring station.";
leaf network-instance {
type leafref {
path "/ni:network-instances/ni:network-instance/"
+ "ni:name";
}
description
"Network instance used for the passive connection.
Defaults to the global network instance if not
specified.";
}
leaf station-address {
type inet:ip-address;
mandatory true;
description
"IP address of the monitoring station.";
}
leaf station-port {
type inet:port-number;
description
"Optional value identifying the origin port of the
connection. If provided, it MUST match the receiving
connection.";
}
choice local-endpoint {
mandatory true;
description
"Local endpoint for the connection.";
case monitored-router-address {
leaf monitored-router-address {
type inet:ip-address;
description
"Local IP address to accept the connection.";
}
}
case monitored-router-interface {
leaf monitored-router-interface {
type if:interface-ref;
description
"Local interface to accept the connection.";
}
}
}
leaf monitored-router-port {
type inet:port-number;
mandatory true;
description
"Local port to accept the connection.";
}
}
}
}
leaf dscp {
type inet:dscp;
description
"DSCP value for marking traffic to the monitoring station.";
reference
"RFC 6991: Common YANG Data Types";
}
}
grouping route-monitoring-peer-grouping {
description
"General configuration options for route monitoring
of a peer.";
container filters {
description
"Filters for selecting which routes to export to
the monitoring station.";
container policy-filter {
if-feature "bmp-filter-based-on-route-policy";
description
"Filter routes using a routing policy from the
rt-pol module.
The policy should only contain accept/reject actions
and match prefix sets.";
leaf-list export-policy {
type leafref {
path "/rt-pol:routing-policy/"
+ "rt-pol:policy-definitions/"
+ "rt-pol:policy-definition/rt-pol:name";
require-instance true;
}
ordered-by user;
description
"Ordered list of policy names used to select
routes for export.";
}
leaf default-export-policy {
type rt-pol:default-policy-type;
default "accept-route";
description
"Default action if no export policy matches.";
}
}
}
}
grouping bmp-peer-ribs-filter-grouping {
description
"Configuration containers for RIBs under the main
BMP container.";
container address-families {
description
"List of address families for route monitoring.";
list address-family {
key "id";
description
"Address family, as defined in the BGP model.";
leaf id {
type identityref {
base afi-safi-type;
}
description
"Address family identifier.";
}
leaf enabled {
type boolean;
default "true";
description
"Enables route monitoring messages for this address
family.";
}
container peers-configurations {
description
"Each peer under this BGP instance can be configured by
at most one of the following containers.
If the peer is not covered by any,
then no BMP route monitoring message
should include information from/to that peer.
If the peer is covered by more than one, then the
priority is:
1. peer
2. peer-groups
3. peer-type
4. peer-selectors
New child containers or new bmp-peer-selectors
instances SHOULD provide a way of unambiguously
selecting which configuration container should
be selected
for a peer in case of multiple matches.
Note that if the implementation supports module
ietf-bmp-bgp-dependencies, the peer configurations
under the BGP container have priority over the
configurations under this container.";
container peers {
description
"Configuration for individual peers.";
list peer {
key "id";
description
"Peer identifier.";
leaf id {
type string;
description
"Identifier of the peer.";
}
leaf enabled {
type boolean;
default "true";
description
"Enables route monitoring messages for this peer.";
}
uses route-monitoring-peer-grouping;
}
}
container peer-groups {
description
"Configuration for peer groups.";
list peer-group {
key "id";
description
"Peer group identifier.";
leaf id {
type string;
description
"Identifier of the peer group.";
}
leaf enabled {
type boolean;
default "true";
description
"Enables route monitoring messages for
this peer group.";
}
uses route-monitoring-peer-grouping;
}
}
container peer-selectors {
description
"Configuration for peers selected by BMP peer
selectors.";
list peer-selector {
key "id";
description
"Identification of peers
for which we send BMP data to the collector
using a peer type defined using a
bmp-peer-selectors identity.
For instance, to create a default for all
peers use all-peers";
leaf id {
type identityref {
base bmp-peer-selectors;
}
description
"BMP peer selector identity.";
}
leaf enabled {
type boolean;
default "true";
description
"Enables route monitoring messages
for the peer(s).";
}
uses route-monitoring-peer-grouping;
}
}
container peer-types {
description
"Generic identification of peers to configure.";
list peer-type {
key "id";
description
"Identification of peers
for which we send BMP data to the collector
using BGP peer-type (e.g. internal, external)
";
leaf id {
type peer-type;
description
"BGP peer type.";
}
leaf enabled {
type boolean;
default "true";
description
"Enables route monitoring messages
for the peer(s).";
}
uses route-monitoring-peer-grouping;
}
}
}
}
}
}
grouping generic-network-instance-grouping {
description
"Generic configuration of a network instance.";
leaf enabled {
type boolean;
default "true";
description
"Enables route monitoring
messages for the network instance.";
}
container adj-rib-in-pre {
description
"Configuration for the adj-rib-in pre-policy.";
reference
"RFC7854: BGP Monitoring Protocol (BMP), Section 2.";
uses bmp-peer-ribs-filter-grouping;
}
container adj-rib-in-post {
description
"Configuration for the adj-rib-in post-policy";
reference
"RFC7854: BGP Monitoring Protocol (BMP), Section 2.";
uses bmp-peer-ribs-filter-grouping;
}
container local-rib {
description
"Configuration for the local-rib.";
reference
"RFC9069: Support for Local RIB in the BGP Monitoring
Protocol (BMP), Section 3.";
container address-families {
description
"List of address families to enable for local-rib.";
list address-family {
key "id";
description
"Address family to enable for local-rib";
leaf id {
type identityref {
base afi-safi-type;
}
description
"Address family id to enable for local-rib";
}
uses route-monitoring-peer-grouping;
}
}
}
container adj-rib-out-pre {
description
"Configuration for the adj-rib-out pre-policy";
reference
"RFC8671: Support for Adj-RIB-Out in the BGP Monitoring
Protocol (BMP) , Section 3.";
uses bmp-peer-ribs-filter-grouping;
}
container adj-rib-out-post {
description
"Configuration for the adj-rib-out post-policy";
reference
"RFC8671: Support for Adj-RIB-Out in the BGP Monitoring
Protocol (BMP) , Section 3.";
uses bmp-peer-ribs-filter-grouping;
}
}
grouping route-monitoring-sources {
description
"Configuration of route monitoring sources.";
reference
"RFC7854: BGP Monitoring Protocol, Section 5.";
container network-instance-configuration {
description
"This container offers options for configuring BMP
route-monitoring messages for each network instance either
selecting it through its name or through a
network-instance-selectors.
Network-instance-selectors are instances of bmp-ni-types
that select one or more network instances for configuration.
For instance, all-ni to configure all network
instances (serving as a default).
Network-instance can be at most configured by one of the
containers. If the network instance is not covered by any,
then no BMP route monitoring message should include that
network instance. If more than one container matches
the network instance, the priority for selecting the
container to use for configuration is:
1. For any named network instance, the configuration
under the element listed with its name under the
network-instance container.
2. If the global-ni network-instance type exists,
it SHOULD be used for the global-ni.
However, if the global-ni
has an explicit name, and it is configured, then
from the previous rule, the explicit network
instance name configuration SHOULD be used.
3. The configuration under network-instance-groups of type
non-global-ni if existing and not the global
network instance.
4. the configuration under network-instance-groups under the
element all-ni.
If the implementation has a name for the global network
instance (e.g. 'main') it can be configure directly under
the network-instances container.
New identities under bmp-ni-types or augmentations of this
container in the future SHOULD provide a clear way of
selecting the configuration container for a network-instance
without ambiguity.";
container network-instances {
description
"Configuration for specific network instances";
list network-instance {
key "id";
description
"Network instance to monitor using BMP.";
leaf id {
type leafref {
path "/ni:network-instances/ni:network-instance/"
+ "ni:name";
}
description
"Name of the network instance.";
}
uses generic-network-instance-grouping;
}
}
container network-instance-selectors {
description
"Configuration of network instances. Uses
bmp-ni-types to identify one or a group of
network instances to configure.";
list network-instance-selector {
key "id";
description
"Network instance(s) to monitor using BMP.";
leaf id {
type identityref {
base bmp-ni-types;
}
description
"Configures one or multiple network instances selected
based on a bmp-ni-types identity (e.g.
all-ni for all of them).";
}
uses generic-network-instance-grouping;
}
}
}
}
container bmp {
description
"Top-level container for BMP configuration.";
container monitoring-stations {
description
"List of BMP monitoring stations.";
list monitoring-station {
key "id";
description
"Configuration for a BMP monitoring station.";
leaf id {
type string;
description
"Unique identifier for the monitoring station.";
}
leaf description {
type string;
description
"Description of the BMP monitoring station.";
}
container connection {
description
"Connection parameters for the monitoring station.";
uses bmp-ip-connection-grouping;
container tcp-options {
description
"TCP options for the connection to the monitoring
station.";
leaf maximum-segment-size {
type uint16;
description
"Maximum segment size for the TCP connections.
In the absence of this container, the system
will select the maximum segment size for this
connection.";
}
// Taken from the bgp yang module
leaf mtu-discovery {
type boolean;
default "true";
description
"Enables path MTU discovery for the TCP sessions
(true) or disables it (false).";
reference
"RFC 1191: Path MTU discovery.";
}
}
leaf initial-delay {
type uint32;
units "seconds";
default "0";
description
"Initial delay before connecting to the monitoring
station.
Useful for allowing BGP sessions to stabilize
before starting BMP.";
}
container backoff {
description
"Configures the backoff strategy after a connection
retry";
reference
"RFC7854 Section 3.2";
choice backoff-options {
description
"Options for backoff strategies";
reference
"RFC7854 Section 3.2";
case simple-exponential {
description
"Simple exponential backoff with limits.";
container simple-exponential {
description
"Simple exponential backoff with limits.
Starts with the initial backoff and doubles
the backoff after every retry until reaching the
maximum backoff.";
leaf initial-backoff {
type uint32;
units "seconds";
default "30";
description
"Initial backoff time";
}
leaf maximum-backoff {
type uint32;
units "seconds";
default "720";
description
"Maximum backoff time";
}
}
}
}
}
}
container bmp-data {
description
"Configuration of BMP data sent to the monitoring
station.";
leaf initiation-message {
type string;
description
"User-defined message to append to the
initiation message.";
reference
"RFC7854: BGP Monitoring Protocol,
Section 4.3 and 4.4";
}
container statistics-report {
presence "Enable BMP statistics report.";
description
"Configuration for periodic statistics reports.";
reference
"RFC7854: BGP Monitoring Protocol,
Section 4.8";
leaf statistics-interval {
type uint32;
units "seconds";
mandatory true;
description
"Interval between statistics report messages.";
}
}
container route-monitoring {
description
"Configuration of the data sources for
route-monitoring messages";
uses route-monitoring-sources;
}
container route-mirroring {
presence "Enable BMP route mirroring to the monitoring
station.";
description
"Configuration for route mirroring to the
monitoring station.";
}
}
container session-stats {
config false;
description
"Operational statistics for the monitoring station.
Counters are reset after each successful
connection or reset.";
grouping bmp-af-stats-with-peers-grouping {
description
"Generic statistics for an address family that can be
disaggregated by peers";
container peers-stats {
description
"Peer stats";
list peer {
key "id";
description
"List of peers";
leaf id {
type string;
description
"Peer id";
}
leaf enabled {
type boolean;
description
"Indicates if route monitoring messages are
currently enabled for the peer under this
network instance, address family, and RIB.";
}
leaf total-route-mnt-updated-prefixes-per-peer {
type uint64;
description
"Number of prefixes updated for this peer.";
}
leaf total-route-mnt-withdraw-prefixes-per-peer {
type uint64;
description
"Number of prefixes withdrawn for this peer.";
}
}
}
}
grouping bmp-af-stats-grouping {
description
"Group for statistics for an address family.";
leaf enabled {
type boolean;
description
"Indicates if any route monitoring messages
are currently enabled for the address family
within the RIB.";
}
leaf total-route-monitoring-updated-prefixes-per-af {
type uint64;
description
"Number of prefixes updated for this address
family.";
}
leaf total-route-monitoring-withdraw-prefixes-per-af {
type uint64;
description
"Number of prefixes withdrawn for this address
family.";
}
}
grouping bmp-rib-with-peers-stats-grouping {
description
"Generic statistics for a RIB with peers.";
container address-families {
description
"List of address families to list stats.";
list address-family {
key "id";
description
"Address family to enable for local-rib";
leaf id {
type identityref {
base afi-safi-type;
}
description
"Address family ID for local-rib.";
}
uses bmp-af-stats-grouping;
uses bmp-af-stats-with-peers-grouping;
}
}
}
grouping bmp-rib-stats-grouping {
description
"Generic statistics per RIB.";
leaf enabled {
type boolean;
description
"Indicates if any Route Monitoring messages are
currently enabled for the RIB.";
}
leaf total-route-mirroring-messages-per-rib {
type uint64;
description
"Number of route-mirroring messages sent for
this RIB.";
}
}
leaf discontinuity-time {
type yang:date-and-time;
mandatory true;
description
"The time on the most recent occasion at which any
one or more of this station's counters suffered a
discontinuity. If no such discontinuities have
occurred since the last re-initialization of the
local management subsystem, then this node contains
the time the local management subsystem
re-initialized itself.";
}
leaf established-session {
type boolean;
description
"Indicates if the session is currently
established.";
}
leaf total-route-monitoring-messages {
type uint64;
description
"Number of route-monitoring messages sent.";
}
leaf total-statistics-messages {
type uint64;
description
"Number of statistics messages sent.";
}
leaf total-peer-down-messages {
type uint64;
description
"Number of peer-down messages sent.";
}
leaf total-peer-up-messages {
type uint64;
description
"Number of peer-up messages sent.";
}
leaf total-initiation-messages {
type uint64;
description
"Number of initiation messages sent";
}
leaf total-route-mirroring-messages {
type uint64;
description
"Number of route-mirroring messages sent.";
}
leaf total-termination-messages {
type uint64;
description
"Number of termination messages sent.";
}
container route-monitoring-stats {
description
"Statistics of route monitoring messages disaggregated
by RIB and peers where applicable.";
container network-instances-stats {
description
"Stats per network-instance";
list network-instance {
key "network-instance-name";
description
"Network instance stats list";
leaf network-instance-name {
type leafref {
path "/ni:network-instances/ni:network-instance/"
+ "ni:name";
}
description
"Name of the network instance.";
}
leaf enabled {
type boolean;
description
"Indicates if route monitoring messages are
currently enabled for the network instance.";
}
leaf total-route-mirroring-messages-per-ni {
type uint64;
description
"Number of route-mirroring messages sent for
this network instance.";
}
container ribs-stats {
description
"Statistics for the different RIBs.";
container adj-rib-in-pre {
description
"Statistics for adj-rib-in-pre.";
uses bmp-rib-stats-grouping;
uses bmp-rib-with-peers-stats-grouping;
}
container adj-rib-in-post {
description
"Statistics for adj-rib-in-post";
uses bmp-rib-stats-grouping;
uses bmp-rib-with-peers-stats-grouping;
}
container local-rib {
description
"Statistics for local-rib";
uses bmp-rib-stats-grouping;
container address-families {
description
"List of address families to for stats.";
list address-family {
key "id";
description
"Address family to enable for local-rib";
leaf id {
type identityref {
base afi-safi-type;
}
description
"Address family ID for local-rib";
}
uses bmp-af-stats-grouping;
}
}
}
container adj-rib-out-pre {
description
"Statistics for adj-rib-out-pre";
uses bmp-rib-stats-grouping;
uses bmp-rib-with-peers-stats-grouping;
}
container adj-rib-out-post {
description
"Statistics for adj-rib-out-post";
uses bmp-rib-stats-grouping;
uses bmp-rib-with-peers-stats-grouping;
}
}
}
}
}
}
container actions {
description
"Container with actions for BMP operation.";
action session-reset {
description
"Resets the session for a station.";
output {
choice outcome {
description
"Output of the reset operation. Either a success or
failure. For the latter, the reason for the
error is provided.";
leaf success {
type empty;
description
"Reset successful.";
}
leaf failure {
type string;
description
"Reset could not be performed.
The reason is included in the field.";
}
}
}
}
action session-counter-reset {
description
"Resets the counters of a BMP monitoring station.";
output {
choice outcome {
description
"Output of the reset operation. Either a success or
failure. For the latter, the reason for the
error is provided.";
leaf success {
type empty;
description
"Counter reset successful.";
}
leaf failure {
type string;
description
"Reset could not be performed.
The reason is included in the field.";
}
}
}
}
nacm:default-deny-all;
}
}
}
}
}
]]>This section shows some examples of BMP configuration using the
model.In this example, the device connects to a monitoring station
using an active connection.
The devices sends route monitoring messages for the global
instance, the adj-rib-in-pre RIB, the IPv4/IPv6 address family,
and external peers.
1192.0.2.157992192.0.2.2
all-niipv6-unicastexternalipv4-unicastexternal
]]>In the next example, the device connects to a monitoring station
using a passive connection, over the network-instance monitoring.
The configuration of route monitoring messages is more complex than
in the previous example. It shows how to combine the configuration
of general identities of network instances and peers (e.g.
all-ni for NI, external for peers), and individual
configurations to support a more complex requirement. This is what
the example expects to configure: For the global network instance,
the device sends updates for adj-rib-in-pre, address families IPv4
and IPv6. It sends updates for all external peers except peer
198.51.100.11, which is disabled.Network instance monitoring is disabled for route monitoring messages. For the rest of network
instances, we are enabling messages from adj-rib-in-pre, address
families IPv4/IPv6, and for all peers.2monitoring192.0.2.1192.0.2.2
57993all-niipv6-unicastall-peersipv4-unicastall-peersglobal-niipv6-unicast198.51.100.11falseexternalipv4-unicast198.51.100.11falseexternalmonitoringfalse
]]>
The authors would like to thank Yimin Shen, Jeff Haas, Pierre Vander
Vorst, and Tom Petch for their review and feedback.