sys/contrib/openzfs/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 https://opensource.org/licenses/CDDL-1.0.
  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 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
  22 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
  23 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
  24 .\" Copyright (c) 2017 Datto Inc.
  25 .\" Copyright (c) 2018 George Melikov. All Rights Reserved.
  26 .\" Copyright 2017 Nexenta Systems, Inc.
  27 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
  28 .\"
  29 .Dd March 16, 2022
  30 .Dt ZPOOL-STATUS 8
  31 .Os
  32 .
  33 .Sh NAME
  34 .Nm zpool-status
  35 .Nd show detailed health status for ZFS storage pools
  36 .Sh SYNOPSIS
  37 .Nm zpool
  38 .Cm status
  39 .Op Fl DigLpPstvx
  40 .Op Fl T Sy u Ns | Ns Sy d
  41 .Op Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns …
  42 .Oo Ar pool Oc Ns …
  43 .Op Ar interval Op Ar count
  44 .
  45 .Sh DESCRIPTION
  46 Displays the detailed health status for the given pools.
  47 If no
  48 .Ar pool
  49 is specified, then the status of each pool in the system is displayed.
  50 For more information on pool and device health, see the
  51 .Sx Device Failure and Recovery
  52 section of
  53 .Xr zpoolconcepts 7 .
  54 .Pp
  55 If a scrub or resilver is in progress, this command reports the percentage done
  56 and the estimated time to completion.
  57 Both of these are only approximate, because the amount of data in the pool and
  58 the other workloads on the system can change.
  59 .Bl -tag -width Ds
  60 .It Fl c Op Ar SCRIPT1 Ns Oo , Ns Ar SCRIPT2 Oc Ns …
  61 Run a script (or scripts) on each vdev and include the output as a new column
  62 in the
  63 .Nm zpool Cm status
  64 output.
  65 See the
  66 .Fl c
  67 option of
  68 .Nm zpool Cm iostat
  69 for complete details.
  70 .It Fl i
  71 Display vdev initialization status.
  72 .It Fl g
  73 Display vdev GUIDs instead of the normal device names
  74 These GUIDs can be used in place of device names for the zpool
  75 detach/offline/remove/replace commands.
  76 .It Fl L
  77 Display real paths for vdevs resolving all symbolic links.
  78 This can be used to look up the current block device name regardless of the
  79 .Pa /dev/disk/
  80 path used to open it.
  81 .It Fl p
  82 Display numbers in parsable (exact) values.
  83 .It Fl P
  84 Display full paths for vdevs instead of only the last component of
  85 the path.
  86 This can be used in conjunction with the
  87 .Fl L
  88 flag.
  89 .It Fl D
  90 Display a histogram of deduplication statistics, showing the allocated
  91 .Pq physically present on disk
  92 and referenced
  93 .Pq logically referenced in the pool
  94 block counts and sizes by reference count.
  95 .It Fl s
  96 Display the number of leaf vdev slow I/O operations.
  97 This is the number of I/O operations that didn't complete in
  98 .Sy zio_slow_io_ms
  99 milliseconds
 100 .Pq Sy 30000 No by default .
 101 This does not necessarily mean the I/O operations failed to complete, just took an
 102 unreasonably long amount of time.
 103 This may indicate a problem with the underlying storage.
 104 .It Fl t
 105 Display vdev TRIM status.
 106 .It Fl T Sy u Ns | Ns Sy d
 107 Display a time stamp.
 108 Specify
 109 .Sy u
 110 for a printed representation of the internal representation of time.
 111 See
 112 .Xr time 2 .
 113 Specify
 114 .Sy d
 115 for standard date format.
 116 See
 117 .Xr date 1 .
 118 .It Fl v
 119 Displays verbose data error information, printing out a complete list of all
 120 data errors since the last complete pool scrub.
 121 .It Fl x
 122 Only display status for pools that are exhibiting errors or are otherwise
 123 unavailable.
 124 Warnings about pools not using the latest on-disk format will not be included.
 125 .El
 126 .
 127 .Sh EXAMPLES
 128 .\" These are, respectively, examples 16 from zpool.8
 129 .\" Make sure to update them bidirectionally
 130 .Ss Example 1 : No Adding output columns
 131 Additional columns can be added to the
 132 .Nm zpool Cm status No and Nm zpool Cm iostat No output with Fl c .
 133 .Bd -literal -compact -offset Ds
 134 .No # Nm zpool Cm status Fl c Pa vendor , Ns Pa model , Ns Pa size
 135    NAME     STATE  READ WRITE CKSUM vendor  model        size
 136    tank     ONLINE 0    0     0
 137    mirror-0 ONLINE 0    0     0
 138    U1       ONLINE 0    0     0     SEAGATE ST8000NM0075 7.3T
 139    U10      ONLINE 0    0     0     SEAGATE ST8000NM0075 7.3T
 140    U11      ONLINE 0    0     0     SEAGATE ST8000NM0075 7.3T
 141    U12      ONLINE 0    0     0     SEAGATE ST8000NM0075 7.3T
 142    U13      ONLINE 0    0     0     SEAGATE ST8000NM0075 7.3T
 143    U14      ONLINE 0    0     0     SEAGATE ST8000NM0075 7.3T
 144
 145 .No # Nm zpool Cm iostat Fl vc Pa size
 146               capacity     operations     bandwidth
 147 pool        alloc   free   read  write   read  write  size
 148 ----------  -----  -----  -----  -----  -----  -----  ----
 149 rpool       14.6G  54.9G      4     55   250K  2.69M
 150   sda1      14.6G  54.9G      4     55   250K  2.69M   70G
 151 ----------  -----  -----  -----  -----  -----  -----  ----
 152 .Ed
 153 .
 154 .Sh SEE ALSO
 155 .Xr zpool-events 8 ,
 156 .Xr zpool-history 8 ,
 157 .Xr zpool-iostat 8 ,
 158 .Xr zpool-list 8 ,
 159 .Xr zpool-resilver 8 ,
 160 .Xr zpool-scrub 8 ,
 161 .Xr zpool-wait 8