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