xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-get.8 (revision a0409676120c1e558d0ade943019934e0f15118d)
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-GET 8
32.Os
33.Sh NAME
34.Nm zpool-get
35.Nd Retrieves properties for the specified ZFS storage pool(s)
36.Sh SYNOPSIS
37.Nm zpool
38.Cm get
39.Op Fl Hp
40.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
41.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
42.Oo Ar pool Oc Ns ...
43.Nm zpool
44.Cm set
45.Ar property Ns = Ns Ar value
46.Ar pool
47.Sh DESCRIPTION
48.Bl -tag -width Ds
49.It Xo
50.Nm zpool
51.Cm get
52.Op Fl Hp
53.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
54.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
55.Oo Ar pool Oc Ns ...
56.Xc
57Retrieves the given list of properties
58.Po
59or all properties if
60.Sy all
61is used
62.Pc
63for the specified storage pool(s).
64These properties are displayed with the following fields:
65.Bd -literal
66        name          Name of storage pool
67        property      Property name
68        value         Property value
69        source        Property source, either 'default' or 'local'.
70.Ed
71.Pp
72See the
73.Xr zpoolprops
74manual page for more information on the available pool properties.
75.Bl -tag -width Ds
76.It Fl H
77Scripted mode.
78Do not display headers, and separate fields by a single tab instead of arbitrary
79space.
80.It Fl o Ar field
81A comma-separated list of columns to display.
82.Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
83is the default value.
84.It Fl p
85Display numbers in parsable (exact) values.
86.El
87.It Xo
88.Nm zpool
89.Cm set
90.Ar property Ns = Ns Ar value
91.Ar pool
92.Xc
93Sets the given property on the specified pool.
94See the
95.Xr zpoolprops
96manual page for more information on what properties can be set and acceptable
97values.
98.El
99.Sh SEE ALSO
100.Xr zpoolprops 8 ,
101.Xr zpool-list 8 ,
102.Xr zpool-features 5
103