netbox-proxbox v0.0.19
This release expands Proxbox from a Proxmox inventory plugin into a broader NetBox control surface for VM sync, firewall intent, Firecracker cloud inventory, endpoint operations, and companion backend integration. It pairs with proxbox-api v0.0.16.
Highlights
- Added per-resource sync mode controls so operators can decide whether cluster, node, VM, container, IP address, storage, backup, and template data is created, updated, or left untouched during sync.
- Added Proxmox VM template inventory, including a dedicated model, serializers, filters, forms, tables, views, routes, navigation entries, migrations, sync service, and frontend tests.
- Added Firecracker Cloud inventory models and APIs for host pools, host-agent hosts, image templates, and provisioned micro-VM records used by NMS Cloud workflows.
- Added firewall intent apply support, including payload builders, merge validation, datacenter/node/VM/LXC/VNet helpers, preview UI, bulk push actions, and tests for write helpers.
- Added Proxmox endpoint SSH terminal support with credential handling, endpoint settings UI, xterm assets, terminal JavaScript, CSS, and route/view coverage.
- Added home page and dashboard improvements: endpoint table view, companion plugin endpoint cards, endpoint runtime cards, live PBS status badge, sync status widgets, object count widgets, and clearer single-row widget layout.
Backend Integration
- FastAPI endpoint token updates now re-register rotated API keys with the backend, reducing manual recovery work after key rotation.
- Proxmox endpoint runtime settings are forwarded to the backend, including SSL verification, timeout, and allow-writes style controls needed by operational workflows.
- Backend version advisory handling now surfaces compatibility guidance for VM IP sync and companion backend version drift.
- PBS and PDM endpoint models now include compatibility properties for backend host and timeout field names, and their enabled columns are repaired during migration.
- Keepalive checks now detect the selected Proxmox endpoint mode correctly.
Sync And Data Model
- Added configurable reconciliation engine settings to plugin settings and endpoint flows.
- Added new sync stages and parameters for Firecracker inventory, firewall state, VM templates, and granular sync-mode behavior.
- Improved VM IP sync behavior so disabled IP sync does not overwrite primary IP state.
- Fixed multiple PVE 9.2 sync, serializer, filterset, firewall, SDN, and migration correctness issues.
- Replaced the earlier firewall/SDN migration sequence with a squashed migration and added later migrations for Firecracker, SSH terminal settings, reconciliation settings, endpoint enabled repair, sync modes, and VM templates.
UI And Documentation
- Added an architecture diagram, compatibility matrix, Firecracker documentation, settings documentation, operational docs, and release publishing notes.
- Added
docs/configuration/sync-modes.mdand updated generated screenshots for the current UI. - Removed obsolete Discord and Telegram community assets and links.
- Added or updated contract, frontend, migration, widget, service, SSH terminal, sync-mode, VM template, keepalive, and firewall tests.
Release Pipeline
- Hardened package publishing workflows with explicit metadata validation, duplicate PyPI upload detection, safer publish inputs, and release documentation.
- Updated CI, docs, E2E Docker, page coverage, screenshot, and package validation workflows for the expanded release surface.
Upgrade Notes
- Run
manage.py migrate netbox_proxboxafter upgrading. This release includes new migrations for Firecracker inventory, endpoint settings, sync modes, and VM templates. - Upgrade
proxbox-apitov0.0.16before or together with this plugin release. - Restart NetBox services and collect static files after installing the package.
Compatibility
- NetBox: 4.5.8 through 4.6.x
- Python: 3.12 and 3.13
- Companion backend:
proxbox-api >= 0.0.16