yang/frr-igmp.yang

   1 module frr-igmp {
   2   yang-version "1.1";
   3   namespace "http://frrouting.org/yang/igmp";
   4
   5   prefix frr-igmp;
   6
   7   import frr-routing {
   8     prefix "frr-rt";
   9   }
  10
  11   import ietf-routing-types {
  12     prefix "rt-types";
  13   }
  14
  15   import ietf-inet-types {
  16     prefix "inet";
  17   }
  18
  19   import frr-interface {
  20     prefix frr-interface;
  21   }
  22
  23   organization
  24     "FRRouting";
  25
  26   contact
  27     "FRR Users List:       <mailto:frog@lists.frrouting.org>
  28      FRR Development List: <mailto:dev@lists.frrouting.org>";
  29
  30   description
  31     "This module defines a model for managing FRR pimd daemon.
  32
  33      Copyright 2020 FRRouting
  34
  35      Redistribution and use in source and binary forms, with or without
  36      modification, are permitted provided that the following conditions
  37      are met:
  38
  39      1. Redistributions of source code must retain the above copyright notice,
  40      this list of conditions and the following disclaimer.
  41
  42      2. Redistributions in binary form must reproduce the above copyright
  43      notice, this list of conditions and the following disclaimer in the
  44      documentation and/or other materials provided with the distribution.
  45
  46      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  47      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  48      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  49      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  50      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  51      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  52      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  53      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  54      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  55      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  56      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  57
  58   revision 2019-11-06 {
  59     description
  60       "Initial revision.";
  61     reference
  62       "RFC 2236: IGMP v2.
  63        RFC 3376: IGMP v3.";
  64   }
  65
  66   grouping interface-config-attributes {
  67     description
  68       "Configuration attributes applied to the interface level.";
  69
  70     leaf igmp-enable {
  71       type boolean;
  72       default "false";
  73       description
  74         "Enable IGMP flag on the interface.";
  75     }
  76
  77     leaf version {
  78       type uint8 {
  79         range "2..3";
  80       }
  81       description
  82         "IGMP version.";
  83     }
  84
  85     leaf query-interval {
  86       type uint16 {
  87         range "1..1800";
  88       }
  89       units seconds;
  90       default "125";
  91       description
  92         "The Query Interval is the interval between General Queries
  93          sent by the Querier.";
  94     }
  95
  96     leaf query-max-response-time {
  97       type uint8 {
  98         range "10..250";
  99       }
 100       units deciseconds;
 101       default "100";
 102       description
 103         "Query maximum response time specifies the maximum time
 104          allowed before sending a responding report.";
 105     }
 106
 107     leaf last-member-query-interval {
 108       type uint8 {
 109         range "1..255";
 110       }
 111       units deciseconds;
 112       default "10";
 113       description
 114         "Last Member Query Interval, which may be tuned to modify
 115          the leave latency of the network.";
 116     }
 117
 118     leaf robustness-variable {
 119       type uint8 {
 120         range "1..7";
 121       }
 122       default "2";
 123       description
 124         "Querier's Robustness Variable allows tuning for the
 125          expected packet loss on a network.";
 126     }
 127   }
 128
 129   grouping per-af-interface-config-attributes {
 130     description
 131       "Configuration attributes applied to the interface level per address family.";
 132
 133     list static-group {
 134       key "group-addr source-addr";
 135       description
 136         "A static multicast route, (*,G) or (S,G).
 137          The version of IGMP must be 3 to support (S,G).";
 138
 139       leaf group-addr {
 140         type rt-types:ip-multicast-group-address;
 141         description
 142           "Multicast group address.";
 143       }
 144       leaf source-addr {
 145         type inet:ip-address;
 146         description
 147           "Multicast source address.";
 148       }
 149     }
 150
 151   } // per-af-interface-config-attributes
 152
 153   /*
 154    * Per-interface configuration data
 155    */
 156   augment "/frr-interface:lib/frr-interface:interface" {
 157     container igmp {
 158       presence
 159         "Configure IGMP on an interface.";
 160       uses interface-config-attributes;
 161       list address-family {
 162         key "address-family";
 163         description
 164           "Each list entry for one address family.";
 165         uses frr-rt:address-family;
 166         uses per-af-interface-config-attributes;
 167
 168         } //address-family
 169     }
 170   }
 171 }