Christian Manivong
4e171bff30
driver / standard (pull_request) Successful in 15s
driver / lint (pull_request) Successful in 15s
driver / types (pull_request) Successful in 55s
driver / test (3.10) (pull_request) Successful in 1m6s
driver / test (3.11) (pull_request) Successful in 59s
driver / test (3.12) (pull_request) Successful in 47s
driver / test (3.13) (pull_request) Successful in 44s
driver / lowest (pull_request) Successful in 24s
driver / security (pull_request) Successful in 52s
driver / build (pull_request) Successful in 29s
CI / driver (pull_request) Successful in 6m47s
driver / publish (pull_request) Skipped
- CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow of NAPALM/driver-standard. .github/ goes with publish.yml and tests.yml: PyPI Trusted Publishing never worked from Gitea. - requirements.txt goes: it only repeated the pyproject dependencies, with an older napalm-device-types floor and without paramiko. - LICENSE file (the README already pointed to it), CHANGELOG, py.typed, SPDX license string, links to git.netork.io (README included); napalm-device-types >=4.21.1, a dev extra with floors. - netaddr gets a true floor (>=0.7.10): unbounded, the lowest job installed a version without IPAddress, which napalm imports. - mypy strict for the package; napalm_tplink_jetstream.tplink_jetstream is exempt for now (96 errors), recorded in the quality baseline with its long functions and the 2000-line module. Coverage floor 36 % (measured 36.71 %).
86 lines
1.8 KiB
Markdown
86 lines
1.8 KiB
Markdown
# napalm-tplink-jetstream
|
|
|
|
NAPALM community driver for **TP-Link Jetstream** managed switches (T1500G, T1600G, T2600G, T3700G and compatible series).
|
|
|
|
## Tested devices
|
|
|
|
| Model | Series | Tested |
|
|
|---|---|---|
|
|
| TL-SG2210P | Jetstream Smart | ✅ |
|
|
| TL-SG3210 | Jetstream Smart | ✅ |
|
|
|
|
> More devices from the T1500G, T1600G, T2600G and T3700G series should work as well — contributions welcome.
|
|
|
|
## Requirements
|
|
|
|
| Dependency | Minimum version |
|
|
|---|---|
|
|
| Python | 3.10 |
|
|
| NAPALM | 4.0 |
|
|
| Netmiko | 4.0 |
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install napalm-tplink-jetstream
|
|
```
|
|
|
|
Or from source:
|
|
|
|
```bash
|
|
git clone https://git.netork.io/NAPALM/napalm-tplink-jetstream
|
|
cd napalm-tplink-jetstream
|
|
pip install -e .
|
|
```
|
|
|
|
## Quick start
|
|
|
|
```python
|
|
from napalm import get_network_driver
|
|
|
|
driver = get_network_driver("tplink_jetstream")
|
|
with driver("192.168.0.1", "admin", "admin") as device:
|
|
facts = device.get_facts()
|
|
print(facts)
|
|
```
|
|
|
|
## Implemented getters
|
|
|
|
| Getter | Status |
|
|
|---|---|
|
|
| `get_facts` | ✅ |
|
|
| `get_interfaces` | ✅ |
|
|
| `get_interfaces_ip` | ✅ |
|
|
| `get_config` | ✅ |
|
|
| `get_arp_table` | ✅ |
|
|
| `get_mac_address_table` | ✅ |
|
|
| `get_lldp_neighbors` | ✅ |
|
|
| `get_lldp_neighbors_detail` | ✅ |
|
|
| `get_vlans` | ✅ |
|
|
| `cli` | ✅ |
|
|
| `is_alive` | ✅ |
|
|
| `get_bgp_neighbors` | ❌ Not applicable |
|
|
| `load_replace_candidate` | ❌ Not applicable |
|
|
| `commit_config` | ❌ Not applicable |
|
|
|
|
## Optional arguments
|
|
|
|
| Argument | Default | Description |
|
|
|---|---|---|
|
|
| `port` | `22` | SSH port |
|
|
| `force_no_enable` | `False` | Skip `enable` after login |
|
|
| `canonical_int_fmt` | `False` | Use canonical interface names |
|
|
|
|
Any additional keyword arguments are forwarded to Netmiko.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
pip install -e ".[dev]"
|
|
pytest tests/
|
|
```
|
|
|
|
## License
|
|
|
|
Apache 2.0 — see [LICENSE](LICENSE).
|