Network Interface Screens

The Interfaces widget on the Network screen shows the configured interface port names and IP addresses, and the MAC addresses associated with network interface cards in your TrueNAS system.

Network Interfaces Widget
Figure 1: Network Interfaces Widgets

Add opens the Add Interface screen.

The more_vert at the right of each interface shows a dropdown list with two options:

TrueNAS Enterprise

High Availability (HA) Enterprise systems cannot reset or edit interface settings with failover enabled. On systems with HA failover enabled, the Reset Configuration or Edit options are disabled. Go to System > Failover to disable failover before attempting to modify interfaces on HA systems.

Reset Configuration Dialog

The Reset Configuration dialog allows you to reset the configuration settings for that interface.

Refresh Configuration Dialog
Figure 3: Refresh Configuration Dialog

Confirm validates the reset activity and activates the Reset button.

Reset resets the configuration for that interface. Resetting the configuration shows the test change options to prevent losing access to that interface and the TrueNAS system.

Add/Edit Interface Screens

The Add Interface screen allows you to configure the settings for a new interface. The Edit Interface screen allows changes to settings for an existing interface. Both screens show the test changes options to validate settings and prevent losing access to the TrueNAS system if the interface is incorrectly configured.

The setting on the Add Interface and Edit Interface screens are almost identical.

Type only shows on the Add Interface screen. It cannot be changed on the Edit Interface screen. Type is a required field. The additional settings show on the Add Interface screen based on the selected type.

Apply saves setting changes, and shows the test changes options.

Interface Settings

Interface settings configure the network interface name, type, and IP address assignment. These settings are common to the three interface types.

Interface Setting
Figure 4: Interface Setting
SettingDescription
Type(Required) Only shows on the Add Interface screen. Sets the type of interface based on the selection on the dropdown list. Options are:
  • Bridge - Creates a logical link between multiple networks.
  • Link Aggregation (LAGG) - Combines multiple network connections into a single interface.
  • VLAN - Partitions and isolates a segment of the connection.
  • Each type of interface shows additional configuration settings for that type. The type cannot be changed after clicking Apply, and testing and accepting the interface change.
    Name(Required) Accepts manual or copy/paste entry of a name for the interface. Names must use the format bondX for a LAGG, vlanX for a VLAN, or brX for a bridge, and 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.
    DescriptionAccepts manual or copy/paste entry of a description for the interface. Descritpions can provide additional information about how the interface is used or what it connects to.
    DHCPEnable DHCP, allowing it to assign IP addresses to the interface. Shows two options: Get IP Address Automatically from DHCP and Define Static IP Addresses. reate a static IPv4 or IPv6 configuration.
    Get IP Address Automatically from DHCPAllows DHCP to assign the IP address for the interface. Only one interface can be configured using DHCP.
    Define Static IP AddressesAllows adding a static IP address to the interface using the Static IP Addresses fields.
    Static IP AddressesShows IP address and netmask (CIDR) fields after clicking Add. Click Add for each static IP address to add to/associate with the interface.
    Autoconfigure IPv6Select to automatically configure the IPv6 address with rtsol(8). Only one interface can be configured this way.
    MTUSets the maximum transmission unit (MTU), which is 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.

    Bridge Settings

    Bridge settings show after setting Type to Bridge. TrueNAS automatically populates the Name with the default br1. Use Description to further define or clarify how or where the bridge is used.

    Bridge Interface Settings
    Figure 5: Bridge Interface Settings

    Bridge Members sets the network interfaces to include in the bridge to the option selected on the dropdown list. |

    Link aggregation (LAGG) settings show after setting Type to Link Aggregation. TrueNAS automatically populates Name with the default bond1. Use Description to further define or clarify how or where the LAGG is used.

    Link Aggregation LACP Protocol
    Figure 6: Link Aggregation LACP Protocol
    SettingDescription
    Link Aggregation ProtocolThe protocol determines the outgoing and incoming traffic ports. Shows a dropdown list with three Link Aggregation (LAGG) protocol options:
  • LACP - Use if the network switch is capable of active LACP (this is the recommended protocol). LACP shows additional settings.
  • Failover - Use 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 - Use to set up loadbalancing. This does not use any other link aggregation settings.
  • Link Aggregation Interfaces(Required) Shows a dropdown list of interfaces in the system. Select the interfaces to use in the aggregation.
    Warning! Link Aggregation creation fails if any of the selected interfaces are manually configured!
  • Failover shows the interfaces that can be enabled for failover. Enabling the toggle select the interface.
  • Loadbalance shows the Transmit Hash Policy setting.
  • Transmit Hash PolicyShows when the protocol is set to LCAP or Loadbalance. Dropdown list shows three hash policy options, LAYER2, LAYER2+3 the default, or LAYER3+4.
    LACPDU RateShows when the protocol is set to LCAP. Shows a dropdown list with two options: Slow or Fast.

    VLAN Settings

    VLAN settings show after setting Type to VLAN. TrueNAS automatically populates the Name with the default vlan1. Use Description to further define or clarify how or where the bridge is used.

    VLAN Settings
    Figure 7: VLAN Settings
    SettingDescription
    Parent InterfaceShows a dropdown list of VLAN parent interface options. Options are 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) Accepts manual or copy/paste entry of the numeric tag configured in the switched network. Request this tag from your IT department if you are not the network administrator for your systems.
    Priority Code PointShows a dropdown list of the class of service options. The available 802.1p class of service ranges from Best effort (default) to Network control (highest).

    Test Changes

    These options show above the Interfaces widget after applying changes to a network interface that can affect access to the UI., and are used to test network changes when creating a new or changing an existing network interface

    Test Network Changes
    Figure 8: Test Network Changes

    Test Changes starts the 60-second timer.

    Revert Changes discards changes made within the 60-second period.

    Save Changes shows after logging into the UI in a new browser window. Makes network changes permanent. Shows as the final part of the testing network interface changes process.