xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-export.8 (revision bb2d13b686e3ccf6c3ccb36209dfb7dcc108b182)
1eda14cbcSMatt Macy.\"
2eda14cbcSMatt Macy.\" CDDL HEADER START
3eda14cbcSMatt Macy.\"
4eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy.\"
8eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9271171e0SMartin Matuska.\" or https://opensource.org/licenses/CDDL-1.0.
10eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11eda14cbcSMatt Macy.\" and limitations under the License.
12eda14cbcSMatt Macy.\"
13eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy.\"
19eda14cbcSMatt Macy.\" CDDL HEADER END
20eda14cbcSMatt Macy.\"
21eda14cbcSMatt Macy.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22eda14cbcSMatt Macy.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23eda14cbcSMatt Macy.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24eda14cbcSMatt Macy.\" Copyright (c) 2017 Datto Inc.
25eda14cbcSMatt Macy.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26eda14cbcSMatt Macy.\" Copyright 2017 Nexenta Systems, Inc.
27eda14cbcSMatt Macy.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28eda14cbcSMatt Macy.\"
29da5137abSMartin Matuska.Dd March 16, 2022
30eda14cbcSMatt Macy.Dt ZPOOL-EXPORT 8
31eda14cbcSMatt Macy.Os
3216038816SMartin Matuska.
33eda14cbcSMatt Macy.Sh NAME
347877fdebSMatt Macy.Nm zpool-export
3516038816SMartin Matuska.Nd export ZFS storage pools
36eda14cbcSMatt Macy.Sh SYNOPSIS
377877fdebSMatt Macy.Nm zpool
38eda14cbcSMatt Macy.Cm export
39eda14cbcSMatt Macy.Op Fl f
4016038816SMartin Matuska.Fl a Ns | Ns Ar pool Ns …
4116038816SMartin Matuska.
42eda14cbcSMatt Macy.Sh DESCRIPTION
43eda14cbcSMatt MacyExports the given pools from the system.
44eda14cbcSMatt MacyAll devices are marked as exported, but are still considered in use by other
45eda14cbcSMatt Macysubsystems.
46eda14cbcSMatt MacyThe devices can be moved between systems
47eda14cbcSMatt Macy.Pq even those of different endianness
48eda14cbcSMatt Macyand imported as long as a sufficient number of devices are present.
49eda14cbcSMatt Macy.Pp
50eda14cbcSMatt MacyBefore exporting the pool, all datasets within the pool are unmounted.
51eda14cbcSMatt MacyA pool can not be exported if it has a shared spare that is currently being
52eda14cbcSMatt Macyused.
53eda14cbcSMatt Macy.Pp
54eda14cbcSMatt MacyFor pools to be portable, you must give the
557877fdebSMatt Macy.Nm zpool
56eda14cbcSMatt Macycommand whole disks, not just partitions, so that ZFS can label the disks with
57eda14cbcSMatt Macyportable EFI labels.
58eda14cbcSMatt MacyOtherwise, disk drivers on platforms of different endianness will not recognize
59eda14cbcSMatt Macythe disks.
60eda14cbcSMatt Macy.Bl -tag -width Ds
61eda14cbcSMatt Macy.It Fl a
62eda14cbcSMatt MacyExports all pools imported on the system.
63eda14cbcSMatt Macy.It Fl f
64*bb2d13b6SMartin MatuskaForcefully unmount all datasets, and allow export of pools with active shared
65*bb2d13b6SMartin Matuskaspares.
66eda14cbcSMatt Macy.Pp
67eda14cbcSMatt MacyThis command will forcefully export the pool even if it has a shared spare that
68eda14cbcSMatt Macyis currently being used.
69eda14cbcSMatt MacyThis may lead to potential data corruption.
70eda14cbcSMatt Macy.El
7116038816SMartin Matuska.
72da5137abSMartin Matuska.Sh EXAMPLES
73da5137abSMartin Matuska.\" These are, respectively, examples 8 from zpool.8
74da5137abSMartin Matuska.\" Make sure to update them bidirectionally
75da5137abSMartin Matuska.Ss Example 1 : No Exporting a ZFS Storage Pool
76da5137abSMartin MatuskaThe following command exports the devices in pool
77da5137abSMartin Matuska.Ar tank
78da5137abSMartin Matuskaso that they can be relocated or later imported:
79da5137abSMartin Matuska.Dl # Nm zpool Cm export Ar tank
80da5137abSMartin Matuska.
81eda14cbcSMatt Macy.Sh SEE ALSO
82eda14cbcSMatt Macy.Xr zpool-import 8
83