christianmanivong 06ece68de6
driver / standard (push) Successful in 14s
driver / lint (push) Successful in 13s
driver / types (push) Successful in 50s
driver / test (3.12) (push) Successful in 52s
driver / test (3.13) (push) Successful in 47s
driver / lowest (push) Successful in 23s
driver / build (push) Successful in 26s
driver / security (push) Successful in 1m6s
CI / driver (push) Successful in 2m25s
driver / publish (push) Skipped
Merge pull request 'fix(driver): load_replace_candidate is None, not a stub that raises (NetOrk/netork#2503)' (#33) from fix/no-config-replace into main
2026-11-13 21:39:07 +00:00

napalm-zyxel

NAPALM driver for Zyxel VMG series residential gateways (VMG4005-B50A and similar), built on napalm-device-types (ResidentialGatewayDriver).

Tested against

Model Firmware
not recorded yet not recorded yet

Connection

The gateway's web API (the Zyxel DAL protocol) over HTTP on port 80, or HTTPS on port 443 with use_tls. The driver fetches the gateway's RSA public key, sends a fresh AES key encrypted with it, and logs in with the web interface account; every request and response after that is AES-encrypted.

from napalm import get_network_driver

driver = get_network_driver("zyxel")
with driver("192.0.2.1", "admin", "secret", optional_args={"use_tls": True}) as device:
    print(device.get_facts())
Optional argument Default Meaning
use_tls False HTTPS instead of HTTP
port 443 with use_tls, else 80 port of the web interface
verify False verify the gateway's TLS certificate

Supported

Getter / action Source
get_facts basic device information (model, firmware), the System page (host name, domain), DAL cardpage_status (serial number, uptime, interfaces)
get_interfaces, get_interfaces_ip basic device information (WAN, LAN, Wi-Fi)
get_arp_table derived from the active LAN hosts
get_wan_status DAL cardpage_status: the DSL line and the WAN interfaces
get_hosts DAL lanhosts, else the DHCP page
get_port_forwards, get_nat_translations DAL nat, else the status page
get_wireless_clients, get_ssids, get_radio_status DAL, else the wireless page
get_diagnostics DAL DIAGNOSTICS
is_alive the session is open and the web port answers; without a session False, no connection
reboot_host DAL REBOOT
restart_wifi DAL WIFI_RESTART

Every DAL answer is read the way the gateway sends it: AES-encrypted, with its data under Object. The Wi-Fi getters read WIFI_CLIENTS, WIFI_SSIDS and WIFI_RADIO, names that have not been checked against a gateway with Wi-Fi yet; a VMG4005-B50A has no Wi-Fi.

Not supported

Configuration changes (load_replace_candidate is None, load_merge_candidate raises NotImplementedError), get_config, LLDP, BGP, NTP, SNMP, users, routes, MAC address table, optics, environment, traceroute, VPN tunnels and the CLI.

ping returns an error and SUPPORTS_PING is False: the DAL accepts a PINGTEST request but does not report whether the target answered.

Development

The rules are in STANDARDS.md.

python -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/pytest --cov

License

Apache-2.0

S
Description
No description provided
Readme
423 KiB
0 Stars 1 Watchers 0 Forks
2026-10-23 13:01:34 +00:00
Languages
Python 100%