connection
routing/bgp/connection
Conditions: !smips
Type: Directory
A list of all connection-specific parameters can be seen in the table below.
In addition to connection-specific parameters, template-specific parameters are also directly exposed in this menu, for easier configuration in simple scenarios (when templates are not necessary).
| Flag | Name | Description |
|---|---|---|
| D | dynamic | dynamic |
| X | disabled | disabled |
| I | inactive | inactive |
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| instance ( mandatory ) | enum | |
| remote.address ( unset ) | address (flags=46i/+:) | Remote address used to connect and/or listen to. |
| remote.port ( unset ) | num | |
| remote.as ( unset ) | super { as: as , [sub-as] [ /as] } | Remote AS number. If not specified BGP will determine remote AS automatically from the OPEN message. |
| remote.ttl | num | Acceptable minimum Time To Live, the hop limit for this TCP connection. For example, if 'ttl=255' then only single-hop neighbors will be able to establish the connection. This property only affects EBGP peers. |
| remote.allowed-as ( unset ) | enum | Name of the num-list containing remote AS numbers that will be allowed to connect. Useful for dynamic peer configuration. |
| local.address ( unset ) | address (flags=46i:) | |
| local.port ( unset ) | num | |
| local.ttl | num | Time To Live (hop limit) that will be recorded in sent TCP packets. |
| local.role ( mandatory ) | enum (ibgp | ibgp-rr | ebgp | ebgp-provider | ebgp-rs | ebgp-rs-client | ebgp-customer | ebgp-peer) | BGP role. In most scenarios, set to iBGP or eBGP. For more information on BGP roles, see the corresponding RFC 9234. |
| tcp-md5-key ( unset ) | string | Key used to authenticate the connection with TCP MD5 signature as described in RFC 2385. Leave empty to disable authentication. |
| connect | bool | Whether to allow the router to initiate the connection. |
| listen | bool | Enable listening for incoming connections. If remote.address is a host address and listening is enabled, close the listening socket after the first successful accept. If remote.address is a subnet and listening is enabled, the listening socket remains open after the first successful accept with a hard-coded limit of 256 open connections. |
| routing-table ( unset ) | enum | Name of the routing table, to install routes in. Overrides the instance parameter. |
| vrf ( unset ) | enum | Name of the VRF BGP connections operate on. By default uses the "main" routing table. |
| templates ( unset ) | multi { template: enum } | List of template names that will be used to inherit parameter values from. Useful feature, to easily configure groups with overlapping configuration options. |
| as ( unset ) | as | A 32-bit BGP autonomous system number. The value accepts AS-Plain or AS-Dot formats. Override the instance ASN and configure BGP confederation using the following format: confederation_as/as. For example, if your AS is 34 and your confederation AS is 43, set as=43/34. |
| nexthop-choice ( unset ) | enum (default | force-self | propagate) | Affect outgoing NEXT_HOP attribute selection. Next-hops set in filters always take precedence and are not changed on route reflection except when set in a filter.
|
| multihop ( unset ) | bool | Enable when the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for eBGP only, excluding iBGP peers local to the confederation). It also affects:
|
| hold-time ( unset ) | alt { special: enum (infinity) { infinity:0 } , number: time [3 .. 65535] } | Specifies the BGP Hold Time value to be used when negotiating with peers. According to the BGP specification, if the 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 used (note that the special value 0 or 'infinity' is lower than any other value)* infinity - never expire the connection and never send keepalive messages. |
| keepalive-time ( unset ) | time | The interval between keepalive messages, if not set then by default keepalive is 1/3 of the hold-time. |
| afi ( unset ) | ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn) | List of address families this peer can exchange routing information. The remote peer must support BGP capabilities optional parameter (they usually do) to negotiate any other address families than IP. |
| cisco-vpls-nlri-len-fmt ( unset ) | enum (auto-bits | auto-bytes | bits | bytes) | VPLS NLRI length format type. Used for compatibility with Cisco VPLS. [[Read more>>]]. |
| output.remove-private-as ( unset ) | bool | If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path. |
| output.as-override ( unset ) | bool | If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepend. |
| use-bfd ( unset ) | bool | Whether to use the BFD protocol for faster connection state detection. |
| save-to ( unset ) | string | Filename to save BGP protocol-specific packet content (Exported PDU) into pcap format. This method allows much simpler peer-specific packet capturing for debugging purposes. |
| output.add-path ( unset ) | ubit (ip, ipv6) | Enable sending of additional paths for specified address families (BGP Addpath). |
| output.affinity ( unset ) | enum (main | alone | remote-as | instance | afi | vrf | input) | Configure output multicore processing. Read more in Routing Protocol Multi-core Support article.
|
| output.redistribute ( unset ) | ubit (connected, static, rip, ospf, isis, bgp, vpn, dhcp, fantasy, modem, bgp-mpls-vpn, slaac) | Enable redistribution of specified route types. |
| output.filter-select ( unset ) | enum | Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used. |
| output.filter-chain ( unset ) | enum | Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything. |
| output.network ( unset ) | enum | Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table and its ORIGIN attribute is set to IGP, other distribution methods have ORIGIN attribute set to INCOMPLETE. |
| output.network-blackhole ( unset ) | bool | |
| output.default-originate ( unset ) | enum (never | if-installed | always) | Specifies default route (0.0.0.0/0) distribution method. 'if-installed' option can be used to distribute default route only if corresponding IGP route present in the routing table. |
| output.default-prepend ( unset ) | num | How many times to prepend local ASN. |
| output.no-client-to-client-reflection ( unset ) | bool | Disable client-to-client route reflection in Route Reflector setups. |
| output.no-early-cut ( unset ) | bool | The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then this option should be used to disable the early cut feature. Early cut works with eBGP sessions. |
| output.keep-sent-attributes ( unset ) | bool | Store in memory sent prefix attributes, required for dump-saved-advertisements command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes. |
| input.add-path ( unset ) | ubit (ip, ipv6) | Accept received additional paths (BGP Addpath) for specified address families. |
| input.attr-error-handling | enum (default | revised) | |
| input.affinity ( unset ) | enum (main | alone | remote-as | instance | afi | vrf) | Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article.
|
| input.filter ( unset ) | enum | Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything. |
| input.filter-nlri ( unset ) | enum | Name of the filter chain that will filter incoming IPv4/IPv6 NLRIs directly before they are stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart. |
| input.allow-as ( unset ) | num | Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix. |
| input.accept-nlri ( unset ) | enum | Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart. |
| input.filter-communities ( unset ) | enum | A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.filter-ext-communities ( unset ) | enum | A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.filter-large-communities ( unset ) | enum | A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.accept-communities ( unset ) | enum | A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.accept-ext-communities ( unset ) | enum | A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.accept-large-communities ( unset ) | enum | A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.filter-unknown ( unset ) | enum | A quick way to filter incoming updates with specific "unknown" attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh. |
| input.limit-process-routes-ipv4 ( unset ) | enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000) { 10:10, 100:100, 1000:1000, 10000:10000, 100000:100000, 1000000:1000000, 10000000:10000000 } | Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached. |
| input.limit-process-routes-ipv6 ( unset ) | enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000) { 10:10, 100:100, 1000:1000, 10000:10000, 100000:100000, 1000000:1000000, 10000000:10000000 } | Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached. |
| Read-only Argument | Type | Description |
|---|---|---|
| local.default-address | address (flags=46i:) |