netbox-pbs

NetBox plugin that reflects Proxmox Backup Server (PBS) inventory into NetBox through the proxbox-api /pbs/* endpoints.

netbox-pbs is a sibling plugin of netbox-proxbox and reuses its FastAPI endpoint resolution, branch lifecycle, and job conventions. When netbox-proxbox is installed it is used as the source of backend context; otherwise the plugin falls back to its own proxbox_api_url / proxbox_api_key plugin settings.

Status

netbox-pbs v0.0.1.post1 is a read-only NetBox inventory layer for PBS. All mutations remain in Proxmox Backup Server; this plugin only reflects. This post release normalizes certification evidence, packaging metadata, and compatibility documentation without changing runtime behavior.

Included Models

• PBS servers
• PBS datastores
• PBS snapshots
• PBS jobs
• PBS plugin settings

Sync Job

PBSSyncJob calls proxbox-api sync resources:

• full
• datastores
• snapshots
• jobs
• node

When NetBox branching support is available through netbox-proxbox, PBS sync jobs can create a branch, run the backend sync against the branch schema, and merge it back according to the plugin settings conflict policy.

Compatibility

See COMPATIBILITY.md for the full version compatibility table.

Installation

pip install netbox-pbs

Then add to configuration.py:

PLUGINS = [
    "netbox_proxbox",   # required peer plugin
    "netbox_pbs",
]

Run NetBox migrations as usual:

python manage.py migrate

Documentation

Full documentation is published at https://emersonfelipesp.github.io/netbox-pbs/.

Support

Use GitHub Issues for bugs and feature requests: https://github.com/emersonfelipesp/netbox-pbs/issues.

Certification Status

Certification evidence is tracked in CERTIFICATION.md. The repository includes Apache-2.0 licensing, PyPI metadata, compatibility metadata, GitHub Actions CI, release validation, docs publishing, screenshot capture, and page-coverage workflows for NetBox v4.6.1.

License

Apache-2.0