summaryrefslogtreecommitdiffstats
path: root/src/plugins/yang/openconfig/openconfig-pim.yang
blob: 7389f9cc45047ff3b35a6f41987821e7804f04a7 (plain)
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
module openconfig-pim {

    yang-version "1";

    // namespace
    namespace "http://openconfig.net/yang/pim";

    prefix "oc-pim";

    // import some basic types/interfaces
    import openconfig-pim-types { prefix oc-pim-types; }
    import openconfig-interfaces { prefix oc-if; }
    import openconfig-acl { prefix oc-acl; }
    import openconfig-types { prefix "oc-types"; }
    import openconfig-extensions { prefix "oc-ext"; }
    import ietf-inet-types { prefix "inet"; }

    // meta
    organization
      "OpenConfig working group";

    contact
      "OpenConfig working group
      www.openconfig.net";

    description
      "An OpenConfig model for Protocol Independent Multicast (PIM).";

    oc-ext:openconfig-version "0.1.0";

    revision "2018-02-09" {
        description
          "Initial revision.";
        reference "0.1.0";
    }

    grouping admin-config {
        description
          "Re-usable grouping to enable or disable a particular feature.";

        leaf enabled {
            type boolean;
            default false;
            description
              "When set to true, the functionality within which this
              leaf is defined is enabled, when set to false it is
              explicitly disabled.";
        }
    }

    grouping pim-counters-state {
        description
          "Counters related to PIM messages.";

        leaf hello-messages {
            type uint32;
            description
              "Number of hello messages received.";
            reference "RFC7761 4.9.2 page 108";
        }

        leaf join-prune-messages {
            type uint32;
            description
              "Number of join/prune messages received.";
            reference "RFC7761 4.5 page 44";
        }

        leaf bootstrap-messages {
            type uint32;
            description
              "Number of bootstrap router messages received.";
            reference "RFC7761 3.7 page 12";
        }
    }

    grouping pim-interface-config {
        description
          "Configuration data for PIM on each interface.";

        uses admin-config;

        leaf interface-id {
            type oc-if:interface-id;
            description
              "Reference to an interface on which PIM is enabled.";
        }

        leaf mode {
            type identityref {
                base oc-pim-types:PIM_MODE;
            }
            description
              "PIM mode to use when delivering multicast traffic via this
              interface.";
        }

        leaf bsr-border {
            type boolean;
            default false;
            description
              "When set to true the device will not send bootstrap router
              messages over this interface. By default these are transmitted
              over all PIM sparse mode (PIM-SM) enabled interfaces.";
        }

        leaf border-router {
            type boolean;
            default false;
            description
              "When set to true the interface is set as MBR (multicast border
              router) and allows multicast traffic from sources that are
              outside of the PIM domain.";
        }


        leaf dr-priority {
            type oc-pim-types:dr-priority-type;
            description
              "The designated router priority of this interface. Larger always
              preferred.";
        }

        leaf join-prune-interval {
            type oc-pim-types:pim-interval-type;
            description
              "Interval at which the router sends the PIM join/prune messages
              toward the upstream RPF neighbor.";
        }

        leaf hello-interval {
            type oc-pim-types:pim-interval-type;
            description
              "Interval at which the router sends the PIM hello messages.";
        }

