# Border Routing Manager

# Border Routing Manager

This module includes configuration variables for Border Routing Manager.

## Summary

| ### Macros ||
|---|---|
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga01c347c4539af92327b7c3ac8bfe34b9 0` | Define to 1 to enable the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gabffe90e99fcac1f992e18a12de0b2c28 (4 * 60 * 60)` | This parameter sets the maximum preferred lifetime (in seconds) for the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gad7b810019f89c7f20958782e31f981cc (30 * 60)` | This parameter sets the minimum preferred lifetime (in seconds) for the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gaa17fbfca2fb3dda16cc43382c74c4517 0` | Define to 1 to enable the Border Routing Manager's DHCPv6 Prefix Delegation feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga3f63e17abc315c2290a30b941301c1db 0` | Define to 1 to enable Border Routing Manager feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga4f3734b51c772cc97b43666a64a07e44 64` | Specifies maximum number of discovered prefixes (on-link prefixes on the infra link) maintained by routing manager. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga3cdf210b17e3265e0a35ef2be4aaf5fe 16` | Specifies maximum number of routers (on infra link) to track by routing manager. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga8378dc89b8dccb4792954c1779f726e3 3` | Specifies maximum number of old local on-link prefixes (being deprecated) maintained by routing manager. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gac4ec815b2de54c339ccea39aa07c84dd 16` | Specifies maximum number of on-mesh prefixes (discovered from Thread Network Data) that are included as Route Info Option in emitted Router Advertisement messages. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga7fb5a13342cdfcaba4acd968e9332ed8 0` | Define to 1 to add mock (empty) implementation of infra-if platform APIs. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gaf08fc14f924de72c9f6f11131abf9056 1` | Specifies the "Auto Enable Mode" for Multi-AIL Detection feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga6d90433c4572b2df8adb9cf139243cc8 OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` | Define to 1 to enable Multiple Adjacent Infrastructure Links (AILs) detection feature. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gaa058512699e3130f3a74d678d3e1e9fc 1` | Define to 1 to allow Routing Manager to check for reachability of messages being forwarded by the BR and determine whether to send an ICMPv6 Destination Unreachable error back to the sender. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1gaaf7d1674c7ea5a6314882fc0dc46379f (60 * 1000)` | Specifies the timeout in msec for a discovered router on infra link side. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga84898633ec4c677abce62dc6ad3c3f82 0` | Define to 1 to enable testing related APIs to be provided by the `RoutingManager`. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga121f11715559b9d2af4d20ca059761f4 OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` | Define to 1 to allow the Routing Manager to track information (e.g., advertised prefixes) about peer Thread Border Routers that are connected to the same Thread network. |
| `https://openthread.io/reference/config/group/config-border-routing#group__config-border-routing_1ga5b388296b90867d200a5ce208b6c97ba 1` | Define to 1 to allow using heap by Routing Manager. |

## Macros

### OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE 0
```
Define to 1 to enable the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature.

See `OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE` for how this is used.

### OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MAX_LIFETIME

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MAX_LIFETIME (4 * 60 * 60)
```
This parameter sets the maximum preferred lifetime (in seconds) for the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature.

### OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MIN_LIFETIME

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MIN_LIFETIME (30 * 60)
```
This parameter sets the minimum preferred lifetime (in seconds) for the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature.

The default value is suggested based on: <https://datatracker.ietf.org/doc/draft-ietf-snac-simple/>.

### OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 0
```
Define to 1 to enable the Border Routing Manager's DHCPv6 Prefix Delegation feature.

When enabled, the Routing Manager will track and use delegated DHCPv6 prefix(es) for use as an OMR (Off-Mesh-Routable) prefix within the Thread network.

The configuration `OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE` (which enables the OpenThread native DHCPv6 PD client) controls how the PD prefixes are acquired:


- If the built-in OpenThread DHCPv6 PD client is disabled, the platform will be responsible for acquiring the PD prefix. The platform layer is expected to interact with DHCPv6 servers and provide the delegated PD prefix(es) through platform APIs such as `otPlatBorderRoutingProcessIcmp6Ra()` or `otPlatBorderRoutingProcessDhcp6PdPrefix()` (refer to `include/platform/border_routing.h` for a more detailed description of these APIs).
- If the built-in OpenThread DHCPv6 PD client is enabled, the functionality is implemented and provided by the OpenThread core itself, which acts as a DHCPv6 client and interacts with DHCPv6 servers directly.

<br />

### OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 0
```
Define to 1 to enable Border Routing Manager feature.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 64
```
Specifies maximum number of discovered prefixes (on-link prefixes on the infra link) maintained by routing manager.

Applicable only when heap allocation is not used, i.e., `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` is disabled.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 16
```
Specifies maximum number of routers (on infra link) to track by routing manager.

Applicable only when heap allocation is not used, i.e., `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` is disabled.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 3
```
Specifies maximum number of old local on-link prefixes (being deprecated) maintained by routing manager.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 16
```
Specifies maximum number of on-mesh prefixes (discovered from Thread Network Data) that are included as Route Info Option in emitted Router Advertisement messages.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0
```
Define to 1 to add mock (empty) implementation of infra-if platform APIs.

This is intended for generating code size report only and should not be used otherwise.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_AUTO_ENABLE_MODE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_AUTO_ENABLE_MODE 1
```
Specifies the "Auto Enable Mode" for Multi-AIL Detection feature.

When "Auto Enable Mode" is set, the Multi-AIL Detector is enabled by default and starts running and monitoring when the infrastructure interface network is initialized and become active/running. If this mode is disabled, the detector will be in a disabled state initially and must be explicitly enabled using the public API `otBorderRoutingSetMultiAilDetectionEnabled()`.

### OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE
```
Define to 1 to enable Multiple Adjacent Infrastructure Links (AILs) detection feature.

The detection mechanism operates as follows: The detector monitors the number of peer BRs listed in the Thread Network Data (see `otBorderRoutingCountPeerBrs()`) and compares this count with the number of peer BRs discovered by processing received Router Advertisement (RA) messages on its connected AIL. If the count derived from Network Data consistently exceeds the count derived from RAs for a detection duration of 10 minutes, it concludes that BRs are likely connected to different AILs. To clear state a shorter window of 1 minute is used.

See `otBorderRoutingIsMultiAilDetected()` for more details.

### OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE 1
```
Define to 1 to allow Routing Manager to check for reachability of messages being forwarded by the BR and determine whether to send an ICMPv6 Destination Unreachable error back to the sender.

Specifically, if the Border Router (BR) decides to forward a unicast IPv6 message outside the AIL and the message's source address matches a BR-generated ULA OMR prefix (with low preference), and the destination is unreachable using this source address, then an ICMPv6 Destination Unreachable message is sent back to the sender.

For example, this situation can occur when a local, non-infrastructure-derived ULA OMR prefix is published alongside a `::/0` route (due to discovered PIO/RIO prefixes by the BR). A Thread mesh device may try to reach addresses beyond the local AIL (e.g., the global internet) using its ULA OMR address as source, which would be unreachable.

Alternatively, this functionality may be implemented within the platform layer, in which case this configuration should be disabled. Note that the platform layer is always responsible for implementing generation of "ICMPv6
Destination Unreachable - No Route" messages. This reachability function will only generate "ICMPv6 Destination
Unreachable - Communication Administratively Prohibited" messages for specific cases where there may be a default route to the destination but the source address type prohibits usable communication with this destination.

### OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT (60 * 1000)
```
Specifies the timeout in msec for a discovered router on infra link side.

This parameter is related to mechanism to check that a discovered router is still active.

After this timeout elapses since the last received message (a Router or Neighbor Advertisement) from the router, routing manager will start sending Neighbor Solidification (NS) probes to the router to check that it is still active.

This parameter can be considered to large value to practically disable this behavior.

### OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE 0
```
Define to 1 to enable testing related APIs to be provided by the `RoutingManager`.

This is intended for testing only. Production devices SHOULD set this to zero.

### OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE
```
Define to 1 to allow the Routing Manager to track information (e.g., advertised prefixes) about peer Thread Border Routers that are connected to the same Thread network.

When enabled, the Routing Manager will maintain a record of advertised RIO/PIO prefixes discovered from received Router Advertisements of peer BRs. These entries are disregarded in decision-making (e.g., selecting favored on-link prefix or determining which route to publish in the Thread Network Data).

It is recommended to enable this feature alongside `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE`.

### OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 1
```
Define to 1 to allow using heap by Routing Manager.

When enabled heap allocated entries will be used to track discovered prefix table contain information about discovered routers and the advertised on-link prefixes on infra link.

When disabled pre-allocated pools are used instead where max number of entries are specified by `OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS` and `MAX_DISCOVERED_PREFIXES` configurations.

## Resources

OpenThread API Reference topics originate from the source code, available
on [GitHub](https://github.com/openthread/openthread/tree/main/include/openthread).
For more information, or to contribute to our documentation, refer to
[Resources](https://openthread.io/resources).