mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2026-01-17 02:26:22 +03:00
055e908d47
Add an introductory sentance explaining why the reader may want to use this command, and establishing the requirement that the jail must be running. Move other requirements from the description of the subcommands to follow this for flow and structure. Move the caveat that this is for FreeBSD down to a cannonical CAVEATS section, and crossreference Linux's equivelant functionality. Mention that this utility can not be used to delegate the root directory of the jail to that section also. Reported by: Jan Brankamp <crest@rlwinm.de> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Allan Jude <allan@klarasystems.com> Signed-off-by: Alexander Ziaee <ziaee@FreeBSD.org> Closes #17883
145 lines
4.1 KiB
Groff
145 lines
4.1 KiB
Groff
.\" SPDX-License-Identifier: CDDL-1.0
|
|
.\"
|
|
.\" 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 https://opensource.org/licenses/CDDL-1.0.
|
|
.\" 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) 2009 Sun Microsystems, Inc. All Rights Reserved.
|
|
.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
|
|
.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
|
|
.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
|
|
.\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
|
|
.\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
|
|
.\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
|
|
.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
|
|
.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
|
|
.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
|
|
.\" Copyright (c) 2014 Integros [integros.com]
|
|
.\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
|
|
.\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
|
|
.\" Copyright (c) 2016 Nexenta Systems, Inc. All Rights Reserved.
|
|
.\" Copyright 2019 Richard Laager. All rights reserved.
|
|
.\" Copyright 2018 Nexenta Systems, Inc.
|
|
.\" Copyright 2019 Joyent, Inc.
|
|
.\"
|
|
.Dd November 4, 2025
|
|
.Dt ZFS-JAIL 8
|
|
.Os
|
|
.
|
|
.Sh NAME
|
|
.Nm zfs-jail
|
|
.Nd attach or detach ZFS filesystem from FreeBSD jail
|
|
.Sh SYNOPSIS
|
|
.Nm zfs Cm jail
|
|
.Ar jailid Ns | Ns Ar jailname
|
|
.Ar filesystem
|
|
.Nm zfs Cm unjail
|
|
.Ar jailid Ns | Ns Ar jailname
|
|
.Ar filesystem
|
|
.
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
functionality can be used to assign a dataset onto a running
|
|
.Fx
|
|
system
|
|
.Xr jail 4 ,
|
|
allowing
|
|
.Xr zfs 8
|
|
management utilities to be run inside of the
|
|
.Xr jail 4 .
|
|
.Pp
|
|
To allow management of the dataset from within a jail, the
|
|
.Sy jailed
|
|
property should be set and the required
|
|
.Xr devfs.conf 5
|
|
entries to expose
|
|
.Pa /dev/zfs
|
|
device within the jail must be present.
|
|
The
|
|
.Sy quota
|
|
property cannot be changed from within a jail.
|
|
.Pp
|
|
To use this functionality, the jail needs the
|
|
.Sy allow.mount
|
|
and
|
|
.Sy allow.mount.zfs
|
|
parameters set to
|
|
.Sy 1
|
|
and the
|
|
.Sy enforce_statfs
|
|
parameter set to a value lower than
|
|
.Sy 2 .
|
|
.Pp
|
|
The subcommands are as follows:
|
|
.Bl -tag -width indent
|
|
.It Xo
|
|
.Cm jail
|
|
.Ar jailid Ns | Ns Ar jailname
|
|
.Ar filesystem
|
|
.Xc
|
|
Attach the specified
|
|
.Ar filesystem
|
|
to the jail identified by JID
|
|
.Ar jailid
|
|
or name
|
|
.Ar jailname .
|
|
From now on this file system tree can be managed from within a jail if the
|
|
.Sy jailed
|
|
property has been set.
|
|
.Pp
|
|
You cannot attach a jailed dataset's children to another jail.
|
|
You can also not attach the root file system
|
|
of the jail or any dataset which needs to be mounted before the zfs rc script
|
|
is run inside the jail, as it would be attached unmounted until it is
|
|
mounted from the rc script inside the jail.
|
|
.Pp
|
|
After a dataset is attached to a jail and the
|
|
.Sy jailed
|
|
property is set, a jailed file system cannot be mounted outside the jail,
|
|
since the jail administrator might have set the mount point to an unacceptable
|
|
value.
|
|
.It Xo
|
|
.Cm unjail
|
|
.Ar jailid Ns | Ns Ar jailname
|
|
.Ar filesystem
|
|
.Xc
|
|
Detaches the specified
|
|
.Ar filesystem
|
|
from the jail identified by JID
|
|
.Ar jailid
|
|
or name
|
|
.Ar jailname .
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr devfs.conf 5 ,
|
|
.Xr zfsprops 7 ,
|
|
.Xr jail 8
|
|
.Sh CAVEATS
|
|
The root directory of jail can not be delegated to the jail with this
|
|
utility because the jail must be running with a valid root directory.
|
|
.Pp
|
|
Jails are a
|
|
.Fx
|
|
feature and are not relevant on other platforms.
|
|
See
|
|
.Xr jail 8
|
|
for more information on managing jails, or
|
|
.Xr zfs-zone 8
|
|
for the equivelant functionality on Linux.
|