man/man8/zpool-status.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) 2007, Sun Microsystems, Inc. All Rights Reserved.
  23 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
  24 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
  25 .\" Copyright (c) 2017 Datto Inc.
  26 .\" Copyright (c) 2018 George Melikov. All Rights Reserved.
  27 .\" Copyright 2017 Nexenta Systems, Inc.
  28 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
  29 .\"
  30 .Dd May 15, 2020
  31 .Dt ZPOOL-STATUS 8
  32 .Os Linux
  33 .Sh NAME
  34 .Nm zpool Ns Pf - Cm status
  35 .Nd Display detailed health status for the given ZFS storage pools
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Cm status
  39 .Oo Fl c Ar SCRIPT Oc
  40 .Op Fl DigLpPstvx
  41 .Op Fl T Sy u Ns | Ns Sy d
  42 .Oo Ar pool Oc Ns ...
  43 .Op Ar interval Op Ar count
  44 .Sh DESCRIPTION
  45 .Bl -tag -width Ds
  46 .It Xo
  47 .Nm
  48 .Cm status
  49 .Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
  50 .Op Fl DigLpPstvx
  51 .Op Fl T Sy u Ns | Ns Sy d
  52 .Oo Ar pool Oc Ns ...
  53 .Op Ar interval Op Ar count
  54 .Xc
  55 Displays the detailed health status for the given pools.
  56 If no
  57 .Ar pool
  58 is specified, then the status of each pool in the system is displayed.
  59 For more information on pool and device health, see the
  60 .Em Device Failure and Recovery
  61 section of
  62 .Xr zpoolconcepts 8 .
  63 .Pp
  64 If a scrub or resilver is in progress, this command reports the percentage done
  65 and the estimated time to completion.
  66 Both of these are only approximate, because the amount of data in the pool and
  67 the other workloads on the system can change.
  68 .Bl -tag -width Ds
  69 .It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns ...
  70 Run a script (or scripts) on each vdev and include the output as a new column
  71 in the
  72 .Nm zpool Cm status
  73 output.  See the
  74 .Fl c
  75 option of
  76 .Nm zpool Cm iostat
  77 for complete details.
  78 .It Fl i
  79 Display vdev initialization status.
  80 .It Fl g
  81 Display vdev GUIDs instead of the normal device names. These GUIDs
  82 can be used in place of device names for the zpool
  83 detach/offline/remove/replace commands.
  84 .It Fl L
  85 Display real paths for vdevs resolving all symbolic links. This can
  86 be used to look up the current block device name regardless of the
  87 .Pa /dev/disk/
  88 path used to open it.
  89 .It Fl p
  90 Display numbers in parsable (exact) values.
  91 .It Fl P
  92 Display full paths for vdevs instead of only the last component of
  93 the path. This can be used in conjunction with the
  94 .Fl L
  95 flag.
  96 .It Fl D
  97 Display a histogram of deduplication statistics, showing the allocated
  98 .Pq physically present on disk
  99 and referenced
 100 .Pq logically referenced in the pool
 101 block counts and sizes by reference count.
 102 .It Fl s
 103 Display the number of leaf VDEV slow IOs.  This is the number of IOs that
 104 didn't complete in \fBzio_slow_io_ms\fR milliseconds (default 30 seconds).
 105 This does not necessarily mean the IOs failed to complete, just took an
 106 unreasonably long amount of time.  This may indicate a problem with the
 107 underlying storage.
 108 .It Fl t
 109 Display vdev TRIM status.
 110 .It Fl T Sy u Ns | Ns Sy d
 111 Display a time stamp.
 112 Specify
 113 .Sy u
 114 for a printed representation of the internal representation of time.
 115 See
 116 .Xr time 2 .
 117 Specify
 118 .Sy d
 119 for standard date format.
 120 See
 121 .Xr date 1 .
 122 .It Fl v
 123 Displays verbose data error information, printing out a complete list of all
 124 data errors since the last complete pool scrub.
 125 .It Fl x
 126 Only display status for pools that are exhibiting errors or are otherwise
 127 unavailable.
 128 Warnings about pools not using the latest on-disk format will not be included.
 129 .El
 130 .El
 131 .Sh SEE ALSO
 132 .Xr zpool-events 8 ,
 133 .Xr zpool-history 8 ,
 134 .Xr zpool-iostat 8 ,
 135 .Xr zpool-list 8 ,
 136 .Xr zpool-resilver 8 ,
 137 .Xr zpool-scrub 8 ,
 138 .Xr zpool-wait 8