Install cv4pve-autosnap using Winget - wingetCollections

cv4pve-autosnap Corsinvest Srl

automation backup container corsinvest proxmox proxmoxve snapshot virtualization vm

Use this command to install cv4pve-autosnap:

winget install --id=Corsinvest.cv4pve.autosnap -e

cv4pve-autosnap is an automatic snapshot tool designed for Proxmox VE virtual machines and containers. It streamlines backup processes by creating snapshots with retention policies, ensuring efficient data management.

Key Features:

Automatic snapshot creation with configurable retention policies to manage data effectively.
Support for both virtual machines (VMs) and containers within the Proxmox VE environment.
Flexible targeting patterns enabling ID/name-based selection, bulk operations, and pool-based selections.
Integration capabilities through pre/post snapshot hook scripts for customized automation workflows.
Utilization of multiple labels to organize snapshots according to different schedules or purposes.

Audience & Benefit: Ideal for system administrators managing Proxmox VE environments, cv4pve-autosnap provides reliable backups and efficient data management. Its features enhance flexibility in targeting specific VMs or containers, integrate seamlessly with existing automation scripts, and maintain data integrity through retention policies.

This tool can be installed via winget, offering a straightforward setup process for users familiar with Proxmox VE environments.

README

cv4pve-autosnap

     ______                _                      __
    / ____/___  __________(_)___ _   _____  _____/ /_
   / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
  / /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
  \____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/

Automatic Snapshot Tool for Proxmox VE (Made in Italy)

> Automatic snapshot management for Proxmox VE — create, retain and clean snapshots of VM/CT with a single command.

Quick Start

wget https://github.com/Corsinvest/cv4pve-autosnap/releases/download/VERSION/cv4pve-autosnap-linux-x64.zip
unzip cv4pve-autosnap-linux-x64.zip
./cv4pve-autosnap --host=YOUR_HOST --api-token=user@realm!token=uuid --vmid=100 snap --label=daily --keep=7

Installation

Platform	Command
Linux	`wget .../cv4pve-autosnap-linux-x64.zip && unzip cv4pve-autosnap-linux-x64.zip && chmod +x cv4pve-autosnap`
Windows WinGet	`winget install Corsinvest.cv4pve.autosnap`
Windows manual	Download `cv4pve-autosnap-win-x64.zip` from Releases
Arch Linux

Versions

2.1.1

2.1.0

2.0.1

2.0.0

1.21.0

1.20.0

1.19.0

1.18.0

1.17.0

Website

github.com

License

Last updated

4/20/2026

Download latest version

yay -S cv4pve-autosnap

Permission	Purpose	Scope
VM.Audit	Read VM/CT configuration and status	Virtual machines
VM.Snapshot	Create and delete snapshots	Virtual machines
Datastore.Audit	Check storage capacity	Storage systems
Pool.Allocate	Access pool information	Resource pools

# Create snapshots with retention
cv4pve-autosnap --host=pve.local --api-token=user@realm!token=uuid --vmid=100 snap --label=daily --keep=7

# Clean old snapshots
cv4pve-autosnap --host=pve.local --api-token=user@realm!token=uuid --vmid=100 clean --label=daily --keep=7

# View snapshot status
cv4pve-autosnap --host=pve.local --api-token=user@realm!token=uuid --vmid=100 status

# Dry-run (no changes)
cv4pve-autosnap --host=pve.local --api-token=user@realm!token=uuid --vmid=100 --dry-run snap --label=daily --keep=7

# Parallel snapshots (up to 5 VMs at once)
cv4pve-autosnap --host=pve.local --api-token=user@realm!token=uuid --vmid=@all snap --label=daily --keep=7 --max-parallel 5

# Parameter file (recommended for complex setups)
cv4pve-autosnap @/etc/cv4pve/production.conf snap --label=daily --keep=14

# Run up to 5 snapshots in parallel
cv4pve-autosnap --host=pve.local --api-token=token --vmid=@all snap --label=daily --keep=7 --max-parallel 5

