Print this page
blah
2897 "zpool split" documentation missing from manpage
Reviewed by: Dan McDonald <danmcd@omniti.com>

@@ -136,10 +136,15 @@
 \fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR
 .fi
 
 .LP
 .nf
+\fBzpool split\fR [\fB-n\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fImntopts\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ... ]
+.fi
+
+.LP
+.nf
 \fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR \fBu\fR | \fBd\fR ] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
 .fi
 
 .LP
 .nf

@@ -155,21 +160,19 @@
 .nf
 \fBzpool upgrade\fR [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIpool\fR ...
 .fi
 
 .SH DESCRIPTION
-.sp
 .LP
 The \fBzpool\fR command configures \fBZFS\fR storage pools. A storage pool is a
 collection of devices that provides physical storage and data replication for
 \fBZFS\fR datasets.
 .sp
 .LP
 All datasets within a storage pool share the same space. See \fBzfs\fR(1M) for
 information on managing datasets.
 .SS "Virtual Devices (\fBvdev\fRs)"
-.sp
 .LP
 A "virtual device" describes a single device or a collection of devices
 organized according to certain performance and fault characteristics. The
 following virtual devices are supported:
 .sp

@@ -306,11 +309,10 @@
 .fi
 .in -2
 .sp
 
 .SS "Device Failure and Recovery"
-.sp
 .LP
 \fBZFS\fR supports a rich set of mechanisms for handling device failure and
 data corruption. All metadata and data is checksummed, and \fBZFS\fR
 automatically repairs bad data from a good copy when corruption is detected.
 .sp

@@ -436,11 +438,10 @@
 .LP
 If a device is removed and later re-attached to the system, \fBZFS\fR attempts
 to put the device online automatically. Device attach detection is
 hardware-dependent and might not be supported on all platforms.
 .SS "Hot Spares"
-.sp
 .LP
 \fBZFS\fR allows devices to be associated with pools as "hot spares". These
 devices are not actively used in the pool, but when an active device fails, it
 is automatically replaced by a hot spare. To create a pool with hot spares,
 specify a "spare" \fBvdev\fR with any number of devices. For example,

@@ -472,11 +473,10 @@
 pools.
 .sp
 .LP
 Spares cannot replace log devices.
 .SS "Intent Log"
-.sp
 .LP
 The \fBZFS\fR Intent Log (\fBZIL\fR) satisfies \fBPOSIX\fR requirements for
 synchronous transactions. For instance, databases often require their
 transactions to be on stable storage devices when returning from a system call.
 \fBNFS\fR and other applications can also use \fBfsync\fR() to ensure data

@@ -499,11 +499,10 @@
 .LP
 Log devices can be added, replaced, attached, detached, and imported and
 exported as part of the larger pool. Mirrored log devices can be removed by
 specifying the top-level mirror for the log.
 .SS "Cache Devices"
-.sp
 .LP
 Devices can be added to a storage pool as "cache devices." These devices
 provide an additional layer of caching between main memory and disk. For
 read-heavy workloads, where the working set size is much larger than what can
 be cached in main memory, using cache devices allow much more of this working

@@ -531,11 +530,10 @@
 .sp
 .LP
 The content of the cache devices is considered volatile, as is the case with
 other system caches.
 .SS "Properties"
-.sp
 .LP
 Each pool has several properties associated with it. Some properties are
 read-only statistics while others are configurable and change the behavior of
 the pool. The following are read-only properties:
 .sp

@@ -875,11 +873,10 @@
 is needed for backwards compatibility. Once feature flags is enabled on a
 pool this property will no longer have a value.
 .RE
 
 .SS "Subcommands"
-.sp
 .LP
 All subcommands that modify state are logged persistently to the pool in their
 original form.
 .sp
 .LP

@@ -1833,10 +1830,79 @@
 .RE
 
 .sp
 .ne 2
 .na
+\fBzpool split\fR [\fB-n\fR] [\fB-R\fR \fIaltroot\fR] [\fB-o\fR \fImntopts\fR] [\fB-o\fR \fIproperty=value\fR] \fIpool\fR \fInewpool\fR [\fIdevice\fR ... ]
+.ad
+.sp .6
+.RS 4n
+
+Splits off one disk from each mirrored top-level vdev in a pool and creates a
+new pool from the split-off disks. The original pool must be made up of one
+or more mirrors and must not be in the process of resilvering. The \fBsplit\fR
+subcommand chooses the last device in each mirror vdev unless overridden by a
+device specification on the command line.
+
+When using a \fIdevice\fR argument, \fBsplit\fR includes the specified
+device(s) in a new pool and, should any devices remain unspecified, assigns
+the last device in each mirror vdev to that pool, as it does normally. If you
+are uncertain about the outcome of a \fBsplit\fR command, use the \fI-n\fR
+("dry-run") option to ensure your command will have the effect you intend.
+
+.sp
+.ne 2
+.na
+\fB\fB-n\fR \fR
+.ad
+.sp .6
+.RS 4n
+Displays the configuration that would be created without actually splitting
+the pool. The actual pool split could still fail due to insufficient
+privileges or device status.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fB-R\fR \fIaltroot\fR \fR
+.ad
+.sp .6
+.RS 4n
+Automatically import the newly created pool after splitting, using the
+specified \fIaltroot\fR parameter for the new pool's alternate root. See the
+\fBaltroot\fR description in the "Properties" section, above.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fB-o\fR \fImntopts\fR \fR
+.ad
+.sp .6
+.RS 4n
+Comma-separated list of mount options to use when mounting datasets within
+the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount
+options. Valid only in conjunction with the \fB-R\fR option.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fB-o\fR \fIproperty=value\fR \fR
+.ad
+.sp .6
+.RS 4n
+Sets the specified property on the new pool. See the "Properties" section,
+above, for more information on the available pool properties.
+.RE
+
+.RE
+
+.sp
+.ne 2
+.na
 \fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR \fBu\fR | \fBd\fR ] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]]
 .ad
 .sp .6
 .RS 4n
 Displays the detailed health status for the given pools. If no \fIpool\fR is

@@ -2284,11 +2350,10 @@
     c1t3d0      -      -      -      -         -
 .fi
 .in -2
 
 .SH EXIT STATUS
-.sp
 .LP
 The following exit values are returned:
 .sp
 .ne 2
 .na

@@ -2315,11 +2380,10 @@
 .RS 5n
 Invalid command line options were specified.
 .RE
 
 .SH ATTRIBUTES
-.sp
 .LP
 See \fBattributes\fR(5) for descriptions of the following attributes:
 .sp
 
 .sp

@@ -2331,8 +2395,7 @@
 _
 Interface Stability     Evolving
 .TE
 
 .SH SEE ALSO
-.sp
 .LP
 \fBzfs\fR(1M), \fBzpool-features\fR(5), \fBattributes\fR(5)