Files
napalm-opnsense/CHANGELOG.md
T
Christian Manivong c4ff19ac20
driver / standard (pull_request) Successful in 25s
driver / lint (pull_request) Successful in 26s
driver / types (pull_request) Failing after 35s
driver / test (3.13) (pull_request) Failing after 18s
driver / test (3.12) (pull_request) Failing after 21s
driver / lowest (pull_request) Failing after 17s
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Failing after 40s
CI / driver (pull_request) Failing after 1m25s
driver / publish (pull_request) Skipped
feat(scheduled-jobs): the cron jobs of config.xml over the REST API (#43)
OPNsense keeps its cron jobs in its configuration and runs each as a
configd action, so the POSIX implementation does not fit: the driver has
no shell, and a job's command is not a shell line. The cron API reads and
writes them instead.

get_scheduled_jobs reads every job in one request (/api/cron/settings/get,
which carries the selected action rather than its display text). A job
another component registered is platform, one written by
put_scheduled_job carries the napalm-scheduled-job marker in its
description and is application, the rest admin. Every job can be enabled
and disabled; only an application's job is edited or deleted.
put_scheduled_job takes a configd action as command and refuses one
configd does not offer; get_scheduled_job_commands lists them. Running a
job now is refused: the API cannot run a configd action. Every write
reads the job again and refuses one whose digest changed.

Parameters are written one per line and only without blanks, quotes or
backslashes: OPNsense up to 26.1 splits them as a shell would, 26.7 takes
a line per argument, and only such arguments mean the same to both.

Requires napalm-device-types 4.26.0.

Closes #43
2026-11-03 05:44:29 +01:00

5.4 KiB
Raw Blame History

Changelog

All notable changes to this driver. The format follows Keep a Changelog, versions follow Semantic Versioning.

[Unreleased]

Added

  • Scheduled jobs (NetOrk/netork#1933, #43): get_scheduled_jobs() reads every cron job of config.xml over /api/cron/settings/get, with who owns it -- another component's job is platform, one written by put_scheduled_job() application, the rest admin. manage_scheduled_job() enables and disables any of them; put_scheduled_job() and delete_scheduled_job() write and remove an application's own, whose command is a configd action. get_scheduled_job_commands() lists the actions configd offers. Running a job now is refused: the API cannot run a configd action. Every write reads the job again first and refuses one that changed.

Changed

  • Requires napalm-device-types 4.26.0, which declares the scheduled-jobs contract.
  • Python 3.12 is the floor (requires-python = ">=3.12"): netOrk runs every driver on 3.12, so 3.10 and 3.11 are no longer tested (NAPALM/driver-standard#6).
  • The floor on napalm is 5.1: older releases import pkg_resources, which a Python 3.12 venv no longer has.

Fixed

  • is_alive() checks the host and port named in base_url (https://fw:8443) instead of always port 443 on the hostname, so a firewall whose API listens elsewhere no longer reads as dead (#15).
  • sync_dns_zone() and get_dns_entries() raise when the host overrides cannot be read. A transient API error used to read as "no overrides": the sync then deleted nothing and added every record a second time (#14).
  • create_dhcp_reservation() no longer takes over a Kea reservation another MAC holds for the address (made by hand, say): it raises RuntimeError and leaves it as it is. delete_dhcp_reservation_and_lease() removes only the reservation and lease of the given MAC and reports another host's reservation for the address in the new reservation_other_mac field (#26).
  • configure_snmp_agent() works on OPNsense 26.x again. The configure step sent fields the os-net-snmp model does not have (contact, location, sysobjid, bindip) and listen in the shape get returns rather than as a string, which 26.x refuses with HTTP 500. It now sends syscontact/syslocation, and only when the caller gives them, so an operator's sysContact and sysLocation are no longer blanked (#36).
  • get_arp_table() and get_ipv6_neighbors_table() report an unknown age as -1.0 (napalm-device-types' ARP_AGE_UNKNOWN). They reported expires, the seconds left until the entry expires, which is no age: an entry refreshed a second ago looked 20 minutes old (NetOrk/netork#1327).
  • get_vpn_tunnels() keys a WireGuard peer by its interface and the start of its public key (wireguard-wg0-aBcD1234, URL-safe) instead of its position, so a peer added ahead of another no longer renumbers it (#32). Every WireGuard key changes once with this release.
  • get_dns_entries() raises when the service list (/api/core/service/search) cannot be read, instead of returning an empty list as if neither Unbound nor Dnsmasq ran: a transient API error made the firewall look as if it had no DNS records. sync_dns_zone() raises that API error instead of "No active DNS service (Unbound or Dnsmasq) detected" (#39).
  • create_dhcp_reservation() raises RuntimeError naming searchReservation when the search for an existing reservation fails, and writes nothing. It used to add the reservation anyway: a retry then failed with "Kea rejected DHCP reservation" instead of the real error, or left two reservations for one address, which Kea refuses to load (#40).
  • The unit tests no longer reach the network: the test of a failed open() looked up a real host name and waited for the resolver, so it hung or behaved differently on a build host with a slow resolver or one that answers every name (#41).

[0.5.0] - 2026-10-23

The first release on PyPI.

Changed

  • The driver follows the NAPALM driver standard (https://git.netork.io/NAPALM/driver-standard): CI on Gitea runs ruff, mypy, the tests on Python 3.10–3.13 and at the lowest declared versions, bandit, pip-audit and a build check, and a release tag publishes to PyPI. The package now ships py.typed and a LICENSE file. Python 3.10 remains the floor. Requires napalm-device-types 4.21.1.

Fixed

  • get_dhcp_leases() raises when Kea, ISC DHCP and the ARP fallback all failed, instead of returning an empty list that looks like a server without leases (#27).
  • create_dhcp_reservation() leaves a reservation that already holds what was asked alone, and does not reconfigure (restart) Kea for it.

[0.4.0] - 2026-10-18

Added

  • napalm-device-types 4.17's public contracts: apply_updates() passes the packages it is given and get_update_progress() reports the upgrade's state and log; get_dns_forwards(), set_dns_forward() and remove_dns_forward() for Unbound; get_ospf(). Requires napalm-device-types 4.17.0.

[0.3.0] - 2026-10-17

Removed

  • Breaking: get_device_warnings(). The pending updates are in get_available_updates().

[0.2.0] - 2026-10-17

Changed

  • Breaking: run_device_action is removed. The SNMP agent is set up through napalm-device-types 4.13's configure_snmp_agent with the caller's community, contact, location and listen address, and the firewall opens UDP/161 only to the allowed sources (#13).