BSD Ports

filesystems/zfsnap 1.11.1_1 DragonFly

Simple sh script to make zfs rolling snaphosts with cron

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
BSD3CLAUSE
Categories
filesystems, sysutils
Package size
6.6 KiB, 25.0 KiB installed

Description

zfSnap is a simple sh script for creating ZFS snapshots. When called from cron rolling snapshots can be created and deleted automatically. The main advantage of zfSnap is that it is written in 100%25 pure /bin/sh, does not require any additional software to run, and is simple to use.

zfSnap keeps all information about snapshot in snapshot name. zfs snapshot names are in form: Timestamp--TTL where timestamp is date and time of snapshot creation and TTL is Time To Live in human readable form.

In the other systems

SystemPortVersion
DragonFlyfilesystems/zfsnap1.11.1_1
FreeBSDfilesystems/zfsnap1.11.1_1
MidnightBSDfilesystems/zfsnap1.11.1
HardenedBSDfilesystems/zfsnap1.11.1_1
GhostBSDfilesystems/zfsnap1.11.1_1

Install

Binary package:

pkg install zfsnap

From DPorts:

cd /usr/dports/filesystems/zfsnap && make install clean

Dependencies

No port depends on this one.

Configuration

No options to configure.

Service scripts
none

Message after installing

To run zfSnap periodically you can add these options to your
	/etc/periodic.conf

	xPERIODICx_zfsnap_enable	- Enable xPERIODICx snapshots
					  (values: YES | NO)
	xPERIODICx_zfsnap_fs		- Space separated zfs filesystems
					  to create non-recursive snapshots
	xPERIODICx_zfsnap_recursive_fs	- Space separated zfs filesystems
					  to create recursive snapshots
	xPERIODICx_zfsnap_ttl		- Set Time To Live
	xPERIODICx_zfsnap_verbose	- Verbose output (values: YES | NO)
	xPERIODICx_zfsnap_flags		- zfSnap generic flags
					  (except -v and -d)
	xPERIODICx_zfsnap_enable_prefix - Create snapshots with prefix
					  (Default = YES)
	xPERIODICx_zfsnap_prefix	- Set prefix to use for new snapshots
					  (Default = "xPERIODICx-")
	(where xPERIODICx is any of hourly, daily, weekly, monthly, reboot)

	xPERIODICx_zfsnap_delete_enable    - Delete old snapshots periodically
					     (values: YES | NO)
	xPERIODICx_zfsnap_delete_flags	   - zfSnap generic flags
					     (except -v and -d)
	xPERIODICx_zfsnap_delete_verbose   - Verbose output (values: YES | NO)
	xPERIODICx_zfsnap_delete_prefixes  - Space separated list of prefixes
					     of old zfSnap snapshots to delete
					     'hourly-', 'daily-', 'weekly-',
					     'monthly-' and 'reboot-' prefixes
					     are hard-coded
	(where xPERIODICx is any of daily, weekly, monthly)


	Add these lines to your /etc/crontab
	4	*	*	*	*	root	periodic hourly
	@reboot					root	periodic reboot

	NOTE: it is not recommended to delete zfSnap snapshots every hour.
	Deleting zfs snapshots takes more time than creating them.
	There for it's better to delete snapshots once per day...


	Periodic scripts provide very limited feature set. If you want to use
	more advanced setup, you need to call zfSnap from crontab directly.
	This way you can combine all sort of parameter combinations.

	Don't forget to check https://github.com/graudeejs/zfSnap/wiki for more
	info.

	Feedback welcomed: [email protected]