xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-checkpoint.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1.\" SPDX-License-Identifier: CDDL-1.0
2.\"
3.\" CDDL HEADER START
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or https://opensource.org/licenses/CDDL-1.0.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" CDDL HEADER END
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 May 27, 2021
31.Dt ZPOOL-CHECKPOINT 8
32.Os
33.
34.Sh NAME
35.Nm zpool-checkpoint
36.Nd check-point current ZFS storage pool state
37.Sh SYNOPSIS
38.Nm zpool
39.Cm checkpoint
40.Op Fl d Op Fl w
41.Ar pool
42.
43.Sh DESCRIPTION
44Checkpoints the current state of
45.Ar pool
46, which can be later restored by
47.Nm zpool Cm import --rewind-to-checkpoint .
48The existence of a checkpoint in a pool prohibits the following
49.Nm zpool
50subcommands:
51.Cm remove , attach , detach , split , No and Cm reguid .
52In addition, it may break reservation boundaries if the pool lacks free
53space.
54The
55.Nm zpool Cm status
56command indicates the existence of a checkpoint or the progress of discarding a
57checkpoint from a pool.
58.Nm zpool Cm list
59can be used to check how much space the checkpoint takes from the pool.
60.
61.Sh OPTIONS
62.Bl -tag -width Ds
63.It Fl d , -discard
64Discards an existing checkpoint from
65.Ar pool .
66.It Fl w , -wait
67Waits until the checkpoint has finished being discarded before returning.
68.El
69.
70.Sh SEE ALSO
71.Xr zfs-snapshot 8 ,
72.Xr zpool-import 8 ,
73.Xr zpool-status 8
74