wingetCollections
  • Auto
  • Search
  • Awesome Collections
  • Awesome Programs
  • My Favorite Collections
  • My Collections
  • Account / Settings
  • Terms of Service
  • Privacy
  • About

© 2026 winget.ragerworks.com

Loading...
Install cv4pve-autosnap using Winget - wingetCollections
  1. Go back
  2. Packages
  3. cv4pve-autosnap
cv4pve-autosnap logo

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)

License Release Downloads NuGet

Quick Start

# Check available releases at: https://github.com/Corsinvest/cv4pve-autosnap/releases
# Download specific version (replace VERSION with actual version number)
wget https://github.com/Corsinvest/cv4pve-autosnap/releases/download/VERSION/cv4pve-autosnap-linux-x64.zip
unzip cv4pve-autosnap-linux-x64.zip

# Create snapshot with retention
./cv4pve-autosnap --host=YOUR_HOST --username=root@pam --password=YOUR_PASSWORD --vmid=100 snap --label=daily --keep=7

# Clean old snapshots
./cv4pve-autosnap --host=YOUR_HOST --username=root@pam --password=YOUR_PASSWORD --vmid=100 clean --label=daily

Features

Core Capabilities

Performance & Reliability

  • Native C# implementation
  • Cross-platform (Windows, Linux, macOS)
  • API-based operation (no root access required)
  • Cluster support with automatic VM/CT resolution
  • High availability with multiple host support

Flexible Targeting

  • ID or name based VM/CT selection
  • Bulk operations with pattern matching
  • Pool-based selections (@pool-customer1)
  • Tag-based selections (@tag-production)
  • Node-specific operations ()
Versions
1.19.0
1.18.0
1.17.0
Website
github.com
License
Last updated
12/24/2025
Download latest version
@node-pve1

Advanced Management

  • Intelligent retention with configurable keep policies
  • Multiple schedules using labels (daily, weekly, monthly)
  • Hook scripts for custom automation
  • Memory state preservation with --state
  • Storage monitoring with capacity checks

Enterprise Features

  • API token support (Proxmox VE 6.2+)
  • SSL validation options
  • Timeout management for operations
  • Error resilience (no stop on error)
  • Comprehensive logging and status reporting

Installation

Linux Installation

# Check available releases and get the specific version number
# Visit: https://github.com/Corsinvest/cv4pve-autosnap/releases

# Download specific version (replace VERSION with actual version like v1.2.3)
wget https://github.com/Corsinvest/cv4pve-autosnap/releases/download/VERSION/cv4pve-autosnap-linux-x64.zip