        leaf dead-timer {
            type uint16 {
                range 1..65535;
            }
            description
              "Number of missed hello messages after which a neighbor is
              expired.";
        }
    }

    grouping pim-neighbor-state {
        description
          "PIM neighbor state.";

        leaf neighbor-address {
            type inet:ipv4-address;
            description
              "IPv4 address of neighbor router.";
        }

        leaf dr-address {
            type inet:ipv4-address;
            description
               "IPv4 address of designated router.";
        }

        leaf neighbor-established {
            type oc-types:timeticks64;
            description
              "This timestamp indicates the time that the
              PIM neighbor adjacency established. The value is the
              timestamp in seconds relative to the Unix Epoch
              (Jan 1, 1970 00:00:00 UTC).

              The PIM session uptime can be computed by clients
              as the difference between this value and the
              current time in UTC.";
        }

        leaf neighbor-expires {
            type oc-types:timeticks64;
            description
              "This timestamp indicates the time that the
              PIM neighbor adjacency will expire should hello
              messages fail to arrive from the neighbor.
              The value is the timestamp in seconds relative to
              the Unix Epoch (Jan 1, 1970 00:00:00 UTC).";
        }

        leaf mode {
            type identityref {
                base oc-pim-types:PIM_MODE;
            }
            description
              "PIM mode in use when delivering multicast traffic
              via this neighbor.";
        }
    }

    grouping pim-neighbors-top {
        description
          "Details about PIM neighbors.";

        container neighbors {
            config false;
            description
              "Details about PIM neighbors.";

            list neighbor {
                key "neighbor-address";
                description
                  "Details about a specific PIM neighbor.";

                leaf neighbor-address {
                    type leafref {
                        path "../state/neighbor-address";
                    }
                    description
                      "IPv4 address of neighbor router.";
                }

                container state {
                    config false;
                    description
                      "Details about a specific PIM neighbor.";

                    uses pim-neighbor-state;
                }
            }
        }
    }

    grouping pim-interfaces-top {
        description
          "Configuration and state data for PIM on each interface.";

        container interfaces {
            description
              "Configuration and state data for PIM on each interface.";

            list interface {
                key "interface-id";
                description
                  "This container defines interface PIM configuration and
                  state information.";

                leaf interface-id {
                    type leafref {
                        path "../config/interface-id";
                    }
                    description
                      "Reference to an interface on which PIM is enabled.";
                }

                container config {
                    description
                      "PIM interface configuration.";

                    uses pim-interface-config;
                }

                container state {
                    config false;
                    description
                      "State information for PIM interfaces.";

                    uses pim-interface-config;
                    container counters {
                        description
                          "PIM counters for each interface.";

                        uses pim-counters-state;
                    }
                }

                uses pim-neighbors-top;
                uses oc-if:interface-ref;
            }
        }
    }

    grouping pim-global-state {
        description
          "State and session data for PIM on each interface.";

        leaf neighbor-count {
            type uint8;
            description
              "Number of adjacent PIM neighbors.";
        }

        container counters {
            description
              "Global PIM counters.";

            uses pim-counters-state;
        }
    }

    grouping pim-sources-joined-top {
        description
         "List of multicast sources joined.";

        container sources-joined {
            config false;
            description
              "List of multicast sources joined.";

            list source {
                key "address";
                description
                  "A multicast source that has been joined.";

                leaf address {
                    type leafref {
                        path "../state/address";
                    }
                    description
                      "Source address of multicast.";
                }

                container state {
                    config false;
                    description
                      "State for a multicast source that has been joined.";

                    leaf address {
                        type inet:ipv4-address;
                        description
                          "Source address of multicast.";
                    }

                    leaf group {
                        type inet:ipv4-address;
                        description
                          "Multicast address.";
                    }

                    leaf upstream-interface-id {
                        type oc-if:interface-id;
                        description
                          "The upstream interface for this multicast source.";
                    }
                }
            }
        }
    }

    grouping pim-global-ssm-config {
        description
          "Source specific multicast (SSM) configuration.";

        leaf ssm-ranges {
            type leafref {
                path "/oc-acl:acl/oc-acl:acl-sets/oc-acl:acl-set/" +
                "oc-acl:config/oc-acl:name";
            }
            description
              "List of accepted source specific multicast (SSM) address
              ranges.";
        }
    }

    grouping pim-global-rp-addresses-config {
        description
          "Defines rendezvous points for sparse mode multicast.";

        leaf address {
            type inet:ipv4-address;
            description
              "IPv4 address of rendezvous point.";
        }

        leaf multicast-groups {
            type string;
            // TODO should this be an ACL or prefix-list reference or prefix list?
            // Cisco it's an ACL, Juniper it's an inline prefix list
            description
              "List of multicast groups (multicast IP address ranges) for which
              this entry will be used as a rendezvous point. When not
              present the default is equivalent to all valid IP multicast
              addresses.";
        }
    }

    grouping pim-global-top {
        description
          "Top level grouping for global PIM configuration.";

        container ssm {
            description
              "Source specific multicast (SSM).";

            container config {
                description
                  "Configuration for source specific multicast (SSM).";
                uses pim-global-ssm-config;
            }
            container state {
                config false;
                description
                  "State for source specific multicast (SSM).";
                uses pim-global-ssm-config;
            }
        }

        container rendezvous-points {
            description
              "Defines rendezvous points for sparse mode multicast.";

            list rendezvous-point {
                key "address";
                description
                  "Defines a rendezvous point (RP) for sparse mode multicast.";

                leaf address {
                    type leafref {
                        path "../config/address";
                    }
                    description
                      "IPv4 address of rendezvous point.";
                }

                container config {
                    description
                      "Rendezvous point configuration.";
                    uses pim-global-rp-addresses-config;
                }
                container state {
                    config false;
                    description
                      "Rendezvous point state.";
                    uses pim-global-rp-addresses-config;
                }
            }
        }

        container state {
            config false;
            description
              "Global PIM state.";
            uses pim-global-state;
        }

        uses pim-sources-joined-top;
    }

    grouping pim-top {
        description
          "Top-level grouping for PIM.";

        container pim {
            description
              "Top-level PIM configuration and operational state.";

            container global {
                description
                  "This container defines global PIM configuration and state
                  information.";
                uses pim-global-top;
            }

            uses pim-interfaces-top;
        }
    }

    // data definition statements
}