mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-17 10:01:01 +03:00
c5ebfbbe19
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
93 lines
3.2 KiB
Groff
93 lines
3.2 KiB
Groff
.\"
|
|
.\" 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-TRIM 8
|
|
.Os Linux
|
|
.Sh NAME
|
|
.Nm zpool Ns Pf - Cm trim
|
|
.Nd Initiate immediate TRIM operations for all free space in a ZFS storage pool
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Cm trim
|
|
.Op Fl d
|
|
.Op Fl r Ar rate
|
|
.Op Fl c | Fl s
|
|
.Ar pool
|
|
.Op Ar device Ns ...
|
|
.Sh DESCRIPTION
|
|
.Bl -tag -width Ds
|
|
.It Xo
|
|
.Nm
|
|
.Cm trim
|
|
.Op Fl d
|
|
.Op Fl c | Fl s
|
|
.Ar pool
|
|
.Op Ar device Ns ...
|
|
.Xc
|
|
Initiates an immediate on-demand TRIM operation for all of the free space in
|
|
a pool. This operation informs the underlying storage devices of all blocks
|
|
in the pool which are no longer allocated and allows thinly provisioned
|
|
devices to reclaim the space.
|
|
.Pp
|
|
A manual on-demand TRIM operation can be initiated irrespective of the
|
|
.Sy autotrim
|
|
pool property setting. See the documentation for the
|
|
.Sy autotrim
|
|
property above for the types of vdev devices which can be trimmed.
|
|
.Bl -tag -width Ds
|
|
.It Fl d -secure
|
|
Causes a secure TRIM to be initiated. When performing a secure TRIM, the
|
|
device guarantees that data stored on the trimmed blocks has been erased.
|
|
This requires support from the device and is not supported by all SSDs.
|
|
.It Fl r -rate Ar rate
|
|
Controls the rate at which the TRIM operation progresses. Without this
|
|
option TRIM is executed as quickly as possible. The rate, expressed in bytes
|
|
per second, is applied on a per-vdev basis and may be set differently for
|
|
each leaf vdev.
|
|
.It Fl c, -cancel
|
|
Cancel trimming on the specified devices, or all eligible devices if none
|
|
are specified.
|
|
If one or more target devices are invalid or are not currently being
|
|
trimmed, the command will fail and no cancellation will occur on any device.
|
|
.It Fl s -suspend
|
|
Suspend trimming on the specified devices, or all eligible devices if none
|
|
are specified.
|
|
If one or more target devices are invalid or are not currently being
|
|
trimmed, the command will fail and no suspension will occur on any device.
|
|
Trimming can then be resumed by running
|
|
.Nm zpool Cm trim
|
|
with no flags on the relevant target devices.
|
|
.El
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr zpool-initialize 8 ,
|
|
.Xr zpool-wait 8 ,
|
|
.Xr zpoolprops 8
|