yang/frr-bgp-neighbor.yang

   1 submodule frr-bgp-neighbor {
   2   yang-version 1.1;
   3
   4   belongs-to frr-bgp {
   5     prefix "bgp";
   6   }
   7
   8   include frr-bgp-common-structure;
   9   include frr-bgp-common-multiprotocol;
  10
  11   organization
  12     "FRRouting";
  13   contact
  14     "FRR Users List: <mailto:frog@lists.frrouting.org> FRR Development
  15      List: <mailto:dev@lists.frrouting.org>";
  16   description
  17     "This submodule contains general data definitions for use in BGP neighbor.
  18
  19      Copyright 2020 FRRouting
  20
  21      Redistribution and use in source and binary forms, with or without
  22      modification, are permitted provided that the following conditions
  23      are met:
  24
  25      1. Redistributions of source code must retain the above copyright notice,
  26      this list of conditions and the following disclaimer.
  27
  28      2. Redistributions in binary form must reproduce the above copyright
  29      notice, this list of conditions and the following disclaimer in the
  30      documentation and/or other materials provided with the distribution.
  31
  32      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33      \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  35      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36      HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  37      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  38      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  39      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  40      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  41      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  42      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  43
  44   revision 2019-12-03 {
  45     description
  46       "Initial revision.";
  47   }
  48
  49   grouping neighbor-parameters {
  50     leaf password {
  51       type string {
  52         length "1..254";
  53       }
  54       description
  55         "Actual password.";
  56     }
  57
  58     leaf ttl-security {
  59       type uint8;
  60       description
  61         "BGP Time To Live (TTL) security check.";
  62       reference
  63         "RFC 5082: The Generalized TTL Security Mechanism
  64          (GTSM),
  65          RFC 7454: BGP Operations and Security.";
  66     }
  67
  68     leaf solo {
  69       type boolean;
  70       default "false";
  71       description
  72         "Solo peer - part of its own update group.";
  73     }
  74
  75     leaf enforce-first-as {
  76       type boolean;
  77       default "false";
  78       description
  79         "When set to 'true' it will enforce the first AS for EBGP routes.";
  80     }
  81
  82     leaf description {
  83       type string;
  84       description
  85         "An optional textual description (intended primarily for use
  86          with a peer or group.";
  87     }
  88
  89     leaf passive-mode {
  90       type boolean;
  91       default "false";
  92       description
  93         "Don't send open messages to this neighbor.";
  94     }
  95
  96     uses structure-neighbor-group-capability-options;
  97
  98     uses neighbor-update-source;
  99
 100     uses neighbor-remote-as;
 101
 102     uses structure-neighbor-group-ebgp-multihop;
 103
 104     uses neighbor-local-as-options;
 105
 106     uses neighbor-bfd-options;
 107
 108     uses structure-neighbor-group-admin-shutdown;
 109
 110     uses structure-neighbor-group-graceful-restart;
 111
 112     uses structure-neighbor-config-timers;
 113
 114     container afi-safis {
 115       description
 116         "List of address-families associated with the BGP
 117          instance.";
 118       list afi-safi {
 119         key "afi-safi-name";
 120         description
 121           "AFI, SAFI configuration available for the
 122            neighbour or group.";
 123         uses mp-afi-safi-config;
 124
 125         leaf enabled {
 126           type boolean;
 127           default "false";
 128           description
 129             "This leaf indicates whether the IPv4 Unicast AFI, SAFI is
 130              enabled for the neighbour or group.";
 131         }
 132
 133         uses mp-all-afi-safi-list-contents;
 134       }
 135     }
 136   }
 137 }