Skip to content

Network API

Network configuration classes.

NetworkConfig

NetworkConfig

Bases: UCISection

Network configuration manager.

Source code in src/wrtkit/network.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
class NetworkConfig(UCISection):
    """Network configuration manager."""

    devices: List[NetworkDevice] = Field(default_factory=list)
    interfaces: List[NetworkInterface] = Field(default_factory=list)
    bridge_vlans: List[BridgeVLAN] = Field(default_factory=list)
    remote_policy: Optional[RemotePolicy] = None

    def __init__(self, **data: Any) -> None:
        super().__init__(**data)
        self._package = "network"
        self._section = ""
        self._section_type = ""

    def add_device(self, device: NetworkDevice) -> "NetworkConfig":
        """Add a device and return self for chaining."""
        self.devices.append(device)
        return self

    def add_interface(self, interface: NetworkInterface) -> "NetworkConfig":
        """Add an interface and return self for chaining."""
        self.interfaces.append(interface)
        return self

    def add_bridge_vlan(self, bridge_vlan: BridgeVLAN) -> "NetworkConfig":
        """Add a bridge VLAN and return self for chaining."""
        self.bridge_vlans.append(bridge_vlan)
        return self

    def get_commands(self) -> List[UCICommand]:
        """Get all UCI commands for network configuration."""
        commands = []
        for device in self.devices:
            commands.extend(device.get_commands())
        for interface in self.interfaces:
            commands.extend(interface.get_commands())
        for bridge_vlan in self.bridge_vlans:
            commands.extend(bridge_vlan.get_commands())
        return commands

add_device(device)

Add a device and return self for chaining.

Source code in src/wrtkit/network.py 
189
190
191
192
def add_device(self, device: NetworkDevice) -> "NetworkConfig":
    """Add a device and return self for chaining."""
    self.devices.append(device)
    return self

add_interface(interface)

Add an interface and return self for chaining.

Source code in src/wrtkit/network.py 
194
195
196
197
def add_interface(self, interface: NetworkInterface) -> "NetworkConfig":
    """Add an interface and return self for chaining."""
    self.interfaces.append(interface)
    return self

get_commands()

Get all UCI commands for network configuration.

Source code in src/wrtkit/network.py 
204
205
206
207
208
209
210
211
212
213
def get_commands(self) -> List[UCICommand]:
    """Get all UCI commands for network configuration."""
    commands = []
    for device in self.devices:
        commands.extend(device.get_commands())
    for interface in self.interfaces:
        commands.extend(interface.get_commands())
    for bridge_vlan in self.bridge_vlans:
        commands.extend(bridge_vlan.get_commands())
    return commands

NetworkDevice

NetworkDevice

Bases: UCISection

Represents a network device configuration.

Source code in src/wrtkit/network.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class NetworkDevice(UCISection):
    """Represents a network device configuration."""

    name: Optional[str] = None
    type: Optional[str] = None
    ports: List[str] = Field(default_factory=list)
    ifname: Optional[str] = None
    vid: Optional[int] = None
    stp: Optional[bool] = None

    def __init__(self, device_name: str, **data: Any) -> None:
        super().__init__(**data)
        self._package = "network"
        self._section = device_name
        self._section_type = "device"

    # Immutable builder methods (composable)
    def with_name(self, value: str) -> "NetworkDevice":
        """Set the device name (returns new copy)."""
        return self.model_copy(update={"name": value})

    def with_type(self, value: str) -> "NetworkDevice":
        """Set the device type (e.g., 'bridge', '8021q') (returns new copy)."""
        return self.model_copy(update={"type": value})

    def with_port(self, port: str) -> "NetworkDevice":
        """Add a port to the device (returns new copy)."""
        ports = self.ports.copy()
        ports.append(port)
        return self.model_copy(update={"ports": ports})

    def with_ports(self, ports: List[str]) -> "NetworkDevice":
        """Set all ports for the device (returns new copy)."""
        return self.model_copy(update={"ports": ports.copy()})

    def with_ifname(self, value: str) -> "NetworkDevice":
        """Set the interface name (returns new copy)."""
        return self.model_copy(update={"ifname": value})

    def with_vid(self, value: int) -> "NetworkDevice":
        """Set the VLAN ID (returns new copy)."""
        return self.model_copy(update={"vid": value})

    def with_stp(self, value: bool) -> "NetworkDevice":
        """Enable or disable Spanning Tree Protocol for bridge devices (returns new copy)."""
        return self.model_copy(update={"stp": value})

with_name(value)

Set the device name (returns new copy).

Source code in src/wrtkit/network.py 
25
26
27
def with_name(self, value: str) -> "NetworkDevice":
    """Set the device name (returns new copy)."""
    return self.model_copy(update={"name": value})

with_type(value)

Set the device type (e.g., 'bridge', '8021q') (returns new copy).

Source code in src/wrtkit/network.py 
29
30
31
def with_type(self, value: str) -> "NetworkDevice":
    """Set the device type (e.g., 'bridge', '8021q') (returns new copy)."""
    return self.model_copy(update={"type": value})

