Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode
TrueNAS.com Software Systems Company Community Security iX Portal Download

  1. Documentation Hub
  2. /
  3. TrueNAS SCALE
  4. /
  5. UI Reference Guide
  6. /
  7. Network
  8. /
  9. Network Interface Screens
Edit this page

Network Interface Screens

  6 minute read.

Last Modified 2022-07-26 09:16 -0400

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

NetworkInterfacesWidget

Use Add to display the Add Interface configuration screen.

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

Click the icon next to an interface to delete that interface.

Add/Edit Interface Configuration Screens

The fields on the Edit Interface are almost identical to the Add Interface configuration screen except for the Type field that only displays on the Add Interface configuration screen. Type is a required field and after selecting the interface type additional configuration fields display for the type selected.

Use Apply to save your setting changes.

Interface Settings

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

AddInterfaceInterfaceSettings

Setting Description
Type Required field. Select the type of interface from the dropdown list or options Bridge, Link Aggregation or VLAN. Each option displays additional configuration settings for that type.
Select Bridge to create a logical link between multiple networks.
Select Link Aggregation to combine multiple network connections into a single interface.
Select Virtual LAN (VLAN) to partition and isolate a segment of the connection.
This field does not display on the Edit Interface screen.
Name Enter a name for the interface. Use the format bondX, vlanX, or brX where X is a number representing a non-parent interface. You cannot change the interface name after you click Apply. It becomes a read-only field when editing an interface.
Description Enter a description for the interface.
DHCP Select to enable DHCP. Leave 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 display after you select Bridge in for Type.

AddInterfaceBridgeSettings

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

Link aggregation settings only display after you select Link Aggregation as the Type. Additional settings display based on the selection in Link Aggregation Protocol.

AddInterfaceLinkAggLACPSettings

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.
Select LACP if the network switch is capable of active LACP (this is the recommended protocol). LACP displays additional settings.
Select Failover 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.
Select Loadbalance to set up loadbalancing. Loadbalance does not use any other link aggregation settings.
Transmit Hash Policy Displays 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 Displays only when the protocol is set to LCAP. Select either Slow or Fast from the dropdown list of options.
Link Aggregation Interfaces Displays when protocol is set to LACP, Failover or Loadbalance. This is a required field. Select the interfaces to use in the aggregation.
Warning! Link Aggregation creation fails if any of the selected interfaces have been manually configured!

AddInterfaceLinkAggFailoverSettings

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.
Select LACP if the network switch is capable of active LACP (this is the recommended protocol). LACP displays additional settings.
Select Failover 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.
Select Loadbalance to set up loadbalancing. Loadbalance does not use any other link aggregation settings.
Link Aggregation Interfaces This is a required field. Select the interfaces to use in the aggregation.
Warning! Link Aggregation creation fails if any of the selected interfaces have been manually configured!

AddInterfaceLinkAggLoadbalanceSettings

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.
Select LACP if the network switch is capable of active LACP (this is the recommended protocol). LACP displays additional settings.
Select Failover 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.
Select Loadbalance to set up loadbalancing. Loadbalance does not use any other link aggregation settings.
Transmit Hash Policy Displays 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.
Link Aggregation Interfaces Displays when protocol is set to LACP, Failover or Loadbalance. This is a required field. 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. Usually and 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 field. Enter the numeric tag configured in the switched network.
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 display 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.

IP Addresses

Use the IP Address Add to define an alias for the interface on the TrueNAS controller. The alias can be an IPv4 or IPv6 address.

AddInterfaceIPAddresses

Users may also select how many bits are a part of the network address from the dropdown list of options.

Related Content

Related Network Articles