Print this page
6781 zpool man page needs updated to remove duplicate entry of "cannot be" where it discusses cache devices
Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>


   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) 2013 by Delphix. All rights reserved.
  24 .\" Copyright 2016 Nexenta Systems, Inc.
  25 .\"
  26 .Dd February 15, 2016
  27 .Dt ZPOOL 1M
  28 .Os
  29 .Sh NAME
  30 .Nm zpool
  31 .Nd configure ZFS storage pools
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Fl \?
  35 .Nm
  36 .Cm add
  37 .Op Fl fn
  38 .Ar pool vdev Ns ...
  39 .Nm
  40 .Cm attach
  41 .Op Fl f
  42 .Ar pool device new_device
  43 .Nm
  44 .Cm clear
  45 .Ar pool
  46 .Op Ar device


 218 .Sy raidz1 .
 219 .Pp
 220 A raidz group with N disks of size X with P parity disks can hold approximately
 221 (N-P)*X bytes and can withstand P device(s) failing before data integrity is
 222 compromised. The minimum number of devices in a raidz group is one more than
 223 the number of parity disks. The recommended number is between 3 and 9 to help
 224 increase performance.
 225 .It Sy spare
 226 A special pseudo-vdev which keeps track of available hot spares for a pool. For
 227 more information, see the
 228 .Sx Hot Spares
 229 section.
 230 .It Sy log
 231 A separate intent log device. If more than one log device is specified, then
 232 writes are load-balanced between devices. Log devices can be mirrored. However,
 233 raidz vdev types are not supported for the intent log. For more information,
 234 see the
 235 .Sx Intent Log
 236 section.
 237 .It Sy cache
 238 A device used to cache storage pool data. A cache device cannot be cannot be
 239 configured as a mirror or raidz group. For more information, see the
 240 .Sx Cache Devices
 241 section.
 242 .El
 243 .Pp
 244 Virtual devices cannot be nested, so a mirror or raidz virtual device can only
 245 contain files or disks. Mirrors of mirrors
 246 .Pq or other combinations
 247 are not allowed.
 248 .Pp
 249 A pool can have any number of virtual devices at the top of the configuration
 250 .Po known as
 251 .Qq root vdevs
 252 .Pc .
 253 Data is dynamically distributed across all top-level devices to balance data
 254 among devices. As new virtual devices are added, ZFS automatically places data
 255 on the newly available devices.
 256 .Pp
 257 Virtual devices are specified one at a time on the command line, separated by
 258 whitespace. The keywords
 259 .Sy mirror




   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) 2013 by Delphix. All rights reserved.
  24 .\" Copyright 2016 Nexenta Systems, Inc.
  25 .\"
  26 .Dd March 25, 2016
  27 .Dt ZPOOL 1M
  28 .Os
  29 .Sh NAME
  30 .Nm zpool
  31 .Nd configure ZFS storage pools
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Fl \?
  35 .Nm
  36 .Cm add
  37 .Op Fl fn
  38 .Ar pool vdev Ns ...
  39 .Nm
  40 .Cm attach
  41 .Op Fl f
  42 .Ar pool device new_device
  43 .Nm
  44 .Cm clear
  45 .Ar pool
  46 .Op Ar device


 218 .Sy raidz1 .
 219 .Pp
 220 A raidz group with N disks of size X with P parity disks can hold approximately
 221 (N-P)*X bytes and can withstand P device(s) failing before data integrity is
 222 compromised. The minimum number of devices in a raidz group is one more than
 223 the number of parity disks. The recommended number is between 3 and 9 to help
 224 increase performance.
 225 .It Sy spare
 226 A special pseudo-vdev which keeps track of available hot spares for a pool. For
 227 more information, see the
 228 .Sx Hot Spares
 229 section.
 230 .It Sy log
 231 A separate intent log device. If more than one log device is specified, then
 232 writes are load-balanced between devices. Log devices can be mirrored. However,
 233 raidz vdev types are not supported for the intent log. For more information,
 234 see the
 235 .Sx Intent Log
 236 section.
 237 .It Sy cache
 238 A device used to cache storage pool data. A cache device cannot be configured
 239 as a mirror or raidz group. For more information, see the
 240 .Sx Cache Devices
 241 section.
 242 .El
 243 .Pp
 244 Virtual devices cannot be nested, so a mirror or raidz virtual device can only
 245 contain files or disks. Mirrors of mirrors
 246 .Pq or other combinations
 247 are not allowed.
 248 .Pp
 249 A pool can have any number of virtual devices at the top of the configuration
 250 .Po known as
 251 .Qq root vdevs
 252 .Pc .
 253 Data is dynamically distributed across all top-level devices to balance data
 254 among devices. As new virtual devices are added, ZFS automatically places data
 255 on the newly available devices.
 256 .Pp
 257 Virtual devices are specified one at a time on the command line, separated by
 258 whitespace. The keywords
 259 .Sy mirror