with_port(port)

Add a port to the device (returns new copy).

Source code in src/wrtkit/network.py 
33
34
35
36
37
def with_port(self, port: str) -> "NetworkDevice":
    """Add a port to the device (returns new copy)."""
    ports = self.ports.copy()
    ports.append(port)
    return self.model_copy(update={"ports": ports})

with_ifname(value)

Set the interface name (returns new copy).

Source code in src/wrtkit/network.py 
43
44
45
def with_ifname(self, value: str) -> "NetworkDevice":
    """Set the interface name (returns new copy)."""
    return self.model_copy(update={"ifname": value})

with_vid(value)

Set the VLAN ID (returns new copy).

Source code in src/wrtkit/network.py 
47
48
49
def with_vid(self, value: int) -> "NetworkDevice":
    """Set the VLAN ID (returns new copy)."""
    return self.model_copy(update={"vid": value})

with_stp(value)

Enable or disable Spanning Tree Protocol for bridge devices (returns new copy).

Source code in src/wrtkit/network.py 
51
52
53
def with_stp(self, value: bool) -> "NetworkDevice":
    """Enable or disable Spanning Tree Protocol for bridge devices (returns new copy)."""
    return self.model_copy(update={"stp": value})

NetworkInterface

NetworkInterface

Bases: UCISection

Represents a network interface configuration.

Source code in src/wrtkit/network.py 
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
class NetworkInterface(UCISection):
    """Represents a network interface configuration."""

    device: Optional[str] = None
    proto: Optional[str] = None
    ipaddr: Optional[str] = None
    netmask: Optional[str] = None
    gateway: Optional[str] = None
    master: Optional[str] = None
    mtu: Optional[int] = None
    routing_algo: Optional[str] = None
    gw_mode: Optional[str] = None
    gw_bandwidth: Optional[str] = None
    hop_penalty: Optional[int] = None
    orig_interval: Optional[int] = None

    def __init__(self, interface_name: str, **data: Any) -> None:
        super().__init__(**data)
        self._package = "network"
        self._section = interface_name
        self._section_type = "interface"

    # Immutable builder methods (composable)
    def with_device(self, value: str) -> "NetworkInterface":
        """Set the device for this interface (returns new copy)."""
        return self.model_copy(update={"device": value})

    def with_proto(self, value: str) -> "NetworkInterface":
        """Set the protocol (e.g., 'static', 'dhcp', 'batadv') (returns new copy)."""
        return self.model_copy(update={"proto": value})

    def with_ipaddr(self, value: str) -> "NetworkInterface":
        """Set the IP address (returns new copy)."""
        return self.model_copy(update={"ipaddr": value})

    def with_netmask(self, value: str) -> "NetworkInterface":
        """Set the netmask (returns new copy)."""
        return self.model_copy(update={"netmask": value})

    def with_gateway(self, value: str) -> "NetworkInterface":
        """Set the gateway (returns new copy)."""
        return self.model_copy(update={"gateway": value})

    def with_master(self, value: str) -> "NetworkInterface":
        """Set the master interface (for batman-adv) (returns new copy)."""
        return self.model_copy(update={"master": value})

    def with_mtu(self, value: int) -> "NetworkInterface":
        """Set the MTU (returns new copy)."""
        return self.model_copy(update={"mtu": value})

    def with_routing_algo(self, value: str) -> "NetworkInterface":
        """Set the routing algorithm (for batman-adv) (returns new copy)."""
        return self.model_copy(update={"routing_algo": value})

    def with_gw_mode(self, value: str) -> "NetworkInterface":
        """Set the gateway mode (for batman-adv) (returns new copy)."""
        return self.model_copy(update={"gw_mode": value})

    def with_gw_bandwidth(self, value: str) -> "NetworkInterface":
        """Set the gateway bandwidth (for batman-adv) (returns new copy)."""
        return self.model_copy(update={"gw_bandwidth": value})

    def with_hop_penalty(self, value: int) -> "NetworkInterface":
        """Set the hop penalty (for batman-adv) (returns new copy)."""
        return self.model_copy(update={"hop_penalty": value})

    def with_orig_interval(self, value: int) -> "NetworkInterface":
        """Set the originator interval (for batman-adv) (returns new copy)."""
        return self.model_copy(update={"orig_interval": value})

    # Convenience builder methods for common configurations
    def with_static_ip(
        self, ip: str, netmask: str = "255.255.255.0", gateway: Optional[str] = None
    ) -> "NetworkInterface":
        """Configure interface with static IP (returns new copy)."""
        updates = {"proto": "static", "ipaddr": ip, "netmask": netmask}
        if gateway:
            updates["gateway"] = gateway
        return self.model_copy(update=updates)

    def with_dhcp(self) -> "NetworkInterface":
        """Configure interface to use DHCP (returns new copy)."""
        return self.model_copy(update={"proto": "dhcp"})

with_device(value)

Set the device for this interface (returns new copy).

