BMP YANG ModuleNTT164-168, Carrer de NumanciaBarcelona08029Spaincamilo@ntt.netNTTSiriusdreef 70-72Hoofddorp2132Netherlandspaolo@ntt.netSwisscomBinzring 17Zurich 8045Switzerlandthomas.graf@swisscom.comHuaweibenoit.claise@huawei.com
OPS
GROW
This document proposes a YANG module for the 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
when, and only when, they appear in all capitals, as shown here.
Routing Information Bases, peers, monitoring stations, and
initiation messages are defined in .
This document specifies a YANG module for configuring and
monitoring the BGP Monitoring Protocol (BMP) . The model
provides parameters for configuring the session to BMP monitoring stations; the
selection of the BGP Routing Information Bases (RIBs) for Route Monitoring Messages; provides
operational metrics and enables resetting of BMP monitoring sessions.
The model is included in . In this
section, we provide details and examples of each of its parts.The BMP yang model is placed at the root of the YANG tree. At its
upper level, the BMP model lists each monitoring station. Every
monitoring station is identified by an ID, which is a string
provided by the operator. BMP allows for active and passive
connections between the router and the BMP monitoring station as described in . In
an active connection, the router establishes the TCP connection to
the monitoring station, while in a passive one, it is the monitoring
station which initiates the connection. The BMP yang module
provides options for both types of connection using a choice.We describe each type of connection option next, and provide
examples of their configuration.For an active connection, the IP address and port of the monitoring
station, together with the local address MUST be provided. One can
optionally provide the local port for establishing the connection.
If the monitoring station is connected over a network-instance
instead of the global one, this one must also be specified. An
example of configuration is included in .Active connection exampleNote in the example from
that there is no network instance defined, so the connection is
using the global network instance.In a passive connection, the IP of the monitoring station, the local address 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.Passive connection exampleThe BMP module allows tuning various parameters of the TCP
connection supporting the BMP session:
For configuring TCP keepalives, the connection container uses the tcp-common-grouping from . Please see for the explanation of each of its parameters. Note that for the configuration of these parameters, the device must have the feature "tcp-client-keepalives" enabled. See also
The maximum segment of the TCP connection. See .
Enabling MTU discovery for the path. See .
Session security. Provides options for authentication using AO and MD5. This part of the model was taken from the BGP yang model .
Figures and include examples configuring the previous TCP parameters in the model.Example of configuring basic TCP parametersExample of the Configuration of TCP session security.The model also includes the next options to configure the connection to the BMP monitoring station:
Initial-delay: a value in seconds that the device must hold back before starting the connection to the station.
Backoff time. Configuration of the backoff time strategy after failing to connect to the monitoring station. The model includes a basic exponential backoff with a default initial backoff of 30 seconds and a maximum of 720 seconds, as suggested in .
In the example in , we configure an initial-delay of 10. Configuring an initial-backoff of 50 seconds and 600 of maximum-backoff.Example of the initial-delay and simple exponential backoff.The bmp-data container defines the configuration parameters for the data that the devices sends to the monitoring station using the various BMP messages. See .The BMP model defines options for the initiation message, the statistics report, and the routing monitoring. The first two have simple configurations options and are shortly described next. The Routing monitoring is the most complex of all and it is detailed in .
Initiation-message: Content for an information TLV type-0 for identification of the device. See and
Statistics-interval: The statistics report is enabled by the presence of the 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 .
An example of configuring the previous options is included in Example of configuration of initiation-message and statistics report interval.Route monitoring messages are used for synchronization of RIBs to the monitoring station. See .The next 3 requirements were defined before designing this part of the model.
Operators might not want to receive all routes from all RIBs in a network device. For instance, some devices contain a considerable amount of data that might overwhelm the monitoring station. In this 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, etc/OUT and local RIB) and Address families is low, and their configuration should not change frequently. Therefore, they are configured explicitly in the model. That is, the model does not provide a way of providing a default configuration for these or configuring them in groups.On the other hand, Network instances and peers require greater flexibility.For network instances, the model should configure not only the "global" network instance (the main one configured under the /ietf-routing:routing), but also other network instances configured under the /ietf-network-instance: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 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 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/peer-type container includes a route-policy option in which the operator can further filter the data send to the BMP monitoring station.We'll describe each of the 4 hierarchies, and provide examples for each, in the next sections.The routing monitoring configuration starts with the selection of network instance. One or more Network instances can be selected using a "bmp-ni-types" identity, or they can be selected individually, referencing the /network-instance/ list.The model currently defines two bmp-ni-types identities: "bmp-ni-types-all-ni" which selects all network instances, and "bmp-ni-types-global-ni" which selects the global network instance (the one configured in `/ietf-routing:routing/`). The former can be used as a "default" configuration for simple cases.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 maximum one element of the network-instances list. There SHOULD be clear rules to 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.
If the bmp-ni-types-global-ni exist, the global network instance / network instance SHOULD be configured using this element.
If any /ni:network-instances/ni:network-instance/ is referenced, the network instance SHOULD be configured using this element.
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. To focus on the network instance configuration, we mask the configuration under each instance using "Configuration X". Examples of configuring the network instance level for Route Monitoring.
!
bmp-data bmp-route-monitoring network-instances network-instance bm\
p-ni-types-global-ni
< Configuration B >
!
bmp-data bmp-route-monitoring network-instances network-instance ne\
twork-instance-one
enabled false
!
bmp-data bmp-route-monitoring network-instances network-instance ne\
twork-instance-two
< Configuration C >
!
]]>In example from , we have a "default" configuration (Configuration A) applied to any network instance without any explicit configuration. The global network instance and network-instance-two get Configuration B and Configuration C, respectively. The network-instance-one instance disables the routing monitoring messages for that network instance.Example of configuring all network instances.
!
]]>The example in 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 Example of configuring only the global network instance.
!
]]>Each RIB type is configured explicitly in the model through a container. The model currently provides containers for adj-rib-out-pre, adj-rib-out-post, adj-rib-in-post, adj-rib-in-pre and local-rib. An empty configuration or absence of a RIB-type container disables route-messages for it. Operators can also disable the RIB-type route monitoring messages by marking the "enabled" leaf as False.We provide an example of this together with address families in the next sectionAddress families are configured explicitly within each RIB-TYPE using a list. The key is of type `ietf-bgp-types:afi-safi-type` without any further constraint.An empty configuration or absence of an address family disables route-messages for it. Operators can also disable the address-family route monitoring messages by marking the "enabled" leaf as False.We show a few examples of configuring RIB-Types and Address families next. We will mask further configurations of address families with "Configuration X" to focus on the covered parts.Example of configuring RIBs and address families.
!
adj-rib-in-pre address-families address-family ipv4-unicast
< Configuration G >
!
!
bmp-data bmp-route-monitoring network-instances network-instance bm\
p-ni-types-global-ni
adj-rib-in-pre address-families address-family ipv6-unicast
< Configuration H >
!
adj-rib-in-pre address-families address-family ipv4-unicast
< Configuration I >
!
adj-rib-in-post address-families address-family ipv6-unicast
< Configuration J >
!
adj-rib-in-post address-families address-family ipv4-unicast
< Configuration K >
!
!
bmp-data bmp-route-monitoring network-instances network-instance ne\
twork-instance-one
disabled
!
bmp-data bmp-route-monitoring network-instances network-instance ne\
twork-instance-two
adj-rib-out-post address-families address-family ipv4-unicast
< Configuration L >
!
!
!
]]>In , we expand previous sections examples with RIB-Type and address families configurations. The expected result of the previous configuration would be:
For the global network instance, adj-rib-in-pre and adj-rib-in-post RIBs are enabled. In each of them IPv4 and IPv6 address families are configured. The configuration can be the same or not, depending on the requirements of the operators. Any other RIB and address families are disabled.
Network instance 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
If an operator only wants to configure the IPv4/IPv6 of adj-rib-pre-in for the global instance, the configuration in will be enough. We note again that even if the configuration of both address families is the same, they must be explicitly configured for each of them.Example of configuring RIBs and address families.
!
adj-rib-in-pre address-families address-family ipv4-unicast
< config for ipv4-unicast >
!
!
]]>For adj-RIB-in and adj-RIB-out, both pre and post, the model requires the selection of peer's RIBs that will be transmitted to the monitoring station. The local-rib does not include this container.Peers are a list indexed by a peer id, which can be one of the following:
An individual peer, using a remote address. The model currently does not check if the remote address exists, that would be a responsibility of the device.
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 maximum a single instance of the peers list. For the included keys in the BMP model, the process to select which instance to use is the next:
If there is a peer address matching the peer, it should be configured using that instance.
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.Any additional bmp-peer-types identity created SHOULD describe how to unambiguously select a peer when there are conflicting options (multiple options covering the peer).We'll provide examples of the peers configuration after describing the filter containers.The local rib, and the peer containers within the rest of rib types, include a filter container. This container includes mechanisms to filter route-monitoring messages for the specific RIB.The policy-filter can include a routing policy that, if existing, should be applied to the outgoing updates to the monitoring station, and would serve as a granular way of filtering the messages that the monitoring station receives. Note that the policy-filter contains an `accept-route` default export policy. An operator can change it to a reject-route, if required.The policies created with the routing-policy can perform a large variety of actions 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.In the example configuration from , address families IPv6 and IPv4 are configured to send all peers. This is an example of a simple configurationEnabling Route monitoring for all peers; all network instances; IPv4/IPv6 Address families, in the adj-rib-in-pre RIB.In the example in , the global network instance enables the adj-rib-in-pre. In this RIB, the IPv4 unicast address family is configured for all external peers. We assume peer 198.51.100.1 is external, but its BGP configuration is not shown in the snippet. Peer 198.51.100.1, however, has a specific configuration: it announces everything but prefixes matching the test_policy list. Note that there is a default accept-route default policy in the model.Configuring address families differently for the global network instanceIn the example from , all network instances have adj-rib-in-pre with IPv6 and IPv4 configured receiving all peers. network-instance-one is disabled, and network-instance-two is announcing only the local-rib/IPv4 unicast routes.Applying a general configuration to all network instances, except of two, which are configured specifically.The non-configurable container "session-stats" includes various metrics for the session with the monitoring station.The "session-reset" action resets a session with a monitoring station.
The following tree diagram provides an overview of the ietf-bmp.yang
data model.
<CODE BEGINS> file "ietf-bmp@2022-01-27.yang"
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 2022-10-18 {
description
"initial version";
reference
"RFC YYYY: BMP YANG Module
RFC-EDITOR: please update YYYY with this RFC ID";
}
identity bmp-peer-types {
description
"Enum values for multiple selecting peer's
Routing Information Bases (RIB) for configuration.";
}
identity bmp-peer-types-all-peers {
base bmp-peer-types;
description
"This identity selects all peer's RIBs.
When used, it act as a 'default' configuration.";
}
identity bmp-ni-types {
description
"Enum values for selecting multiple Network instances
for configuration";
}
identity bmp-ni-types-all-ni {
base bmp-ni-types;
description
"The identify is an explicit way
of selecting all network instances.";
}
identity bmp-ni-types-global-ni {
base bmp-ni-types;
description
"Selects the global network instance";
}
grouping bmp-tcp-options {
description
"TCP options for the connection to the station";
leaf maximum-segment-size {
type uint16;
description
"Maximum segment size for the TCP connections.";
}
// Taken from the bgp yang module
leaf mtu-discovery {
type boolean;
description
"Turns path mtu discovery for the TCP sessions
on (true) or off (false).";
reference
"RFC 1191: Path MTU discovery.";
}
uses tcpcmn:tcp-common-grouping;
// taken from the bgp yang module
leaf secure-session-enable {
type boolean;
default "false";
description
"Does this session need to be secured?";
}
container secure-session {
when "../secure-session-enable = 'true'";
description
"Container for describing how a particular BMP session
is to be secured.";
choice authentication {
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.";
}
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.";
}
}
}
grouping bmp-ip-connection {
description
"common elements for defining connectivity
to a BMP monitoring station";
choice passive-or-active {
description
"Choice for active or passive connection as described
in section 3.2 of RFC 7854";
case active {
description
"The device starts 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
"If present, specifies the network instance
used to reach the monitoring station.
If not provided, the global network
instance is used.";
}
leaf station-address {
type inet:ip-address;
mandatory true;
description
"Destination IP address of monitoring station";
}
leaf station-port {
type inet:port-number;
mandatory true;
description
"Destination port of the station";
}
leaf local-address {
type inet:ip-address;
mandatory true;
description
"Local IP address to source active connection";
}
leaf local-port {
type inet:port-number;
description
"Optional Local port for active connection";
}
}
}
case passive {
description
"The device waits for the connection
in a local endpoint";
container passive {
description
"The device waits for the connection
in a local endpoint";
leaf network-instance {
type leafref {
path "/ni:network-instances/ni:network-instance/"
+ "ni:name";
}
description
"If present, specifies the network instance
used to reach the monitoring station.
If not provided, the global network
instance is used.";
}
leaf station-address {
type inet:ip-address;
mandatory true;
description
"address of the station";
}
leaf station-port {
type inet:port-number;
description
"Optional value identifying the origin port of
the connection, if provided it MUST match";
}
leaf local-address {
type inet:ip-address;
mandatory true;
description
"Local IP address to wait for the connection";
}
leaf local-port {
type inet:port-number;
mandatory true;
description
"Local port to wait for the connection";
}
}
}
}
}
grouping bmp-source-configuration {
description
"Group containing some general characteristics for configuring
a BMP source";
container filters {
description
"Includes containers specifying filters for deciding
which routes to export to the station";
container policy-filter {
description
"Filter routes based on a policy.
The policy SHOULD NOT perform any action besides
filtering routes.
The policy SHOULD only contain accept and reject
routes, and the matching conditions SHOULD only
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
"List of policy names in sequence used to select
routes to be exported to station.";
}
leaf default-export-policy {
type rt-pol:default-policy-type;
default "accept-route";
description
"Explicitly set a default policy if no policy
definition in the export policy chain
is satisfied.";
}
}
}
}
grouping bmp-peer-ribs-filter {
description
"Leaves for configuring RIBs where
origin/destination peers are defined.";
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.";
// If we knew the network instance,
// we could list the AF directly from the configured
// ones, as we for instance show next for the global one.
// leaf name {
// type leafref {
// path "/rt:routing/rt:control-plane-protocols/"
// + "rt:control-plane-protocol/bgp:bgp/"
// + "bgp:global/bgp:afi-safis/bgp:afi-safi/bgp:name";
// }
// description
// "Name of the address family";
// }
// However, since is not aware if we are doing global,
// and individual NT or a default, we cannot
// contraint it to this.
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 {
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 union {
// inet:ip-address reflects a neighbor
// but since the model is not aware of
// the ni, it doesn not know from where to get it
// e.g. if we knew were were referencing
// the global instance, we could do:
// type leafref {
// path "/rt:routing/rt:control-plane-protocols/"
// + "rt:control-plane-protocol/bgp:bgp/"
// + "bgp:neighbors/bgp:neighbor/"
// + "bgp:remote-address";
// }
type inet:ip-address;
type bt:peer-type;
type identityref {
base bmp-peer-types;
}
}
description
"Peers can be identified by a remote-address,
by the bgp type of the peers,
or by an enum value corresponding to groups
of peers. This way an operator can
select, for example, all external peers,
all internal peers, or all peers.";
}
leaf enabled {
type boolean;
default "true";
description
"Enables routing monitoring messages
for the peer(s).";
}
uses bmp-source-configuration;
}
}
}
}
}
grouping bmp-route-monitoring-sources {
description
"Route monitoring sources";
reference
"RFC7854: BGP Monitoring Protocol, Section 5.";
container network-instances {
description
"container for lists of network-instances";
list network-instance {
key "network-instance-id";
description
"Network instance to monitory using BMP.";
leaf network-instance-id {
type union {
type leafref {
path "/ni:network-instances/ni:network-instance/"
+ "ni:name";
}
type identityref {
base bmp-ni-types;
}
}
description
"Identification of a network-instance.
Network instances can be identified
directly by their path or use an identity to
identify one or a group of them
(e.g. bmp-ni-types-all-ni for all of them)";
}
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-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 {
base bt:afi-safi-type;
}
description
"Address family id to enable for local-rib";
}
uses bmp-source-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.";
}
}
}
}
container bmp {
description
"Main level for BMP configuration ";
container monitoring-stations {
description
"Container for the list of BMP monitoring stations";
list monitoring-station {
key "id";
description
"Configuration for a BMP monitoring station.";
leaf id {
type string;
description
"Identification string for the monitoring station";
}
// Connection, missing tcp tuning params
// like keep-alives, segment sizes, etc.
container connection {
description
"Connection details for the monitoring station";
uses bmp-ip-connection;
container tcp-options {
description
"TCP options for the connection to the monitoring
station";
uses bmp-tcp-options;
}
leaf initial-delay {
type uint32;
units "seconds";
default "0";
description
"Initial delay of the connection to the station";
}
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 of every retry until reaching the
maximum backoff";
leaf initial-backoff {
type uint32;
units "seconds";
default "30";
description
"Initial backoff time";
}
leaf maximum-backoff {
type uint32;
units "seconds";
default "720";
description
"Maximum backoff time";
}
}
}
}
}
}
container bmp-data {
description
"Configuration of BMP data";
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 "Enables the BMP statistics report";
description
"Configuration of the statistics report";
reference
"RFC7854: BGP Monitoring Protocol,
Section 4.8";
leaf statistics-interval {
type uint32;
units "seconds";
mandatory true;
description
"Interval for statistic report message.";
}
}
container bmp-route-monitoring {
description
"Configuration of the data sources for
route-monitoring messages";
uses bmp-route-monitoring-sources;
}
}
container session-stats {
config false;
description
"stats and operational values for the station";
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
"Value indicating if the session is currently
established";
}
leaf total-route-monitoring-messages {
type uint64;
description
"Number of route-monitoring messages sent since last
successful connection";
}
leaf total-statistics-messages {
type uint64;
description
"Number of statistics messages sent since last
successful connection";
}
leaf total-peer-down-messages {
type uint64;
description
"Number of peer-down messages sent since last
successful connection";
}
leaf total-peer-up-messages {
type uint64;
description
"Number of peer-up messages sent since last successful
connection";
}
leaf total-initiation-messages {
type uint64;
description
"Number of initiation messages sent since last
successful connection";
}
leaf total-route-mirroring-messages {
type uint64;
description
"Number of route-mirroring messages sent since last
successful connection";
}
}
container actions {
nacm:default-deny-all;
description
"Container with the actions for the 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.
Reason is included in the field";
}
}
}
}
}
}
}
}
}
]]><CODE ENDS>
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 or RESTCONF . The lowest NETCONF layer is the secure transport
layer, and the mandatory-to-implement secure transport is Secure
Shell (SSH) . The lowest RESTCONF layer is
HTTPS, and the mandatory-to-implement secure transport is TLS . The NETCONF Access Control Model (NACM) 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 sensible 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 considerable amount of resources
from network elements. It SHOULD thus be protected from illegal access.
This document registers a URIs in the IETF XML
registry . Following the format in
, the following registrations are
requested:
URI: urn:ietf:params:xml:ns:yang:ietf-bmp
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
This document registers the following YANG module in the "
YANG Module Names" registry
registry :
Name: ietf-bmp
Namespace: urn:ietf:params:xml:ns:yang:ietf-bmp
Prefix: bmp
Reference: [This RFC-to-be]
The security considerations section will have to be aligned with
https://trac.ietf.org/trac/ops/wiki/yang-security-guidelinesThis sections shows some examples of BMP configuration using the
model.In this example, the device connects to a monitoring station
using an active connection.
The devices sends route monitoring messages for the global
instance, the adj-rib-out-pre RIB, the IPv4/IPv6 address family,
and external peers.
1192.0.2.157992192.0.2.2
bmp-ni-types-global-ni
bt:ipv6-unicastexternal
bt:ipv4-unicastexternal
]]>In the next example, the device connects to a monitoring station
using a passive connection, over the network-instance monitoring.
The configuration of route monitoring messages is more complex than
in the previous example. It shows how to combine the configuration
of general identities of network instances and peers (e.g.
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
128.66.1.1, which is disabled.Network instance monitoring is disabled for route monitoring messages. For the rest of network
instances, we are enabling messages from adj-rib-in-pre, address
families IPv4/IPv6, and for all peers.2monitoring192.0.2.1192.0.2.257993
bmp-ni-types-all-ni
bt:ipv6-unicastbmp-peer-types-all-peers
bt:ipv4-unicastbmp-peer-types-all-peers
bmp-ni-types-global-ni
bt:ipv6-unicast128.66.1.1falseexternal
bt:ipv4-unicast128.66.1.1falseexternalmonitoringfalse
]]>
The authors would like to thank Yimin Shen, Jeff Haas, Pierre Vander
Vorst, and Tom Petch for their review and feedback.