Christian Manivong 83fba8646d docs: collect what is known for LANCOM drivers
No code yet and no test device. The README maps LANCOM's four operating
systems (LCOS, LCOS SX, LCOS LX, LCOS FX) to planned entry points and
napalm-device-types role bases. docs/lcos-sx3.md covers the first target
(GS-23xx on LCOS SX 3.34): CLI model, getter-to-command map from the
GS-2300 CLI reference, and the open get_config question (TFTP-only
export). docs/fixtures.md lists the output to record from a real device.

Refs NetOrk/netork#1094
2026-10-13 00:31:29 +02:00

napalm-lancom

NAPALM drivers for LANCOM Systems devices, built on napalm-device-types. Written for netOrk (NetOrk/netork#1094).

Status: planning. There is no code yet and no test device. This repository holds what is known so far, so the driver can start as soon as a device is available.

One vendor, four operating systems

LANCOM does not run one OS across its portfolio. Each family needs its own transport and parsers, so this package will provide one napalm.drivers entry point per family (like napalm-vmware and napalm-netgear do). Shared code stays in a common base.

Entry point (planned) OS Devices Interface Role base Notes
lancom_sx3 LCOS SX 3 GS-23xx, GS-2426 switches SSH CLI, menu sections SwitchDriver First target. See docs/lcos-sx3.md
lancom_sx LCOS SX 4/5 newer GS/XS switches (models per lifecycle table) SSH CLI, Cisco-like SwitchDriver netmiko has lancom_lcossx4/lancom_lcossx5
lancom_lcos LCOS routers, gateways, older APs SSH CLI over the menu tree FirewallDriver or ResidentialGatewayDriver See docs/lcos.md
lancom_lx LCOS LX Wi-Fi 6 access points SSH CLI over the menu tree AccessPointDriver See docs/lcos-lx.md
lancom_fx LCOS FX Unified Firewalls REST API FirewallDriver See docs/lcos-fx.md

Entry point names are provisional and are fixed when the first family is implemented.

The order follows hardware availability: the first family implemented is the one a test device exists for. Candidates so far are a GS-2326+ and a GS-2310P+, both LCOS SX 3.34.

Prior art

  • netmiko: netmiko/lancom/lancom_lcossx4.py and lancom_lcossx5.py (SSH, Cisco-style enable mode). There is no class for LCOS SX 3.
  • Oxidized: lib/oxidized/model/lancom.rb backs up LCOS routers with sysinfo and readscript over SSH/Telnet (tested on a 1781EF+, LCOS 10.32).
  • LANCOM Management Cloud (LMC) has a documented Swagger API. That is a path for a cloud integration, not for a local driver. netOrk talks to devices directly.
  • There is no existing NAPALM driver for LANCOM: none in napalm-automation-community, none found elsewhere on GitHub (checked 2026-10-13).

Conventions

These follow the other drivers in the NAPALM organisation:

  • Role bases declare, they never implement (see the napalm-device-types README). Generic logic goes into napalm-device-types, vendor mechanics stay here.
  • Parsing lives in pure functions, tested on output recorded from real devices under tests/fixtures/<device>-<firmware>/, with a COMMANDS.txt listing what produced each file.
  • Example output from LANCOM's manuals is not copied into this repository. It is LANCOM's copyrighted material and comes from older firmware. The docs point to the chapter instead.
  • napalm-device-types is not on PyPI: install it from git+https://git.netork.io/NAPALM/napalm-device-types.git before this package.

References

See docs/references.md.

License

Apache License 2.0, see LICENSE.

S
Description
NAPALM drivers for LANCOM Systems devices (LCOS, LCOS SX, LCOS LX, LCOS FX)
Readme
54 KiB
0 Stars 1 Watchers 0 Forks