| blob | 53a1ccef77468d3c56b3346b7f614f88b6323e7f |
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) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
25 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
26 .\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
27 .\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
28 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
29 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
30 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
31 .\" Copyright (c) 2014 Integros [integros.com]
32 .\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
33 .\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
34 .\" Copyright (c) 2016 Nexenta Systems, Inc. All Rights Reserved.
35 .\" Copyright 2019 Richard Laager. All rights reserved.
36 .\" Copyright 2018 Nexenta Systems, Inc.
37 .\" Copyright 2019 Joyent, Inc.
38 .\"
39 .Dd May 27, 2021
40 .Dt ZFS-JAIL 8
41 .Os
42 .
43 .Sh NAME
44 .Nm zfs-jail
45 .Nd attach or detach ZFS filesystem from FreeBSD jail
46 .Sh SYNOPSIS
47 .Nm zfs Cm jail
48 .Ar jailid Ns | Ns Ar jailname
49 .Ar filesystem
50 .Nm zfs Cm unjail
51 .Ar jailid Ns | Ns Ar jailname
52 .Ar filesystem
53 .
54 .Sh DESCRIPTION
55 .Bl -tag -width ""
56 .It Xo
57 .Nm zfs
58 .Cm jail
59 .Ar jailid Ns | Ns Ar jailname
60 .Ar filesystem
61 .Xc
62 Attach the specified
63 .Ar filesystem
64 to the jail identified by JID
65 .Ar jailid
66 or name
67 .Ar jailname .
68 From now on this file system tree can be managed from within a jail if the
69 .Sy jailed
70 property has been set.
71 To use this functionality, the jail needs the
72 .Sy allow.mount
73 and
74 .Sy allow.mount.zfs
75 parameters set to
76 .Sy 1
77 and the
78 .Sy enforce_statfs
79 parameter set to a value lower than
80 .Sy 2 .
81 .Pp
82 You cannot attach a jailed dataset's children to another jail.
83 You can also not attach the root file system
84 of the jail or any dataset which needs to be mounted before the zfs rc script
85 is run inside the jail, as it would be attached unmounted until it is
86 mounted from the rc script inside the jail.
87 .Pp
88 To allow management of the dataset from within a jail, the
89 .Sy jailed
90 property has to be set and the jail needs access to the
91 .Pa /dev/zfs
92 device.
93 The
94 .Sy quota
95 property cannot be changed from within a jail.
96 .Pp
97 After a dataset is attached to a jail and the
98 .Sy jailed
99 property is set, a jailed file system cannot be mounted outside the jail,
100 since the jail administrator might have set the mount point to an unacceptable
101 value.
102 .Pp
103 See
104 .Xr jail 8
105 for more information on managing jails.
106 Jails are a
107 .Fx
108 feature and are not relevant on other platforms.
109 .It Xo
110 .Nm zfs
111 .Cm unjail
112 .Ar jailid Ns | Ns Ar jailname
113 .Ar filesystem
114 .Xc
115 Detaches the specified
116 .Ar filesystem
117 from the jail identified by JID
118 .Ar jailid
119 or name
120 .Ar jailname .
121 .El
122 .Sh SEE ALSO
123 .Xr zfsprops 7 ,
124 .Xr jail 8