yang/frr-bgp-types.yang

   1 module frr-bgp-types {
   2   yang-version 1.1;
   3   namespace "http://frrouting.org/yang/bgp-types";
   4   prefix frr-bt;
   5
   6   organization
   7     "FRRouting";
   8   contact
   9     "FRR Users List: <mailto:frog@lists.frrouting.org> FRR Development
  10      List: <mailto:dev@lists.frrouting.org>";
  11   description
  12     "This module contains general data definitions for use in BGP.
  13
  14      Copyright 2020 FRRouting
  15
  16      Redistribution and use in source and binary forms, with or without
  17      modification, are permitted provided that the following conditions
  18      are met:
  19
  20      1. Redistributions of source code must retain the above copyright notice,
  21      this list of conditions and the following disclaimer.
  22
  23      2. Redistributions in binary form must reproduce the above copyright
  24      notice, this list of conditions and the following disclaimer in the
  25      documentation and/or other materials provided with the distribution.
  26
  27      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  38
  39   revision 2019-12-03 {
  40     description
  41       "Initial revision.";
  42   }
  43
  44   typedef rmap-ref {
  45     type string;
  46   }
  47
  48   typedef plist-ref {
  49     type string;
  50   }
  51
  52   typedef access-list-ref {
  53     type string;
  54   }
  55
  56   typedef as-path-filter-ref {
  57     type string;
  58   }
  59
  60   typedef bgp-instance-type {
  61     type enumeration {
  62       enum "default" {
  63         value 1;
  64         description
  65           "BGP instance default.";
  66       }
  67       enum "vrf" {
  68         value 2;
  69         description
  70           "BGP instance vrf.";
  71       }
  72       enum "view" {
  73         value 3;
  74         description
  75           "BGP instance view.";
  76       }
  77     }
  78   }
  79
  80   typedef as-type {
  81     type enumeration {
  82       enum "as-specified" {
  83         value 1;
  84         description
  85           "AS has explicitly specified value.";
  86       }
  87       enum "internal" {
  88         value 2;
  89         description
  90           "Internal BGP peer.";
  91       }
  92       enum "external" {
  93         value 3;
  94         description
  95           "External BGP peer.";
  96       }
  97     }
  98   }
  99
 100   typedef add-path-type {
 101     type enumeration {
 102       enum "all" {
 103         value 1;
 104         description
 105           "To advertise all paths to a neighbor.";
 106       }
 107       enum "per-as" {
 108         value 2;
 109         description
 110           "To advertise the best path per each neighboring AS.";
 111       }
 112       enum "none" {
 113         value 3;
 114         description
 115           "Add path feature is disabled.";
 116       }
 117     }
 118   }
 119
 120   typedef bfd-session-type {
 121     type enumeration {
 122       enum "single-hop" {
 123         value 1;
 124         description
 125           "Single hop session.";
 126       }
 127       enum "multi-hop" {
 128         value 2;
 129         description
 130           "Multiple hop session.";
 131       }
 132       enum "not-configured" {
 133         value 3;
 134         description
 135           "Not Configured.";
 136       }
 137     }
 138   }
 139
 140   typedef direction {
 141     type enumeration {
 142       enum "in" {
 143         value 1;
 144         description
 145           "IN, ingress, Rx.";
 146       }
 147       enum "out" {
 148         value 2;
 149         description
 150           "OUT, egress, Tx.";
 151       }
 152     }
 153   }
 154 }