GROW C. Cardona Internet-Draft P. Lucente Intended status: Standards Track NTT Expires: 14 December 2025 T. Graf Swisscom B. Claise Huawei D. Patki P. Narasimha Cisco 12 June 2025 BMP YANG Module draft-ietf-grow-bmp-yang-05 Abstract This document proposes a YANG module for the configuration and monitoring of the BGP Monitoring Protocol (BMP). Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on 14 December 2025. Copyright Notice Copyright (c) 2025 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/ license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components Cardona, et al. Expires 14 December 2025 [Page 1] Internet-Draft BMP YANG Module June 2025 extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 3. Model description . . . . . . . . . . . . . . . . . . . . . . 3 3.1. IP Connectivity . . . . . . . . . . . . . . . . . . . . . 3 3.1.1. Active connection . . . . . . . . . . . . . . . . . . 4 3.1.2. Passive connection . . . . . . . . . . . . . . . . . 4 3.2. TCP Options . . . . . . . . . . . . . . . . . . . . . . . 5 3.3. Other BMP connectivity options . . . . . . . . . . . . . 8 3.4. BMP data . . . . . . . . . . . . . . . . . . . . . . . . 9 3.4.1. BMP route monitoring . . . . . . . . . . . . . . . . 10 3.4.1.1. Network instances . . . . . . . . . . . . . . . . 13 3.4.1.2. RIB Type . . . . . . . . . . . . . . . . . . . . 17 3.4.1.3. Address families . . . . . . . . . . . . . . . . 18 3.4.1.4. Peers . . . . . . . . . . . . . . . . . . . . . . 23 3.4.1.5. Filtering route-monitoring messages . . . . . . . 24 3.4.1.6. Full examples of Route monitoring configurations . . . . . . . . . . . . . . . . . . 24 3.5. Session stats . . . . . . . . . . . . . . . . . . . . . . 31 3.6. Session reset action . . . . . . . . . . . . . . . . . . 31 4. Implementation guidelines . . . . . . . . . . . . . . . . . . 31 5. BMP YANG module . . . . . . . . . . . . . . . . . . . . . . . 31 5.1. Tree View . . . . . . . . . . . . . . . . . . . . . . . . 32 5.2. Base BMP YANG Module . . . . . . . . . . . . . . . . . . 57 5.3. BGP dependencies for BMP YANG Module . . . . . . . . . . 80 5.4. TCP dependencies for BMP YANG Module . . . . . . . . . . 87 6. Security Considerations . . . . . . . . . . . . . . . . . . . 90 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 90 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 90 7.2. The YANG Module Name Registration . . . . . . . . . . . . 91 8. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 91 9. Normative References . . . . . . . . . . . . . . . . . . . . 91 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 93 A.1. Example one . . . . . . . . . . . . . . . . . . . . . . . 93 A.2. Example two . . . . . . . . . . . . . . . . . . . . . . . 95 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 98 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 98 Cardona, et al. Expires 14 December 2025 [Page 2] Internet-Draft BMP YANG Module June 2025 1. Introduction 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. 2. Terminology 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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. Routing Information Bases, peers, monitoring stations, and initiation messages are defined in [RFC7854]. 3. Model description This document specifies a YANG module for configuring and monitoring the BGP Monitoring Protocol (BMP) [RFC7854] 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 Section 5. 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. 3.1. IP Connectivity BMP allows for active and passive connections between the router and the BMP monitoring station as described in Section 3.2 of [RFC7854]. 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. Cardona, et al. Expires 14 December 2025 [Page 3] Internet-Draft BMP YANG Module June 2025 3.1.1. Active connection 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 Figure 1. =============== NOTE: '\' line wrapping per RFC 8792 ================ 1 192.0.2.1 57992 192.0.2.2 Figure 1: Active connection example Note in the example from Figure 1 that there is no network instance defined, so the connection is using the global network instance. 3.1.2. Passive connection In a passive connection, the IP of the monitoring station, the local endpoint and 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. Cardona, et al. Expires 14 December 2025 [Page 4] Internet-Draft BMP YANG Module June 2025 Figure 2 includes an example of configuring a passive connection. In this example, we specify the network-instance where we want to receive the connection. =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_two test 192.0.2.1 192.0.2.2 57993 Figure 2: Passive connection example 3.2. TCP Options The BMP module allows tuning various parameters of the TCP connection supporting the BMP session: * The maximum segment size of the TCP connection. See Section 3.7.1 of [RFC9293]. * Enabling MTU discovery for the path. See Section 3.7.2 of [RFC9293]. * For configuring TCP keepalives, the connection container uses the tcp-common-grouping from [I-D.ietf-netconf-tcp-client-server]. Note that the implementation must support module ietf-bmp-tcp- dependencies in addition to the main module to support these elements. Please see Section 2.1.3.1 of [I-D.ietf-netconf-tcp-client-server] for the explanation of each of its parameters. The device must have the feature "tcp-client- keepalives" enabled. See also Section 3.8.4 of [RFC9293] * Session security. Provides options for authentication using AO and MD5. This part of the model was taken from the BGP YANG model [I-D.ietf-idr-bgp-model]. This feature also requires support of the ietf-bmp-tcp-dependencies module. Cardona, et al. Expires 14 December 2025 [Page 5] Internet-Draft BMP YANG Module June 2025 Figures 3 and 4 include examples configuring the previous TCP parameters in the model. =============== NOTE: '\' line wrapping per RFC 8792 ================ 1 192.0.2.1 57992 192.0.2.2 15 3 30 1500 true Figure 3: Example of configuring basic TCP parameters =============== NOTE: '\' line wrapping per RFC 8792 ================ bmp-key-chain An example of TCP-AO configuration for BMP 55 aes-cmac-prf-128 2023-01-01T00:00:00+00:00 Cardona, et al. Expires 14 December 2025 [Page 6] Internet-Draft BMP YANG Module June 2025 2023-02-01T00:00:00+00:00 2023-01-01T00:00:00+00:00 2023-02-01T00:00:00+00:00 teststring bmp-key-chain 65 87 56 aes-cmac-prf-128 2023-01-01T00:00:00+00:00 2023-02-01T00:00:00+00:00 2023-01-01T00:00:00+00:00 2023-02-01T00:00:00+00:00 bmp-key-chain 65 87 monitoring_station_one Cardona, et al. Expires 14 December 2025 [Page 7] Internet-Draft BMP YANG Module June 2025 192.0.2.1 57992 192.0.2.2 bmp-key-chain Figure 4: Example of the Configuration of TCP session security. 3.3. Other BMP connectivity options 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 Section 3.2 of [RFC7854]. In the example in Figure 5, we configure an initial-delay of 10, an initial-backoff of 50 seconds and 600 of maximum-backoff. Cardona, et al. Expires 14 December 2025 [Page 8] Internet-Draft BMP YANG Module June 2025 =============== NOTE: '\' line wrapping per RFC 8792 ================ 1 192.0.2.1 57992 192.0.2.2 10 50 600 Figure 5: Example of the initial-delay and simple exponential backoff. 3.4. BMP data The bmp-data container defines the configuration parameters for the data that the device sends to the monitoring station using BMP messages. See Section 4 of [RFC7854]. 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 Section 3.4.1. * Initiation-message: Content for an information TLV type-0 for identification of the device. See 4.3 and Section 4.4 of [RFC7854] Cardona, et al. Expires 14 December 2025 [Page 9] Internet-Draft BMP YANG Module June 2025 * Statistics-interval: The statistics report is enabled by the presence of the bmp-statistics-report container. The statistics- interval is mandatory if the bmp-statistics-report container exists and defines the interval of the statistics report. See Section 4.8 of [RFC7854]. * Route-mirroring: Route Mirroring messages serve as an exact replica of the messages received by the device. See Section 6 of [RFC7854]. Enabling route mirroring messages towards a particular BMP monitoring station only requires the presence of the container "bmp-route-mirroing" within the monitoring station container. An example of configuring the previous options is included in Figure 6 =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 BMP device supporting the BMP yang modul\ e 600 Figure 6: Example of configuration of initiation-message and statistics report interval. 3.4.1. BMP route monitoring Route monitoring messages are used for synchronization of RIBs to the monitoring station. See Section 5 of [RFC7854]. Cardona, et al. Expires 14 December 2025 [Page 10] Internet-Draft BMP YANG Module June 2025 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 Routing monitoring configuration is divided in a 4 part hierarchy: * Network Instance * RIB Type (e.g. Adj-RIB-IN pre/post, local RIB) * Address Family * Peers Absence of the routing monitoring container will disable the routing 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. Cardona, et al. Expires 14 December 2025 [Page 11] Internet-Draft BMP YANG Module June 2025 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, turn a route-policy filtering prefix for a specific peer, or turning off 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. Cardona, et al. Expires 14 December 2025 [Page 12] Internet-Draft BMP YANG Module June 2025 3.4.1.1. Network instances 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 two bmp-ni-types identities: "bmp-ni- types-all-ni" which selects all network instances, and "bmp-ni-types- non-global-ni" which selects all network instances except the global one. The former can be used as a "default" configuration for simple cases. The model offers two ways of configuring a network-instance individually. The main one is under container "bmp-data/bmp- monitoring-stations/" under the "routing/control-plane-protocols/ control-plane-protocol/bgp". The second one is specifying the name under the "bmp/bmp-route-monitoring/network-instance". The former one requires the support of schema-mount and the ietf-bmp-bgp- dependencies.yang module (which is optional). The latter does not require support for schema-mount by the device. An empty configuration disables routing 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 BGP container under the network-instance includes a BMP/ Route monitoring container, it SHOULD be configured by it. Note that if the monitoring-station is not present in the container, the route monitoring will be disabled for this network instance. * 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. Cardona, et al. Expires 14 December 2025 [Page 13] Internet-Draft BMP YANG Module June 2025 * If the selector 'bmp-ni-types-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 bmp-ni-types-global-ni selector. * If the selector 'bmp-ni-types-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 bmp-ni-types-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 (not the configuration under the BGP container). To focus on the network instance configuration, we mask the configuration under each instance using "Configuration X". =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-all-ni Cardona, et al. Expires 14 December 2025 [Page 14] Internet-Draft BMP YANG Module June 2025 bmp-ni-types-global-ni\ network-instance-two network-instance-one false Figure 7: Examples of configuring the network instance level for Route Monitoring. In example from Figure 7, 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 routing monitoring messages for that network instance. Cardona, et al. Expires 14 December 2025 [Page 15] Internet-Draft BMP YANG Module June 2025 =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-all-ni Figure 8: Example of configuring all network instances. The example in Figure 8 shows a "simple" configuration. In this case, all network instances would get "Configuration D". Note that `bmp-ni-types-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 Figure 9 Cardona, et al. Expires 14 December 2025 [Page 16] Internet-Draft BMP YANG Module June 2025 =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-all-ni Figure 9: Example of configuring only the global network instance. Alternatively to the configuration of Figure 9, if the device supports the ietf-bgp and ietf-bmp-bgp-dependencies.yang models, one could configure directly the global instance, but using the BMP configuration under the BGP container 3.4.1.2. RIB Type 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. Cardona, et al. Expires 14 December 2025 [Page 17] Internet-Draft BMP YANG Module June 2025 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 section 3.4.1.3. Address families Address 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. =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-all-ni bt:ipv6-unicast bt:ipv4-unicast bmp-ni-types-global-ni\ bt:ipv6-unicast bt:ipv4-unicast bt:ipv6-unicast bt:ipv4-unicast network-instance-one Cardona, et al. Expires 14 December 2025 [Page 19] Internet-Draft BMP YANG Module June 2025 false network-instance-two bt:ipv4-unicast Figure 10: Example of configuring RIBs and address families. In Figure 10, 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 routing 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 bmp-ni-types-all-ni Cardona, et al. Expires 14 December 2025 [Page 20] Internet-Draft BMP YANG Module June 2025 If an operator only wants to configure the IPv4/IPv6 of adj-rib-pre- in for the global instance, the configuration in Figure 11 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. Cardona, et al. Expires 14 December 2025 [Page 21] Internet-Draft BMP YANG Module June 2025 =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-global-ni\ bt:ipv6-unicast bt:ipv4-unicast Figure 11: Example of configuring RIBs and address families. Cardona, et al. Expires 14 December 2025 [Page 22] Internet-Draft BMP YANG Module June 2025 3.4.1.4. Peers 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 `bmp-peer-types-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 `bmp-peer-types- all-peers`, it would be configured using this instance. * Finally, if no instance covers the peer, the data 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 peer-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). Cardona, et al. Expires 14 December 2025 [Page 23] Internet-Draft BMP YANG Module June 2025 We'll provide examples of the peers configuration after describing the filter containers. 3.4.1.5. Filtering route-monitoring messages 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 routes, and can filter them based on multiple characteristics. For the consistency of the data in the monitoring station, the route policies actions SHOULD be restricted to accepting or rejecting routes. Furthermore, the conditions SHOULD only match prefix sets. We present examples of full configurations next. 3.4.1.6. Full examples of Route monitoring configurations 3.4.1.6.1. Example one - simple configuration In the example configuration from Figure 12, address families IPv6 and IPv4 are configured to send all peers. This is an example of a simple configuration =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 Cardona, et al. Expires 14 December 2025 [Page 24] Internet-Draft BMP YANG Module June 2025 bmp-ni-types-global-ni\ bt:ipv6-unicast bmp-peer-selectors-all-\ peers bt:ipv4-unicast bmp-peer-selectors-all-\ peers Figure 12: Enabling Route monitoring for all peers; all network instances; IPv4/ IPv6 Address families, in the adj-rib-in-pre RIB. Cardona, et al. Expires 14 December 2025 [Page 25] Internet-Draft BMP YANG Module June 2025 3.4.1.6.2. Example two - policy list example In the example in Figure 13, 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. =============== NOTE: '\' line wrapping per RFC 8792 ================ test_policy monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-global-ni bt:ipv6-unicast Cardona, et al. Expires 14 December 2025 [Page 26] Internet-Draft BMP YANG Module June 2025 bmp-peer-selectors-all-peer\ s bt:ipv4-unicast external 198.51.100.1 test_policy Figure 13: Configuring address families differently for the global network instance Cardona, et al. Expires 14 December 2025 [Page 27] Internet-Draft BMP YANG Module June 2025 3.4.1.6.3. Example three - specific network instance configuration In the example from Figure 14, 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. =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-all-ni bt:ipv6-unicast bmp-peer-selectors-all-\ peers bt:ipv4-unicast Cardona, et al. Expires 14 December 2025 [Page 28] Internet-Draft BMP YANG Module June 2025 bmp-peer-selectors-all-\ peers network-instance-one false network-instance-two bt:ipv4-unicast Figure 14: Applying a general configuration to all network instances, except of two, which are configured specifically. 3.4.1.6.4. Example four - Enabling just a few peers in global In the example from Figure 15, 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-pre-policy. Cardona, et al. Expires 14 December 2025 [Page 29] Internet-Draft BMP YANG Module June 2025 =============== NOTE: '\' line wrapping per RFC 8792 ================ monitoring_station_one 192.0.2.1 57992 192.0.2.2 bmp-ni-types-global-ni\ bt:ipv6-unicast 198.51.100.1 198.51.100.2 bt:ipv4-unicast 198.51.100.1 198.51.100.2 Cardona, et al. Expires 14 December 2025 [Page 30] Internet-Draft BMP YANG Module June 2025 Figure 15: Sending just BGP messages from adj-rib-in-pre from 2 peers 3.5. Session stats The non-configurable container "session-stats" includes various metrics for the session with the monitoring station. 3.6. Session reset action The "session-reset" action resets a session with a monitoring station. 4. Implementation guidelines To facilitate implementation, the model is divided into three 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, two supplementary modules, ietf-bmp-bgp- dependencies.yang and ietf-bmp-tcp-dependencies.yang, enhance the model's functionality but rely on the IETF BGP and TCP models. These modules can be adopted by implementations that support these dependencies. 5. BMP YANG module Cardona, et al. Expires 14 December 2025 [Page 31] Internet-Draft BMP YANG Module June 2025 5.1. Tree View The following tree diagram provides an overview of the base ietf- bmp.yang data model. It also includes the trees for the modules ietf-bmp-bgp-dependencies.yang and ietf-bmp-tcp-dependencies.yang that adds some options to the models in case the implementation supports these models (and their requisites) =============== NOTE: '\' line wrapping per RFC 8792 ================ module: ietf-bmp +--rw bmp +--rw bmp-monitoring-stations +--rw bmp-monitoring-station* [id] +--rw id string +--rw description? string +--rw connection | +--rw (passive-or-active) | | +--:(active) | | | +--rw active | | | +--rw network-instance? | | | | leafref | | | +--rw station-address | | | | inet:ip-address | | | +--rw station-port | | | | inet:port-number | | | +--rw (local-endpoint) | | | | +--:(monitored-router-address) | | | | | +--rw monitored-router-address? | | | | | inet:ip-address | | | | +--:(monitored-router-interface) | | | | +--rw monitored-router-interface? | | | | leafref | | | +--rw monitored-router-port? | | | inet:port-number | | +--:(passive) | | +--rw passive | | +--rw network-instance? | | | leafref | | +--rw station-address | | | inet:ip-address | | +--rw station-port? | | | inet:port-number | | +--rw (local-endpoint) | | | +--:(monitored-router-address) | | | | +--rw monitored-router-address? | | | | inet:ip-address | | | +--:(monitored-router-interface) Cardona, et al. Expires 14 December 2025 [Page 32] Internet-Draft BMP YANG Module June 2025 | | | +--rw monitored-router-interface? | | | leafref | | +--rw monitored-router-port | | inet:port-number | +--rw dscp? inet:dscp | +--rw tcp-options | | +--rw maximum-segment-size? uint16 | | +--rw mtu-discovery? boolean | | +--rw bmp-tcp:keepalives! | | | {keepalives-supported}? | | | +--rw bmp-tcp:idle-time? uint16 | | | +--rw bmp-tcp:max-probes? uint16 | | | +--rw bmp-tcp:probe-interval? uint16 | | +--rw bmp-tcp:secure-session! | | +--rw (bmp-tcp:authentication) | | +--:(bmp-tcp:ao) | | | +--rw bmp-tcp:ao-keychain? | | | key-chain:key-chain-ref | | +--:(bmp-tcp:md5) | | +--rw bmp-tcp:md5-keychain? | | key-chain:key-chain-ref | +--rw initial-delay? uint32 | +--rw backoff | +--rw (backoff-options)? | +--:(simple-exponential) | +--rw simple-exponential | +--rw initial-backoff? uint32 | +--rw maximum-backoff? uint32 +--rw bmp-data | +--rw initiation-message? string | +--rw bmp-statistics-report! | | +--rw statistics-interval uint32 | +--rw bmp-route-monitoring | | +--rw network-instance-configuration | | +--rw network-instances | | | +--rw network-instance* | | | [network-instance-id] | | | +--rw network-instance-id leafref | | | +--rw enabled? boolean | | | +--rw adj-rib-in-pre | | | | +--rw address-families | | | | +--rw address-family* | | | | [address-family-id] | | | | +--rw address-family-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw peers-configurations Cardona, et al. Expires 14 December 2025 [Page 33] Internet-Draft BMP YANG Module June 2025 | | | | +--rw peers | | | | | +--rw peer* [peer-id] | | | | | +--rw peer-id | | | | | | string | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw peer-groups | | | | | +--rw peer-group* | | | | | [peer-group-id] | | | | | +--rw peer-group-id | | | | | | string | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw bmp-peer-selectors | | | | | +--rw bmp-peer-selector* | | | | | [bmp-selector-id] | | | | | +--rw bmp-selector-id | | | | | | identityref | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* Cardona, et al. Expires 14 December 2025 [Page 34] Internet-Draft BMP YANG Module June 2025 | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw bgp-peer-types | | | | +--rw bgp-peer-type* | | | | | [bgp-peer-type-id] | | | | | +--rw bgp-peer-type-id | | | | | bt:peer-type | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-base\ d-on-route-policy}? | | | | +--rw export-policy* | | | | | leafref | | | | +--rw default-export-\ policy? | | | | rt-pol:defaul\ t-policy-type | | | +--rw adj-rib-in-post | | | | +--rw address-families | | | | +--rw address-family* | | | | [address-family-id] | | | | +--rw address-family-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw peers-configurations | | | | +--rw peers | | | | | +--rw peer* [peer-id] | | | | | +--rw peer-id | | | | | | string | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type Cardona, et al. Expires 14 December 2025 [Page 35] Internet-Draft BMP YANG Module June 2025 | | | | +--rw peer-groups | | | | | +--rw peer-group* | | | | | [peer-group-id] | | | | | +--rw peer-group-id | | | | | | string | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw bmp-peer-selectors | | | | | +--rw bmp-peer-selector* | | | | | [bmp-selector-id] | | | | | +--rw bmp-selector-id | | | | | | identityref | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw bgp-peer-types | | | | +--rw bgp-peer-type* | | | | | [bgp-peer-type-id] | | | | | +--rw bgp-peer-type-id | | | | | bt:peer-type | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-base\ d-on-route-policy}? | | | | +--rw export-policy* Cardona, et al. Expires 14 December 2025 [Page 36] Internet-Draft BMP YANG Module June 2025 | | | | | leafref | | | | +--rw default-export-\ policy? | | | | rt-pol:defaul\ t-policy-type | | | +--rw local-rib | | | | +--rw address-families | | | | +--rw address-family* | | | | [address-family-id] | | | | +--rw address-family-id | | | | | identityref | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-based-on-r\ oute-policy}? | | | | +--rw export-policy* | | | | | leafref | | | | +--rw default-export-policy? | | | | rt-pol:default-poli\ cy-type | | | +--rw adj-rib-out-pre | | | | +--rw address-families | | | | +--rw address-family* | | | | [address-family-id] | | | | +--rw address-family-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw peers-configurations | | | | +--rw peers | | | | | +--rw peer* [peer-id] | | | | | +--rw peer-id | | | | | | string | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw peer-groups | | | | | +--rw peer-group* Cardona, et al. Expires 14 December 2025 [Page 37] Internet-Draft BMP YANG Module June 2025 | | | | | [peer-group-id] | | | | | +--rw peer-group-id | | | | | | string | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw bmp-peer-selectors | | | | | +--rw bmp-peer-selector* | | | | | [bmp-selector-id] | | | | | +--rw bmp-selector-id | | | | | | identityref | | | | | +--rw enabled? | | | | | | boolean | | | | | +--rw filters | | | | | +--rw policy-filter | | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | | +--rw export-polic\ y* | | | | | | leafref | | | | | +--rw default-expo\ rt-policy? | | | | | rt-pol:def\ ault-policy-type | | | | +--rw bgp-peer-types | | | | +--rw bgp-peer-type* | | | | | [bgp-peer-type-id] | | | | | +--rw bgp-peer-type-id | | | | | bt:peer-type | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-base\ d-on-route-policy}? | | | | +--rw export-policy* | | | | | leafref | | | | +--rw default-export-\ Cardona, et al. Expires 14 December 2025 [Page 38] Internet-Draft BMP YANG Module June 2025 policy? | | | | rt-pol:defaul\ t-policy-type | | | +--rw adj-rib-out-post | | | +--rw address-families | | | +--rw address-family* | | | [address-family-id] | | | +--rw address-family-id | | | | identityref | | | +--rw enabled? | | | | boolean | | | +--rw peers-configurations | | | +--rw peers | | | | +--rw peer* [peer-id] | | | | +--rw peer-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw peer-groups | | | | +--rw peer-group* | | | | [peer-group-id] | | | | +--rw peer-group-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bmp-peer-selectors Cardona, et al. Expires 14 December 2025 [Page 39] Internet-Draft BMP YANG Module June 2025 | | | | +--rw bmp-peer-selector* | | | | [bmp-selector-id] | | | | +--rw bmp-selector-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bgp-peer-types | | | +--rw bgp-peer-type* | | | | [bgp-peer-type-id] | | | | +--rw bgp-peer-type-id | | | | bt:peer-type | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-base\ d-on-route-policy}? | | | +--rw export-policy* | | | | leafref | | | +--rw default-export-\ policy? | | | rt-pol:defaul\ t-policy-type | | +--rw network-instance-selectors | | +--rw network-instance-selector* | | [network-instance-selector-id] | | +--rw network-instance-selector-id | | | identityref | | +--rw enabled? | | | boolean | | +--rw adj-rib-in-pre | | | +--rw address-families | | | +--rw address-family* | | | [address-family-id] | | | +--rw address-family-id | | | | identityref | | | +--rw enabled? Cardona, et al. Expires 14 December 2025 [Page 40] Internet-Draft BMP YANG Module June 2025 | | | | boolean | | | +--rw peers-configurations | | | +--rw peers | | | | +--rw peer* [peer-id] | | | | +--rw peer-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw peer-groups | | | | +--rw peer-group* | | | | [peer-group-id] | | | | +--rw peer-group-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bmp-peer-selectors | | | | +--rw bmp-peer-selector* | | | | [bmp-selector-id] | | | | +--rw bmp-selector-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? Cardona, et al. Expires 14 December 2025 [Page 41] Internet-Draft BMP YANG Module June 2025 | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bgp-peer-types | | | +--rw bgp-peer-type* | | | | [bgp-peer-type-id] | | | | +--rw bgp-peer-type-id | | | | bt:peer-type | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-base\ d-on-route-policy}? | | | +--rw export-policy* | | | | leafref | | | +--rw default-export-\ policy? | | | rt-pol:defaul\ t-policy-type | | +--rw adj-rib-in-post | | | +--rw address-families | | | +--rw address-family* | | | [address-family-id] | | | +--rw address-family-id | | | | identityref | | | +--rw enabled? | | | | boolean | | | +--rw peers-configurations | | | +--rw peers | | | | +--rw peer* [peer-id] | | | | +--rw peer-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? Cardona, et al. Expires 14 December 2025 [Page 42] Internet-Draft BMP YANG Module June 2025 | | | | rt-pol:def\ ault-policy-type | | | +--rw peer-groups | | | | +--rw peer-group* | | | | [peer-group-id] | | | | +--rw peer-group-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bmp-peer-selectors | | | | +--rw bmp-peer-selector* | | | | [bmp-selector-id] | | | | +--rw bmp-selector-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bgp-peer-types | | | +--rw bgp-peer-type* | | | | [bgp-peer-type-id] | | | | +--rw bgp-peer-type-id | | | | bt:peer-type | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-base\ Cardona, et al. Expires 14 December 2025 [Page 43] Internet-Draft BMP YANG Module June 2025 d-on-route-policy}? | | | +--rw export-policy* | | | | leafref | | | +--rw default-export-\ policy? | | | rt-pol:defaul\ t-policy-type | | +--rw local-rib | | | +--rw address-families | | | +--rw address-family* | | | [address-family-id] | | | +--rw address-family-id | | | | identityref | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-based-on-r\ oute-policy}? | | | +--rw export-policy* | | | | leafref | | | +--rw default-export-policy? | | | rt-pol:default-poli\ cy-type | | +--rw adj-rib-out-pre | | | +--rw address-families | | | +--rw address-family* | | | [address-family-id] | | | +--rw address-family-id | | | | identityref | | | +--rw enabled? | | | | boolean | | | +--rw peers-configurations | | | +--rw peers | | | | +--rw peer* [peer-id] | | | | +--rw peer-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type Cardona, et al. Expires 14 December 2025 [Page 44] Internet-Draft BMP YANG Module June 2025 | | | +--rw peer-groups | | | | +--rw peer-group* | | | | [peer-group-id] | | | | +--rw peer-group-id | | | | | string | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bmp-peer-selectors | | | | +--rw bmp-peer-selector* | | | | [bmp-selector-id] | | | | +--rw bmp-selector-id | | | | | identityref | | | | +--rw enabled? | | | | | boolean | | | | +--rw filters | | | | +--rw policy-filter | | | | {bmp-filter-b\ ased-on-route-policy}? | | | | +--rw export-polic\ y* | | | | | leafref | | | | +--rw default-expo\ rt-policy? | | | | rt-pol:def\ ault-policy-type | | | +--rw bgp-peer-types | | | +--rw bgp-peer-type* | | | | [bgp-peer-type-id] | | | | +--rw bgp-peer-type-id | | | | bt:peer-type | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-base\ d-on-route-policy}? | | | +--rw export-policy* Cardona, et al. Expires 14 December 2025 [Page 45] Internet-Draft BMP YANG Module June 2025 | | | | leafref | | | +--rw default-export-\ policy? | | | rt-pol:defaul\ t-policy-type | | +--rw adj-rib-out-post | | +--rw address-families | | +--rw address-family* | | [address-family-id] | | +--rw address-family-id | | | identityref | | +--rw enabled? | | | boolean | | +--rw peers-configurations | | +--rw peers | | | +--rw peer* [peer-id] | | | +--rw peer-id | | | | string | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-b\ ased-on-route-policy}? | | | +--rw export-polic\ y* | | | | leafref | | | +--rw default-expo\ rt-policy? | | | rt-pol:def\ ault-policy-type | | +--rw peer-groups | | | +--rw peer-group* | | | [peer-group-id] | | | +--rw peer-group-id | | | | string | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-b\ ased-on-route-policy}? | | | +--rw export-polic\ y* | | | | leafref | | | +--rw default-expo\ rt-policy? | | | rt-pol:def\ Cardona, et al. Expires 14 December 2025 [Page 46] Internet-Draft BMP YANG Module June 2025 ault-policy-type | | +--rw bmp-peer-selectors | | | +--rw bmp-peer-selector* | | | [bmp-selector-id] | | | +--rw bmp-selector-id | | | | identityref | | | +--rw enabled? | | | | boolean | | | +--rw filters | | | +--rw policy-filter | | | {bmp-filter-b\ ased-on-route-policy}? | | | +--rw export-polic\ y* | | | | leafref | | | +--rw default-expo\ rt-policy? | | | rt-pol:def\ ault-policy-type | | +--rw bgp-peer-types | | +--rw bgp-peer-type* | | | [bgp-peer-type-id] | | | +--rw bgp-peer-type-id | | | bt:peer-type | | +--rw enabled? | | | boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-base\ d-on-route-policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-\ policy? | | rt-pol:defaul\ t-policy-type | +--rw bmp-route-mirroring! +--ro session-stats | +--ro discontinuity-time | | yang:date-and-time | +--ro established-session? boolean | +--ro total-route-monitoring-messages? uint64 | +--ro total-statistics-messages? uint64 | +--ro total-peer-down-messages? uint64 | +--ro total-peer-up-messages? uint64 | +--ro total-initiation-messages? uint64 | +--ro total-route-mirroring-messages? uint64 | +--ro total-termination-messages? uint64 Cardona, et al. Expires 14 December 2025 [Page 47] Internet-Draft BMP YANG Module June 2025 | +--ro route-monitoring-stats | +--ro network-instances-stats | +--ro network-instance* | [network-instance-name] | +--ro network-instance-name | | leafref | +--ro enabled? | | boolean | +--ro total-route-mirroring-messages-per-ni? | | uint64 | +--ro ribs-stats | +--ro adj-rib-in-pre | | +--ro enabled? | | | boolean | | +--ro total-route-mirroring-messages-pe\ r-rib? | | | uint64 | | +--ro address-families | | +--ro address-family* | | [address-family-id] | | +--ro address-family-id | | | identityref | | +--ro enabled? | | | boolean | | +--ro total-route-monitoring-upda\ ted-prefixes-per-af? | | | uint64 | | +--ro total-route-monitoring-with\ draw-prefixes-per-af? | | | uint64 | | +--ro peers-stats | | +--ro peer* [peer-id] | | +--ro peer-id | | | string | | +--ro enabled? | | | boolean | | +--ro total-route-monitorin\ g-updated-prefixes-per-peer? | | | uint64 | | +--ro total-route-monitorin\ g-withdraw-prefixes-per-peer? | | uint64 | +--ro adj-rib-in-post | | +--ro enabled? | | | boolean | | +--ro total-route-mirroring-messages-pe\ r-rib? | | | uint64 Cardona, et al. Expires 14 December 2025 [Page 48] Internet-Draft BMP YANG Module June 2025 | | +--ro address-families | | +--ro address-family* | | [address-family-id] | | +--ro address-family-id | | | identityref | | +--ro enabled? | | | boolean | | +--ro total-route-monitoring-upda\ ted-prefixes-per-af? | | | uint64 | | +--ro total-route-monitoring-with\ draw-prefixes-per-af? | | | uint64 | | +--ro peers-stats | | +--ro peer* [peer-id] | | +--ro peer-id | | | string | | +--ro enabled? | | | boolean | | +--ro total-route-monitorin\ g-updated-prefixes-per-peer? | | | uint64 | | +--ro total-route-monitorin\ g-withdraw-prefixes-per-peer? | | uint64 | +--ro local-rib | | +--ro enabled? | | | boolean | | +--ro total-route-mirroring-messages-pe\ r-rib? | | | uint64 | | +--ro address-families | | +--ro address-family* | | [address-family-id] | | +--ro address-family-id | | | identityref | | +--ro enabled? | | | boolean | | +--ro total-route-monitoring-upda\ ted-prefixes-per-af? | | | uint64 | | +--ro total-route-monitoring-with\ draw-prefixes-per-af? | | uint64 | +--ro adj-rib-out-pre | | +--ro enabled? | | | boolean | | +--ro total-route-mirroring-messages-pe\ Cardona, et al. Expires 14 December 2025 [Page 49] Internet-Draft BMP YANG Module June 2025 r-rib? | | | uint64 | | +--ro address-families | | +--ro address-family* | | [address-family-id] | | +--ro address-family-id | | | identityref | | +--ro enabled? | | | boolean | | +--ro total-route-monitoring-upda\ ted-prefixes-per-af? | | | uint64 | | +--ro total-route-monitoring-with\ draw-prefixes-per-af? | | | uint64 | | +--ro peers-stats | | +--ro peer* [peer-id] | | +--ro peer-id | | | string | | +--ro enabled? | | | boolean | | +--ro total-route-monitorin\ g-updated-prefixes-per-peer? | | | uint64 | | +--ro total-route-monitorin\ g-withdraw-prefixes-per-peer? | | uint64 | +--ro adj-rib-out-post | +--ro enabled? | | boolean | +--ro total-route-mirroring-messages-pe\ r-rib? | | uint64 | +--ro address-families | +--ro address-family* | [address-family-id] | +--ro address-family-id | | identityref | +--ro enabled? | | boolean | +--ro total-route-monitoring-upda\ ted-prefixes-per-af? | | uint64 | +--ro total-route-monitoring-with\ draw-prefixes-per-af? | | uint64 | +--ro peers-stats | +--ro peer* [peer-id] Cardona, et al. Expires 14 December 2025 [Page 50] Internet-Draft BMP YANG Module June 2025 | +--ro peer-id | | string | +--ro enabled? | | boolean | +--ro total-route-monitorin\ g-updated-prefixes-per-peer? | | uint64 | +--ro total-route-monitorin\ g-withdraw-prefixes-per-peer? | uint64 +--rw actions +---x session-reset | +--ro output | +--ro (outcome)? | +--:(success) | | +--ro success? empty | +--:(failure) | +--ro failure? string +---x session-counter-reset +--ro output +--ro (outcome)? +--:(success) | +--ro success? empty +--:(failure) +--ro failure? string augment /rt:routing/rt:control-plane-protocols /rt:control-plane-protocol/bgp:bgp: +--rw bmp-data +--rw bmp-monitoring-stations! +--rw bmp-monitoring-station* [id] +--rw id string +--rw bmp-route-monitoring! +--rw enabled? boolean +--rw adj-rib-in-pre | +--rw address-families | +--rw address-family* [address-family-id] | +--rw address-family-id | | identityref | +--rw enabled? boolean | +--rw peers-configurations | +--rw bmp-peer-selectors | | +--rw bmp-peer-selector* | | [bmp-selector-id] | | +--rw bmp-selector-id | | | identityref | | +--rw enabled? Cardona, et al. Expires 14 December 2025 [Page 51] Internet-Draft BMP YANG Module June 2025 | | | boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-ro\ ute-policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-polic\ y-type | +--rw peer-types | | +--rw peer-type* [peer-type-id] | | | +--rw peer-type-id | | | bt:peer-type | | +--rw enabled? boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-route\ -policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-policy-t\ ype | +--rw peer-groups | | +--rw peer-group* [peer-group] | | +--rw peer-group leafref | | +--rw enabled? boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-ro\ ute-policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-polic\ y-type | +--rw peers | +--rw peer* [peer-id] | +--rw peer-id leafref | +--rw enabled? boolean | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-ro\ ute-policy}? | +--rw export-policy* | | leafref | +--rw default-export-policy? Cardona, et al. Expires 14 December 2025 [Page 52] Internet-Draft BMP YANG Module June 2025 | rt-pol:default-polic\ y-type +--rw adj-rib-in-post | +--rw address-families | +--rw address-family* [address-family-id] | +--rw address-family-id | | identityref | +--rw enabled? boolean | +--rw peers-configurations | +--rw bmp-peer-selectors | | +--rw bmp-peer-selector* | | [bmp-selector-id] | | +--rw bmp-selector-id | | | identityref | | +--rw enabled? | | | boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-ro\ ute-policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-polic\ y-type | +--rw peer-types | | +--rw peer-type* [peer-type-id] | | | +--rw peer-type-id | | | bt:peer-type | | +--rw enabled? boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-route\ -policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-policy-t\ ype | +--rw peer-groups | | +--rw peer-group* [peer-group] | | +--rw peer-group leafref | | +--rw enabled? boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-ro\ ute-policy}? | | +--rw export-policy* Cardona, et al. Expires 14 December 2025 [Page 53] Internet-Draft BMP YANG Module June 2025 | | | leafref | | +--rw default-export-policy? | | rt-pol:default-polic\ y-type | +--rw peers | +--rw peer* [peer-id] | +--rw peer-id leafref | +--rw enabled? boolean | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-ro\ ute-policy}? | +--rw export-policy* | | leafref | +--rw default-export-policy? | rt-pol:default-polic\ y-type +--rw local-rib | +--rw address-families | +--rw address-family* [address-family-id] | +--rw address-family-id identityref | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-route-polic\ y}? | +--rw export-policy* | | leafref | +--rw default-export-policy? | rt-pol:default-policy-type +--rw adj-rib-out-pre | +--rw address-families | +--rw address-family* [address-family-id] | +--rw address-family-id | | identityref | +--rw enabled? boolean | +--rw peers-configurations | +--rw bmp-peer-selectors | | +--rw bmp-peer-selector* | | [bmp-selector-id] | | +--rw bmp-selector-id | | | identityref | | +--rw enabled? | | | boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-ro\ ute-policy}? | | +--rw export-policy* Cardona, et al. Expires 14 December 2025 [Page 54] Internet-Draft BMP YANG Module June 2025 | | | leafref | | +--rw default-export-policy? | | rt-pol:default-polic\ y-type | +--rw peer-types | | +--rw peer-type* [peer-type-id] | | | +--rw peer-type-id | | | bt:peer-type | | +--rw enabled? boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-route\ -policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-policy-t\ ype | +--rw peer-groups | | +--rw peer-group* [peer-group] | | +--rw peer-group leafref | | +--rw enabled? boolean | | +--rw filters | | +--rw policy-filter | | {bmp-filter-based-on-ro\ ute-policy}? | | +--rw export-policy* | | | leafref | | +--rw default-export-policy? | | rt-pol:default-polic\ y-type | +--rw peers | +--rw peer* [peer-id] | +--rw peer-id leafref | +--rw enabled? boolean | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-ro\ ute-policy}? | +--rw export-policy* | | leafref | +--rw default-export-policy? | rt-pol:default-polic\ y-type +--rw adj-rib-out-post +--rw address-families +--rw address-family* [address-family-id] +--rw address-family-id Cardona, et al. Expires 14 December 2025 [Page 55] Internet-Draft BMP YANG Module June 2025 | identityref +--rw enabled? boolean +--rw peers-configurations +--rw bmp-peer-selectors | +--rw bmp-peer-selector* | [bmp-selector-id] | +--rw bmp-selector-id | | identityref | +--rw enabled? | | boolean | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-ro\ ute-policy}? | +--rw export-policy* | | leafref | +--rw default-export-policy? | rt-pol:default-polic\ y-type +--rw peer-types | +--rw peer-type* [peer-type-id] | | +--rw peer-type-id | | bt:peer-type | +--rw enabled? boolean | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-route\ -policy}? | +--rw export-policy* | | leafref | +--rw default-export-policy? | rt-pol:default-policy-t\ ype +--rw peer-groups | +--rw peer-group* [peer-group] | +--rw peer-group leafref | +--rw enabled? boolean | +--rw filters | +--rw policy-filter | {bmp-filter-based-on-ro\ ute-policy}? | +--rw export-policy* | | leafref | +--rw default-export-policy? | rt-pol:default-polic\ y-type +--rw peers +--rw peer* [peer-id] Cardona, et al. Expires 14 December 2025 [Page 56] Internet-Draft BMP YANG Module June 2025 +--rw peer-id leafref +--rw enabled? boolean +--rw filters +--rw policy-filter {bmp-filter-based-on-ro\ ute-policy}? +--rw export-policy* | leafref +--rw default-export-policy? rt-pol:default-polic\ y-type 5.2. Base BMP YANG Module 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-bgp-types { prefix bt; description "The bgp types is a model that contains just types. Vendors can include it without implications."; reference "RFC AAAA: BGP YANG module for Service Provider Network. RFC-EDITOR: please update XXX with the RFC ID assigned to I-D.ietf-idr-bgp-model"; } 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"; Cardona, et al. Expires 14 December 2025 [Page 57] Internet-Draft BMP YANG Module June 2025 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). 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. Cardona, et al. Expires 14 December 2025 [Page 58] Internet-Draft BMP YANG Module June 2025 Copyright (c) 2022 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 9196 (https://www.rfc-editor.org/info/rfc9196); 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"; } identity bmp-peer-selectors { description "Enum values for selecting peers"; } identity bmp-peer-selectors-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 "Enum values for selecting one or more network instances for configuration"; } identity bmp-ni-types-all-ni { base bmp-ni-types; description "This identity is an explicit way to select all network instances."; } identity bmp-ni-types-global-ni { Cardona, et al. Expires 14 December 2025 [Page 59] Internet-Draft BMP YANG Module June 2025 base bmp-ni-types; description "Selecting the global or main network instance"; } identity bmp-ni-types-non-global-ni { base bmp-ni-types; description "This identity is an explicit way to select all network instances except the global one."; } feature bmp-filter-based-on-route-policy { description "This feature means that the device is capable of filtering prefixes in BMP monitoring sessions"; } grouping bmp-ip-connection { 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."; Cardona, et al. Expires 14 December 2025 [Page 60] Internet-Draft BMP YANG Module June 2025 } 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 leafref { path "/if:interfaces/if:interface/if:name"; } 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."; Cardona, et al. Expires 14 December 2025 [Page 61] Internet-Draft BMP YANG Module June 2025 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 leafref { path "/if:interfaces/if:interface/if:name"; } description "Local interface to accept the connection."; } } } leaf monitored-router-port { type inet:port-number; mandatory true; description "Local port to accept the connection."; Cardona, et al. Expires 14 December 2025 [Page 62] Internet-Draft BMP YANG Module June 2025 } } } } leaf dscp { type inet:dscp; description "DSCP value for marking traffic to the monitoring station."; reference "RFC 6991: Common YANG Data Types"; } } grouping bmp-route-monitoring-peer-configuration { 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."; } } } Cardona, et al. Expires 14 December 2025 [Page 63] Internet-Draft BMP YANG Module June 2025 } grouping bmp-peer-ribs-filter { 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 "address-family-id"; description "Address family, as defined in the BGP model."; leaf address-family-id { type identityref { base bt: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. bmp-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 Cardona, et al. Expires 14 December 2025 [Page 64] Internet-Draft BMP YANG Module June 2025 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 "peer-id"; description "Peer identifier."; leaf peer-id { type string; description "Identifier of the peer."; } leaf enabled { type boolean; default "true"; description "Enables route monitoring messages for this peer."; } uses bmp-route-monitoring-peer-configuration; } } container peer-groups { description "Configuration for peer groups."; list peer-group { key "peer-group-id"; description "Peer group identifier."; leaf peer-group-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 bmp-route-monitoring-peer-configuration; } } container bmp-peer-selectors { description Cardona, et al. Expires 14 December 2025 [Page 65] Internet-Draft BMP YANG Module June 2025 "Configuration for peers selected by BMP peer selectors."; list bmp-peer-selector { key "bmp-selector-id"; description "Identification of peers for which we send BMP data to the collector using a peer type defined using a peer-types-bmp. For instance, to create a default for all peers use bmp-peer-selectors-all-peers"; leaf bmp-selector-id { type identityref { base bmp-peer-selectors; } description "BMP peer selector identity."; } leaf enabled { type boolean; default "true"; description "Enables routing monitoring messages for the peer(s)."; } uses bmp-route-monitoring-peer-configuration; } } container bgp-peer-types { description "Generic identification of peers to configure."; list bgp-peer-type { key "bgp-peer-type-id"; description "Identification of peers for which we send BMP data to the collector using BGP peer-type (e.g. internal, external) "; leaf bgp-peer-type-id { type bt:peer-type; description "BGP peer type."; } } leaf enabled { type boolean; default "true"; description "Enables routing monitoring messages Cardona, et al. Expires 14 December 2025 [Page 66] Internet-Draft BMP YANG Module June 2025 for the peer(s)."; } uses bmp-route-monitoring-peer-configuration; } } } } } grouping generic-network-instance-configuration { 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; } 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; } 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 "address-family-id"; description "Address family to enable for local-rib"; leaf address-family-id { type identityref { Cardona, et al. Expires 14 December 2025 [Page 67] Internet-Draft BMP YANG Module June 2025 base bt:afi-safi-type; } description "Address family id to enable for local-rib"; } uses bmp-route-monitoring-peer-configuration; } } } container adj-rib-out-pre { description "Configuration for the adj-rib-out pre-policy"; uses bmp-peer-ribs-filter; reference "RFC8671: Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP) , Section 3."; } container adj-rib-out-post { description "Configuration for the adj-rib-out post-policy"; uses bmp-peer-ribs-filter; reference "RFC8671: Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP) , Section 3."; } } grouping bmp-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, bmp-ni-types-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 Cardona, et al. Expires 14 December 2025 [Page 68] Internet-Draft BMP YANG Module June 2025 the network instance, the priority for selecting the container to use for configuration is: 1. The configuration under the BGP container, if supported by the implementation (see ietf-bmp-bgp-dependencies.yang) 2. For any other named network instance, the configuration under the element listed with its name under the network-instance container. 3. The configuration under network-instance-groups of type bmp-ni-types-non-global-ni if existing and not the global network instance. 4. the configuration under network-instance-groups under the element bmp-ni-types-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 "network-instance-id"; description "Network instance to monitor using BMP."; leaf network-instance-id { type leafref { path "/ni:network-instances/ni:network-instance/" + "ni:name"; } description "Name of the network instance."; } uses generic-network-instance-configuration; } } container network-instance-selectors { description "Configuration of network instances. Uses bmp-ni-types to identify one or a group of network instances to configure."; Cardona, et al. Expires 14 December 2025 [Page 69] Internet-Draft BMP YANG Module June 2025 list network-instance-selector { key "network-instance-selector-id"; description "Network instance(s) to monitor using BMP."; leaf network-instance-selector-id { type identityref { base bmp-ni-types; } description "Configures one or multiple network instances selected based on a bmp-ni-types identity (e.g. bmp-ni-types-all-ni for all of them)."; } uses generic-network-instance-configuration; } } } } container bmp { description "Top-level container for BMP configuration."; container bmp-monitoring-stations { description "List of BMP monitoring stations."; list bmp-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; container tcp-options { description "TCP options for the connection to the monitoring station."; Cardona, et al. Expires 14 December 2025 [Page 70] Internet-Draft BMP YANG Module June 2025 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 Cardona, et al. Expires 14 December 2025 [Page 71] Internet-Draft BMP YANG Module June 2025 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 bmp-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."; } } Cardona, et al. Expires 14 December 2025 [Page 72] Internet-Draft BMP YANG Module June 2025 container bmp-route-monitoring { description "Configuration of the data sources for route-monitoring messages"; uses bmp-route-monitoring-sources; } container bmp-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."; 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 Cardona, et al. Expires 14 December 2025 [Page 73] Internet-Draft BMP YANG Module June 2025 "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."; } grouping bmp-af-stats-with-peers { description "Generic statistics for an address family that can be disaggregated by peers"; container peers-stats { description "Peer stats"; list peer { key "peer-id"; description "List of peers"; leaf peer-id { type string; description "Peer id"; } Cardona, et al. Expires 14 December 2025 [Page 74] Internet-Draft BMP YANG Module June 2025 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-monitoring-updated-prefixes-per-peer { type uint64; description "Number of prefixes updated for this peer."; } leaf total-route-monitoring-withdraw-prefixes-per-peer { type uint64; description "Number of prefixes withdrawn for this peer."; } } } } grouping bmp-af-stats { 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."; } Cardona, et al. Expires 14 December 2025 [Page 75] Internet-Draft BMP YANG Module June 2025 } grouping bmp-rib-with-peers-stats { description "Generic statistics for a RIB with peers."; container address-families { description "List of address families to list stats."; list address-family { key "address-family-id"; description "Address family to enable for local-rib"; leaf address-family-id { type identityref { base bt:afi-safi-type; } description "Address family ID for local-rib."; } uses bmp-af-stats; uses bmp-af-stats-with-peers; } } } grouping bmp-rib-stats { 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."; } } container route-monitoring-stats { description Cardona, et al. Expires 14 December 2025 [Page 76] Internet-Draft BMP YANG Module June 2025 "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; uses bmp-rib-with-peers-stats; } container adj-rib-in-post { description "Statistics for adj-rib-in-post"; uses bmp-rib-stats; Cardona, et al. Expires 14 December 2025 [Page 77] Internet-Draft BMP YANG Module June 2025 uses bmp-rib-with-peers-stats; } container local-rib { description "Statistics for local-rib"; uses bmp-rib-stats; container address-families { description "List of address families to for stats."; list address-family { key "address-family-id"; description "Address family to enable for local-rib"; leaf address-family-id { type identityref { base bt:afi-safi-type; } description "Address family ID for local-rib"; } uses bmp-af-stats; } } } container adj-rib-out-pre { description "Statistics for adj-rib-out-pre"; uses bmp-rib-stats; uses bmp-rib-with-peers-stats; } container adj-rib-out-post { description "Statistics for adj-rib-out-post"; uses bmp-rib-stats; uses bmp-rib-with-peers-stats; } } } Cardona, et al. Expires 14 December 2025 [Page 78] Internet-Draft BMP YANG Module June 2025 } } } container actions { nacm:default-deny-all; 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 Cardona, et al. Expires 14 December 2025 [Page 79] Internet-Draft BMP YANG Module June 2025 "Reset could not be performed. The reason is included in the field."; } } } } } } } } } 5.3. BGP dependencies for BMP YANG Module file "ietf-bmp-bgp-dependencies.yang@2022-01-27.yang" module ietf-bmp-bgp-dependencies { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-bmp-bgp-dependencies"; prefix bmp-ietf-dep; import ietf-bmp { prefix bmp; } import ietf-routing { prefix rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)."; } import ietf-bgp { prefix bgp; reference "I-D.draft-ietf-idr-bgp-model-17: BGP YANG module for Service Provider Network."; } import ietf-bgp-types { prefix bt; reference "RFC AAAA: BGP YANG module for Service Provider Network. RFC-EDITOR: please update XXX with the RFC ID assigned to I-D.ietf-idr-bgp-model"; } Cardona, et al. Expires 14 December 2025 [Page 80] Internet-Draft BMP YANG Module June 2025 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) 2022 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 9196 (https://www.rfc-editor.org/info/rfc9196); 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"; Cardona, et al. Expires 14 December 2025 [Page 81] Internet-Draft BMP YANG Module June 2025 } grouping bmp-ni-peer-ribs-filter { description "Containers for configuring RIBs under the ietf-bgp:bgp container."; container address-families { description "container for lists of address-families"; list address-family { key "address-family-id"; description "List of address families. The name of the address family, as defined in the BGP model is used for keying."; leaf address-family-id { type identityref { base bt:afi-safi-type; } description "Address family id to configure"; } leaf enabled { type boolean; default "true"; description "Enables route monitoring messages for the address family"; } container peers-configurations { description "Every peer under the configured network instance can be at most configured by one of the next containers. If the peer is not covered by any, then no BMP message should include information from/to that peer. If the peer is covered by more than one, then the priority is: 1. peers 2. peer-groups 3. peer-type 4. bmp-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 multiple matches. "; container bmp-peer-selectors { description "Generic identification of peers to configure."; Cardona, et al. Expires 14 December 2025 [Page 82] Internet-Draft BMP YANG Module June 2025 list bmp-peer-selector { key "bmp-selector-id"; description "Identification of peers for which we send BMP data to the collector using a peer type defined using a peer-types-bmp. For instance, to create a default for all peers use bmp-peer-selectors-all-peers"; leaf bmp-selector-id { type identityref { base bmp:bmp-peer-selectors; } description "Peers to configure using a BMP peer selector"; } leaf enabled { type boolean; default "true"; description "Enables routing monitoring messages for the peer(s)."; } uses bmp:bmp-route-monitoring-peer-configuration; } } container peer-types { description "Generic identification of peers to configure."; list peer-type { key "peer-type-id"; description "Identification of peers for which we send BMP data to the collector using BGP peer-type (e.g. internal, external) "; leaf peer-type-id { type bt:peer-type; description "BGP Peer type to configure"; } } leaf enabled { type boolean; default "true"; description "Enables routing monitoring messages for the peer(s)."; } Cardona, et al. Expires 14 December 2025 [Page 83] Internet-Draft BMP YANG Module June 2025 uses bmp:bmp-route-monitoring-peer-configuration; } container peer-groups { description "Identification of peer-groups to configure"; list peer-group { key "peer-group"; description "Identification of peer-groups for which we send BMP data to the collector"; leaf peer-group { type leafref { path "../../../../../../../../../../../" + "bgp:peer-groups/bgp:peer-group/" + "bgp:name"; } description "Peergroup to configure"; } leaf enabled { type boolean; default "true"; description "Enables routing monitoring messages for the peer-group(s)."; } uses bmp:bmp-route-monitoring-peer-configuration; } } container peers { description "Identification of peers for which we send BMP data to the collector"; list peer { key "peer-id"; description "Identification of peers for which we send BMP data to the collector"; leaf peer-id { type leafref { path "../../../../../../../../../../../" + "bgp:neighbors/bgp:neighbor/" + "bgp:remote-address"; } description "Peer to configure"; } Cardona, et al. Expires 14 December 2025 [Page 84] Internet-Draft BMP YANG Module June 2025 leaf enabled { type boolean; default "true"; description "Enables routing monitoring messages for the peer(s)."; } uses bmp:bmp-route-monitoring-peer-configuration; } } } } } } // Augment the BGP module to include data for network instances augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/bgp:bgp" { description "Augments the BGP container under control-plane-protocol. It can be used to configure the global BGP instance, but also the network-instances under the module ietf-network-instance"; container bmp-data { description "Container for the configuration of BMP data related to this BGP instance"; container bmp-monitoring-stations { presence "If this container exists, the network instance must be configured using this"; description "Container for the configuration of BMP data related to this BGP instance"; list bmp-monitoring-station { key "id"; description "Container for the configuration of BMP data for this monitoring-station related to this BGP instance"; leaf id { // TODO: We have not been able to configure // the schema mount to recognize this yet. // Until we solve it, we will keep it as it is. //type leafref { // path "/bmp:bmp/bmp:bmp-monitoring-stations/" // + "bmp:bmp-monitoring-station/bmp:id"; //} Cardona, et al. Expires 14 December 2025 [Page 85] Internet-Draft BMP YANG Module June 2025 type string; description "Identification string for the monitoring station"; } container bmp-route-monitoring { presence "The presence of this container means the Network instance it contains MUST be configured using it"; description "Configuration of the data sources for route-monitoring messages for this network-instance"; leaf enabled { type boolean; default "true"; description "Enables routing 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-ni-peer-ribs-filter; } container adj-rib-in-post { description "Configuration for the adj-rib-in post-policy"; reference "RFC7854: BGP Monitoring Protocol (BMP), Section 2."; uses bmp-ni-peer-ribs-filter; } 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 "address-family-id"; description "Address family to enable for local-rib"; leaf address-family-id { type identityref { Cardona, et al. Expires 14 December 2025 [Page 86] Internet-Draft BMP YANG Module June 2025 base bt:afi-safi-type; } description "Address family id to enable for local-rib"; } uses bmp:bmp-route-monitoring-peer-configuration; } } } container adj-rib-out-pre { description "Configuration for the adj-rib-out pre-policy"; uses bmp-ni-peer-ribs-filter; reference "RFC8671: Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP) , Section 3."; } container adj-rib-out-post { description "Configuration for the adj-rib-out post-policy"; uses bmp-ni-peer-ribs-filter; reference "RFC8671: Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP) , Section 3."; } } } } } } } 5.4. TCP dependencies for BMP YANG Module 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 Cardona, et al. Expires 14 December 2025 [Page 87] Internet-Draft BMP YANG Module June 2025 "I-D.ietf-netconf-tcp-client-server: 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) 2022 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 9196 Cardona, et al. Expires 14 December 2025 [Page 88] Internet-Draft BMP YANG Module June 2025 (https://www.rfc-editor.org/info/rfc9196); 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:bmp-monitoring-stations/" + "bmp: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; case ao { 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."; } 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."; } case md5 { 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."; Cardona, et al. Expires 14 December 2025 [Page 89] Internet-Draft BMP YANG Module June 2025 } 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."; } description "Choice of TCP authentication."; } } } } 6. Security Considerations The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446]. The NETCONF Access Control Model (NACM) [RFC8341] provides the means to restrict access for NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. BGP data is sensitive for security considerations. The model described in this document could be used to send BGP information to malicious BMP stations. Write access to this model SHOULD therefore be properly protected. The session-reset action can demand a considerable amount of resources from network elements. It SHOULD thus be protected from unauthorized access. 7. IANA Considerations 7.1. The IETF XML Registry This document registers a URIs in the IETF XML registry [RFC3688]. Following the format in [RFC3688], the following registrations are requested: Cardona, et al. Expires 14 December 2025 [Page 90] Internet-Draft BMP YANG Module June 2025 URI: urn:ietf:params:xml:ns:yang:ietf-bmp Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. 7.2. The YANG Module Name Registration This document registers the following YANG module in the " YANG Module Names" registry registry [RFC6020]: Name: ietf-bmp Namespace: urn:ietf:params:xml:ns:yang:ietf-bmp Prefix: bmp Reference: [This RFC-to-be] 8. Open Issues The security considerations section will have to be aligned with https://trac.ietf.org/trac/ops/wiki/yang-security-guidelines 9. Normative References [I-D.ietf-idr-bgp-model] Jethanandani, M., Patel, K., Hares, S., and J. Haas, "YANG Model for Border Gateway Protocol (BGP-4)", Work in Progress, Internet-Draft, draft-ietf-idr-bgp-model-18, 21 October 2024, . [I-D.ietf-netconf-tcp-client-server] Watsen, K. and M. Scharf, "YANG Groupings for TCP Clients and TCP Servers", Work in Progress, Internet-Draft, draft- ietf-netconf-tcp-client-server-26, 4 April 2024, . [RFC1191] Mogul, J. and S. Deering, "Path MTU discovery", RFC 1191, DOI 10.17487/RFC1191, November 1990, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . Cardona, et al. Expires 14 December 2025 [Page 91] Internet-Draft BMP YANG Module June 2025 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, . [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . [RFC7854] Scudder, J., Ed., Fernando, R., and S. Stuart, "BGP Monitoring Protocol (BMP)", RFC 7854, DOI 10.17487/RFC7854, June 2016, . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8177] Lindem, A., Ed., Qu, Y., Yeung, D., Chen, I., and J. Zhang, "YANG Data Model for Key Chains", RFC 8177, DOI 10.17487/RFC8177, June 2017, . [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for Routing Management (NMDA Version)", RFC 8349, DOI 10.17487/RFC8349, March 2018, . Cardona, et al. Expires 14 December 2025 [Page 92] Internet-Draft BMP YANG Module June 2025 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, . [RFC8529] Berger, L., Hopps, C., Lindem, A., Bogdanovic, D., and X. Liu, "YANG Data Model for Network Instances", RFC 8529, DOI 10.17487/RFC8529, March 2019, . [RFC8671] Evens, T., Bayraktar, S., Lucente, P., Mi, P., and S. Zhuang, "Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP)", RFC 8671, DOI 10.17487/RFC8671, November 2019, . [RFC9069] Evens, T., Bayraktar, S., Bhardwaj, M., and P. Lucente, "Support for Local RIB in the BGP Monitoring Protocol (BMP)", RFC 9069, DOI 10.17487/RFC9069, February 2022, . [RFC9293] Eddy, W., Ed., "Transmission Control Protocol (TCP)", STD 7, RFC 9293, DOI 10.17487/RFC9293, August 2022, . Appendix A. Examples This section shows some examples of BMP configuration using the model. A.1. Example one 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. =============== NOTE: '\' line wrapping per RFC 8792 ================ 1 192.0.2.1 57992 192.0.2.2 Cardona, et al. Expires 14 December 2025 [Page 93] Internet-Draft BMP YANG Module June 2025 bmp-ni-types-all-ni bt:ipv6-unicast external bt:ipv4-unicast external Figure 16 Cardona, et al. Expires 14 December 2025 [Page 94] Internet-Draft BMP YANG Module June 2025 A.2. Example two 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. bmp-ni- types-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. =============== NOTE: '\' line wrapping per RFC 8792 ================ bgp:bgp\ BGP 64496 192.0.2.1 198.51.100.11 64497 2 Cardona, et al. Expires 14 December 2025 [Page 95] Internet-Draft BMP YANG Module June 2025 bt:ipv6-unicast 198.51.100.11 false external bt:ipv4-unicast 198.51.100.11 false external Cardona, et al. Expires 14 December 2025 [Page 96] Internet-Draft BMP YANG Module June 2025 2 monitoring 192.0.2.1 192.0.2.2 57993 bmp-ni-types-all-ni<\ /network-instance-selector-id> bt:ipv6-unicast bmp-peer-selectors-all-\ peers bt:ipv4-unicast bmp-peer-selectors-all-pe\ ers Cardona, et al. Expires 14 December 2025 [Page 97] Internet-Draft BMP YANG Module June 2025 monitoring false Figure 17 Acknowledgements The authors would like to thank Yimin Shen, Jeff Haas, Pierre Vander Vorst, and Tom Petch for their review and feedback. Authors' Addresses Camilo Cardona NTT 164-168, Carrer de Numancia 08029 Barcelona Spain Email: camilo@ntt.net Paolo Lucente NTT Siriusdreef 70-72 2132 Hoofddorp Netherlands Email: paolo@ntt.net Thomas Graf Swisscom Binzring 17 CH- Zurich 8045 Switzerland Email: thomas.graf@swisscom.com Cardona, et al. Expires 14 December 2025 [Page 98] Internet-Draft BMP YANG Module June 2025 Benoit Claise Huawei Email: benoit.claise@huawei.com Dhananjay Patki Cisco Cessna Business Park SEZ, Kadubeesanahalli Bangalore India Email: dhpatki@cisco.com Prasad S. Narasimha Cisco Cessna Business Park SEZ, Kadubeesanahalli Bangalore India Email: snprasad@cisco.com Cardona, et al. Expires 14 December 2025 [Page 99]