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