-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-ietf-grow-bmp-yang-04.xml
3202 lines (3029 loc) · 131 KB
/
draft-ietf-grow-bmp-yang-04.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="4"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="std" ipr="trust200902" docName="draft-ietf-grow-bmp-yang-04" submissionType='IETF'>
<front>
<title abbrev="BMP YANG Module">BMP YANG Module</title>
<author fullname="Camilo Cardona" initials="C" surname="Cardona ">
<organization>NTT</organization>
<address>
<postal>
<street>164-168, Carrer de Numancia</street>
<city>Barcelona</city>
<code>08029</code>
<country>Spain</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Paolo Lucente" initials="P." surname="Lucente">
<organization>NTT</organization>
<address>
<postal>
<street>Siriusdreef 70-72</street>
<city>Hoofddorp</city>
<code>2132</code>
<country>Netherlands</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Thomas Graf" initials="T." surname="Graf">
<organization>Swisscom</organization>
<address>
<postal>
<street>Binzring 17</street>
<city>Zurich 8045</city>
<country>Switzerland</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Benoit Claise" initials="B" surname="Claise">
<organization>Huawei</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<date/>
<area>OPS</area>
<workgroup>GROW</workgroup>
<abstract>
<t>
This document proposes a YANG module for the configuration and monitoring of the BGP Monitoring Protocol (BMP).
</t>
</abstract>
</front>
<middle>
<section title="Terminology" anchor="terminology">
<t>
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 <xref target="RFC2119"/> <xref target="RFC8174"/>
when, and only when, they appear in all capitals, as shown here.
</t>
<t>
Routing Information Bases, peers, monitoring stations, and
initiation messages are defined in <xref target="RFC7854"/>.
</t>
</section>
<section title="Model description" anchor="model_description">
<t>
This document specifies a YANG module for configuring and
monitoring the BGP Monitoring Protocol (BMP) <xref target="RFC7854"/>. 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.
</t>
<t>The model is included in <xref target="model-content"/>. In this
section, we provide details and examples of each of its parts.</t>
<t>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.</t>
<section title="IP Connectivity" anchor="ip_connectivitu">
<t> BMP allows for active and passive
connections between the router and the BMP monitoring station as described in <xref
target="RFC7854" section="3.2" sectionFormat="of"/>. 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.</t>
<t>We describe each type of connection option next, and provide
examples of their configuration.</t>
<section title="Active connection">
<t>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 <xref target="active_connection_option"/>.</t>
<figure anchor="active_connection_option">
<name>Active connection example</name>
<sourcecode><![CDATA[
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>1</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
<t>Note in the example from <xref target="active_connection_option"/>
that there is no network instance defined, so the connection is
using the global network instance.</t>
</section>
<section title="Passive connection">
<t>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.</t>
<t>An incoming connection not matching a valid entry MUST be ignored by
the router.</t>
<figure anchor="passive_connection_option">
<name>Passive connection example</name>
<sourcecode><![CDATA[
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_two</id>
<connection>
<passive>
<network-instance>test</network-instance>
<station-address>192.0.2.1</station-address>
<local-address>192.0.2.2</local-address>
<local-port>57993</local-port>
</passive>
</connection>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</section>
</section>
<section title="TCP Options" anchor="tcp_options">
<t>The BMP module allows tuning various parameters of the TCP
connection supporting the BMP session:</t>
<t>
<ul spacing="compact">
<li>For configuring TCP keepalives, the connection container uses the tcp-common-grouping from <xref target="I-D.ietf-netconf-tcp-client-server"/>. Please see <xref target="I-D.ietf-netconf-tcp-client-server" section="2.1.3.1" sectionFormat="of"/> 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 <xref target="RFC9293" section="3.8.4" sectionFormat="of"/></li>
<li>The maximum segment of the TCP connection. See <xref target="RFC9293" section="3.7.1" sectionFormat="of"/>.</li>
<li>Enabling MTU discovery for the path. See <xref target="RFC9293" section="3.7.2" sectionFormat="of"/>.</li>
<li>Session security. Provides options for authentication using AO and MD5. This part of the model was taken from the BGP yang model <xref target="I-D.ietf-idr-bgp-model"/>.</li>
</ul>
</t>
<t>Figures <xref target="tcp_example1" format="counter"/> and <xref target="tcp_example2" format="counter"/> include examples configuring the previous TCP parameters in the model.</t>
<t>
<figure anchor="tcp_example1">
<name>Example of configuring basic TCP parameters</name>
<sourcecode><![CDATA[
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>1</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
<tcp-options>
<keepalives>
<idle-time>15</idle-time>
<max-probes>3</max-probes>
<probe-interval>30</probe-interval>
</keepalives>
<maximum-segment-size>1500</maximum-segment-size>
<mtu-discovery>true</mtu-discovery>
</tcp-options>
</connection>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
<t>
<figure anchor="tcp_example2">
<name>Example of the Configuration of TCP session security.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<key-chains xmlns="urn:ietf:params:xml:ns:yang:ietf-key-chain">
<key-chain>
<name>bmp-key-chain</name>
<description>An example of TCP-AO configuration for BMP</descr\
iption>
<key>
<key-id>55</key-id>
<crypto-algorithm>aes-cmac-prf-128</crypto-algorithm>
<lifetime>
<send-lifetime>
<start-date-time>2023-01-01T00:00:00+00:00</start-date-t\
ime>
<end-date-time>2023-02-01T00:00:00+00:00</end-date-time>
</send-lifetime>
<accept-lifetime>
<start-date-time>2023-01-01T00:00:00+00:00</start-date-t\
ime>
<end-date-time>2023-02-01T00:00:00+00:00</end-date-time>
</accept-lifetime>
</lifetime>
<key-string>
<keystring>teststring</keystring>
</key-string>
<authentication xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp">
<keychain>bmp-key-chain</keychain>
<ao>
<send-id>65</send-id>
<recv-id>87</recv-id>
</ao>
</authentication>
</key>
<key>
<key-id>56</key-id>
<crypto-algorithm>aes-cmac-prf-128</crypto-algorithm>
<lifetime>
<send-lifetime>
<start-date-time>2023-01-01T00:00:00+00:00</start-date-t\
ime>
<end-date-time>2023-02-01T00:00:00+00:00</end-date-time>
</send-lifetime>
<accept-lifetime>
<start-date-time>2023-01-01T00:00:00+00:00</start-date-t\
ime>
<end-date-time>2023-02-01T00:00:00+00:00</end-date-time>
</accept-lifetime>
</lifetime>
<authentication xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp">
<keychain>bmp-key-chain</keychain>
<ao>
<send-id>65</send-id>
<recv-id>87</recv-id>
</ao>
</authentication>
</key>
</key-chain>
</key-chains>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
<tcp-options>
<secure-session-enable>true</secure-session-enable>
<secure-session>
<ao-keychain>bmp-key-chain</ao-keychain>
</secure-session>
</tcp-options>
</connection>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
</section>
<section title="Other BMP connectivity options">
<t>The model also includes the next options to configure the connection to the BMP monitoring station:</t>
<t>
<ul spacing="compact">
<li>Initial-delay: a value in seconds that the device must hold back before starting the connection to the station. </li>
<li>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 <xref target="RFC7854" section="3.2" sectionFormat="of"/>.</li>
</ul>
</t>
<t>In the example in <xref target="example_indelay"/>, we configure an initial-delay of 10. Configuring an initial-backoff of 50 seconds and 600 of maximum-backoff.</t>
<t>
<figure anchor="example_indelay">
<name>Example of the initial-delay and simple exponential backoff.</name>
<sourcecode><![CDATA[
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>1</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
<initial-delay>10</initial-delay>
<backoff>
<simple-exponential>
<initial-backoff>50</initial-backoff>
<maximum-backoff>600</maximum-backoff>
</simple-exponential>
</backoff>
</connection>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
</section>
<section title="BMP data">
<t>The bmp-data container defines the configuration parameters for the data that the device sends to the monitoring station using the various BMP messages. See <xref target="RFC7854" section="4" sectionFormat="of"/>.</t>
<t>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 <xref target='route_monitoring'/>.</t>
<t>
<ul spacing="compact">
<li>Initiation-message: Content for an information TLV type-0 for identification of the device. See <xref target="RFC7854" section="4.3" sectionFormat="bare"/> and <xref target="RFC7854" section="4.4" sectionFormat="of"/></li>
<li>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 <xref target="RFC7854" section="4.8" sectionFormat="of"/>.</li>
</ul>
</t>
<t>An example of configuring the previous options is included in <xref target="example_init_msg"/></t>
<t>
<figure anchor='example_init_msg'>
<name>Example of configuration of initiation-message and statistics report interval.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<initiation-message>BMP device supporting the BMP yang modul\
e</initiation-message>
<bmp-statistics-report>
<statistics-interval>600</statistics-interval>
</bmp-statistics-report>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
<section title="BMP route monitoring" anchor="route_monitoring">
<t>Route monitoring messages are used for synchronization of RIBs to the monitoring station. See <xref target="RFC7854" section="5" sectionFormat="of"/>.</t>
<t>The next 3 requirements were defined before designing this part of the model.</t>
<t>
<ul spacing="compact">
<li>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.</li>
<li>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. </li>
<li>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). </li>
</ul>
</t>
<t>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.</t>
<t>The Routing monitoring configuration is divided in a 4 part hierarchy:</t>
<t>
<ul spacing="compact">
<li>Network Instance </li>
<li>RIB Type (e.g. Adj-RIB-IN pre/post, local RIB)</li>
<li>Address Family </li>
<li>Peers</li>
</ul>
</t>
<t>Absence of the routing monitoring container will disable the routing monitoring messages to the monitoring station.</t>
<t>We'll offer an introduction to these hierarchies before going over them with detail.</t>
<t>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.</t>
<t>On the other hand, Network instances and peers require greater flexibility.</t>
<t>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.</t>
<t>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. </t>
<t>We summarize the requirements stated on the previous two paragraphs next:</t>
<t>For network instances:</t>
<t>
<ul spacing="compact">
<li>The configuration should be simple for cases where only the "global" routing instance is enabled.</li>
<li>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).</li>
<li>The model should provide a way of configuring network instances individually.</li>
</ul>
</t>
<t>For peers:</t>
<t>
<ul spacing="compact">
<li>The model should provide ways of configuring all peers, kind of a default. This would be the most common case.</li>
<li>The model should provide ways of configuring peergroups.</li>
<li>The model should provide ways of configuring type of peers. For instance, only send routes from eBGP peers.</li>
<li>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.</li>
</ul>
</t>
<t>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.</t>
<t>We'll describe each of the 4 hierarchies, and provide examples for each, in the next sections.</t>
<section title="Network instances">
<t>The routing monitoring configuration starts with the configuration of network instances. A network instance can be configured individual or it can be configured if it matches any of the selectors from the "bmp-ni-types" identity. We explain each next</t>
<t>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.</t>
<t>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 is the prefered method, since it allows for better validation of the data. This method requires the support of schema-mount. The latter method does not validate some leafs, but it does not requires support for schema-mount by the device.</t>
<t>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. </t>
<t>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.</t>
<t>
<ul spacing="compact">
<li>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.</li>
<li>If the bmp-ni-types-global-ni exist, the global network instance / network instance SHOULD be configured using this element.</li>
<li>If any /ni:network-instances/ni:network-instance/ is referenced, the network instance SHOULD be configured using this element.</li>
<li>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).</li>
</ul>
</t>
<t>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. </t>
<t>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". </t>
<t>
<figure anchor='example_netins_one'>
<name>Examples of configuring the network instance level for Route Monitoring.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-all-ni</network-inst\
ance-id>
<!-- Configuration A -->
</network-instance>
<network-instance>
<network-instance-id>bmp-ni-types-global-ni</network-i\
nstance-id>
<!-- Configuration B -->
</network-instance>
<network-instance>
<network-instance-id>network-instance-two</network-ins\
tance-id>
<!-- Configuration C -->
</network-instance>
<network-instance>
<network-instance-id>network-instance-one</network-ins\
tance-id>
<enabled>false</enabled>
</network-instance>
</network-instance-configuration>
</bmp-route-monitoring>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
<t>In example from <xref target="example_netins_one"/>, 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.</t>
<t>
<figure anchor='simple_ni_configuration'>
<name>Example of configuring all network instances.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-all-ni</network-inst\
ance-id>
<!-- Configuration D -->
</network-instance>
</network-instance-configuration>
</bmp-route-monitoring>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
<t>The example in <xref target="simple_ni_configuration"/> 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.</t>
<t>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 <xref target='simple_gni_configuration'/></t>
<t>
<figure anchor='simple_gni_configuration'>
<name>Example of configuring only the global network instance.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-all-ni</network-inst\
ance-id>
<!-- Configuration D -->
</network-instance>
</network-instance-configuration>
</bmp-route-monitoring>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
<t>Alternatively to the configuration of <xref target='simple_gni_configuration'/>, one can configure directly the global instance, but using the BMP configuration under the BGP container</t>
</section>
<section title="RIB Type">
<t>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. </t>
<t>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.</t>
<t>We provide an example of this together with address families in the next section</t>
</section>
<section title="Address families">
<t>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.</t>
<t>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.</t>
<t>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.</t>
<t>
<figure anchor='example_rib_af_one'>
<name>Example of configuring RIBs and address families.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-all-ni</network-inst\
ance-id>
<adj-rib-in-pre>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv6-unicast</address-family-id>
<!-- Configuration F -->
</address-family>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<!-- Configuration G -->
</address-family>
</address-families>
</adj-rib-in-pre>
</network-instance>
<network-instance>
<network-instance-id>bmp-ni-types-global-ni</network-i\
nstance-id>
<adj-rib-in-pre>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv6-unicast</address-family-id>
<!-- Configuration H -->
</address-family>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<!-- Configuration I -->
</address-family>
</address-families>
</adj-rib-in-pre>
<adj-rib-in-post>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv6-unicast</address-family-id>
<!-- Configuration H -->
</address-family>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<!-- Configuration I -->
</address-family>
</address-families>
</adj-rib-in-post>
</network-instance>
<network-instance>
<network-instance-id>network-instance-one</network-ins\
tance-id>
<enabled>false</enabled>
</network-instance>
<network-instance>
<network-instance-id>network-instance-two</network-ins\
tance-id>
<adj-rib-in-post>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<!-- Configuration L -->
</address-family>
</address-families>
</adj-rib-in-post>
</network-instance>
</network-instance-configuration>
</bmp-route-monitoring>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
<t>In <xref target='example_rib_af_one'/>, we expand previous sections examples with RIB-Type and address families configurations. The expected result of the previous configuration would be:</t>
<t>
<ul spacing="compact">
<li>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.</li>
<li>Network instance one is disabled, meaning that routing monitoring messages are disabled for that network instance.</li>
<li>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.</li>
<li>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</li>
</ul>
</t>
<t>If an operator only wants to configure the IPv4/IPv6 of adj-rib-pre-in for the global instance, the configuration in <xref target='example_rib_af_two'/> 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.</t>
<t>
<figure anchor='example_rib_af_two'>
<name>Example of configuring RIBs and address families.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-global-ni</network-i\
nstance-id>
<adj-rib-in-pre>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv6-unicast</address-family-id>
<!-- Configuration for ipv6-uniceast -->
</address-family>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<!-- Configuration for ipv4-unicast -->
</address-family>
</address-families>
</adj-rib-in-pre>
</network-instance>
</network-instance-configuration>
</bmp-route-monitoring>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
</section>
<section title="Peers">
<t>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.</t>
<t>Peers are a list indexed by a peer id, which can be one of the following: </t>
<t>
<ul spacing="compact">
<li>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.</li>
<li>A group of peers matching a BGP type. i.e. eBGP peers. </li>
<li>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.</li>
</ul>
</t>
<t>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:</t>
<t>
<ul spacing="compact">
<li>If there is a peer address matching the peer, it should be configured using that instance.</li>
<li>If the peer is of any BGP type listed in the peer list, it should be configured using this instance.</li>
<li>If there is a peer instance identified with the `bmp-peer-types-all-peers`, it would be configured using this instance.</li>
<li>Finally, if no instance covers the peer, the data from this peer should not be transmitted to the monitoring station.</li>
</ul>
</t>
<t>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.</t>
<t>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).</t>
<t>We'll provide examples of the peers configuration after describing the filter containers.</t>
</section>
<section title="Filtering route-monitoring messages">
<t>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.</t>
<t>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. </t>
<t>Note that the policy-filter contains an `accept-route` default export policy. An operator can change it to a reject-route, if required.</t>
<t>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.</t>
<t>We present examples of full configurations next.</t>
</section>
<section title="Full examples of Route monitoring configurations">
<section title="Example one">
<t>In the example configuration from <xref target='full_example_one'/>, address families IPv6 and IPv4 are configured to send all peers. This is an example of a simple configuration</t>
<t>
<figure anchor="full_example_one">
<name>Enabling Route monitoring for all peers; all network instances; IPv4/IPv6 Address families, in the adj-rib-in-pre RIB.</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-global-ni</network-i\
nstance-id>
<adj-rib-in-pre>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv6-unicast</address-family-id>
<peers-configurations>
<bmp-peer-types>
<bmp-peer-type>
<peer-types-bmp>bmp-peer-types-all-peers\
</peer-types-bmp>
</bmp-peer-type>
</bmp-peer-types>
</peers-configurations>
</address-family>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml\
:ns:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<peers-configurations>
<bmp-peer-types>
<bmp-peer-type>
<peer-types-bmp>bmp-peer-types-all-peers\
</peer-types-bmp>
</bmp-peer-type>
</bmp-peer-types>
</peers-configurations>
</address-family>
</address-families>
</adj-rib-in-pre>
</network-instance>
</network-instance-configuration>
</bmp-route-monitoring>
</bmp-data>
</bmp-monitoring-station>
</bmp-monitoring-stations>
</bmp>
]]></sourcecode>
</figure>
</t>
</section>
<section title="Example two">
<t>In the example in <xref target='full_example_two'/>, 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.</t>
<t>
<figure anchor="full_example_two">
<name>Configuring address families differently for the global network instance</name>
<sourcecode><![CDATA[
=============== NOTE: '\' line wrapping per RFC 8792 ================
<?xml version="1.0"?>
<routing-policy xmlns="urn:ietf:params:xml:ns:yang:ietf-routing-poli\
cy">
<policy-definitions>
<policy-definition>
<name>test_policy</name>
<!-- Policy definition -->
</policy-definition>
</policy-definitions>
</routing-policy>
<bmp xmlns="urn:ietf:params:xml:ns:yang:ietf-bmp">
<bmp-monitoring-stations>
<bmp-monitoring-station>
<id>monitoring_station_one</id>
<connection>
<active>
<station-address>192.0.2.1</station-address>
<station-port>57992</station-port>
<local-address>192.0.2.2</local-address>
</active>
</connection>
<bmp-data>
<bmp-route-monitoring>
<network-instance-configuration>
<network-instance>
<network-instance-id>bmp-ni-types-global-ni</network-ins\
tance-id>
<adj-rib-in-pre>
<address-families>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml:n\
s:yang:ietf-bgp-types">bt:ipv6-unicast</address-family-id>
<peers-configurations>
<bmp-peer-types>
<bmp-peer-type>
<peer-types-bmp>bmp-peer-types-all-peers</pe\
er-types-bmp>
</bmp-peer-type>
</bmp-peer-types>
</peers-configurations>
</address-family>
<address-family>
<address-family-id xmlns:bt="urn:ietf:params:xml:n\
s:yang:ietf-bgp-types">bt:ipv4-unicast</address-family-id>
<peers-configurations>
<peer-types>
<peer-type>
<peer-type-id>external</peer-type-id>
</peer-type>
</peer-types>
<peers>
<peer>
<peer-id-str>198.51.100.1</peer-id-str>
<filters>
<policy-filter>
<export-policy>test_policy</export-polic\
y>
</policy-filter>
</filters>
</peer>
</peers>
</peers-configurations>
</address-family>
</address-families>