yang/frr-bgp-types.yang

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