TrueNASTrueNAS Nightly Development Documentation
This content follows experimental nightly development software. Pre-release software is intended for testing purposes only.
Use the Product and Version selectors above to view content specific to a stable software release.

Setting Up a Network Bridge

In general, a bridge refers to various methods of combining (aggregating) multiple network connections into a single aggregate network.

TrueNAS uses bridge(4) as the kernel bridge driver. Bridge(8) is a command for configuring the bridge in Linux. While the examples focus on the deprecated brctl(8) from the bridge-utilities package, we use ip(8) and bridge(8) from iproute2 instead. Refer to the FAQ section that covers bridging topics more generally.

Network bridging does not inherently aggregate bandwidth like link aggregation (LAGG). Bridging is often used for scenarios that require extending a network segment or combining different types of network traffic.

You can use bridging to integrate different types of networks (e.g., wireless and wired networks) or to segment traffic within the same network. You can also use a bridge to allow a VM configured on TrueNAS to communicate with the host system. See Accessing NAS from a VM or Apps for more information.

Before making network interface changes:

  1. Stop running apps.
  2. Power off running virtual machines (VMs).
  3. Remove active NIC devices for VMs.

Sharing services such as SMB that use the IP address(s) assigned to the primary interface might cause issues with testing network changes. To resolve issues, stop sharing services such as SMB, make the interface change and test the connection, and when complete restart the service.

To set up a bridge interface, go to Network, click Add on the Interfaces widget to open the Add Interface screen, then:

  1. Select Bridge from the Type dropdown list. You cannot change the Type field value after clicking Save!

  2. Enter a name for the interface. Use the correct format based on the interface type:

    bondX* for a LAGG interface vlanX for a VLAN interface brx for a bridge interface

    Where X is a number representing a non-parent interface. Assing the first bridge interface br0.

    You cannot change the Name of the interface after clicking Save.

  3. (Optional but recommended) Enter any notes or reminders about this particular bridge in Description.

  4. Select the interfaces on the Bridge Members dropdown list.

  5. Click Add to the right of Aliases to show the IP address fields, and enter the IP address for this bridge interface. Click Add again to show additional IP address fields for each additional IP address you want to add.

  6. Click Save when finished. The created bridge shows in Interfaces with its associated IP address information.

  7. Click Test Changes to determine if network changes are successful. See Testing Network Interface Changes

  8. After TrueNAS finishes testing the interface, click Save Changes to keep the changes. Click Revert Changes to discard the changes and return to the previous configuration.

Troubleshooting Network Changes

Occasionally, a misconfigured bridge or a conflict with a running application, VM, or service can cause the network changes test to fail. Typically, this is because the bridge is configured using an IP address that is already in use. If the system does not receive a Save Changes check-in before the test times out (default 60 seconds), TrueNAS automatically reverts all unsaved changes.

The following troubleshooting options are available if you cannot save the new bridge and network changes. Options are ordered from the least to the most disruptive. Try options one and two before proceeding with options three and four.

  1. Ensure that there are no currently running applications.
  2. Stop any running VMs.
  3. (Optional) Go to Services. Click edit Configure to view the current configuration of sharing services including SMB and NFS. Stop any services that have a bind IP address matching the bridge IP address. Restart the service(s) after network changes are tested and saved.
  4. (Optional) Stop running apps. After network changes are tested and saved, restart apps.