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