# Alternative: Get latest release URL programmatically
LATEST_URL=$(curl -s https://api.github.com/repos/Corsinvest/cv4pve-autosnap/releases/latest | grep browser_download_url | grep linux-x64 | cut -d '"' -f 4)
wget "$LATEST_URL"

# Extract and make executable
unzip cv4pve-autosnap-linux-x64.zip
chmod +x cv4pve-autosnap

# Optional: Move to system path
sudo mv cv4pve-autosnap /usr/local/bin/

Windows Installation

Option 1: Winget (Recommended)

# Install using Windows Package Manager
winget install Corsinvest.cv4pve-autosnap

Option 2: Manual Installation

# Check available releases at: https://github.com/Corsinvest/cv4pve-autosnap/releases
# Download specific version (replace VERSION with actual version)
Invoke-WebRequest -Uri "https://github.com/Corsinvest/cv4pve-autosnap/releases/download/VERSION/cv4pve-autosnap-win-x64.zip" -OutFile "cv4pve-autosnap.zip"

# Extract
Expand-Archive cv4pve-autosnap.zip -DestinationPath "C:\Tools\cv4pve-autosnap"

# Add to PATH (optional)
$env:PATH += ";C:\Tools\cv4pve-autosnap"

macOS Installation

# Check available releases at: https://github.com/Corsinvest/cv4pve-autosnap/releases
# Download specific version (replace VERSION with actual version)
wget https://github.com/Corsinvest/cv4pve-autosnap/releases/download/VERSION/cv4pve-autosnap-osx-x64.zip
unzip cv4pve-autosnap-osx-x64.zip
chmod +x cv4pve-autosnap

# Move to applications
sudo mv cv4pve-autosnap /usr/local/bin/

Configuration

Authentication Methods

Username/Password

cv4pve-autosnap --host=192.168.1.100 --username=backup@pve --password=your_password [commands]

API Token (Recommended)

cv4pve-autosnap --host=192.168.1.100 --api-token=backup@pve!token1=uuid-here [commands]

Password from File

# Use interactive password prompt that stores to file
cv4pve-autosnap --host=192.168.1.100 --username=backup@pve --password=file:/etc/cv4pve/password [commands]

# First run: prompts for password and saves to file
# Subsequent runs: reads password from file automatically

VM/CT Selection Patterns

The --vmid parameter supports powerful pattern matching based on the GetVmsAsync method with jolly patterns:

PatternSyntaxDescriptionExample
Single IDIDSpecific VM/CT by ID--vmid=100
Single NamenameSpecific VM/CT by name--vmid=web-server
Multiple IDsID,ID,IDComma-separated list--vmid=100,101,102
Mixed ID/NamesID,name,IDMix IDs and names--vmid=100,web-server,102
ID Rangesstart:endRange of IDs (inclusive)--vmid=100:110
Complex Rangesstart:end,ID,start:endMultiple ranges and IDs--vmid=100:107,200,300:305
Wildcard Names%pattern%Contains pattern--vmid=%web%,%db%
Prefix Matchpattern%Starts with pattern--vmid=web%,db%
Suffix Match%patternEnds with pattern--vmid=%server,%prod
All VMs@allAll VMs in cluster--vmid=@all
All on Node@all-nodeAll VMs on specific node--vmid=@all-pve1
All on Current@all-$(hostname)All VMs on current host--vmid=@all-$(hostname)
Pool Selection@pool-nameAll VMs in specific pool--vmid=@pool-production
Tag Selection@tag-nameAll VMs with specific tag--vmid=@tag-backup
Node Selection@node-nameAll VMs on specific node--vmid=@node-pve1
Node Current@node-$(hostname)All VMs on current host--vmid=@node-$(hostname)
Exclusions-ID or -nameExclude specific VM/CT--vmid=@all,-100,-test-vm
Wildcard Exclusions-%pattern%Exclude pattern matches--vmid=@all,-%test%,-%dev%
Range Exclusions-start:endExclude range of IDs--vmid=@all,-200:299
Tag Exclusions-@tag-nameExclude VMs with tag--vmid=@all,-@tag-test
Pool Exclusions-@pool-nameExclude pool VMs--vmid=@pool-prod,-@pool-dev
Node Exclusions-@node-nameExclude node VMs--vmid=@all,-@node-pve2

Pattern Examples

Real-World Selection Examples

Basic Selections

# Single VM by ID
--vmid=100

# Single VM by name
--vmid=database-server

# Multiple VMs mixed
--vmid=100,web-server,102,mail-server

# Range of VMs
--vmid=100:110

# Complex ranges
--vmid=100:107,-105,200:204,300

# Wildcard patterns with %
--vmid=web%,db%,%server  # web*, db*, *server
--vmid=%test%,%dev%      # *test*, *dev*

Advanced Pool & Tag Selections

# All VMs in production pool
--vmid=@pool-production

# All VMs tagged as critical
--vmid=@tag-critical

# All VMs on specific node
--vmid=@node-pve1

# All VMs on current hostname
--vmid=@node-$(hostname)

Exclusion Patterns

# All VMs except specific IDs
--vmid=@all,-100,-101

# All VMs except by name
--vmid=@all,-test-vm,-backup-server

# All VMs except wildcard patterns
--vmid=@all,-%test%,-%dev%

# All VMs except range
--vmid=@all,-200:299

# Production pool except test tagged
--vmid=@pool-production,-@tag-test

# All except specific node
--vmid=@all,-@node-pve2

# Complex exclusions with wildcards
--vmid=@all,-100:110,-@tag-development,-%test%

Wildcard Pattern Examples

# Contains pattern (equivalent to *web* in shell)
--vmid=%web%              # Matches: web-server, my-web-app, web01

# Starts with pattern (equivalent to web* in shell)
--vmid=web%               # Matches: web-server, webmail, web01

# Ends with pattern (equivalent to *server in shell)
--vmid=%server            # Matches: web-server, mail-server, db-server

# Multiple wildcard patterns
--vmid=web%,db%,%prod     # web*, db*, *prod

# Complex selections with wildcards
--vmid=%web%,%db%,100:110,mail-server

# Exclude wildcard patterns
--vmid=@all,-%test%,-%dev%,-%staging%

Usage Examples

Basic Snapshot Operations

Create Snapshots

Single VM Snapshot

cv4pve-autosnap --host=pve.domain.com --username=root@pam --password=secret --vmid=100 snap --label=daily --keep=7

Multiple VMs with State

cv4pve-autosnap --host=pve.domain.com --api-token=backup@pve!token=uuid --vmid=100,101,102 snap --label=backup --keep=3 --state

All VMs except exclusions

cv4pve-autosnap --host=pve.domain.com --username=backup@pve --password=secret --vmid="@all,-100,-test-vm" snap --label=nightly --keep=5

Clean Old Snapshots

Clean specific label

cv4pve-autosnap --host=pve.domain.com --username=root@pam --password=secret --vmid=100 clean --label=daily

Clean with retention

cv4pve-autosnap --host=pve.domain.com --api-token=backup@pve!token=uuid --vmid=@pool-production clean --label=weekly --keep=4

Status & Monitoring

View snapshot status

cv4pve-autosnap --host=pve.domain.com --username=root@pam --password=secret --vmid=100 status

JSON output for automation

cv4pve-autosnap --host=pve.domain.com --api-token=backup@pve!token=uuid  --vmid=@all status --output=json

Advanced Targeting Examples

Production Environment Patterns

# Backup all production VMs tagged as 'critical'
cv4pve-autosnap --host=cluster.company.com --api-token=backup@pve!prod=uuid --vmid=@tag-critical snap --label=critical-daily --keep=14

# Backup entire customer pool except test VMs
cv4pve-autosnap --host=pve.company.com --username=backup@pve --password=secret --vmid="@pool-customer1,-@tag-test" snap --label=customer-backup --keep=30

# Node-specific backup with range exclusion
cv4pve-autosnap --host=pve-cluster.local --api-token=ops@pve!node1=uuid --vmid="@node-pve1,-200:299" snap --label=node1-backup --keep=7

Scheduling with Cron

Cron Examples

# Edit crontab
crontab -e

# Daily backup 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 backup 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 --state

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

Security & Permissions

Required Permissions

PermissionPurposeScope
VM.AuditRead VM/CT informationVirtual machines
VM.SnapshotCreate/delete snapshotsVirtual machines
Datastore.AuditCheck storage capacityStorage systems
Pool.AuditAccess pool informationResource pools

API Token Setup (Recommended)

Creating API Tokens

1. Generate API Token and Configure Permissions

# Follow Proxmox VE documentation for:
# - API token creation with proper privilege separation
# - Permission assignment for required roles
# - Required permissions: VM.Audit, VM.Snapshot, Datastore.Audit, Pool.Audit
# Refer to official Proxmox VE API documentation for detailed steps

2. Use Token in Commands

cv4pve-autosnap --host=pve.local --api-token=backup@pve!backup-token=uuid-from-creation [commands]

Advanced Features

Hook Scripts

Pre/Post Snapshot Automation

Hook scripts receive environment variables for custom automation:

CV4PVE_AUTOSNAP_PHASE        # pre-snapshot, post-snapshot, pre-clean, post-clean
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
CV4PVE_AUTOSNAP_STATE        # Operation status (1/0)
CV4PVE_AUTOSNAP_DEBUG        # Debug mode enabled (1/0)
CV4PVE_AUTOSNAP_DRY_RUN      # Dry run mode enabled (1/0)

The repository includes example hook scripts in the hooks/ directory for different platforms:

  • Windows Batch: hook-template.bat
  • Unix/Linux: hook-template.sh
  • PowerShell: hook-template.ps1
  • Metrics: send-metrics.sh (for sending metrics to monitoring systems)

These scripts provide templates with all available environment variables and phase handling logic that you can customize for your automation needs.

Example Hook Script

#!/bin/bash
# /usr/local/bin/cv4pve-hook.sh

case $CV4PVE_AUTOSNAP_PHASE in
    "pre-snapshot")
        echo "$(date): Starting snapshot for VM $CV4PVE_AUTOSNAP_VMID"
        # Send notification to monitoring system
        curl -X POST "https://monitoring.company.com/api/events" -d "{'type':'snapshot_start','vm':'$CV4PVE_AUTOSNAP_VMID'}"
        ;;
    "post-snapshot")
        echo "$(date): Completed snapshot $CV4PVE_AUTOSNAP_SNAP_NAME"
        # Log to central system
        logger "cv4pve-autosnap: Created snapshot $CV4PVE_AUTOSNAP_SNAP_NAME for VM $CV4PVE_AUTOSNAP_VMID"
        ;;
