yang/frr-pim-rp.yang

   1 module frr-pim-rp {
   2   yang-version "1.1";
   3   namespace "http://frrouting.org/yang/pim-rp";
   4
   5   prefix frr-pim-rp;
   6
   7   import ietf-inet-types {
   8     prefix "inet";
   9   }
  10
  11   import frr-routing {
  12     prefix "frr-rt";
  13   }
  14
  15   import frr-pim {
  16     prefix "frr-pim";
  17   }
  18
  19   import frr-route-types {
  20     prefix frr-route-types;
  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     "The module defines a collection of YANG definitions common for
  32      all PIM (Protocol Independent Multicast) RP (Rendezvous Point) model.
  33
  34      Copyright 2020 FRRouting
  35
  36      Redistribution and use in source and binary forms, with or without
  37      modification, are permitted provided that the following conditions
  38      are met:
  39
  40      1. Redistributions of source code must retain the above copyright notice,
  41      this list of conditions and the following disclaimer.
  42
  43      2. Redistributions in binary form must reproduce the above copyright
  44      notice, this list of conditions and the following disclaimer in the
  45      documentation and/or other materials provided with the distribution.
  46
  47      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  48      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  49      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  50      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  51      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  52      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  53      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  54      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  55      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  56      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  57      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  58
  59   revision 2017-03-09 {
  60     description
  61       "Initial revision.";
  62     reference
  63       "RFC XXXX: A YANG Data Model for PIM RP";
  64   }
  65
  66   typedef plist-ref {
  67     type string;
  68   }
  69
  70   /*
  71    * Groupings
  72    */
  73   grouping static-rp-container {
  74     description
  75       "Grouping of static RP container.";
  76
  77     container static-rp {
  78       description
  79         "Containing static RP attributes.";
  80
  81       list rp-list {
  82         key "rp-address";
  83         description
  84           "A list of RP addresses.";
  85
  86         leaf rp-address {
  87           type inet:ip-address;
  88           description
  89             "Specifies a static RP address.";
  90         }
  91
  92         choice group-list-or-prefix-list {
  93           description "Use group-list or prefix-list";
  94           case group-list {
  95             leaf-list group-list{
  96               type frr-route-types:ip-multicast-group-prefix;
  97               description
  98                 "List of multicast group address.";
  99             }
 100           }
 101           case prefix-list {
 102             leaf prefix-list {
 103               type plist-ref;
 104               description
 105                 "Group prefix-list filter";
 106             }
 107           }
 108         }
 109       }
 110     } // static-rp
 111   } // static-rp-container
 112
 113   /*
 114    * Configuration data nodes
 115    */
 116   augment "/frr-rt:routing/frr-rt:control-plane-protocols/"
 117     + "frr-rt:control-plane-protocol/frr-pim:pim/"
 118     + "frr-pim:address-family" {
 119     description "PIM RP augmentation.";
 120
 121     container rp {
 122       description
 123         "PIM RP configuration data.";
 124       uses static-rp-container;
 125     } // rp
 126   } // augment
 127 }