yang/frr-routing.yang

   1 module frr-routing {
   2   yang-version "1.1";
   3   namespace "http://frrouting.org/yang/routing";
   4   prefix "rt";
   5
   6   import ietf-yang-types {
   7     prefix "yang";
   8   }
   9
  10   import frr-vrf {
  11     prefix frr-vrf;
  12   }
  13
  14   organization
  15     "FRRouting";
  16
  17   contact
  18     "FRR Users List:       <mailto:frog@lists.frrouting.org>
  19      FRR Development List: <mailto:dev@lists.frrouting.org>";
  20
  21   description
  22     "This YANG module defines essential components for the management
  23      of a routing subsystem.
  24
  25      Copyright 2020 FRRouting
  26
  27      Redistribution and use in source and binary forms, with or without
  28      modification, are permitted provided that the following conditions
  29      are met:
  30
  31      1. Redistributions of source code must retain the above copyright notice,
  32      this list of conditions and the following disclaimer.
  33
  34      2. Redistributions in binary form must reproduce the above copyright
  35      notice, this list of conditions and the following disclaimer in the
  36      documentation and/or other materials provided with the distribution.
  37
  38      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  39      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  40      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  41      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  42      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  44      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  45      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  46      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  47      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  48      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  49
  50   revision 2019-08-15 {
  51     description
  52       "Initial revision.";
  53   }
  54
  55   /* Identities */
  56
  57   identity address-family {
  58     description
  59       "Base identity from which identities describing address
  60        families are derived.";
  61   }
  62
  63   identity ipv4 {
  64     base address-family;
  65     description
  66       "This identity represents an IPv4 address family.";
  67   }
  68
  69   identity ipv6 {
  70     base address-family;
  71     description
  72       "This identity represents an IPv6 address family.";
  73   }
  74
  75   identity control-plane-protocol {
  76     description
  77       "Base identity from which control-plane protocol identities are
  78        derived.";
  79   }
  80
  81   identity routing-protocol {
  82     base control-plane-protocol;
  83     description
  84       "Identity from which Layer 3 routing protocol identities are
  85        derived.";
  86   }
  87
  88   /* Type Definitions */
  89
  90   typedef administrative-distance {
  91     type uint8 {
  92       range "1..255";
  93     }
  94     description
  95       "Admin distance associated with the route.";
  96   }
  97
  98   /* Groupings */
  99
 100   grouping address-family {
 101     description
 102       "This grouping provides a leaf identifying an address
 103        family.";
 104     leaf address-family {
 105       type identityref {
 106         base address-family;
 107       }
 108       mandatory true;
 109       description
 110         "Address family.";
 111     }
 112   }
 113
 114   grouping router-id {
 115     description
 116       "This grouping provides a router ID.";
 117     leaf router-id {
 118       type yang:dotted-quad;
 119       description
 120         "A 32-bit number in the form of a dotted quad that is used by
 121          some routing protocols identifying a router.";
 122       reference
 123         "RFC 2328: OSPF Version 2";
 124     }
 125   }
 126
 127   /* Data nodes */
 128
 129   container routing {
 130     description
 131       "Configuration parameters for the routing subsystem.";
 132     container control-plane-protocols {
 133       description
 134         "Support for control-plane protocol instances.";
 135       list control-plane-protocol {
 136         key "type name vrf";
 137         description
 138           "Each entry contains a control-plane protocol instance.";
 139         leaf type {
 140           type identityref {
 141             base control-plane-protocol;
 142           }
 143           description
 144             "Type of the control-plane protocol";
 145         }
 146         leaf name {
 147           type string;
 148           description
 149             "An arbitrary name of the control-plane protocol
 150              instance.";
 151         }
 152         leaf vrf {
 153           type string;
 154           description
 155             "vrf for control-plane protocol";
 156         }
 157       }
 158     }
 159   }
 160 }