esac

Using Hook Scripts

cv4pve-autosnap --host=pve.local --api-token=backup@pve!token=uuid --vmid=100 --script-hook=/usr/local/bin/cv4pve-hook.sh snap --label=daily --keep=7

Storage Monitoring

Intelligent Storage Management

cv4pve-autosnap automatically monitors storage usage:

# Set custom storage threshold (default: 95%)
cv4pve-autosnap --host=pve.local --api-token=backup@pve!token=uuid --max-perc-storage=85 --vmid=@all snap --label=daily --keep=7

Storage Check Output

----------------------------------------------------------------------------
| Storage          | Type    | Valid | Used %  | Max Disk (GB) | Disk (GB) |
----------------------------------------------------------------------------
| pve-local/ssd    | zfspool | Ok    | 78.2    | 1000          | 782       |
| pve-local/hdd    | zfspool | Ok    | 45.1    | 2000          | 902       |
| nfs-backup       | nfs     | Ok    | 23.4    | 5000          | 1170      |
----------------------------------------------------------------------------

Custom Timestamp Formats

Flexible Naming Patterns

Customize snapshot naming with C# datetime format strings. The timestamp format follows the Microsoft .NET Custom Date and Time Format Strings specification.

# Default format: yyMMddHHmmss (e.g., 250811143022)
cv4pve-autosnap --vmid=100 snap --label=daily

