FRR BGP

STATE: unstable

API Docs: Plugins - Quagga

Service Docs: Dynamic Routing

FRR Docs: FRRouting (make sure you are looking at the current OPNSense package version!)

Sponsoring

Thanks to @telmich for sponsoring the development of these modules!

More FRR modules

Docs

Prerequisites

You need to install the FRR plugin:

os-frr

You can also install it using the package module.

Definition

For basic parameters see: Basics

ansibleguy.opnsense.frr_bgp_general

Parameter	Type	Required	Default value	Aliases	Comment
as_number	string	true	-	as, as_nr	BGP AS-Number
id	string	false	-	router_id	In some cases it might be clearer to set a fixed router-id. (4-byte field/IPv4 Address)
graceful	boolean	false	-	-	BGP graceful restart functionality as defined in RFC-4724 defines the mechanisms that allows BGP speaker to continue to forward data packets along known routes while the routing protocol information is being restored.
networks	list	false	-	nets	Select the network to advertise, you have to set a Null route via System -> Routes
redistribute	list	false	-	-	Select other routing sources, which should be redistributed to the other nodes. Choose from: ‘ospf’, ‘connected’, ‘kernel’, ‘rip’, ‘static’
reload	boolean	false	true	-	If the running config should be reloaded on change - this will take some time. You might want to reload it ‘manually’ after all changes are done => using the reload module.
enabled	boolean	false	true	-	En- or disable the service

ansibleguy.opnsense.frr_bgp_neighbor

Parameter	Type	Required	Default value	Aliases	Comment
match_fields	string	false	[‘ip’, ‘description’]	-	Fields that are used to match configured neighbor with the running config - if any of those fields are changed, the module will think it’s a new entry. At least one of: ‘ip’, ‘as_number’, ‘weight’, ‘local_ip’, ‘source_int’, ‘ipv6_link_local_int’, ‘disable_connected_check’, ‘description’, ‘prefix_list_in’, ‘prefix_list_out’, ‘route_map_in’, ‘route_map_out’
as_number	string	false for state changes, else true	-	as, as_nr, remote_as	BGP AS-Number of the neighbor
ip	string	false for state changes, else true	-	peer, peer_ip, address, neighbor	IP-address of the neighbor
password	string	false	-	pwd	Set a (MD5-hashed) password for BGP authentication
weight	integer	false	-	-	Specify a default weight value for the neighbor’s routes. Integer between 0 and 65535
local_ip	string	false	-	local	Set the local IP connecting to the neighbor. This is only required for BGP authentication.
source_int	string	false	-	src_int, update_src, update_source	Physical name of the IPv4 interface facing the peer. You must provide the network port as shown in ‘Interface - Assignments - Interface ID (in brackets)’
ipv6_link_local_int	string	false	-	v6_ll_int, ipv6_ll_int, link_local_int	Interface to use for IPv6 link-local neighbours. You must provide the network port as shown in ‘Interface - Assignments - Interface ID (in brackets)’
next_hop_self	boolean	false	false	nhs
next_hop_self_all	boolean	false	false	nhsa	Add the parameter “all” after next-hop-self command
multi_hop	boolean	false	false	-	Specifying ebgp-multihop allows sessions with eBGP neighbors to establish when they are multiple hops away. When the neighbor is not directly connected and this knob is not enabled, the session will not establish.
multi_protocol	boolean	false	false	-	Is this neighbour multiprotocol capable per RFC 2283
rrclient	boolean	false	false	route_reflector_client
bfd	boolean	false	false	-	Enable BFD support for this neighbor
send_default_route	boolean	false	false	default_originate
as_override	boolean	false	false	asoverride	Override AS number of the originating router with the local AS number. This command is only allowed for eBGP peers
disable_connected_check	boolean	false	false	asoverride	Allow peerings between directly connected eBGP peers using loopback addresses
keepalive	integer	false	60	keep_alive	Keepalive timer to check if the neighbor is still up. Integer between 1 and 1000
hold_down	integer	false	180	holddown	The time in seconds when a neighbor is considered dead. This is usually 3 times the keepalive timer. Integer between 3 and 3000
connect_timer	integer	false	-	connecttimer	The time in seconds how fast a neighbor tries to reconnect. Integer between 1 and 65000
description	string	false	-	desc	Optional description for the neighbor
prefix_list_in	string	false	-	prefix_in, pre_in	Prefix-List for inbound direction
prefix_list_out	string	false	-	prefix_out, pre_out	Prefix-List for outbound direction
route_map_in	string	false	-	map_in, rm_in	Route-Map for inbound direction
route_map_out	string	false	-	map_out, rm_out	Route-Map for outbound direction
reload	boolean	false	true	-	If the running config should be reloaded on change - this will take some time. You might want to reload it ‘manually’ after all changes are done => using the reload module.

