summaryrefslogtreecommitdiff
path: root/man8
diff options
context:
space:
mode:
authorerdgeist <de@gsmk.de>2014-06-10 02:34:47 +0200
committererdgeist <de@gsmk.de>2014-06-10 02:34:47 +0200
commit8c232a30f4da36b5e201af0b83d2ea24f6294b73 (patch)
treeae32f605087a222ef21130667a7ec8a22d3fe883 /man8
parent0601e306e7ff30498a03a62b748e417262630dcf (diff)
Document the snapshot command
Diffstat (limited to 'man8')
-rw-r--r--man8/ezjail-admin.827
1 files changed, 27 insertions, 0 deletions
diff --git a/man8/ezjail-admin.8 b/man8/ezjail-admin.8
index 8382e44..7e809cf 100644
--- a/man8/ezjail-admin.8
+++ b/man8/ezjail-admin.8
@@ -54,6 +54,9 @@
54.Op Fl d Ar archivedir 54.Op Fl d Ar archivedir
55.Ar archive | jailname... 55.Ar archive | jailname...
56.Nm 56.Nm
57.Cm snapshot
58.Ar [jailname...]
59.Nm
57.Cm update 60.Cm update
58.Op Fl s Ar sourcetree | sourceosversion 61.Op Fl s Ar sourcetree | sourceosversion
59.Op Fl p 62.Op Fl p
@@ -518,6 +521,30 @@ where it was archived. Be default,
518will refuse to restore an archive if the archived host system's hostname, 521will refuse to restore an archive if the archived host system's hostname,
519its FreeBSD version or CPU architecture do not match the current host. 522its FreeBSD version or CPU architecture do not match the current host.
520.El 523.El
524.Ss Nm Cm snapshot [jailname...]
525Takes zfs snapshots of some or all (zfs) ezjails and their zfs datasets and
526optionally destroys older snapshots according to a configured retention
527policy.
528.Pp
529The zfs snapshots will be named @ez-autosnap- with the date appended in format
530“%Y%m%d%H%M”. List all auto snapshots with
531.Dq Li /sbin/zfs list -H -t snapshot | grep @ez-autosnap- .
532.Pp
533You can set (and override in that order) the retention policy globally in your
534.Dq Li $ezjail_default_retention_policy
535.Xr ezjail.conf 5
536variable, set them per jail in its config file with their
537.Dq Li $ezjail_retention_policy
538variable or set a User property with the name
539.Dq Li ezjail:autosnap_retention
540on the respective file systems.
541.Pp
542The policy is described by a pattern of space separated
543.Dq Li repeat x window
544entries with the algorithm guaranteeing at least one and at most two snapshots
545in each of the windows, if mathematically possible. See
546.Xr ezjail 7
547for details.
521.Ss Nm Cm update 548.Ss Nm Cm update
522Updates ezjail's basejail, or in the 549Updates ezjail's basejail, or in the
523.Fl b 550.Fl b