doc/manpages/bgpd.rst

   1 ****
   2 BGPD
   3 ****
   4
   5 .. include:: defines.rst
   6 .. |DAEMON| replace:: bgpd
   7
   8 SYNOPSIS
   9 ========
  10 |DAEMON| |synopsis-options-hv|
  11
  12 |DAEMON| |synopsis-options|
  13
  14 DESCRIPTION
  15 ===========
  16 |DAEMON| is a routing component that works with the FRRouting routing engine.
  17
  18 OPTIONS
  19 =======
  20 OPTIONS available for the |DAEMON| command:
  21
  22 .. include:: common-options.rst
  23
  24 .. option:: -p, --bgp_port <port>
  25
  26    Set the bgp protocol's port number. When port number is 0, that means do not
  27    listen bgp port.
  28
  29 .. option:: -l, --listenon
  30
  31    Specify a specific IP address for bgpd to listen on, rather than its default
  32    of ``0.0.0.0`` / ``::``. This can be useful to constrain bgpd to an internal
  33    address, or to run multiple bgpd processes on one host.
  34
  35 .. option:: -n, --no_kernel
  36
  37    Do not install learned routes into the linux kernel.  This option is useful
  38    for a route-reflector environment or if you are running multiple bgp
  39    processes in the same namespace.  This option is different than the --no_zebra
  40    option in that a ZAPI connection is made.
  41
  42 .. option:: -e, --ecmp
  43
  44    Run BGP with a limited ecmp capability, that is different than what BGP
  45    was compiled with.  The value specified must be greater than 0 and less
  46    than or equal to the MULTIPATH_NUM specified on compilation.
  47
  48 .. option:: -Z, --no_zebra
  49
  50    Do not communicate with zebra at all.  This is different than the --no_kernel
  51    option in that we do not even open a ZAPI connection to the zebra process.
  52
  53 .. option:: -s, --socket_size
  54
  55    When opening tcp connections to our peers, set the socket send buffer
  56    size that the kernel will use for the peers socket.  This option
  57    is only really useful at a very large scale.  Experimentation should
  58    be done to see if this is helping or not at the scale you are running
  59    at.
  60
  61 LABEL MANAGER
  62 -------------
  63
  64 .. option:: -I, --int_num
  65
  66    Set zclient id. This is required when using Zebra label manager in proxy mode.
  67
  68 FILES
  69 =====
  70
  71 |INSTALL_PREFIX_SBIN|/|DAEMON|
  72    The default location of the |DAEMON| binary.
  73
  74 |INSTALL_PREFIX_ETC|/|DAEMON|.conf
  75    The default location of the |DAEMON| config file.
  76
  77 $(PWD)/|DAEMON|.log
  78    If the |DAEMON| process is configured to output logs to a file, then you
  79    will find this file in the directory where you started |DAEMON|.
  80
  81 .. include:: epilogue.rst
  82