bgp
Manage FRR peering on OPNsense: configure router ID and AS, create or remove neighbors, and check peering status.
Instructions
FRR BGP: peering state and neighbours. FRR ships disabled, so an empty result usually means it has not been turned on yet. Call action='help' for each action's fields and rules.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bfd | No | [create_neighbor] Use BFD for fast failure detection | |
| uuid | No | Record to act on, identified by a list action. | |
| apply | No | Apply now rather than leaving the change staged. The default differs by action; action='help' reports each one. | |
| action | Yes | Operation to run. 'help' lists fields. | |
| address | No | [create_neighbor] Peer address | |
| confirm | No | Token returned by the previous call, to confirm. | |
| enabled | No | Target state, set explicitly rather than flipped. | |
| multihop | No | [create_neighbor] Peer is not on a directly connected subnet | |
| password | No | [create_neighbor] MD5 session password; stored in clear by OPNsense | |
| as_number | No | [configure] Local AS number. Required the first time BGP is enabled | |
| remote_as | No | [create_neighbor] Peer AS number. Give this or remote_as_mode, not both | |
| router_id | No | [configure] Router id, conventionally a loopback address | |
| description | No | Free-text note stored on the record. | |
| update_source | No | [create_neighbor] Interface to source the session from, e.g. lo0 | |
| remote_as_mode | No | [create_neighbor] internal or external, deriving the peer AS from the local one |