creekorful/netbox-pve-sync
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases 5 Packages Wiki Activity Actions

Clean-up module
All checks were successful
CD / ci (push) Successful in 1m7s
Details
CI / ci (push) Successful in 1m13s
Details

Browse source
This commit is contained in:
Aloïs Micard 2025-02-19 12:51:19 +01:00
parent 552965a90d
commit 5fc6a028ec
9 changed files with 826 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

56
README.md Normal file
View file

@ -0,0 +1,56 @@
# netbox-pve-sync
Synchronize Proxmox Virtual Environment (PVE) information to a NetBox instance.
This allows automatic tracking of Virtual Machines, disks, IP addresses/prefixes, MAC addresses, VLANs, ...
## How does it work?
This script work by pulling VMs information from the PVE API and create/update/delete resources on NetBox.
## Installation
## Configuration
### On NetBox
You'll need to create a dedicated user (ex: netbox-pve-sync) on your NetBox instance and then create a write API
token.
The following env variables will need to be set:
- **NB_API_URL**: The URL to your NetBox instance. (ex: https://netbox.example.org)
- **NB_API_TOKEN**: The token created previously. (ex: f74cb99cf552b7005fd1a616b53efba2ce0c9656)
You'll also need to perform a minimal configuration on NetBox:
- Create the physical nodes hosting the cluster. (The name should match the one on Proxmox, so that the script can
correctly link the VMs to the physical host)
- Create the cluster.
- Add the following Custom Fields:
| Name | Object types | Label | Type |
|-----------|-----------------|-----------|---------|
| autostart | Virtual Machine | Autostart | Boolean |
| backup | Virtual Disk | Backup | Boolean |
| dns_name | Prefix | DNS Name | Text |
### On the PVE API
You'll need to create a dedicated user (ex: netsync) on your PVE cluster and then create an API token.
The user needs to have access to the VM.Monitor, Pool.Audit, VM.Audit permissions.
The following env variables will need to be set:
- **PVE_API_HOST**: The DNS/IP to your PVE instance. (ex: 10.10.0.10)
- **PVE_API_USER**: The username of the account created previously. (ex: netsync@pve)
- **PVE_API_TOKEN**: The name of the API token created previously. (ex: test-token)
- **PVE_API_SECRET**: The API token created previously (ex: 4d46dc0a-6363-47a2-98df-d5cdfefa33d2)
## Executing the script
You can then execute the script using the following command:
```
PVE_API_HOST=xx PVE_API_USER=xx PVE_API_TOKEN=xx PVE_API_SECRET=xx NB_API_URL=xx NB_API_TOKEN=xx python3 -m netbox_pve_sync
```