# Border Router

This module includes configuration variables for Border Router services.

## Summary

| ### Macros ||
|---|---|
| `https://openthread.io/reference/config/group/config-border-router#group__config-border-router_1gae368773b5d35b10c0ff8d0f9e99bfecf 0` | Define to 1 to enable Border Router support. |
| `https://openthread.io/reference/config/group/config-border-router#group__config-border-router_1gadeb4a8a17f4068789a99fb6e8d954949 1` | Define to 1 to enable mechanism on a Border Router which provides IP connectivity to request router role upgrade. |
| `https://openthread.io/reference/config/group/config-border-router#group__config-border-router_1ga7e506465446dfe473fd3a703c01fe5ef OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` | Define as 1 to enable mechanism to detect and signal when local or leader Network Data gets full. |

## Macros

### OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 0
```
Define to 1 to enable Border Router support.

### OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE

```
 OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 1
```
Define to 1 to enable mechanism on a Border Router which provides IP connectivity to request router role upgrade.

This config is applicable on an `OPENTHREAD_FTD` build and when `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` is also enabled.

A Border Router is considered to provide external IP connectivity if at least one of the below conditions hold:


- It has added at least one external route entry.
- It has added at least one prefix entry with default-route and on-mesh flags set.

<br />

A Border Router which provides IP connectivity and is acting as a REED is eligible to request a router role upgrade by sending an "Address Solicit" request to leader with status reason `BorderRouterRequest`. This reason is used when the number of active routers in the Thread mesh is above the threshold, and only if the number of existing eligible BRs (determined from the Thread Network Data) that are acting as router is less than two. This mechanism allows up to two eligible Border Routers to request router role upgrade when the number of routers is already above the threshold.

### OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL

```
 OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
```
Define as 1 to enable mechanism to detect and signal when local or leader Network Data gets full.

## 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).