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) 2009 Sun Microsystems, Inc. All Rights Reserved. 23.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org> 24.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved. 25.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 26.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. 27.\" Copyright (c) 2014 by Adam Stevko. All rights reserved. 28.\" Copyright (c) 2014 Integros [integros.com] 29.\" Copyright 2019 Richard Laager. All rights reserved. 30.\" Copyright 2018 Nexenta Systems, Inc. 31.\" Copyright 2019 Joyent, Inc. 32.\" 33.Dd February 16, 2019 34.Dt ZFS-MOUNT 8 35.Os 36. 37.Sh NAME 38.Nm zfs-mount 39.Nd manage mount state of ZFS filesystems 40.Sh SYNOPSIS 41.Nm zfs 42.Cm mount 43.Op Fl j 44.Nm zfs 45.Cm mount 46.Op Fl Oflv 47.Op Fl o Ar options 48.Fl a Ns | Ns Fl R Ar filesystem Ns | Ns Ar filesystem 49.Nm zfs 50.Cm unmount 51.Op Fl fu 52.Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint 53. 54.Sh DESCRIPTION 55.Bl -tag -width "" 56.It Xo 57.Nm zfs 58.Cm mount 59.Op Fl j 60.Xc 61Displays all ZFS file systems currently mounted. 62.Bl -tag -width "-j" 63.It Fl j , -json 64Displays all mounted file systems in JSON format. 65.El 66.It Xo 67.Nm zfs 68.Cm mount 69.Op Fl Oflv 70.Op Fl o Ar options 71.Fl a Ns | Ns Fl R Ar filesystem Ns | Ns Ar filesystem 72.Xc 73Mount ZFS filesystem on a path described by its 74.Sy mountpoint 75property, if the path exists and is empty. 76If 77.Sy mountpoint 78is set to 79.Em legacy , 80the filesystem should be instead mounted using 81.Xr mount 8 . 82.Bl -tag -width "-O" 83.It Fl O 84Perform an overlay mount. 85Allows mounting in non-empty 86.Sy mountpoint . 87See 88.Xr mount 8 89for more information. 90.It Fl a 91Mount all available ZFS file systems. 92Invoked automatically as part of the boot process if configured. 93.It Fl R 94Mount the specified filesystems along with all their children. 95.It Ar filesystem 96Mount the specified filesystem. 97.It Fl o Ar options 98An optional, comma-separated list of mount options to use temporarily for the 99duration of the mount. 100See the 101.Em Temporary Mount Point Properties 102section of 103.Xr zfsprops 7 104for details. 105.It Fl l 106Load keys for encrypted filesystems as they are being mounted. 107This is equivalent to executing 108.Nm zfs Cm load-key 109on each encryption root before mounting it. 110Note that if a filesystem has 111.Sy keylocation Ns = Ns Sy prompt , 112this will cause the terminal to interactively block after asking for the key. 113.It Fl v 114Report mount progress. 115.It Fl f 116Attempt to force mounting of all filesystems, even those that couldn't normally 117be mounted (e.g. redacted datasets). 118.El 119.It Xo 120.Nm zfs 121.Cm unmount 122.Op Fl fu 123.Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint 124.Xc 125Unmounts currently mounted ZFS file systems. 126.Bl -tag -width "-a" 127.It Fl a 128Unmount all available ZFS file systems. 129Invoked automatically as part of the shutdown process. 130.It Fl f 131Forcefully unmount the file system, even if it is currently in use. 132This option is not supported on Linux. 133.It Fl u 134Unload keys for any encryption roots unmounted by this command. 135.It Ar filesystem Ns | Ns Ar mountpoint 136Unmount the specified filesystem. 137The command can also be given a path to a ZFS file system mount point on the 138system. 139.El 140.El 141