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