ansibleguy.opnsense.frr_bgp_prefix_list

Parameter	Type	Required	Default value	Aliases	Comment
name	string	true	-	-	Name to identify the prefix-list by - used in combination with its sequence number. Maximum length = 64
seq	integer	true	-	sequence, seq_number	Sequence number for the prefix-list
network	string	false for state changes, else true	-	net
action	string	false for state changes, else true	-	-	Set permit for match or deny to negate the rule. One of: ‘permit’, ‘deny’
description	string	false	-	-	Optional description
version	string	false	IPv4	ipv	IP-version to use. One of: IPv4, IPv6
reload	boolean	false	true	-	If the running config should be reloaded on change - this will take some time. You might want to reload it ‘manually’ after all changes are done => using the reload module.

ansibleguy.opnsense.frr_bgp_route_map

Parameter	Type	Required	Default value	Aliases	Comment
name	string	true	-	-	Name to identify the route-map by. Maximum length = 64
id	integer	false for state changes, else true	-	-	Route-map ID between 10 and 99. Be aware that the sorting will be done under the hood, so when you add an entry between it get’s to the right position
action	string	false for state changes, else true	-	-	Set permit for match or deny to negate the rule. One of: ‘permit’, ‘deny’
description	string	false	-	-	Optional description
as_path_list	list	false	-	as_path	List of as-path entries to link
prefix_list	dict	false	-	pre, prefix	Dictionary of prefixes to link. Per example: “{prefix_name: [seq1, seq2]}” or “{‘pre1’: [5, 6]}” will link prefixes with the name ‘pre1’ and sequence 5-6
community_list	list	false	-	community	List of community-list entries to link
set	string	false	-	-	Free text field for your set, please be careful! You can set e.g. “local-preference 300” or “community 1:1” (http://www.nongnu.org/quagga/docs/docs-multi/Route-Map-Set-Command.html#Route-Map-Set-Command)
reload	boolean	false	true	-	If the running config should be reloaded on change - this will take some time. You might want to reload it ‘manually’ after all changes are done => using the reload module.

ansibleguy.opnsense.frr_bgp_community_list

Parameter	Type	Required	Default value	Aliases	Comment
description	string	true	-	desc	Description used to identify the community-list by
number	integer	false for state changes, else true	-	nr	Set the number of your Community-List. 1-99 are stardard lists while 100-500 are expanded lists
seq	integer	false for state changes, else true	-	sequence	The ACL sequence number (10-99)
action	string	false for state changes, else true	-	-	Set permit for match or deny to negate the rule. One of: ‘permit’, ‘deny’
community	string	false for state changes, else true	-	comm	The community you want to match. You can also regex and it is not validated so please be careful
reload	boolean	false	true	-	If the running config should be reloaded on change - this will take some time. You might want to reload it ‘manually’ after all changes are done => using the reload module.

ansibleguy.opnsense.frr_bgp_as_path

Parameter	Type	Required	Default value	Aliases	Comment
description	string	true	-	desc	Description used to identify the as-path by
number	integer	false for state changes, else true	-	nr	The ACL rule number (10-99); keep in mind that there are no sequence numbers with AS-Path lists. When you want to add a new line between you have to completely remove the ACL
action	string	false for state changes, else true	-	-	Set permit for match or deny to negate the rule. One of: ‘permit’, ‘deny’
as_pattern	string	false for state changes, else true	-	as	The AS pattern you want to match, regexp allowed (e.g. .$ or _1$). It’s not validated so please be careful!
reload	boolean	false	true	-	If the running config should be reloaded on change - this will take some time. You might want to reload it ‘manually’ after all changes are done => using the reload module.

Examples