-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathdraft-ietf-ospf-sr-yang-19.xml
1309 lines (1170 loc) · 44.7 KB
/
draft-ietf-ospf-sr-yang-19.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="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
<!ENTITY RFC3688 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3688.xml'>
<!ENTITY RFC6020 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6020.xml'>
<!ENTITY RFC6241 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6241.xml'>
<!ENTITY RFC7223 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.7223.xml'>
<!ENTITY RFC2328 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2328.xml'>
<!ENTITY RFC5340 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5340.xml'>
<!ENTITY RFC5838 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5838.xml'>
<!ENTITY RFC4750 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.4750.xml'>
<!ENTITY RFC5643 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5643.xml'>
<!ENTITY RFC6242 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6242.xml'>
<!ENTITY RFC7950 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.7950.xml'>
<!ENTITY RFC8022 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8022.xml'>
<!ENTITY RFC8040 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8040.xml'>
<!ENTITY RFC8340 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8340.xml'>
<!ENTITY RFC8341 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8341.xml'>
<!ENTITY RFC8342 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8342.xml'>
<!ENTITY RFC8446 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8446.xml'>
<!ENTITY RFC8476 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8476.xml'>
<!ENTITY RFC8665 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8665.xml'>
<!ENTITY RFC9020 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.9020.xml'>
<!ENTITY RFC9129 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.9129.xml'>
]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc strict="no" ?>
<?rfc toc="yes" ?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc rfcedstyle="yes" ?>
<?rfc subcompact="no" ?>
<rfc category="std" docName="draft-ietf-ospf-sr-yang-19" ipr="trust200902">
<!-- category values: std, bcp, info, exp, and historic
ipr values: full3667, noModification3667, noDerivatives3667
you can add the attributes updates="NNNN" and obsoletes="NNNN"
they will automatically be output with "(if approved)" -->
<!-- ***** FRONT MATTER ***** -->
<front>
<!-- The abbreviated title is used in the page header - it is only necessary if the
full title is longer than 39 characters -->
<title abbrev="OSPF SR (Segment Routing) YANG Data Model">YANG Data Model for OSPF Segment Routing
</title>
<!-- add 'role="editor"' below for the editors if appropriate -->
<!-- Another author who claims to be an editor -->
<author fullname="Derek Yeung" initials="D" surname="Yeung">
<organization>Arrcus</organization>
<address>
<phone></phone>
<email>[email protected]</email>
<!-- uri and facsimile elements may also be added -->
</address>
</author>
<author fullname="Yingzhen Qu" initials="Y" surname="Qu">
<organization>Futurewei</organization>
<address>
<postal>
<street>2330 Central Expressway</street>
<!-- Reorder these if your country does things differently -->
<city>Santa Clara</city>
<region>CA</region>
<code>95050</code>
<country>USA</country>
</postal>
<phone></phone>
<email>[email protected]</email>
<!-- uri and facsimile elements may also be added -->
</address>
</author>
<author fullname="Jeffrey Zhang" initials="J" surname="Zhang">
<organization>Juniper Networks</organization>
<address>
<postal>
<street>10 Technology Park Drive</street>
<!-- Reorder these if your country does things differently -->
<city>Westford</city>
<region>MA</region>
<code>01886</code>
<country>USA</country>
</postal>
<phone></phone>
<email>[email protected]</email>
<!-- uri and facsimile elements may also be added -->
</address>
</author>
<author fullname="Ing-Wher Chen" initials="I." surname="Chen">
<organization>The MITRE Corporation</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<author fullname="Acee Lindem" initials="A." surname="Lindem">
<organization>Cisco Systems</organization>
<address>
<postal>
<street>301 Midenhall Way</street>
<city>Cary, NC 27513</city>
</postal>
<email>[email protected]</email>
</address>
</author>
<date/>
<!-- If the month and year are both specified and are the current ones, xml2rfc will fill
in the current day for you. If only the current year is specified, xml2rfc will fill
in the current day and month for you. If the year is not the current one, it is
necessary to specify at least a month (xml2rfc assumes day="1" if not specified for the
purpose of calculating the expiry date). With drafts it is normally sufficient to
specify just the year. -->
<!-- Meta-data Declarations -->
<area>General</area>
<workgroup>Internet</workgroup>
<!-- WG name at the upperleft corner of the doc,
IETF is fine for individual submissions.
If this element is not present, the default is "Network Working Group",
which is used by the RFC Editor as a nod to the history of the IETF. -->
<!-- Keywords will be incorporated into HTML output
files in a meta tag but they have no effect on text or nroff
output. If you submit your draft to the RFC Editor, the
keywords will be used for the search engine. -->
<abstract>
<t>This document defines a YANG data module that can be
used to configure and manage OSPF Extensions for Segment Routing.
</t>
</abstract>
</front>
<middle>
<section title="Overview">
<t>YANG <xref target="RFC7950"></xref> is a data definition language
used to define the contents of a conceptual data store
that allows networked devices to be managed using NETCONF
<xref target="RFC6241"></xref>. YANG is proving relevant beyond its
initial confines, as bindings to other interfaces (e.g., ReST) and
encodings other than XML (e.g., JSON) are being defined. Furthermore,
YANG data models can be used as the basis for implementation of other
interfaces, such as CLI and programmatic APIs.</t>
<t>This document defines a YANG data model that can be used to configure
and manage OSPFv2 extensions for Segment Routing <xref target="RFC8665"></xref> and it is
an augmentation to the OSPF YANG data model.
</t>
<t> The YANG module in this document conforms to the Network Management
Datastore Architecture (NMDA) <xref target="RFC8342"></xref>.</t>
<section title="Requirements Language">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref target="RFC2119"></xref>.</t>
</section>
<section title="Tree Diagrams">
<t>This document uses the graphical representation of data models
defined in <xref target="RFC8340"/>.</t>
</section>
</section>
<section title="OSPF Segment Routing">
<t>This document defines a model for OSPF Segment Routing feature <xref target="RFC8665"></xref>. It is an
augmentation of the OSPF base model.</t>
<t>The OSPF SR YANG module requires support for the base segment
routing module <xref target="RFC9020"></xref>,
which defines the global segment routing configuration independent
of any specific routing protocol configuration, and support of OSPF base
model<xref target="RFC9129"></xref> which defines basic OSPF configuration and state.</t>
<figure align="left">
<artwork align="left">
module: ietf-ospf-sr
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf:
+--rw segment-routing
| +--rw enabled? boolean
| +--rw bindings {mapping-server}?
| +--rw advertise
| | +--rw policies* -> /rt:routing/sr:segment-routing
| | /sr-mpls:sr-mpls/bindings
| | /mapping-server/policy/name
| +--rw receive? boolean
+--rw protocol-srgb {sr-mpls:protocol-srgb}?
+--rw srgb* [lower-bound upper-bound]
+--rw lower-bound uint32
+--rw upper-bound uint32
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:interfaces/ospf:interface:
+--rw segment-routing
+--rw adjacency-sid
+--rw adj-sids* [value]
| +--rw value-type? enumeration
| +--rw value uint32
| +--rw protected? boolean
| +--rw weight? uint8
+--rw advertise-adj-group-sid* [group-id]
| +--rw group-id uint32
+--rw advertise-protection? enumeration
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:interfaces/ospf:interface/ospf:fast-reroute:
+--rw ti-lfa {ti-lfa}?
+--rw enable? boolean
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:interfaces/ospf:interface/ospf:database
/ospf:link-scope-lsa-type/ospf:link-scope-lsas
/ospf:link-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:extended-prefix-opaque:
+--ro extended-prefix-range-tlvs
+--ro extended-prefix-range-tlv* []
+--ro prefix-length? uint8
+--ro af? uint8
+--ro range-size? uint16
+--ro extended-prefix-range-flags
| +--ro bits* identityref
+--ro prefix? inet:ip-prefix
+--ro prefix-sid-sub-tlvs
| +--ro prefix-sid-sub-tlv* []
| +--ro prefix-sid-flags
| | +--ro bits* identityref
| +--ro mt-id? uint8
| +--ro algorithm? uint8
| +--ro sid? uint32
+--ro unknown-tlvs
+--ro unknown-tlv* []
+--ro type? uint16
+--ro length? uint16
+--ro value? yang:hex-string
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:database/ospf:area-scope-lsa-type/ospf:area-scope-lsas
/ospf:area-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:extended-prefix-opaque:
+--ro extended-prefix-range-tlvs
+--ro extended-prefix-range-tlv* []
+--ro prefix-length? uint8
+--ro af? uint8
+--ro range-size? uint16
+--ro extended-prefix-range-flags
| +--ro bits* identityref
+--ro prefix? inet:ip-prefix
+--ro prefix-sid-sub-tlvs
| +--ro prefix-sid-sub-tlv* []
| +--ro prefix-sid-flags
| | +--ro bits* identityref
| +--ro mt-id? uint8
| +--ro algorithm? uint8
| +--ro sid? uint32
+--ro unknown-tlvs
+--ro unknown-tlv* []
+--ro type? uint16
+--ro length? uint16
+--ro value? yang:hex-string
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:database
/ospf:as-scope-lsa-type/ospf:as-scope-lsas
/ospf:as-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:extended-prefix-opaque:
+--ro extended-prefix-range-tlvs
+--ro extended-prefix-range-tlv* []
+--ro prefix-length? uint8
+--ro af? uint8
+--ro range-size? uint16
+--ro extended-prefix-range-flags
| +--ro bits* identityref
+--ro prefix? inet:ip-prefix
+--ro prefix-sid-sub-tlvs
| +--ro prefix-sid-sub-tlv* []
| +--ro prefix-sid-flags
| | +--ro bits* identityref
| +--ro mt-id? uint8
| +--ro algorithm? uint8
| +--ro sid? uint32
+--ro unknown-tlvs
+--ro unknown-tlv* []
+--ro type? uint16
+--ro length? uint16
+--ro value? yang:hex-string
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:interfaces/ospf:interface/ospf:database
/ospf:link-scope-lsa-type/ospf:link-scope-lsas
/ospf:link-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:extended-prefix-opaque
/ospf:extended-prefix-tlv:
+--ro prefix-sid-sub-tlvs
+--ro prefix-sid-sub-tlv* []
+--ro prefix-sid-flags
| +--ro bits* identityref
+--ro mt-id? uint8
+--ro algorithm? uint8
+--ro sid? uint32
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:database/ospf:area-scope-lsa-type/ospf:area-scope-lsas
/ospf:area-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:extended-prefix-opaque
/ospf:extended-prefix-tlv:
+--ro prefix-sid-sub-tlvs
+--ro prefix-sid-sub-tlv* []
+--ro prefix-sid-flags
| +--ro bits* identityref
+--ro mt-id? uint8
+--ro algorithm? uint8
+--ro sid? uint32
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:database
/ospf:as-scope-lsa-type/ospf:as-scope-lsas/ospf:as-scope-lsa
/ospf:version/ospf:ospfv2/ospf:ospfv2/ospf:body/ospf:opaque
/ospf:extended-prefix-opaque/ospf:extended-prefix-tlv:
+--ro prefix-sid-sub-tlvs
+--ro prefix-sid-sub-tlv* []
+--ro prefix-sid-flags
| +--ro bits* identityref
+--ro mt-id? uint8
+--ro algorithm? uint8
+--ro sid? uint32
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:database/ospf:area-scope-lsa-type/ospf:area-scope-lsas
/ospf:area-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:extended-link-opaque
/ospf:extended-link-tlv:
+--ro adj-sid-sub-tlvs
| +--ro adj-sid-sub-tlv* []
| +--ro adj-sid-flags
| | +--ro bits* identityref
| +--ro mt-id? uint8
| +--ro weight? uint8
| +--ro sid? uint32
+--ro lan-adj-sid-sub-tlvs
+--ro lan-adj-sid-sub-tlv* []
+--ro lan-adj-sid-flags
| +--ro bits* identityref
+--ro mt-id? uint8
+--ro weight? uint8
+--ro neighbor-router-id? yang:dotted-quad
+--ro sid? uint32
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:interfaces/ospf:interface/ospf:database
/ospf:link-scope-lsa-type/ospf:link-scope-lsas
/ospf:link-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:ri-opaque:
+--ro sr-algorithm-tlv
| +--ro sr-algorithm* uint8
+--ro sid-range-tlvs
| +--ro sid-range-tlv* []
| +--ro range-size? uint24
| +--ro sid-sub-tlv
| +--ro sid? uint32
+--ro local-block-tlvs
| +--ro local-block-tlv* []
| +--ro range-size? uint24
| +--ro sid-sub-tlv
| +--ro sid? uint32
+--ro srms-preference-tlv
+--ro preference? uint8
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:areas/ospf:area
/ospf:database/ospf:area-scope-lsa-type/ospf:area-scope-lsas
/ospf:area-scope-lsa/ospf:version/ospf:ospfv2/ospf:ospfv2
/ospf:body/ospf:opaque/ospf:ri-opaque:
+--ro sr-algorithm-tlv
| +--ro sr-algorithm* uint8
+--ro sid-range-tlvs
| +--ro sid-range-tlv* []
| +--ro range-size? uint24
| +--ro sid-sub-tlv
| +--ro sid? uint32
+--ro local-block-tlvs
| +--ro local-block-tlv* []
| +--ro range-size? uint24
| +--ro sid-sub-tlv
| +--ro sid? uint32
+--ro srms-preference-tlv
+--ro preference? uint8
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/ospf:ospf/ospf:database
/ospf:as-scope-lsa-type/ospf:as-scope-lsas/ospf:as-scope-lsa
/ospf:version/ospf:ospfv2/ospf:ospfv2/ospf:body/ospf:opaque
/ospf:ri-opaque:
+--ro sr-algorithm-tlv
| +--ro sr-algorithm* uint8
+--ro sid-range-tlvs
| +--ro sid-range-tlv* []
| +--ro range-size? uint24
| +--ro sid-sub-tlv
| +--ro sid? uint32
+--ro local-block-tlvs
| +--ro local-block-tlv* []
| +--ro range-size? uint24
| +--ro sid-sub-tlv
| +--ro sid? uint32
+--ro srms-preference-tlv
+--ro preference? uint8
</artwork>
</figure>
<section title="OSPF Segment Routing YANG Module">
<t>
<figure>
<artwork><![CDATA[
<CODE BEGINS> file "[email protected]"
module ietf-ospf-sr {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-ospf-sr";
prefix ospf-sr;
import ietf-inet-types {
prefix "inet";
reference "RFC 6991 - Common YANG Data Types";
}
import ietf-yang-types {
prefix "yang";
reference "RFC 6991 - Common YANG Data Types";
}
import ietf-routing {
prefix "rt";
reference "RFC 8349 - A YANG Data Model for Routing
Management (NMDA Version)";
}
import ietf-segment-routing-common {
prefix "sr-cmn";
reference "RFC 9020 - YANG Data Model for Segment
Routing";
}
import ietf-segment-routing-mpls {
prefix "sr-mpls";
reference "RFC 9020 - YANG Data Model for Segment
Routing";
}
import ietf-ospf {
prefix "ospf";
reference "RFC 9129 - YANG Data Model for the OSPF
Protocol";
}
organization
"IETF LSR - Link State Routing Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/lsr/>
WG List: <mailto:[email protected]>
Author: Derek Yeung
<mailto:[email protected]>
Author: Yingzhen Qu
<mailto:[email protected]>
Author: Acee Lindem
<mailto:[email protected]>
Author: Jeffrey Zhang
<mailto:[email protected]>
Author: Ing-Wher Chen
<mailto:[email protected]>
Author: Greg Hankins
<mailto:[email protected]>";
description
"This YANG module defines the generic configuration
and operational state for OSPF Segment Routing, which is
common across all of the vendor implementations. It is
intended that the module will be extended by vendors to
define vendor-specific OSPF Segment Routing configuration
and operational parameters and policies.
This YANG model conforms to the Network Management
Datastore Architecture (NMDA) as described in RFC 8342.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.
This version of this YANG module is part of RFC XXXX;
see the RFC itself for full legal notices.";
reference "RFC XXXX";
revision 2023-01-01 {
description
"Initial revision.";
reference
"RFC XXXX: A YANG Data Model for OSPF Segment Routing.";
}
feature ti-lfa {
description
"Topology-Independent Loop-Free Alternate (TI-LFA)
computation using segment routing.";
}
identity prefix-sid-bit {
description
"Base identity for prefix sid sub-tlv bits.";
}
identity np-bit {
base prefix-sid-bit;
description
"No-PHP flag.";
}
identity m-bit {
base prefix-sid-bit;
description
"Mapping server flag.";
}
identity e-bit {
base prefix-sid-bit;
description
"Explicit-NULL flag.";
}
identity v-bit {
base prefix-sid-bit;
description
"Value/Index flag.";
}
identity l-bit {
base prefix-sid-bit;
description
"Local flag.";
}
identity extended-prefix-range-bit {
description
"Base identity for extended prefix range TLV bits.";
}
identity ia-bit {
base extended-prefix-range-bit;
description
"Inter-Area flag. If set, advertisement is of inter-area type.";
}
identity adj-sid-bit {
description
"Base identity for adj sid sub-tlv bits.";
}
identity b-bit {
base adj-sid-bit;
description
"Backup flag.";
}
identity vi-bit {
base adj-sid-bit;
description
"Value/Index flag.";
}
identity lo-bit {
base adj-sid-bit;
description
"Local/Global flag.";
}
identity g-bit {
base adj-sid-bit;
description
"Group flag.";
}
identity p-bit {
base adj-sid-bit;
description
"Persistent flag.";
}
typedef uint24 {
type uint32 {
range "0 .. 16777215";
}
description
"24-bit unsigned integer.";
}
/* Groupings */
grouping sid-sub-tlv {
description "SID/Label sub-TLV grouping.";
container sid-sub-tlv {
description
"Used to advertise the SID/Label associated with a
prefix or adjacency.";
leaf sid {
type uint32;
description
"Segment Identifier (SID) - A 20 bit label or
32 bit SID.";
}
}
}
grouping prefix-sid-sub-tlvs {
description "Prefix Segment ID (SID) sub-TLVs.";
container prefix-sid-sub-tlvs{
description "Prefix SID sub-TLV.";
list prefix-sid-sub-tlv {
description "Prefix SID sub-TLV.";
container prefix-sid-flags {
leaf-list bits {
type identityref {
base prefix-sid-bit;
}
description
"Prefix SID Sub-TLV flag bits list.";
}
description "Segment Identifier (SID) Flags.";
}
leaf mt-id {
type uint8;
description "Multi-topology ID.";
}
leaf algorithm {
type uint8;
description
"The algorithm associated with the prefix-SID.";
}
leaf sid {
type uint32;
description "An index or label.";
}
}
}
}
grouping extended-prefix-range-tlvs {
description "Extended prefix range TLV grouping.";
container extended-prefix-range-tlvs {
description "The list of range of prefixes.";
list extended-prefix-range-tlv {
description "The range of prefixes.";
leaf prefix-length {
type uint8;
description "Length of prefix in bits.";
}
leaf af {
type uint8;
description "Address family for the prefix.";
}
leaf range-size {
type uint16;
description "The number of prefixes covered by the
advertisement.";
}
container extended-prefix-range-flags {
leaf-list bits {
type identityref {
base extended-prefix-range-bit;
}
description "Extended prefix range TLV flags list.";
}
description "Extended Prefix Range TLV flags.";
}
leaf prefix {
type inet:ip-prefix;
description "Address prefix.";
}
uses prefix-sid-sub-tlvs;
uses ospf:unknown-tlvs;
}
}
}
grouping sr-algorithm-tlv {
description "SR algorithm TLV grouping.";
container sr-algorithm-tlv {
description "All SR algorithm TLVs.";
leaf-list sr-algorithm {
type uint8;
description
"The Segment Routing (SR) algorithms that the router is
currently using.";
}
}
}
grouping sid-range-tlvs {
description "SID Range TLV grouping.";
container sid-range-tlvs {
description "List of SID range TLVs.";
list sid-range-tlv {
description "SID range TLV.";
leaf range-size {
type uint24;
description "The SID range.";
}
uses sid-sub-tlv;
}
}
}
grouping local-block-tlvs {
description "The SR local block TLV contains the
range of labels reserved for local SIDs.";
container local-block-tlvs {
description "List of SRLB TLVs.";
list local-block-tlv {
description "SRLB TLV.";
leaf range-size {
type uint24;
description "The SID range.";
}
uses sid-sub-tlv;
}
}
}
grouping srms-preference-tlv {
description "The SRMS preference TLV is used to advertise
a preference associated with the node that acts
as an SR Mapping Server.";
container srms-preference-tlv {
description "SRMS Preference TLV.";
leaf preference {
type uint8 {
range "0 .. 255";
}
description "SRMS preference TLV, value from 0 to 255.";
}
}
}
/* Configuration */
augment "/rt:routing/rt:control-plane-protocols"
+ "/rt:control-plane-protocol/ospf:ospf" {
when "../rt:type = 'ospf:ospfv2' or "
+ "../rt:type = 'ospf:ospfv3'" {
description
"This augments the OSPF routing protocol when used.";
}
description
"This augments the OSPF protocol configuration
with segment routing.";
uses sr-mpls:sr-control-plane;
container protocol-srgb {
if-feature sr-mpls:protocol-srgb;
uses sr-cmn:srgb;
description
"Per-protocol SRGB.";
}
}
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/ospf:ospf/"
+ "ospf:areas/ospf:area/ospf:interfaces/ospf:interface" {
when "../../../../../rt:type = 'ospf:ospfv2' or "
+ "../../../../../rt:type = 'ospf:ospfv3'" {
description
"This augments the OSPF interface configuration
when used.";
}
description
"This augments the OSPF protocol interface
configuration with segment routing.";
uses sr-mpls:igp-interface;
}
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/ospf:ospf/"
+ "ospf:areas/ospf:area/ospf:interfaces/ospf:interface/"
+ "ospf:fast-reroute" {
when "../../../../../../rt:type = 'ospf:ospfv2' or "
+ "../../../../../../rt:type = 'ospf:ospfv3'" {
description
"This augments the OSPF routing protocol when used.";
}
description
"This augments the OSPF protocol IP-FRR with TI-LFA.";
container ti-lfa {
if-feature ti-lfa;
leaf enable {
type boolean;
description
"Enables TI-LFA computation.";
}
description
"Topology Independent Loop Free Alternate
(TI-LFA) support.";
}
}
/* Database */
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:areas/ospf:area/"
+ "ospf:interfaces/ospf:interface/ospf:database/"
+ "ospf:link-scope-lsa-type/ospf:link-scope-lsas/"
+ "ospf:link-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-prefix-opaque" {
when "../../../../../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description
"This augmentation is only valid for OSPFv2.";
}
description
"SR specific TLVs for OSPFv2 extended prefix LSA
in type 9 opaque LSA.";
uses extended-prefix-range-tlvs;
}
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:areas/"
+ "ospf:area/ospf:database/"
+ "ospf:area-scope-lsa-type/ospf:area-scope-lsas/"
+ "ospf:area-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-prefix-opaque" {
when "../../../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description
"This augmentation is only valid for OSPFv2.";
}
description
"SR specific TLVs for OSPFv2 extended prefix LSA
in type 10 opaque LSA.";
uses extended-prefix-range-tlvs;
}
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:database/"
+ "ospf:as-scope-lsa-type/ospf:as-scope-lsas/"
+ "ospf:as-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-prefix-opaque" {
when "../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description
"This augmentation is only valid for OSPFv2.";
}
description
"SR specific TLVs for OSPFv2 extended prefix LSA
in type 11 opaque LSA.";
uses extended-prefix-range-tlvs;
}
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:areas/ospf:area/"
+ "ospf:interfaces/ospf:interface/ospf:database/"
+ "ospf:link-scope-lsa-type/ospf:link-scope-lsas/"
+ "ospf:link-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-prefix-opaque/ospf:extended-prefix-tlv" {
when "../../../../../../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description
"This augmentation is only valid for OSPFv2.";
}
description
"SR specific TLVs for OSPFv2 extended prefix TLV
in type 9 opaque LSA.";
uses prefix-sid-sub-tlvs;
}
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:areas/"
+ "ospf:area/ospf:database/"
+ "ospf:area-scope-lsa-type/ospf:area-scope-lsas/"
+ "ospf:area-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-prefix-opaque/ospf:extended-prefix-tlv" {
when "../../../../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description
"This augmentation is only valid for OSPFv2.";
}
description
"SR specific TLVs for OSPFv2 extended prefix TLV
in type 10 opaque LSA.";
uses prefix-sid-sub-tlvs;
}
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:database/"
+ "ospf:as-scope-lsa-type/ospf:as-scope-lsas/"
+ "ospf:as-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-prefix-opaque/ospf:extended-prefix-tlv" {
when "../../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description
"This augmentation is only valid for OSPFv2.";
}
description
"SR specific TLVs for OSPFv2 extended prefix TLV
in type 11 opaque LSA.";
uses prefix-sid-sub-tlvs;
}
augment "/rt:routing/"
+ "rt:control-plane-protocols/rt:control-plane-protocol/"
+ "ospf:ospf/ospf:areas/"
+ "ospf:area/ospf:database/"
+ "ospf:area-scope-lsa-type/ospf:area-scope-lsas/"
+ "ospf:area-scope-lsa/ospf:version/ospf:ospfv2/"
+ "ospf:ospfv2/ospf:body/ospf:opaque/"
+ "ospf:extended-link-opaque/ospf:extended-link-tlv" {
when "../../../../../../../../../../../../"
+ "rt:type = 'ospf:ospfv2'" {
description