man/man8/zfs-destroy.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 http://www.opensolaris.org/os/licensing.
  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 .\"
  22 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
  23 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  24 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
  25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  26 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
  27 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
  28 .\" Copyright (c) 2014 Integros [integros.com]
  29 .\" Copyright 2019 Richard Laager. All rights reserved.
  30 .\" Copyright 2018 Nexenta Systems, Inc.
  31 .\" Copyright 2019 Joyent, Inc.
  32 .\"
  33 .Dd June 30, 2019
  34 .Dt ZFS-DESTROY 8
  35 .Os
  36 .Sh NAME
  37 .Nm zfs Ns Pf - Cm destroy
  38 .Nd Destroys the given dataset(s), snapshot(s), or bookmark.
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Cm destroy
  42 .Op Fl Rfnprv
  43 .Ar filesystem Ns | Ns Ar volume
  44 .Nm
  45 .Cm destroy
  46 .Op Fl Rdnprv
  47 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
  48 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
  49 .Nm
  50 .Cm destroy
  51 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
  52 .Sh DESCRIPTION
  53 .Bl -tag -width ""
  54 .It Xo
  55 .Nm
  56 .Cm destroy
  57 .Op Fl Rfnprv
  58 .Ar filesystem Ns | Ns Ar volume
  59 .Xc
  60 Destroys the given dataset.
  61 By default, the command unshares any file systems that are currently shared,
  62 unmounts any file systems that are currently mounted, and refuses to destroy a
  63 dataset that has active dependents
  64 .Pq children or clones .
  65 .Bl -tag -width "-R"
  66 .It Fl R
  67 Recursively destroy all dependents, including cloned file systems outside the
  68 target hierarchy.
  69 .It Fl f
  70 Force an unmount of any file systems using the
  71 .Nm unmount Fl f
  72 command.
  73 This option has no effect on non-file systems or unmounted file systems.
  74 .It Fl n
  75 Do a dry-run
  76 .Pq Qq No-op
  77 deletion.
  78 No data will be deleted.
  79 This is useful in conjunction with the
  80 .Fl v
  81 or
  82 .Fl p
  83 flags to determine what data would be deleted.
  84 .It Fl p
  85 Print machine-parsable verbose information about the deleted data.
  86 .It Fl r
  87 Recursively destroy all children.
  88 .It Fl v
  89 Print verbose information about the deleted data.
  90 .El
  91 .Pp
  92 Extreme care should be taken when applying either the
  93 .Fl r
  94 or the
  95 .Fl R
  96 options, as they can destroy large portions of a pool and cause unexpected
  97 behavior for mounted file systems in use.
  98 .It Xo
  99 .Nm
 100 .Cm destroy
 101 .Op Fl Rdnprv
 102 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
 103 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
 104 .Xc
 105 The given snapshots are destroyed immediately if and only if the
 106 .Ql zfs destroy
 107 command without the
 108 .Fl d
 109 option would have destroyed it.
 110 Such immediate destruction would occur, for example, if the snapshot had no
 111 clones and the user-initiated reference count were zero.
 112 .Pp
 113 If a snapshot does not qualify for immediate destruction, it is marked for
 114 deferred deletion.
 115 In this state, it exists as a usable, visible snapshot until both of the
 116 preconditions listed above are met, at which point it is destroyed.
 117 .Pp
 118 An inclusive range of snapshots may be specified by separating the first and
 119 last snapshots with a percent sign.
 120 The first and/or last snapshots may be left blank, in which case the
 121 filesystem's oldest or newest snapshot will be implied.
 122 .Pp
 123 Multiple snapshots
 124 .Pq or ranges of snapshots
 125 of the same filesystem or volume may be specified in a comma-separated list of
 126 snapshots.
 127 Only the snapshot's short name
 128 .Po the part after the
 129 .Sy @
 130 .Pc
 131 should be specified when using a range or comma-separated list to identify
 132 multiple snapshots.
 133 .Bl -tag -width "-R"
 134 .It Fl R
 135 Recursively destroy all clones of these snapshots, including the clones,
 136 snapshots, and children.
 137 If this flag is specified, the
 138 .Fl d
 139 flag will have no effect.
 140 .It Fl d
 141 Destroy immediately. If a snapshot cannot be destroyed now, mark it for
 142 deferred destruction.
 143 .It Fl n
 144 Do a dry-run
 145 .Pq Qq No-op
 146 deletion.
 147 No data will be deleted.
 148 This is useful in conjunction with the
 149 .Fl p
 150 or
 151 .Fl v
 152 flags to determine what data would be deleted.
 153 .It Fl p
 154 Print machine-parsable verbose information about the deleted data.
 155 .It Fl r
 156 Destroy
 157 .Pq or mark for deferred deletion
 158 all snapshots with this name in descendent file systems.
 159 .It Fl v
 160 Print verbose information about the deleted data.
 161 .Pp
 162 Extreme care should be taken when applying either the
 163 .Fl r
 164 or the
 165 .Fl R
 166 options, as they can destroy large portions of a pool and cause unexpected
 167 behavior for mounted file systems in use.
 168 .El
 169 .It Xo
 170 .Nm
 171 .Cm destroy
 172 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
 173 .Xc
 174 The given bookmark is destroyed.
 175 .El
 176 .Sh SEE ALSO
 177 .Xr zfs-create 8 ,
 178 .Xr zfs-hold 8