xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-checkpoint.8 (revision 271171e0d97b88ba2a7c3bf750c9672b484c1c13)
1eda14cbcSMatt Macy.\"
2eda14cbcSMatt Macy.\" CDDL HEADER START
3eda14cbcSMatt Macy.\"
4eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy.\"
8eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*271171e0SMartin Matuska.\" or https://opensource.org/licenses/CDDL-1.0.
10eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11eda14cbcSMatt Macy.\" and limitations under the License.
12eda14cbcSMatt Macy.\"
13eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy.\"
19eda14cbcSMatt Macy.\" CDDL HEADER END
20eda14cbcSMatt Macy.\"
21eda14cbcSMatt Macy.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22eda14cbcSMatt Macy.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23eda14cbcSMatt Macy.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24eda14cbcSMatt Macy.\" Copyright (c) 2017 Datto Inc.
25eda14cbcSMatt Macy.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26eda14cbcSMatt Macy.\" Copyright 2017 Nexenta Systems, Inc.
27eda14cbcSMatt Macy.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28eda14cbcSMatt Macy.\"
2916038816SMartin Matuska.Dd May 27, 2021
30eda14cbcSMatt Macy.Dt ZPOOL-CHECKPOINT 8
31eda14cbcSMatt Macy.Os
3216038816SMartin Matuska.
33eda14cbcSMatt Macy.Sh NAME
347877fdebSMatt Macy.Nm zpool-checkpoint
3516038816SMartin Matuska.Nd check-point current ZFS storage pool state
36eda14cbcSMatt Macy.Sh SYNOPSIS
377877fdebSMatt Macy.Nm zpool
38eda14cbcSMatt Macy.Cm checkpoint
3916038816SMartin Matuska.Op Fl d Op Fl w
40eda14cbcSMatt Macy.Ar pool
4116038816SMartin Matuska.
42eda14cbcSMatt Macy.Sh DESCRIPTION
43eda14cbcSMatt MacyCheckpoints the current state of
44eda14cbcSMatt Macy.Ar pool
45eda14cbcSMatt Macy, which can be later restored by
46eda14cbcSMatt Macy.Nm zpool Cm import --rewind-to-checkpoint .
47eda14cbcSMatt MacyThe existence of a checkpoint in a pool prohibits the following
48eda14cbcSMatt Macy.Nm zpool
4916038816SMartin Matuskasubcommands:
5016038816SMartin Matuska.Cm remove , attach , detach , split , No and Cm reguid .
51eda14cbcSMatt MacyIn addition, it may break reservation boundaries if the pool lacks free
52eda14cbcSMatt Macyspace.
53eda14cbcSMatt MacyThe
54eda14cbcSMatt Macy.Nm zpool Cm status
55eda14cbcSMatt Macycommand indicates the existence of a checkpoint or the progress of discarding a
56eda14cbcSMatt Macycheckpoint from a pool.
57eda14cbcSMatt Macy.Nm zpool Cm list
5816038816SMartin Matuskacan be used to check how much space the checkpoint takes from the pool.
5916038816SMartin Matuska.
6016038816SMartin Matuska.Sh OPTIONS
61eda14cbcSMatt Macy.Bl -tag -width Ds
62eda14cbcSMatt Macy.It Fl d , -discard
63eda14cbcSMatt MacyDiscards an existing checkpoint from
64eda14cbcSMatt Macy.Ar pool .
65eda14cbcSMatt Macy.It Fl w , -wait
66eda14cbcSMatt MacyWaits until the checkpoint has finished being discarded before returning.
67eda14cbcSMatt Macy.El
6816038816SMartin Matuska.
69eda14cbcSMatt Macy.Sh SEE ALSO
7016038816SMartin Matuska.Xr zfs-snapshot 8 ,
71eda14cbcSMatt Macy.Xr zpool-import 8 ,
7216038816SMartin Matuska.Xr zpool-status 8
73