interface.update

Update Interface of id.

Update network interface static IP:

> network interface update enp0s3 aliases=”192.168.0.10”

Type: object

Call parameters

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

Name

Type: string

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

description

Description

Type: string

Human-readable description of the interface.

ipv4_dhcp

Ipv4 Dhcp

Type: boolean

Enable IPv4 DHCP for automatic IP address assignment.

ipv6_auto

Ipv6 Auto

Type: boolean

Enable IPv6 autoconfiguration.

aliases

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

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

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

Must be one of:

• "INET"
• "INET6"

address Required

Address

The IP address for the failover alias.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

netmask Required

Netmask

Type: integer

The network mask in CIDR notation.

failover_critical

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

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

Any of

• Option 1
• Option 2

Type: integer

Type: null

failover_vhid

Failover Vhid

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

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

failover_aliases

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

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

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

Must be one of:

• "INET"
• "INET6"

address Required

Address

The IP address for the failover alias.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

failover_virtual_aliases

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

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

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

Must be one of:

• "INET"
• "INET6"

address Required

Address

The IP address for the failover alias.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

bridge_members

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

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

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

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

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

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

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

Vlan Parent Interface

Type: string

Parent interface for VLAN configuration.

vlan_tag

Vlan Tag

Type: integer

VLAN tag number (1-4094).

vlan_pcp

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.

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

mtu

Mtu

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

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

Return value

InterfaceEntry

Type: object

The updated interface configuration.

id Required

Id

Type: string

Unique identifier for the network interface.

name Required

Name

Type: string

Name of the network interface.

fake Required

Fake

Type: boolean

Whether this is a fake/simulated interface for testing purposes.

type Required

Type

Type: string

Type of interface (PHYSICAL, BRIDGE, LINK_AGGREGATION, VLAN, etc.).

state Required

InterfaceEntryState

Type: object

Current runtime state information for the interface.

No Additional Properties

name Required

Name

Type: string

Current name of the network interface.

orig_name Required

Orig Name

Type: string

Original name of the network interface before any renaming.

description Required

Description

Type: string

Human-readable description of the network interface.

mtu Required

Mtu

Type: integer

Maximum transmission unit size for the interface.

cloned Required

Cloned

Type: boolean

Whether the interface is a cloned/virtual interface.

flags Required

Flags

Type: array of string

List of interface flags indicating various states and capabilities. Common flags include UP, DOWN, RUNNING, MULTICAST, BROADCAST, LOOPBACK, and POINTOPOINT.

No Additional Items

Each item of this array must be:

Type: string

nd6_flags Required

Nd6 Flags

Type: array

IPv6 neighbor discovery flags. These control IPv6 autoconfiguration behavior and include flags like AUTOLINKLOCAL, ACCEPTRTADV, and PERFORMNUD.

No Additional Items

Each item of this array must be:

Type: object

capabilities Required

Capabilities

Type: array

List of hardware capabilities supported by the interface. Common capabilities include VLANMTU, JUMBOMTU, VLANHWTAGGING, VLANHWCSUM, and TSO4.

No Additional Items

Each item of this array must be:

Type: object

link_state Required

Link State

Type: string

Current link state of the interface (up, down, etc.).

media_type Required

Media Type

Type: string

Type of media/connection for the interface. Examples include Ethernet, 802.11, or loopback.

media_subtype Required

Media Subtype

Type: string

Subtype of media/connection for the interface. Examples include 1000baseT, 100baseTX, or autoselect.

active_media_type Required

Active Media Type

Type: string

Currently active media type. This may differ from configured media_type during autonegotiation.

active_media_subtype Required

Active Media Subtype

Type: string

Currently active media subtype. This reflects the actual negotiated connection speed and type.

supported_media Required

Supported Media

Type: array

List of supported media types for the interface. Contains media descriptors like '1000baseT <full-duplex>' or 'autoselect'.

No Additional Items

Each item of this array must be:

Type: object

media_options Required

Media Options

Available media options for the interface. Options may include 'full-duplex', 'half-duplex', 'flowcontrol', or 'rxpause'.

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

link_address Required

Link Address

Type: string

MAC address of the interface.

permanent_link_address Required

Permanent Link Address

