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