man/man8/zpool-checkpoint.8

   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 https://opensource.org/licenses/CDDL-1.0.
  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 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
  22 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
  23 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
  24 .\" Copyright (c) 2017 Datto Inc.
  25 .\" Copyright (c) 2018 George Melikov. All Rights Reserved.
  26 .\" Copyright 2017 Nexenta Systems, Inc.
  27 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
  28 .\"
  29 .Dd May 27, 2021
  30 .Dt ZPOOL-CHECKPOINT 8
  31 .Os
  32 .
  33 .Sh NAME
  34 .Nm zpool-checkpoint
  35 .Nd check-point current ZFS storage pool state
  36 .Sh SYNOPSIS
  37 .Nm zpool
  38 .Cm checkpoint
  39 .Op Fl d Op Fl w
  40 .Ar pool
  41 .
  42 .Sh DESCRIPTION
  43 Checkpoints the current state of
  44 .Ar pool
  45 , which can be later restored by
  46 .Nm zpool Cm import --rewind-to-checkpoint .
  47 The existence of a checkpoint in a pool prohibits the following
  48 .Nm zpool
  49 subcommands:
  50 .Cm remove , attach , detach , split , No and Cm reguid .
  51 In addition, it may break reservation boundaries if the pool lacks free
  52 space.
  53 The
  54 .Nm zpool Cm status
  55 command indicates the existence of a checkpoint or the progress of discarding a
  56 checkpoint from a pool.
  57 .Nm zpool Cm list
  58 can be used to check how much space the checkpoint takes from the pool.
  59 .
  60 .Sh OPTIONS
  61 .Bl -tag -width Ds
  62 .It Fl d , -discard
  63 Discards an existing checkpoint from
  64 .Ar pool .
  65 .It Fl w , -wait
  66 Waits until the checkpoint has finished being discarded before returning.
  67 .El
  68 .
  69 .Sh SEE ALSO
  70 .Xr zfs-snapshot 8 ,
  71 .Xr zpool-import 8 ,
  72 .Xr zpool-status 8