# ISO format: yyyy-MM-dd_HH-mm-ss (e.g., 2025-08-11_14-30-22)
cv4pve-autosnap --vmid=100 --timestamp-format="yyyy-MM-dd_HH-mm-ss" snap --label=daily

# Custom format with day names: yyyyMMdd_dddd_HHmmss (e.g., 20250811_Monday_143022)
cv4pve-autosnap --vmid=100 --timestamp-format="yyyyMMdd_dddd_HHmmss" snap --label=backup

# European format: dd.MM.yyyy-HH.mm.ss (e.g., 11.08.2025-14.30.22)
cv4pve-autosnap --vmid=100 --timestamp-format="dd.MM.yyyy-HH.mm.ss" snap --label=daily

C# DateTime Format Specifiers

SpecifierDescriptionExampleResult
Year
yy2-digit yearyy25
yyyy4-digit yearyyyy2025
Month
MMonth (1-12)M8
MMMonth (01-12)MM08
MMMShort month nameMMMAug
MMMMFull month nameMMMMAugust
Day
dDay (1-31)d11
ddDay (01-31)dd11
dddShort day namedddMon
ddddFull day nameddddMonday
Hour
hHour 12-format (1-12)h2
hhHour 12-format (01-12)hh02
HHour 24-format (0-23)H14
HHHour 24-format (00-23)HH14
Minute
mMinute (0-59)m30
mmMinute (00-59)mm30
Second
sSecond (0-59)s22
ssSecond (00-59)ss22
Millisecond
fTenths of secondf7
ffHundredths of secondff72
fffMillisecondsfff722
Time Period
ttAM/PM designatorttPM

Common Format Examples

Format StringExample OutputUse Case
yyMMddHHmmss250811143022Default compact format
yyyy-MM-dd_HH-mm-ss2025-08-11_14-30-22ISO-like readable format
yyyyMMdd-HHmmss20250811-143022Date-time separation
dd.MM.yyyy-HH.mm.ss11.08.2025-14.30.22European format
yyyy_MM_dd_HH_mm_ss2025_08_11_14_30_22Underscore format
yyyyMMdd_dddd20250811_MondayDate with day name
MMM_dd_yyyy_HHmmAug_11_2025_1430Month abbreviation

