xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-export.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 March 16, 2022
31.Dt ZPOOL-EXPORT 8
32.Os
33.
34.Sh NAME
35.Nm zpool-export
36.Nd export ZFS storage pools
37.Sh SYNOPSIS
38.Nm zpool
39.Cm export
40.Op Fl f
41.Fl a Ns | Ns Ar pool Ns …
42.
43.Sh DESCRIPTION
44Exports the given pools from the system.
45All devices are marked as exported, but are still considered in use by other
46subsystems.
47The devices can be moved between systems
48.Pq even those of different endianness
49and imported as long as a sufficient number of devices are present.
50.Pp
51Before exporting the pool, all datasets within the pool are unmounted.
52A pool can not be exported if it has a shared spare that is currently being
53used.
54.Pp
55For pools to be portable, you must give the
56.Nm zpool
57command whole disks, not just partitions, so that ZFS can label the disks with
58portable EFI labels.
59Otherwise, disk drivers on platforms of different endianness will not recognize
60the disks.
61.Bl -tag -width Ds
62.It Fl a
63Exports all pools imported on the system.
64.It Fl f
65Forcefully unmount all datasets, and allow export of pools with active shared
66spares.
67.Pp
68This command will forcefully export the pool even if it has a shared spare that
69is currently being used.
70This may lead to potential data corruption.
71.El
72.
73.Sh EXAMPLES
74.\" These are, respectively, examples 8 from zpool.8
75.\" Make sure to update them bidirectionally
76.Ss Example 1 : No Exporting a ZFS Storage Pool
77The following command exports the devices in pool
78.Ar tank
79so that they can be relocated or later imported:
80.Dl # Nm zpool Cm export Ar tank
81.
82.Sh SEE ALSO
83.Xr zpool-import 8
84