napalm-bsd
NAPALM drivers for FreeBSD (freebsd) and OpenBSD (openbsd) hosts,
over SSH, built on napalm-device-types'
OSDriver. Written for netOrk, which provisions and manages BSD VMs
(NetOrk/netork#792).
Design
- One shared
BsdDriver(napalm_bsd/base.py) holds the SSH layer and every reader whose tools agree between the BSDs.FreeBSDDriverandOpenBSDDrivername only the commands that differ (hostname, release, kernel, hardware,netstat -rnWvs-rn). - Every command runs on its own SSH exec channel (
run_on_transportfrom napalm-device-types): no PTY to parse a prompt from, stdout and stderr apart, a real exit status.run_command()/open_stream()are public (CommandChannelMixin). - Root comes from
sudo -Swith the sudo password on stdin (never on a command line), orsudo -nwithout one, as in napalm-linux. netOrk provisionssudoon BSD VMs for that reason;doascannot read a password from stdin. - Parsing is in
napalm_bsd/parse.py, pure functions tested on output recorded from real systems (tests/fixtures/, each directory'sCOMMANDS.txtlists what produced it).
Supported getters
| Getter | FreeBSD | OpenBSD | Source |
|---|---|---|---|
get_facts |
✓ | ✓ | kern.hostname/hostname, freebsd-version/uname, kenv smbios.*/hw.*, kern.boottime |
get_interfaces, get_interfaces_ip |
✓ | ✓ | ifconfig -a |
get_route_to |
✓ | ✓ | netstat -rnW / netstat -rn |
get_arp_table |
✓ | ✓ | arp -an |
get_lldp_neighbors |
{} |
{} |
no LLDP daemon in either base system |
get_users, get_processes, get_cron_jobs |
✓ | ✓ | /etc/passwd+/etc/group, ps … lstart, system crontab + crontab -l |
get_listening_sockets |
✓ | ✓ | sockstat -46lq / fstat -n as root, netstat -an without |
get_listening_sockets has the shape of napalm-device-types'
ListeningSocketsMixin (whose ss/cgroup reading is Linux's) and its rule:
read as root first, without root when that brings nothing back
(attributed: False). FreeBSD's sockstat sees every socket either way;
OpenBSD's fstat shows a user only their own processes, so without root the
sockets come from netstat -an, unnamed.
There is deliberately no get_kernel_facts: KernelFactsMixin reports a
Linux kernel's modules and CONFIG_* options, which a BSD kernel does not
have, and hasattr(driver, "get_kernel_facts") has to stay truthful.
Packages, services, updates (#799) and SNMP (#800) follow.
Connection arguments
optional_args: port (22), key_file, sudo_password, allow_agent,
look_for_keys (both off by default).
Development
pip install "napalm-device-types @ git+https://git.netork.io/NAPALM/napalm-device-types.git"
pip install -e ".[dev]"
pytest