1.\" SPDX-License-Identifier: CDDL-1.0 2.\" 3.\" CDDL HEADER START 4.\" 5.\" The contents of this file are subject to the terms of the 6.\" Common Development and Distribution License (the "License"). 7.\" You may not use this file except in compliance with the License. 8.\" 9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10.\" or https://opensource.org/licenses/CDDL-1.0. 11.\" See the License for the specific language governing permissions 12.\" and limitations under the License. 13.\" 14.\" When distributing Covered Code, include this CDDL HEADER in each 15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16.\" If applicable, add the following below this CDDL HEADER, with the 17.\" fields enclosed by brackets "[]" replaced with your own identifying 18.\" information: Portions Copyright [yyyy] [name of copyright owner] 19.\" 20.\" CDDL HEADER END 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. 34.Sh NAME 35.Nm zpool-get 36.Nd retrieve properties of ZFS storage pools 37.Sh SYNOPSIS 38.Nm zpool 39.Cm get 40.Op Fl Hp 41.Op Fl j Op Ar --json-int, --json-pool-key-guid 42.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 43.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 44.Oo Ar pool Oc Ns … 45. 46.Nm zpool 47.Cm get 48.Op Fl Hp 49.Op Fl j Op Ar --json-int 50.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 51.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 52.Ar pool 53.Oo Sy all-vdevs Ns | Ns 54.Ar vdev Oc Ns … 55. 56.Nm zpool 57.Cm set 58.Ar property Ns = Ns Ar value 59.Ar pool 60. 61.Nm zpool 62.Cm set 63.Ar property Ns = Ns Ar value 64.Ar pool 65.Ar vdev 66. 67.Sh DESCRIPTION 68.Bl -tag -width Ds 69.It Xo 70.Nm zpool 71.Cm get 72.Op Fl Hp 73.Op Fl j Op Ar --json-int, --json-pool-key-guid 74.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 75.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 76.Oo Ar pool Oc Ns … 77.Xc 78Retrieves the given list of properties 79.Po 80or all properties if 81.Sy all 82is used 83.Pc 84for the specified storage pool(s). 85These properties are displayed with the following fields: 86.Bl -tag -compact -offset Ds -width "property" 87.It Sy name 88Name of storage pool. 89.It Sy property 90Property name. 91.It Sy value 92Property value. 93.It Sy source 94Property source, either 95.Sy default No or Sy local . 96.El 97.Pp 98See the 99.Xr zpoolprops 7 100manual page for more information on the available pool properties. 101.Bl -tag -compact -offset Ds -width "-o field" 102.It Fl j , -json Op Ar --json-int, --json-pool-key-guid 103Display the list of properties in JSON format. 104Specify 105.Sy --json-int 106to display the numbers in integer format instead of strings in JSON output. 107Specify 108.Sy --json-pool-key-guid 109to set pool GUID as key for pool objects instead of pool name. 110.It Fl H 111Scripted mode. 112Do not display headers, and separate fields by a single tab instead of arbitrary 113space. 114.It Fl o Ar field 115A comma-separated list of columns to display, defaults to 116.Sy name , Ns Sy property , Ns Sy value , Ns Sy source . 117.It Fl p 118Display numbers in parsable (exact) values. 119.El 120.It Xo 121.Nm zpool 122.Cm get 123.Op Fl j Op Ar --json-int 124.Op Fl Hp 125.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 126.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 127.Ar pool 128.Oo Sy all-vdevs Ns | Ns 129.Ar vdev Oc Ns … 130.Xc 131Retrieves the given list of properties 132.Po 133or all properties if 134.Sy all 135is used 136.Pc 137for the specified vdevs 138.Po 139or all vdevs if 140.Sy all-vdevs 141is used 142.Pc 143in the specified pool. 144These properties are displayed with the following fields: 145.Bl -tag -compact -offset Ds -width "property" 146.It Sy name 147Name of vdev. 148.It Sy property 149Property name. 150.It Sy value 151Property value. 152.It Sy source 153Property source, either 154.Sy default No or Sy local . 155.El 156.Pp 157See the 158.Xr vdevprops 7 159manual page for more information on the available pool properties. 160.Bl -tag -compact -offset Ds -width "-o field" 161.It Fl j , -json Op Ar --json-int 162Display the list of properties in JSON format. 163Specify 164.Sy --json-int 165to display the numbers in integer format instead of strings in JSON output. 166.It Fl H 167Scripted mode. 168Do not display headers, and separate fields by a single tab instead of arbitrary 169space. 170.It Fl o Ar field 171A comma-separated list of columns to display, defaults to 172.Sy name , Ns Sy property , Ns Sy value , Ns Sy source . 173.It Fl p 174Display numbers in parsable (exact) values. 175.El 176.It Xo 177.Nm zpool 178.Cm set 179.Ar property Ns = Ns Ar value 180.Ar pool 181.Xc 182Sets the given property on the specified pool. 183See the 184.Xr zpoolprops 7 185manual page for more information on what properties can be set and acceptable 186values. 187.It Xo 188.Nm zpool 189.Cm set 190.Ar property Ns = Ns Ar value 191.Ar pool 192.Ar vdev 193.Xc 194Sets the given property on the specified vdev in the specified pool. 195See the 196.Xr vdevprops 7 197manual page for more information on what properties can be set and acceptable 198values. 199.El 200. 201.Sh SEE ALSO 202.Xr vdevprops 7 , 203.Xr zpool-features 7 , 204.Xr zpoolprops 7 , 205.Xr zpool-list 8 206