# eve4pve-autosnap

**Repository Path**: geekpi/eve4pve-autosnap

## Basic Information

- **Project Name**: eve4pve-autosnap
- **Description**: https://github.com/EnterpriseVE/eve4pve-autosnap
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-03-12
- **Last Updated**: 2024-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# eve4pve-autosnap

[![License](https://img.shields.io/github/license/EnterpriseVE/eve4pve-autosnap.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Gitter](https://badges.gitter.im/EnterpriseVE/eve4pve-autosnap.svg)](https://gitter.im/EnterpriseVE/eve4pve-autosnap)
[![Release](https://img.shields.io/github/release/EnterpriseVE/eve4pve-autosnap.svg)](https://github.com/EnterpriseVE/eve4pve-autosnap/releases/latest)


Proxmox VE automatic snapshot tool

[More information about eve4pve-autosnap](http://www.enterpriseve.com/protezione-continua-dei-dati-proxmox-ve/)

[More information about Qemu guest agent](https://pve.proxmox.com/wiki/Qemu-guest-agent)

```text
    ______      __                       _              _    ________
   / ____/___  / /____  _________  _____(_)_______     | |  / / ____/
  / __/ / __ \/ __/ _ \/ ___/ __ \/ ___/ / ___/ _ \    | | / / __/
 / /___/ / / / /_/  __/ /  / /_/ / /  / (__  )  __/    | |/ / /___
/_____/_/ /_/\__/\___/_/  / .___/_/  /_/____/\___/     |___/_____/
                         /_/

EnterpriseVE automatic snapshot for Proxmox VE      (Made in Italy)

Usage:
    eve4pve-autosnap <COMMAND> [ARGS] [OPTIONS]
    eve4pve-autosnap help
    eve4pve-autosnap version

    eve4pve-autosnap create  --vmid=<string> --label=<string> --keep=<integer>
                             --vmstate --script=<string> --syslog
                             --exclude-vmid=<string>
    eve4pve-autosnap destroy --vmid=<string> --label=<string>
    eve4pve-autosnap enable  --vmid=<string> --label=<string>
    eve4pve-autosnap disable --vmid=<string> --label=<string>

    eve4pve-autosnap status
    eve4pve-autosnap clean   --vmid=<string> --label=<string> --keep=<integer>

    eve4pve-autosnap snap    --vmid=<string> --label=<string> --keep=<integer>
                             --vmstate --script=<string> --syslog
                             --exclude-vmid=<string>

Commands:
    version                  Show version program.
    help                     Show help program.
    create                   Create snap job from scheduler.
    destroy                  Remove snap job from scheduler.
    enable                   Enable snap job from scheduler.
    disable                  Disable snap job from scheduler.
    status                   Get list of all auto snapshots.
    clean                    Remove all auto snapshots.
    snap                     Will snap one time.

Options:
    --vmid=string            The ID of the VM/CT, comma separated (es. 100,101,102),
                             'all' for all VM/CT in node.
    --exclude-vmid           Exclude ID of the VM/CT, comma separated (es. 100,101,102).
    --vmstate                Save the vmstate only qemu.
    --label=string           Is usually 'hourly', 'daily', 'weekly', or 'monthly'.
    --keep=integer           Specify the number of snapshots which should will keep. Default 1.
    --script=string          Use specified hook script.
                             Es. /usr/share/doc/eve4pve-autosnap/examples/script-hook.sh
    --syslog                 Write messages into the system log.

Report bugs to <support@enterpriseve.com>.
```

## Introduction

Automatic snapshot for Proxmox VE with retention.

## Main features

* For KVM and LXC
* Work forn single node or cluster
* Cluster cron in /etc/pve/eve/autosnap/autosnap.cron unique for all
* Can keep multiple snapshots
* Syslog integration
* Clean all snapshots
* Multiple schedule VM using --label (es. daily,monthly)
* Hook script
* Multiple VM (100,102 or all) single execution
* Exclude VM parameter

## Limit

The vm run in same machine on Proxmox VE.

## Configuration and use

Download package eve4pve-autosnap_?.?.?-?_all.deb, on your Proxmox VE host and install:

```sh
wget https://github.com/EnterpriseVE/eve4pve-autosnap/releases/latest
dpkg -i eve4pve-autosnap_?.?.?-?_all.deb
```

This tool need basically no configuration.

## Snap a VM one time

```sh
root@pve1:~# eve4pve-autosnap snap --vmid=111 --label='daily' --keep=2
```

This command snap VM 111. The --keep tells that it should be kept 2 snapshots, if there are more than 2 snapshots, the 3 one will be erased (sorted by creation time).

## Create a recurring snap job

```sh
root@pve1:~# eve4pve-autosnap create --vmid=111 --label='daily' --keep=5
```

## Delete a recurring snap job

```sh
root@pve1:~# eve4pve-autosnap destroy --vmid=111 --label='daily' --keep=5
```

## Pause a snap job

```sh
root@pve1:~# eve4pve-autosnap disable --vmid=111 --label='daily' --keep=5
```

## Reactivate a snap job

```sh
root@pve1:~# eve4pve-autosnap enable --vmid=111 --label='daily' --keep=5
```

## Reactivate status snap

```sh
root@pve1:~# eve4pve-autosnap status

VM   SNAPSHOTS          LABEL
101  17-01-14 17:30:56  hourly
102  17-01-14 17:30:56  hourly
105  17-01-14 17:30:56  hourly
111  17-01-14 17:30:56  hourly
```

## Changing parameters

You can edit the configuration in /etc/pve/eve/autosnap/eve4pve-autosnap.cron or destroy the job and create it new.