yang/frr-staticd.yang

   1 module frr-staticd {
   2   yang-version 1.1;
   3   namespace "http://frrouting.org/yang/staticd";
   4   prefix frr-staticd;
   5
   6   import frr-routing {
   7     prefix frr-rt;
   8   }
   9
  10   import frr-nexthop {
  11     prefix frr-nexthop;
  12   }
  13
  14   import ietf-inet-types {
  15     prefix inet;
  16   }
  17
  18   import frr-bfdd {
  19     prefix frr-bfdd;
  20   }
  21
  22   organization
  23     "FRRouting";
  24   contact
  25     "FRR Users List: <mailto:frog@lists.frrouting.org>
  26      FRR Development List: <mailto:dev@lists.frrouting.org>";
  27   description
  28     "This module defines a model for managing FRR staticd information.
  29      This YANG module augments the ietf-routing with additional
  30      nexthop information
  31
  32      Copyright 2020 FRRouting
  33
  34      Redistribution and use in source and binary forms, with or without
  35      modification, are permitted provided that the following conditions
  36      are met:
  37
  38      1. Redistributions of source code must retain the above copyright notice,
  39      this list of conditions and the following disclaimer.
  40
  41      2. Redistributions in binary form must reproduce the above copyright
  42      notice, this list of conditions and the following disclaimer in the
  43      documentation and/or other materials provided with the distribution.
  44
  45      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  46      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  47      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  48      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  49      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  50      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  51      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  52      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  53      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  54      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  55      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  56
  57   revision 2019-12-03 {
  58     description
  59       "Initial revision.";
  60   }
  61
  62   identity staticd {
  63     base frr-rt:routing-protocol;
  64     description
  65       "'Staticd' routing pseudo-protocol.";
  66   }
  67
  68   grouping staticd-prefix-attributes {
  69     list path-list {
  70       key "table-id distance";
  71       leaf table-id {
  72         type uint32;
  73         description
  74           "Table-id";
  75       }
  76
  77       leaf distance {
  78         type frr-rt:administrative-distance;
  79         description
  80           "Admin distance associated with this route.";
  81       }
  82
  83       leaf tag {
  84         type uint32;
  85         default "0";
  86         description
  87           "Route tag";
  88       }
  89
  90       uses frr-nexthop:frr-nexthop;
  91     }
  92   }
  93
  94   augment "/frr-rt:routing/frr-rt:control-plane-protocols/frr-rt:control-plane-protocol" {
  95     container staticd {
  96       when "../frr-rt:type = 'frr-staticd:staticd'" {
  97         description
  98           "This container is only valid for the 'staticd' routing
  99            protocol.";
 100       }
 101       description
 102         "Support for a 'staticd' pseudo-protocol instance
 103          consists of a list of routes.";
 104       list route-list {
 105         key "prefix afi-safi";
 106         description
 107           "List of staticd IP routes.";
 108         leaf prefix {
 109           type inet:ip-prefix;
 110           description
 111             "IP prefix.";
 112         }
 113         leaf afi-safi {
 114           type identityref {
 115             base frr-rt:afi-safi-type;
 116           }
 117           description
 118             "AFI-SAFI type.";
 119         }
 120
 121         uses staticd-prefix-attributes {
 122           augment "path-list/frr-nexthops/nexthop" {
 123             container bfd-monitoring {
 124               description "BFD monitoring options.";
 125               presence
 126                 "Present if BFD configuration is available.";
 127
 128               when "../nh-type = 'ip4' or ../nh-type = 'ip4-ifindex' or
 129                     ../nh-type = 'ip6' or ../nh-type = 'ip6-ifindex'";
 130               uses frr-bfdd:bfd-monitoring;
 131             }
 132           }
 133         }
 134
 135         list src-list {
 136           key "src-prefix";
 137           leaf src-prefix {
 138             type inet:ipv6-prefix;
 139             description
 140               "IPv6 source prefix";
 141           }
 142
 143           uses staticd-prefix-attributes;
 144         }
 145       }
 146     }
 147   }
 148 }