Logo

Proxmox Backup


Quick search

Navigation

Table of Contents

  • Introduction
    • What is Proxmox Backup Server?
    • Architecture
    • Main Features
    • Reasons for Data Backup?
    • Software Stack
    • Getting Help
      • Enterprise Support
      • Community Support Forum
      • Mailing Lists
      • Bug Tracker
    • License
    • History
  • Installation
    • System Requirements
      • Minimum Server Requirements, for Evaluation
      • Recommended Server System Requirements
      • Supported Web Browsers for Accessing the Web Interface
    • Installation Medium
      • Prepare Installation Medium
      • Prepare a USB Flash Drive as Installation Medium
      • Instructions for GNU/Linux
      • Instructions for macOS
      • Instructions for Windows
      • Use the Installation Medium
    • Server Installation
      • Install Proxmox Backup Server using the Installer
      • Install Proxmox Backup Server Unattended
      • Install Proxmox Backup Server on Debian
      • Install Proxmox Backup Server on Proxmox VE
    • Client Installation
      • Install Proxmox Backup Client on Debian
      • Install Statically Linked Proxmox Backup Client
    • Debian Package Repositories
      • SecureApt
      • Proxmox Backup Enterprise Repository
      • Proxmox Backup No-Subscription Repository
      • Proxmox Backup Test Repository
      • Proxmox Backup Client-only Repository
      • Repository Access Behind HTTP Proxy
  • Terminology
    • Backup Content
      • Image Archives: <name>.img
      • File Archives: <name>.pxar
      • Binary Data (BLOBs)
      • Catalog File: catalog.pcat1
      • The Manifest: index.json
    • Backup Namespace
    • Backup Type
    • Backup ID
    • Backup Time
    • Backup Group
    • Backup Snapshot
  • Graphical User Interface
    • Features
    • Login
      • Consent Banner
    • GUI Overview
    • Sidebar
      • Dashboard
      • Configuration
      • Administration
      • Tape Backup
      • Datastore
  • Backup Storage
    • Disk Management
    • Datastore
      • Datastore Configuration
      • Backup Namespaces
      • Options
    • Ransomware Protection & Recovery
      • Built-in Protection
      • The 3-2-1 Rule with Proxmox Backup Server
      • Restrictive User & Access Management
      • Ransomware Detection
      • General Prevention Methods and Best Practices
  • User Management
    • User Configuration
    • API Tokens
    • Access Control
      • Privileges
      • Access Roles
      • Objects and Paths
      • Configuration & Management
      • API Token Permissions
      • Effective Permissions
    • Two-Factor Authentication
      • Introduction
      • Available Second Factors
      • Setup
      • TFA and Automated Access
      • Limits and Lockout of Two-Factor Authentication
    • Authentication Realms
      • Linux PAM
      • Proxmox Backup authentication server
      • LDAP
      • Active Directory
  • Backup Client Usage
    • Backup Repository Locations
    • Statically Linked Backup Client
    • Environment Variables
    • System and Service Credentials
    • Output Format
    • Creating Backups
      • Excluding Files/Directories from a Backup
      • Change Detection Mode
    • Encryption
      • Using a Master Key to Store and Recover Encryption Keys
    • Restoring Data
      • Interactive Restores
      • Mounting of Archives via FUSE
    • Login and Logout
    • Changing the Owner of a Backup Group
    • Pruning and Removing Backups
    • Garbage Collection
    • Benchmarking
  • Proxmox VE Integration
    • Using the Proxmox VE Web-Interface
    • Using the Proxmox VE Command Line
  • pxar Command-line Tool
    • Creating an Archive
    • Extracting an Archive
    • List the Contents of an Archive
    • Mounting an Archive
  • Tape Backup
    • Tape Technology Primer
    • Supported Hardware
      • Drive Performance
      • LTO-9+ considerations
    • Terminology
    • Tape Quick Start
    • Configuration
      • Tape changers
      • Tape drives
      • Media Pools
      • Tape Backup Jobs
    • Administration
      • Label Tapes
      • Run Tape Backups
      • Restore from Tape
      • Update Inventory
      • Restore Catalog
      • Encryption Key Management
      • Tape Cleaning
    • WORM Tapes
    • Example Setups
      • Single Continued Media Set
      • Weekday Scheme
      • Multiple Pools with Different Policies
    • Disaster Recovery
      • Setting Up a Datastore
      • Setting Up the Tape Drive
      • Restoring Data From the Tape
  • Managing Remotes & Sync
    • Remote
    • Sync Jobs
      • Namespace Support
      • Bandwidth Limit
      • Sync Direction Push
  • Maintenance Tasks
    • Pruning
      • Prune Simulator
      • Prune Jobs
      • Manual Pruning
      • Retention Settings Example
    • Garbage Collection
      • GC Background
      • Manually Starting GC
      • Scheduled GC
    • Verification
    • Notifications
    • Maintenance Mode
  • Host System Administration
    • ZFS on Linux
      • Hardware
      • ZFS Administration
    • Host Bootloader
      • Partitioning Scheme Used by the Installer
      • Synchronizing the Content of the ESP with proxmox-boot-tool
      • Determine which Bootloader is Used
      • Grub
      • Systemd-boot
      • Editing the Kernel Commandline
      • Override the Kernel-Version for next Boot
      • Secure Boot
    • Certificate Management
      • Certificates for the API and SMTP
      • Upload Custom Certificate
      • Trusted certificates via Let’s Encrypt (ACME)
      • ACME HTTP Challenge Plugin
      • ACME DNS API Challenge Plugin
      • Automatic renewal of ACME certificates
      • Manually Change Certificate over the Command Line
    • External Metric Server
      • InfluxDB (HTTP) plugin configuration
      • InfluxDB (UDP) plugin configuration
    • Service Daemons
      • proxmox-backup-proxy
      • proxmox-backup
    • Command-line Tools
      • proxmox-backup-client
      • proxmox-backup-manager
      • proxmox-tape
      • pmt
      • pmtx
      • pxar
      • proxmox-file-restore
      • proxmox-backup-debug
  • Network Management
    • Traffic Control
  • Notifications
    • Overview
    • Notification Targets
      • Sendmail
      • SMTP
      • Gotify
      • Webhook
    • Notification Matchers
      • Calendar Matching Rules
      • Field Matching Rules
      • Severity Matching Rules
    • Notification Events
    • System Mail Forwarding
    • Permissions
    • Notification Mode
      • Settings for legacy-sendmail notification mode
    • Overriding Notification Templates
  • Technical Overview
    • Datastores
    • Snapshots
    • Chunks
      • Fixed-Sized Chunks
      • Dynamically Sized Chunks
      • Encrypted Chunks
      • Change Detection Mode for File-Based Backups
    • Caveats and Limitations
      • Notes on Hash Collisions
      • File-Based Backup
      • Verification of Encrypted Chunks
    • Troubleshooting
      • Restore without a Running Proxmox Backup Server
  • FAQ
    • What distribution is Proxmox Backup Server (PBS) based on?
    • Which platforms are supported as a backup source (client)?
    • Will Proxmox Backup Server run on a 32-bit processor?
    • How long will my Proxmox Backup Server version be supported?
    • How can I upgrade Proxmox Backup Server to the next point release?
    • How can I upgrade Proxmox Backup Server to the next major release?
    • Can I copy or synchronize my datastore to another location?
    • Can Proxmox Backup Server verify data integrity of a backup archive?
    • When backing up to remote servers, do I have to trust the remote server?
    • Is the backup incremental/deduplicated/full?

