mirror of
https://github.com/zfsonlinux/zfs-auto-snapshot.git
synced 2025-08-17 16:11:19 +02:00
Compare commits
73 Commits
upstream/1
...
master
Author | SHA1 | Date | |
---|---|---|---|
92db087bb0 | |||
f938d9cc1c | |||
4538217932 | |||
99e1a6103d | |||
86a95095ee | |||
363a847ee3 | |||
12945110d3 | |||
d5646c901e | |||
4a59d0d615 | |||
ef7ae674f5 | |||
b0a5909335 | |||
3689b2c43d | |||
d27bbfa650 | |||
897ca026e1 | |||
3e48c8956e | |||
3efc478828 | |||
c99de67c63 | |||
4425d681f3 | |||
6f6d1202cf | |||
6ee4553cf6 | |||
6c7da10e24 | |||
3d9992b086 | |||
f145cf6e07 | |||
838b03b41f | |||
e1268767b8 | |||
e93096c2d9 | |||
1ae1adc5f0 | |||
41eddc97cc | |||
2b7b694a95 | |||
277287f824 | |||
d49be6a2de | |||
2e1f309131 | |||
1666623191 | |||
739972f18a | |||
8c45add2c0 | |||
9c6f065589 | |||
62f5f7d920 | |||
b74769894c | |||
11130ba8d6 | |||
27413ac798 | |||
c4ad5eeac5 | |||
6e32b25d8f | |||
b2e97c5fe0 | |||
d3bdd2dc23 | |||
f2767ad43a | |||
d5cb31aaae | |||
1ce72681bf | |||
a0df1ebcc1 | |||
0be4466869 | |||
9d2398ed8e | |||
bc1b65a66e | |||
bfe4c911a8 | |||
10f9b3e336 | |||
c08f366c1c | |||
da5a8bd5b7 | |||
a1b89b6fef | |||
d625c53af1 | |||
dc6f5ddcd9 | |||
39bce83e0f | |||
6ea2d7f5b1 | |||
dd27aa1c56 | |||
f5fc21ace0 | |||
bf4e97b07d | |||
53ad1dc042 | |||
b6fba51643 | |||
cc9f1802ed | |||
d77af5a902 | |||
b5bf1149ca | |||
5fc395c2bb | |||
d99147db7a | |||
c8507a0da9 | |||
74359e51a7 | |||
afdae86271 |
9
CHANGELOG
Normal file
9
CHANGELOG
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
[ 1.2.5 (Unreleased) ]
|
||||||
|
|
||||||
|
* Start a changelog
|
||||||
|
* Accept PR#94 from aimileus/macos
|
||||||
|
- Replace --utc longform option with -u for macos compatibility
|
||||||
|
* Accept PR#107 from ArakniD/master
|
||||||
|
- Add optional label for snap removals
|
||||||
|
|
||||||
|
-- Jonathan Carter 2019-09-25, 15:24 SAST
|
33
Makefile
33
Makefile
@ -1,15 +1,28 @@
|
|||||||
|
PREFIX := /usr/local
|
||||||
|
|
||||||
all:
|
all:
|
||||||
|
|
||||||
install:
|
install:
|
||||||
install -d $(DESTDIR)$(PREFIX)/etc/cron.d
|
install -d $(DESTDIR)/etc/cron.d
|
||||||
install -d $(DESTDIR)$(PREFIX)/etc/cron.daily
|
install -d $(DESTDIR)/etc/cron.daily
|
||||||
install -d $(DESTDIR)$(PREFIX)/etc/cron.hourly
|
install -d $(DESTDIR)/etc/cron.hourly
|
||||||
install -d $(DESTDIR)$(PREFIX)/etc/cron.weekly
|
install -d $(DESTDIR)/etc/cron.weekly
|
||||||
install -d $(DESTDIR)$(PREFIX)/etc/cron.monthly
|
install -d $(DESTDIR)/etc/cron.monthly
|
||||||
install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)$(PREFIX)/etc/cron.d/zfs-auto-snapshot
|
install -m 0644 etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/zfs-auto-snapshot
|
||||||
install etc/zfs-auto-snapshot.cron.hourly $(DESTDIR)$(PREFIX)/etc/cron.daily/zfs-auto-snapshot
|
install etc/zfs-auto-snapshot.cron.hourly $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot
|
||||||
install etc/zfs-auto-snapshot.cron.daily $(DESTDIR)$(PREFIX)/etc/cron.hourly/zfs-auto-snapshot
|
install etc/zfs-auto-snapshot.cron.daily $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot
|
||||||
install etc/zfs-auto-snapshot.cron.weekly $(DESTDIR)$(PREFIX)/etc/cron.weekly/zfs-auto-snapshot
|
install etc/zfs-auto-snapshot.cron.weekly $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot
|
||||||
install etc/zfs-auto-snapshot.cron.monthly $(DESTDIR)$(PREFIX)/etc/cron.monthly/zfs-auto-snapshot
|
install etc/zfs-auto-snapshot.cron.monthly $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot
|
||||||
|
install -d $(DESTDIR)$(PREFIX)/share/man/man8
|
||||||
|
install -m 0644 src/zfs-auto-snapshot.8 $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
|
||||||
install -d $(DESTDIR)$(PREFIX)/sbin
|
install -d $(DESTDIR)$(PREFIX)/sbin
|
||||||
install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot
|
install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot
|
||||||
|
|
||||||
|
uninstall:
|
||||||
|
rm $(DESTDIR)/etc/cron.d/zfs-auto-snapshot
|
||||||
|
rm $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot
|
||||||
|
rm $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot
|
||||||
|
rm $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot
|
||||||
|
rm $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot
|
||||||
|
rm $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
|
||||||
|
rm $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot
|
||||||
|
19
README
19
README
@ -1,4 +1,21 @@
|
|||||||
An alternative implementation of the zfs-auto-snapshot service for Linux.
|
zfs-auto-snapshot:
|
||||||
|
|
||||||
|
An alternative implementation of the zfs-auto-snapshot service for Linux
|
||||||
|
that is compatible with zfs-linux and zfs-fuse.
|
||||||
|
|
||||||
|
Automatically create, rotate, and destroy periodic ZFS snapshots. This is
|
||||||
|
the utility that creates the @zfs-auto-snap_frequent, @zfs-auto-snap_hourly,
|
||||||
|
@zfs-auto-snap_daily, @zfs-auto-snap_weekly, and @zfs-auto-snap_monthly
|
||||||
|
snapshots if it is installed.
|
||||||
|
|
||||||
This program is a posixly correct bourne shell script. It depends only on
|
This program is a posixly correct bourne shell script. It depends only on
|
||||||
the zfs utilities and cron, and can run in the dash shell.
|
the zfs utilities and cron, and can run in the dash shell.
|
||||||
|
|
||||||
|
|
||||||
|
Installation:
|
||||||
|
-------------
|
||||||
|
|
||||||
|
wget https://github.com/zfsonlinux/zfs-auto-snapshot/archive/upstream/1.2.4.tar.gz
|
||||||
|
tar -xzf 1.2.4.tar.gz
|
||||||
|
cd zfs-auto-snapshot-upstream-1.2.4
|
||||||
|
make install
|
||||||
|
@ -1,2 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
|
# Only call zfs-auto-snapshot if it's available
|
||||||
|
which zfs-auto-snapshot > /dev/null || exit 0
|
||||||
|
|
||||||
exec zfs-auto-snapshot --quiet --syslog --label=daily --keep=31 //
|
exec zfs-auto-snapshot --quiet --syslog --label=daily --keep=31 //
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
PATH="/usr/bin:/bin:/usr/sbin:/sbin"
|
PATH="/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin"
|
||||||
|
|
||||||
*/15 * * * * root zfs-auto-snapshot -q -g --label=frequent --keep=4 //
|
*/15 * * * * root which zfs-auto-snapshot > /dev/null || exit 0 ; zfs-auto-snapshot --quiet --syslog --label=frequent --keep=4 //
|
||||||
@hourly root zfs-auto-snapshot -q -g --label=hourly --keep=24 //
|
|
||||||
@daily root zfs-auto-snapshot -q -g --label=daily --keep=31 //
|
|
||||||
@weekly root zfs-auto-snapshot -q -g --label=weekly --keep=4 //
|
|
||||||
@monthly root zfs-auto-snapshot -q -g --label=monthly --keep=12 //
|
|
||||||
|
@ -1,2 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
|
# Only call zfs-auto-snapshot if it's available
|
||||||
|
which zfs-auto-snapshot > /dev/null || exit 0
|
||||||
|
|
||||||
exec zfs-auto-snapshot --quiet --syslog --label=hourly --keep=24 //
|
exec zfs-auto-snapshot --quiet --syslog --label=hourly --keep=24 //
|
||||||
|
@ -1,2 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
|
# Only call zfs-auto-snapshot if it's available
|
||||||
|
which zfs-auto-snapshot > /dev/null || exit 0
|
||||||
|
|
||||||
exec zfs-auto-snapshot --quiet --syslog --label=monthly --keep=12 //
|
exec zfs-auto-snapshot --quiet --syslog --label=monthly --keep=12 //
|
||||||
|
@ -1,2 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
exec zfs-auto-snapshot --quiet --syslog --label=weekly --keep=4 //
|
|
||||||
|
# Only call zfs-auto-snapshot if it's available
|
||||||
|
which zfs-auto-snapshot > /dev/null || exit 0
|
||||||
|
|
||||||
|
exec zfs-auto-snapshot --quiet --syslog --label=weekly --keep=8 //
|
||||||
|
91
src/zfs-auto-snapshot.8
Normal file
91
src/zfs-auto-snapshot.8
Normal file
@ -0,0 +1,91 @@
|
|||||||
|
.TH ZFS-AUTO-SNAPSHOT "8" "June 16, 2013" "zfs-auto-snapshot.sh" "System Administration Commands"
|
||||||
|
.SH NAME
|
||||||
|
zfs-auto-snapshot \- take regular ZFS snapshots
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B zfs-auto-snapshot
|
||||||
|
[\fIoptions\fR] [\fI-l label\fR] \fI<'//' | name \fR[\fIname\fR...]\fI>\fR
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B zfs-auto-snapshot
|
||||||
|
automatically creates, rotates, and destroys snapshots for all your
|
||||||
|
ZFS datasets, and is compatible with both zfsonlinux and zfs-fuse.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
\fB\-\-default\-exclude\fR
|
||||||
|
By default \fBzfs-auto-snapshot\fR will snapshot all datasets except
|
||||||
|
for those in which the user-property \fBcom.sun:auto-snapshot\fR is
|
||||||
|
set to \fBfalse\fR. This option reverses the behavior and requires
|
||||||
|
\fBcom.sun:auto-snapshot\fR to be set to \fBtrue\fR.
|
||||||
|
.TP
|
||||||
|
\fB\-d\fR, \fB\-\-debug\fR
|
||||||
|
Print debugging messages.
|
||||||
|
.TP
|
||||||
|
\fB\-e\fR, \fB\-\-event\fR=\fIEVENT\fR
|
||||||
|
Set the com.sun:auto\-snapshot\-desc property to EVENT.
|
||||||
|
.TP
|
||||||
|
\fB\-\-fast\fR
|
||||||
|
Use a faster zfs list invocation.
|
||||||
|
.TP
|
||||||
|
\fB\-n\fR, \fB\-\-dry\-run\fR
|
||||||
|
Print actions without actually doing anything.
|
||||||
|
.TP
|
||||||
|
\fB\-s\fR, \fB\-\-skip\-scrub\fR
|
||||||
|
Do not snapshot filesystems in scrubbing pools.
|
||||||
|
.TP
|
||||||
|
\fB\-h\fR, \fB\-\-help\fR
|
||||||
|
Print the usage message.
|
||||||
|
.TP
|
||||||
|
\fB\-k\fR, \fB\-\-keep\fR=\fINUM\fR
|
||||||
|
Keep NUM recent snapshots and destroy older snapshots.
|
||||||
|
.TP
|
||||||
|
\fB\-l\fR, \fB\-\-label\fR=\fILAB\fR
|
||||||
|
LAB is usually 'hourly', 'daily', or 'monthly'.
|
||||||
|
.TP
|
||||||
|
\fB\-p\fR, \fB\-\-prefix\fR=\fIPRE\fR
|
||||||
|
PRE is 'zfs\-auto\-snap' by default.
|
||||||
|
.TP
|
||||||
|
\fB\-q\fR, \fB\-\-quiet\fR
|
||||||
|
Suppress warnings and notices at the console.
|
||||||
|
.TP
|
||||||
|
\fB\-\-send\-full\fR=\fIF\fR
|
||||||
|
Send zfs full backup. Unimplemented.
|
||||||
|
.TP
|
||||||
|
\fB\-\-send\-incr\fR=\fIF\fR
|
||||||
|
Send zfs incremental backup. Unimplemented.
|
||||||
|
.TP
|
||||||
|
\fB\-\-sep\fR=\fICHAR\fR
|
||||||
|
Use CHAR to separate date stamps in snapshot names.
|
||||||
|
.TP
|
||||||
|
\fB\-g\fR, \fB\-\-syslog\fR
|
||||||
|
Write messages into the system log.
|
||||||
|
.TP
|
||||||
|
\fB\-r\fR, \fB\-\-recursive\fR
|
||||||
|
Snapshot named filesystem and all descendants.
|
||||||
|
.TP
|
||||||
|
\fB\-v\fR, \fB\-\-verbose\fR
|
||||||
|
Print info messages.
|
||||||
|
.TP
|
||||||
|
\fB\-\-pre-snapshot\fR=\fICOMMAND\fR
|
||||||
|
Command to run before each dataset is snapshotted.
|
||||||
|
It is passed the dataset and snapshot name. If it
|
||||||
|
returns non-zero, snapshotting this dataset is
|
||||||
|
aborted.
|
||||||
|
.TP
|
||||||
|
\fB\-\-post-snapshot\fR=\fICOMMAND\fR
|
||||||
|
Command to run after each dataset is snapshotted.
|
||||||
|
It is passed the dataset and snapshot name.
|
||||||
|
.TP
|
||||||
|
\fB\-\-destroy-only\fR
|
||||||
|
Do not create new snapshots, but do destroy older
|
||||||
|
snapshots. Has no effect unless used with \fB\-k\fR.
|
||||||
|
.IP
|
||||||
|
A non-obvious use may be construction of cron jobs or
|
||||||
|
scripts that run pre-snapshot command(s), then run
|
||||||
|
zfs-auto-snapshot (without \fB\-k\fR) to quickly
|
||||||
|
snapshot all datasets, then run post-snapshot
|
||||||
|
command(s) and clean up with zfs-auto-snapshot
|
||||||
|
\fB\-\-destroy-only\fR.
|
||||||
|
.TP
|
||||||
|
name
|
||||||
|
Filesystem and volume names, or '//' for all ZFS datasets.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR zfs (8)
|
179
src/zfs-auto-snapshot.sh
Executable file → Normal file
179
src/zfs-auto-snapshot.sh
Executable file → Normal file
@ -29,6 +29,7 @@ opt_backup_incremental=''
|
|||||||
opt_default_exclude=''
|
opt_default_exclude=''
|
||||||
opt_dry_run=''
|
opt_dry_run=''
|
||||||
opt_event='-'
|
opt_event='-'
|
||||||
|
opt_fast_zfs_list=''
|
||||||
opt_keep=''
|
opt_keep=''
|
||||||
opt_label=''
|
opt_label=''
|
||||||
opt_prefix='zfs-auto-snap'
|
opt_prefix='zfs-auto-snap'
|
||||||
@ -38,6 +39,10 @@ opt_setauto=''
|
|||||||
opt_syslog=''
|
opt_syslog=''
|
||||||
opt_skip_scrub=''
|
opt_skip_scrub=''
|
||||||
opt_verbose=''
|
opt_verbose=''
|
||||||
|
opt_pre_snapshot=''
|
||||||
|
opt_post_snapshot=''
|
||||||
|
opt_do_snapshots=1
|
||||||
|
opt_min_size=0
|
||||||
|
|
||||||
# Global summary statistics.
|
# Global summary statistics.
|
||||||
DESTRUCTION_COUNT='0'
|
DESTRUCTION_COUNT='0'
|
||||||
@ -51,9 +56,10 @@ SNAPSHOTS_OLD=''
|
|||||||
print_usage ()
|
print_usage ()
|
||||||
{
|
{
|
||||||
echo "Usage: $0 [options] [-l label] <'//' | name [name...]>
|
echo "Usage: $0 [options] [-l label] <'//' | name [name...]>
|
||||||
--default-exclude Exclude objects if com.sun:auto-snapshot is unset.
|
--default-exclude Exclude datasets if com.sun:auto-snapshot is unset.
|
||||||
-d, --debug Print debugging messages.
|
-d, --debug Print debugging messages.
|
||||||
-e, --event=EVENT Set the com.sun:auto-snapshot-desc property to EVENT.
|
-e, --event=EVENT Set the com.sun:auto-snapshot-desc property to EVENT.
|
||||||
|
--fast Use a faster zfs list invocation.
|
||||||
-n, --dry-run Print actions without actually doing anything.
|
-n, --dry-run Print actions without actually doing anything.
|
||||||
-s, --skip-scrub Do not snapshot filesystems in scrubbing pools.
|
-s, --skip-scrub Do not snapshot filesystems in scrubbing pools.
|
||||||
-h, --help Print this usage message.
|
-h, --help Print this usage message.
|
||||||
@ -67,7 +73,8 @@ print_usage ()
|
|||||||
-g, --syslog Write messages into the system log.
|
-g, --syslog Write messages into the system log.
|
||||||
-r, --recursive Snapshot named filesystem and all descendants.
|
-r, --recursive Snapshot named filesystem and all descendants.
|
||||||
-v, --verbose Print info messages.
|
-v, --verbose Print info messages.
|
||||||
name Filesystem and volume names, or '//' for all ZFS objects.
|
--destroy-only Only destroy older snapshots, do not create new ones.
|
||||||
|
name Filesystem and volume names, or '//' for all ZFS datasets.
|
||||||
"
|
"
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -104,7 +111,7 @@ print_log () # level, message, ...
|
|||||||
;;
|
;;
|
||||||
(inf*)
|
(inf*)
|
||||||
# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.info $*
|
# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.info $*
|
||||||
test -n "$opt_verbose" && echo $*
|
test -z "$opt_quiet" && test -n "$opt_verbose" && echo $*
|
||||||
;;
|
;;
|
||||||
(deb*)
|
(deb*)
|
||||||
# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.debug $*
|
# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.debug $*
|
||||||
@ -146,6 +153,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
|||||||
local GLOB="$4"
|
local GLOB="$4"
|
||||||
local TARGETS="$5"
|
local TARGETS="$5"
|
||||||
local KEEP=''
|
local KEEP=''
|
||||||
|
local RUNSNAP=1
|
||||||
|
|
||||||
# global DESTRUCTION_COUNT
|
# global DESTRUCTION_COUNT
|
||||||
# global SNAPSHOT_COUNT
|
# global SNAPSHOT_COUNT
|
||||||
@ -154,13 +162,37 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
|||||||
|
|
||||||
for ii in $TARGETS
|
for ii in $TARGETS
|
||||||
do
|
do
|
||||||
if do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'"
|
# Check if size check is > 0
|
||||||
|
size_check_skip=0
|
||||||
|
if [ "$opt_min_size" -gt 0 ]
|
||||||
then
|
then
|
||||||
|
bytes_written=`zfs get -Hp -o value written $ii`
|
||||||
|
kb_written=$(( $bytes_written / 1024 ))
|
||||||
|
if [ "$kb_written" -lt "$opt_min_size" ]
|
||||||
|
then
|
||||||
|
size_check_skip=1
|
||||||
|
if [ $opt_verbose -gt 0 ]
|
||||||
|
then
|
||||||
|
echo "Skipping target $ii, only $kb_written kB written since last snap. opt_min_size is $opt_min_size"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$opt_do_snapshots" -a "$size_check_skip" -eq 0 ]
|
||||||
|
then
|
||||||
|
if [ "$opt_pre_snapshot" != "" ]
|
||||||
|
then
|
||||||
|
do_run "$opt_pre_snapshot $ii $NAME" || RUNSNAP=0
|
||||||
|
fi
|
||||||
|
if [ $RUNSNAP -eq 1 ] && do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'"
|
||||||
|
then
|
||||||
|
[ "$opt_post_snapshot" != "" ] && do_run "$opt_post_snapshot $ii $NAME"
|
||||||
SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 ))
|
SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 ))
|
||||||
else
|
else
|
||||||
WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
|
WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
# Retain at most $opt_keep number of old snapshots of this filesystem,
|
# Retain at most $opt_keep number of old snapshots of this filesystem,
|
||||||
# including the one that was just recently created.
|
# including the one that was just recently created.
|
||||||
@ -176,7 +208,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
|||||||
KEEP=$(( $KEEP - 1 ))
|
KEEP=$(( $KEEP - 1 ))
|
||||||
if [ "$KEEP" -le '0' ]
|
if [ "$KEEP" -le '0' ]
|
||||||
then
|
then
|
||||||
if do_run "zfs destroy $FLAGS '$jj'"
|
if do_run "zfs destroy -d $FLAGS '$jj'"
|
||||||
then
|
then
|
||||||
DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
|
DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
|
||||||
else
|
else
|
||||||
@ -192,11 +224,19 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
|||||||
# main ()
|
# main ()
|
||||||
# {
|
# {
|
||||||
|
|
||||||
GETOPT=$(getopt \
|
if [ "$(uname)" = "Darwin" ]; then
|
||||||
--longoptions=default-exclude,dry-run,skip-scrub,recursive \
|
GETOPT_BIN="$(brew --prefix gnu-getopt 2> /dev/null || echo /usr/local)/bin/getopt"
|
||||||
|
else
|
||||||
|
GETOPT_BIN="getopt"
|
||||||
|
fi
|
||||||
|
|
||||||
|
GETOPT=$($GETOPT_BIN \
|
||||||
|
--longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \
|
||||||
--longoptions=event:,keep:,label:,prefix:,sep: \
|
--longoptions=event:,keep:,label:,prefix:,sep: \
|
||||||
--longoptions=debug,help,quiet,syslog,verbose \
|
--longoptions=debug,help,quiet,syslog,verbose \
|
||||||
--options=dnshe:l:k:p:rs:qgv \
|
--longoptions=pre-snapshot:,post-snapshot:,destroy-only \
|
||||||
|
--longoptions=min-size: \
|
||||||
|
--options=dnshe:l:k:p:rs:qgvm: \
|
||||||
-- "$@" ) \
|
-- "$@" ) \
|
||||||
|| exit 128
|
|| exit 128
|
||||||
|
|
||||||
@ -226,6 +266,10 @@ do
|
|||||||
fi
|
fi
|
||||||
shift 2
|
shift 2
|
||||||
;;
|
;;
|
||||||
|
(--fast)
|
||||||
|
opt_fast_zfs_list='1'
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
(-n|--dry-run)
|
(-n|--dry-run)
|
||||||
opt_dry_run='1'
|
opt_dry_run='1'
|
||||||
shift 1
|
shift 1
|
||||||
@ -251,12 +295,16 @@ do
|
|||||||
opt_label="$2"
|
opt_label="$2"
|
||||||
shift 2
|
shift 2
|
||||||
;;
|
;;
|
||||||
|
(-m|--min-size)
|
||||||
|
opt_min_size="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
(-p|--prefix)
|
(-p|--prefix)
|
||||||
opt_prefix="$2"
|
opt_prefix="$2"
|
||||||
while test "${#opt_prefix}" -gt '0'
|
while test "${#opt_prefix}" -gt '0'
|
||||||
do
|
do
|
||||||
case $opt_prefix in
|
case $opt_prefix in
|
||||||
([![:alnum:]_-.:\ ]*)
|
([![:alnum:]_.:\ -]*)
|
||||||
print_log error "The $1 parameter must be alphanumeric."
|
print_log error "The $1 parameter must be alphanumeric."
|
||||||
exit 130
|
exit 130
|
||||||
;;
|
;;
|
||||||
@ -278,7 +326,7 @@ do
|
|||||||
;;
|
;;
|
||||||
(--sep)
|
(--sep)
|
||||||
case "$2" in
|
case "$2" in
|
||||||
([[:alnum:]_-.:\ ])
|
([[:alnum:]_.:\ -])
|
||||||
:
|
:
|
||||||
;;
|
;;
|
||||||
('')
|
('')
|
||||||
@ -302,6 +350,18 @@ do
|
|||||||
opt_verbose='1'
|
opt_verbose='1'
|
||||||
shift 1
|
shift 1
|
||||||
;;
|
;;
|
||||||
|
(--pre-snapshot)
|
||||||
|
opt_pre_snapshot="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
(--post-snapshot)
|
||||||
|
opt_post_snapshot="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
(--destroy-only)
|
||||||
|
opt_do_snapshots=''
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
(--)
|
(--)
|
||||||
shift 1
|
shift 1
|
||||||
break
|
break
|
||||||
@ -335,13 +395,35 @@ fi
|
|||||||
ZPOOL_STATUS=$(env LC_ALL=C zpool status 2>&1 ) \
|
ZPOOL_STATUS=$(env LC_ALL=C zpool status 2>&1 ) \
|
||||||
|| { print_log error "zpool status $?: $ZPOOL_STATUS"; exit 135; }
|
|| { print_log error "zpool status $?: $ZPOOL_STATUS"; exit 135; }
|
||||||
|
|
||||||
|
|
||||||
ZFS_LIST=$(env LC_ALL=C zfs list -H -t filesystem,volume -s name \
|
ZFS_LIST=$(env LC_ALL=C zfs list -H -t filesystem,volume -s name \
|
||||||
-o name,com.sun:auto-snapshot,com.sun:auto-snapshot:"$opt_label") \
|
-o name,com.sun:auto-snapshot,com.sun:auto-snapshot:"$opt_label") \
|
||||||
|| { print_log error "zfs list $?: $ZFS_LIST"; exit 136; }
|
|| { print_log error "zfs list $?: $ZFS_LIST"; exit 136; }
|
||||||
|
|
||||||
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
|
if [ -n "$opt_fast_zfs_list" ]
|
||||||
|
then
|
||||||
|
# Check if a snapshot label is being used, in which case restrict the old
|
||||||
|
# snapshot removal to only snapshots with the same label format
|
||||||
|
if [ -n "$opt_label" ]
|
||||||
|
then
|
||||||
|
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name | \
|
||||||
|
grep "$opt_prefix"_"$opt_label" | \
|
||||||
|
awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' | \
|
||||||
|
sort -r -k1,1 -k2,2 | \
|
||||||
|
awk '{ print substr( $0, 17, length($0) )}') \
|
||||||
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||||
|
else
|
||||||
|
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name | \
|
||||||
|
grep $opt_prefix | \
|
||||||
|
awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' | \
|
||||||
|
sort -r -k1,1 -k2,2 | \
|
||||||
|
awk '{ print substr( $0, 17, length($0) )}') \
|
||||||
|
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
|
||||||
|
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||||
|
fi
|
||||||
|
|
||||||
# Verify that each argument is a filesystem or volume.
|
# Verify that each argument is a filesystem or volume.
|
||||||
for ii in "$@"
|
for ii in "$@"
|
||||||
@ -358,26 +440,26 @@ do
|
|||||||
done
|
done
|
||||||
|
|
||||||
# Get a list of pools that are being scrubbed.
|
# Get a list of pools that are being scrubbed.
|
||||||
ZPOOLS_SCRUBBING=$(echo "$ZFS_STATUS" | awk -F ': ' \
|
ZPOOLS_SCRUBBING=$(echo "$ZPOOL_STATUS" | awk -F ': ' \
|
||||||
'$1 ~ /^ *pool$/ { pool = $2 } ; \
|
'$1 ~ /^ *pool$/ { pool = $2 } ; \
|
||||||
$1 ~ /^ *scan$/ && $2 ~ /scrub in progress/ { print pool }' \
|
$1 ~ /^ *scan$/ && $2 ~ /scrub in progress/ { print pool }' \
|
||||||
| sort )
|
| sort )
|
||||||
|
|
||||||
# Get a list of pools that cannot do a snapshot.
|
# Get a list of pools that cannot do a snapshot.
|
||||||
ZPOOLS_NOTREADY=$(echo "$ZFS_STATUS" | awk -F ': ' \
|
ZPOOLS_NOTREADY=$(echo "$ZPOOL_STATUS" | awk -F ': ' \
|
||||||
'$1 ~ /^ *pool$/ { pool = $2 } ; \
|
'$1 ~ /^ *pool$/ { pool = $2 } ; \
|
||||||
$1 ~ /^ *state$/ && $2 !~ /ONLINE|DEGRADED/ { print pool } ' \
|
$1 ~ /^ *state$/ && $2 !~ /ONLINE|DEGRADED/ { print pool } ' \
|
||||||
| sort)
|
| sort)
|
||||||
|
|
||||||
# Get a list of objects for which snapshots are explicitly disabled.
|
# Get a list of datasets for which snapshots are explicitly disabled.
|
||||||
NOAUTO=$(echo "$ZFS_LIST" | awk -F '\t' \
|
NOAUTO=$(echo "$ZFS_LIST" | awk -F '\t' \
|
||||||
'tolower($2) ~ /false/ || tolower($3) ~ /false/ {print $1}')
|
'tolower($2) ~ /false/ || tolower($3) ~ /false/ {print $1}')
|
||||||
|
|
||||||
# If the --default-exclude flag is set, then exclude all objects that lack
|
# If the --default-exclude flag is set, then exclude all datasets that lack
|
||||||
# an explicit com.sun:auto-snapshot* property. Otherwise, include them.
|
# an explicit com.sun:auto-snapshot* property. Otherwise, include them.
|
||||||
if [ -n "$opt_default_exclude" ]
|
if [ -n "$opt_default_exclude" ]
|
||||||
then
|
then
|
||||||
# Get a list of objects for which snapshots are explicitly enabled.
|
# Get a list of datasets for which snapshots are explicitly enabled.
|
||||||
CANDIDATES=$(echo "$ZFS_LIST" | awk -F '\t' \
|
CANDIDATES=$(echo "$ZFS_LIST" | awk -F '\t' \
|
||||||
'tolower($2) ~ /true/ || tolower($3) ~ /true/ {print $1}')
|
'tolower($2) ~ /true/ || tolower($3) ~ /true/ {print $1}')
|
||||||
else
|
else
|
||||||
@ -386,24 +468,33 @@ else
|
|||||||
'tolower($2) !~ /false/ && tolower($3) !~ /false/ {print $1}')
|
'tolower($2) !~ /false/ && tolower($3) !~ /false/ {print $1}')
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Initialize the list of objects that will get a recursive snapshot.
|
# Initialize the list of datasets that will get a recursive snapshot.
|
||||||
TARGETS_RECURSIVE=''
|
TARGETS_RECURSIVE=''
|
||||||
|
|
||||||
# Initialize the list of objects that will get a non-recursive snapshot.
|
# Initialize the list of datasets that will get a non-recursive snapshot.
|
||||||
TARGETS_REGULAR=''
|
TARGETS_REGULAR=''
|
||||||
|
|
||||||
for ii in $CANDIDATES
|
for ii in $CANDIDATES
|
||||||
do
|
do
|
||||||
# Qualify object names so variable globbing works properly.
|
# Qualify dataset names so variable globbing works properly.
|
||||||
# Suppose ii=tanker/foo and jj=tank sometime during the loop.
|
# Suppose ii=tanker/foo and jj=tank sometime during the loop.
|
||||||
# Just testing "$ii" != ${ii#$jj} would incorrectly match.
|
# Just testing "$ii" != ${ii#$jj} would incorrectly match.
|
||||||
iii="$ii/"
|
iii="$ii/"
|
||||||
|
|
||||||
# Exclude objects that are not named on the command line.
|
|
||||||
|
# Exclude datasets
|
||||||
|
# * that are not named on the command line or
|
||||||
|
# * those whose prefix is not on the command line (if --recursive flag is set)
|
||||||
IN_ARGS='0'
|
IN_ARGS='0'
|
||||||
for jj in "$@"
|
for jj in "$@"
|
||||||
do
|
do
|
||||||
|
# Ibid regarding iii.
|
||||||
|
jjj="$jj/"
|
||||||
|
|
||||||
if [ "$jj" = '//' -o "$jj" = "$ii" ]
|
if [ "$jj" = '//' -o "$jj" = "$ii" ]
|
||||||
|
then
|
||||||
|
IN_ARGS=$(( $IN_ARGS + 1 ))
|
||||||
|
elif [ -n "$opt_recursive" -a "$iii" != "${iii#$jjj}" ]
|
||||||
then
|
then
|
||||||
IN_ARGS=$(( $IN_ARGS + 1 ))
|
IN_ARGS=$(( $IN_ARGS + 1 ))
|
||||||
fi
|
fi
|
||||||
@ -413,13 +504,13 @@ do
|
|||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Exclude objects in pools that cannot do a snapshot.
|
# Exclude datasets in pools that cannot do a snapshot.
|
||||||
for jj in $ZPOOLS_NOTREADY
|
for jj in $ZPOOLS_NOTREADY
|
||||||
do
|
do
|
||||||
# Ibid regarding iii.
|
# Ibid regarding iii.
|
||||||
jjj="$jj/"
|
jjj="$jj/"
|
||||||
|
|
||||||
# Check whether the pool name is a prefix of the object name.
|
# Check whether the pool name is a prefix of the dataset name.
|
||||||
if [ "$iii" != "${iii#$jjj}" ]
|
if [ "$iii" != "${iii#$jjj}" ]
|
||||||
then
|
then
|
||||||
print_log info "Excluding $ii because pool $jj is not ready."
|
print_log info "Excluding $ii because pool $jj is not ready."
|
||||||
@ -427,13 +518,13 @@ do
|
|||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|
||||||
# Exclude objects in scrubbing pools if the --skip-scrub flag is set.
|
# Exclude datasets in scrubbing pools if the --skip-scrub flag is set.
|
||||||
test -n "$opt_skip_scrub" && for jj in $ZPOOLS_SCRUBBING
|
test -n "$opt_skip_scrub" && for jj in $ZPOOLS_SCRUBBING
|
||||||
do
|
do
|
||||||
# Ibid regarding iii.
|
# Ibid regarding iii.
|
||||||
jjj="$jj/"
|
jjj="$jj/"
|
||||||
|
|
||||||
# Check whether the pool name is a prefix of the object name.
|
# Check whether the pool name is a prefix of the dataset name.
|
||||||
if [ "$iii" != "${iii#$jjj}" ]
|
if [ "$iii" != "${iii#$jjj}" ]
|
||||||
then
|
then
|
||||||
print_log info "Excluding $ii because pool $jj is scrubbing."
|
print_log info "Excluding $ii because pool $jj is scrubbing."
|
||||||
@ -446,17 +537,17 @@ do
|
|||||||
# Ibid regarding iii.
|
# Ibid regarding iii.
|
||||||
jjj="$jj/"
|
jjj="$jj/"
|
||||||
|
|
||||||
# The --recusive switch only matters for non-wild arguments.
|
# The --recursive switch only matters for non-wild arguments.
|
||||||
if [ -z "$opt_recursive" -a "$1" != '//' ]
|
if [ -z "$opt_recursive" -a "$1" != '//' ]
|
||||||
then
|
then
|
||||||
# Snapshot this object non-recursively.
|
# Snapshot this dataset non-recursively.
|
||||||
print_log debug "Including $ii for regular snapshot."
|
print_log debug "Including $ii for regular snapshot."
|
||||||
TARGETS_REGULAR="${TARGETS_REGULAR:+$TARGETS_REGULAR }$ii" # nb: \t
|
TARGETS_REGULAR="${TARGETS_REGULAR:+$TARGETS_REGULAR }$ii" # nb: \t
|
||||||
continue 2
|
continue 2
|
||||||
# Check whether the candidate name is a prefix of any excluded object name.
|
# Check whether the candidate name is a prefix of any excluded dataset name.
|
||||||
elif [ "$jjj" != "${jjj#$iii}" ]
|
elif [ "$jjj" != "${jjj#$iii}" ]
|
||||||
then
|
then
|
||||||
# Snapshot this object non-recursively.
|
# Snapshot this dataset non-recursively.
|
||||||
print_log debug "Including $ii for regular snapshot."
|
print_log debug "Including $ii for regular snapshot."
|
||||||
TARGETS_REGULAR="${TARGETS_REGULAR:+$TARGETS_REGULAR }$ii" # nb: \t
|
TARGETS_REGULAR="${TARGETS_REGULAR:+$TARGETS_REGULAR }$ii" # nb: \t
|
||||||
continue 2
|
continue 2
|
||||||
@ -468,7 +559,7 @@ do
|
|||||||
# Ibid regarding iii.
|
# Ibid regarding iii.
|
||||||
jjj="$jj/"
|
jjj="$jj/"
|
||||||
|
|
||||||
# Check whether any included object is a prefix of the candidate name.
|
# Check whether any included dataset is a prefix of the candidate name.
|
||||||
if [ "$iii" != "${iii#$jjj}" ]
|
if [ "$iii" != "${iii#$jjj}" ]
|
||||||
then
|
then
|
||||||
print_log debug "Excluding $ii because $jj includes it recursively."
|
print_log debug "Excluding $ii because $jj includes it recursively."
|
||||||
@ -493,20 +584,38 @@ SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event'"
|
|||||||
|
|
||||||
# ISO style date; fifteen characters: YYYY-MM-DD-HHMM
|
# ISO style date; fifteen characters: YYYY-MM-DD-HHMM
|
||||||
# On Solaris %H%M expands to 12h34.
|
# On Solaris %H%M expands to 12h34.
|
||||||
DATE=$(date +%F-%H%M)
|
# We use the shortfirm -u here because --utc is not supported on macos.
|
||||||
|
DATE=$(date -u +%F-%H%M)
|
||||||
|
|
||||||
# The snapshot name after the @ symbol.
|
# The snapshot name after the @ symbol.
|
||||||
SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label-$DATE}"
|
SNAPNAME="${opt_prefix:+$opt_prefix$opt_sep}${opt_label:+$opt_label}-$DATE"
|
||||||
|
|
||||||
# The expression for matching old snapshots. -YYYY-MM-DD-HHMM
|
# The expression for matching old snapshots. -YYYY-MM-DD-HHMM
|
||||||
SNAPGLOB="$opt_prefix${opt_label:+?$opt_label}????????????????"
|
SNAPGLOB="${opt_prefix:+$opt_prefix$opt_sep}${opt_label:+$opt_label}-???????????????"
|
||||||
|
|
||||||
test -n "$TARGETS_REGULAR" \
|
if [ -n "$opt_do_snapshots" ]
|
||||||
|
then
|
||||||
|
test -n "$TARGETS_REGULAR" \
|
||||||
&& print_log info "Doing regular snapshots of $TARGETS_REGULAR"
|
&& print_log info "Doing regular snapshots of $TARGETS_REGULAR"
|
||||||
|
|
||||||
test -n "$TARGETS_RECURSIVE" \
|
test -n "$TARGETS_RECURSIVE" \
|
||||||
&& print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE"
|
&& print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE"
|
||||||
|
|
||||||
|
if test -n "$opt_keep" && [ "$opt_keep" -ge "1" ]
|
||||||
|
then
|
||||||
|
print_log info "Destroying all but the newest $opt_keep snapshots of each dataset."
|
||||||
|
fi
|
||||||
|
elif test -n "$opt_keep" && [ "$opt_keep" -ge "1" ]
|
||||||
|
then
|
||||||
|
test -n "$TARGETS_REGULAR" \
|
||||||
|
&& print_log info "Destroying all but the newest $opt_keep snapshots of $TARGETS_REGULAR"
|
||||||
|
|
||||||
|
test -n "$TARGETS_RECURSIVE" \
|
||||||
|
&& print_log info "Recursively destroying all but the newest $opt_keep snapshots of $TARGETS_RECURSIVE"
|
||||||
|
else
|
||||||
|
print_log notice "Only destroying snapshots, but count of snapshots to preserve not given. Nothing to do."
|
||||||
|
fi
|
||||||
|
|
||||||
test -n "$opt_dry_run" \
|
test -n "$opt_dry_run" \
|
||||||
&& print_log info "Doing a dry run. Not running these commands..."
|
&& print_log info "Doing a dry run. Not running these commands..."
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user