mirror_zfs/man/man8/zpool-export.8

.\"
.\" CDDL HEADER START
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
.\"
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
.\" Copyright (c) 2017 Datto Inc.
.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
.\"
.Dd August 9, 2019
.Dt ZPOOL-EXPORT 8
.Os Linux
.Sh NAME
.Nm zpool Ns Pf - Cm export
.Nd Exports the given ZFS storage pools from the system
.Sh SYNOPSIS
.Nm
.Cm export
.Op Fl a
.Op Fl f
.Ar pool Ns ...
.Sh DESCRIPTION
.Bl -tag -width Ds
.It Xo
.Nm
.Cm export
.Op Fl a
.Op Fl f
.Ar pool Ns ...
.Xc
Exports the given pools from the system.
All devices are marked as exported, but are still considered in use by other
subsystems.
The devices can be moved between systems
.Pq even those of different endianness
and imported as long as a sufficient number of devices are present.
.Pp
Before exporting the pool, all datasets within the pool are unmounted.
A pool can not be exported if it has a shared spare that is currently being
used.
.Pp
For pools to be portable, you must give the
.Nm
command whole disks, not just partitions, so that ZFS can label the disks with
portable EFI labels.
Otherwise, disk drivers on platforms of different endianness will not recognize
the disks.
.Bl -tag -width Ds
.It Fl a
Exports all pools imported on the system.
.It Fl f
Forcefully unmount all datasets, using the
.Nm unmount Fl f
command.
.Pp
This command will forcefully export the pool even if it has a shared spare that
is currently being used.
This may lead to potential data corruption.
.El
.El
.Sh SEE ALSO
.Xr zpool-import 8
Reorganize zpool(8) man page into sections Moved subcommand topics into individual manpages. Reordered and grouped the list of subcommands by topic. Moved concepts overview to `zpoolconcepts.8` and the long list of available pool properties to `zpoolprops.8`. Internal cross-references copied from `zpool.8` needed to be converted to `.Xr` external references to new subcommand manual pages. Move `autotrim` into lexical order, autotrim tacked onto the end of a list. Now it is in alphabetical order. Clarify attach/detach description. Description was too specific to command syntax. Overview clarifies reason for attaching or detaching a device. Clarify replace description, don't refer to subcommand arguments. Clarify split command description, say what split actually does and why you'd want to do it. Clarify description of upgrade, and simplify the zpool.8 wording of the zpool-upgrade(8) description. Clarify description of import, detail what zpool-import(8) actually does. Add appropriate SEE ALSO sections. Divided zpool subcommand manual pages need their own SEE ALSO sections. Also modified fsck.zfs.8 to point directly to zfs-scrub.8 and zed.8.in to include a direct reference to zfs-events.8 Reviewed-by: Matt Ahrens <matt@delphix.com> Reviewed-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ross Williams <ross@ross-williams.net> Closes #9564 2019-11-13 20:21:07 +03:00			`.\"`
			`.\" CDDL HEADER START`
			`.\"`
			`.\" The contents of this file are subject to the terms of the`
			`.\" Common Development and Distribution License (the "License").`
			`.\" You may not use this file except in compliance with the License.`
			`.\"`
			`.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE`
			`.\" or http://www.opensolaris.org/os/licensing.`
			`.\" See the License for the specific language governing permissions`
			`.\" and limitations under the License.`
			`.\"`
			`.\" When distributing Covered Code, include this CDDL HEADER in each`
			`.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.`
			`.\" If applicable, add the following below this CDDL HEADER, with the`
			`.\" fields enclosed by brackets "[]" replaced with your own identifying`
			`.\" information: Portions Copyright [yyyy] [name of copyright owner]`
			`.\"`
			`.\" CDDL HEADER END`
			`.\"`
			`.\"`
			`.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.`
			`.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.`
			`.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.`
			`.\" Copyright (c) 2017 Datto Inc.`
			`.\" Copyright (c) 2018 George Melikov. All Rights Reserved.`
			`.\" Copyright 2017 Nexenta Systems, Inc.`
			`.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.`
			`.\"`
			`.Dd August 9, 2019`
			`.Dt ZPOOL-EXPORT 8`
			`.Os Linux`
			`.Sh NAME`
			`.Nm zpool Ns Pf - Cm export`
			`.Nd Exports the given ZFS storage pools from the system`
			`.Sh SYNOPSIS`
			`.Nm`
			`.Cm export`
			`.Op Fl a`
			`.Op Fl f`
			`.Ar pool Ns ...`
			`.Sh DESCRIPTION`
			`.Bl -tag -width Ds`
			`.It Xo`
			`.Nm`
			`.Cm export`
			`.Op Fl a`
			`.Op Fl f`
			`.Ar pool Ns ...`
			`.Xc`
			`Exports the given pools from the system.`
			`All devices are marked as exported, but are still considered in use by other`
			`subsystems.`
			`The devices can be moved between systems`
			`.Pq even those of different endianness`
			`and imported as long as a sufficient number of devices are present.`
			`.Pp`
			`Before exporting the pool, all datasets within the pool are unmounted.`
			`A pool can not be exported if it has a shared spare that is currently being`
			`used.`
			`.Pp`
			`For pools to be portable, you must give the`
			`.Nm`
			`command whole disks, not just partitions, so that ZFS can label the disks with`
			`portable EFI labels.`
			`Otherwise, disk drivers on platforms of different endianness will not recognize`
			`the disks.`
			`.Bl -tag -width Ds`
			`.It Fl a`
			`Exports all pools imported on the system.`
			`.It Fl f`
			`Forcefully unmount all datasets, using the`
			`.Nm unmount Fl f`
			`command.`
			`.Pp`
			`This command will forcefully export the pool even if it has a shared spare that`
			`is currently being used.`
			`This may lead to potential data corruption.`
			`.El`
			`.El`
			`.Sh SEE ALSO`
			`.Xr zpool-import 8`