man/man8/zfs-mount.8

   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 .Op Fl j
  43 .Nm zfs
  44 .Cm mount
  45 .Op Fl Oflv
  46 .Op Fl o Ar options
  47 .Fl a Ns | Ns Fl R Ar filesystem Ns | Ns Ar filesystem
  48 .Nm zfs
  49 .Cm unmount
  50 .Op Fl fu
  51 .Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
  52 .
  53 .Sh DESCRIPTION
  54 .Bl -tag -width ""
  55 .It Xo
  56 .Nm zfs
  57 .Cm mount
  58 .Op Fl j
  59 .Xc
  60 Displays all ZFS file systems currently mounted.
  61 .Bl -tag -width "-j"
  62 .It Fl j , -json
  63 Displays all mounted file systems in JSON format.
  64 .El
  65 .It Xo
  66 .Nm zfs
  67 .Cm mount
  68 .Op Fl Oflv
  69 .Op Fl o Ar options
  70 .Fl a Ns | Ns Fl R Ar filesystem Ns | Ns Ar filesystem
  71 .Xc
  72 Mount ZFS filesystem on a path described by its
  73 .Sy mountpoint
  74 property, if the path exists and is empty.
  75 If
  76 .Sy mountpoint
  77 is set to
  78 .Em legacy ,
  79 the filesystem should be instead mounted using
  80 .Xr mount 8 .
  81 .Bl -tag -width "-O"
  82 .It Fl O
  83 Perform an overlay mount.
  84 Allows mounting in non-empty
  85 .Sy mountpoint .
  86 See
  87 .Xr mount 8
  88 for more information.
  89 .It Fl a
  90 Mount all available ZFS file systems.
  91 Invoked automatically as part of the boot process if configured.
  92 .It Fl R
  93 Mount the specified filesystems along with all their children.
  94 .It Ar filesystem
  95 Mount the specified filesystem.
  96 .It Fl o Ar options
  97 An optional, comma-separated list of mount options to use temporarily for the
  98 duration of the mount.
  99 See the
 100 .Em Temporary Mount Point Properties
 101 section of
 102 .Xr zfsprops 7
 103 for details.
 104 .It Fl l
 105 Load keys for encrypted filesystems as they are being mounted.
 106 This is equivalent to executing
 107 .Nm zfs Cm load-key
 108 on each encryption root before mounting it.
 109 Note that if a filesystem has
 110 .Sy keylocation Ns = Ns Sy prompt ,
 111 this will cause the terminal to interactively block after asking for the key.
 112 .It Fl v
 113 Report mount progress.
 114 .It Fl f
 115 Attempt to force mounting of all filesystems, even those that couldn't normally
 116 be mounted (e.g. redacted datasets).
 117 .El
 118 .It Xo
 119 .Nm zfs
 120 .Cm unmount
 121 .Op Fl fu
 122 .Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
 123 .Xc
 124 Unmounts currently mounted ZFS file systems.
 125 .Bl -tag -width "-a"
 126 .It Fl a
 127 Unmount all available ZFS file systems.
 128 Invoked automatically as part of the shutdown process.
 129 .It Fl f
 130 Forcefully unmount the file system, even if it is currently in use.
 131 This option is not supported on Linux.
 132 .It Fl u
 133 Unload keys for any encryption roots unmounted by this command.
 134 .It Ar filesystem Ns | Ns Ar mountpoint
 135 Unmount the specified filesystem.
 136 The command can also be given a path to a ZFS file system mount point on the
 137 system.
 138 .El
 139 .El