xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-list.8 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
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 August 9, 2019
31.Dt ZPOOL-LIST 8
32.Os
33.Sh NAME
34.Nm zpool-list
35.Nd Lists ZFS storage pools along with a health status and space usage
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.Sh DESCRIPTION
45.Bl -tag -width Ds
46.It Xo
47.Nm zpool
48.Cm list
49.Op Fl HgLpPv
50.Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
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
55Lists the given pools along with a health status and space usage.
56If no
57.Ar pool Ns s
58are specified, all pools in the system are listed.
59When given an
60.Ar interval ,
61the information is printed every
62.Ar interval
63seconds until ^C is pressed.
64If
65.Ar count
66is specified, the command exits after
67.Ar count
68reports are printed.
69.Bl -tag -width Ds
70.It Fl g
71Display vdev GUIDs instead of the normal device names. These GUIDs
72can be used in place of device names for the zpool
73detach/offline/remove/replace commands.
74.It Fl H
75Scripted mode.
76Do not display headers, and separate fields by a single tab instead of arbitrary
77space.
78.It Fl o Ar property
79Comma-separated list of properties to display.
80See the
81.Xr zpoolprops
82manual page for a list of valid properties.
83The default list is
84.Cm name , size , allocated , free , checkpoint, expandsize , fragmentation ,
85.Cm capacity , dedupratio , health , altroot .
86.It Fl L
87Display real paths for vdevs resolving all symbolic links. This can
88be used to look up the current block device name regardless of the
89/dev/disk/ path used to open it.
90.It Fl p
91Display numbers in parsable
92.Pq exact
93values.
94.It Fl P
95Display full paths for vdevs instead of only the last component of
96the path. This can be used in conjunction with the
97.Fl L
98flag.
99.It Fl T Sy u Ns | Ns Sy d
100Display a time stamp.
101Specify
102.Sy u
103for a printed representation of the internal representation of time.
104See
105.Xr time 2 .
106Specify
107.Sy d
108for standard date format.
109See
110.Xr date 1 .
111.It Fl v
112Verbose statistics.
113Reports usage statistics for individual vdevs within the pool, in addition to
114the pool-wide statistics.
115.El
116.El
117.Sh SEE ALSO
118.Xr zpool-import 8 ,
119.Xr zpool-status 8
120