docs(readme): describe netgear_plus beside netgear_smart #20

Merged
christianmanivong merged 1 commits from fix/bugs-2026-11-02 into main 2026-11-02 08:12:27 +00:00
Owner

What

The README describes netgear_plus beside netgear_smart.

  • A table of the two drivers (switches, transport) at the top.
  • "Tested devices" names the driver per model and adds the GS308EP for netgear_plus (from the module docstring).
  • "Implemented getters" has a column per driver with three marks: implemented, always empty without asking the switch, raises NotImplementedError / does not exist. Each netgear_plus cell is checked against napalm_netgear/netgear_plus.py (and the method resolution order, for what falls through to NAPALM's base class); its notes say what the implemented ones leave out (uptime 0.0, is_enabled always true, fixed MTU, string VLAN keys, counters other than octets and CRC are 0, no PoE power draw). Rows for the Plus-only methods (get_vlans_detail, set_poe_enabled, power_cycle_port, get_firmware_offer, get_snmp_config) and traceroute are added.
  • Three netgear_smart cells marked ❌ are now "always empty": get_ntp_stats, get_optics and get_ipv6_neighbors_table exist in netgear_smart.py and return []/{}. The other Smart cells are unchanged.
  • "Optional arguments" and "CLI notes" become "Connecting", split per driver. Plus: plain HTTP through py-netgear-plus, password-only login (username ignored), optional_args and timeout ignored, portN interface names, and the HEAD requests get_firmware_offer sends to Netgear's download server.
  • Requirements lists py-netgear-plus.

Why

The README introduced both drivers but documented only the SSH one, and marked as working what netgear_plus returns empty (MAC/ARP tables, users, SNMP, NTP) or refuses (cli, configuration methods).

Tests

Documentation only; no code changed. pytest 110 passed, ruff, mypy, napalm-standard check and ratchet unchanged and green.

Closes #19

## What The README describes `netgear_plus` beside `netgear_smart`. - A table of the two drivers (switches, transport) at the top. - "Tested devices" names the driver per model and adds the GS308EP for `netgear_plus` (from the module docstring). - "Implemented getters" has a column per driver with three marks: implemented, always empty without asking the switch, raises `NotImplementedError` / does not exist. Each `netgear_plus` cell is checked against `napalm_netgear/netgear_plus.py` (and the method resolution order, for what falls through to NAPALM's base class); its notes say what the implemented ones leave out (`uptime` 0.0, `is_enabled` always true, fixed MTU, string VLAN keys, counters other than octets and CRC are 0, no PoE power draw). Rows for the Plus-only methods (`get_vlans_detail`, `set_poe_enabled`, `power_cycle_port`, `get_firmware_offer`, `get_snmp_config`) and `traceroute` are added. - Three `netgear_smart` cells marked ❌ are now "always empty": `get_ntp_stats`, `get_optics` and `get_ipv6_neighbors_table` exist in `netgear_smart.py` and return `[]`/`{}`. The other Smart cells are unchanged. - "Optional arguments" and "CLI notes" become "Connecting", split per driver. Plus: plain HTTP through py-netgear-plus, password-only login (`username` ignored), `optional_args` and `timeout` ignored, `portN` interface names, and the HEAD requests `get_firmware_offer` sends to Netgear's download server. - Requirements lists py-netgear-plus. ## Why The README introduced both drivers but documented only the SSH one, and marked as working what `netgear_plus` returns empty (MAC/ARP tables, users, SNMP, NTP) or refuses (`cli`, configuration methods). ## Tests Documentation only; no code changed. pytest 110 passed, ruff, mypy, `napalm-standard check` and `ratchet` unchanged and green. Closes #19
christianmanivong added 1 commit 2026-11-02 07:43:40 +00:00
docs(readme): describe netgear_plus beside netgear_smart
driver / standard (pull_request) Successful in 21s
driver / lint (pull_request) Successful in 20s
driver / types (pull_request) Successful in 1m10s
driver / test (3.12) (pull_request) Successful in 1m16s
driver / lowest (pull_request) Successful in 34s
driver / test (3.13) (pull_request) Successful in 1m15s
driver / build (pull_request) Successful in 34s
driver / security (pull_request) Successful in 1m11s
CI / driver (pull_request) Successful in 3m8s
driver / publish (pull_request) Skipped
1ecf5da44b
The README introduced both drivers but its getter table, tested devices,
optional arguments and CLI notes described the SSH driver only, and
marked as working what netgear_plus returns empty or refuses with
NotImplementedError. The getter table now has a column per driver,
checked against both modules, and Plus has its own tested model and
connection notes.

Closes #19
christianmanivong merged commit 16a9d70660 into main 2026-11-02 08:12:27 +00:00
christianmanivong deleted branch fix/bugs-2026-11-02 2026-11-02 08:12:28 +00:00
Sign in to join this conversation.