TrueNAS 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.

Network Interface Screens

6 minute read.

Last Modified 2024-08-21 10:51 EDT

The Interfaces widget on the Network screen shows interface port names and IP addresses configured on your TrueNAS system and their upload/download rates.

NetworkInterfacesWidget

Use Add to open the Add Interface configuration screen.

Click on an interface to open the Edit Interface configuration screen.

Click the icon next to an interface to open the Edit Interface configuration screen.

Click the icon next to a physical interface to reset configuration settings for that interface.

Click the icon next to any other interface to delete that interface.

TrueNAS Enterprise
High Availability (HA) Enterprise systems cannot reset or delete interfaces while failover is enabled. On systems with HA failover enabled, the or icons are disabled. Go to System > Failover to disable failover before attempting to modify interfaces on HA systems.

Add/Edit Interface Configuration Screens

The fields on the Add Interface and Edit Interface configuration screens are almost identical. The Type field only shows on the Add Interface configuration screen. Type is a required field, and after selecting the interface type additional configuration fields show based on the selected type.

Apply saves setting changes.

Interface Settings

These settings are common to all interface types. The Type setting is only available and required on the Add Interface configuration screen.

AddInterfaceInterfaceSettings

Setting	Description
Type	(Required) Select the type of interface from the dropdown list, Options are: Bridge - Select to create a logical link between multiple networks. Link Aggregation - Select to combine multiple network connections into a single interface. VLAN - Select to partition and isolate a segment of the connection. Each type of interface shows additional configuration settings for that type. The Type field does not display on the Edit Interface screen.
Name	(Required) Enter a name for the interface. Use the format bondX, vlanX, or brX where X is a number representing a non-parent interface. Assign the first interface of any type the appropriate name plus zero, for example, br0 for the first bridge interface created. You cannot change the interface name after clicking Apply. After saving, Name becomes a read-only field when editing an interface.
Description	Enter a description for the interface.
DHCP	Select to enable DHCP. Leave the checkbox clear to create a static IPv4 or IPv6 configuration. Only one interface can be configured using DHCP.
Autoconfigure IPv6	Select to automatically configure the IPv6 address with rtsol(8). Only one interface can be configured this way.

Bridge Settings

Bridge Settings only shows after selecting Bridge in Type.

AddInterfaceBridgeSettings

Setting	Description
Bridge Members	Select the network interfaces to include in the bridge from the dropdown list of options.

Link Aggregation Settings

Link aggregation settings only show after selecting Link Aggregation as the Type. Additional settings show based on the selection in Link Aggregation Protocol.

Click here for LACP settings

Setting	Description
Link Aggregation Protocol	Select the protocol to use from the dropdown list of options. The protocol determines the outgoing and incoming traffic ports. LACP - Select if the network switch is capable of active LACP (this is the recommended protocol). LACP shows additional settings. Failover - Select if the network switch does not support active LACP. This is the default protocol choice and is only used if the network switch does not support active LACP. Failover uses only the Link Aggregation Interfaces setting.<br Loadbalance - Select to set up loadbalancing. Loadbalance does not use any other link aggregation settings.
Transmit Hash Policy	Shows when the protocol is set to LCAP or Loadbalance. Select the hash policy from the dropdown list of options, LAYER2, LAYER2+3 the default, or LAYER3+4.
LACPDU Rate	Shows only when the protocol is set to LCAP. Select either Slow or Fast from the dropdown list of options.
Link Aggregation Interfaces	(Required) Shows when protocol is set to LACP, Failover or Loadbalance. Select the interfaces to use in the aggregation. Warning! Link Aggregation creation fails if any of the selected interfaces are manually configured!

Click here for Failover settings

Setting	Description
Link Aggregation Protocol	Select the protocol to use from the dropdown list of options. The protocol determines the outgoing and incoming traffic ports. Options are: LACP - Select if the network switch is capable of active LACP (this is the recommended protocol). LACP Shows additional settings. Failover - Select if the network switch does not support active LACP. This is the default protocol choice and is only used if the network switch does not support active LACP. Failover uses only the Link Aggregation Interfaces setting. Loadbalance - Select to set up loadbalancing. Loadbalance does not use any other link aggregation settings.
Link Aggregation Interfaces	(Required) Select the interfaces to use in the aggregation. Warning! Link Aggregation creation fails if any of the selected interfaces are manually configured!

Setting

Description

Link Aggregation Protocol

Select the protocol to use from the dropdown list of options. The protocol determines the outgoing and incoming traffic ports. Options are:

LACP - Select if the network switch is capable of active LACP (this is the recommended protocol). LACP Shows additional settings.

Failover - Select if the network switch does not support active LACP. This is the default protocol choice and is only used if the network switch does not support active LACP. Failover uses only the Link Aggregation Interfaces setting.

Loadbalance - Select to set up loadbalancing. Loadbalance does not use any other link aggregation settings.

Link Aggregation Interfaces

(Required) Select the interfaces to use in the aggregation.
Warning! Link Aggregation creation fails if any of the selected interfaces are manually configured!

Click here for Loadbalance settings

Setting	Description
Link Aggregation Protocol	Select the protocol to use from the dropdown list of options. The protocol determines the outgoing and incoming traffic ports. LACP - Select if the network switch is capable of active LACP (this is the recommended protocol). LACP shows additional settings. Failover - Select if the network switch does not support active LACP. This is the default protocol choice and should be only used if the network switch does not support active LACP. Failover uses only the Link Aggregation Interfaces setting. Loadbalance Select to set up loadbalancing. Loadbalance does not use any other link aggregation settings
Transmit Hash Policy	Select the hash policy from the dropdown list of options, LAYER2, LAYER2+3 the default, or LAYER3+4.
Link Aggregation Interfaces	Required. Select the interfaces to use in the aggregation. Warning! Link Aggregation creation fails if any of the selected interfaces have been manually configured!

VLAN Settings

Link aggregation settings only display after you select VLAN as the Type.

AddInterfaceVLANSettings

Setting	Description
Parent Interface	Select the VLAN parent interface from the dropdown list of options. This is usually an Ethernet card connected to a switch port configured for the VLAN. New link aggregations are not available until you restart the system.
VLAN Tag	(Required) Enter the numeric tag configured in the switched network. Request this from your IT department if you are not the network administrator for your systems.
Priority Code Point	Select the class of service from the dropdown list of options. The available 802.1p class of service ranges from Best effort (default) to Network control (highest).

Other Settings

Other Settings show for all types of interfaces.

AddInterfaceOtherSettings

Setting	Description
MTU	Maximum Transmission Unit (MTU), or the largest protocol data unit that can be communicated. The largest workable MTU size varies with network interfaces and equipment. 1500 and 9000 are standard Ethernet MTU sizes. Leaving blank restores the field to the default value of 1500.

Aliases

Add the right of Aliases shows fields to define an alias IP address and netmask (CIDR) for the interface on the TrueNAS controller. The alias can be an IPv4 or IPv6 address.

AddInterfaceAliases

Users can also select the CIDR bits that are a part of the network address from the dropdown list of options.

Testing Changes

The option to test network changes shows when creating a new or changing an existing network interface that can affect access to the UI.

Test Changes starts the 60-second timer. Revert Changes discards changes made within the 60-second period. Save Changes makes changes permanent. Shows in the new browser window opened as part of the esting Network Interface Changes process.