Pattern	Example	Description
Single ID	`--vmid=100`	Specific VM/CT by ID
Single name	`--vmid=web-server`	Specific VM/CT by name
Multiple	`--vmid=100,101,web-server`	Comma-separated list
Range	`--vmid=100:110`	Range of IDs (inclusive)
Wildcard	`--vmid=%web%`	Contains pattern
All VMs	`--vmid=@all`	All VMs in cluster
Pool	`--vmid=@pool-production`	All VMs in specific pool
Tag	`--vmid=@tag-backup`	All VMs with specific tag
Node	`--vmid=@node-pve1`	All VMs on specific node
Exclusion	`--vmid=@all,-100,-test-vm`	Exclude specific VMs
Tag exclusion	`--vmid=@all,-@tag-test`	Exclude VMs with tag

# Daily snapshot at 2 AM (keep 7 days)
0 2 * * * /usr/local/bin/cv4pve-autosnap --host=pve.local --api-token=backup@pve!daily=uuid --vmid=@tag-production snap --label=daily --keep=7

# Weekly snapshot on Sunday at 3 AM (keep 4 weeks)
0 3 * * 0 /usr/local/bin/cv4pve-autosnap --host=pve.local --api-token=backup@pve!weekly=uuid --vmid=@all snap --label=weekly --keep=4

# Monthly cleanup on 1st at 4 AM
0 4 1 * * /usr/local/bin/cv4pve-autosnap --host=pve.local --api-token=backup@pve!clean=uuid --vmid=@all clean --label=monthly --keep=12

CV4PVE_AUTOSNAP_PHASE        # snap-create-pre, snap-create-post, snap-remove-pre, snap-remove-post, ...
CV4PVE_AUTOSNAP_VMID         # VM/CT ID
CV4PVE_AUTOSNAP_VMNAME       # VM/CT name
CV4PVE_AUTOSNAP_VMTYPE       # qemu or lxc
CV4PVE_AUTOSNAP_LABEL        # Snapshot label
CV4PVE_AUTOSNAP_KEEP         # Retention count
CV4PVE_AUTOSNAP_SNAP_NAME    # Snapshot name
CV4PVE_AUTOSNAP_VMSTATE      # Memory state included (1/0)
CV4PVE_AUTOSNAP_DURATION     # Operation duration in seconds
CV4PVE_AUTOSNAP_STATE        # Operation status (1/0)
CV4PVE_AUTOSNAP_DEBUG        # Debug mode (1/0)
CV4PVE_AUTOSNAP_DRY_RUN      # Dry-run mode (1/0)

Phase	Description
`snap-job-start`	Before the entire snap job starts
`snap-job-end`	After the entire snap job ends
`snap-create-pre`	Before creating a snapshot for a VM
`snap-create-post`	After creating a snapshot for a VM
`snap-create-abort`	When snapshot creation fails
`snap-remove-pre`	Before removing an old snapshot
`snap-remove-post`	After removing an old snapshot
`snap-remove-abort`	When snapshot removal fails
`clean-job-start`	Before the entire clean job starts
`clean-job-end`	After the entire clean job ends

#!/bin/bash
case $CV4PVE_AUTOSNAP_PHASE in
    "snap-create-pre")
        echo "Starting snapshot for VM $CV4PVE_AUTOSNAP_VMID"
        ;;
    "snap-create-post")
        echo "Completed snapshot $CV4PVE_AUTOSNAP_SNAP_NAME"
        ;;
esac

cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 snap --label=daily --keep=7 --script-hook=/opt/scripts/hook.sh

Setting	Effect	Default
`--max-parallel 1`	Sequential — one VM at a time	default
`--max-parallel N`	Up to N VMs snapshotted concurrently	—

cv4pve-autosnap Corsinvest Srl

README

cv4pve-autosnap

Quick Start

Installation

Features

Required Permissions

Usage

Performance

VM/CT Selection

Scheduling with Cron

Hook Scripts

Example Hook Script

Using Hook Scripts

Resources

Support