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