xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-checkpoint.8 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or http://www.opensolaris.org/os/licensing.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
21.\"
22.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
24.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
25.\" Copyright (c) 2017 Datto Inc.
26.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
27.\" Copyright 2017 Nexenta Systems, Inc.
28.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
29.\"
30.Dd August 9, 2019
31.Dt ZPOOL-CHECKPOINT 8
32.Os
33.Sh NAME
34.Nm zpool-checkpoint
35.Nd Checkpoints the current state of a ZFS storage pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm checkpoint
39.Op Fl d, -discard Oo Fl w, -wait Oc
40.Ar pool
41.Sh DESCRIPTION
42.Bl -tag -width Ds
43.It Xo
44.Nm zpool
45.Cm checkpoint
46.Op Fl d, -discard Oo Fl w, -wait Oc
47.Ar pool
48.Xc
49Checkpoints the current state of
50.Ar pool
51, which can be later restored by
52.Nm zpool Cm import --rewind-to-checkpoint .
53The existence of a checkpoint in a pool prohibits the following
54.Nm zpool
55commands:
56.Cm remove ,
57.Cm attach ,
58.Cm detach ,
59.Cm split ,
60and
61.Cm reguid .
62In addition, it may break reservation boundaries if the pool lacks free
63space.
64The
65.Nm zpool Cm status
66command indicates the existence of a checkpoint or the progress of discarding a
67checkpoint from a pool.
68The
69.Nm zpool Cm list
70command reports how much space the checkpoint takes from the pool.
71.Bl -tag -width Ds
72.It Fl d, -discard
73Discards an existing checkpoint from
74.Ar pool .
75.It Fl w, -wait
76Waits until the checkpoint has finished being discarded before returning.
77.El
78.El
79.Sh SEE ALSO
80.Xr zpool-import 8 ,
81.Xr zpool-status 8 ,
82.Xr zfs-snapshot 8
83