2025-01-04 11:04:27 +11:00
|
|
|
.\" SPDX-License-Identifier: CDDL-1.0
|
2019-11-13 12:21:07 -05:00
|
|
|
.\"
|
|
|
|
|
.\" CDDL HEADER START
|
|
|
|
|
.\"
|
|
|
|
|
.\" The contents of this file are subject to the terms of the
|
|
|
|
|
.\" Common Development and Distribution License (the "License").
|
|
|
|
|
.\" You may not use this file except in compliance with the License.
|
|
|
|
|
.\"
|
|
|
|
|
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
2022-07-11 23:16:13 +02:00
|
|
|
.\" or https://opensource.org/licenses/CDDL-1.0.
|
2019-11-13 12:21:07 -05:00
|
|
|
.\" See the License for the specific language governing permissions
|
|
|
|
|
.\" and limitations under the License.
|
|
|
|
|
.\"
|
|
|
|
|
.\" When distributing Covered Code, include this CDDL HEADER in each
|
|
|
|
|
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
|
|
|
.\" If applicable, add the following below this CDDL HEADER, with the
|
|
|
|
|
.\" fields enclosed by brackets "[]" replaced with your own identifying
|
|
|
|
|
.\" information: Portions Copyright [yyyy] [name of copyright owner]
|
|
|
|
|
.\"
|
|
|
|
|
.\" CDDL HEADER END
|
|
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
|
|
|
|
|
.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
|
|
|
|
|
.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
|
|
|
|
|
.\" Copyright (c) 2017 Datto Inc.
|
|
|
|
|
.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
|
|
|
|
|
.\" Copyright 2017 Nexenta Systems, Inc.
|
|
|
|
|
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
|
|
|
|
|
.\"
|
2025-08-28 19:26:16 -04:00
|
|
|
.Dd July 11, 2022
|
2019-11-13 12:21:07 -05:00
|
|
|
.Dt ZPOOL-CHECKPOINT 8
|
2020-08-21 14:55:47 -04:00
|
|
|
.Os
|
2021-05-27 02:46:40 +02:00
|
|
|
.
|
2019-11-13 12:21:07 -05:00
|
|
|
.Sh NAME
|
2020-10-22 21:28:10 +03:00
|
|
|
.Nm zpool-checkpoint
|
2021-05-27 02:46:40 +02:00
|
|
|
.Nd check-point current ZFS storage pool state
|
2019-11-13 12:21:07 -05:00
|
|
|
.Sh SYNOPSIS
|
2020-10-22 21:28:10 +03:00
|
|
|
.Nm zpool
|
2019-11-13 12:21:07 -05:00
|
|
|
.Cm checkpoint
|
2021-05-27 02:46:40 +02:00
|
|
|
.Op Fl d Op Fl w
|
2019-11-13 12:21:07 -05:00
|
|
|
.Ar pool
|
2021-05-27 02:46:40 +02:00
|
|
|
.
|
2019-11-13 12:21:07 -05:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
Checkpoints the current state of
|
|
|
|
|
.Ar pool
|
|
|
|
|
, which can be later restored by
|
|
|
|
|
.Nm zpool Cm import --rewind-to-checkpoint .
|
|
|
|
|
The existence of a checkpoint in a pool prohibits the following
|
|
|
|
|
.Nm zpool
|
2021-05-27 02:46:40 +02:00
|
|
|
subcommands:
|
|
|
|
|
.Cm remove , attach , detach , split , No and Cm reguid .
|
2019-11-13 12:21:07 -05:00
|
|
|
In addition, it may break reservation boundaries if the pool lacks free
|
|
|
|
|
space.
|
|
|
|
|
The
|
|
|
|
|
.Nm zpool Cm status
|
|
|
|
|
command indicates the existence of a checkpoint or the progress of discarding a
|
|
|
|
|
checkpoint from a pool.
|
|
|
|
|
.Nm zpool Cm list
|
2021-05-27 02:46:40 +02:00
|
|
|
can be used to check how much space the checkpoint takes from the pool.
|
|
|
|
|
.
|
|
|
|
|
.Sh OPTIONS
|
2019-11-13 12:21:07 -05:00
|
|
|
.Bl -tag -width Ds
|
2021-05-27 02:46:40 +02:00
|
|
|
.It Fl d , -discard
|
2019-11-13 12:21:07 -05:00
|
|
|
Discards an existing checkpoint from
|
|
|
|
|
.Ar pool .
|
2021-05-27 02:46:40 +02:00
|
|
|
.It Fl w , -wait
|
2019-11-13 12:21:07 -05:00
|
|
|
Waits until the checkpoint has finished being discarded before returning.
|
|
|
|
|
.El
|
2021-05-27 02:46:40 +02:00
|
|
|
.
|
2019-11-13 12:21:07 -05:00
|
|
|
.Sh SEE ALSO
|
2021-05-27 02:46:40 +02:00
|
|
|
.Xr zfs-snapshot 8 ,
|
2019-11-13 12:21:07 -05:00
|
|
|
.Xr zpool-import 8 ,
|
2021-05-27 02:46:40 +02:00
|
|
|
.Xr zpool-status 8
|
