<td> in case this instance is a route reflector: cluster ID of the router reflector cluster this instance belongs to. This attribute helps to recognize routing updates that comes from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; this case 'cluster-id' does not need to be configured and BGP router ID is used instead</td>
<td> if enabled, this BGP instance will redistribute the information about connected routes, i.e., routes to the networks that can be directly reached</td>
<td> if enabled, the router will redistribute the information about static routes added to its routing database, i.e., routes that have been created using the '/ip route add' command on the router</td>
<td> Name of routing table this BGP instance operates on.
Non-default routing-table and list of VRFs cannot be configured for the same instance at the same time. Available starting from v4.3</td>
</tr>
</table>
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
{{Mr-arg-table
|arg=as
|type=integer [0..4294967295]
|default=
|desc=32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats.
}}
{{Mr-arg-table
|arg=client-to-client-reflection
|type=yes {{!}} no
|default=yes
|desc=In case this instance is a route reflector: whether to redistribute routes learned from one routing reflection client to other clients.
}}
{{Mr-arg-table
|arg=cluster-id
|type=IP address
|default=
|desc=In case this instance is a route reflector: cluster ID of the router reflector cluster this instance belongs to. This attribute helps to recognize routing updates that comes from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; this case 'cluster-id' does not need to be configured and BGP router ID is used instead
}}
{{Mr-arg-table
|arg=comment
|type=string
|default=
|desc=Short description of the instance.
}}
{{Mr-arg-table
|arg=confederation
|type=integer [0..4294967295]
|default=
|desc=In case of BGP confederations: autonomous system number that identifies the [local] confederation as a whole.
}}
{{Mr-arg-table
|arg=confederation-peers
|type=list/range of integer[0..4294967295]
|default=
|desc=In case of BGP confederations: list of AS numbers internal to the [local] confederation. Range of as numbers are also supported. For example 10,20,30-50.
}}
{{Mr-arg-table
|arg=disabled
|type=yes {{!}} no
|default=no
|desc=Whether instance is disabled.
}}
{{Mr-arg-table
|arg=ignore-as-path-len
|type=yes {{!}} no
|default=no
|desc=Whether to ignore '''AS_PATH''' attribute in BGP route selection algorithm
}}
{{Mr-arg-table
|arg=name
|type=string
|default=
|desc=BGP instance name
}}
{{Mr-arg-table
|arg=out-filter
|type=string
|default=
|desc=Output [[M:Routing/Routing_filters | routing filter]] chain used by all BGP peers belonging to this instance. Due to known problems in ROS v6, it is not recommended to use instance out-filter, instead use out-filter on peer.
}}
{{Mr-arg-table
|arg=redistribute-connected
|type=yes {{!}} no
|default=no
|desc=If enabled, this BGP instance will redistribute the information about connected routes, i.e., routes to the networks that can be directly reached.
}}
{{Mr-arg-table
|arg=redistribute-ospf
|type=yes {{!}} no
|default=no
|desc=If enabled, this BGP instance will redistribute the information about routes learned by OSPF
}}
{{Mr-arg-table
|arg=redistribute-other-bgp
|type=yes {{!}} no
|default=no
|desc=If enabled, this BGP instance will redistribute the information about routes learned by other BGP instances
}}
{{Mr-arg-table
|arg=redistribute-rip
|type=yes {{!}} no
|default=no
|desc=If enabled, this BGP instance will redistribute the information about routes learned by RIP
}}
{{Mr-arg-table
|arg=redistribute-static
|type=yes {{!}} no
|default=no
|desc=If enabled, the router will redistribute the information about static routes added to its routing database, i.e., routes that have been created using the '/ip route add' command on the router
}}
{{Mr-arg-table
|arg=router-id
|type=IP
|default=0.0.0.0
|desc=BGP Router ID (for this instance). If set to 0.0.0.0, BGP will use one of router's IP addresses.
}}
{{Mr-arg-table-end
|arg=routing-table
|type=string
|default=
|desc=Name of routing table this BGP instance operates on.
Non-default routing-table and list of VRFs cannot be configured for the same instance at the same time.
Available starting from v4.3
}}
Line 101:
Line 162:
Instance related VRF configuration
Instance related VRF configuration
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
{{Mr-arg-table
|arg=comment
|type=string
|default=
|desc=Short description of the VRF.
}}
{{Mr-arg-table
|arg=disabled
|type=yes {{!}} no
|default=no
|desc=
}}
{{Mr-arg-table
|arg=in-filter
|type=string
|default=
|desc=Name of the routing filter chain that is applied to the incoming routing information
}}
{{Mr-arg-table
|arg=instance
|type=string
|default=
|desc=Name of the instance this configuration applies to.
}}
{{Mr-arg-table
|arg=out-filter
|type=string
|default=
|desc=Name of the routing filter chain that is applied to the outgoing routing information
}}
{{Mr-arg-table
|arg=redistribute-connected
|type=yes {{!}} no
|default=no
|desc=Redistribute connected routes that belongs to VRF.
}}
{{Mr-arg-table
|arg=redistribute-ospf
|type=yes {{!}} no
|default=no
|desc=Redistribute OSPF routes that belongs to VRF.
}}
{{Mr-arg-table
|arg=redistribute-other-bgp
|type=yes {{!}} no
|default=no
|desc=Redistribute BGP routes that belongs to VRF received from other BGP instance.
}}
{{Mr-arg-table
|arg=redistribute-rip
|type=yes {{!}} no
|default=no
|desc=Redistribute RIP routes that belongs to VRF.
}}
{{Mr-arg-table
|arg=redistribute-static
|type=yes {{!}} no
|default=no
|desc=Redistribute static routes that belongs to VRF.
}}
{{Mr-arg-table-end
|arg=routing-mark
|type=string
|default=
|desc=Name of the routing-mark used by VRF configured in ''/ip route vrf'''menu.
}}
==Peer==
==Peer==
Line 120:
Line 264:
{{Mr-arg-table
{{Mr-arg-table
|arg=allowas-in
|arg=allow-as-in
|type=string
|type=integer [0..10]
|default=
|default=
|desc=
|desc=How many times to allow own AS number in AS-PATH, before discarding a prefix.
}}
}}
Line 286:
Line 430:
|desc=If set, then BGP AS-PATH attribute is removed before sending out route update if attribute contains only private AS numbers.
|desc=If set, then BGP AS-PATH attribute is removed before sending out route update if attribute contains only private AS numbers.
removal process happens before routing filters are applied and before local AS
removal process happens before routing filters are applied and before local AS
number is prepended to the AS path. Option is available starting from v4.3.
number is prepended to the AS path. Option is available starting from v4.3. Currently works only with 16-bit ASNs.
}}
}}
Line 307:
Line 451:
|type=integer [1..255] {{!}} default
|type=integer [1..255] {{!}} default
|default=default
|default=default
|desc=Time To Leave, the hop limit for TCP connection. For example, if 'ttl=1' then only single
|desc=Time To Live, the hop limit for TCP connection. For example, if 'ttl=1' then only single
hop neighbors will be able to establish the connection. This property only affects EBGP peers.
hop neighbors will be able to establish the connection. This property only affects EBGP peers.
* <var>default</var> - system's default TTL value is used
* <var>default</var> - system's default TTL value is used
Read only information about outgoing routing information currently advertised.
Read only information about outgoing routing information currently advertised.
</p>
<p>
This information is calculated dynamically after 'print' command is issued. As a result, it may not correspond to the information that at the exact moment has been sent out. Especially if in case of slow connection, routing information prepared for output will spend long time in buffers. 'advertisements print' will show as things should be, not as they are!
This information is calculated dynamically after 'print' command is issued. As a result, it may not correspond to the information that at the exact moment has been sent out. Especially if in case of slow connection, routing information prepared for output will spend long time in buffers. 'advertisements print' will show as things should be, not as they are!
</p>
{{ Note | At the moment AS-PATH attribute for advertised routes is shown without prepends. }}
{{ Note | At the moment AS-PATH attribute for advertised routes is shown without prepends. }}
The Border Gateway Protocol (BGP) allows setting up an interdomain dynamic routing system that automatically updates routing tables of devices running BGP in case of network topology changes.
MikroTik RouterOS supports BGP Version 4, as defined in RFC 4271
Standards and Technologies:
RFC 4271 Border Gateway Protocol 4
RFC 4456 BGP Route Reflection
RFC 5065 Autonomous System Confederations for BGP
RFC 1997 BGP Communities Attribute
RFC 2385 TCP MD5 Authentication for BGPv4
RFC 5492 Capabilities Advertisement with BGP-4
RFC 2918 Route Refresh Capability
RFC 4760 Multiprotocol Extensions for BGP-4
RFC 2545 Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing
RFC 4893 BGP Support for Four-octet AS Number Space
Instance
Sub-menu:/routing bgp instance
Property
Description
as (integer [0..4294967295]; Default: )
32-bit BGP autonomous system number. Value can be entered in AS-Plain and AS-Dot formats.
In case this instance is a route reflector: whether to redistribute routes learned from one routing reflection client to other clients.
cluster-id (IP address; Default: )
In case this instance is a route reflector: cluster ID of the router reflector cluster this instance belongs to. This attribute helps to recognize routing updates that comes from another route reflector in this cluster and avoid routing information looping. Note that normally there is only one route reflector in a cluster; this case 'cluster-id' does not need to be configured and BGP router ID is used instead
In case of BGP confederations: autonomous system number that identifies the [local] confederation as a whole.
confederation-peers (list/range of integer[0..4294967295]; Default: )
In case of BGP confederations: list of AS numbers internal to the [local] confederation. Range of as numbers are also supported. For example 10,20,30-50.
disabled (yes | no; Default: no)
Whether instance is disabled.
ignore-as-path-len (yes | no; Default: no)
Whether to ignore AS_PATH attribute in BGP route selection algorithm
name (string; Default: )
BGP instance name
out-filter (string; Default: )
Output routing filter chain used by all BGP peers belonging to this instance. Due to known problems in ROS v6, it is not recommended to use instance out-filter, instead use out-filter on peer.
redistribute-connected (yes | no; Default: no)
If enabled, this BGP instance will redistribute the information about connected routes, i.e., routes to the networks that can be directly reached.
redistribute-ospf (yes | no; Default: no)
If enabled, this BGP instance will redistribute the information about routes learned by OSPF
redistribute-other-bgp (yes | no; Default: no)
If enabled, this BGP instance will redistribute the information about routes learned by other BGP instances
redistribute-rip (yes | no; Default: no)
If enabled, this BGP instance will redistribute the information about routes learned by RIP
redistribute-static (yes | no; Default: no)
If enabled, the router will redistribute the information about static routes added to its routing database, i.e., routes that have been created using the '/ip route add' command on the router
router-id (IP; Default: 0.0.0.0)
BGP Router ID (for this instance). If set to 0.0.0.0, BGP will use one of router's IP addresses.
routing-table (string; Default: )
Name of routing table this BGP instance operates on.
Non-default routing-table and list of VRFs cannot be configured for the same instance at the same time.
Available starting from v4.3
VRF
Sub-menu:/routing bgp instance vrf
Instance related VRF configuration
Property
Description
comment (string; Default: )
Short description of the VRF.
disabled (yes | no; Default: no)
in-filter (string; Default: )
Name of the routing filter chain that is applied to the incoming routing information
instance (string; Default: )
Name of the instance this configuration applies to.
out-filter (string; Default: )
Name of the routing filter chain that is applied to the outgoing routing information
redistribute-connected (yes | no; Default: no)
Redistribute connected routes that belongs to VRF.
redistribute-ospf (yes | no; Default: no)
Redistribute OSPF routes that belongs to VRF.
redistribute-other-bgp (yes | no; Default: no)
Redistribute BGP routes that belongs to VRF received from other BGP instance.
redistribute-rip (yes | no; Default: no)
Redistribute RIP routes that belongs to VRF.
redistribute-static (yes | no; Default: no)
Redistribute static routes that belongs to VRF.
routing-mark (string; Default: )
Name of the routing-mark used by VRF configured in /ip route vrf'menu.
List of address families about which this peer will exchange routing information. The remote peer must support (they usually do) BGP capabilities optional parameter to negotiate any other families than IP.
allow-as-in (integer [0..10]; Default: )
How many times to allow own AS number in AS-PATH, before discarding a prefix.
as-override (yes | no; Default: no)
If set, then all instances of remote peer's AS number in BGP AS PATH attribute are replaced with local AS number before sending route update to that peer. Happens before routing filters and prepending.
Specifies the BGP Hold Time value to use when negotiating with peers.
According to the BGP specification, if router does not receive successive KEEPALIVE and/or UPDATE
and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message,
then the BGP connection to the peer will be closed.
The minimal hold-time value of both peers will be actually used (note that the special value 0 or 'infinity' is lower than any other values)
infinity - never expire the connection and never send keepalive messages.
in-filter (string; Default: )
Name of the routing filter chain that is applied to the incoming routing information
Affects the outgoing NEXT_HOP attribute selection. Note that nexthops set in filters always takes precedence. Also note that nexthop is not changed on route reflection, expect when it's set in filter.
default - select the nexthop as described in RFC 4271
force-self - always use a local address of the interface that used to connect to the peer as the nexthop;
propagate - try to propagate further the nexthop received; i.e. if the route has BGP NEXT_HOP attribute, then use it as the nexthop, otherwise fall back to the default case
out-filter (string; Default: )
Name of the routing filter chain that is applied to the outgoing routing information.
If instance has also configured out-filter, then instance filters are applied firs and only then peer's filters.
passive (yes | no; Default: no)
If set to yes, then connection attempts to remote peer are not made.
The remote peer must initialize connection in this case.
Available starting from v4.3
remote-address (IP/IPv6 address; Default: )
Address of the remote peer. If remote address is IPv6 link-local address then interface must be specified after '%', for example, fe80::21a:4dff:fe5d:8e56%ether1
remote-as (integer [0..4294967295]; Default: )
32-bit AS number of the remote peer. AS number can be specified in AS-Plain and AS-Dot formats.
remote-port (integer [0..65535]; Default: )
Remote peers port to establish tcp session. If not set, then default 179 port will be used.
remove-private-as (yes | no; Default: no)
If set, then BGP AS-PATH attribute is removed before sending out route update if attribute contains only private AS numbers.
removal process happens before routing filters are applied and before local AS
number is prepended to the AS path. Option is available starting from v4.3. Currently works only with 16-bit ASNs.
If address is specified, this address is used as the source address of the outgoing TCP connection.
If interface name is specified, an address belonging to the interface is used as described.
This property is ignored, if the value specified is not a valid address of the router or name an interface with active addresses. Do not specify name of interface that is added as a bridge port here!
use-bfd (yes | no; Default: no)
Whether to use BFD protocol for fast state detection.
Read only status properties:
Property
Description
as4-capability (yes | no)
Shows whether peer has 4-byte AS support
established (yes | no)
Set to yes if BGP peering is established.
local-address (IP | IPv6)
Address that is used as source address of BGP packets.
prefix-count (integer)
Number of routing prefixes received from this peer currently in routing table.
refresh-capability (yes | no)
Whether route refresh is supported by the peer
remote-hold-time (time)
Hold time set on remote peer.
remote-id (IP)
Remote peer's instance ID.
state (idle | connect | active | opensent | openconfirm | established)
BGP protocol state.
updates-received (integer)
Total number of reachable routing prefixes received
updates-sent (integer)
Total number of reachable routing prefixes sent
uptime (time)
Shows how long BGP has established state.
used-hold-time (time)
Negotiated and used hold time on both peers
used-keepalive-time (time)
Negotiated and used keepalive time on both peers (used-hold-time / 3)
withdraws-received (integer)
Total number of withdrawn routing prefixes received.
withdraws-sent (integer)
Total number of withdrawn routing prefixes advertised
Advertisements
Sub-menu:/routing bgp advertisements
Read only information about outgoing routing information currently advertised.
This information is calculated dynamically after 'print' command is issued. As a result, it may not correspond to the information that at the exact moment has been sent out. Especially if in case of slow connection, routing information prepared for output will spend long time in buffers. 'advertisements print' will show as things should be, not as they are!
Note: At the moment AS-PATH attribute for advertised routes is shown without prepends.
Property
Description
aggregator (IP)
Advertised AGGREGATOR attribute value
as-path (string)
Advertised AS_PATH attribute value
atomic-aggregate (yes | no)
Advertised ATOMIC_AGGREGATE attribute value
bgp-ext-communities ()
cluster-list (string)
Advertised CLUSTER_LIST attribute value
communities ()
local-pref (integer)
Advertised LOCAL_PREF attribute value
med (integer)
Advertised MULTI_EXIT_DISC attribute value
nexthop (IP | IPv6)
Advertised NEXT_HOP attribute value
origin (igp | egp | incomplete)
Advertised ORIGIN attribute value
originator-id (IP)
Advertised ORIGINATOR_ID attribute value
peer (string)
Name of the peer this information is advertised to
prefix (IPv4 | IPv6 prefix)
Advertised NLRI prefix
Network
Sub-menu:/routing bgp network
BGP network configuration. BGP Networks is a list of IP prefixes to be advertised.
Property
Description
network (IP prefix;)
the aggregate prefix
synchronize (yes | no; Default: yes)
install a route for this network only when there is an active IGP route matching this network
Aggregate
Sub-menu:/routing bgp aggregate
BGP allows the aggregation of specific routes into one route with. This menu ('/routing bgp aggregate') allows to specify which routes you want to aggregate, and what attributes to use for the route created by aggregation.
Property
Description
advertise-filter (string;)
name of the filter chain used to select the routes from which to inherit attributes
attribute-filter (string;)
name of the filter chain used to set the attributes of the aggregate route
include-igp (yes | no; Default: )
By default, BGP aggregate takes into account only BGP routes. Use this option to take IGP and connected routes into consideration.
inherit-attributes (yes | no; Default: yes)
whether to inherit BGP attributes from aggregated routes
instance (string;)
the instance this network belongs to
prefix (IP prefix;)
the aggregate prefix
summary-only (yes | no; Default: yes)
whether to suppress advertisements of all routes that fall within the range of this aggregate
suppress-filter (string;)
name of the filter chain used to select the routes to be suppressed
Read only status property:
routes-used (integer)
aggregated route statistics.
in console- list of route console IDs used;
in winbox- number of routes used.
Terminology
aggregated routes - all routes, that fall within the range of this aggregate; they possibly are suppressed;
aggregate route - route created by aggregation.
Note: Each aggregate will only affect routes coming from peers that belong to it's instance. suppress-filter is useful only if summary-only=no;
advertise-filter is useful only if inherit-attributes=yes.
If result attribute-filter match reject or discard, the aggregate route is not created.
Vpnv4 route
Sub-menu:/routing bgp vpnv4-route
Read only information about vpnv4 routing information currently advertised.
