interface.update

Update Interface of id.

Update network interface static IP:

> network interface update enp0s3 aliases=”192.168.0.10”

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

ID of the interface to update.
Parameter 2: data

data

Type: object

Updated interface configuration data.

 No Additional Properties

Name

Type: string

Generate a name if not provided based on type, e.g. "br0", "bond1", "vlan0".

Description

Type: string

Human-readable description of the interface.

Ipv4 Dhcp

Type: boolean

Enable IPv4 DHCP for automatic IP address assignment.

Ipv6 Auto

Type: boolean

Enable IPv6 autoconfiguration.

Aliases

Type: array of object

List of IP address aliases to configure on the interface.

All items must be unique

No Additional Items
Each item of this array must be:

InterfaceCreateAlias

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "INET"

The type of IP address (INET for IPv4, INET6 for IPv6).

Must be one of:
  • "INET"
  • "INET6"

Address


The IP address for the failover alias.

Type: const
Specific value: ""
Type: string

Netmask

Type: integer

The network mask in CIDR notation.

Failover Critical

Type: boolean

Whether this interface is critical for failover functionality. Critical interfaces are monitored for failover events and can trigger failover when they fail.

Failover Group


Failover group identifier for clustering. Interfaces in the same group fail over together during failover events.

Type: integer
Type: null

Failover Vhid


Virtual Host ID for VRRP failover configuration. Must be unique within the VRRP group and match between failover nodes.

Type: integer

Value must be greater or equal to 1 and lesser or equal to 255

Type: null

Failover Aliases

Type: array of object

List of IP aliases for failover configuration. These IPs are assigned to the interface during normal operation and migrate during failover.

 No Additional Items
Each item of this array must be:

InterfaceCreateFailoverAlias

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "INET"

The type of IP address (INET for IPv4, INET6 for IPv6).

Must be one of:
  • "INET"
  • "INET6"

Address


The IP address for the failover alias.

Type: const
Specific value: ""
Type: string

Failover Virtual Aliases

Type: array of object

List of virtual IP aliases for failover configuration. These are shared IPs that float between nodes during failover events.

 No Additional Items
Each item of this array must be:

InterfaceCreateFailoverAlias

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "INET"

The type of IP address (INET for IPv4, INET6 for IPv6).

Must be one of:
  • "INET"
  • "INET6"

Address


The IP address for the failover alias.

Type: const
Specific value: ""
Type: string

Bridge Members

Type: array

List of interfaces to add as members of this bridge.

 No Additional Items
Each item of this array must be:
Type: object

Enable Learning

Type: boolean

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

Stp

Type: boolean

Enable Spanning Tree Protocol for bridge interfaces. STP prevents network loops by blocking redundant paths and enables automatic failover when the primary path fails.

Lag Protocol

Type: enum (of string)

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.

Must be one of:
  • "LACP"
  • "FAILOVER"
  • "LOADBALANCE"
  • "ROUNDROBIN"
  • "NONE"

Xmit Hash Policy

Type: enum (of null or string)

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

Must be one of:
  • "LAYER2"
  • "LAYER2+3"
  • "LAYER3+4"
  • null

Lacpdu Rate

Type: enum (of null or string)

LACP data unit transmission rate. SLOW sends LACPDUs every 30 seconds, FAST sends every 1 second for quicker link failure detection.

Must be one of:
  • "SLOW"
  • "FAST"
  • null

Lag Ports

Type: array of string

List of interface names to include in the link aggregation group.

 No Additional Items
Each item of this array must be:
Type: string

Vlan Parent Interface

Type: string

Parent interface for VLAN configuration.

Vlan Tag

Type: integer

VLAN tag number (1-4094).

Value must be greater or equal to 1 and lesser or equal to 4094

Vlan Pcp


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.

Type: integer

Value must be greater or equal to 0 and lesser or equal to 7

Type: null

Mtu


Maximum transmission unit size for the interface (68-9216 bytes).

Type: integer

Value must be greater or equal to 68 and lesser or equal to 9216

Type: null

Fec Mode

Type: enum (of string)

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.

  • "AUTO": Selects the best FEC mode based on cable/port capabilities
  • "RS": RS-FEC (Reed-Solomon), often used for 25GbE/100GbE+ NICs
  • "BASER": BaseR-FEC (FireCode)
  • "OFF": Disables FEC
  • "LLRS": Low Latency Reed-Solomon FEC, used for 25GBASE-KR/CR
Must be one of:
  • "AUTO"
  • "OFF"
  • "RS"
  • "BASER"
  • "LLRS"

Type: object

The updated interface configuration.


Required roles: NETWORK_INTERFACE_WRITE