docs: add LCOS SX 4 (GS-3152X) as first-target candidate

The GS-3152X runs LCOS SX 4.30 (end of life 2028-08). netmiko already has
a transport for it, show running-config exists (SX 3 can only export its
config to TFTP), and its Cisco-like CLI is closer to the current SX 5
switches. docs/lcos-sx4.md maps the getters to commands from the SX 4.30
CLI reference; fixtures.md gets the matching capture list.

Refs NetOrk/netork#1094
This commit is contained in:
Christian Manivong committed 2026-10-13 00:35:11 +02:00
1 parent 83fba8646d
commit 4c4805bae3
5 files changed
+131 -4

No files matched your search

+6 -3
View File
@@ -15,8 +15,8 @@ parsers, so this package will provide one `napalm.drivers` entry point per famil
| 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_sx3` | LCOS SX 3 | GS-23xx, GS-2426 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-3xxx (SX 4), newer GS/XS switches (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) |
@@ -24,7 +24,10 @@ parsers, so this package will provide one `napalm.drivers` entry point per famil
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.
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
+42
View File
@@ -50,3 +50,45 @@ 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)
## LCOS SX 4 (GS-3xxx)
Session basics:
- [ ] login banner and the first prompt after SSH login
- [ ] `show ?` (list of show commands on this firmware)
- [ ] the error text of an invalid command
Commands:
- [ ] `show version`
- [ ] `show system cpu status`
- [ ] `show interface * status`
- [ ] `show interface * description`
- [ ] `show interface * capabilities`
- [ ] `show interface * statistics`
- [ ] `show interface * switchport`
- [ ] `show interface * transceiver` (with and without an SFP+ module)
- [ ] `show interface vlan`
- [ ] `show ip interface brief`
- [ ] `show ipv6 interface brief`
- [ ] `show ip arp`
- [ ] `show ip route`
- [ ] `show mac address-table`
- [ ] `show lldp neighbors` (with a neighbour)
- [ ] `show vlan`
- [ ] `show process load`
- [ ] `show thermal-protect`
- [ ] `show green-ethernet fan`
- [ ] `show snmp`
- [ ] `show snmp community`
- [ ] `show ntp status`
- [ ] `show users`
- [ ] `show ip dhcp server binding`, `show ip dhcp pool` (if the DHCP server is used)
- [ ] `show poe`, `show poe interface` (PoE models only)
- [ ] `show aggregation`, `show lacp`
- [ ] `show spanning-tree`
- [ ] `show logging`
- [ ] `show licenses`
- [ ] `show running-config`
- [ ] `show running-config all-defaults`
+2 -1
View File
@@ -1,6 +1,7 @@
# LCOS SX 3 (GS-23xx, GS-2426)
First target of this package.
First-target candidate, alongside [LCOS SX 4](lcos-sx4.md). SX 4 is preferred if a device is
available; SX 3 covers the installed base until 2030.
## Devices
+79
View File
@@ -0,0 +1,79 @@
# LCOS SX 4 (GS-3xxx)
Candidate first target alongside [LCOS SX 3](lcos-sx3.md), because SX 4 is closer to the
switches LANCOM sells today.
## Devices
From LANCOM's lifecycle tables (checked 2026-10-13):
| Model | Firmware | End of sale | End of life | Successor |
|---|---|---|---|---|
| GS-3152X | LCOS SX 4.30 | 2023-08 | 2028-08 | GS-3628X |
| GS-3152XP | LCOS SX 4.30 | 2023-03 | 2028-03 | GS-3652XP |
| GS-3152XSP | LCOS SX 4.30 | 2023-08 | 2028-08 | GS-3652XUP |
All three are past end of sale with no further major releases. The GS-3152X has 48 ×
1 GbE, 4 × SFP+ (10 GbE) and "layer 3 lite" (static routing, DHCP server). Other GS-3xxx
models and their SX versions: see the lifecycle tables.
## Why SX 4 over SX 3
- **Transport exists.** netmiko ships `lancom_lcossx4` (`LancomLCOSSX4SSH`, based on
`CiscoSSHConnection`, `logout` to exit, `copy running-config startup-config` to save).
- **Cisco-like CLI**, like SX 5. Parsers written for SX 4 have a fair chance to carry over
to the current SX 5 switches. SX 3's menu-sectioned CLI does not.
- **`show running-config` exists**, so `get_config` does not need the TFTP export that
SX 3 forces.
- **Layer 3 lite** adds ARP, routes and DHCP server leases to what a driver can read.
Trade-offs: SX 4 reaches end of life in 2028-08, two years before SX 3. A 48-port switch is
large for a desk; check fan noise and power draw before buying (not checked).
## Documentation
**LCOS SX 4.30 CLI Reference** (LANCOM, 2024-05, 250 pages; a 4.20 edition exists too).
It lists every command with syntax, parameters and 207 examples with output. Examples are
from lab devices (e.g. `MAC Address : 02-00-c1-…`, uptime from 1970-01-01), so parsers
must still be tested on recorded output.
Commands accept output modifiers `| begin|exclude|include <line>`. Ports are addressed as
`GigabitEthernet <port_type_list>` (e.g. `1/1-48`) and `10GigabitEthernet <port_type_list>`
for the SFP+ ports.
## Getter map
| Getter | Command |
|---|---|
| `get_facts` | `show version` (MAC, system name/contact/location, uptime, bootloader, active image) |
| `get_interfaces` | `show interface * status`, `show interface * description`, `show interface * capabilities` |
| `get_interfaces_counters` | `show interface * statistics` (optional `bytes`, `discards`, `errors`, `packets`, `up`/`down` filters) |
| `get_interfaces_ip` | `show ip interface brief`, `show ipv6 interface brief`, `show interface vlan` |
| `get_arp_table` | `show ip arp` |
| `get_route_to` / routes | `show ip route` |
| `get_mac_address_table` | `show mac address-table` (also `… vlan`, `… interface`, `… count`) |
| `get_lldp_neighbors`, `get_lldp_neighbors_detail` | `show lldp neighbors` |
| `get_vlans` | `show vlan`, `show interface * switchport` |
| `get_environment` | `show process load` (CPU), `show thermal-protect`, `show green-ethernet fan`, `show system cpu status` |
| `get_snmp_information` | `show snmp`, `show snmp community` |
| `get_ntp_servers`, `get_ntp_stats` | `show ntp status` |
| `get_users` | user accounts from `show running-config`; `show users` lists terminal sessions |
| `get_config` | `show running-config` (`all-defaults` for the full set); startup config to be checked |
| DHCP server (role method) | `show ip dhcp server binding`, `show ip dhcp pool` |
| PoE (role method) | `show poe`, `show poe interface` |
| Link aggregation | `show aggregation`, `show lacp` |
| Spanning tree | `show spanning-tree` |
| Logs | `show logging` |
| Transceivers | `show interface * transceiver` |
| Licenses | `show licenses` |
## Open questions
1. Numbering of the SFP+ ports on the GS-3152X (`10GigabitEthernet 1/1-4` or continuing
after the copper ports).
2. Whether `show running-config` is complete enough to restore from, or whether the startup
config differs in format.
3. How close SX 5 output is. The SX 5.20 reference is online, so this can be compared
before buying an SX 5 device.
4. Role base: `SwitchDriver`. Layer 3 lite (DHCP server, static routes) may justify more
mixins later, decided in napalm-device-types, not here.
+2
View File
@@ -7,6 +7,8 @@ Collected 2026-10-13.
| 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 4 | CLI Reference 4.30 (2024-05) | https://ftp.lancom.de/Documentation/LCOS-SX/MA_LCOS-SX-4.30-CLI-Reference_EN.pdf |
| LCOS SX 4 | CLI Reference 4.20 (2023-08) | https://ftp.lancom.de/Documentation/LCOS-SX/MA_LCOS-SX-4.20-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 |