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