bgpd.conf.5

同时支持IPv4和IPv6的BGP协议实现

.\"	$KAME: bgpd.conf.5,v 1.8 2000/11/10 12:12:09 itojun Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
.\" 
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the project nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd May 17, 1998
.Dt BGPD.CONF 5
.Os KAME
.\"
.Sh NAME
.Nm bgpd.conf
.Nd bgpd configuration file
.\"
.Sh SYNOPSIS
.Pa /usr/local/v6/etc/bgpd.conf
.\"
.Sh DESCRIPTION
The bgpd config file consists of a sequence of statements terminated
by a semi-colon (`;').
Statements are composed of tokens
separated by white space, which can be any combination of blanks, tabs
and newlines.
This structure simplifies identification of
the parts of the configuration associated with each other and with
specific protocols.
Lines beginning with
.Ql #
are comments.
.\"
.Sh Meta Syntax
Keywords and special characters that the parser expects exactly are
displayed using the
.Ic bold
font.
Parameters are specifying with
.Ar underline .
Parameters shown in
square brackets (`[' and `]') are used to show optional
keywords and parameters.
The vertical bar (`|') is used to indicate
between a choice of optional parameters.
Parentheses (`(' and
`)') are used to group keywords and parameters when necessary.
.\"
.Sh Interface specification
There are some statements that may or have to specify interface.
Interfaces are specified in the form of "name unit", such as
.Ar lo0
and
.Ar ep1.
.\"
.Sh Specifying Log Level
.Bl -tag -width Ds -compact
.It Xo
.Ic log
.Ar option...
.Ic ;
.Xc
Specify debug messages to be printed out.
Each
.Ar option
usually specifies a subset of the messages to be printed.
If an
.Ar option
begins with
.Ic no ,
it means that the set of the messages that are specified by the option
will not be printed.
For example,
.Ic `all norip'
means that all the messages except RIPng related ones will be printed.
Valid options are
.Ic aspath, bgpstate, bgpconnect, bgpinput, bgpoutput, bgproute, bgp,
.Ic interface, inet6, rip, route, filter, timer,
and
.Ic all .
The
.Ic bgp
option means all the BGP related options to be printed.
.El
.\"
.Sh Specifying Dump File
.Bl -tag -width Ds -compact
.It Xo
.Ic dumpfile Ar filename Ic ;
.Xc
Specifies the name of the dump file
(see
.Xr bgpd 8 ) .
.El
.\"
.Sh Specifying Filters
The following four route filters can be specified, each of which
is for a RIPng interface or a BGP peer (see below).
.Bl -tag -width Ds -compact
.It Ic filterin Ar prefix Ic ;
Specifies incoming route filtering.
If an incoming route on the
interface or from the peer matches the specified prefix,
it will be ignored and will not be installed in the kernel.
.Pp
The prefixes are specified in the form of
.Ql address/prefix_length,
such as
.Ar 3ffe:509::/32
and
.Ar 3ffe:501:100f::/48.
The special string 
.Ar default
can also be specified as a prefix, which means the default route.
Note that the semantics of
.Ar default
is different from the semantics of
.Ar ::/0 .
The former is to specify filtering the default route (exact match),
but the latter is to specify filtering all routes that match
.Ar ::/0 ,
that is, filtering all incoming routes.
.\"
.It Ic restrictin Ar prefix Ic ;
Specifies incoming route restriction.
An incoming route on the interface or from the peer
will be ignored unless it matches
.Ar prefix .
If this attribute is specified for more than one prefix,
an incoming route will be required to match at least one prefix of them.
Like the
.Ic filterin
attribute, the special string
.Ar default
can be specified as a prefix, which means that all non default routes
will be ignored on the interface or from the peer.
.\"
.It Ic filterout Ar prefix Ic ;
Specifies outgoing route filtering.
If an outgoing route on the
interface or to the peer matches the specified prefix,
it will not be advertised.
The special string
.Ar default
can also be specified for this attribute, which means that the default route
will not be advertised on the interface nor to the peer.
Note that the semantics of
.Ic filterout Ar ::/0
is different from the semantics of
.Ic filterout Ar default .
The former means that all routes that match the prefix
.Ar ::/0
will not be advertised on the interface.
For a RIPng interface, it thus has the same meaning
of the
.Ic noripout .
attribute.
.\"
.It Ic restrictout Ar prefix Ic ;
Specifies outgoing route restriction.
An outgoing route on the interface or to the peer will not be
advertised unless it matches
.Ar prefix .
If this attribute is specified for more than one prefix,
an outgoing route will be required to match at least one prefix of
them.
If the special string
.Ar default
is specified as a prefix, it means that only the default route will be
advertised on the interface nor to the peer.
.El
.\"
.Sh The BGP Related Statements
.Bl -tag -width Ds -compact
.It Xo
.Ic autonomoussystem Ar as_number Ic ;
.Xc
Sets the autonomous system number of this router to be autonomous
system.
This statement is required if BGP is in use.
The AS number is assigned by the Network Information Center (NIC).
.\"
.It Ic bgpsbsize Ar size Ic ;
Sets the size of socket write buffer for each BGP socket.
.\"
.It Ic routerid Ar router_id Ic ;
Sets the router identifier for use by the BGP and OSPF protocols.
The default is the address of the first interface encountered by
.Nm bgpd
except the loopback address(127.0.0.1).
.\"
.It Ic clusterid Ar cluster_id Ic ;
Sets the cluster identifier for use as a BGP route reflector.
The default is the address of the first interface encountered by
.Nm bgpd
except the loopback address(127.0.0.1).
.\"
.It Ic IamRouteReflector ;
Specifies to act as a route reflector.
.\"
.It Ic holdtime Ar seconds Ic ;
Specifies the BGP holdtime value to use when negotiating the
connection with this peer, in seconds.
According to BGP, if bgpd does not receive a keepalive, update, or notification message
within the period specified in the Hold Time field of
the BGP Open message, then the BGP connection will be closed.
The value must be either 0 (no keepalives will be sent)
or at least 3.
The default value is 240 according to the RFC 1771.
.\"
.It Xo
.Ic bgp (yes \(ba no) { Ar substatements
.Ic };
.Xc
Enables or disables BGP.
By default BGP is disabled.
The following two substatements can be appeared in the
.Ic bgp
statement.
.\"
.It Ic group type external peeras Ar remote_as_number {
.Bl -tag -width Ds -compact
.It Xo
.Ic peer Ar host
.Op Ic interface Ar interface
.Op Ic preference Ar preference
.Op Ic prepend Op Ar iteration
.Op Ic no synchronization
.Op Ic lcladdr Ar localaddress
.Op Ar filters...
.Ic ;
.Ic };
.Xc
.El
.Pp
Specifies the IPv6 address and AS number of an individual EBGP peer.
The interface on which the peer exists may also be specified.
Interface
specification may be necessary when the peer address is a link-local
address.
If the optional keyword
.Ic preference
is specified followed by a number, bgpd uses the value as the value of
local preference when advertising reachable routes from the peer via
IBGP.
Currently, the value can only be specified per peer base.
If the optional keyword
.Ic prepend
is specified, bgpd adds its AS number to the as path when advertising
reachable routes to other EBGP peers.
This keywords takes an optional argument, which specifies number of iteration
of the addition.
If the argument is omitted, bgpd treats it as 1.
Note that
.Ic prepend 1
makes each advertised AS path longer than usual.
Typically, this keywords does not have to be set.
If the optional keyword
.Ic no synchronization
is specified, bgpd will export each EBGP route to the peer without waiting
for synchronization with RIPng for the route.
The optional keyword
.Ic lcladdr
specifies the local(source) IPv6 address to connect the peer.
If the node has multiple IPv6 addresses that can be used as the source address,
the keyword should be specified.
If a list of
.Ar filters
is specified, each of the
.Ar filters
is applied to the peer according to the semantics of each filter
described above.
.\"
.It Xo
.Ic group type internal
.Op Ic routerid Ar router_id
.Ic { Ar substatements
.Ic };
.Xc
Specifies a set of IBGP peers.
The BGP identifier of the peer can be specified with the keyword