Permanent MAC address of the interface if different from current.

Any of

• Option 1
• Option 2

Type: string

Type: null

hardware_link_address Required

Hardware Link Address

Type: string

Hardware MAC address of the interface.

rx_queues

Rx Queues

Type: integer

Number of receive queues configured for the interface.

tx_queues

Tx Queues

Type: integer

Number of transmit queues configured for the interface.

aliases Required

Aliases

Type: array of object

List of IP address aliases configured on the interface.

No Additional Items

Each item of this array must be:

InterfaceEntryStateAlias

Type: object
No Additional Properties

type Required

Type

Type: string

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

address Required

Address

Type: string

The IP address value.

netmask

Netmask

Any of

• Option 1
• Option 2

Type: string

Type: integer

broadcast

Broadcast

Type: string

vrrp_config

Vrrp Config

Default: []

VRRP (Virtual Router Redundancy Protocol) configuration for the interface.

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

protocol

Protocol

Link aggregation protocol used (LACP, FAILOVER, etc.).

Any of

• Option 1
• Option 2

Type: string

Type: null

ports

Ports

Type: array of object Default: []

List of ports that are members of this link aggregation group.

No Additional Items

Each item of this array must be:

InterfaceEntryStatePort

Type: object
No Additional Properties

name Required

Name

Type: string

The name of the port interface.

flags Required

Flags

Type: array of string

List of flags associated with the port.

No Additional Items

Each item of this array must be:

Type: string

xmit_hash_policy

Xmit Hash Policy

Default: null

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.

Any of

• Option 1
• Option 2

Type: string

Type: null

lacpdu_rate

Lacpdu Rate

Default: null

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

Any of

• Option 1
• Option 2

Type: string

Type: null

parent

Parent

Parent interface for VLAN configuration.

Any of

• Option 1
• Option 2

Type: string

Type: null

tag

Tag

VLAN tag number.

Any of

• Option 1
• Option 2

Type: integer

Type: null

pcp

Pcp

Priority Code Point for VLAN traffic prioritization. Values 0-7 map to different QoS priority levels, with 0 being lowest and 7 highest priority.

Any of

• Option 1
• Option 2

Type: integer

Type: null

aliases Required

Aliases

Type: array of object

List of IP address aliases configured on the interface.

No Additional Items

Each item of this array must be:

InterfaceEntryAlias

Type: object
No Additional Properties

type Required

Type

Type: string

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

address Required

Address

Type: string

The IP address value.

netmask Required

Netmask

The network mask for the IP address, either as a string or CIDR notation integer.

Any of

• Option 1
• Option 2

Type: string

Type: integer

ipv4_dhcp Required

Ipv4 Dhcp

Type: boolean

Whether IPv4 DHCP is enabled for automatic IP address assignment.

ipv6_auto Required

Ipv6 Auto

Type: boolean

Whether IPv6 autoconfiguration is enabled.

description Required

Description

Type: string

Human-readable description of the interface.

mtu Required

Mtu

Maximum transmission unit size for the interface.

Any of

• Option 1
• Option 2

Type: integer

Type: null

vlan_parent_interface

Vlan Parent Interface

Parent interface for VLAN configuration.

Any of

• Option 1
• Option 2

Type: string

Type: null

vlan_tag

Vlan Tag

VLAN tag number for VLAN interfaces.

Any of

• Option 1
• Option 2

Type: integer

Type: null

vlan_pcp

Vlan Pcp

Priority Code Point for VLAN traffic prioritization.

Any of

• Option 1
• Option 2

Type: integer

Type: null

lag_protocol

Lag Protocol

Type: string

Link aggregation protocol (LACP, FAILOVER, LOADBALANCE, etc.).

lag_ports

Lag Ports

Type: array of string Default: []

List of interface names that are members of this link aggregation group.

No Additional Items

Each item of this array must be:

Type: string

bridge_members

Bridge Members

Type: array of string Default: []

List of interface names that are members of this bridge.

No Additional Items

Each item of this array must be:

Type: string

enable_learning

Enable Learning

Type: boolean

Whether MAC address learning is enabled for bridge interfaces.

Additional Properties

Additional Properties of any type are allowed.

Type: object

Required roles: NETWORK_INTERFACE_WRITE