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
This commit is contained in:
Christian Manivong committed 2026-10-13 00:31:29 +02:00
commit 83fba8646d
9 files changed
+488

No files matched your search

+7
View File
@@ -0,0 +1,7 @@
__pycache__/
*.py[cod]
*.egg-info/
build/
dist/
.venv/
.pytest_cache/
+191
View File
@@ -0,0 +1,191 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship made available under
the License, as indicated by a copyright notice that is included in
or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other transformations
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean, as submitted to the Licensor for inclusion
in the Work by the copyright owner or by an individual or Legal Entity
authorized to submit on behalf of the copyright owner. For the purposes
of this definition, "submitted" means any form of electronic, verbal,
or written communication sent to the Licensor or its representatives,
including but not limited to communication on electronic mailing lists,
source code control systems, and issue tracking systems that are managed
by, or on behalf of, the Licensor for the purpose of discussing and
improving the Work, but excluding communication that is conspicuously
marked or designated in writing by the copyright owner as "Not a
Contribution."
"Contributor" shall mean Licensor and any Legal Entity on behalf of
whom a Contribution has been received by the Licensor and incorporated
within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by the combined Contribution(s) and the Work
to which such Contribution(s) was submitted. If You institute patent
litigation against any entity (including a cross-claim or counterclaim
in a lawsuit) alleging that the Work or any Contribution embodied
within the Work constitutes direct or contributory patent infringement,
then any patent licenses granted to You under this License for that
Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or Derivative
Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, You must include a readable copy of the
attribution notices contained within such NOTICE file, in
at least one of the following places: within a NOTICE text file
distributed as part of the Derivative Works; within the Source
form or documentation, if provided along with the Derivative
Works; or, within a display generated by the Derivative Works,
if and wherever such third-party notices normally appear. The
contents of the NOTICE file are for informational purposes only
and do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own license statement for Your modifications and
may provide additional grant of rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Work,
and to permit persons to whom the Work is furnished to do so,
subject to the following conditions:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any conditions of TITLE,
MERCHANTIBILITY, or FITNESS FOR A PARTICULAR PURPOSE.
See the License for the specific language governing permissions and
limitations under the License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or exemplary damages of any character arising as a
result of this License or out of the use or inability to use the
Work (even if such Contributor has been advised of the possibility
of such damages).
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may offer only
conditions consistent with this License, subject to the following
additional conditions:
(a) You may offer additional warranty, indemnity, or other liability
terms and conditions; and
(b) You may offer support for the Work in return for a fee.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format in question. It may also be
possible to make it available with a creative commons license.
Copyright 2026 Christian Manivong
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+60
View File
@@ -0,0 +1,60 @@
# 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, GS-2426 switches | SSH CLI, menu sections | `SwitchDriver` | **First target.** See [docs/lcos-sx3.md](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](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.
## 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).
+52
View File
@@ -0,0 +1,52 @@
# Fixtures to capture
Record raw output from a real device the first time one is connected. Store it under
`tests/fixtures/<model>-<firmware>/` (e.g. `gs-2310p-plus-3.34/`), one file per command,
plus a `COMMANDS.txt` that lists the command, the section it ran in, and the device state
that matters (links up/down, PoE consumers, LLDP neighbours present or not).
Scrub before committing: serial numbers, public IPs, SNMP communities, hostnames that
identify a site.
## LCOS SX 3 (GS-23xx)
Session basics:
- [ ] login banner and the first prompt after SSH login
- [ ] `?` at the top level (list of sections)
- [ ] `?` inside each section listed below
- [ ] the error text of an invalid command and of an invalid parameter
Per section:
- [ ] `system` → `show`
- [ ] `firmware` → `show`
- [ ] `port` → `show configuration`
- [ ] `port` → `show status` (with at least one link up and one down)
- [ ] `port` → `show simple-counter`
- [ ] `port` → `show detail-counter 1`
- [ ] `port` → `show sfp <sfp-port>` (with and without a module)
- [ ] `ip` → `show`
- [ ] `ipv6` → `show current`
- [ ] `fdb` → `show mac-table`
- [ ] `fdb` → `show static-mac`
- [ ] `lldp` → `show config`
- [ ] `lldp` → `show info <port-list>` (with a neighbour, e.g. another switch or a router)
- [ ] `vlan` → `show vlan`
- [ ] `vlan` → `show port-config`
- [ ] `vlan` → `show port-status static`
- [ ] `thermal` → `show`
- [ ] `snmp` → `show snmp`
- [ ] `snmp` → `show community`
- [ ] `time` → `show ntp`
- [ ] `poe` → `show config` (PoE models only)
- [ ] `poe` → `show status` (with a powered device attached)
- [ ] `aggregation` → `show`
- [ ] `lacp` → `show status`
- [ ] `stp` → `show status`
- [ ] `syslog` → `show log`
Configuration:
- [ ] `config-file` → `export` to a TFTP server once (the XML file itself)
- [ ] whether the web UI offers a configuration download, and how (URL, auth)
+19
View File
@@ -0,0 +1,19 @@
# LCOS FX (Unified Firewalls)
Not started. No test device.
## What is known
- LCOS FX runs on LANCOM's (Rohde & Schwarz) Unified Firewalls.
- It has a **REST API**. The device's web client links its Swagger documentation under
Help → REST API Documentation. Requests need an auth token from the login endpoint
(category "Authentication").
- LANCOM's API documentation database publishes the API per firmware version
(11.1.1–11.2.1 at the time of writing), including change lists between versions.
- This makes LCOS FX the best-documented family: a REST client can be written from the spec
without a device. Tests still need recorded responses.
- Open: whether a used firewall is usable without an active license. Check before buying.
## Role
`FirewallDriver` (NAT/VPN, firewall rules, DHCP server, health metrics, package management).
+16
View File
@@ -0,0 +1,16 @@
# LCOS LX (Wi-Fi 6 access points)
Not started. No test device.
## What is known
- LCOS LX runs on LANCOM's newer (Wi-Fi 6 and later) access points. Older access points
run LCOS instead and are LCOS devices for a driver, see [lcos.md](lcos.md). Which OS a
given model runs is in the lifecycle tables (not yet checked per model).
- Access over SSH to a CLI that navigates a menu tree, like LCOS.
- LANCOM publishes an **LCOS LX Menu Reference** per release (PDFs up to LX 7.10). It
documents the tree but not the exact output layout.
## Role
`AccessPointDriver` (MAC ACLs, updates, service control, health metrics, interface filter).
+87
View File
@@ -0,0 +1,87 @@
# LCOS SX 3 (GS-23xx, GS-2426)
First target of this package.
## Devices
From LANCOM's lifecycle tables (checked 2026-10-13):
| Model | Firmware | End of sale | Last major release | End of life | Successor |
|---|---|---|---|---|---|
| GS-2310 | LCOS SX 3.34 | 2025-04 | 2027-04 | 2030-04 | GS-2412 |
| GS-2310P+ | LCOS SX 3.34 | 2025-04 | 2027-04 | 2030-04 | GS-2412P |
| GS-2326 / GS-2326+ / GS-2326P+ | LCOS SX 3.34 | 2025-04 | 2027-04 | 2030-04 | GS-2426(P) |
| GS-2426 / GS-2426P | LCOS SX 3.34 | 2025-04 | 2027-04 | 2030-04 | R&S GS-2426(P) |
| GS-2310P | LCOS SX 3.34 RU4 | 2017-06 | — | 2022-06 | — |
| GS-2352 / GS-2352P | LCOS SX 3.34 SU9 | 2019-09 / 2020-01 | — | 2024-09 / 2025-01 | — |
So a large installed base will be on SX 3.34 until at least 2030. All models share one CLI;
they differ in port count and PoE.
## Documentation
The **GS-2300 series CLI Reference** (LANCOM, 2018, 371 pages) documents every command
section with syntax, parameters and an example including output. Its examples come from
firmware 2.x (e.g. `GS-2326P (standalone) v2.50`). Whether 3.34 prints the same layout is
open until real output is captured. Parsers must be written and tested against recorded 3.34
output, not against the manual.
## CLI model
- Login over SSH (or the serial console, 115200 8N1). Factory default user/password: `admin`/`admin`.
- The top-level prompt is `<hostname>#`. Entering a section name (`system`, `port`, `vlan`,
`fdb`, …) switches into that section; the prompt shows it in brackets:
`<hostname>(vlan)#`.
- `show …` runs inside a section. Two-level sections (e.g. `acl` → `ace`, `qos` → `qce`) end
the second level with `end`.
- `?` or `help` lists the commands available in the current section.
This is not the Cisco-style CLI that netmiko's `lancom_lcossx4`/`lancom_lcossx5` expect.
The driver needs its own transport, either a netmiko class or an exec/shell channel from
napalm-device-types, that enters a section, runs `show`, and returns to the top level.
## Getter map
Chapter numbers refer to the GS-2300 CLI Reference.
| Getter | Section → command | Chapter |
|---|---|---|
| `get_facts` | `system` → `show` (model, description, hostname, uptime, firmware, serial, MAC, management IP) | 52 |
| | `firmware` → `show` (active and alternate image) | 20 |
| `get_interfaces` | `port` → `show configuration`, `show status [<port-list>]` | 39 |
| `get_interfaces_counters` | `port` → `show simple-counter`, `show detail-counter <port>` | 39 |
| `get_interfaces_ip` | `ip` → `show` (configured vs. current IPv4, mask, gateway, management VLAN) | 25 |
| | `ipv6` → `show current` | 27 |
| `get_mac_address_table` | `fdb` → `show mac-table [port <port-list>] [vid <1-4094>]`, `show static-mac` | 19 |
| `get_lldp_neighbors`, `get_lldp_neighbors_detail` | `lldp` → `show info <port-list>` | 29 |
| `get_vlans` | `vlan` → `show vlan`, `show port-config`, `show port-status static` | 57 |
| `get_environment` | `system` → `show` (CPU load 100 ms/1 s/10 s, RAM size) | 52 |
| | `thermal` → `show` (chip temperature per port) | 53 |
| `get_snmp_information` | `snmp` → `show snmp`, `show community` | 48 |
| `get_ntp_servers`, `get_ntp_stats` | `time` → `show ntp` | 54 |
| PoE (role method) | `poe` → `show config`, `show status` | 38 |
| Link aggregation | `aggregation` → `show`; `lacp` → `show status` | 7, 28 |
| Spanning tree | `stp` → `show status` | 50 |
| Logs | `syslog` → `show log [<0-7>]` | 51 |
| `get_config` | **open**, see below | 11 |
`get_arp_table` does not apply: the GS-23xx is a layer-2 switch with one management IP.
## Open questions
1. **`get_config`.** `config-file` only offers `export <ip-address> [<filename>]` and
`import`, which push and pull an XML file to and from a **TFTP server**. There is no
`show running-config` in the reference. Options to check on a real device: the web UI's
configuration download over HTTPS, an SNMP path, or a short-lived TFTP receiver on the
polling side. The TFTP receiver is the least attractive, because it needs an inbound
port from the switch to the poller.
2. **3.34 vs. 2.x output.** Does 3.34 print the tables the way the manual's 2.x examples do?
3. **Shared parsers with SX 4/5.** Probably not, because the CLI style differs. Decide once
both are seen.
4. **Write operations.** Port enable/disable, VLAN membership and PoE on/off are the
candidates for netOrk. Each is one command inside a section followed by `save`. Out of
scope until reading works.
## Fixtures to capture
See [fixtures.md](fixtures.md).
+26
View File
@@ -0,0 +1,26 @@
# LCOS (routers, gateways)
Not started. No test device.
## What is known
- LCOS is the OS of LANCOM's routers and VPN gateways (e.g. the 17xx series) and of older
access points. It is likely the LANCOM OS most often met in German SMB networks.
- Access over SSH (also Telnet) to a CLI that navigates one tree (commands such as `ls`,
`cd`, `set`; exact set to be confirmed against the reference manual). The tree has a
**Setup** branch (configuration) and a **Status** branch (runtime state).
- The **LCOS Menu Reference** documents every node of that tree, per LCOS version. That is
enough to find the paths for each getter, e.g. the status tables for interfaces, ARP,
DHCP leases, VPN peers and firewall sessions. It does not show the column layout of
`ls` output, which needs recorded output.
- `readscript` prints the configuration as a script of `set` commands, which fits
`get_config`. Oxidized uses `sysinfo` and `readscript`.
- No REST API for LCOS was found.
- Check that a used device still gets LCOS 10.x before buying. Reportedly the LCOS reset
button can be configured to be ignored (not verified), so ask the seller to confirm a
factory reset is possible.
## Role
`FirewallDriver` for the business routers (NAT/VPN, firewall rules, DHCP server, health
metrics), `ResidentialGatewayDriver` if a model is used as a plain internet gateway.
+30
View File
@@ -0,0 +1,30 @@
# References
Collected 2026-10-13.
## LANCOM documentation
| Family | Document | URL |
|---|---|---|
| LCOS SX 3 | GS-2300 series CLI Reference (2018) | https://www.lancom-systems.com/download/documentation/CLI-Reference/MA_Switch-CLI-Reference_EN.pdf |
| LCOS SX 5 | CLI Reference 5.20 (online) | https://www.lancom-systems.de/docs/LCOS-SX/CLI-Reference/5.20/EN/V5/6_Switching-Commands.html |
| LCOS | Reference Manual (10.94) | https://www.lancom-systems.com/docs/LCOS/Refmanual/EN/ |
| LCOS | Menu Reference | https://lancom-systems.de/docs/LCOS/Menuref/EN |
| LCOS LX | Menu Reference 7.10 | https://ftp.lancom.de/Documentation/LCOS-LX/Menu%20Reference/MA_LCOS-LX-710-Menu-Reference_EN.pdf |
| LCOS FX | REST API documentation | https://www.lancom-systems.de/docs/LCOS-FX/Refmanual/EN/topics/UI_WCC_Header_Rest-API.html |
| all | API documentation database | https://knowledgebase.lancom-systems.de/x/GgDJE |
| LMC | Management Cloud API | https://www.lancom-systems.de/docs/lmc/api/ |
| all | Lifecycle product tables | https://rs-nc.rohde-schwarz.com/en/products/firmware/lifecycle-management/product-tables/ |
| LCOS SX | Release notes (GS-23xx) | https://ftp.lancom.de/Documentation/Release-Notes/LCOS%20SX/ |
## Prior art
| Project | What | URL |
|---|---|---|
| netmiko | `lancom_lcossx4`, `lancom_lcossx5` SSH classes | https://github.com/ktbyers/netmiko/tree/develop/netmiko/lancom |
| Oxidized | LCOS config backup model | https://github.com/ytti/oxidized/blob/master/lib/oxidized/model/lancom.rb |
## netOrk
- NetOrk/netork#1094: the originating issue
- napalm-device-types (role bases): https://git.netork.io/NAPALM/napalm-device-types