Configuration Files

Parameter Files for Complex Setups

Use parameter files for complex configurations:

Create Parameter File

# /etc/cv4pve/production.conf
--host=pve-cluster.company.com
--api-token=backup@pve!production=uuid-here
--vmid=@pool-production,-@tag-test
--max-perc-storage=90
--timeout=300
--validate-certificate

Execute with Parameter File

cv4pve-autosnap @/etc/cv4pve/production.conf snap --label=daily --keep=14 --state

Multiple Environment Configs

# Development environment
cv4pve-autosnap @/etc/cv4pve/dev.conf snap --label=dev-snapshot --keep=3

# Staging environment
cv4pve-autosnap @/etc/cv4pve/staging.conf snap --label=staging --keep=5

# Production environment
cv4pve-autosnap @/etc/cv4pve/production.conf snap --label=production --keep=30

Best Practices

Snapshot Strategy Guidelines

Retention Schedules

  • Hourly: Keep 24 snapshots (1 day)
  • Daily: Keep 7-14 snapshots (1-2 weeks)
  • Weekly: Keep 4-8 snapshots (1-2 months)
  • Monthly: Keep 12 snapshots (1 year)
  • Yearly: Keep 3-5 snapshots (long-term)

Labeling Convention

  • Use descriptive labels (daily, weekly, before-update)
  • Include environment in label (prod-daily, dev-weekly)
  • Consider compliance requirements (retention-7y)

Performance Optimization

  • Schedule during low activity periods
  • Stagger snapshot times across VMs
  • Monitor storage growth regularly
  • Use memory state sparingly (larger snapshots)
  • Implement cleanup routines for old snapshots

Reliability Measures

  • Test restore procedures regularly
  • Monitor snapshot creation for failures
  • Implement alerting for storage thresholds
  • Document recovery procedures
  • Verify QEMU agent installation

Troubleshooting

Common Issues & Solutions

Authentication Problems

Issue: "Authentication failed"

# Check credentials
cv4pve-autosnap --host=pve.local --username=root@pam --password=test --vmid=100 status

# Verify API token format
cv4pve-autosnap --host=pve.local --api-token=user@realm!tokenid=uuid --vmid=100 status

Solution: Verify permissions

# Check user permissions in Proxmox
pveum user list
pveum user permissions backup@pve

Connection Issues

Issue: "Connection timeout" or "Host unreachable"

# Test connectivity
ping pve.local
telnet pve.local 8006

# Check SSL certificate
cv4pve-autosnap --host=pve.local --validate-certificate --username=root@pam --password=secret --vmid=100 status

Solution: Network and certificate verification

# Use IP instead of hostname
cv4pve-autosnap --host=192.168.1.100 ...

# Disable SSL validation for testing (not recommended for production)
cv4pve-autosnap --host=pve.local --username=root@pam --password=secret --vmid=100 status

Storage Issues

Issue: "Storage space insufficient"

# Check storage status
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 status

Solution: Adjust storage threshold

# Lower storage threshold
cv4pve-autosnap --host=pve.local --api-token=token --max-perc-storage=80 --vmid=100 snap --label=daily --keep=3

VM Selection Issues

Issue: "No VMs found matching criteria"

# Debug VM selection
cv4pve-autosnap --host=pve.local --api-token=token --vmid=@tag-nonexistent status

Solution: Verify VM tags and pools

# List all VMs to verify IDs/names
cv4pve-autosnap --host=pve.local --api-token=token --vmid=@all status

# Check specific pool
cv4pve-autosnap --host=pve.local --api-token=token --vmid=@pool-production status

Debug Mode

Enable Detailed Logging

# Enable debug output
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 --debug snap --label=debug-test --keep=1

# Test run without making changes
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 --dry-run snap --label=test --keep=3

Resources

Official Tutorial

cv4pve-autosnap Tutorial

Complete setup and usage guide

Web GUI Version

cv4pve-admin

Web interface for cv4pve-autosnap

Documentation Links

ResourceDescription
QEMU Guest AgentSetup guide for QEMU guest agent
API DocumentationProxmox VE API reference
cv4pve-tools SuiteComplete cv4pve tools ecosystem

QEMU Guest Agent Integration