Source code in src/wrtkit/network.py 
79
80
81
def with_device(self, value: str) -> "NetworkInterface":
    """Set the device for this interface (returns new copy)."""
    return self.model_copy(update={"device": value})

with_proto(value)

Set the protocol (e.g., 'static', 'dhcp', 'batadv') (returns new copy).

Source code in src/wrtkit/network.py 
83
84
85
def with_proto(self, value: str) -> "NetworkInterface":
    """Set the protocol (e.g., 'static', 'dhcp', 'batadv') (returns new copy)."""
    return self.model_copy(update={"proto": value})

with_ipaddr(value)

Set the IP address (returns new copy).

Source code in src/wrtkit/network.py 
87
88
89
def with_ipaddr(self, value: str) -> "NetworkInterface":
    """Set the IP address (returns new copy)."""
    return self.model_copy(update={"ipaddr": value})

with_netmask(value)

Set the netmask (returns new copy).

Source code in src/wrtkit/network.py 
91
92
93
def with_netmask(self, value: str) -> "NetworkInterface":
    """Set the netmask (returns new copy)."""
    return self.model_copy(update={"netmask": value})

with_gateway(value)

Set the gateway (returns new copy).

Source code in src/wrtkit/network.py 
95
96
97
def with_gateway(self, value: str) -> "NetworkInterface":
    """Set the gateway (returns new copy)."""
    return self.model_copy(update={"gateway": value})

with_master(value)

Set the master interface (for batman-adv) (returns new copy).

Source code in src/wrtkit/network.py 
 99
100
101
def with_master(self, value: str) -> "NetworkInterface":
    """Set the master interface (for batman-adv) (returns new copy)."""
    return self.model_copy(update={"master": value})

with_mtu(value)

Set the MTU (returns new copy).

Source code in src/wrtkit/network.py 
103
104
105
def with_mtu(self, value: int) -> "NetworkInterface":
    """Set the MTU (returns new copy)."""
    return self.model_copy(update={"mtu": value})

with_routing_algo(value)

Set the routing algorithm (for batman-adv) (returns new copy).

Source code in src/wrtkit/network.py 
107
108
109
def with_routing_algo(self, value: str) -> "NetworkInterface":
    """Set the routing algorithm (for batman-adv) (returns new copy)."""
    return self.model_copy(update={"routing_algo": value})

with_gw_mode(value)

Set the gateway mode (for batman-adv) (returns new copy).

Source code in src/wrtkit/network.py 
111
112
113
def with_gw_mode(self, value: str) -> "NetworkInterface":
    """Set the gateway mode (for batman-adv) (returns new copy)."""
    return self.model_copy(update={"gw_mode": value})

with_gw_bandwidth(value)

Set the gateway bandwidth (for batman-adv) (returns new copy).

Source code in src/wrtkit/network.py 
115
116
117
def with_gw_bandwidth(self, value: str) -> "NetworkInterface":
    """Set the gateway bandwidth (for batman-adv) (returns new copy)."""
    return self.model_copy(update={"gw_bandwidth": value})

with_hop_penalty(value)

Set the hop penalty (for batman-adv) (returns new copy).

Source code in src/wrtkit/network.py 
119
120
121
def with_hop_penalty(self, value: int) -> "NetworkInterface":
    """Set the hop penalty (for batman-adv) (returns new copy)."""
    return self.model_copy(update={"hop_penalty": value})

with_orig_interval(value)

Set the originator interval (for batman-adv) (returns new copy).

Source code in src/wrtkit/network.py 
123
124
125
def with_orig_interval(self, value: int) -> "NetworkInterface":
    """Set the originator interval (for batman-adv) (returns new copy)."""
    return self.model_copy(update={"orig_interval": value})

with_static_ip(ip, netmask='255.255.255.0', gateway=None)

Configure interface with static IP (returns new copy).

Source code in src/wrtkit/network.py 
128
129
130
131
132
133
134
135
def with_static_ip(
    self, ip: str, netmask: str = "255.255.255.0", gateway: Optional[str] = None
) -> "NetworkInterface":
    """Configure interface with static IP (returns new copy)."""
    updates = {"proto": "static", "ipaddr": ip, "netmask": netmask}
    if gateway:
        updates["gateway"] = gateway
    return self.model_copy(update=updates)

with_dhcp()

Configure interface to use DHCP (returns new copy).

Source code in src/wrtkit/network.py 
137
138
139
def with_dhcp(self) -> "NetworkInterface":
    """Configure interface to use DHCP (returns new copy)."""
    return self.model_copy(update={"proto": "dhcp"})

Usage Example

from wrtkit import UCIConfig
from wrtkit.network import NetworkDevice, NetworkInterface

config = UCIConfig()

# Create a bridge
device = NetworkDevice("br_lan")\
    .with_name("br-lan")\
    .with_type("bridge")\
    .with_port("lan1")\
    .with_port("lan2")
config.network.add_device(device)

# Create an interface
interface = NetworkInterface("lan")\
    .with_device("br-lan")\
    .with_static_ip("192.168.1.1", "255.255.255.0")
config.network.add_interface(interface)

See Also