Files
Christian Manivong 57dd646e8f docs: GS-2400 series runs LCOS SX 4, not SX 3
LANCOM's LCOS SX release page assigns SX 3.34 only to GS-2326P+,
GS-2326+, GS-2310P+, GS-2310 and GS-2328F, and SX 4.30 to the
XS/GS/IGS-3000 and GS-2400 series. The GS-2426 was listed under SX 3 from
a misread lifecycle table. Move it, add GS-2412, GS-3252P and GS-3528XP
to the SX 4 table, and record which series run SX 5.

Refs NetOrk/netork#1094
2026-10-13 01:01:33 +02:00

64 lines
3.4 KiB
Markdown

# napalm-lancom
NAPALM drivers for **LANCOM Systems** devices, built on
[napalm-device-types](https://git.netork.io/NAPALM/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 switches | SSH CLI, menu sections | `SwitchDriver` | First-target candidate. See [docs/lcos-sx3.md](docs/lcos-sx3.md) |
| `lancom_sx` | LCOS SX 4/5 | GS-24xx, GS/XS/IGS-3xxx (SX 4); XS-5000/6000, XS/GS-4500, CS, YS (SX 5) | SSH CLI, Cisco-like | `SwitchDriver` | First-target candidate. netmiko has `lancom_lcossx4`/`lancom_lcossx5`. See [docs/lcos-sx4.md](docs/lcos-sx4.md) |
| `lancom_lcos` | LCOS | routers, gateways, older APs | SSH CLI over the menu tree | `FirewallDriver` or `ResidentialGatewayDriver` | See [docs/lcos.md](docs/lcos.md) |
| `lancom_lx` | LCOS LX | Wi-Fi 6 access points | SSH CLI over the menu tree | `AccessPointDriver` | See [docs/lcos-lx.md](docs/lcos-lx.md) |
| `lancom_fx` | LCOS FX | Unified Firewalls | REST API | `FirewallDriver` | See [docs/lcos-fx.md](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)
and a GS-3152X (LCOS SX 4.30). SX 4 is preferred if available: netmiko already covers the
transport, `show running-config` exists, and its Cisco-like CLI is closer to the current
SX 5 switches.
## 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](docs/references.md).
## License
Apache License 2.0, see [LICENSE](LICENSE).