yang/frr-bgp-neighbor.yang

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