man/man8/zpool-list.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-LIST 8
  31 .Os
  32 .
  33 .Sh NAME
  34 .Nm zpool-list
  35 .Nd list information about ZFS storage pools
  36 .Sh SYNOPSIS
  37 .Nm zpool
  38 .Cm list
  39 .Op Fl HgLpPv
  40 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns …
  41 .Op Fl T Sy u Ns | Ns Sy d
  42 .Oo Ar pool Oc Ns …
  43 .Op Ar interval Op Ar count
  44 .
  45 .Sh DESCRIPTION
  46 Lists the given pools along with a health status and space usage.
  47 If no
  48 .Ar pool Ns s
  49 are specified, all pools in the system are listed.
  50 When given an
  51 .Ar interval ,
  52 the information is printed every
  53 .Ar interval
  54 seconds until killed.
  55 If
  56 .Ar count
  57 is specified, the command exits after
  58 .Ar count
  59 reports are printed.
  60 .Bl -tag -width Ds
  61 .It Fl g
  62 Display vdev GUIDs instead of the normal device names.
  63 These GUIDs can be used in place of device names for the zpool
  64 detach/offline/remove/replace commands.
  65 .It Fl H
  66 Scripted mode.
  67 Do not display headers, and separate fields by a single tab instead of arbitrary
  68 space.
  69 .It Fl o Ar property
  70 Comma-separated list of properties to display.
  71 See the
  72 .Xr zpoolprops 7
  73 manual page for a list of valid properties.
  74 The default list is
  75 .Sy name , size , allocated , free , checkpoint, expandsize , fragmentation ,
  76 .Sy capacity , dedupratio , health , altroot .
  77 .It Fl L
  78 Display real paths for vdevs resolving all symbolic links.
  79 This can be used to look up the current block device name regardless of the
  80 .Pa /dev/disk
  81 path used to open it.
  82 .It Fl p
  83 Display numbers in parsable
  84 .Pq exact
  85 values.
  86 .It Fl P
  87 Display full paths for vdevs instead of only the last component of
  88 the path.
  89 This can be used in conjunction with the
  90 .Fl L
  91 flag.
  92 .It Fl T Sy u Ns | Ns Sy d
  93 Display a time stamp.
  94 Specify
  95 .Sy u
  96 for a printed representation of the internal representation of time.
  97 See
  98 .Xr time 1 .
  99 Specify
 100 .Sy d
 101 for standard date format.
 102 See
 103 .Xr date 1 .
 104 .It Fl v
 105 Verbose statistics.
 106 Reports usage statistics for individual vdevs within the pool, in addition to
 107 the pool-wide statistics.
 108 .El
 109 .
 110 .Sh EXAMPLES
 111 .\" These are, respectively, examples 6, 15 from zpool.8
 112 .\" Make sure to update them bidirectionally
 113 .Ss Example 1 : No Listing Available ZFS Storage Pools
 114 The following command lists all available pools on the system.
 115 In this case, the pool
 116 .Ar zion
 117 is faulted due to a missing device.
 118 The results from this command are similar to the following:
 119 .Bd -literal -compact -offset Ds
 120 .No # Nm zpool Cm list
 121 NAME    SIZE  ALLOC   FREE  EXPANDSZ   FRAG    CAP  DEDUP  HEALTH  ALTROOT
 122 rpool  19.9G  8.43G  11.4G         -    33%    42%  1.00x  ONLINE  -
 123 tank   61.5G  20.0G  41.5G         -    48%    32%  1.00x  ONLINE  -
 124 zion       -      -      -         -      -      -      -  FAULTED -
 125 .Ed
 126 .
 127 .Ss Example 2 : No Displaying expanded space on a device
 128 The following command displays the detailed information for the pool
 129 .Ar data .
 130 This pool is comprised of a single raidz vdev where one of its devices
 131 increased its capacity by 10 GiB.
 132 In this example, the pool will not be able to utilize this extra capacity until
 133 all the devices under the raidz vdev have been expanded.
 134 .Bd -literal -compact -offset Ds
 135 .No # Nm zpool Cm list Fl v Ar data
 136 NAME         SIZE  ALLOC   FREE  EXPANDSZ   FRAG    CAP  DEDUP  HEALTH  ALTROOT
 137 data        23.9G  14.6G  9.30G         -    48%    61%  1.00x  ONLINE  -
 138   raidz1    23.9G  14.6G  9.30G         -    48%
 139     sda         -      -      -         -      -
 140     sdb         -      -      -       10G      -
 141     sdc         -      -      -         -      -
 142 .Ed
 143 .
 144 .Sh SEE ALSO
 145 .Xr zpool-import 8 ,
 146 .Xr zpool-status 8