ID of the interface to update.
Updated interface configuration data.
No Additional PropertiesInterface names that are members of this bridge. Only relevant for BRIDGE interfaces.
No Additional ItemsEnable MAC address learning for bridge interfaces. When enabled, the bridge learns MAC addresses from incoming frames and builds a forwarding table to optimize traffic flow.
Enable Spanning Tree Protocol for bridge interfaces. STP prevents network loops by blocking redundant paths and enables automatic failover when the primary path fails.
Interface names that are members of this link aggregation group.
No Additional ItemsTransmit hash policy for load balancing in link aggregation. LAYER2 uses MAC addresses, LAYER2+3 adds IP addresses, and LAYER3+4 includes TCP/UDP ports for distribution.
LACP data unit transmission rate. SLOW sends LACPDUs every 30 seconds, FAST sends every 1 second for quicker link failure detection.
Whether this interface is critical for failover functionality. Critical interfaces are monitored for failover events and can trigger failover when they fail.
Failover group identifier for clustering. Interfaces in the same group fail over together during failover events. Only relevant on HA-capable systems.
Generate a name if not provided based on type, e.g. "br0", "bond1", "vlan0".
Human-readable description of the interface.
Enable IPv4 DHCP for automatic IP address assignment.
Enable IPv6 autoconfiguration.
List of IP address aliases to configure on the interface.
All items must be unique
No Additional ItemsThe type of IP address (INET for IPv4, INET6 for IPv6).
The IP address for the failover alias.
""
The network mask in CIDR notation.
Virtual Host ID for VRRP failover configuration. Must be unique within the VRRP group and match between failover nodes.
Value must be greater or equal to 1 and lesser or equal to 255
List of IP aliases for failover configuration. These IPs are assigned to the interface during normal operation and migrate during failover.
No Additional ItemsThe type of IP address (INET for IPv4, INET6 for IPv6).
The IP address for the failover alias.
""
List of virtual IP aliases for failover configuration. These are shared IPs that float between nodes during failover events.
No Additional ItemsThe type of IP address (INET for IPv4, INET6 for IPv6).
The IP address for the failover alias.
""
Link aggregation protocol to use for bonding interfaces. LACP uses 802.3ad dynamic negotiation, FAILOVER provides active-backup, LOADBALANCE and ROUNDROBIN distribute traffic across links.
Parent interface for VLAN configuration.
VLAN tag number (1-4094).
Value must be greater or equal to 1 and lesser or equal to 4094
Priority Code Point for VLAN traffic prioritization (0-7). Values 0-7 map to different QoS priority levels, with 0 being lowest and 7 highest priority.
Value must be greater or equal to 0 and lesser or equal to 7
Maximum transmission unit size for the interface (68-9216 bytes).
Value must be greater or equal to 68 and lesser or equal to 9216
Forward Error Correction (FEC) mode. Only valid for physical interfaces.
Configuring this field is only available on enterprise systems. It should be used as directed by TrueNAS Support for resolving link negotiation failures due to FEC mismatches with the upstream switch. Improper configuration of this field can cause a healthy interface to go down.
The updated interface configuration.
No Additional PropertiesInterface names that are members of this bridge. Only relevant for BRIDGE interfaces.
No Additional ItemsWhether MAC address learning is enabled for bridge interfaces. When enabled, the bridge learns MAC addresses from incoming frames and builds a forwarding table to optimize traffic flow.
Whether Spanning Tree Protocol is enabled for bridge interfaces. STP prevents network loops by blocking redundant paths and enables automatic failover when the primary path fails.
Interface names that are members of this link aggregation group.
No Additional ItemsTransmit hash policy for load balancing in link aggregation. LAYER2 uses MAC addresses, LAYER2+3 adds IP addresses, and LAYER3+4 includes TCP/UDP ports for distribution. Only relevant for LACP and LOADBALANCE link aggregations.
LACP data unit transmission rate. SLOW sends LACPDUs every 30 seconds, FAST sends every 1 second for quicker link failure detection. Only relevant for LACP link aggregations.
Whether this interface is critical for failover. Critical interfaces are monitored for failover events and can trigger failover when they fail. Only relevant on HA-capable systems.
Failover group identifier for clustering. Interfaces in the same group fail over together during failover events. Only relevant on HA-capable systems.
Unique identifier for the network interface.
Name of the network interface.
Whether this is a fake/simulated interface for testing purposes.
Type of interface (PHYSICAL, BRIDGE, LINK_AGGREGATION, VLAN, etc.).
Current runtime state of the interface as reported by the OS kernel. This reflects what is actually configured in the kernel at query time and may differ from the top-level fields, which represent the persisted database configuration. Pending changes (after interface.update but before interface.commit) will not be visible here until the commit is applied and the interface is synchronized.
Current name of the network interface.
Original name of the network interface before any renaming.
Human-readable description of the network interface.
Maximum transmission unit size for the interface.
Whether the interface is a cloned/virtual interface.
List of interface flags indicating various states and capabilities. Common flags include UP, DOWN, RUNNING, MULTICAST, BROADCAST, LOOPBACK, and POINTOPOINT.
No Additional ItemsIPv6 neighbor discovery flags. These control IPv6 autoconfiguration behavior and include flags like AUTOLINKLOCAL, ACCEPTRTADV, and PERFORMNUD.
No Additional ItemsList of hardware capabilities supported by the interface. Common capabilities include VLANMTU, JUMBOMTU, VLANHWTAGGING, VLANHWCSUM, and TSO4.
No Additional ItemsCurrent link state of the interface (up, down, etc.).
Type of media/connection for the interface. Examples include Ethernet, 802.11, or loopback.
Subtype of media/connection for the interface. Examples include 1000baseT, 100baseTX, or autoselect.
Currently active media type. This may differ from configured media_type during autonegotiation.
Currently active media subtype. This reflects the actual negotiated connection speed and type.
List of supported media types for the interface. Contains media descriptors like '1000baseT <full-duplex>' or 'autoselect'.
No Additional ItemsAvailable media options for the interface. Options may include 'full-duplex', 'half-duplex', 'flowcontrol', or 'rxpause'.
MAC address of the interface.
Permanent MAC address of the interface if different from current.
Hardware MAC address of the interface.
Number of receive queues configured for the interface.
Number of transmit queues configured for the interface.
List of IP address aliases configured on the interface.
No Additional ItemsThe type of IP address (INET for IPv4, INET6 for IPv6).
The IP address value.
The network mask for the IP address, either as a string or CIDR notation integer.
Broadcast address for the network interface.
VRRP (Virtual Router Redundancy Protocol) configuration for the interface.
Link aggregation protocol used (LACP, FAILOVER, etc.).
List of ports that are members of this link aggregation group.
No Additional ItemsThe name of the port interface.
List of flags associated with the port.
No Additional ItemsTransmit hash policy for load balancing in link aggregation. LAYER2 uses MAC addresses, LAYER2+3 adds IP addresses, and LAYER3+4 includes TCP/UDP ports for distribution.
LACP data unit transmission rate. SLOW sends LACPDUs every 30 seconds, FAST sends every 1 second for quicker link failure detection.
Parent interface for VLAN configuration.
VLAN tag number.
Priority Code Point for VLAN traffic prioritization. Values 0-7 map to different QoS priority levels, with 0 being lowest and 7 highest priority.
Currently active Forward Error Correction mode from the hardware. Only present for physical interfaces.
null: FEC not supported or mode cannot be determinedList of IP address aliases configured on the interface.
No Additional ItemsThe type of IP address (INET for IPv4, INET6 for IPv6).
The IP address value.
The network mask for the IP address, either as a string or CIDR notation integer.
Whether IPv4 DHCP is enabled for automatic IP address assignment.
Whether IPv6 autoconfiguration is enabled.
Human-readable description of the interface.
Maximum transmission unit size for the interface.
Forward Error Correction (FEC) mode. Only valid for physical interfaces.
Parent interface for VLAN configuration.
VLAN tag number for VLAN interfaces.
Priority Code Point for VLAN traffic prioritization.
Link aggregation protocol (LACP, FAILOVER, LOADBALANCE, etc.).
VRRP Virtual Host ID for failover. Only present on HA-capable systems.
Standby node IP aliases for failover. Only present on HA-capable systems. Unlike the failover_aliases accepted by interface.create and interface.update, each entry here also includes a netmask.
The type of IP address (INET for IPv4, INET6 for IPv6).
The IP address value.
The network mask for the IP address, either as a string or CIDR notation integer.
Virtual (floating) IP aliases shared between nodes during failover. Only present on HA-capable systems. Unlike the failover_virtual_aliases accepted by interface.create and interface.update, each entry here also includes a netmask.
The type of IP address (INET for IPv4, INET6 for IPv6).
The IP address value.
The network mask for the IP address, either as a string or CIDR notation integer.