-
Notifications
You must be signed in to change notification settings - Fork 2
/
draft-ietf-ospf-yang-01.txt
5936 lines (4866 loc) · 173 KB
/
draft-ietf-ospf-yang-01.txt
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
Internet D. Yeung
Internet-Draft Y. Qu
Intended status: Informational Cisco Systems
Expires: September 2, 2015 J. Zhang
D. Bogdanovic
Juniper Networks
K. Sreenivasa
Brocade Communications System
March 2015
Yang Data Model for OSPF Protocol
draft-ietf-ospf-yang-01
Abstract
This document defines a YANG data model that can be used to configure
and manage OSPF.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 2, 2015.
Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
Yeung, et al. Expires September 2, 2015 [Page 1]
Internet-Draft OSPF Yang Data Model March 2015
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3
2. Design of Data Model . . . . . . . . . . . . . . . . . . . . 3
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2. OSPFv2 and OSPFv3 . . . . . . . . . . . . . . . . . . . . 5
2.3. Optional Features . . . . . . . . . . . . . . . . . . . . 5
2.4. Inheritance . . . . . . . . . . . . . . . . . . . . . . . 5
2.5. OSPF Router Configuration . . . . . . . . . . . . . . . . 5
2.6. OSPF Instance Configuration . . . . . . . . . . . . . . . 6
2.7. OSPF Area Configuration . . . . . . . . . . . . . . . . . 7
2.8. OSPF Interface Configuration . . . . . . . . . . . . . . 9
2.9. OSPF notification . . . . . . . . . . . . . . . . . . . . 11
3. OSPF Segment Routing . . . . . . . . . . . . . . . . . . . . 14
4. OSPF Yang Module . . . . . . . . . . . . . . . . . . . . . . 20
5. OSPF Segment Routing Yang Module . . . . . . . . . . . . . . 90
6. Security Considerations . . . . . . . . . . . . . . . . . . . 104
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 104
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 104
8.1. Normative References . . . . . . . . . . . . . . . . . . 104
8.2. Informative References . . . . . . . . . . . . . . . . . 105
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 105
1. Overview
YANG [RFC6020] is a data definition language that was introduced to
define the contents of a conceptual data store that allows networked
devices to be managed using NETCONF [RFC6241]. 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 of
implementation for other interfaces, such as CLI and programmatic
APIs.
A core routing data model is defined in
[I-D.ietf-netmod-routing-cfg], and it proposes a basis for the
development of data models for routing protocols. The interface data
model is defined in [RFC7223] and is used for referencing interface
from the routing protocol. The key-chain data model is defined in
[I-D.acee-rtg-yang-key-chain] and is used for referencing key-chains
configured for authentication and for the enumeration of
cryptographic algorithms, also used for authentication. This
document defines a YANG data model that can be used to configure and
manage OSPF and it is an augment to the core routing data model.
Yeung, et al. Expires September 2, 2015 [Page 2]
Internet-Draft OSPF Yang Data Model March 2015
This document defines a YANG data model that can be used to configure
and manage OSPF. Both OSPFv2 [RFC2328] and OSPFv3 [RFC5340] are
supported. In additional to the core OSPF protocol, features
described in different separate OSPF RFCs are also supported. They
includes demand circuit [RFC1793], traffic engineering [RFC3630],
multiple address family [RFC5838], graceful restart [RFC3623]
[RFC5187], NSSA [RFC3101] and sham link [RFC4577]. Those non-core
features are made optional in the data model provided.
1.1. Requirements Language
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 [RFC2119].
2. Design of Data Model
Although the basis of OSPF configuration elements like routers, areas
and interfaces remains the same, the detailed configuration model
varies among different vendors. Differences are observed in term of
how protocol engine is tied to routing domain, how multiple protocol
engines could be instantiated and configuration inheritance, just to
name a few.
The goal of this document is to define a data model that is capable
of representing these differences. There is very little information
that is designated as "mandatory", providing freedom to vendors to
adapt this data model to their product implementation.
2.1. Overview
The OSPF YANG module defined in this document has all the common
building blocks for OSPF protocol.
The OSPF YANG module augments the routing/routing-instance/routing-
protocols/routing-protocol path of the ietf-routing module.
Yeung, et al. Expires September 2, 2015 [Page 3]
Internet-Draft OSPF Yang Data Model March 2015
module: ospf
+--rw routing
+--rw routing-instance [name]
+--rw routing-protocols
+--rw routing-protocol [name]
+--rw ospf
.
.
+--rw all-instances-inherit {instance-inheritance}?
| .
| .
+--rw instance* [routing-instance af]
.
.
+--rw areas
| +--rw area* [area-id]
| .
| .
| +--rw all-interfaces-inherit {interface-inheritance}?
| .
| .
| +--rw virtual-links
| | +--rw virtual-link* [router-id]
| | .
| | .
| +--rw sham-links
| | +--rw sham-link* [local-id remote-id]
| | .
| | .
| +--rw interfaces
| | +--rw interface* [interface]
| | .
| | .
| .
| .
+--rw topologies
+--rw topology* [name]
The ospf is intended to match to the vendor specific OSPF
configuration construct which is identified by a local identifier
'name'. The field 'version' allows support for OSPFv2 and OSPFv3.
The ospf container includes one or more OSPF protocol engines, each
encapsulated in the instance entity. Each instance includes
information for the routing domain it is running on based on the
[routing-instance af] specification. There is no default routing
domain assumed by the data model. For example, to enable OSPF on the
default IPv4 routing domain of the vendor, this model requires an
Yeung, et al. Expires September 2, 2015 [Page 4]
Internet-Draft OSPF Yang Data Model March 2015
explicit instance entity with the specification like ["default"
"ipv4-unicast"]. The instance also contains OSPF router level
configuration
The instance/area and instance/area/interface container contain the
OSPF configuration for the area and interface level respectively
The instance/topology container contain the OSPF configuration for
topology when multi-topology feature is enabled
2.2. OSPFv2 and OSPFv3
The defined data model supports both OSPFv2 and OSPFv3.
The field 'version' is used to indicate the OSPF version and is a
mandatory. Based on the version set, the data model change
accordingly to accommodate the difference between the two versions.
2.3. Optional Features
Optional features are features beyond the basic of OSPF
configurations and it is up to a vendor to decide the support of a
particular feature on a particular device.
This module has declared a number of features, such as NSR, max-LSA
etc.. It is intended that vendors will extend the features list.
2.4. Inheritance
This defined data model supports configuration inheritance for
intances, areas and interfaces.
The all-instances-inherit, all-areas-inherit and all-interfaces-
inherit containers provides a consistent way to configure inheritable
command. Inheritance is treated as a feature. Vendors are expected
to augment the above container to provide the list of inheritance
command for their implementation.
2.5. OSPF Router Configuration
The container ospf is the top level container in this data model. It
contains shared information among different OSPF instances under the
container.
Yeung, et al. Expires September 2, 2015 [Page 5]
Internet-Draft OSPF Yang Data Model March 2015
module: ospf
+--rw ospf
+--rw all-instances-inherit {instance-inheritance}?
| +--rw area
| +--rw interface
+--rw operation-mode? identityref
+--rw instance* [af]
.
.
2.6. OSPF Instance Configuration
The container instance represents an OSPF protocol engine. Each
instance indicates the routing domain it is associated with based on
[routing-instance af] and contains the router level configurations.
The all-areas-inherit container contains area configuration that
could be inherited to all OSPF areas defined. Similarly, the all-
areas-inherit also contains interface configuration that could be
inherited to all the OSPF interfaces defined.
module: ospf
+--rw ospf
.
.
+--rw instance* [af]
+--rw af identityref
+--rw router-id? yang:dotted-quad {router-id}?
+--rw admin-distance
| +--rw (scope)?
| +--:(single-value)
| | +--rw all? uint8
| +--:(multi-values)
| +--rw (granularity)?
| | +--:(detail)
| | | +--rw intra-area? uint8
| | | +--rw inter-area? uint8
| | +--:(coarse)
| | +--rw internal? uint8
| +--rw external? uint8
+--rw nsr {nsr}?
| +--rw enable? boolean
+--rw graceful-restart {graceful-restart}?
| +--rw enable? boolean
| +--rw helper-enable? boolean
| +--rw restart-interval? uint16
| +--rw helper-strict-lsa-checking? boolean
Yeung, et al. Expires September 2, 2015 [Page 6]
Internet-Draft OSPF Yang Data Model March 2015
+--rw enable? boolean {admin-control}?
+--rw auto-cost {auto-cost}?
| +--rw enable? boolean
| +--rw reference-bandwidth? uint32
+--rw spf-control
| +--rw paths? uint16 {max-ecmp}?
+--rw database-control
| +--rw max-lsa? uint32 {max-lsa}?
+--rw stub-router {stub-router}?
| +--rw (trigger)?
| +--:(always)
| +--rw always!
+--rw mpls
| +--rw te-rid {te-rid}?
| | +--rw (source)?
| | +--:(interface)
| | | +--rw interface? if:interface-ref
| | +--:(explicit)
| | +--rw router-id? inet:ipv4-address
| +--rw ldp
| +--rw igp-sync? boolean {ldp-igp-sync}?
| +--rw autoconfig? boolean {ldp-igp-autoconfig}?
+--rw fast-reroute {fast-reroute}?
| +--rw lfa {lfa}?
+--rw all-areas-inherit {area-inheritance}?
| +--rw area
| +--rw interface
2.7. OSPF Area Configuration
The container area contains configurations of that area and the list
of interface container represents all the OSPF interfaces active in
the enclosing area.
module: ospf
+--rw ospf
.
.
+--rw instance* [routing-instance af]
.
.
+--rw areas
| +--rw area* [area-id]
| +--rw area-id area-id-type
| +--rw area-type? identityref
| +--rw summary? boolean
| +--rw default-cost? uint32
| +--rw ranges
Yeung, et al. Expires September 2, 2015 [Page 7]
Internet-Draft OSPF Yang Data Model March 2015
| | +--rw range* [prefix]
| | +--rw prefix inet:ip-prefix
| | +--rw advertise? boolean
| | +--rw cost? uint24
| +--rw all-interfaces-inherit {interface-inheritance}?
| | +--rw interface
| +--rw virtual-links
| | +--rw virtual-link* [router-id]
| | +--rw router-id yang:dotted-quad
| | +--rw cost? uint16
| | +--rw hello-interval? uint16
| | +--rw dead-interval? uint16
| | +--rw retransmit-interval? uint16
| | +--rw transmit-delay? uint16
| | +--rw mtu-ignore? boolean {mtu-ignore}?
| | +--rw lls? boolean {lls}?
| | +--rw prefix-suppression? boolean {prefix-suppression}?
| | +--rw bfd? boolean {bfd}?
| | +--rw ttl-security {ttl-security}?
| | | +--rw enable? boolean
| | | +--rw hops? uint8
| | +--rw enable? boolean {admin-control}?
| | +--rw authentication
| | +--rw (auth-type-selection)?
| | +--:(auth-ipsec) {ospfv3-authentication-ipsec}?
| | | +--rw sa? string
| | +--:(auth-trailer-key-chain)
| | | +--rw key-chain? key-chain:key-chain-ref
| | +--:(auth-trailer-key)
| | +--rw key? string
| | +--rw crypto-algorithm
| | +--rw (algorithm)?
| | +--:(hmac-sha-1-12) {crypto-hmac-sha-1-12}?
| | | +--rw hmac-sha1-12? empty
| | +--:(md5)
| | | +--rw md5? empty
| | +--:(sha-1)
| | | +--rw sha-1? empty
| | +--:(hmac-sha-1)
| | | +--rw hmac-sha-1? empty
| | +--:(hmac-sha-256)
| | | +--rw hmac-sha-256? empty
| | +--:(hmac-sha-384)
| | | +--rw hmac-sha-384? empty
| | +--:(hmac-sha-512)
| | +--rw hmac-sha-512? empty
| +--rw sham-link
| | +--rw sham-link* [local-id remote-id]
Yeung, et al. Expires September 2, 2015 [Page 8]
Internet-Draft OSPF Yang Data Model March 2015
| | +--rw local-id inet:ip-address
| | +--rw remote-id inet:ip-address
| | +--rw cost? uint16
| | +--rw hello-interval? uint16
| | +--rw dead-interval? uint16
| | +--rw retransmit-interval? uint16
| | +--rw transmit-delay? uint16
| | +--rw mtu-ignore? boolean {mtu-ignore}?
| | +--rw lls? boolean {lls}?
| | +--rw prefix-suppression? boolean {prefix-suppression}?
| | +--rw bfd? boolean {bfd}?
| | +--rw ttl-security {ttl-security}?
| | | +--rw enable? boolean
| | | +--rw hops? uint8
| | +--rw enable? boolean {admin-control}?
| | +--rw authentication
| | +--rw (auth-type-selection)?
| | +--:(auth-ipsec) {ospfv3-authentication-ipsec}?
| | | +--rw sa? string
| | +--:(auth-trailer-key-chain)
| | | +--rw key-chain? key-chain:key-chain-ref
| | +--:(auth-trailer-key)
| | +--rw key? string
| | +--rw crypto-algorithm
| | +--rw (algorithm)?
| | +--:(hmac-sha-1-12) {crypto-hmac-sha-1-12}?
| | | +--rw hmac-sha1-12? empty
| | +--:(md5)
| | | +--rw md5? empty
| | +--:(sha-1)
| | | +--rw sha-1? empty
| | +--:(hmac-sha-1)
| | | +--rw hmac-sha-1? empty
| | +--:(hmac-sha-256)
| | | +--rw hmac-sha-256? empty
| | +--:(hmac-sha-384)
| | | +--rw hmac-sha-384? empty
| | +--:(hmac-sha-512)
| | +--rw hmac-sha-512? empty
2.8. OSPF Interface Configuration
The container interface contains configurations of that interface.
The ospf-interfaces also contain interface configuration that could
be inherited to all ospf-interface's defined.
module: ospf
Yeung, et al. Expires September 2, 2015 [Page 9]
Internet-Draft OSPF Yang Data Model March 2015
+--rw ospf
.
.
+--rw instance* [routing-instance af]
.
.
+--rw areas
| +--rw area* [area-id]
.
.
| +--rw interfaces
| +--rw interface* [interface]
| +--rw interface if:interface-ref
| +--rw network-type? enumeration
| +--rw passive? boolean
| +--rw demand-circuit? boolean {demand-circuit}?
| +--rw multi-areas
| | +--rw multi-area* [multi-area-id] {multi-area-adj}?
| | +--rw multi-area-id area-id-type
| | +--rw cost? uint16
| +--rw static-neighbors
| | +--rw neighbor* [address]
| | +--rw address inet:ip-address
| | +--rw cost? uint16
| | +--rw poll-interval? uint16
| | +--rw priority? uint8
| +--rw node-flag? boolean {node-flag}?
| +--rw fast-reroute {fast-reroute}?
| | +--rw lfa {lfa}?
| | +--rw candidate-disabled? boolean
| | +--rw enabled? boolean
| | +--rw remote-lfa {remote-lfa}?
| | +--rw enabled? boolean
| +--rw cost? uint16
| +--rw hello-interval? uint16
| +--rw dead-interval? uint16
| +--rw retransmit-interval? uint16
| +--rw transmit-delay? uint16
| +--rw mtu-ignore? boolean {mtu-ignore}?
| +--rw lls? boolean {lls}?
| +--rw prefix-suppression? boolean {prefix-suppression}?
| +--rw bfd? boolean {bfd}?
| +--rw ttl-security {ttl-security}?
| | +--rw enable? boolean
| | +--rw hops? uint8
| +--rw enable? boolean {admin-control}?
| +--rw authentication
| | +--rw (auth-type-selection)?
Yeung, et al. Expires September 2, 2015 [Page 10]
Internet-Draft OSPF Yang Data Model March 2015
| | +--:(auth-ipsec) {ospfv3-authentication-ipsec}?
| | | +--rw sa? string
| | +--:(auth-trailer-key-chain)
| | | +--rw key-chain? key-chain:key-chain-ref
| | +--:(auth-trailer-key)
| | +--rw key? string
| | +--rw crypto-algorithm
| | +--rw (algorithm)?
| | +--:(hmac-sha-1-12) {crypto-hmac-sha-1-12}?
| | | +--rw hmac-sha1-12? empty
| | +--:(md5)
| | | +--rw md5? empty
| | +--:(sha-1)
| | | +--rw sha-1? empty
| | +--:(hmac-sha-1)
| | | +--rw hmac-sha-1? empty
| | +--:(hmac-sha-256)
| | | +--rw hmac-sha-256? empty
| | +--:(hmac-sha-384)
| | | +--rw hmac-sha-384? empty
| | +--:(hmac-sha-512)
| | +--rw hmac-sha-512? empty
| +--rw topologies
| +--rw topology* [name]
| +--rw name leafref
| +--rw cost? uint32
2.9. OSPF notification
This YANG model defines a list of notifications to inform client of
important events detected during the protocol operation. The
notifications defined cover the common set of traps from OSPFv2 MIB
[RFC4750] and OSPFv3 MIB [RFC5643].
module: ospf
notifications:
+---n if-state-change
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro link-type? identityref
| +--ro interface
| | +--ro interface? if:interface-ref
| +--ro virtual-link
| | +--ro area-id? uint32
| | +--ro neighbor-router-id? yang:dotted-quad
| +--ro sham-link
Yeung, et al. Expires September 2, 2015 [Page 11]
Internet-Draft OSPF Yang Data Model March 2015
| | +--ro area-id? uint32
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro state? if-state-type
+---n if-config-error
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro link-type? identityref
| +--ro interface
| | +--ro interface? if:interface-ref
| | +--ro packet-source? yang:dotted-quad
| +--ro virtual-link
| | +--ro area-id? uint32
| | +--ro neighbor-router-id? yang:dotted-quad
| +--ro sham-link
| | +--ro area-id? uint32
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro packet-type? packet-type
| +--ro error? enumeration
+---n nbr-state-change
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro link-type? identityref
| +--ro interface
| | +--ro interface? if:interface-ref
| | +--ro neighbor-router-id? yang:dotted-quad
| | +--ro neighbor-ip-addr? yang:dotted-quad
| +--ro virtual-link
| | +--ro area-id? uint32
| | +--ro neighbor-router-id? yang:dotted-quad
| +--ro sham-link
| | +--ro area-id? uint32
| | +--ro local-ip-addr? inet:ip-address
| | +--ro neighbor-router-id? yang:dotted-quad
| | +--ro neighbor-ip-addr? yang:dotted-quad
| +--ro state? nbr-state-type
+---n nbr-restart-helper-status-change
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro link-type? identityref
| +--ro interface
Yeung, et al. Expires September 2, 2015 [Page 12]
Internet-Draft OSPF Yang Data Model March 2015
| | +--ro interface? if:interface-ref
| | +--ro neighbor-router-id? yang:dotted-quad
| | +--ro neighbor-ip-addr? yang:dotted-quad
| +--ro virtual-link
| | +--ro area-id? uint32
| | +--ro neighbor-router-id? yang:dotted-quad
| +--ro status? restart-helper-status-type
| +--ro age? uint32
| +--ro exit-reason? restart-exit-reason-type
+---n rx-bad-packet
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro link-type? identityref
| +--ro interface
| | +--ro interface? if:interface-ref
| | +--ro packet-source? yang:dotted-quad
| +--ro virtual-link
| | +--ro area-id? uint32
| | +--ro neighbor-router-id? yang:dotted-quad
| +--ro sham-link
| | +--ro area-id? uint32
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro packet-type? packet-type
+---n lsdb-approaching-overflow
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro ext-lsdb-limit? uint32
+---n lsdb-overflow
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro ext-lsdb-limit? uint32
+---n nssa-translator-status-change
| +--ro routing-instance? rt:routing-instance-ref
| +--ro routing-protocol-type? leafref
| +--ro routing-protocol-name? leafref
| +--ro af? leafref
| +--ro area-id? uint32
| +--ro status? nssa-translator-state-type
+---n restart-status-change
+--ro routing-instance? rt:routing-instance-ref
+--ro routing-protocol-type? leafref
Yeung, et al. Expires September 2, 2015 [Page 13]
Internet-Draft OSPF Yang Data Model March 2015
+--ro routing-protocol-name? leafref
+--ro af? leafref
+--ro status? restart-status-type
+--ro restart-interval? uint16
+--ro exit-reason? restart-exit-reason-type
3. OSPF Segment Routing
In additional to the OSPF base YANG model, this document also defines
a model for OSPF segment routing.
The OSPF SR YANG module requires the base segment routing module
[I-D.litkowski-spring-sr-yang] to be supported as there is a strong
relationship between those modules.
module: ietf-ospf-sr
augment /rt:routing/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance:
+--rw segment-routing
+--rw enabled? boolean
+--rw bindings
+--rw advertise
| +--rw policies* string
+--rw receive? boolean
augment /rt:routing/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/ospf:areas/
ospf:area/ospf:interfaces/ospf:interface:
+--rw segment-routing
+--rw adjacency-sid
+--rw advertise-adj-group-sid* [group-id]
| +--rw group-id uint32
+--rw advertise-protection? enumeration
augment /rt:routing/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/ospf:areas/
ospf:area/ospf:interfaces/ospf:interface/ospf:fast-reroute:
+--rw ti-lfa {ti-lfa}?
+--rw enable? boolean
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance:
+--ro segment-routing
+--ro enabled? boolean
+--ro bindings
+--ro advertise
| +--ro policies* string
+--ro receive? boolean
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/ospf:areas/
ospf:area/ospf:interfaces/ospf:interface:
Yeung, et al. Expires September 2, 2015 [Page 14]
Internet-Draft OSPF Yang Data Model March 2015
+--ro segment-routing
+--ro adjacency-sid
+--ro advertise-adj-group-sid* [group-id]
| +--ro group-id uint32
+--ro advertise-protection? enumeration
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/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-tlvs/
ospf:extended-prefix-tlv:
+--ro perfix-sid-sub-tlvs
| +--ro prefix-sid-sub-tlv*
| +--ro flags? bits
| +--ro mt-id? uint8
| +--ro algorithm? uint8
| +--ro sid? uint32
+--ro sid-binding-sub-tlvs
+--ro sid-binding-sub-tlv*
+--ro flags? bits
+--ro mt-id? uint8
+--ro weight? uint8
+--ro sid-sub-tlv
| +--ro sid? uint32
+--ro ero-metric-sub-tlv
| +--ro metric? uint32
+--ro ipv4-ero-sub-tlv
| +--ro flags? bits
| +--ro ipv4-address? inet:ipv4-address
+--ro unnumbered-ero-sub-tlv
| +--ro flags? bits
| +--ro router-id? yang:dotted-quad
| +--ro interface-id? uint32
+--ro ipv4-backup-ero-sub-tlv
| +--ro flags? bits
| +--ro ipv4-address? inet:ipv4-address
+--ro unnumbered-backup-ero-sub-tlv
+--ro flags? bits
+--ro router-id? yang:dotted-quad
+--ro interface-id? uint32
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/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-tlvs/ospf:extended-prefix-tlv:
+--ro perfix-sid-sub-tlvs
Yeung, et al. Expires September 2, 2015 [Page 15]
Internet-Draft OSPF Yang Data Model March 2015
| +--ro prefix-sid-sub-tlv*
| +--ro flags? bits
| +--ro mt-id? uint8
| +--ro algorithm? uint8
| +--ro sid? uint32
+--ro sid-binding-sub-tlvs
+--ro sid-binding-sub-tlv*
+--ro flags? bits
+--ro mt-id? uint8
+--ro weight? uint8
+--ro sid-sub-tlv
| +--ro sid? uint32
+--ro ero-metric-sub-tlv
| +--ro metric? uint32
+--ro ipv4-ero-sub-tlv
| +--ro flags? bits
| +--ro ipv4-address? inet:ipv4-address
+--ro unnumbered-ero-sub-tlv
| +--ro flags? bits
| +--ro router-id? yang:dotted-quad
| +--ro interface-id? uint32
+--ro ipv4-backup-ero-sub-tlv
| +--ro flags? bits
| +--ro ipv4-address? inet:ipv4-address
+--ro unnumbered-backup-ero-sub-tlv
+--ro flags? bits
+--ro router-id? yang:dotted-quad
+--ro interface-id? uint32
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/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-tlvs/ospf:extended-prefix-tlv:
+--ro perfix-sid-sub-tlvs
| +--ro prefix-sid-sub-tlv*
| +--ro flags? bits
| +--ro mt-id? uint8
| +--ro algorithm? uint8
| +--ro sid? uint32
+--ro sid-binding-sub-tlvs
+--ro sid-binding-sub-tlv*
+--ro flags? bits
+--ro mt-id? uint8
+--ro weight? uint8
+--ro sid-sub-tlv
| +--ro sid? uint32
+--ro ero-metric-sub-tlv
| +--ro metric? uint32
Yeung, et al. Expires September 2, 2015 [Page 16]
Internet-Draft OSPF Yang Data Model March 2015
+--ro ipv4-ero-sub-tlv
| +--ro flags? bits
| +--ro ipv4-address? inet:ipv4-address
+--ro unnumbered-ero-sub-tlv
| +--ro flags? bits
| +--ro router-id? yang:dotted-quad
| +--ro interface-id? uint32
+--ro ipv4-backup-ero-sub-tlv
| +--ro flags? bits
| +--ro ipv4-address? inet:ipv4-address
+--ro unnumbered-backup-ero-sub-tlv
+--ro flags? bits
+--ro router-id? yang:dotted-quad
+--ro interface-id? uint32
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/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-tlvs/ospf:extended-link-tlv:
+--ro adj-sid-sub-tlvs
| +--ro adj-sid-sub-tlv*
| +--ro flags? bits
| +--ro mt-id? uint8
| +--ro weight? uint8
| +--ro sid? uint32
+--ro lan-adj-sid-sub-tlvs
+--ro lan-adj-sid-sub-tlv*
+--ro flags? bits
+--ro mt-id? uint8
+--ro weight? uint8
+--ro neighbor-router-id? yang:dotted-quad
+--ro sid? uint32
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/
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:
+--ro extended-prefix-range-tlvs
| +--ro extended-prefix-range-tlv*
| +--ro range-size? uint16
| +--ro flags? bits
| +--ro prefix? inet:ip-prefix
| +--ro perfix-sid-sub-tlvs
| | +--ro prefix-sid-sub-tlv*
| | +--ro flags? bits
| | +--ro mt-id? uint8
Yeung, et al. Expires September 2, 2015 [Page 17]
Internet-Draft OSPF Yang Data Model March 2015
| | +--ro algorithm? uint8
| | +--ro sid? uint32
| +--ro sid-binding-sub-tlvs
| | +--ro sid-binding-sub-tlv*
| | +--ro flags? bits
| | +--ro mt-id? uint8
| | +--ro weight? uint8
| | +--ro sid-sub-tlv
| | | +--ro sid? uint32
| | +--ro ero-metric-sub-tlv
| | | +--ro metric? uint32
| | +--ro ipv4-ero-sub-tlv
| | | +--ro flags? bits
| | | +--ro ipv4-address? inet:ipv4-address
| | +--ro unnumbered-ero-sub-tlv
| | | +--ro flags? bits
| | | +--ro router-id? yang:dotted-quad
| | | +--ro interface-id? uint32
| | +--ro ipv4-backup-ero-sub-tlv
| | | +--ro flags? bits
| | | +--ro ipv4-address? inet:ipv4-address
| | +--ro unnumbered-backup-ero-sub-tlv
| | +--ro flags? bits
| | +--ro router-id? yang:dotted-quad
| | +--ro interface-id? uint32
| +--ro unknown-tlvs
| +--ro unknown-tlv*
| +--ro type? uint16
| +--ro length? uint16
| +--ro value? yang:hex-string
+--ro sr-algorithm-tlv
| +--ro sr-algorithm* uint8
+--ro sid-range-tlvs
+--ro sid-range-tlv*
+--ro range-size? ospf:uint24
+--ro sid-sub-tlv
+--ro sid? uint32
augment /rt:routing-state/rt:routing-instance/rt:routing-protocols/
rt:routing-protocol/ospf:ospf/ospf:instance/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:
+--ro extended-prefix-range-tlvs
| +--ro extended-prefix-range-tlv*