Files
napalm-zyxel/README.md
T
Christian Manivong e5ce4e32b1
driver / standard (pull_request) Successful in 19s
driver / lint (pull_request) Successful in 19s
driver / types (pull_request) Successful in 1m5s
driver / test (3.12) (pull_request) Successful in 1m3s
driver / lowest (pull_request) Successful in 34s
driver / test (3.13) (pull_request) Successful in 1m9s
driver / build (pull_request) Successful in 31s
driver / security (pull_request) Successful in 1m12s
CI / driver (pull_request) Successful in 2m53s
driver / publish (pull_request) Skipped
fix(session): report is_alive from the driver's own session
is_alive() opened a TCP connection to the gateway whether or not the
driver was opened, and after close() too. NAPALM's __del__ asks it of
every collected driver, so each one connected once more and could stall
for up to five seconds. Without an open session it now answers False
and connects nowhere; with one, it reports whether the gateway still
answers on its port.

Closes #19
2026-11-02 10:58:14 +01:00

71 lines
2.4 KiB
Markdown

# napalm-zyxel
NAPALM driver for Zyxel VMG series residential gateways (VMG4005-B50A and similar), built on
[napalm-device-types](https://git.netork.io/NAPALM/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.
```python
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 |
| `get_interfaces`, `get_interfaces_ip` | basic device information (WAN, LAN, Wi-Fi) |
| `get_arp_table` | derived from the active LAN hosts |
| `get_wan_status` | basic device information |
| `get_hosts` | DAL `LAN_HOSTS`, else the DHCP page |
| `get_port_forwards`, `get_nat_translations` | DAL `NAT_PORTMAP`, 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` |
## Not supported
Configuration changes (`load_merge_candidate` and `load_replace_candidate` raise
`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](https://git.netork.io/NAPALM/driver-standard/src/branch/main/STANDARDS.md).
```bash
python -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/pytest --cov
```
## License
Apache-2.0