/
draft-ietf-pim-yang-01.txt
3864 lines (3031 loc) · 111 KB
/
draft-ietf-pim-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
PIM Working Group X. Liu
Internet-Draft Ericsson
Intended status: Standards Track P. McAllister
Expires: November 19, 2016 Metaswitch Networks
A. Peter
Juniper Networks
M. Sivakumar
Cisco Systems
Y. Liu
Huawei Technologies
F. Hu
ZTE Corporation
May 18, 2016
A YANG data model for Protocol-Independent Multicast (PIM)
draft-ietf-pim-yang-01
Abstract
This document defines a YANG data model that can be used to configure
Protocol Independent Multicast (PIM) devices.
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 November 19, 2016.
Copyright Notice
Copyright (c) 2016 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
Liu, et al. Expires November 19, 2016 [Page 1]
Internet-Draft PIM YANG May 2016
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
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Design of Data Model . . . . . . . . . . . . . . . . . . . . 3
2.1. Scope of model . . . . . . . . . . . . . . . . . . . . . 3
2.2. Optional capabilities . . . . . . . . . . . . . . . . . . 4
2.3. Top-level structure . . . . . . . . . . . . . . . . . . . 4
2.4. Position of address family in hierarchy . . . . . . . . . 5
3. Unresolved Issues . . . . . . . . . . . . . . . . . . . . . . 5
3.1. Current status of work in progress . . . . . . . . . . . 5
3.2. Group range mappings . . . . . . . . . . . . . . . . . . 5
3.3. Issues blocked on other model designers . . . . . . . . . 6
4. Module Structure . . . . . . . . . . . . . . . . . . . . . . 6
4.1. PIM base module . . . . . . . . . . . . . . . . . . . . . 6
4.2. PIM RP module . . . . . . . . . . . . . . . . . . . . . . 10
4.3. PIM-SM module . . . . . . . . . . . . . . . . . . . . . . 13
4.4. PIM-DM module . . . . . . . . . . . . . . . . . . . . . . 14
4.5. PIM-BIDIR module . . . . . . . . . . . . . . . . . . . . 15
5. PIM YANG Modules . . . . . . . . . . . . . . . . . . . . . . 16
5.1. PIM base module . . . . . . . . . . . . . . . . . . . . . 16
5.2. PIM RP module . . . . . . . . . . . . . . . . . . . . . . 35
5.3. PIM-SM module . . . . . . . . . . . . . . . . . . . . . . 50
5.4. PIM-DM module . . . . . . . . . . . . . . . . . . . . . . 56
5.5. PIM-BIDIR module . . . . . . . . . . . . . . . . . . . . 58
6. TODO list . . . . . . . . . . . . . . . . . . . . . . . . . . 66
7. Security Considerations . . . . . . . . . . . . . . . . . . . 66
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 66
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 66
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 67
10.1. Normative References . . . . . . . . . . . . . . . . . . 67
10.2. Informative References . . . . . . . . . . . . . . . . . 67
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 68
1. Introduction
YANG [RFC6020] [RFC6087] is a data definition language that was
introduced to model the configuration and running state of a device
managed using NETCONF [RFC6241]. YANG is now also being used as a
component of wider management interfaces, such as CLIs.
Liu, et al. Expires November 19, 2016 [Page 2]
Internet-Draft PIM YANG May 2016
This document defines a draft YANG data model that can be used to
configure and manage Protocol-Independent Multicast (PIM) devices.
Currently this model is incomplete, but it will support the core PIM
protocol, as well as many other features mentioned in separate PIM
RFCs. Non-core features are defined as optional in the provided 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 BCP 14, RFC 2119
[RFC2119].
1.2. Terminology
The terminology for describing YANG data models is found in
[RFC6020].
This draft employs YANG tree diagrams, which are explained in
[I-D.ietf-netmod-rfc6087bis].
2. Design of Data Model
2.1. Scope of model
The model covers PIM Sparse Mode [RFC4601], including the Source-
Specfic subset [RFC3569], Dense Mode [RFC3973], and Bi-directional
PIM [RFC5015].
The PIM extensions represented in the model include BSR [RFC5059] and
Anycast RP [RFC4610].
The representation of some of these features is not completely
specified in this draft of the data model. This model is being
circulated in its current form for early oversight and review of the
basic hierarchy.
The operational state fields and notifications of this model are also
incomplete, though the structure of what has been written may be
taken as representative of the structure of the model when complete.
This model does not cover other multicast protocols such as IGMP/MLD,
MSDP, mVPN, or m-LDP in-band signalling. It does not cover any
configuration required to generate the MRIB. These will be covered
by future Internet Drafts.
Liu, et al. Expires November 19, 2016 [Page 3]
Internet-Draft PIM YANG May 2016
2.2. Optional capabilities
This model is designed to represent the capabilities of PIM devices
with various specifications, including some with basic subsets of the
PIM protocol. The main design goals of this draft are that any major
now-existing implementation may be said to support the base model,
and that the configuration of all implementations meeting the
specification is easy to express through some combination of the
features in the base model and simple vendor augmentations.
There is also value in widely-supported features being standardized,
to save work for individual vendors, and so that mapping between
different vendors' configuration is not needlessly complicated.
Therefore these modules declare a number of features representing
capabilities that not all deployed devices support.
The extensive use of feature declarations should also substantially
simplify the capability negotiation process for a vendor's PIM
implementation.
On the other hand, operational state parameters are not so widely
designated as features, as there are many cases where the defaulting
of an operational state parameter would not cause any harm to the
system, and it is much more likely that an implementation without
native support for a piece of operational state would be able to
derive a suitable value for a state variable that is not natively
supported.
For the same reason, wide constant ranges (for example, timer maxima
and minima) will be used in the model. It is expected that vendors
will augment the model with any specific restrictions that might be
required. Vendors may also extend the features list with proprietary
extensions.
2.3. Top-level structure
This model defines several separate modules for modelling PIM
configuration, defined below. Again, this separation will make it
easier to express the specific capabilities of a PIM device.
The hierarchy of PIM configuration is designed so that objects that
are only relevant for one situation or feature are collected in a
container for that feature. For example, the configuration for PIM-
SM that is not relevant for an SSM-only implementation is collected
in an ASM container.
Liu, et al. Expires November 19, 2016 [Page 4]
Internet-Draft PIM YANG May 2016
Where fields are not genuinely essential to protocol operation, they
are marked as optional. Some fields will be essential but have a
default specified, so they need not be explicitly configured.
This module structure also applies, where applicable, to the
operational state and notifications of the model.
2.4. Position of address family in hierarchy
The current draft contains address-family as a node in the hierarchy
multiple times: both under the interface list, and under the PIM
instance. This is similar to the IS-IS yang draft model.
The reasoning for this is to make it easier for implementations in
which configuration options are not supported for specific address
families.
For these implementations, the restriction that interface
configuration must be address-family independent must either be
expressed as a vendor augmentation of an address-family-independent
parameter above the address-family level, or by a constraint on the
base model objects of a form similar to:
must ". = ../../address-family[address-family='ipv4']/
interface[interface=current()/sibling:interface]/dr-priority" {
error-app-tag dr-priority-mismatch; error-message "Error: IPv6 DR
priority must match IPv4 DR priority "; }
3. Unresolved Issues
3.1. Current status of work in progress
The model so far details how the PIM modules interact and covers the
higher levels of their hierarchy. Some details of interface
configuration, RP configuration, and PIM-ASM-specific parameters are
also complete.
For a list of the most substantial areas still to cover, please see
the "TODO list" section below.
3.2. Group range mappings
There is currently no convenient way in the operational state model
to map from a group address to the PIM mode and RP information that
it will be forwarded according to, which complicates reasoning about
the running state and the diagnosis of conflicting policy
configuration.
Liu, et al. Expires November 19, 2016 [Page 5]
Internet-Draft PIM YANG May 2016
A hypothetical group range state reporting object indexed by group
range would be desirable for this purpose, but would be inconvenient
for many implementations that index the relevant information on RP
address (not applicable for DM or unroutable group-ranges), and
difficult to express directly in YANG (as it is difficult to express
a container indexed on an arbitrary, proprietary policy structure).
3.3. Issues blocked on other model designers
Some questions must be resolved with reference to other yang models,
and so the resolution may be blocked on a decision from another body.
Currently these issues are:
1. The position of BFD in the configuration; does the BFD model
augment various different protocols, or do the protocols have to
augment themselves individually to support BFD?
2. The abstract concepts of a "set of IP addresses" or "set of IP
prefixes", as represented in implementations by prefixes, ACLs or
policy statements, is a general concept out of the scope of this
document. It will presumably have a yang data-type the
instantiation of which is vendor-specific.
4. Module Structure
4.1. PIM base module
The PIM base module defines the router-wide configuration options not
specific to any PIM mode, and is included by the other modules.
There are a couple of things worth mentioning here regarding where
the PIM model fits in the overall routing hierarchy:
1. Our current direction is to agree to a routing-instance-centric
(VRF) model as opposed to protocol-centric mainly because it fits
well into the routing-instance model, and it is easier to map
from the VRF-centric to the protocol-centric than the other way
around due to forward references.
2. The PIM base model will augment "/rt:routing/rt:routing-instance/
rt:routing-protocols:" as opposed to augmenting "/rt:routing/
rt:routing-instance/rt:routing-protocols:/rt:routing-protocol" as
the latter would allow multiple protocol instances per VRF, which
does not make sense for PIM.
module: ietf-pim-base
augment /rt:routing/rt:routing-protocols:
+--rw pim
+--rw graceful-restart
Liu, et al. Expires November 19, 2016 [Page 6]
Internet-Draft PIM YANG May 2016
| +--rw enabled? boolean
| +--rw duration? uint16
+--rw address-family* [address-family]
| +--rw address-family identityref
| +--rw graceful-restart
| +--rw enabled? boolean
| +--rw duration? uint16
+--rw interfaces
+--rw interface* [interface]
+--rw interface if:interface-ref
+--rw address-family* [address-family]
+--rw address-family identityref
+--rw bfd
| +--rw enabled? boolean
| +--rw local-multiplier? multiplier
| +--rw (interval-config-type)?
| +--:(tx-rx-intervals)
| | +--rw desired-min-tx-interval uint32
| | +--rw required-min-rx-interval uint32
| +--:(single-interval)
| +--rw min-interval uint32
+--rw dr-priority? uint32 {intf-dr-priority}?
+--rw hello-interval? timer-value {intf-hello-interval}?
+--rw (hello-holdtime-or-multipler)?
| +--:(holdtime) {intf-hello-holdtime}?
| | +--rw hello-holdtime? timer-value
| +--:(multipler) {intf-hello-multipler}?
| +--rw hello-multipler? uint8
+--rw jp-interval? timer-value {intf-jp-interval}?
+--rw (jp-holdtime-or-multipler)?
| +--:(holdtime) {intf-jp-holdtime}?
| | +--rw jp-holdtime? timer-value
| +--:(multipler) {intf-jp-multipler}?
| +--rw jp-multipler? uint8
+--rw propagation-delay? uint16 {intf-propagation-delay}?
+--rw override-interval? uint16 {intf-override-interval}?
augment /rt:routing-state/rt:routing-protocols:
+--ro pim
+--ro address-family* [address-family]
| +--ro address-family identityref
| +--ro statistics
| | +--ro discontinuity-time? yang:date-and-time
| | +--ro error
| | | +--ro assert? yang:counter64
| | | +--ro bsr? yang:counter64
| | | +--ro candidate-rp-advertisement? yang:counter64
| | | +--ro hello? yang:counter64
| | | +--ro join-prune? yang:counter64
Liu, et al. Expires November 19, 2016 [Page 7]
Internet-Draft PIM YANG May 2016
| | | +--ro register? yang:counter64
| | | +--ro register-stop? yang:counter64
| | | +--ro state-refresh? yang:counter64
| | +--ro queue
| | | +--ro size? uint32
| | | +--ro overflow? yang:counter32
| | +--ro received
| | | +--ro assert? yang:counter64
| | | +--ro bsr? yang:counter64
| | | +--ro candidate-rp-advertisement? yang:counter64
| | | +--ro hello? yang:counter64
| | | +--ro join-prune? yang:counter64
| | | +--ro register? yang:counter64
| | | +--ro register-stop? yang:counter64
| | | +--ro state-refresh? yang:counter64
| | +--ro sent
| | +--ro assert? yang:counter64
| | +--ro bsr? yang:counter64
| | +--ro candidate-rp-advertisement? yang:counter64
| | +--ro hello? yang:counter64
| | +--ro join-prune? yang:counter64
| | +--ro register? yang:counter64
| | +--ro register-stop? yang:counter64
| | +--ro state-refresh? yang:counter64
| +--ro topology-tree-info
| +--ro ipv4-route* [group source-addr is-rpt]
| | +--ro group inet:ipv4-address
| | +--ro source-addr union
| | +--ro is-rpt boolean
| | +--ro expire? uint32
| | +--ro incoming-interface? if:interface-ref
| | +--ro mode? pim-mode
| | +--ro msdp-learned? boolean
| | +--ro rp-address? inet:ip-address
| | +--ro rpf-neighbor? inet:ip-address
| | +--ro spt-bit? boolean
| | +--ro up-time? uint32
| | +--ro outgoing-interface* [name]
| | +--ro name if:interface-ref
| | +--ro expire? timer-value
| | +--ro up-time? uint32
| | +--ro jp-state? enumeration
| +--ro ipv6-route* [group source-addr is-rpt]
| +--ro group inet:ipv6-address
| +--ro source-addr union
| +--ro is-rpt boolean
| +--ro expire? uint32
| +--ro incoming-interface? if:interface-ref
Liu, et al. Expires November 19, 2016 [Page 8]
Internet-Draft PIM YANG May 2016
| +--ro mode? pim-mode
| +--ro msdp-learned? boolean
| +--ro rp-address? inet:ip-address
| +--ro rpf-neighbor? inet:ip-address
| +--ro spt-bit? boolean
| +--ro up-time? uint32
| +--ro outgoing-interface* [name]
| +--ro name if:interface-ref
| +--ro expire? timer-value
| +--ro up-time? uint32
| +--ro jp-state? enumeration
+--ro interfaces
+--ro interface* [interface]
+--ro interface if:interface-ref
+--ro address-family* [address-family]
+--ro address-family identityref
+--ro bfd
| +--ro enabled? boolean
| +--ro local-multiplier? multiplier
| +--ro (interval-config-type)?
| +--:(tx-rx-intervals)
| | +--ro desired-min-tx-interval uint32
| | +--ro required-min-rx-interval uint32
| +--:(single-interval)
| +--ro min-interval uint32
+--ro dr-priority? uint32 {intf-dr-priority}?
+--ro hello-interval? timer-value {intf-hello-interval}?
+--ro (hello-holdtime-or-multipler)?
| +--:(holdtime) {intf-hello-holdtime}?
| | +--ro hello-holdtime? timer-value
| +--:(multipler) {intf-hello-multipler}?
| +--ro hello-multipler? uint8
+--ro jp-interval? timer-value {intf-jp-interval}?
+--ro (jp-holdtime-or-multipler)?
| +--:(holdtime) {intf-jp-holdtime}?
| | +--ro jp-holdtime? timer-value
| +--:(multipler) {intf-jp-multipler}?
| +--ro jp-multipler? uint8
+--ro propagation-delay? uint16 {intf-propagation-delay}?
+--ro override-interval? uint16 {intf-override-interval}?
+--ro ipv4
| +--ro address* inet:ipv4-address
| +--ro dr-addr? inet:ipv4-address
+--ro ipv6
| +--ro address* inet:ipv6-address
| +--ro dr-addr? inet:ipv6-address
+--ro oper-status? enumeration
+--ro hello-expire? timer-value
Liu, et al. Expires November 19, 2016 [Page 9]
Internet-Draft PIM YANG May 2016
+--ro neighbor-ipv4* [address]
| +--ro address inet:ipv4-address
| +--ro bfd-status? enumeration
| +--ro expire? timer-value
| +--ro dr-priority? uint32
| +--ro gen-id? uint32
| +--ro up-time? uint32
+--ro neighbor-ipv6* [address]
+--ro address inet:ipv6-address
+--ro bfd-status? enumeration
+--ro expire? timer-value
+--ro dr-priority? uint32
+--ro gen-id? uint32
+--ro up-time? uint32
notifications:
+---n pim-neighbor-event
| +--ro event-type? neighbor-event-type
| +--ro interface-state-ref? leafref
| +--ro interface-af-state-ref? leafref
| +--ro neighbor-ipv4-state-ref? leafref
| +--ro neighbor-ipv6-state-ref? leafref
| +--ro up-time? uint32
+---n pim-interface-event
+--ro event-type? interface-event-type
+--ro interface-state-ref? leafref
+--ro ipv4
| +--ro address* inet:ipv4-address
| +--ro dr-addr? inet:ipv4-address
+--ro ipv6
+--ro address* inet:ipv6-address
+--ro dr-addr? inet:ipv6-address
4.2. PIM RP module
The PIM RP module contains configuration information scoped to RPs or
ranges of group addresses. This does not belong in the hierarchy
under any PIM mode, but is augmented by the individual mode-specific
modules as appropriate.
module: ietf-pim-rp
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family:
+--rw rp
+--rw static-rp
| +--rw ipv4-rp* [ipv4-addr]
| | +--rw ipv4-addr inet:ipv4-address
| +--rw ipv6-rp* [ipv6-addr]
| +--rw ipv6-addr inet:ipv6-address
Liu, et al. Expires November 19, 2016 [Page 10]
Internet-Draft PIM YANG May 2016
+--rw bsr {bsr}?
+--rw bsr-candidate!
| +--rw (interface-or-address)?
| | +--:(interface) {candidate-interface}?
| | | +--rw interface if:interface-ref
| | +--:(ipv4-address) {candidate-ipv4}?
| | | +--rw ipv4-address inet:ipv4-address
| | +--:(ipv6-address) {candidate-ipv6}?
| | +--rw ipv6-address inet:ipv6-address
| +--rw hash-mask-length uint8
| +--rw priority uint8
+--rw rp-candidate-interface* [interface] {candidate-interface}?
| +--rw interface if:interface-ref
| +--rw policy? string
| +--rw mode? identityref
+--rw rp-candidate-ipv4-address* [ipv4-address] {candidate-ipv4}?
| +--rw ipv4-address inet:ipv4-address
| +--rw policy? string
| +--rw mode? identityref
+--rw rp-candidate-ipv6-address* [ipv6-address] {candidate-ipv6}?
+--rw ipv6-address inet:ipv6-address
+--rw policy? string
+--rw mode? identityref
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family:
+--ro rp
+--ro static-rp
| +--ro ipv4-rp* [ipv4-addr]
| | +--ro ipv4-addr inet:ipv4-address
| +--ro ipv6-rp* [ipv6-addr]
| +--ro ipv6-addr inet:ipv6-address
+--ro bsr {bsr}?
| +--ro bsr-candidate!
| | +--ro (interface-or-address)?
| | | +--:(interface) {candidate-interface}?
| | | | +--ro interface if:interface-ref
| | | +--:(ipv4-address) {candidate-ipv4}?
| | | | +--ro ipv4-address inet:ipv4-address
| | | +--:(ipv6-address) {candidate-ipv6}?
| | | +--ro ipv6-address inet:ipv6-address
| | +--ro hash-mask-length uint8
| | +--ro priority uint8
| +--ro rp-candidate-interface* [interface] {candidate-interface}?
| | +--ro interface if:interface-ref
| | +--ro policy? string
| | +--ro mode? identityref
| +--ro rp-candidate-ipv4-address* [ipv4-address] {candidate-ipv4}?
| | +--ro ipv4-address inet:ipv4-address
Liu, et al. Expires November 19, 2016 [Page 11]
Internet-Draft PIM YANG May 2016
| | +--ro policy? string
| | +--ro mode? identityref
| +--ro rp-candidate-ipv6-address* [ipv6-address] {candidate-ipv6}?
| | +--ro ipv6-address inet:ipv6-address
| | +--ro policy? string
| | +--ro mode? identityref
| +--ro bsr
| | +--ro addr? inet:ip-address
| | +--ro hash-mask-length? uint8
| | +--ro priority? uint8
| | +--ro up-time? uint32
| +--ro (election-state)? {bsr-election-state}?
| | +--:(candidate)
| | | +--ro candidate-bsr-state? enumeration
| | +--:(non-candidate)
| | +--ro non-candidate-bsr-state? enumeration
| +--ro bsr-next-bootstrap? uint16
| +--ro rp
| | +--ro rp-address? inet:ip-address
| | +--ro group-policy? string
| | +--ro up-time? uint32
| +--ro rp-candidate-next-advertisement? uint16
+--ro rp-list
| +--ro ipv4-rp* [ipv4-addr mode]
| | +--ro ipv4-addr inet:ipv4-address
| | +--ro mode identityref
| | +--ro info-source-addr? inet:ipv4-address
| | +--ro info-source-type? identityref
| | +--ro up-time? uint32
| | +--ro expire? pim-base:timer-value
| +--ro ipv6-rp* [ipv6-addr mode]
| +--ro ipv6-addr inet:ipv6-address
| +--ro mode identityref
| +--ro info-source-addr? inet:ipv6-address
| +--ro info-source-type? identityref
| +--ro up-time? uint32
| +--ro expire? pim-base:timer-value
+--ro rp-mappings
+--ro ipv4-rp* [group rp-addr]
| +--ro group inet:ipv4-prefix
| +--ro rp-addr inet:ipv4-address
| +--ro up-time? uint32
| +--ro expire? pim-base:timer-value
+--ro ipv6-rp* [group rp-addr]
+--ro group inet:ipv6-prefix
+--ro rp-addr inet:ipv6-address
+--ro up-time? uint32
+--ro expire? pim-base:timer-value
Liu, et al. Expires November 19, 2016 [Page 12]
Internet-Draft PIM YANG May 2016
notifications:
+---n pim-rp-event
+--ro event-type? rp-event-type
+--ro instance-af-state-ref? leafref
+--ro group? inet:ip-address
+--ro rp-address? inet:ip-address
+--ro is-rpt? boolean
+--ro mode? pim-base:pim-mode
+--ro message-origin? inet:ip-address
4.3. PIM-SM module
This module covers Sparse Mode configuration, including PIM-ASM and
PIM-SSM.
module: ietf-pim-sm
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family:
+--rw sm
+--rw asm
| +--rw anycast-rp!
| | +--rw ipv4
| | | +--rw ipv4-anycast-rp* [anycast-addr rp-addr]
| | | +--rw anycast-addr inet:ipv4-address
| | | +--rw rp-addr inet:ipv4-address
| | +--rw ipv6
| | +--rw ipv6-anycast-rip* [anycast-addr rp-addr]
| | +--rw anycast-addr inet:ipv6-address
| | +--rw rp-addr inet:ipv6-address
| +--rw spt-switch
| +--rw infinity! {spt-switch-infinity}?
| +--rw policy-name? string {spt-switch-policy}?
+--rw ssm!
+--rw range-poligy? string
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:interfaces/
pim-base:interface/pim-base:address-family:
+--rw sm!
+--rw passive? empty
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family/
pim-rp:rp/pim-rp:static-rp/pim-rp:ipv4-rp:
+--rw sm!
+--rw policy-name? string
+--rw override? boolean {static-rp-override}?
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family/
pim-rp:rp/pim-rp:static-rp/pim-rp:ipv6-rp:
+--rw sm!
+--rw policy-name? string
+--rw override? boolean {static-rp-override}?
Liu, et al. Expires November 19, 2016 [Page 13]
Internet-Draft PIM YANG May 2016
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family:
+--ro sm
+--ro asm
| +--ro anycast-rp!
| | +--ro ipv4
| | | +--ro ipv4-anycast-rp* [anycast-addr rp-addr]
| | | +--ro anycast-addr inet:ipv4-address
| | | +--ro rp-addr inet:ipv4-address
| | +--ro ipv6
| | +--ro ipv6-anycast-rip* [anycast-addr rp-addr]
| | +--ro anycast-addr inet:ipv6-address
| | +--ro rp-addr inet:ipv6-address
| +--ro spt-switch
| +--ro infinity! {spt-switch-infinity}?
| +--ro policy-name? string {spt-switch-policy}?
+--ro ssm!
+--ro range-poligy? string
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:interfaces/pim-base:interface/pim-base:address-family:
+--ro sm!
+--ro passive? empty
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family/pim-rp:rp/pim-rp:static-rp/pim-rp:ipv4-rp:
+--ro sm!
+--ro policy-name? string
+--ro override? boolean {static-rp-override}?
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family/pim-rp:rp/pim-rp:static-rp/pim-rp:ipv6-rp:
+--ro sm!
+--ro policy-name? string
+--ro override? boolean {static-rp-override}?
4.4. PIM-DM module
This module will cover Dense Mode configuration.
module: ietf-pim-dm
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family:
+--rw dm!
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:interfaces/
pim-base:interface/pim-base:address-family:
+--rw dm!
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family:
+--ro dm
Liu, et al. Expires November 19, 2016 [Page 14]
Internet-Draft PIM YANG May 2016
4.5. PIM-BIDIR module
This module will cover Bidirectional PIM configuration.
module: ietf-pim-bidir
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family:
+--rw bidir
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:interfaces/
pim-base:interface/pim-base:address-family:
+--rw bidir!
+--rw df-election {intf-df-election}?
+--rw offer-interval? pim-base:timer-value
+--rw backoff-interval? pim-base:timer-value
+--rw offer-multipler? uint8
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family/
pim-rp:rp/pim-rp:static-rp/pim-rp:ipv4-rp:
+--rw bidir!
+--rw policy-name? string
+--rw override? boolean {static-rp-override}?
augment /rt:routing/rt:routing-protocols/pim-base:pim/pim-base:address-family/
pim-rp:rp/pim-rp:static-rp/pim-rp:ipv6-rp:
+--rw bidir!
+--rw policy-name? string
+--rw override? boolean {static-rp-override}?
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family:
+--ro bidir
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:interfaces/pim-base:interface/pim-base:address-family:
+--ro bidir!
+--ro df-election {intf-df-election}?
+--ro offer-interval? pim-base:timer-value
+--ro backoff-interval? pim-base:timer-value
+--ro offer-multipler? uint8
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family/pim-rp:rp/pim-rp:static-rp/pim-rp:ipv4-rp:
+--ro bidir!
+--ro policy-name? string
+--ro override? boolean {static-rp-override}?
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family/pim-rp:rp/pim-rp:static-rp/pim-rp:ipv6-rp:
+--ro bidir!
+--ro policy-name? string
+--ro override? boolean {static-rp-override}?
augment /rt:routing-state/rt:routing-protocols/pim-base:pim/
pim-base:address-family/pim-rp:rp:
+--ro bidir
+--ro df-election
Liu, et al. Expires November 19, 2016 [Page 15]
Internet-Draft PIM YANG May 2016
| +--ro ipv4-rp* [ipv4-addr]
| | +--ro ipv4-addr inet:ipv4-address
| +--ro ipv6-rp* [ipv6-addr]
| +--ro ipv6-addr inet:ipv6-address
+--ro interface-df-election
+--ro ipv4-rp* [ipv4-addr interface-name]
| +--ro ipv4-addr inet:ipv4-address
| +--ro interface-name if:interface-ref
| +--ro df-address? inet:ipv4-address
| +--ro interface-state? identityref
+--ro ipv6-rp* [ipv6-addr interface-name]
+--ro ipv6-addr inet:ipv6-address
+--ro interface-name if:interface-ref
+--ro df-address? inet:ipv6-address
+--ro interface-state? identityref
5. PIM YANG Modules
5.1. PIM base module
<CODE BEGINS> file "ietf-pim-base@2016-03-18.yang"
module ietf-pim-base {
namespace "urn:ietf:params:xml:ns:yang:ietf-pim-base";
// replace with IANA namespace when assigned
prefix pim-base;
import ietf-inet-types {
prefix "inet";
}
import ietf-yang-types {
prefix "yang";
}
import ietf-interfaces {
prefix "if";
}
import ietf-routing {
prefix "rt";
}
import ietf-bfd {
prefix "bfd";
}
Liu, et al. Expires November 19, 2016 [Page 16]
Internet-Draft PIM YANG May 2016
organization
"IETF PIM Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/pim/>
WG List: <mailto:pim@ietf.org>
WG Chair: Stig Venaas
<mailto:stig@venaas.com>
WG Chair: Mike McBride
<mailto:mmcbride7@gmail.com>
Editors: ";
description
"The module defines a collection of YANG definitions common for
all PIM modes.";
revision 2016-03-18 {
description
"Initial revision.";
reference
"RFC XXXX: A YANG Data Model for PIM";
}
/*
* Features
*/
feature bfd-protocol-parms {
description
"BFD protocol specific parameters support.";
}
feature global-graceful-restart {
description
"Global configuraiont for graceful restart support as per
RFC5306.";
}
feature intf-dr-priority {
description
"Support configuration of interface dr priority.";
}
feature intf-hello-holdtime {
description
"Support configuration of interface hello holdtime.";
Liu, et al. Expires November 19, 2016 [Page 17]
Internet-Draft PIM YANG May 2016
}
feature intf-hello-interval {
description
"Support configuration of interface hello interval.";
}
feature intf-hello-multipler {
description
"Support configuration of interface hello multipler.";
}
feature intf-jp-interval {
description
"Support configuration of interface join prune interval.";
}
feature intf-jp-holdtime {
description
"Support configuration of interface join prune holdtime.";
}
feature intf-jp-multipler {
description
"Support configuration of interface join prune multipler.";
}
feature intf-propagation-delay {
description
"Support configuration of interface propagation delay.";
}
feature intf-override-interval {
description
"Support configuration of interface override interval.";
}
feature per-af-graceful-restart {
description
"Per AF configuraiont for graceful restart support as per
RFC5306.";
}
/*