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 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 j Op Ar --json-int, --json-pool-key-guid 41.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 42.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 43.Oo Ar pool Oc Ns … 44. 45.Nm zpool 46.Cm get 47.Op Fl Hp 48.Op Fl j Op Ar --json-int 49.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 50.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 51.Ar pool 52.Oo Sy all-vdevs Ns | Ns 53.Ar vdev Oc Ns … 54. 55.Nm zpool 56.Cm set 57.Ar property Ns = Ns Ar value 58.Ar pool 59. 60.Nm zpool 61.Cm set 62.Ar property Ns = Ns Ar value 63.Ar pool 64.Ar vdev 65. 66.Sh DESCRIPTION 67.Bl -tag -width Ds 68.It Xo 69.Nm zpool 70.Cm get 71.Op Fl Hp 72.Op Fl j Op Ar --json-int, --json-pool-key-guid 73.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 74.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 75.Oo Ar pool Oc Ns … 76.Xc 77Retrieves the given list of properties 78.Po 79or all properties if 80.Sy all 81is used 82.Pc 83for the specified storage pool(s). 84These properties are displayed with the following fields: 85.Bl -tag -compact -offset Ds -width "property" 86.It Sy name 87Name of storage pool. 88.It Sy property 89Property name. 90.It Sy value 91Property value. 92.It Sy source 93Property source, either 94.Sy default No or Sy local . 95.El 96.Pp 97See the 98.Xr zpoolprops 7 99manual page for more information on the available pool properties. 100.Bl -tag -compact -offset Ds -width "-o field" 101.It Fl j Op Ar --json-int, --json-pool-key-guid 102Display the list of properties in JSON format. 103Specify 104.Sy --json-int 105to display the numbers in integer format instead of strings in JSON output. 106Specify 107.Sy --json-pool-key-guid 108to set pool GUID as key for pool objects instead of pool name. 109.It Fl H 110Scripted mode. 111Do not display headers, and separate fields by a single tab instead of arbitrary 112space. 113.It Fl o Ar field 114A comma-separated list of columns to display, defaults to 115.Sy name , Ns Sy property , Ns Sy value , Ns Sy source . 116.It Fl p 117Display numbers in parsable (exact) values. 118.El 119.It Xo 120.Nm zpool 121.Cm get 122.Op Fl j Op Ar --json-int 123.Op Fl Hp 124.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 125.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 126.Ar pool 127.Oo Sy all-vdevs Ns | Ns 128.Ar vdev Oc Ns … 129.Xc 130Retrieves the given list of properties 131.Po 132or all properties if 133.Sy all 134is used 135.Pc 136for the specified vdevs 137.Po 138or all vdevs if 139.Sy all-vdevs 140is used 141.Pc 142in the specified pool. 143These properties are displayed with the following fields: 144.Bl -tag -compact -offset Ds -width "property" 145.It Sy name 146Name of vdev. 147.It Sy property 148Property name. 149.It Sy value 150Property value. 151.It Sy source 152Property source, either 153.Sy default No or Sy local . 154.El 155.Pp 156See the 157.Xr vdevprops 7 158manual page for more information on the available pool properties. 159.Bl -tag -compact -offset Ds -width "-o field" 160.It Fl j Op Ar --json-int 161Display the list of properties in JSON format. 162Specify 163.Sy --json-int 164to display the numbers in integer format instead of strings in JSON output. 165.It Fl H 166Scripted mode. 167Do not display headers, and separate fields by a single tab instead of arbitrary 168space. 169.It Fl o Ar field 170A comma-separated list of columns to display, defaults to 171.Sy name , Ns Sy property , Ns Sy value , Ns Sy source . 172.It Fl p 173Display numbers in parsable (exact) values. 174.El 175.It Xo 176.Nm zpool 177.Cm set 178.Ar property Ns = Ns Ar value 179.Ar pool 180.Xc 181Sets the given property on the specified pool. 182See the 183.Xr zpoolprops 7 184manual page for more information on what properties can be set and acceptable 185values. 186.It Xo 187.Nm zpool 188.Cm set 189.Ar property Ns = Ns Ar value 190.Ar pool 191.Ar vdev 192.Xc 193Sets the given property on the specified vdev in the specified pool. 194See the 195.Xr vdevprops 7 196manual page for more information on what properties can be set and acceptable 197values. 198.El 199. 200.Sh SEE ALSO 201.Xr vdevprops 7 , 202.Xr zpool-features 7 , 203.Xr zpoolprops 7 , 204.Xr zpool-list 8 205