Appendix

  • Command Syntax
    • proxmox-backup-client
    • proxmox-backup-manager
    • proxmox-tape
    • pmt
    • pmtx
    • pxar
    • proxmox-file-restore
    • proxmox-backup-debug
  • Configuration Files
    • acl.cfg
    • datastore.cfg
    • domains.cfg
    • media-pool.cfg
    • node.cfg
    • notifications.cfg
    • notifications-priv.cfg
    • prune.cfg
    • tape.cfg
    • tape-job.cfg
    • user.cfg
    • remote.cfg
    • sync.cfg
    • verification.cfg
  • File Formats
    • Proxmox File Archive Format (.pxar)
    • Proxmox File Archive Format - Meta (.mpxar)
    • Proxmox File Archive Format - Payload (.ppxar)
    • Data Blob Format (.blob)
    • Fixed Index Format (.fidx)
    • Dynamic Index Format (.didx)
  • Backup Protocol
    • Backup Protocol API
    • Restore/Reader Protocol API
  • Calendar Events
    • Introduction and Format
    • Differences to systemd
    • Notes on Scheduling
  • Markdown Primer
    • Markdown Basics
  • Glossary
  • GNU Free Documentation License

  • API Viewer
  • LTO Barcode Generator
  • PDF
  • Proxmox Backup Server Wiki
  • Proxmox Homepage
  • Prune Simulator

Related Topics

  • Documentation overview

Index

C | D | F | R | S | V

C

  • Container

D

  • Datastore

F

  • FUSE

R

  • Remote
  • reStructuredText
  • Rust

S

  • Sphinx

V

  • Virtual machine
 
©2019-2025, Proxmox Server Solutions GmbH.