mirror_zfs/man/man8/zpool-checkpoint.8

.\"
.\" 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
.\" or http://www.opensolaris.org/os/licensing.
.\" 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.
.\"
.Dd August 9, 2019
.Dt ZPOOL-CHECKPOINT 8
.Os Linux
.Sh NAME
.Nm zpool Ns Pf - Cm checkpoint
.Nd Checkpoints the current state of a ZFS storage pool
.Sh SYNOPSIS
.Nm
.Cm checkpoint
.Op Fl d, -discard Oo Fl w, -wait Oc
.Ar pool
.Sh DESCRIPTION
.Bl -tag -width Ds
.It Xo
.Nm
.Cm checkpoint
.Op Fl d, -discard Oo Fl w, -wait Oc
.Ar pool
.Xc
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
commands:
.Cm remove ,
.Cm attach ,
.Cm detach ,
.Cm split ,
and
.Cm reguid .
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.
The
.Nm zpool Cm list
command reports how much space the checkpoint takes from the pool.
.Bl -tag -width Ds
.It Fl d, -discard
Discards an existing checkpoint from
.Ar pool .
.It Fl w, -wait
Waits until the checkpoint has finished being discarded before returning.
.El
.El
.Sh SEE ALSO
.Xr zpool-import 8 ,
.Xr zpool-status 8 ,
.Xr zfs-snapshot 8
Reorganize zpool(8) man page into sections Moved subcommand topics into individual manpages. Reordered and grouped the list of subcommands by topic. Moved concepts overview to `zpoolconcepts.8` and the long list of available pool properties to `zpoolprops.8`. Internal cross-references copied from `zpool.8` needed to be converted to `.Xr` external references to new subcommand manual pages. Move `autotrim` into lexical order, autotrim tacked onto the end of a list. Now it is in alphabetical order. Clarify attach/detach description. Description was too specific to command syntax. Overview clarifies reason for attaching or detaching a device. Clarify replace description, don't refer to subcommand arguments. Clarify split command description, say what split actually does and why you'd want to do it. Clarify description of upgrade, and simplify the zpool.8 wording of the zpool-upgrade(8) description. Clarify description of import, detail what zpool-import(8) actually does. Add appropriate SEE ALSO sections. Divided zpool subcommand manual pages need their own SEE ALSO sections. Also modified fsck.zfs.8 to point directly to zfs-scrub.8 and zed.8.in to include a direct reference to zfs-events.8 Reviewed-by: Matt Ahrens <matt@delphix.com> Reviewed-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ross Williams <ross@ross-williams.net> Closes #9564 2019-11-13 20:21:07 +03: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`
			`.\" or http://www.opensolaris.org/os/licensing.`
			`.\" 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.`
			`.\"`
			`.Dd August 9, 2019`
			`.Dt ZPOOL-CHECKPOINT 8`
			`.Os Linux`
			`.Sh NAME`
			`.Nm zpool Ns Pf - Cm checkpoint`
			`.Nd Checkpoints the current state of a ZFS storage pool`
			`.Sh SYNOPSIS`
			`.Nm`
			`.Cm checkpoint`
			`.Op Fl d, -discard Oo Fl w, -wait Oc`
			`.Ar pool`
			`.Sh DESCRIPTION`
			`.Bl -tag -width Ds`
			`.It Xo`
			`.Nm`
			`.Cm checkpoint`
			`.Op Fl d, -discard Oo Fl w, -wait Oc`
			`.Ar pool`
			`.Xc`
			`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`
			`commands:`
			`.Cm remove ,`
			`.Cm attach ,`
			`.Cm detach ,`
			`.Cm split ,`
			`and`
			`.Cm reguid .`
			`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.`
			`The`
			`.Nm zpool Cm list`
			`command reports how much space the checkpoint takes from the pool.`
			`.Bl -tag -width Ds`
			`.It Fl d, -discard`
			`Discards an existing checkpoint from`
			`.Ar pool .`
			`.It Fl w, -wait`
			`Waits until the checkpoint has finished being discarded before returning.`
			`.El`
			`.El`
			`.Sh SEE ALSO`
			`.Xr zpool-import 8 ,`
			`.Xr zpool-status 8 ,`
			`.Xr zfs-snapshot 8`