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