xref: /freebsd/sys/contrib/openzfs/man/man8/zfs.8 (revision da5137abdf463bb5fee85061958a14dd12bc043e)
1eda14cbcSMatt Macy.\"
2eda14cbcSMatt Macy.\" CDDL HEADER START
3eda14cbcSMatt Macy.\"
4eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy.\"
8eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9eda14cbcSMatt Macy.\" or http://www.opensolaris.org/os/licensing.
10eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11eda14cbcSMatt Macy.\" and limitations under the License.
12eda14cbcSMatt Macy.\"
13eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy.\"
19eda14cbcSMatt Macy.\" CDDL HEADER END
20eda14cbcSMatt Macy.\"
21eda14cbcSMatt Macy.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
22eda14cbcSMatt Macy.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
23eda14cbcSMatt Macy.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
24eda14cbcSMatt Macy.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
25eda14cbcSMatt Macy.\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
26eda14cbcSMatt Macy.\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
27eda14cbcSMatt Macy.\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
28eda14cbcSMatt Macy.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
29eda14cbcSMatt Macy.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
30eda14cbcSMatt Macy.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
31eda14cbcSMatt Macy.\" Copyright (c) 2014 Integros [integros.com]
32eda14cbcSMatt Macy.\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
33eda14cbcSMatt Macy.\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
34eda14cbcSMatt Macy.\" Copyright (c) 2016 Nexenta Systems, Inc. All Rights Reserved.
35eda14cbcSMatt Macy.\" Copyright 2019 Richard Laager. All rights reserved.
36eda14cbcSMatt Macy.\" Copyright 2018 Nexenta Systems, Inc.
37eda14cbcSMatt Macy.\" Copyright 2019 Joyent, Inc.
38eda14cbcSMatt Macy.\"
39*da5137abSMartin Matuska.Dd March 16, 2022
40eda14cbcSMatt Macy.Dt ZFS 8
41eda14cbcSMatt Macy.Os
4216038816SMartin Matuska.
43eda14cbcSMatt Macy.Sh NAME
44eda14cbcSMatt Macy.Nm zfs
4516038816SMartin Matuska.Nd configure ZFS datasets
46eda14cbcSMatt Macy.Sh SYNOPSIS
47eda14cbcSMatt Macy.Nm
48eda14cbcSMatt Macy.Fl ?V
49eda14cbcSMatt Macy.Nm
50eda14cbcSMatt Macy.Cm version
51eda14cbcSMatt Macy.Nm
5216038816SMartin Matuska.Cm subcommand
5316038816SMartin Matuska.Op Ar arguments
5416038816SMartin Matuska.
55eda14cbcSMatt Macy.Sh DESCRIPTION
56eda14cbcSMatt MacyThe
57eda14cbcSMatt Macy.Nm
58eda14cbcSMatt Macycommand configures ZFS datasets within a ZFS storage pool, as described in
59eda14cbcSMatt Macy.Xr zpool 8 .
60eda14cbcSMatt MacyA dataset is identified by a unique path within the ZFS namespace.
61eda14cbcSMatt MacyFor example:
6216038816SMartin Matuska.Dl pool/{filesystem,volume,snapshot}
63eda14cbcSMatt Macy.Pp
64eda14cbcSMatt Macywhere the maximum length of a dataset name is
6516038816SMartin Matuska.Sy MAXNAMELEN Pq 256B
66eda14cbcSMatt Macyand the maximum amount of nesting allowed in a path is 50 levels deep.
67eda14cbcSMatt Macy.Pp
68eda14cbcSMatt MacyA dataset can be one of the following:
6916038816SMartin Matuska.Bl -tag -offset Ds -width "file system"
70eda14cbcSMatt Macy.It Sy file system
7116038816SMartin MatuskaCan be mounted within the standard system namespace and behaves like other file
72eda14cbcSMatt Macysystems.
7316038816SMartin MatuskaWhile ZFS file systems are designed to be POSIX-compliant, known issues exist
74eda14cbcSMatt Macythat prevent compliance in some cases.
75eda14cbcSMatt MacyApplications that depend on standards conformance might fail due to non-standard
76eda14cbcSMatt Macybehavior when checking file system free space.
77eda14cbcSMatt Macy.It Sy volume
78eda14cbcSMatt MacyA logical volume exported as a raw or block device.
79eda14cbcSMatt MacyThis type of dataset should only be used when a block device is required.
80eda14cbcSMatt MacyFile systems are typically used in most environments.
81eda14cbcSMatt Macy.It Sy snapshot
82eda14cbcSMatt MacyA read-only version of a file system or volume at a given point in time.
83eda14cbcSMatt MacyIt is specified as
84eda14cbcSMatt Macy.Ar filesystem Ns @ Ns Ar name
85eda14cbcSMatt Macyor
86eda14cbcSMatt Macy.Ar volume Ns @ Ns Ar name .
87eda14cbcSMatt Macy.It Sy bookmark
88eda14cbcSMatt MacyMuch like a
89eda14cbcSMatt Macy.Sy snapshot ,
90eda14cbcSMatt Macybut without the hold on on-disk data.
9116038816SMartin MatuskaIt can be used as the source of a send (but not for a receive).
9216038816SMartin MatuskaIt is specified as
93eda14cbcSMatt Macy.Ar filesystem Ns # Ns Ar name
94eda14cbcSMatt Macyor
95eda14cbcSMatt Macy.Ar volume Ns # Ns Ar name .
96eda14cbcSMatt Macy.El
97eda14cbcSMatt Macy.Pp
9816038816SMartin MatuskaSee
993ff01b23SMartin Matuska.Xr zfsconcepts 7
10016038816SMartin Matuskafor details.
10116038816SMartin Matuska.
102eda14cbcSMatt Macy.Ss Properties
10316038816SMartin MatuskaProperties are divided into two types: native properties and user-defined
10416038816SMartin Matuska.Pq or Qq user
105eda14cbcSMatt Macyproperties.
106eda14cbcSMatt MacyNative properties either export internal statistics or control ZFS behavior.
107eda14cbcSMatt MacyIn addition, native properties are either editable or read-only.
108eda14cbcSMatt MacyUser properties have no effect on ZFS behavior, but you can use them to annotate
109eda14cbcSMatt Macydatasets in a way that is meaningful in your environment.
11016038816SMartin MatuskaFor more information about properties, see
1113ff01b23SMartin Matuska.Xr zfsprops 7 .
11216038816SMartin Matuska.
113eda14cbcSMatt Macy.Ss Encryption
114eda14cbcSMatt MacyEnabling the
115eda14cbcSMatt Macy.Sy encryption
116eda14cbcSMatt Macyfeature allows for the creation of encrypted filesystems and volumes.
117eda14cbcSMatt MacyZFS will encrypt file and zvol data, file attributes, ACLs, permission bits,
118eda14cbcSMatt Macydirectory listings, FUID mappings, and
11916038816SMartin Matuska.Sy userused Ns / Ns Sy groupused Ns / Ns Sy projectused
120eda14cbcSMatt Macydata.
12116038816SMartin MatuskaFor an overview of encryption, see
12216038816SMartin Matuska.Xr zfs-load-key 8 .
12316038816SMartin Matuska.
124eda14cbcSMatt Macy.Sh SUBCOMMANDS
125eda14cbcSMatt MacyAll subcommands that modify state are logged persistently to the pool in their
126eda14cbcSMatt Macyoriginal form.
127eda14cbcSMatt Macy.Bl -tag -width ""
128eda14cbcSMatt Macy.It Nm Fl ?
129eda14cbcSMatt MacyDisplays a help message.
130eda14cbcSMatt Macy.It Xo
131eda14cbcSMatt Macy.Nm
132eda14cbcSMatt Macy.Fl V , -version
133eda14cbcSMatt Macy.Xc
134eda14cbcSMatt Macy.It Xo
135eda14cbcSMatt Macy.Nm
136eda14cbcSMatt Macy.Cm version
137eda14cbcSMatt Macy.Xc
138eda14cbcSMatt MacyDisplays the software version of the
139eda14cbcSMatt Macy.Nm
140eda14cbcSMatt Macyuserland utility and the zfs kernel module.
141eda14cbcSMatt Macy.El
14216038816SMartin Matuska.
143eda14cbcSMatt Macy.Ss Dataset Management
144eda14cbcSMatt Macy.Bl -tag -width ""
145eda14cbcSMatt Macy.It Xr zfs-list 8
146eda14cbcSMatt MacyLists the property information for the given datasets in tabular form.
147eda14cbcSMatt Macy.It Xr zfs-create 8
148eda14cbcSMatt MacyCreates a new ZFS file system or volume.
149eda14cbcSMatt Macy.It Xr zfs-destroy 8
150eda14cbcSMatt MacyDestroys the given dataset(s), snapshot(s), or bookmark.
151eda14cbcSMatt Macy.It Xr zfs-rename 8
152eda14cbcSMatt MacyRenames the given dataset (filesystem or snapshot).
153eda14cbcSMatt Macy.It Xr zfs-upgrade 8
154eda14cbcSMatt MacyManage upgrading the on-disk version of filesystems.
155eda14cbcSMatt Macy.El
15616038816SMartin Matuska.
157eda14cbcSMatt Macy.Ss Snapshots
158eda14cbcSMatt Macy.Bl -tag -width ""
159eda14cbcSMatt Macy.It Xr zfs-snapshot 8
160eda14cbcSMatt MacyCreates snapshots with the given names.
161eda14cbcSMatt Macy.It Xr zfs-rollback 8
162eda14cbcSMatt MacyRoll back the given dataset to a previous snapshot.
16316038816SMartin Matuska.It Xr zfs-hold 8 Ns / Ns Xr zfs-release 8
164eda14cbcSMatt MacyAdd or remove a hold reference to the specified snapshot or snapshots.
165eda14cbcSMatt MacyIf a hold exists on a snapshot, attempts to destroy that snapshot by using the
166eda14cbcSMatt Macy.Nm zfs Cm destroy
167eda14cbcSMatt Macycommand return
16816038816SMartin Matuska.Sy EBUSY .
169eda14cbcSMatt Macy.It Xr zfs-diff 8
170eda14cbcSMatt MacyDisplay the difference between a snapshot of a given filesystem and another
171eda14cbcSMatt Macysnapshot of that filesystem from a later time or the current contents of the
172eda14cbcSMatt Macyfilesystem.
173eda14cbcSMatt Macy.El
17416038816SMartin Matuska.
175eda14cbcSMatt Macy.Ss Clones
176eda14cbcSMatt Macy.Bl -tag -width ""
177eda14cbcSMatt Macy.It Xr zfs-clone 8
178eda14cbcSMatt MacyCreates a clone of the given snapshot.
179eda14cbcSMatt Macy.It Xr zfs-promote 8
180eda14cbcSMatt MacyPromotes a clone file system to no longer be dependent on its
181eda14cbcSMatt Macy.Qq origin
182eda14cbcSMatt Macysnapshot.
183eda14cbcSMatt Macy.El
18416038816SMartin Matuska.
185eda14cbcSMatt Macy.Ss Send & Receive
186eda14cbcSMatt Macy.Bl -tag -width ""
187eda14cbcSMatt Macy.It Xr zfs-send 8
188eda14cbcSMatt MacyGenerate a send stream, which may be of a filesystem, and may be incremental
189eda14cbcSMatt Macyfrom a bookmark.
190eda14cbcSMatt Macy.It Xr zfs-receive 8
191eda14cbcSMatt MacyCreates a snapshot whose contents are as specified in the stream provided on
192eda14cbcSMatt Macystandard input.
193eda14cbcSMatt MacyIf a full stream is received, then a new file system is created as well.
194eda14cbcSMatt MacyStreams are created using the
195eda14cbcSMatt Macy.Xr zfs-send 8
196eda14cbcSMatt Macysubcommand, which by default creates a full stream.
197eda14cbcSMatt Macy.It Xr zfs-bookmark 8
198eda14cbcSMatt MacyCreates a new bookmark of the given snapshot or bookmark.
199eda14cbcSMatt MacyBookmarks mark the point in time when the snapshot was created, and can be used
200eda14cbcSMatt Macyas the incremental source for a
201eda14cbcSMatt Macy.Nm zfs Cm send
202eda14cbcSMatt Macycommand.
203eda14cbcSMatt Macy.It Xr zfs-redact 8
204eda14cbcSMatt MacyGenerate a new redaction bookmark.
205eda14cbcSMatt MacyThis feature can be used to allow clones of a filesystem to be made available on
206eda14cbcSMatt Macya remote system, in the case where their parent need not (or needs to not) be
207eda14cbcSMatt Macyusable.
208eda14cbcSMatt Macy.El
20916038816SMartin Matuska.
210eda14cbcSMatt Macy.Ss Properties
211eda14cbcSMatt Macy.Bl -tag -width ""
212eda14cbcSMatt Macy.It Xr zfs-get 8
213eda14cbcSMatt MacyDisplays properties for the given datasets.
214eda14cbcSMatt Macy.It Xr zfs-set 8
215eda14cbcSMatt MacySets the property or list of properties to the given value(s) for each dataset.
216eda14cbcSMatt Macy.It Xr zfs-inherit 8
217eda14cbcSMatt MacyClears the specified property, causing it to be inherited from an ancestor,
218eda14cbcSMatt Macyrestored to default if no ancestor has the property set, or with the
219eda14cbcSMatt Macy.Fl S
220eda14cbcSMatt Macyoption reverted to the received value if one exists.
221eda14cbcSMatt Macy.El
22216038816SMartin Matuska.
223eda14cbcSMatt Macy.Ss Quotas
224eda14cbcSMatt Macy.Bl -tag -width ""
22516038816SMartin Matuska.It Xr zfs-userspace 8 Ns / Ns Xr zfs-groupspace 8 Ns / Ns Xr zfs-projectspace 8
226eda14cbcSMatt MacyDisplays space consumed by, and quotas on, each user, group, or project
227eda14cbcSMatt Macyin the specified filesystem or snapshot.
228eda14cbcSMatt Macy.It Xr zfs-project 8
229eda14cbcSMatt MacyList, set, or clear project ID and/or inherit flag on the file(s) or directories.
230eda14cbcSMatt Macy.El
23116038816SMartin Matuska.
232eda14cbcSMatt Macy.Ss Mountpoints
233eda14cbcSMatt Macy.Bl -tag -width ""
234eda14cbcSMatt Macy.It Xr zfs-mount 8
235eda14cbcSMatt MacyDisplays all ZFS file systems currently mounted, or mount ZFS filesystem
236eda14cbcSMatt Macyon a path described by its
237eda14cbcSMatt Macy.Sy mountpoint
238eda14cbcSMatt Macyproperty.
239eda14cbcSMatt Macy.It Xr zfs-unmount 8
240eda14cbcSMatt MacyUnmounts currently mounted ZFS file systems.
241eda14cbcSMatt Macy.El
24216038816SMartin Matuska.
243eda14cbcSMatt Macy.Ss Shares
244eda14cbcSMatt Macy.Bl -tag -width ""
245eda14cbcSMatt Macy.It Xr zfs-share 8
246eda14cbcSMatt MacyShares available ZFS file systems.
247eda14cbcSMatt Macy.It Xr zfs-unshare 8
248eda14cbcSMatt MacyUnshares currently shared ZFS file systems.
249eda14cbcSMatt Macy.El
25016038816SMartin Matuska.
251eda14cbcSMatt Macy.Ss Delegated Administration
252eda14cbcSMatt Macy.Bl -tag -width ""
253eda14cbcSMatt Macy.It Xr zfs-allow 8
254eda14cbcSMatt MacyDelegate permissions on the specified filesystem or volume.
255eda14cbcSMatt Macy.It Xr zfs-unallow 8
256eda14cbcSMatt MacyRemove delegated permissions on the specified filesystem or volume.
257eda14cbcSMatt Macy.El
25816038816SMartin Matuska.
259eda14cbcSMatt Macy.Ss Encryption
260eda14cbcSMatt Macy.Bl -tag -width ""
261eda14cbcSMatt Macy.It Xr zfs-change-key 8
262eda14cbcSMatt MacyAdd or change an encryption key on the specified dataset.
263eda14cbcSMatt Macy.It Xr zfs-load-key 8
264eda14cbcSMatt MacyLoad the key for the specified encrypted dataset, enabling access.
265eda14cbcSMatt Macy.It Xr zfs-unload-key 8
266eda14cbcSMatt MacyUnload a key for the specified dataset, removing the ability to access the dataset.
267eda14cbcSMatt Macy.El
26816038816SMartin Matuska.
269eda14cbcSMatt Macy.Ss Channel Programs
270eda14cbcSMatt Macy.Bl -tag -width ""
271eda14cbcSMatt Macy.It Xr zfs-program 8
272eda14cbcSMatt MacyExecute ZFS administrative operations
273eda14cbcSMatt Macyprogrammatically via a Lua script-language channel program.
274eda14cbcSMatt Macy.El
27516038816SMartin Matuska.
276eda14cbcSMatt Macy.Ss Jails
277eda14cbcSMatt Macy.Bl -tag -width ""
278eda14cbcSMatt Macy.It Xr zfs-jail 8
279eda14cbcSMatt MacyAttaches a filesystem to a jail.
280eda14cbcSMatt Macy.It Xr zfs-unjail 8
281eda14cbcSMatt MacyDetaches a filesystem from a jail.
282eda14cbcSMatt Macy.El
28316038816SMartin Matuska.
284eda14cbcSMatt Macy.Ss Waiting
285eda14cbcSMatt Macy.Bl -tag -width ""
286eda14cbcSMatt Macy.It Xr zfs-wait 8
287eda14cbcSMatt MacyWait for background activity in a filesystem to complete.
288eda14cbcSMatt Macy.El
28916038816SMartin Matuska.
290eda14cbcSMatt Macy.Sh EXIT STATUS
291eda14cbcSMatt MacyThe
292eda14cbcSMatt Macy.Nm
29316038816SMartin Matuskautility exits
29416038816SMartin Matuska.Sy 0
29516038816SMartin Matuskaon success,
29616038816SMartin Matuska.Sy 1
29716038816SMartin Matuskaif an error occurs, and
29816038816SMartin Matuska.Sy 2
29916038816SMartin Matuskaif invalid command line options were specified.
30016038816SMartin Matuska.
301eda14cbcSMatt Macy.Sh EXAMPLES
302*da5137abSMartin Matuska.\" Examples 1, 4, 6, 7, 11, 14, 16 are shared with zfs-set.8.
303*da5137abSMartin Matuska.\" Examples 1, 10 are shared with zfs-create.8.
304*da5137abSMartin Matuska.\" Examples 2, 3, 10, 15 are also shared with zfs-snapshot.8.
305*da5137abSMartin Matuska.\" Examples 3, 10, 15 are shared with zfs-destroy.8.
306*da5137abSMartin Matuska.\" Examples 5 are shared with zfs-list.8.
307*da5137abSMartin Matuska.\" Examples 8 are shared with zfs-rollback.8.
308*da5137abSMartin Matuska.\" Examples 9, 10 are shared with zfs-clone.8.
309*da5137abSMartin Matuska.\" Examples 10 are also shared with zfs-promote.8.
310*da5137abSMartin Matuska.\" Examples 10, 15 also are shared with zfs-rename.8.
311*da5137abSMartin Matuska.\" Examples 12, 13 are shared with zfs-send.8.
312*da5137abSMartin Matuska.\" Examples 12, 13 are also shared with zfs-receive.8.
313*da5137abSMartin Matuska.\" Examples 17, 18, 19, 20, 21 are shared with zfs-allow.8.
314*da5137abSMartin Matuska.\" Examples 22 are shared with zfs-diff.8.
315*da5137abSMartin Matuska.\" Examples 23 are shared with zfs-bookmark.8.
316*da5137abSMartin Matuska.\" Make sure to update them omnidirectionally
317*da5137abSMartin Matuska.Ss Example 1 : No Creating a ZFS File System Hierarchy
318eda14cbcSMatt MacyThe following commands create a file system named
31916038816SMartin Matuska.Ar pool/home
320eda14cbcSMatt Macyand a file system named
32116038816SMartin Matuska.Ar pool/home/bob .
322eda14cbcSMatt MacyThe mount point
323eda14cbcSMatt Macy.Pa /export/home
324eda14cbcSMatt Macyis set for the parent file system, and is automatically inherited by the child
325eda14cbcSMatt Macyfile system.
32616038816SMartin Matuska.Dl # Nm zfs Cm create Ar pool/home
32716038816SMartin Matuska.Dl # Nm zfs Cm set Sy mountpoint Ns = Ns Ar /export/home pool/home
32816038816SMartin Matuska.Dl # Nm zfs Cm create Ar pool/home/bob
32916038816SMartin Matuska.
330*da5137abSMartin Matuska.Ss Example 2 : No Creating a ZFS Snapshot
331eda14cbcSMatt MacyThe following command creates a snapshot named
33216038816SMartin Matuska.Ar yesterday .
333eda14cbcSMatt MacyThis snapshot is mounted on demand in the
334eda14cbcSMatt Macy.Pa .zfs/snapshot
335eda14cbcSMatt Macydirectory at the root of the
33616038816SMartin Matuska.Ar pool/home/bob
337eda14cbcSMatt Macyfile system.
33816038816SMartin Matuska.Dl # Nm zfs Cm snapshot Ar pool/home/bob Ns @ Ns Ar yesterday
33916038816SMartin Matuska.
340*da5137abSMartin Matuska.Ss Example 3 : No Creating and Destroying Multiple Snapshots
341eda14cbcSMatt MacyThe following command creates snapshots named
34216038816SMartin Matuska.Ar yesterday No of Ar pool/home
343eda14cbcSMatt Macyand all of its descendent file systems.
344eda14cbcSMatt MacyEach snapshot is mounted on demand in the
345eda14cbcSMatt Macy.Pa .zfs/snapshot
346eda14cbcSMatt Macydirectory at the root of its file system.
347eda14cbcSMatt MacyThe second command destroys the newly created snapshots.
34816038816SMartin Matuska.Dl # Nm zfs Cm snapshot Fl r Ar pool/home Ns @ Ns Ar yesterday
34916038816SMartin Matuska.Dl # Nm zfs Cm destroy Fl r Ar pool/home Ns @ Ns Ar yesterday
35016038816SMartin Matuska.
351*da5137abSMartin Matuska.Ss Example 4 : No Disabling and Enabling File System Compression
352eda14cbcSMatt MacyThe following command disables the
353eda14cbcSMatt Macy.Sy compression
354eda14cbcSMatt Macyproperty for all file systems under
35516038816SMartin Matuska.Ar pool/home .
356eda14cbcSMatt MacyThe next command explicitly enables
357eda14cbcSMatt Macy.Sy compression
358eda14cbcSMatt Macyfor
35916038816SMartin Matuska.Ar pool/home/anne .
36016038816SMartin Matuska.Dl # Nm zfs Cm set Sy compression Ns = Ns Sy off Ar pool/home
36116038816SMartin Matuska.Dl # Nm zfs Cm set Sy compression Ns = Ns Sy on Ar pool/home/anne
36216038816SMartin Matuska.
363*da5137abSMartin Matuska.Ss Example 5 : No Listing ZFS Datasets
364eda14cbcSMatt MacyThe following command lists all active file systems and volumes in the system.
36516038816SMartin MatuskaSnapshots are displayed if
36616038816SMartin Matuska.Sy listsnaps Ns = Ns Sy on .
367eda14cbcSMatt MacyThe default is
368eda14cbcSMatt Macy.Sy off .
369eda14cbcSMatt MacySee
3703ff01b23SMartin Matuska.Xr zpoolprops 7
371eda14cbcSMatt Macyfor more information on pool properties.
37216038816SMartin Matuska.Bd -literal -compact -offset Ds
37316038816SMartin Matuska.No # Nm zfs Cm list
374eda14cbcSMatt MacyNAME                      USED  AVAIL  REFER  MOUNTPOINT
375eda14cbcSMatt Macypool                      450K   457G    18K  /pool
376eda14cbcSMatt Macypool/home                 315K   457G    21K  /export/home
377eda14cbcSMatt Macypool/home/anne             18K   457G    18K  /export/home/anne
378eda14cbcSMatt Macypool/home/bob             276K   457G   276K  /export/home/bob
379eda14cbcSMatt Macy.Ed
38016038816SMartin Matuska.
381*da5137abSMartin Matuska.Ss Example 6 : No Setting a Quota on a ZFS File System
382eda14cbcSMatt MacyThe following command sets a quota of 50 Gbytes for
38316038816SMartin Matuska.Ar pool/home/bob :
38416038816SMartin Matuska.Dl # Nm zfs Cm set Sy quota Ns = Ns Ar 50G pool/home/bob
38516038816SMartin Matuska.
386*da5137abSMartin Matuska.Ss Example 7 : No Listing ZFS Properties
387eda14cbcSMatt MacyThe following command lists all properties for
38816038816SMartin Matuska.Ar pool/home/bob :
38916038816SMartin Matuska.Bd -literal -compact -offset Ds
39016038816SMartin Matuska.No # Nm zfs Cm get Sy all Ar pool/home/bob
391eda14cbcSMatt MacyNAME           PROPERTY              VALUE                  SOURCE
392eda14cbcSMatt Macypool/home/bob  type                  filesystem             -
393eda14cbcSMatt Macypool/home/bob  creation              Tue Jul 21 15:53 2009  -
394eda14cbcSMatt Macypool/home/bob  used                  21K                    -
395eda14cbcSMatt Macypool/home/bob  available             20.0G                  -
396eda14cbcSMatt Macypool/home/bob  referenced            21K                    -
397eda14cbcSMatt Macypool/home/bob  compressratio         1.00x                  -
398eda14cbcSMatt Macypool/home/bob  mounted               yes                    -
399eda14cbcSMatt Macypool/home/bob  quota                 20G                    local
400eda14cbcSMatt Macypool/home/bob  reservation           none                   default
401eda14cbcSMatt Macypool/home/bob  recordsize            128K                   default
402eda14cbcSMatt Macypool/home/bob  mountpoint            /pool/home/bob         default
403eda14cbcSMatt Macypool/home/bob  sharenfs              off                    default
404eda14cbcSMatt Macypool/home/bob  checksum              on                     default
405eda14cbcSMatt Macypool/home/bob  compression           on                     local
406eda14cbcSMatt Macypool/home/bob  atime                 on                     default
407eda14cbcSMatt Macypool/home/bob  devices               on                     default
408eda14cbcSMatt Macypool/home/bob  exec                  on                     default
409eda14cbcSMatt Macypool/home/bob  setuid                on                     default
410eda14cbcSMatt Macypool/home/bob  readonly              off                    default
411eda14cbcSMatt Macypool/home/bob  zoned                 off                    default
412eda14cbcSMatt Macypool/home/bob  snapdir               hidden                 default
413eda14cbcSMatt Macypool/home/bob  acltype               off                    default
414eda14cbcSMatt Macypool/home/bob  aclmode               discard                default
415eda14cbcSMatt Macypool/home/bob  aclinherit            restricted             default
416eda14cbcSMatt Macypool/home/bob  canmount              on                     default
417eda14cbcSMatt Macypool/home/bob  xattr                 on                     default
418eda14cbcSMatt Macypool/home/bob  copies                1                      default
419eda14cbcSMatt Macypool/home/bob  version               4                      -
420eda14cbcSMatt Macypool/home/bob  utf8only              off                    -
421eda14cbcSMatt Macypool/home/bob  normalization         none                   -
422eda14cbcSMatt Macypool/home/bob  casesensitivity       sensitive              -
423eda14cbcSMatt Macypool/home/bob  vscan                 off                    default
424eda14cbcSMatt Macypool/home/bob  nbmand                off                    default
425eda14cbcSMatt Macypool/home/bob  sharesmb              off                    default
426eda14cbcSMatt Macypool/home/bob  refquota              none                   default
427eda14cbcSMatt Macypool/home/bob  refreservation        none                   default
428eda14cbcSMatt Macypool/home/bob  primarycache          all                    default
429eda14cbcSMatt Macypool/home/bob  secondarycache        all                    default
430eda14cbcSMatt Macypool/home/bob  usedbysnapshots       0                      -
431eda14cbcSMatt Macypool/home/bob  usedbydataset         21K                    -
432eda14cbcSMatt Macypool/home/bob  usedbychildren        0                      -
433eda14cbcSMatt Macypool/home/bob  usedbyrefreservation  0                      -
434eda14cbcSMatt Macy.Ed
435eda14cbcSMatt Macy.Pp
43616038816SMartin MatuskaThe following command gets a single property value:
43716038816SMartin Matuska.Bd -literal -compact -offset Ds
43816038816SMartin Matuska.No # Nm zfs Cm get Fl H o Sy value compression Ar pool/home/bob
439eda14cbcSMatt Macyon
440eda14cbcSMatt Macy.Ed
44116038816SMartin Matuska.Pp
442eda14cbcSMatt MacyThe following command lists all properties with local settings for
44316038816SMartin Matuska.Ar pool/home/bob :
44416038816SMartin Matuska.Bd -literal -compact -offset Ds
44516038816SMartin Matuska.No # Nm zfs Cm get Fl r s Sy local Fl o Sy name , Ns Sy property , Ns Sy value all Ar pool/home/bob
446eda14cbcSMatt MacyNAME           PROPERTY              VALUE
447eda14cbcSMatt Macypool/home/bob  quota                 20G
448eda14cbcSMatt Macypool/home/bob  compression           on
449eda14cbcSMatt Macy.Ed
45016038816SMartin Matuska.
451*da5137abSMartin Matuska.Ss Example 8 : No Rolling Back a ZFS File System
452eda14cbcSMatt MacyThe following command reverts the contents of
45316038816SMartin Matuska.Ar pool/home/anne
454eda14cbcSMatt Macyto the snapshot named
45516038816SMartin Matuska.Ar yesterday ,
45616038816SMartin Matuskadeleting all intermediate snapshots:
45716038816SMartin Matuska.Dl # Nm zfs Cm rollback Fl r Ar pool/home/anne Ns @ Ns Ar yesterday
45816038816SMartin Matuska.
459*da5137abSMartin Matuska.Ss Example 9 : No Creating a ZFS Clone
460eda14cbcSMatt MacyThe following command creates a writable file system whose initial contents are
461eda14cbcSMatt Macythe same as
46216038816SMartin Matuska.Ar pool/home/bob@yesterday .
46316038816SMartin Matuska.Dl # Nm zfs Cm clone Ar pool/home/bob@yesterday pool/clone
46416038816SMartin Matuska.
465*da5137abSMartin Matuska.Ss Example 10 : No Promoting a ZFS Clone
466eda14cbcSMatt MacyThe following commands illustrate how to test out changes to a file system, and
467eda14cbcSMatt Macythen replace the original file system with the changed one, using clones, clone
468eda14cbcSMatt Macypromotion, and renaming:
46916038816SMartin Matuska.Bd -literal -compact -offset Ds
47016038816SMartin Matuska.No # Nm zfs Cm create Ar pool/project/production
471eda14cbcSMatt Macy  populate /pool/project/production with data
47216038816SMartin Matuska.No # Nm zfs Cm snapshot Ar pool/project/production Ns @ Ns Ar today
47316038816SMartin Matuska.No # Nm zfs Cm clone Ar pool/project/production@today pool/project/beta
474eda14cbcSMatt Macy  make changes to /pool/project/beta and test them
47516038816SMartin Matuska.No # Nm zfs Cm promote Ar pool/project/beta
47616038816SMartin Matuska.No # Nm zfs Cm rename Ar pool/project/production pool/project/legacy
47716038816SMartin Matuska.No # Nm zfs Cm rename Ar pool/project/beta pool/project/production
478eda14cbcSMatt Macy  once the legacy version is no longer needed, it can be destroyed
47916038816SMartin Matuska.No # Nm zfs Cm destroy Ar pool/project/legacy
480eda14cbcSMatt Macy.Ed
48116038816SMartin Matuska.
482*da5137abSMartin Matuska.Ss Example 11 : No Inheriting ZFS Properties
483eda14cbcSMatt MacyThe following command causes
48416038816SMartin Matuska.Ar pool/home/bob No and Ar pool/home/anne
485eda14cbcSMatt Macyto inherit the
486eda14cbcSMatt Macy.Sy checksum
487eda14cbcSMatt Macyproperty from their parent.
48816038816SMartin Matuska.Dl # Nm zfs Cm inherit Sy checksum Ar pool/home/bob pool/home/anne
48916038816SMartin Matuska.
490*da5137abSMartin Matuska.Ss Example 12 : No Remotely Replicating ZFS Data
491eda14cbcSMatt MacyThe following commands send a full stream and then an incremental stream to a
492eda14cbcSMatt Macyremote machine, restoring them into
493eda14cbcSMatt Macy.Em poolB/received/fs@a
494eda14cbcSMatt Macyand
495eda14cbcSMatt Macy.Em poolB/received/fs@b ,
496eda14cbcSMatt Macyrespectively.
497eda14cbcSMatt Macy.Em poolB
498eda14cbcSMatt Macymust contain the file system
499eda14cbcSMatt Macy.Em poolB/received ,
500eda14cbcSMatt Macyand must not initially contain
501eda14cbcSMatt Macy.Em poolB/received/fs .
50216038816SMartin Matuska.Bd -literal -compact -offset Ds
50316038816SMartin Matuska.No # Nm zfs Cm send Ar pool/fs@a |
50416038816SMartin Matuska.No "   " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs Ns @ Ns Ar a
50516038816SMartin Matuska.No # Nm zfs Cm send Fl i Ar a pool/fs@b |
50616038816SMartin Matuska.No "   " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs
507eda14cbcSMatt Macy.Ed
50816038816SMartin Matuska.
509*da5137abSMartin Matuska.Ss Example 13 : No Using the Nm zfs Cm receive Fl d No Option
510eda14cbcSMatt MacyThe following command sends a full stream of
51116038816SMartin Matuska.Ar poolA/fsA/fsB@snap
512eda14cbcSMatt Macyto a remote machine, receiving it into
51316038816SMartin Matuska.Ar poolB/received/fsA/fsB@snap .
514eda14cbcSMatt MacyThe
51516038816SMartin Matuska.Ar fsA/fsB@snap
516eda14cbcSMatt Macyportion of the received snapshot's name is determined from the name of the sent
517eda14cbcSMatt Macysnapshot.
51816038816SMartin Matuska.Ar poolB
519eda14cbcSMatt Macymust contain the file system
52016038816SMartin Matuska.Ar poolB/received .
521eda14cbcSMatt MacyIf
52216038816SMartin Matuska.Ar poolB/received/fsA
523eda14cbcSMatt Macydoes not exist, it is created as an empty file system.
52416038816SMartin Matuska.Bd -literal -compact -offset Ds
52516038816SMartin Matuska.No # Nm zfs Cm send Ar poolA/fsA/fsB@snap |
52616038816SMartin Matuska.No "   " Nm ssh Ar host Nm zfs Cm receive Fl d Ar poolB/received
527eda14cbcSMatt Macy.Ed
52816038816SMartin Matuska.
529*da5137abSMartin Matuska.Ss Example 14 : No Setting User Properties
530eda14cbcSMatt MacyThe following example sets the user-defined
53116038816SMartin Matuska.Ar com.example : Ns Ar department
53216038816SMartin Matuskaproperty for a dataset:
53316038816SMartin Matuska.Dl # Nm zfs Cm set Ar com.example : Ns Ar department Ns = Ns Ar 12345 tank/accounting
53416038816SMartin Matuska.
535*da5137abSMartin Matuska.Ss Example 15 : No Performing a Rolling Snapshot
536eda14cbcSMatt MacyThe following example shows how to maintain a history of snapshots with a
537eda14cbcSMatt Macyconsistent naming scheme.
538eda14cbcSMatt MacyTo keep a week's worth of snapshots, the user destroys the oldest snapshot,
539eda14cbcSMatt Macyrenames the remaining snapshots, and then creates a new snapshot, as follows:
54016038816SMartin Matuska.Bd -literal -compact -offset Ds
54116038816SMartin Matuska.No # Nm zfs Cm destroy Fl r Ar pool/users@7daysago
54216038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@6daysago No @ Ns Ar 7daysago
54316038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@5daysago No @ Ns Ar 6daysago
54416038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@4daysago No @ Ns Ar 5daysago
54516038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@3daysago No @ Ns Ar 4daysago
54616038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@2daysago No @ Ns Ar 3daysago
54716038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@yesterday No @ Ns Ar 2daysago
54816038816SMartin Matuska.No # Nm zfs Cm rename Fl r Ar pool/users@today No @ Ns Ar yesterday
54916038816SMartin Matuska.No # Nm zfs Cm snapshot Fl r Ar pool/users Ns @ Ns Ar today
550eda14cbcSMatt Macy.Ed
55116038816SMartin Matuska.
552*da5137abSMartin Matuska.Ss Example 16 : No Setting sharenfs Property Options on a ZFS File System
553eda14cbcSMatt MacyThe following commands show how to set
554eda14cbcSMatt Macy.Sy sharenfs
55516038816SMartin Matuskaproperty options to enable read-write
55616038816SMartin Matuskaaccess for a set of IP addresses and to enable root access for system
55716038816SMartin Matuska.Qq neo
558eda14cbcSMatt Macyon the
55916038816SMartin Matuska.Ar tank/home
56016038816SMartin Matuskafile system:
5616ba2210eSMartin Matuska.Dl # Nm zfs Cm set Sy sharenfs Ns = Ns ' Ns Ar rw Ns =@123.123.0.0/16:[::1],root= Ns Ar neo Ns ' tank/home
562eda14cbcSMatt Macy.Pp
56316038816SMartin MatuskaIf you are using DNS for host name resolution,
56416038816SMartin Matuskaspecify the fully-qualified hostname.
56516038816SMartin Matuska.
566*da5137abSMartin Matuska.Ss Example 17 : No Delegating ZFS Administration Permissions on a ZFS Dataset
567eda14cbcSMatt MacyThe following example shows how to set permissions so that user
56816038816SMartin Matuska.Ar cindys
569eda14cbcSMatt Macycan create, destroy, mount, and take snapshots on
57016038816SMartin Matuska.Ar tank/cindys .
571eda14cbcSMatt MacyThe permissions on
57216038816SMartin Matuska.Ar tank/cindys
573eda14cbcSMatt Macyare also displayed.
57416038816SMartin Matuska.Bd -literal -compact -offset Ds
57516038816SMartin Matuska.No # Nm zfs Cm allow Sy cindys create , Ns Sy destroy , Ns Sy mount , Ns Sy snapshot Ar tank/cindys
57616038816SMartin Matuska.No # Nm zfs Cm allow Ar tank/cindys
577eda14cbcSMatt Macy---- Permissions on tank/cindys --------------------------------------
578eda14cbcSMatt MacyLocal+Descendent permissions:
579eda14cbcSMatt Macy        user cindys create,destroy,mount,snapshot
580eda14cbcSMatt Macy.Ed
581eda14cbcSMatt Macy.Pp
582eda14cbcSMatt MacyBecause the
58316038816SMartin Matuska.Ar tank/cindys
584eda14cbcSMatt Macymount point permission is set to 755 by default, user
58516038816SMartin Matuska.Ar cindys
586eda14cbcSMatt Macywill be unable to mount file systems under
58716038816SMartin Matuska.Ar tank/cindys .
588eda14cbcSMatt MacyAdd an ACE similar to the following syntax to provide mount point access:
58916038816SMartin Matuska.Dl # Cm chmod No A+user: Ns Ar cindys Ns :add_subdirectory:allow Ar /tank/cindys
59016038816SMartin Matuska.
591*da5137abSMartin Matuska.Ss Example 18 : No Delegating Create Time Permissions on a ZFS Dataset
592eda14cbcSMatt MacyThe following example shows how to grant anyone in the group
59316038816SMartin Matuska.Ar staff
594eda14cbcSMatt Macyto create file systems in
59516038816SMartin Matuska.Ar tank/users .
596eda14cbcSMatt MacyThis syntax also allows staff members to destroy their own file systems, but not
597eda14cbcSMatt Macydestroy anyone else's file system.
598eda14cbcSMatt MacyThe permissions on
59916038816SMartin Matuska.Ar tank/users
600eda14cbcSMatt Macyare also displayed.
60116038816SMartin Matuska.Bd -literal -compact -offset Ds
60216038816SMartin Matuska.No # Nm zfs Cm allow Ar staff Sy create , Ns Sy mount Ar tank/users
60316038816SMartin Matuska.No # Nm zfs Cm allow Fl c Sy destroy Ar tank/users
60416038816SMartin Matuska.No # Nm zfs Cm allow Ar tank/users
605eda14cbcSMatt Macy---- Permissions on tank/users ---------------------------------------
606eda14cbcSMatt MacyPermission sets:
607eda14cbcSMatt Macy        destroy
608eda14cbcSMatt MacyLocal+Descendent permissions:
609eda14cbcSMatt Macy        group staff create,mount
610eda14cbcSMatt Macy.Ed
61116038816SMartin Matuska.
612*da5137abSMartin Matuska.Ss Example 19 : No Defining and Granting a Permission Set on a ZFS Dataset
613eda14cbcSMatt MacyThe following example shows how to define and grant a permission set on the
61416038816SMartin Matuska.Ar tank/users
615eda14cbcSMatt Macyfile system.
616eda14cbcSMatt MacyThe permissions on
61716038816SMartin Matuska.Ar tank/users
618eda14cbcSMatt Macyare also displayed.
61916038816SMartin Matuska.Bd -literal -compact -offset Ds
62016038816SMartin Matuska.No # Nm zfs Cm allow Fl s No @ Ns Ar pset Sy create , Ns Sy destroy , Ns Sy snapshot , Ns Sy mount Ar tank/users
62116038816SMartin Matuska.No # Nm zfs Cm allow staff No @ Ns Ar pset tank/users
62216038816SMartin Matuska.No # Nm zfs Cm allow Ar tank/users
623eda14cbcSMatt Macy---- Permissions on tank/users ---------------------------------------
624eda14cbcSMatt MacyPermission sets:
625eda14cbcSMatt Macy        @pset create,destroy,mount,snapshot
626eda14cbcSMatt MacyLocal+Descendent permissions:
627eda14cbcSMatt Macy        group staff @pset
628eda14cbcSMatt Macy.Ed
62916038816SMartin Matuska.
630*da5137abSMartin Matuska.Ss Example 20 : No Delegating Property Permissions on a ZFS Dataset
631eda14cbcSMatt MacyThe following example shows to grant the ability to set quotas and reservations
632eda14cbcSMatt Macyon the
63316038816SMartin Matuska.Ar users/home
634eda14cbcSMatt Macyfile system.
635eda14cbcSMatt MacyThe permissions on
63616038816SMartin Matuska.Ar users/home
637eda14cbcSMatt Macyare also displayed.
63816038816SMartin Matuska.Bd -literal -compact -offset Ds
63916038816SMartin Matuska.No # Nm zfs Cm allow Ar cindys Sy quota , Ns Sy reservation Ar users/home
64016038816SMartin Matuska.No # Nm zfs Cm allow Ar users/home
641eda14cbcSMatt Macy---- Permissions on users/home ---------------------------------------
642eda14cbcSMatt MacyLocal+Descendent permissions:
643eda14cbcSMatt Macy        user cindys quota,reservation
644eda14cbcSMatt Macycindys% zfs set quota=10G users/home/marks
645eda14cbcSMatt Macycindys% zfs get quota users/home/marks
646eda14cbcSMatt MacyNAME              PROPERTY  VALUE  SOURCE
647eda14cbcSMatt Macyusers/home/marks  quota     10G    local
648eda14cbcSMatt Macy.Ed
64916038816SMartin Matuska.
650*da5137abSMartin Matuska.Ss Example 21 : No Removing ZFS Delegated Permissions on a ZFS Dataset
651eda14cbcSMatt MacyThe following example shows how to remove the snapshot permission from the
65216038816SMartin Matuska.Ar staff
653eda14cbcSMatt Macygroup on the
65416038816SMartin Matuska.Sy tank/users
655eda14cbcSMatt Macyfile system.
656eda14cbcSMatt MacyThe permissions on
65716038816SMartin Matuska.Sy tank/users
658eda14cbcSMatt Macyare also displayed.
65916038816SMartin Matuska.Bd -literal -compact -offset Ds
66016038816SMartin Matuska.No # Nm zfs Cm unallow Ar staff Sy snapshot Ar tank/users
66116038816SMartin Matuska.No # Nm zfs Cm allow Ar tank/users
662eda14cbcSMatt Macy---- Permissions on tank/users ---------------------------------------
663eda14cbcSMatt MacyPermission sets:
664eda14cbcSMatt Macy        @pset create,destroy,mount,snapshot
665eda14cbcSMatt MacyLocal+Descendent permissions:
666eda14cbcSMatt Macy        group staff @pset
667eda14cbcSMatt Macy.Ed
66816038816SMartin Matuska.
669*da5137abSMartin Matuska.Ss Example 22 : No Showing the differences between a snapshot and a ZFS Dataset
670eda14cbcSMatt MacyThe following example shows how to see what has changed between a prior
671eda14cbcSMatt Macysnapshot of a ZFS dataset and its current state.
672eda14cbcSMatt MacyThe
673eda14cbcSMatt Macy.Fl F
674eda14cbcSMatt Macyoption is used to indicate type information for the files affected.
67516038816SMartin Matuska.Bd -literal -compact -offset Ds
67616038816SMartin Matuska.No # Nm zfs Cm diff Fl F Ar tank/test@before tank/test
677eda14cbcSMatt MacyM       /       /tank/test/
678eda14cbcSMatt MacyM       F       /tank/test/linked      (+1)
679eda14cbcSMatt MacyR       F       /tank/test/oldname -> /tank/test/newname
680eda14cbcSMatt Macy-       F       /tank/test/deleted
681eda14cbcSMatt Macy+       F       /tank/test/created
682eda14cbcSMatt MacyM       F       /tank/test/modified
683eda14cbcSMatt Macy.Ed
68416038816SMartin Matuska.
685*da5137abSMartin Matuska.Ss Example 23 : No Creating a bookmark
686eda14cbcSMatt MacyThe following example create a bookmark to a snapshot.
687eda14cbcSMatt MacyThis bookmark can then be used instead of snapshot in send streams.
68816038816SMartin Matuska.Dl # Nm zfs Cm bookmark Ar rpool Ns @ Ns Ar snapshot rpool Ns # Ns Ar bookmark
68916038816SMartin Matuska.
690*da5137abSMartin Matuska.Ss Example 24 : No Setting Sy sharesmb No Property Options on a ZFS File System
691eda14cbcSMatt MacyThe following example show how to share SMB filesystem through ZFS.
69216038816SMartin MatuskaNote that a user and their password must be given.
69316038816SMartin Matuska.Dl # Nm smbmount Ar //127.0.0.1/share_tmp /mnt/tmp Fl o No user=workgroup/turbo,password=obrut,uid=1000
694eda14cbcSMatt Macy.Pp
695eda14cbcSMatt MacyMinimal
69616038816SMartin Matuska.Pa /etc/samba/smb.conf
69716038816SMartin Matuskaconfiguration is required, as follows.
698eda14cbcSMatt Macy.Pp
69916038816SMartin MatuskaSamba will need to bind to the loopback interface for the ZFS utilities to
700eda14cbcSMatt Macycommunicate with Samba.
701eda14cbcSMatt MacyThis is the default behavior for most Linux distributions.
702eda14cbcSMatt Macy.Pp
703eda14cbcSMatt MacySamba must be able to authenticate a user.
70416038816SMartin MatuskaThis can be done in a number of ways
70516038816SMartin Matuska.Pq Xr passwd 5 , LDAP , Xr smbpasswd 5 , &c.\& .
70616038816SMartin MatuskaHow to do this is outside the scope of this document – refer to
707eda14cbcSMatt Macy.Xr smb.conf 5
70816038816SMartin Matuskafor more information.
709eda14cbcSMatt Macy.Pp
710eda14cbcSMatt MacySee the
71116038816SMartin Matuska.Sx USERSHARES
71216038816SMartin Matuskasection for all configuration options,
71316038816SMartin Matuskain case you need to modify any options of the share afterwards.
714eda14cbcSMatt MacyDo note that any changes done with the
715eda14cbcSMatt Macy.Xr net 8
71616038816SMartin Matuskacommand will be undone if the share is ever unshared (like via a reboot).
71716038816SMartin Matuska.
718eda14cbcSMatt Macy.Sh ENVIRONMENT VARIABLES
719eda14cbcSMatt Macy.Bl -tag -width "ZFS_MOUNT_HELPER"
72016038816SMartin Matuska.It Sy ZFS_MOUNT_HELPER
721eda14cbcSMatt MacyCause
72216038816SMartin Matuska.Nm zfs Cm mount
723eda14cbcSMatt Macyto use
72416038816SMartin Matuska.Xr mount 8
72516038816SMartin Matuskato mount ZFS datasets.
72616038816SMartin MatuskaThis option is provided for backwards compatibility with older ZFS versions.
727eda14cbcSMatt Macy.El
72816038816SMartin Matuska.
729eda14cbcSMatt Macy.Sh INTERFACE STABILITY
730eda14cbcSMatt Macy.Sy Committed .
73116038816SMartin Matuska.
732eda14cbcSMatt Macy.Sh SEE ALSO
733eda14cbcSMatt Macy.Xr attr 1 ,
734eda14cbcSMatt Macy.Xr gzip 1 ,
735eda14cbcSMatt Macy.Xr ssh 1 ,
736eda14cbcSMatt Macy.Xr chmod 2 ,
737eda14cbcSMatt Macy.Xr fsync 2 ,
738eda14cbcSMatt Macy.Xr stat 2 ,
739eda14cbcSMatt Macy.Xr write 2 ,
740eda14cbcSMatt Macy.Xr acl 5 ,
741eda14cbcSMatt Macy.Xr attributes 5 ,
742eda14cbcSMatt Macy.Xr exports 5 ,
7433ff01b23SMartin Matuska.Xr zfsconcepts 7 ,
7443ff01b23SMartin Matuska.Xr zfsprops 7 ,
745eda14cbcSMatt Macy.Xr exportfs 8 ,
746eda14cbcSMatt Macy.Xr mount 8 ,
747eda14cbcSMatt Macy.Xr net 8 ,
748eda14cbcSMatt Macy.Xr selinux 8 ,
749ac0bf12eSMatt Macy.Xr zfs-allow 8 ,
750ac0bf12eSMatt Macy.Xr zfs-bookmark 8 ,
751ac0bf12eSMatt Macy.Xr zfs-change-key 8 ,
752ac0bf12eSMatt Macy.Xr zfs-clone 8 ,
753ac0bf12eSMatt Macy.Xr zfs-create 8 ,
754ac0bf12eSMatt Macy.Xr zfs-destroy 8 ,
755ac0bf12eSMatt Macy.Xr zfs-diff 8 ,
756ac0bf12eSMatt Macy.Xr zfs-get 8 ,
757ac0bf12eSMatt Macy.Xr zfs-groupspace 8 ,
758ac0bf12eSMatt Macy.Xr zfs-hold 8 ,
759ac0bf12eSMatt Macy.Xr zfs-inherit 8 ,
760ac0bf12eSMatt Macy.Xr zfs-jail 8 ,
761ac0bf12eSMatt Macy.Xr zfs-list 8 ,
762ac0bf12eSMatt Macy.Xr zfs-load-key 8 ,
763ac0bf12eSMatt Macy.Xr zfs-mount 8 ,
764ac0bf12eSMatt Macy.Xr zfs-program 8 ,
765ac0bf12eSMatt Macy.Xr zfs-project 8 ,
766ac0bf12eSMatt Macy.Xr zfs-projectspace 8 ,
767ac0bf12eSMatt Macy.Xr zfs-promote 8 ,
768ac0bf12eSMatt Macy.Xr zfs-receive 8 ,
769ac0bf12eSMatt Macy.Xr zfs-redact 8 ,
770ac0bf12eSMatt Macy.Xr zfs-release 8 ,
771ac0bf12eSMatt Macy.Xr zfs-rename 8 ,
772ac0bf12eSMatt Macy.Xr zfs-rollback 8 ,
773ac0bf12eSMatt Macy.Xr zfs-send 8 ,
774ac0bf12eSMatt Macy.Xr zfs-set 8 ,
775ac0bf12eSMatt Macy.Xr zfs-share 8 ,
776ac0bf12eSMatt Macy.Xr zfs-snapshot 8 ,
777ac0bf12eSMatt Macy.Xr zfs-unallow 8 ,
778ac0bf12eSMatt Macy.Xr zfs-unjail 8 ,
779ac0bf12eSMatt Macy.Xr zfs-unload-key 8 ,
780ac0bf12eSMatt Macy.Xr zfs-unmount 8 ,
781ac0bf12eSMatt Macy.Xr zfs-unshare 8 ,
782ac0bf12eSMatt Macy.Xr zfs-upgrade 8 ,
783ac0bf12eSMatt Macy.Xr zfs-userspace 8 ,
784ac0bf12eSMatt Macy.Xr zfs-wait 8 ,
785eda14cbcSMatt Macy.Xr zpool 8
786