napalm-linux 0.15.0__tar.gz

napalm_linux-0.15.0/LICENSE

@@ -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.

napalm_linux-0.15.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: napalm-linux
+Version: 0.15.0
+Summary: NAPALM driver for generic Linux systems via SSH
+Author-email: Christian Manivong <christian@manivong.de>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://git.netork.io/NAPALM/napalm-linux
+Project-URL: Issues, https://git.netork.io/NAPALM/napalm-linux/issues
+Project-URL: Changelog, https://git.netork.io/NAPALM/napalm-linux/src/branch/main/CHANGELOG.md
+Keywords: napalm,network,automation,linux,ssh,driver
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: napalm>=4.0
+Requires-Dist: napalm-device-types>=4.22.0
+Requires-Dist: netmiko>=4.0.0
+Requires-Dist: paramiko>=5.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Dynamic: license-file
+
+# napalm-linux
+
+NAPALM driver for **generic Linux systems** — Debian, Ubuntu, RHEL, Rocky, Alpine, Arch and any
+other distribution reachable via SSH.
+
+Connects over SSH using [Netmiko](https://github.com/ktbyers/netmiko) (`linux` device type) and
+**automatically detects** the installed package manager (`apt`, `dnf`, `yum`, `apk`, `pacman`).
+
+## Requirements
+
+| Dependency | Minimum version |
+|---|---|
+| Python | 3.9 |
+| NAPALM | 4.0 |
+| Netmiko | 4.0 |
+| napalm-device-types | 0.2.0 |
+
+## Installation
+
+```bash
+pip install napalm napalm-linux
+```
+
+Or from source:
+
+```bash
+git clone https://git.netork.io/NAPALM/napalm-linux
+pip install -e napalm-linux/
+```
+
+When working in the NetOrk monorepo, install both packages as editable:
+
+```bash
+pip install -e vendor/napalm-device-types/ -e vendor/napalm-linux/
+```
+
+## Quick start
+
+```python
+from napalm import get_network_driver
+
+Driver = get_network_driver("linux")
+
+with Driver(
+    "10.0.0.5",
+    "admin",
+    "s3cr3t",
+    optional_args={
+        # "port": 22,
+        # "pkg_manager": "apt",   # force package manager; auto-detected by default
+        # "sudo_password": "sudo-pass",  # for commands that need root; without it,
+        #                                # `sudo -n` (passwordless sudo) is tried
+        # "debugging": True,      # enable verbose logging
+    },
+) as dev:
+    facts = dev.get_facts()
+    print(facts)
+
+    # OS-specific methods (from napalm-device-types OSDriver)
+    packages = dev.get_packages()
+    updates = dev.get_pending_updates()
+    services = dev.get_services()
+    users = dev.get_os_users()
+    procs = dev.get_processes()
+    jobs = dev.get_cron_jobs()
+
+    # Upgrade specific packages
+    result = dev.apply_updates(["openssh-server", "curl"])
+    print(result)  # {"success": True, "output": "..."}
+
+    # Upgrade everything with pending updates
+    result = dev.apply_updates([])
+
+    # Restart a service (start, stop, restart, enable, disable)
+    result = dev.manage_service("cron", "restart")
+    print(result)  # {"success": True, "output": ""}
+```
+
+## Supported NAPALM methods
+
+### Standard NAPALM
+
+| Method | Supported | Notes |
+|---|---|---|
+| `open()` / `close()` | ✅ | SSH via netmiko `linux` |
+| `is_alive()` | ✅ | |
+| `get_facts()` | ✅ | DMI / `/proc/uptime` / `ip link` |
+| `get_interfaces()` | ✅ | `ip link show` |
+| `get_interfaces_ip()` | ✅ | `ip addr show` |
+| `get_arp_table()` | ✅ | `ip neigh show` |
+| `get_config()` | ✅ | Returns `ip addr` + `ip route` output |
+| `ping()` | ✅ | Executes `ping` on the remote host |
+| `load_merge_candidate()` | ❌ | Not applicable for generic Linux |
+| `load_replace_candidate()` | ❌ | Not applicable for generic Linux |
+| `compare_config()` | ❌ | Not applicable for generic Linux |
+| `commit_config()` | ❌ | Not applicable for generic Linux |
+| `discard_config()` | ❌ | Not applicable for generic Linux |
+| `rollback()` | ❌ | Not applicable for generic Linux |
+
+### OSDriver extensions (napalm-device-types)
+
+| Method | Supported | Package managers |
+|---|---|---|
+| `get_packages()` | ✅ | apt, dnf, yum, apk, pacman |
+| `get_pending_updates()` | ✅ | apt, dnf, yum, apk, pacman |
+| `apply_updates(packages)` | ✅ | apt, dnf, yum, apk, pacman |
+| `get_services()` | ✅ | systemd, one round trip (fallback: SysV `service`) |
+| `manage_service(name, action)` | ✅ | systemd: start, stop, restart, enable, disable |
+| `get_os_users()` | ✅ | `/etc/passwd` + `/etc/group` |
+| `get_processes()` | ✅ | `ps axo` |
+| `get_cron_jobs()` | ✅ | user crontabs + `/etc/cron.d/` |
+
+## Package manager auto-detection
+
+The driver probes for each binary in order via `command -v`:
+
+```
+apt → dnf → yum → apk → pacman
+```
+
+Force a specific package manager:
+
+```python
+optional_args = {"pkg_manager": "dnf"}
+```
+
+## SSH user permissions
+
+The SSH user needs read access to:
+
+| Data | Required permission |
+|---|---|
+| `/etc/passwd`, `/etc/group` | world-readable (default) |
+| `/proc/uptime`, `/sys/class/dmi/…` | world-readable (default) |
+| User crontabs (`/var/spool/cron/…`) | `root` or `sudo` required |
+| `systemctl list-unit-files`, `systemctl show` | unprivileged |
+| `systemctl start/stop/restart/enable/disable` | `root`, or `sudo` (with `sudo_password`, or passwordless) |
+| `apt list --upgradable` | may require `apt-get update` (root) |
+| `dnf check-update` / `yum check-update` | unprivileged, but slower without cache |
+
+For full functionality it is recommended to run as `root` or grant passwordless `sudo` for
+the above commands.
+
+With a `sudo_password`, privileged commands run on an exec channel next to the interactive
+shell: the password reaches `sudo -S` on stdin, never a command line, so it shows neither in
+the process list nor in a shell history. The interactive session switches its history off
+before its first command.
+
+`get_services()` and `manage_service()` come from napalm-device-types'
+`SystemdServicesMixin`; this driver supplies only the transport. An action runs as
+`timeout 45 systemctl --no-ask-password <action> -- <unit>.service`, so a unit that hangs
+on its way up or down cannot hold the session, and only the exit status decides whether it
+succeeded. Without a sudo password it uses `sudo -n`, which fails at once instead of
+waiting for a password prompt.
+
+On OpenMediaVault (napalm-openmediavault inherits this driver), enabling or disabling a
+unit that OMV manages itself — Samba, NFS, SSH — may be reverted the next time OMV applies
+its configuration.
+
+## Tested distributions
+
+| Distribution | Version | Package manager | Tested |
+|---|---|---|---|
+| Debian | 12 (Bookworm) | apt | ✅ |
+| Ubuntu | 22.04 LTS | apt | ✅ |
+| Rocky Linux | 9 | dnf | planned |
+| Alpine Linux | 3.19 | apk | planned |
+| Arch Linux | rolling | pacman | planned |
+
+Contributions for additional distributions and versions are welcome.
+
+## Development
+
+```bash
+# Create venv
+python -m venv .venv
+source .venv/bin/activate
+
+# Install in editable mode with dev dependencies
+pip install -e ../napalm-device-types/ -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Lint / format
+ruff check napalm_linux/
+ruff format napalm_linux/
+```
+
+## License
+
+Apache 2.0

napalm_linux-0.15.0/README.md

@@ -0,0 +1,192 @@
+# napalm-linux
+
+NAPALM driver for **generic Linux systems** — Debian, Ubuntu, RHEL, Rocky, Alpine, Arch and any
+other distribution reachable via SSH.
+
+Connects over SSH using [Netmiko](https://github.com/ktbyers/netmiko) (`linux` device type) and
+**automatically detects** the installed package manager (`apt`, `dnf`, `yum`, `apk`, `pacman`).
+
+## Requirements
+
+| Dependency | Minimum version |
+|---|---|
+| Python | 3.9 |
+| NAPALM | 4.0 |
+| Netmiko | 4.0 |
+| napalm-device-types | 0.2.0 |
+
+## Installation
+
+```bash
+pip install napalm napalm-linux
+```
+
+Or from source:
+
+```bash
+git clone https://git.netork.io/NAPALM/napalm-linux
+pip install -e napalm-linux/
+```
+
+When working in the NetOrk monorepo, install both packages as editable:
+
+```bash
+pip install -e vendor/napalm-device-types/ -e vendor/napalm-linux/
+```
+
+## Quick start
+
+```python
+from napalm import get_network_driver
+
+Driver = get_network_driver("linux")
+
+with Driver(
+    "10.0.0.5",
+    "admin",
+    "s3cr3t",
+    optional_args={
+        # "port": 22,
+        # "pkg_manager": "apt",   # force package manager; auto-detected by default
+        # "sudo_password": "sudo-pass",  # for commands that need root; without it,
+        #                                # `sudo -n` (passwordless sudo) is tried
+        # "debugging": True,      # enable verbose logging
+    },
+) as dev:
+    facts = dev.get_facts()
+    print(facts)
+
+    # OS-specific methods (from napalm-device-types OSDriver)
+    packages = dev.get_packages()
+    updates = dev.get_pending_updates()
+    services = dev.get_services()
+    users = dev.get_os_users()
+    procs = dev.get_processes()
+    jobs = dev.get_cron_jobs()
+
+    # Upgrade specific packages
+    result = dev.apply_updates(["openssh-server", "curl"])
+    print(result)  # {"success": True, "output": "..."}
+
+    # Upgrade everything with pending updates
+    result = dev.apply_updates([])
+
+    # Restart a service (start, stop, restart, enable, disable)
+    result = dev.manage_service("cron", "restart")
+    print(result)  # {"success": True, "output": ""}
+```
+
+## Supported NAPALM methods
+
+### Standard NAPALM
+
+| Method | Supported | Notes |
+|---|---|---|
+| `open()` / `close()` | ✅ | SSH via netmiko `linux` |
+| `is_alive()` | ✅ | |
+| `get_facts()` | ✅ | DMI / `/proc/uptime` / `ip link` |
+| `get_interfaces()` | ✅ | `ip link show` |
+| `get_interfaces_ip()` | ✅ | `ip addr show` |
+| `get_arp_table()` | ✅ | `ip neigh show` |
+| `get_config()` | ✅ | Returns `ip addr` + `ip route` output |
+| `ping()` | ✅ | Executes `ping` on the remote host |
+| `load_merge_candidate()` | ❌ | Not applicable for generic Linux |
+| `load_replace_candidate()` | ❌ | Not applicable for generic Linux |
+| `compare_config()` | ❌ | Not applicable for generic Linux |
+| `commit_config()` | ❌ | Not applicable for generic Linux |
+| `discard_config()` | ❌ | Not applicable for generic Linux |
+| `rollback()` | ❌ | Not applicable for generic Linux |
+
+### OSDriver extensions (napalm-device-types)
+
+| Method | Supported | Package managers |
+|---|---|---|
+| `get_packages()` | ✅ | apt, dnf, yum, apk, pacman |
+| `get_pending_updates()` | ✅ | apt, dnf, yum, apk, pacman |
+| `apply_updates(packages)` | ✅ | apt, dnf, yum, apk, pacman |
+| `get_services()` | ✅ | systemd, one round trip (fallback: SysV `service`) |
+| `manage_service(name, action)` | ✅ | systemd: start, stop, restart, enable, disable |
+| `get_os_users()` | ✅ | `/etc/passwd` + `/etc/group` |
+| `get_processes()` | ✅ | `ps axo` |
+| `get_cron_jobs()` | ✅ | user crontabs + `/etc/cron.d/` |
+
+## Package manager auto-detection
+
+The driver probes for each binary in order via `command -v`:
+
+```
+apt → dnf → yum → apk → pacman
+```
+
+Force a specific package manager:
+
+```python
+optional_args = {"pkg_manager": "dnf"}
+```
+
+## SSH user permissions
+
+The SSH user needs read access to:
+
+| Data | Required permission |
+|---|---|
+| `/etc/passwd`, `/etc/group` | world-readable (default) |
+| `/proc/uptime`, `/sys/class/dmi/…` | world-readable (default) |
+| User crontabs (`/var/spool/cron/…`) | `root` or `sudo` required |
+| `systemctl list-unit-files`, `systemctl show` | unprivileged |
+| `systemctl start/stop/restart/enable/disable` | `root`, or `sudo` (with `sudo_password`, or passwordless) |
+| `apt list --upgradable` | may require `apt-get update` (root) |
+| `dnf check-update` / `yum check-update` | unprivileged, but slower without cache |
+
+For full functionality it is recommended to run as `root` or grant passwordless `sudo` for
+the above commands.
+
+With a `sudo_password`, privileged commands run on an exec channel next to the interactive
+shell: the password reaches `sudo -S` on stdin, never a command line, so it shows neither in
+the process list nor in a shell history. The interactive session switches its history off
+before its first command.
+
+`get_services()` and `manage_service()` come from napalm-device-types'
+`SystemdServicesMixin`; this driver supplies only the transport. An action runs as
+`timeout 45 systemctl --no-ask-password <action> -- <unit>.service`, so a unit that hangs
+on its way up or down cannot hold the session, and only the exit status decides whether it
+succeeded. Without a sudo password it uses `sudo -n`, which fails at once instead of
+waiting for a password prompt.
+
+On OpenMediaVault (napalm-openmediavault inherits this driver), enabling or disabling a
+unit that OMV manages itself — Samba, NFS, SSH — may be reverted the next time OMV applies
+its configuration.
+
+## Tested distributions
+
+| Distribution | Version | Package manager | Tested |
+|---|---|---|---|
+| Debian | 12 (Bookworm) | apt | ✅ |
+| Ubuntu | 22.04 LTS | apt | ✅ |
+| Rocky Linux | 9 | dnf | planned |
+| Alpine Linux | 3.19 | apk | planned |
+| Arch Linux | rolling | pacman | planned |
+
+Contributions for additional distributions and versions are welcome.
+
+## Development
+
+```bash
+# Create venv
+python -m venv .venv
+source .venv/bin/activate
+
+# Install in editable mode with dev dependencies
+pip install -e ../napalm-device-types/ -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Lint / format
+ruff check napalm_linux/
+ruff format napalm_linux/
+```
+
+## License
+
+Apache 2.0

napalm_linux-0.15.0/napalm_linux/__init__.py

@@ -0,0 +1,5 @@
+"""napalm-linux – NAPALM driver for generic Linux systems."""
+
+from napalm_linux.linux import LinuxDriver
+
+__all__ = ["LinuxDriver"]