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 plist-ref {
  45     type string;
  46   }
  47
  48   typedef access-list-ref {
  49     type string;
  50   }
  51
  52   typedef as-path-filter-ref {
  53     type string;
  54   }
  55
  56   typedef bgp-instance-type {
  57     type enumeration {
  58       enum "default" {
  59         value 1;
  60         description
  61           "BGP instance default.";
  62       }
  63       enum "vrf" {
  64         value 2;
  65         description
  66           "BGP instance vrf.";
  67       }
  68       enum "view" {
  69         value 3;
  70         description
  71           "BGP instance view.";
  72       }
  73     }
  74   }
  75
  76   typedef as-type {
  77     type enumeration {
  78       enum "as-specified" {
  79         value 1;
  80         description
  81           "AS has explicitly specified value.";
  82       }
  83       enum "internal" {
  84         value 2;
  85         description
  86           "Internal BGP peer.";
  87       }
  88       enum "external" {
  89         value 3;
  90         description
  91           "External BGP peer.";
  92       }
  93     }
  94   }
  95
  96   typedef add-path-type {
  97     type enumeration {
  98       enum "all" {
  99         value 1;
 100         description
 101           "To advertise all paths to a neighbor.";
 102       }
 103       enum "per-as" {
 104         value 2;
 105         description
 106           "To advertise the best path per each neighboring AS.";
 107       }
 108       enum "none" {
 109         value 3;
 110         description
 111           "Add path feature is disabled.";
 112       }
 113     }
 114   }
 115
 116   typedef bfd-session-type {
 117     type enumeration {
 118       enum "single-hop" {
 119         value 1;
 120         description
 121           "Single hop session.";
 122       }
 123       enum "multi-hop" {
 124         value 2;
 125         description
 126           "Multiple hop session.";
 127       }
 128       enum "not-configured" {
 129         value 3;
 130         description
 131           "Not Configured.";
 132       }
 133     }
 134   }
 135
 136   typedef direction {
 137     type enumeration {
 138       enum "in" {
 139         value 1;
 140         description
 141           "IN, ingress, Rx.";
 142       }
 143       enum "out" {
 144         value 2;
 145         description
 146           "OUT, egress, Tx.";
 147       }
 148     }
 149   }
 150 }