man/man8/zpool-get.8

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