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