napalm-linux adds and locks accounts with shadow-utils and keys in ~/.ssh. OMV's sshd lets in only root and _ssh, and OMV keeps a user's keys in its own database, deploying them to /var/lib/openmediavault/ssh/authorized_keys. So a new account is made by UserMgmt.setUser in _ssh, one made outside OMV joins _ssh when it is opened, and keys go through setUser. Each call applies the modules it made dirty (postfix, ssh) and leaves what was pending in the web UI pending. setUser takes a plain password, netOrk only the hash, so the hash is set with usermod -p. The lock stays napalm-linux's expiry. Checked on a fresh OMV 8 (Debian 13) with the real driver over SSH and sudo -S: a new account logs in with its key and uses sudo, is refused after locking with OMV's keys emptied, logs in again after reopening; an account made outside OMV is let in once it joined _ssh; a module left dirty before stays dirty.
napalm-openmediavault
NAPALM driver for OpenMediaVault NAS systems, built on
napalm-device-types (StorageDriver) and
napalm-linux (LinuxDriver).
OpenMediaVault is Debian underneath, so the driver inherits everything napalm-linux does for a Linux host (packages, updates, services, users, processes, cron, Docker) and adds the NAS side: disks, md RAID arrays, filesystems, shares and the NAS services.
Tested against
| Model | Firmware |
|---|---|
| OpenMediaVault | 6.x (Debian Bullseye), 7.x (Debian Bookworm) |
Connection
SSH, port 22 by default, through napalm-linux (Netmiko). The account needs a shell; smartctl
and mdadm run through sudo (passwordless, or with sudo_password). Every optional_args
key of napalm-linux is accepted (port, pkg_manager, sudo_password, …).
from napalm import get_network_driver
driver = get_network_driver("openmediavault")
with driver("192.0.2.10", "admin", "secret", optional_args={"sudo_password": "secret"}) as nas:
print(nas.get_facts())
print(nas.get_disks())
print(nas.get_shares())
Supported
| Getter / action | |
|---|---|
get_facts |
napalm-linux's facts, os_version is OMV <version> of the openmediavault package |
get_disks |
lsblk for the disks, smartctl -iA for health, temperature and RPM |
get_disk_pools |
md arrays from /proc/mdstat, size and state from mdadm --detail |
get_volumes |
mounted block-device filesystems from df, read-only flag from /proc/mounts |
get_shares |
SMB, NFS and FTP shares from OMV's configuration database (omv-confdbadm) |
get_storage_services |
whether smbd, nfs-server, proftpd, ssh and rsync are enabled and running |
| everything of napalm-linux | packages, updates, services, users, processes, cron, Docker, … |
"Upgrade everything" is a full upgrade (FULL_UPGRADE = True): a plain apt-get upgrade holds
back OpenMediaVault's own packages and the kernel.
Not supported
get_volume_snapshots,get_replication_jobs,get_quotasraiseNotImplementedError.harden_ssh_serveris not offered: OpenMediaVault generatessshd_configfrom its own database and would undo a drop-in on the next apply of its SSH settings.- Configuration changes to shares, disks or arrays.
Installation
pip install napalm-openmediavault
Development
The rules are in STANDARDS.md.
python -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/pytest --cov
License
Apache-2.0