Tools & Add-onsPVE Tools
Proxmox VE host tools
Reference for every script in tools/pve, grouped by what you use it for.
The scripts in tools/pve/ do not create containers. They work on the host itself or on guests that already exist: updates, repositories, storage, hardware passthrough and cleanup.
How to run a tool
Open a shell on the host (web interface: node, then Shell; or SSH) as root and paste the command from the tool's page. All commands have this form:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/tools/pve/<name>.sh)"Things that hold for the whole folder:
- Most tools are interactive and need a real terminal for their dialogs. PVE LXC Apps Update can also be run unattended through variables.
- A few scripts live here but do not run on a Proxmox VE host: the four Proxmox Backup Server tools, the Mail Gateway and Datacenter Manager post-install scripts, and the two Home Assistant restore scripts, which run inside the container. Each page says where to run it.
- Almost every tool loads
api/api.funcfrom the core repository and callsinit_tool_telemetry "<name>" "pve", which reports the result of the run when the script exits. The base URL can be changed withCOMMUNITY_SCRIPTS_CORE_URL. - Read the page before you run a tool. Several of them change APT sources, delete data or stop guests, and most have no undo.
Updates and maintenance
| Tool | Summary |
|---|---|
| PVE LXC Apps Update | Runs the application updater in tagged containers, with optional backup and automatic restore on failure. |
| PVE LXC Updater | Upgrades the operating system packages of all containers, interactively. |
| PVE Cron LXC Updater | Installs and manages a weekly cron job for container OS updates. |
| update-lxcs-cron | The worker script that the cron job runs. |
| PVE Update Repositories | Rewrites /usr/bin/update in older containers from tteck/Proxmox to community-scripts/ProxmoxVE. |
| PVE LXC Execute | Runs one command in every Debian and Ubuntu container. |
| PVE Monitor-All | Service that restarts guests tagged mon-restart when they stop responding. |
Post-install and upgrades
| Tool | Summary |
|---|---|
| PVE Post Install | Repositories, subscription notice, HA services and updates on Proxmox VE 8 and 9. |
| PBS Post Install | The same for Proxmox Backup Server 3 and 4. |
| PMG Post Install | The same for Proxmox Mail Gateway. |
| Proxmox Datacenter Manager Post Install | The same for Proxmox Datacenter Manager. |
| pve8-upgrade | Upgrades Proxmox VE 7.4 to 8. |
| pbs3-upgrade | Upgrades Proxmox Backup Server 2 to 3. |
| PBS 4 Upgrade | Upgrades Proxmox Backup Server 3 to 4. |
| post-install-hook-examples | Example scripts for var_post_install, the host-side hook after a container is created. |
Storage and backup
| Tool | Summary |
|---|---|
| Storage-Share-Helper | Tests SMB, NFS and iSCSI, adds and removes Proxmox storages and LXC bind mounts, creates host shares. |
| PVE Host Backup | Archives selected host files and directories, by default from /etc. |
| PVE LXC Filesystem Trim | Runs pct fstrim on containers. |
| PVE Disk Health Tool | SMART summary for all disks and an optional short self-test. |
| PVE Privilege Converter | Converts a container between privileged and unprivileged through backup and restore. |
| container-restore-from-backup | Restores a Home Assistant backup inside a Home Assistant Container LXC. |
| core-restore-from-backup | Restores a Home Assistant backup inside a Home Assistant Core LXC. |
Hardware
| Tool | Summary |
|---|---|
| PVE Processor Microcode | Installs an Intel or AMD microcode package on a Proxmox VE host. |
| PBS Processor Microcode | The same for a bare-metal Proxmox Backup Server. |
| PVE CPU Scaling Governor | Shows and sets the CPU scaling governor, optionally at every boot. |
| PVE Kernel Pin | Pins or unpins the kernel the host boots. |
| hw-acceleration | Passes an Intel GPU into a privileged container and installs the drivers there. |
| usb-passthrough | Passes USB serial devices into a privileged container. |
| frigate-support | Passes the devices Frigate needs into a container. |
Network
| Tool | Summary |
|---|---|
| Intel e1000e NIC Offloading Fix | Disables offloading on Intel e1000e and e1000 interfaces through systemd services. |
| PVE LXC Tag | Service that writes the IP addresses of guests into their tags. |
Cleanup
| Tool | Summary |
|---|---|
| PVE LXC Cleaner | Deletes logs, caches and temporary files inside containers. |
| PVE Clean Orphaned LVM | Finds and removes LVM volumes that belong to no guest. |
| PVE Kernel Clean | Removes old kernel packages. |
| PVE Guest Deletion | Destroys selected containers and VMs. |
Related
- Copy data between containers for moving application data from one LXC to another.
- LXC add-ons for software installed into an existing container.
- Host tools for Incus are in the Incus repository; the scripts on these pages are for Proxmox products only.