-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathdraft-ietf-ospf-yang-07.txt
5544 lines (4470 loc) · 158 KB
/
draft-ietf-ospf-yang-07.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 Arrcus
Intended status: Informational Y. Qu
Expires: September 14, 2017 Huawei
J. Zhang
Juniper Networks
I. Chen
Jabil
A. Lindem
Cisco Systems
March 13, 2017
Yang Data Model for OSPF Protocol
draft-ietf-ospf-yang-07
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 14, 2017.
Copyright Notice
Copyright (c) 2017 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
Yeung, et al. Expires September 14, 2017 [Page 1]
Internet-Draft OSPF Yang Data Model March 2017
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
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
2.10. OSPF RPC Operations . . . . . . . . . . . . . . . . . . . 15
3. OSPF Yang Module . . . . . . . . . . . . . . . . . . . . . . 15
4. Security Considerations . . . . . . . . . . . . . . . . . . . 95
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 95
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 96
6.1. Normative References . . . . . . . . . . . . . . . . . . 96
6.2. Informative References . . . . . . . . . . . . . . . . . 97
Appendix A. Contributors' Addreses . . . . . . . . . . . . . . . 98
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 98
1. Overview
YANG [RFC6020] is a data definition language used 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 for
implementation of other interfaces, such as CLI and programmatic
APIs.
This document defines a YANG data model that can be used to configure
and manage OSPF and it is an augmentation to the core routing data
model. A core routing data model is defined in [RFC8022], and it
provides the basis for the development of data models for routing
protocols. The interface data model is defined in [RFC7223] and is
used for referencing interfaces from the routing protocol. The key-
chain data model used for OSPF authentication is defined in
Yeung, et al. Expires September 14, 2017 [Page 2]
Internet-Draft OSPF Yang Data Model March 2017
[I-D.ietf-rtgwg-yang-key-chain] and provides both a reference to
configured key-chains and an enumeration of cryptographic algorithms.
Both OSPFv2 [RFC2328] and OSPFv3 [RFC5340] are supported. In
addition to the core OSPF protocol, features described in other OSPF
RFCs are also supported. These includes demand circuit [RFC1793],
traffic engineering [RFC3630], multiple address family [RFC5838],
graceful restart [RFC3623] [RFC5187], NSSA [RFC3101], and OSPF(v3) as
a PE-CE Protocol [RFC4577], [RFC6565]. These non-core features are
optional in the OSPF data model.
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 router vendors. Differences are observed in terms
of how the protocol engine is tied to the routing domain, how
multiple protocol engines are be instantiated, and configuration
inheritance, among others.
The goal of this document is to define a data model that provides a
common user interface to the OSPFv2 and OSPFv3 protocols. There is
very little information that is designated as "mandatory", providing
freedom for vendors to adapt this data model to their respective
product implementations.
2.1. Overview
The OSPF YANG module defined in this document has all the common
building blocks for the OSPF protocol.
The OSPF YANG module augments the /routing/control-plane-protocols/
control-plane-protocol path defined in the ietf-routing module.
Yeung, et al. Expires September 14, 2017 [Page 3]
Internet-Draft OSPF Yang Data Model March 2017
module: ietf-ospf
augment /rt:routing/rt:control-plane-protocols/
rt:control-plane-protocol:
+--rw ospf
+--rw all-instances-inherit {instance-inheritance}?
.
.
+--rw operation-mode? identityref
+--rw instance* [af]
.
.
+--rw areas
| +--rw area* [area-id]
| +--rw area-id area-id-type
| +--rw all-interfaces-inherit {interface-inheritance}?
| .
| .
| +--rw virtual-links
| | +--rw virtual-link* [transit-area-id router-id]
| | .
| | .
| +--rw sham-links {pe-ce-protocol}?
| | +--rw sham-link* [local-id remote-id]
| | .
| | .
| +--rw interfaces
| +--rw interface* [name]
| .
| .
+--rw topologies {multi-topology}?
+--rw topology* [name]
.
.
The ospf module is intended to match to the vendor specific OSPF
configuration construct that is identified by the local identifier
'name'. The field 'version' allows support for OSPFv2 and OSPFv3.
The ospf container includes one or more OSPF protocol engines, each
enclosed in a separate instance entity. Each instance includes
information for the routing domain based on the [routing-instance af]
specification. There is no default routing domain assumed by the
data model. For example, to enable OSPF on a vendor's default IPv4
routing domain, an explicit instance entity with a specification like
["default" "ipv4-unicast"] is required. The instance also contains
OSPF router level configuration
Yeung, et al. Expires September 14, 2017 [Page 4]
Internet-Draft OSPF Yang Data Model March 2017
The instance/area and instance/area/interface containers respectively
define the OSPF configuration for OSPF areas and interfaces.
The instance/topology container defines the OSPF configuration for
OSPF topologies when the multi-topology feature is supported.
2.2. OSPFv2 and OSPFv3
The data model defined herein supports both OSPFv2 and OSPFv3.
The field 'version' is used to indicate the OSPF version and is
mandatory. Based on the configured version, the data model varies to
accommodate the differences between OSPFv2 and OSPFv3.
2.3. Optional Features
Optional features are beyond the basic OSPF configuration and it is
the responsibility of each vendor to decide whether to support a
given feature on a particular device.
This model defines a number of features, such as NSR, max-LSA, etc.
It is expected that vendors will support additional features through
vendor specific augmentations.
2.4. Inheritance
This data model supports configuration inheritance at different
levels including instance-level, area-level, and interface-level
inheritance.
The all-instances-inherit, all-areas-inherit, and all-interfaces-
inherit containers are defined to provide a consistent way to
configure inheritable configuration parameters. For example,
parameters defined in the all-instances-inherit container apply to
all OSPF instances. However, a particular instance configuration can
include leaves that override this inheritance.
Inheritance is defined as an optional feature, and vendors are
permitted to augment the inheritance containers with their own vendor
specific parameters.
2.5. OSPF Router Configuration
The ospf container is the top level container in this data model. It
contains shared information among the OSPF instances configured
within the container.
Yeung, et al. Expires September 14, 2017 [Page 5]
Internet-Draft OSPF Yang Data Model March 2017
module: ietf-ospf
augment /rt:routing/rt:control-plane-protocols/
rt:control-plane-protocol:
+--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 instance container represents an OSPF protocol engine and
contains the router level configuration. The routing domain for each
instance is dictated through the specification of [routing-instance
af].
The all-areas-inherit container contains area configuration that may
be inherited by configured OSPF areas in the OSPF instance.
module: ietf-ospf
augment /rt:routing/rt:control-plane-protocols/
rt:control-plane-protocol:
+--rw ospf
.
.
+--rw instance* [af]
+--rw af identityref
+--rw all-areas-inherit {area-inheritance}?
| +--rw area
| +--rw interface
+--rw explicit-router-id? rt-types:router-id
| {explicit-router-id}?
+--rw preference
| +--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}?
Yeung, et al. Expires September 14, 2017 [Page 6]
Internet-Draft OSPF Yang Data Model March 2017
| +--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
+--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 ietf-spf-delay {ietf-spf-delay}?
| +--rw initial-delay? uint16
| +--rw short-delay? uint16
| +--rw long-delay? uint16
| +--rw hold-down? uint16
| +--rw time-to-learn? uint16
+--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 ipv4-router-id? inet:ipv4-address
| | +--rw ipv6-router-id? inet:ipv6-address
| +--rw ldp
| +--rw igp-sync? boolean {ldp-igp-sync}?
+--rw fast-reroute {fast-reroute}?
| +--rw lfa {lfa}?
+--rw node-tags {node-tag}?
| +--rw node-tag* [tag]
| +--rw tag uint32
.
.
2.7. OSPF Area Configuration
The area container contains OSPF area configuration and the list of
interface containers representing all the OSPF interfaces in the
area.
The all-interfaces-inherit contains interface configuration that may
be inherited by all OSPF area interfaces.
module: ietf-ospf
Yeung, et al. Expires September 14, 2017 [Page 7]
Internet-Draft OSPF Yang Data Model March 2017
augment /rt:routing/rt:control-plane-protocols/
rt:control-plane-protocol:
+--rw ospf
.
.
+--rw instance* [af]
+--rw areas
| +--rw area* [area-id]
| +--rw area-id area-id-type
| +--rw all-interfaces-inherit {interface-inheritance}?
| | +--rw interface
| +--rw area-type? identityref
| +--rw summary? boolean
| +--rw default-cost? uint32
| +--rw ranges
| | +--rw range* [prefix]
| | +--rw prefix inet:ip-prefix
| | +--rw advertise? boolean
| | +--rw cost? uint24
| +--rw virtual-links
| | +--rw virtual-link* [transit-area-id router-id]
| | +--rw transit-area-id -> ../../../area-id
| | +--rw router-id rt-types:router-id
| | +--rw hello-interval? uint16
| | +--rw dead-interval? uint32
| | +--rw retransmit-interval? uint16
| | +--rw transmit-delay? uint16
| | +--rw lls? boolean {lls}?
| | +--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? identityref
| +--rw sham-links {pe-ce-protocol}?
| | +--rw sham-link* [local-id remote-id]
| | +--rw local-id inet:ip-address
| | +--rw remote-id inet:ip-address
Yeung, et al. Expires September 14, 2017 [Page 8]
Internet-Draft OSPF Yang Data Model March 2017
| | +--rw hello-interval? uint16
| | +--rw dead-interval? uint32
| | +--rw retransmit-interval? uint16
| | +--rw transmit-delay? uint16
| | +--rw lls? boolean {lls}?
| | +--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? identityref
| | +--rw cost? uint16
| | +--rw mtu-ignore? boolean
| | {mtu-ignore}?
| | +--rw prefix-suppression? boolean
| | {prefix-suppression}?
. .
. .
2.8. OSPF Interface Configuration
The interface container contains OSPF interface configuration.
module: ietf-ospf
augment /rt:routing/rt:control-plane-protocols/
rt:control-plane-protocol:
+--rw ospf
.
.
+--rw instance* [af]
.
.
+--rw areas
| +--rw area* [area-id]
| .
| .
| +--rw interfaces
| +--rw interface* [name]
Yeung, et al. Expires September 14, 2017 [Page 9]
Internet-Draft OSPF Yang Data Model March 2017
| +--rw name if:interface-ref
| +--rw interface-type? enumeration
| +--rw passive? boolean
| +--rw demand-circuit? boolean
| {demand-circuit}?
| +--rw priority? uint8
| +--rw multi-areas {multi-area-adj}?
| | +--rw multi-area* [multi-area-id]
| | +--rw multi-area-id area-id-type
| | +--rw cost? uint16
| +--rw static-neighbors
| | +--rw neighbor* [identifier]
| | +--rw identifier inet:ip-address
| | +--rw cost? uint16
| | +--rw poll-interval? uint16
| | +--rw priority? uint8
| +--rw node-flag? boolean
| {node-flag}?
| +--rw bfd {bfd}?
| | +--rw enable? boolean
| +--rw fast-reroute {fast-reroute}?
| | +--rw lfa {lfa}?
| | +--rw candidate-enable? boolean
| | +--rw enable? boolean
| | +--rw remote-lfa {remote-lfa}?
| | +--rw enable? boolean
| +--rw hello-interval? uint16
| +--rw dead-interval? uint32
| +--rw retransmit-interval? uint16
| +--rw transmit-delay? uint16
| +--rw lls? boolean {lls}?
| +--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? identityref
| +--rw cost? uint16
Yeung, et al. Expires September 14, 2017 [Page 10]
Internet-Draft OSPF Yang Data Model March 2017
| +--rw mtu-ignore? boolean
| | {mtu-ignore}?
| +--rw prefix-suppression? boolean
| | {prefix-suppression}?
| +--rw topologies {ospf:multi-topology}?
| | +--rw topology* [name]
| | +--rw name -> ../../../../../../../../
| | ../../../rt:ribs/rib/name
| | +--rw cost? uint32
| +--rw instance-id? uint8
.
.
2.9. OSPF notification
This YANG model defines a list of notifications that inform YANG
clients of important events detected during protocol operation. The
defined notifications cover the common set of traps from the OSPFv2
MIB [RFC4750] and OSPFv3 MIB [RFC5643].
notifications:
+---n if-state-change
| +--ro routing-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro (if-link-type-selection)?
| | +--:(interface)
| | | +--ro interface
| | | +--ro interface? if:interface-ref
| | +--:(virtual-link)
| | | +--ro virtual-link
| | | +--ro transit-area-id? area-id-type
| | | +--ro neighbor-router-id? rt-types:router-id
| | +--:(sham-link)
| | +--ro sham-link
| | +--ro area-id? area-id-type
| | +--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-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
Yeung, et al. Expires September 14, 2017 [Page 11]
Internet-Draft OSPF Yang Data Model March 2017
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro (if-link-type-selection)?
| | +--:(interface)
| | | +--ro interface
| | | +--ro interface? if:interface-ref
| | +--:(virtual-link)
| | | +--ro virtual-link
| | | +--ro transit-area-id? area-id-type
| | | +--ro neighbor-router-id? rt-types:router-id
| | +--:(sham-link)
| | +--ro sham-link
| | +--ro area-id? area-id-type
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro packet-source? yang:dotted-quad
| +--ro packet-type? packet-type
| +--ro error? enumeration
+---n nbr-state-change
| +--ro routing-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro (if-link-type-selection)?
| | +--:(interface)
| | | +--ro interface
| | | +--ro interface? if:interface-ref
| | +--:(virtual-link)
| | | +--ro virtual-link
| | | +--ro transit-area-id? area-id-type
| | | +--ro neighbor-router-id? rt-types:router-id
| | +--:(sham-link)
| | +--ro sham-link
| | +--ro area-id? area-id-type
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro neighbor-router-id? rt-types:router-id
| +--ro neighbor-ip-addr? yang:dotted-quad
| +--ro state? nbr-state-type
+---n nbr-restart-helper-status-change
| +--ro routing-protocol-name?
Yeung, et al. Expires September 14, 2017 [Page 12]
Internet-Draft OSPF Yang Data Model March 2017
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro (if-link-type-selection)?
| | +--:(interface)
| | | +--ro interface
| | | +--ro interface? if:interface-ref
| | +--:(virtual-link)
| | | +--ro virtual-link
| | | +--ro transit-area-id? area-id-type
| | | +--ro neighbor-router-id? rt-types:router-id
| | +--:(sham-link)
| | +--ro sham-link
| | +--ro area-id? area-id-type
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro neighbor-router-id? rt-types:router-id
| +--ro neighbor-ip-addr? yang:dotted-quad
| +--ro status? restart-helper-status-type
| +--ro age? uint32
| +--ro exit-reason? restart-exit-reason-type
+---n if-rx-bad-packet
| +--ro routing-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro (if-link-type-selection)?
| | +--:(interface)
| | | +--ro interface
| | | +--ro interface? if:interface-ref
| | +--:(virtual-link)
| | | +--ro virtual-link
| | | +--ro transit-area-id? area-id-type
| | | +--ro neighbor-router-id? rt-types:router-id
| | +--:(sham-link)
| | +--ro sham-link
| | +--ro area-id? area-id-type
| | +--ro local-ip-addr? inet:ip-address
| | +--ro remote-ip-addr? inet:ip-address
| +--ro packet-source? yang:dotted-quad
Yeung, et al. Expires September 14, 2017 [Page 13]
Internet-Draft OSPF Yang Data Model March 2017
| +--ro packet-type? packet-type
+---n lsdb-approaching-overflow
| +--ro routing-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro ext-lsdb-limit? uint32
+---n lsdb-overflow
| +--ro routing-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro ext-lsdb-limit? uint32
+---n nssa-translator-status-change
| +--ro routing-protocol-name?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +--ro af?
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol
| + [rt:name=current()/../routing-protocol-name]/
| + ospf:ospf/instance/af
| +--ro area-id? area-id-type
| +--ro status? nssa-translator-state-type
+---n restart-status-change
+--ro routing-protocol-name?
+ -> /rt:routing/control-plane-protocols/
+ control-plane-protocol/name
+--ro af?
+ -> /rt:routing/control-plane-protocols/
+ control-plane-protocol
+ [rt:name=current()/../routing-protocol-name]/
+ ospf:ospf/instance/af
+--ro status? restart-status-type
+--ro restart-interval? uint16
+--ro exit-reason? restart-exit-reason-type
Yeung, et al. Expires September 14, 2017 [Page 14]
Internet-Draft OSPF Yang Data Model March 2017
2.10. OSPF RPC Operations
The "ietf-ospf" module defines two RPC operations:
o clear-database: reset the content of a particular OSPF database.
o clear-neighbor: restart a particular set of OSPF neighbor.
rpcs:
+---x clear-neighbor
| +---w input
| +---w routing-protocol-name
| + -> /rt:routing/control-plane-protocols/
| + control-plane-protocol/name
| +---w interface? if:interface-ref
+---x clear-database
+---w input
+---w routing-protocol-name
-> /rt:routing/control-plane-protocols/
control-plane-protocol/name
3. OSPF Yang Module
<CODE BEGINS> file "[email protected]"
module ietf-ospf {
namespace "urn:ietf:params:xml:ns:yang:ietf-ospf";
prefix ospf;
import ietf-inet-types {
prefix "inet";
}
import ietf-yang-types {
prefix "yang";
}
import ietf-interfaces {
prefix "if";
}
import ietf-routing-types {
prefix "rt-types";
}
import ietf-routing {
prefix "rt";
}
Yeung, et al. Expires September 14, 2017 [Page 15]
Internet-Draft OSPF Yang Data Model March 2017
import ietf-key-chain {
prefix "key-chain";
}
organization
"Cisco Systems
170 West Tasman Drive
San Jose, CA 95134-1706
USA";
contact
"WG Web: <http://tools.ietf.org/wg/ospf/>
WG List: <mailto:[email protected]>
WG Chair: Acee Lindem
<mailto:[email protected]>
WG Chair: Abhay Roy
<mailto:[email protected]>
Editor: Derek Yeung
<mailto:[email protected]>
Author: Derek Yeung
<mailto:[email protected]>
Author: Yingzhen Qu
<mailto:[email protected]>
Author: Jeffrey Zhang
<mailto:[email protected]>
Author: Ing-Wher Chen
<mailto:[email protected]>
Author: Dean Bogdanovic
<mailto:[email protected]>
Author: Kiran Agrahara Sreenivasa
<mailto:[email protected]>";
description
"This YANG module defines the generic configuration and
operational state for the OSPF protocol common to all
vendor implementations. It is intended that the module
will be extended by vendors to define vendor-specific
OSPF configuration parameters and policies,
for example route maps or route policies.
Terms and Acronyms
OSPF (ospf): Open Shortest Path First
IP (ip): Internet Protocol
Yeung, et al. Expires September 14, 2017 [Page 16]
Internet-Draft OSPF Yang Data Model March 2017
IPv4 (ipv4):Internet Protocol Version 4
IPv6 (ipv6): Internet Protocol Version 6
MTU (mtu) Maximum Transmission Unit
";
revision 2017-03-12 {
description
"* Update authors information.
* Rename admin distance to preference.
* Rename network type to interface type.
* Add ietf-spf-delay as a feature.
* Add node-tag as a feature and update LSA
definition accordingly.
* Remove LDP IGP autoconfig.
* Add BFD as a feature instead of a separate module.
* Change TE router ID to support IPv4 and IPv6 router ID.
* Replace key-chain:crypto-algorithm-types with
key-chain:crypto-algorithm.
* Remove type ieee-bandwidth.
* Import ietf-routing-types and make use of
router-id, address-family and bandwidth-ieee-float32
type definitions.
* Simplify notification header.
* Fix compilation issue in multiple must statements.
";
reference
"RFC XXXX: A YANG Data Model for OSPF.";
}
revision 2016-10-31 {
description
"* Update authors information.
* Rename candidate-disabled to candidiate-enable
and set the default value to TRUE.
* Rename node identifiers that end with
'enabled' to 'enable'.
* Set the default value of
ospf/instance/areas/area/interfaces/interface/
fast-reroute/lfa/enable (previously named 'enabled')
to FALSE.
* Set the default value of
ospf/instance/areas/area/interfaces/interface/
fast-reroute/remote-lfa/enable (previously named 'enabled')
to FALSE.
* Rename
ospf/instance/areas/area/interfaces/interface/
Yeung, et al. Expires September 14, 2017 [Page 17]
Internet-Draft OSPF Yang Data Model March 2017
static-neighbors/neighbor/address to 'identifier'
with type inet:ip-address
* Add 'dead-timer' to
ospf-state/instance/areas/area/interfaces/interface/
neighbors/neighbor.
* Remove 'mtu-ignore' and 'prefix-suppression' from
virtual-link configuration.
* Adjust range specifications from 'transmit-delay',
'dead-interval', and 'retransmit-interval' in
ospf/instance/areas/area/interfaces/interface.
* Change the type of
ospf/instance/areas/area/interface/interface/dead-interval
to uint32 to match RFC2328 Appendix A.3.2.
* Change hello-timer and wait-timer unit to seconds.
* Update hello-timer, dead-timer and wait-timer descriptions.
* Add IEEE bandwidth type and update all TE bandwidth fields
to use it.
* Add Nt-bit to OSPFv2 router LSA.
* Remove L-bit from OSPFv2 router LSA.
";
reference
"RFC XXXX: A YANG Data Model for OSPF.";
}
revision 2016-07-07 {
description
"* Add ospfv3 AF bit.
* Add ospfv2 MT, L, O, DN bit.
* Add interface priority config.
* Change bdr-ip-address to type ip-address.
* Rename leaf interface to name.
* Rename rx-bad-packet to if-rx-bad-packet.
* Move virtual link placement to backbone area.
* Remove cost configuration from virtual link.
* Move if-feature multi-area-adj statement.
* Add type checksum16-type.
* Change LSA header checksum to use checksum16-type.
* Change routing-protocol to control-plane-protocol.
* Change import module name to ietf-key-chain.";
reference
"RFC XXXX: A YANG Data Model for OSPF.";
}
revision 2016-03-20 {