c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2024-11-18 18:31:00 +03:00
Code Issues Packages Projects Releases Wiki Activity
804414aad2
mirror_zfs/man/man1/zhack.1

168 lines
3.4 KiB
Groff
Raw Normal View History

Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-17 00:54:32 +04: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
Replace dead opensolaris.org license link The commit replaces all findings of the link: http://www.opensolaris.org/os/licensing with this one: https://opensource.org/licenses/CDDL-1.0 Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Tino Reichardt <milky-zfs@mcmilk.de> Closes #13619
2022-07-12 00:16:13 +03:00
.\" or https://opensource.org/licenses/CDDL-1.0.
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-17 00:54:32 +04: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 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
.\"
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.\" lint-ok: WARNING: sections out of conventional order: Sh SYNOPSIS
.\"
.Dd May 26, 2021
.Dt ZHACK 1
.Os
.
.Sh NAME
.Nm zhack
.Nd libzpool debugging tool
.Sh DESCRIPTION
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-17 00:54:32 +04:00
This utility pokes configuration changes directly into a ZFS pool,
which is dangerous and can cause data corruption.
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.Sh SYNOPSIS
.Bl -tag -width Ds
.It Xo
.Nm zhack
.Cm feature stat
.Ar pool
.Xc
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-17 00:54:32 +04:00
List feature flags.
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.
.It Xo
.Nm zhack
.Cm feature enable
.Op Fl d Ar description
.Op Fl r
.Ar pool
.Ar guid
.Xc
Add a new feature to
.Ar pool
that is uniquely identified by
.Ar guid ,
which is specified in the same form as a
.Xr zfs 8
user property.
.Pp
The
.Ar description
is a short human readable explanation of the new feature.
.Pp
The
.Fl r
flag indicates that
.Ar pool
can be safely opened in read-only mode by a system that does not understand the
.Ar guid
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-17 00:54:32 +04:00
feature.
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.
.It Xo
.Nm zhack
.Cm feature ref
.Op Fl d Ns | Ns Fl m
.Ar pool
.Ar guid
.Xc
Increment the reference count of the
.Ar guid
feature in
.Ar pool .
.Pp
The
.Fl d
flag decrements the reference count of the
.Ar guid
feature in
.Ar pool
instead.
.Pp
The
.Fl m
flag indicates that the
.Ar guid
feature is now required to read the pool MOS.
zhack: Add repair label option In case if all label checksums will be invalid on any vdev, the pool will become unimportable. The zhack with newly added cli options could be used to restore label checksums and make pool importable again. Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Fedor Uporov <fuporov.vstack@gmail.com> Closes #2510 Closes #12686
2021-11-11 22:26:18 +03:00
.
.It Xo
.Nm zhack
.Cm label repair
Allow zhack label repair to restore detached devices. This commit expands on the zhack label repair command in d04b5c9 by adding the -u option to undetach a device by regenerating uberblocks, in addition to the existing functionality of fixing checksums, now represented by -c. Previous behavior is retained in the case of no options. The changes are heavily inspired by Jeff Bonwick's labelfix utility, as archived at: https://gist.github.com/jjwhitney/baaa63144da89726e482 Additionally, it is now capable of properly determining the size of block devices and other media, as well as handling sizes which are not divisible by 2^18. This should make it viable for use on physical devices and partitions, in addition to files. These changes should make it possible to import zpools that have had their uberblocks erased, such as in the case of pools rendered inaccessible by erroneous detach commands. Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: buzzingwires <buzzingwires@outlook.com> Closes #14773
2023-05-03 19:03:57 +03:00
.Op Fl cu
zhack: Add repair label option In case if all label checksums will be invalid on any vdev, the pool will become unimportable. The zhack with newly added cli options could be used to restore label checksums and make pool importable again. Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Fedor Uporov <fuporov.vstack@gmail.com> Closes #2510 Closes #12686
2021-11-11 22:26:18 +03:00
.Ar device
.Xc
Allow zhack label repair to restore detached devices. This commit expands on the zhack label repair command in d04b5c9 by adding the -u option to undetach a device by regenerating uberblocks, in addition to the existing functionality of fixing checksums, now represented by -c. Previous behavior is retained in the case of no options. The changes are heavily inspired by Jeff Bonwick's labelfix utility, as archived at: https://gist.github.com/jjwhitney/baaa63144da89726e482 Additionally, it is now capable of properly determining the size of block devices and other media, as well as handling sizes which are not divisible by 2^18. This should make it viable for use on physical devices and partitions, in addition to files. These changes should make it possible to import zpools that have had their uberblocks erased, such as in the case of pools rendered inaccessible by erroneous detach commands. Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: buzzingwires <buzzingwires@outlook.com> Closes #14773
2023-05-03 19:03:57 +03:00
Repair labels of a specified
.Ar device
according to options.
.Pp
Flags may be combined to do their functions simultaneously.
.
.Pp
The
.Fl c
flag repairs corrupted label checksums
.
.Pp
The
.Fl u
flag restores the label on a detached device
.Pp
Example:
.Nm zhack Cm label repair Fl cu Ar device
Fix checksums and undetach a device
.
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.El
.
.Sh GLOBAL OPTIONS
The following can be passed to all
.Nm
invocations before any subcommand:
.Bl -tag -width "-d dir"
.It Fl c Ar cachefile
Read
.Ar pool
configuration from the
.Ar cachefile ,
which is
.Pa /etc/zfs/zpool.cache
by default.
.It Fl d Ar dir
Search for
.Ar pool
members in
.Ar dir .
Can be specified more than once.
.El
.
.Sh EXAMPLES
.Bd -literal
Consistentify miscellaneous style on remaining manpages Most notably this fixes the vdev_id(8) non-.Xrs in vdev_id.conf.5 Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12212
2021-06-04 23:08:50 +03:00
.No # Nm zhack Cm feature stat Ar tank
Create fsck.zfs and zhack man pages. The automake templates have been updated to install them, and the existing packaging will automatically include them. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Supplements #518
2013-03-17 00:54:32 +04:00
for_read_obj:
org.illumos:lz4_compress = 0
for_write_obj:
com.delphix:async_destroy = 0
com.delphix:empty_bpobj = 0
descriptions_obj:
com.delphix:async_destroy = Destroy filesystems asynchronously.
com.delphix:empty_bpobj = Snapshots use less space.
org.illumos:lz4_compress = LZ4 compression algorithm support.
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
Consistentify miscellaneous style on remaining manpages Most notably this fixes the vdev_id(8) non-.Xrs in vdev_id.conf.5 Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12212
2021-06-04 23:08:50 +03:00
.No # Nm zhack Cm feature enable Fl d No 'Predict future disk failures.' Ar tank com.example:clairvoyance
.No # Nm zhack Cm feature ref Ar tank com.example:clairvoyance
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.Ed
.
.Sh SEE ALSO
.Xr ztest 1 ,
Move properties, parameters, events, and concepts around manual sections The pages moved as follows: zpool-features.{5 => 7} spl{-module-parameters.5 => .4} zfs{-module-parameters.5 => .4} zfs-events.5 => into zpool-events.8 zfsconcepts.{8 => 7} zfsprops.{8 => 7} zpoolconcepts.{8 => 7} zpoolprops.{8 => 7} Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Co-authored-by: Daniel Ebdrup Jensen <debdrup@FreeBSD.org> Closes #12149 Closes #12212
2021-06-04 23:29:26 +03:00
.Xr zpool-features 7 ,
zhack.1: modernise The spacing on zhack feature stat pool is a bit iffy(?) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
2021-05-26 17:46:48 +03:00
.Xr zfs 8
Reference in New Issue Copy Permalink