man/man1/zhack.1

   1 '\" t
   2 .\"
   3 .\" CDDL HEADER START
   4 .\"
   5 .\" The contents of this file are subject to the terms of the
   6 .\" Common Development and Distribution License (the "License").
   7 .\" You may not use this file except in compliance with the License.
   8 .\"
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10 .\" or http://www.opensolaris.org/os/licensing.
  11 .\" See the License for the specific language governing permissions
  12 .\" and limitations under the License.
  13 .\"
  14 .\" When distributing Covered Code, include this CDDL HEADER in each
  15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16 .\" If applicable, add the following below this CDDL HEADER, with the
  17 .\" fields enclosed by brackets "[]" replaced with your own identifying
  18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  19 .\"
  20 .\" CDDL HEADER END
  21 .\"
  22 .\"
  23 .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
  24 .\"
  25 .TH zhack 1 "2013 MAR 16" "ZFS on Linux" "User Commands"
  26 .SH NAME
  27 .BR zhack " \- libzpool debugging tool"
  28 .SH DESCRIPTION
  29 This utility pokes configuration changes directly into a ZFS pool,
  30 which is dangerous and can cause data corruption.
  31 .SH SYNOPSIS
  32 .LP
  33 .BI "zhack [\-c " "cachefile" "] [\-d " "dir" "] <" "subcommand" "> [" "arguments" "]"
  34 .SH OPTIONS
  35 .HP
  36 .BI "\-c" " cachefile"
  37 .IP
  38 Read the \fIpool\fR configuration from the \fIcachefile\fR, which is
  39 /etc/zfs/zpool.cache by default.
  40 .HP
  41 .BI "\-d" " dir"
  42 .IP
  43 Search for \fIpool\fR members in the \fIdir\fR path. Can be specified
  44 more than once.
  45 .SH SUBCOMMANDS
  46 .LP
  47 .BI "feature stat " "pool"
  48 .IP
  49 List feature flags.
  50 .LP
  51 .BI "feature enable [\-d " "description" "] [\-r] " "pool guid"
  52 .IP
  53 Add a new feature to \fIpool\fR that is uniquely identified by
  54 \fIguid\fR, which is specified in the same form as a zfs(8) user
  55 property.
  56 .IP
  57 The \fIdescription\fR is a short human readable explanation of the new
  58 feature.
  59 .IP
  60 The \fB\-r\fR switch indicates that \fIpool\fR can be safely opened
  61 in read-only mode by a system that does not have the \fIguid\fR
  62 feature.
  63 .LP
  64 .BI "feature ref [\-d|\-m] " "pool guid"
  65 .IP
  66 Increment the reference count of the \fIguid\fR feature in \fIpool\fR.
  67 .IP
  68 The \fB\-d\fR switch decrements the reference count of the \fIguid\fR
  69 feature in \fIpool\fR.
  70 .IP
  71 The \fB\-m\fR switch indicates that the \fIguid\fR feature is now
  72 required to read the pool MOS.
  73 .SH EXAMPLES
  74 .LP
  75 .nf
  76 # zhack feature stat tank
  77
  78 for_read_obj:
  79         org.illumos:lz4_compress = 0
  80 for_write_obj:
  81         com.delphix:async_destroy = 0
  82         com.delphix:empty_bpobj = 0
  83 descriptions_obj:
  84         com.delphix:async_destroy = Destroy filesystems asynchronously.
  85         com.delphix:empty_bpobj = Snapshots use less space.
  86         org.illumos:lz4_compress = LZ4 compression algorithm support.
  87 .LP
  88 # zhack feature enable -d 'Predict future disk failures.' \\
  89     tank com.example:clairvoyance
  90 .LP
  91 # zhack feature ref tank com.example:clairvoyance
  92 .SH AUTHORS
  93 This man page was written by Darik Horn <dajhorn@vanadac.com>.
  94 .SH SEE ALSO
  95 .BR splat (1),
  96 .BR zfs (8),
  97 .BR zpios (1),
  98 .BR zpool-features (5),
  99 .BR ztest (1)