# netbox-pdm

NetBox plugin scaffold for read-only Proxmox Datacenter Manager inventory through proxbox-api.

| Field |Value |
| --- | --- |
| Canonical URL | https://emersonfelipesp.com/netbox-pdm |
| GitHub | https://github.com/emersonfelipesp/netbox-pdm |
| Developer guide | https://emersonfelipesp.com/netbox-pdm/developer |
| Roadmap | https://emersonfelipesp.com/netbox-pdm/roadmap |
| Releases | https://emersonfelipesp.com/netbox-pdm/releases |
| Stars | 2 |
| Forks | 0 |
| Latest release | v0.0.1 |

## Overview

netbox-pdm is a sibling of netbox-proxbox for future read-only PDM inventory: remotes, views, and SDN-adjacent state through proxbox-api.

The released v0.0.1 package ships the plugin scaffold and NetBox installation glue. Model and synchronization views are not part of this release.

## Features

- Plugin scaffold and NetBox installation glue
- Reuses netbox-proxbox endpoint resolution and job conventions when installed
- Falls back to proxbox_api_url and proxbox_api_key plugin settings
- Read-only boundary — all mutations remain in PDM
- Model and synchronization views are planned for later releases

## Stack

- NetBox plugin (Django / Python 3.12+)
- proxbox-api backend with PDM-aware endpoints
- netbox-proxbox >=0.0.16

## Install

Primary command:

```shell
pip install netbox-pdm
```

Requires a running Proxmox Datacenter Manager instance and netbox-proxbox for cluster context.

## Links

| Label |URL |
| --- | --- |
| repo | https://github.com/emersonfelipesp/netbox-pdm |
| netbox-proxbox | https://emersonfelipesp.com/netbox-proxbox |
| Proxmox PDM Docs | https://pve.proxmox.com/pve-docs/pdm-admin-guide.html |