xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-split.8 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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 June 2, 2021
30.Dt ZPOOL-SPLIT 8
31.Os
32.
33.Sh NAME
34.Nm zpool-split
35.Nd split devices off ZFS storage pool, creating new pool
36.Sh SYNOPSIS
37.Nm zpool
38.Cm split
39.Op Fl gLlnP
40.Oo Fl o Ar property Ns = Ns Ar value Oc Ns …
41.Op Fl R Ar root
42.Ar pool newpool
43.Oo Ar device Oc Ns …
44.
45.Sh DESCRIPTION
46Splits devices off
47.Ar pool
48creating
49.Ar newpool .
50All vdevs in
51.Ar pool
52must be mirrors and the pool must not be in the process of resilvering.
53At the time of the split,
54.Ar newpool
55will be a replica of
56.Ar pool .
57By default, the
58last device in each mirror is split from
59.Ar pool
60to create
61.Ar newpool .
62.Pp
63The optional device specification causes the specified device(s) to be
64included in the new
65.Ar pool
66and, should any devices remain unspecified,
67the last device in each mirror is used as would be by default.
68.Bl -tag -width Ds
69.It Fl g
70Display vdev GUIDs instead of the normal device names.
71These GUIDs can be used in place of device names for the zpool
72detach/offline/remove/replace commands.
73.It Fl L
74Display real paths for vdevs resolving all symbolic links.
75This can be used to look up the current block device name regardless of the
76.Pa /dev/disk/
77path used to open it.
78.It Fl l
79Indicates that this command will request encryption keys for all encrypted
80datasets it attempts to mount as it is bringing the new pool online.
81Note that if any datasets have
82.Sy keylocation Ns = Ns Sy prompt ,
83this command will block waiting for the keys to be entered.
84Without this flag, encrypted datasets will be left unavailable until the keys
85are loaded.
86.It Fl n
87Do a dry-run
88.Pq Qq No-op
89split: do not actually perform it.
90Print out the expected configuration of
91.Ar newpool .
92.It Fl P
93Display full paths for vdevs instead of only the last component of
94the path.
95This can be used in conjunction with the
96.Fl L
97flag.
98.It Fl o Ar property Ns = Ns Ar value
99Sets the specified property for
100.Ar newpool .
101See the
102.Xr zpoolprops 7
103manual page for more information on the available pool properties.
104.It Fl R Ar root
105Set
106.Sy altroot
107for
108.Ar newpool
109to
110.Ar root
111and automatically import it.
112.El
113.
114.Sh SEE ALSO
115.Xr zpool-import 8 ,
116.Xr zpool-list 8 ,
117.Xr zpool-remove 8
118