Why QEMU Guest Agent Matters

> Important: Without QEMU Guest Agent, snapshots are like "pulling the power plug" on your VM. The agent ensures filesystem consistency during snapshot operations.

Without Guest Agent

  • Inconsistent filesystem state
  • Potential data corruption
  • Half-written files
  • Requires fsck on boot
  • Application data loss risk

With Guest Agent

  • Filesystem sync before snapshot
  • I/O freeze during operation
  • Clean application state
  • Reliable snapshot consistency
  • Database-safe operations

Guest Agent Verification

# Check if guest agent is working
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 status

# Look for agent warnings in output:
# "VM 100 consider enabling QEMU agent see https://pve.proxmox.com/wiki/Qemu-guest-agent"

Command Reference

Global Options

Complete Parameter List

cv4pve-autosnap [global-options] [command] [command-options]

Authentication Options

ParameterDescriptionExample
--hostProxmox host(s)--host=pve.local:8006
--usernameUsername@realm--username=backup@pve
--passwordPassword or file--password=secret or --password=file:/path
--api-tokenAPI token--api-token=user@realm!token=uuid

Connection Options

ParameterDescriptionDefault
--timeoutOperation timeout (seconds)30
--validate-certificateValidate SSL certificatefalse

Target Selection

ParameterDescriptionExample
--vmidVM/CT selection pattern--vmid=100,101,@pool-prod

Storage & Format

ParameterDescriptionDefault
--max-perc-storageMax storage usage %95
--timestamp-formatSnapshot timestamp formatyyMMddHHmmss

Output Options

ParameterDescriptionOptions
--outputOutput formattext, json, jsonpretty
--debugEnable debug modefalse
--dry-runTest run without changesfalse

Snap Command

Snapshot Creation Options

cv4pve-autosnap [global-options] snap [snap-options]

Snap-Specific Options

ParameterDescriptionRequired
--labelSnapshot label/categoryYes
--keepNumber of snapshots to retainYes
--stateInclude VM memory stateNo
--script-hookPath to hook scriptNo

Examples

# Basic snapshot with retention
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 snap --label=daily --keep=7

# Snapshot with memory state
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 snap --label=backup --keep=3 --state

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

Clean Command

Snapshot Cleanup Options

cv4pve-autosnap [global-options] clean [clean-options]

Clean-Specific Options

ParameterDescriptionNotes
--labelLabel to cleanMatches exact label
--keepSnapshots to preserve0 = remove all

Examples

# Clean old daily snapshots (keep newest 7)
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 clean --label=daily --keep=7

# Remove all snapshots with specific label
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 clean --label=old-backup --keep=0

# Clean across multiple VMs
cv4pve-autosnap --host=pve.local --api-token=token --vmid=@pool-development clean --label=test --keep=0

Status Command

Snapshot Status & Reporting

cv4pve-autosnap [global-options] status [status-options]

Status Output Formats

# Table format (default)
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 status

# JSON format for automation
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 status --output=json

# Pretty JSON for debugging
cv4pve-autosnap --host=pve.local --api-token=token --vmid=100 status --output=jsonpretty

Example Output

┌──────┬─────┬───────────────────┬──────────────────────────────┬──────────────────────────────┬─────────────────┬─────┐
│ NODE │ VM  │ TIME              │ PARENT                       │ NAME                         │ DESCRIPTION     │ RAM │
├──────┼─────┼───────────────────┼──────────────────────────────┼──────────────────────────────┼─────────────────┼─────┤
│ pve1 │ 100 │ 25/08/11 09:21:35 │ no-parent                    │ autodaily250811092135        │ cv4pve-autosnap │     │
│ pve1 │ 100 │ 25/08/11 12:23:09 │ autodaily250811092135        │ autodaily250811122309        │ cv4pve-autosnap │     │
│ pve1 │ 100 │ 25/08/12 06:50:23 │ autodaily250811122309        │ autodaily250812065023        │ cv4pve-autosnap │  X  │
└──────┴─────┴───────────────────┴──────────────────────────────┴──────────────────────────────┴─────────────────┴─────┘

Support

Professional support and consulting available through Corsinvest.

Part of cv4pve suite | Made with ❤️ in Italy by Corsinvest

Copyright © Corsinvest Srl