# netbox-pbs

NetBox plugin for Proxmox Backup Server — tracks datastores, backup jobs, verification schedules, and retention policies.

| Field |Value |
| --- | --- |
| Canonical URL | https://emersonfelipesp.com/netbox-pbs |
| GitHub | https://github.com/emersonfelipesp/netbox-pbs |
| Developer guide | https://emersonfelipesp.com/netbox-pbs/developer |
| Roadmap | https://emersonfelipesp.com/netbox-pbs/roadmap |
| Releases | https://emersonfelipesp.com/netbox-pbs/releases |
| Stars | 0 |
| Forks | 0 |
| Latest release | n/a |

## Overview

netbox-pbs integrates Proxmox Backup Server (PBS) inventory into NetBox, giving your DCIM a complete picture of your backup infrastructure alongside the VMs and nodes it protects.

Datastores, backup jobs, tape drives, and pruning schedules are discovered automatically and linked to the Proxmox clusters and virtual machines already managed by netbox-proxbox.

## Features

- Automatic discovery of PBS datastores and their usage metrics
- Backup job tracking: status, schedule, last run, and next run
- Verification job and garbage collection schedule visibility
- Retention policy modeling per datastore
- Links PBS objects to existing Proxmox cluster and VM records
- Read-only discovery — never mutates resources on PBS
- REST API for all plugin models

## Stack

- NetBox plugin (Django / Python 3.12+)
- Proxmox Backup Server API integration
- netbox-proxbox (companion plugin for VM and cluster context)

## Install

Primary command:

```shell
pip install netbox-pbs
```

Requires a running Proxmox Backup Server instance and netbox-proxbox for cluster context.

## Links

| Label |URL |
| --- | --- |
| repo | https://github.com/emersonfelipesp/netbox-pbs |
| netbox-proxbox | https://emersonfelipesp.com/netbox-proxbox |
| Proxmox Backup Server Docs | https://pbs.proxmox.com/docs/ |