napalm-srlinux 2.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- napalm_srlinux-2.0.0/AUTHORS +7 -0
- napalm_srlinux-2.0.0/LICENSE +201 -0
- napalm_srlinux-2.0.0/PKG-INFO +153 -0
- napalm_srlinux-2.0.0/README.md +128 -0
- napalm_srlinux-2.0.0/napalm_srlinux/__init__.py +19 -0
- napalm_srlinux-2.0.0/napalm_srlinux/device.py +259 -0
- napalm_srlinux-2.0.0/napalm_srlinux/helpers.py +191 -0
- napalm_srlinux-2.0.0/napalm_srlinux/srlinux.py +1606 -0
- napalm_srlinux-2.0.0/napalm_srlinux.egg-info/PKG-INFO +153 -0
- napalm_srlinux-2.0.0/napalm_srlinux.egg-info/SOURCES.txt +13 -0
- napalm_srlinux-2.0.0/napalm_srlinux.egg-info/dependency_links.txt +1 -0
- napalm_srlinux-2.0.0/napalm_srlinux.egg-info/requires.txt +2 -0
- napalm_srlinux-2.0.0/napalm_srlinux.egg-info/top_level.txt +1 -0
- napalm_srlinux-2.0.0/pyproject.toml +50 -0
- napalm_srlinux-2.0.0/setup.cfg +4 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Jonathon Lundstrom <jonathon.lundstrom@nokia.com>
|
|
2
|
+
Mohammad Zamman <mohammad.f.zamman@nokia.com>
|
|
3
|
+
Jose Valente <jose.valente@nokia.com>
|
|
4
|
+
Syed Shekupillai <syed.shekupillai@nokia.com>
|
|
5
|
+
Ashna Shah <ashna.shah@nokia.com>
|
|
6
|
+
Wim Henderickx <wim.henderickx@nokia.com>
|
|
7
|
+
Jeroen van Bemmel <jeroen.van_bemmel@nokia.com>
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: napalm-srlinux
|
|
3
|
+
Version: 2.0.0
|
|
4
|
+
Summary: NAPALM driver for Nokia SR Linux (JSON-RPC)
|
|
5
|
+
Author-email: Jose Valente <jose.valente@nokia.com>, Jeroen van Bemmel <jeroen.van_bemmel@nokia.com>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/napalm-automation-community/napalm-srlinux
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/napalm-automation-community/napalm-srlinux/issues
|
|
9
|
+
Classifier: Topic :: System :: Networking
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
15
|
+
Classifier: Natural Language :: English
|
|
16
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
17
|
+
Classifier: Operating System :: MacOS
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
License-File: AUTHORS
|
|
22
|
+
Requires-Dist: napalm<6,>=5.0.0
|
|
23
|
+
Requires-Dist: httpx>=0.27.0
|
|
24
|
+
Dynamic: license-file
|
|
25
|
+
|
|
26
|
+
# napalm-srlinux
|
|
27
|
+
|
|
28
|
+
Community [NAPALM](https://napalm.readthedocs.io) driver for the [Nokia SR Linux](https://learn.srlinux.dev) network OS, built on the **JSON-RPC** management interface; the only runtime dependencies are `napalm` and `httpx`.
|
|
29
|
+
|
|
30
|
+
**Documentation: https://napalm-automation-community.github.io/napalm-srlinux/**
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
pip install napalm-srlinux
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Requires Python ≥ 3.10 and napalm ≥ 5.
|
|
39
|
+
|
|
40
|
+
On the SR Linux node the JSON-RPC server must be enabled (it is by default in [containerlab](https://containerlab.dev) labs):
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
set / system json-rpc-server admin-state enable
|
|
44
|
+
set / system json-rpc-server network-instance mgmt http admin-state enable
|
|
45
|
+
set / system json-rpc-server network-instance mgmt https admin-state enable
|
|
46
|
+
set / system json-rpc-server network-instance mgmt https tls-profile <profile>
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Quick start
|
|
50
|
+
|
|
51
|
+
```python
|
|
52
|
+
from napalm import get_network_driver
|
|
53
|
+
|
|
54
|
+
driver = get_network_driver("srlinux")
|
|
55
|
+
optional_args = {
|
|
56
|
+
# pick one of the TLS modes below:
|
|
57
|
+
"insecure": True, # plain http on port 80 — labs only
|
|
58
|
+
# "skip_verify": True, # https, certificate not verified
|
|
59
|
+
# "tls_ca": "ca.pem", # https, verified against this CA
|
|
60
|
+
}
|
|
61
|
+
with driver("192.0.2.1", "admin", "NokiaSrl1!", optional_args=optional_args) as device:
|
|
62
|
+
print(device.get_facts())
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
A runnable example against a containerlab node is in [examples/example.py](examples/example.py).
|
|
66
|
+
|
|
67
|
+
## Optional arguments
|
|
68
|
+
|
|
69
|
+
| argument | default | description |
|
|
70
|
+
|---|---|---|
|
|
71
|
+
| `jsonrpc_port` | `443` (or `80` with `insecure`) | TCP port of the JSON-RPC server |
|
|
72
|
+
| `insecure` | `False` | use plain http instead of https |
|
|
73
|
+
| `skip_verify` | `False` | https without certificate verification |
|
|
74
|
+
| `tls_ca` | `""` | CA bundle used to verify the server certificate |
|
|
75
|
+
| `tls_cert_path` / `tls_key_path` | `""` | client certificate and key (both required for mTLS) |
|
|
76
|
+
| `tls_key_password` | `""` | passphrase of the client key |
|
|
77
|
+
| `running_format` | `"json"` | `get_config()` running-config format: `json` or `cli` (`info flat`) |
|
|
78
|
+
| `commit_save` | `False` | when set, commits use `commit save` / `save startup` so the config persists |
|
|
79
|
+
|
|
80
|
+
## Supported methods
|
|
81
|
+
|
|
82
|
+
All standard NAPALM getters that have an SR Linux equivalent are implemented:
|
|
83
|
+
`get_facts`, `get_interfaces`, `get_interfaces_counters`*, `get_interfaces_ip`*, `get_arp_table`, `get_ipv6_neighbors_table`, `get_bgp_neighbors`, `get_bgp_neighbors_detail`, `get_bgp_config`, `get_environment`, `get_lldp_neighbors`, `get_lldp_neighbors_detail`, `get_network_instances`, `get_users`, `get_snmp_information`, `get_config`, `get_ntp_servers`, `get_ntp_stats`, `get_optics`, `get_mac_address_table`, `get_route_to`, `get_vlans`**, `is_alive`, `ping`, `traceroute`, `cli` (`text` and `json` encodings), plus the full candidate-config workflow (`load_merge_candidate`, `load_replace_candidate`, `compare_config`, `commit_config` — including commit-confirm via `revert_in` —, `confirm_commit`, `has_pending_commit`, `discard_config`, `rollback`).
|
|
84
|
+
|
|
85
|
+
\* keyed by subinterface name (e.g. `ethernet-1/1.0`), since IP/counter state lives on subinterfaces in SR Linux.
|
|
86
|
+
|
|
87
|
+
\** SR Linux has no global VLAN table; `get_vlans` reports the single-tagged encapsulations of bridged subinterfaces attached to mac-vrf network instances, named after the mac-vrf. Untagged subinterfaces and `vlan-id any` are not reported.
|
|
88
|
+
|
|
89
|
+
Not supported by SR Linux (raise `NotImplementedError`): `get_probes_config/results`, `get_firewall_policies`, `get_ntp_peers`, `get_route_to(longer=True)`.
|
|
90
|
+
|
|
91
|
+
### Candidate-config semantics
|
|
92
|
+
|
|
93
|
+
The JSON-RPC interface has no persistent candidate datastore across requests — a `set` request against the candidate datastore is transactional and commits on success. The NAPALM candidate workflow is therefore emulated client-side:
|
|
94
|
+
|
|
95
|
+
- `load_merge_candidate()` / `load_replace_candidate()` store the intended change **in the driver** and (for JSON configs) validate it on the device via the `validate` method. Accepted formats: native SR Linux JSON, a gNMI-style envelope (`updates`/`replaces`/`deletes`), or SR Linux CLI commands.
|
|
96
|
+
- `compare_config()` uses the JSON-RPC `diff` method (JSON configs) or a throwaway named candidate on the device (CLI configs).
|
|
97
|
+
- `commit_config()` first creates a named checkpoint (`NAPALM-<session>-<n>`, unique per driver instance) as the rollback anchor, then applies everything in one transactional request.
|
|
98
|
+
- `discard_config()` only clears the client-side state; it never touches the device.
|
|
99
|
+
- `rollback()` restores the checkpoint created by the last `commit_config()`. Checkpoints contain the **entire** configuration tree — any change made after the checkpoint is reverted too.
|
|
100
|
+
- `get_config(retrieve="candidate")` returns `""` — the candidate only exists client-side.
|
|
101
|
+
|
|
102
|
+
#### Commit confirm
|
|
103
|
+
|
|
104
|
+
`commit_config(revert_in=<seconds>)` starts a confirmed commit: the change is applied, but the device reverts it automatically unless it is confirmed in time (JSON configs use the JSON-RPC `confirm-timeout` parameter, available since SR Linux 23.3.2; CLI configs use `commit confirmed timeout <seconds>`).
|
|
105
|
+
|
|
106
|
+
- `has_pending_commit()` reports whether a confirmed commit is awaiting confirmation — device-side state, visible to every session.
|
|
107
|
+
- `confirm_commit()` accepts the pending commit and cancels the revert timer. With `commit_save`, the `save startup` is deferred until this point, so the startup config never holds a change that may still auto-revert.
|
|
108
|
+
- `rollback()` called while a confirm is pending rejects it immediately (`confirmed-reject`) instead of loading a checkpoint.
|
|
109
|
+
- `commit_config()` refuses to run while another confirmed commit is pending.
|
|
110
|
+
|
|
111
|
+
Because the candidate is client-side, no lock is held on the device; concurrent clients are not blocked (and not protected) against each other.
|
|
112
|
+
|
|
113
|
+
## Migrating from 1.x
|
|
114
|
+
|
|
115
|
+
- The driver name changed: `get_network_driver("srlinux")` instead of `"srl"`; the package is `napalm_srlinux` (was `napalm_srl`).
|
|
116
|
+
- gNMI is gone — the optional arguments `gnmi_port`, `target_name`, `encoding`, `tls_cert`, and `tls_key` no longer exist. Client certificates are configured with `tls_cert_path`/`tls_key_path`.
|
|
117
|
+
- `get_interfaces()` speeds are now correctly reported in Mbit/s (e.g. `1G` → `1000.0`).
|
|
118
|
+
- `get_users()` returns the standard `sshkeys` key (was `ssh-keys`).
|
|
119
|
+
- BGP/interface uptimes are no longer truncated to less than a day.
|
|
120
|
+
|
|
121
|
+
## Development
|
|
122
|
+
|
|
123
|
+
The project is managed with [uv](https://docs.astral.sh/uv/):
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
uv sync # create the venv and install all dependencies
|
|
127
|
+
uv run pytest test/unit # unit tests (mocked JSON-RPC fixtures)
|
|
128
|
+
uv run ruff check napalm_srlinux test tools examples
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Testing against a real node
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
make deploy-clab-ci # single-node containerlab topology
|
|
135
|
+
make run-tests # runs all test/ci scripts against it
|
|
136
|
+
make destroy-clab-ci
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Re-recording the unit-test fixtures
|
|
140
|
+
|
|
141
|
+
The mocked-data fixtures under `test/unit/mocked_data/` are verbatim JSON-RPC responses recorded from a real two-node lab (BGP, LLDP, ARP, mac-vrf, NTP, ...):
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
make deploy-clab-record # two-node recording topology
|
|
145
|
+
make record-fixtures # configure the lab + record all fixtures
|
|
146
|
+
make destroy-clab-record
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
Review the resulting `git diff` before committing re-recorded fixtures.
|
|
150
|
+
|
|
151
|
+
## License
|
|
152
|
+
|
|
153
|
+
Apache 2.0 — see [LICENSE](LICENSE).
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# napalm-srlinux
|
|
2
|
+
|
|
3
|
+
Community [NAPALM](https://napalm.readthedocs.io) driver for the [Nokia SR Linux](https://learn.srlinux.dev) network OS, built on the **JSON-RPC** management interface; the only runtime dependencies are `napalm` and `httpx`.
|
|
4
|
+
|
|
5
|
+
**Documentation: https://napalm-automation-community.github.io/napalm-srlinux/**
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install napalm-srlinux
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Requires Python ≥ 3.10 and napalm ≥ 5.
|
|
14
|
+
|
|
15
|
+
On the SR Linux node the JSON-RPC server must be enabled (it is by default in [containerlab](https://containerlab.dev) labs):
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
set / system json-rpc-server admin-state enable
|
|
19
|
+
set / system json-rpc-server network-instance mgmt http admin-state enable
|
|
20
|
+
set / system json-rpc-server network-instance mgmt https admin-state enable
|
|
21
|
+
set / system json-rpc-server network-instance mgmt https tls-profile <profile>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Quick start
|
|
25
|
+
|
|
26
|
+
```python
|
|
27
|
+
from napalm import get_network_driver
|
|
28
|
+
|
|
29
|
+
driver = get_network_driver("srlinux")
|
|
30
|
+
optional_args = {
|
|
31
|
+
# pick one of the TLS modes below:
|
|
32
|
+
"insecure": True, # plain http on port 80 — labs only
|
|
33
|
+
# "skip_verify": True, # https, certificate not verified
|
|
34
|
+
# "tls_ca": "ca.pem", # https, verified against this CA
|
|
35
|
+
}
|
|
36
|
+
with driver("192.0.2.1", "admin", "NokiaSrl1!", optional_args=optional_args) as device:
|
|
37
|
+
print(device.get_facts())
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
A runnable example against a containerlab node is in [examples/example.py](examples/example.py).
|
|
41
|
+
|
|
42
|
+
## Optional arguments
|
|
43
|
+
|
|
44
|
+
| argument | default | description |
|
|
45
|
+
|---|---|---|
|
|
46
|
+
| `jsonrpc_port` | `443` (or `80` with `insecure`) | TCP port of the JSON-RPC server |
|
|
47
|
+
| `insecure` | `False` | use plain http instead of https |
|
|
48
|
+
| `skip_verify` | `False` | https without certificate verification |
|
|
49
|
+
| `tls_ca` | `""` | CA bundle used to verify the server certificate |
|
|
50
|
+
| `tls_cert_path` / `tls_key_path` | `""` | client certificate and key (both required for mTLS) |
|
|
51
|
+
| `tls_key_password` | `""` | passphrase of the client key |
|
|
52
|
+
| `running_format` | `"json"` | `get_config()` running-config format: `json` or `cli` (`info flat`) |
|
|
53
|
+
| `commit_save` | `False` | when set, commits use `commit save` / `save startup` so the config persists |
|
|
54
|
+
|
|
55
|
+
## Supported methods
|
|
56
|
+
|
|
57
|
+
All standard NAPALM getters that have an SR Linux equivalent are implemented:
|
|
58
|
+
`get_facts`, `get_interfaces`, `get_interfaces_counters`*, `get_interfaces_ip`*, `get_arp_table`, `get_ipv6_neighbors_table`, `get_bgp_neighbors`, `get_bgp_neighbors_detail`, `get_bgp_config`, `get_environment`, `get_lldp_neighbors`, `get_lldp_neighbors_detail`, `get_network_instances`, `get_users`, `get_snmp_information`, `get_config`, `get_ntp_servers`, `get_ntp_stats`, `get_optics`, `get_mac_address_table`, `get_route_to`, `get_vlans`**, `is_alive`, `ping`, `traceroute`, `cli` (`text` and `json` encodings), plus the full candidate-config workflow (`load_merge_candidate`, `load_replace_candidate`, `compare_config`, `commit_config` — including commit-confirm via `revert_in` —, `confirm_commit`, `has_pending_commit`, `discard_config`, `rollback`).
|
|
59
|
+
|
|
60
|
+
\* keyed by subinterface name (e.g. `ethernet-1/1.0`), since IP/counter state lives on subinterfaces in SR Linux.
|
|
61
|
+
|
|
62
|
+
\** SR Linux has no global VLAN table; `get_vlans` reports the single-tagged encapsulations of bridged subinterfaces attached to mac-vrf network instances, named after the mac-vrf. Untagged subinterfaces and `vlan-id any` are not reported.
|
|
63
|
+
|
|
64
|
+
Not supported by SR Linux (raise `NotImplementedError`): `get_probes_config/results`, `get_firewall_policies`, `get_ntp_peers`, `get_route_to(longer=True)`.
|
|
65
|
+
|
|
66
|
+
### Candidate-config semantics
|
|
67
|
+
|
|
68
|
+
The JSON-RPC interface has no persistent candidate datastore across requests — a `set` request against the candidate datastore is transactional and commits on success. The NAPALM candidate workflow is therefore emulated client-side:
|
|
69
|
+
|
|
70
|
+
- `load_merge_candidate()` / `load_replace_candidate()` store the intended change **in the driver** and (for JSON configs) validate it on the device via the `validate` method. Accepted formats: native SR Linux JSON, a gNMI-style envelope (`updates`/`replaces`/`deletes`), or SR Linux CLI commands.
|
|
71
|
+
- `compare_config()` uses the JSON-RPC `diff` method (JSON configs) or a throwaway named candidate on the device (CLI configs).
|
|
72
|
+
- `commit_config()` first creates a named checkpoint (`NAPALM-<session>-<n>`, unique per driver instance) as the rollback anchor, then applies everything in one transactional request.
|
|
73
|
+
- `discard_config()` only clears the client-side state; it never touches the device.
|
|
74
|
+
- `rollback()` restores the checkpoint created by the last `commit_config()`. Checkpoints contain the **entire** configuration tree — any change made after the checkpoint is reverted too.
|
|
75
|
+
- `get_config(retrieve="candidate")` returns `""` — the candidate only exists client-side.
|
|
76
|
+
|
|
77
|
+
#### Commit confirm
|
|
78
|
+
|
|
79
|
+
`commit_config(revert_in=<seconds>)` starts a confirmed commit: the change is applied, but the device reverts it automatically unless it is confirmed in time (JSON configs use the JSON-RPC `confirm-timeout` parameter, available since SR Linux 23.3.2; CLI configs use `commit confirmed timeout <seconds>`).
|
|
80
|
+
|
|
81
|
+
- `has_pending_commit()` reports whether a confirmed commit is awaiting confirmation — device-side state, visible to every session.
|
|
82
|
+
- `confirm_commit()` accepts the pending commit and cancels the revert timer. With `commit_save`, the `save startup` is deferred until this point, so the startup config never holds a change that may still auto-revert.
|
|
83
|
+
- `rollback()` called while a confirm is pending rejects it immediately (`confirmed-reject`) instead of loading a checkpoint.
|
|
84
|
+
- `commit_config()` refuses to run while another confirmed commit is pending.
|
|
85
|
+
|
|
86
|
+
Because the candidate is client-side, no lock is held on the device; concurrent clients are not blocked (and not protected) against each other.
|
|
87
|
+
|
|
88
|
+
## Migrating from 1.x
|
|
89
|
+
|
|
90
|
+
- The driver name changed: `get_network_driver("srlinux")` instead of `"srl"`; the package is `napalm_srlinux` (was `napalm_srl`).
|
|
91
|
+
- gNMI is gone — the optional arguments `gnmi_port`, `target_name`, `encoding`, `tls_cert`, and `tls_key` no longer exist. Client certificates are configured with `tls_cert_path`/`tls_key_path`.
|
|
92
|
+
- `get_interfaces()` speeds are now correctly reported in Mbit/s (e.g. `1G` → `1000.0`).
|
|
93
|
+
- `get_users()` returns the standard `sshkeys` key (was `ssh-keys`).
|
|
94
|
+
- BGP/interface uptimes are no longer truncated to less than a day.
|
|
95
|
+
|
|
96
|
+
## Development
|
|
97
|
+
|
|
98
|
+
The project is managed with [uv](https://docs.astral.sh/uv/):
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
uv sync # create the venv and install all dependencies
|
|
102
|
+
uv run pytest test/unit # unit tests (mocked JSON-RPC fixtures)
|
|
103
|
+
uv run ruff check napalm_srlinux test tools examples
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Testing against a real node
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
make deploy-clab-ci # single-node containerlab topology
|
|
110
|
+
make run-tests # runs all test/ci scripts against it
|
|
111
|
+
make destroy-clab-ci
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Re-recording the unit-test fixtures
|
|
115
|
+
|
|
116
|
+
The mocked-data fixtures under `test/unit/mocked_data/` are verbatim JSON-RPC responses recorded from a real two-node lab (BGP, LLDP, ARP, mac-vrf, NTP, ...):
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
make deploy-clab-record # two-node recording topology
|
|
120
|
+
make record-fixtures # configure the lab + record all fixtures
|
|
121
|
+
make destroy-clab-record
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Review the resulting `git diff` before committing re-recorded fixtures.
|
|
125
|
+
|
|
126
|
+
## License
|
|
127
|
+
|
|
128
|
+
Apache 2.0 — see [LICENSE](LICENSE).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Copyright 2024 Nokia. All rights reserved.
|
|
2
|
+
#
|
|
3
|
+
# The contents of this file are licensed under the Apache License, Version 2.0
|
|
4
|
+
# (the "License"); you may not use this file except in compliance with the
|
|
5
|
+
# License. You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
11
|
+
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
12
|
+
# License for the specific language governing permissions and limitations under
|
|
13
|
+
# the License.
|
|
14
|
+
|
|
15
|
+
"""napalm-srlinux package."""
|
|
16
|
+
|
|
17
|
+
from napalm_srlinux.srlinux import NokiaSRLinuxDriver
|
|
18
|
+
|
|
19
|
+
__all__ = ("NokiaSRLinuxDriver",)
|