~ubuntu-branches/ubuntu/raring/zfs-fuse/raring-proposed
» Revision
12
: .pc/fix-manpage-section-mismatch/doc/zfs.8
« back to all changes in this revision
Viewing changes to .pc/fix-manpage-section-mismatch/doc/zfs.8
- browse files at revision 12
- compare with another revision
- download diff
- download tarball
- view history from revision 12
- Committer: Package Import Robot
- Author(s): Asias He
- Date: 2011-11-02 15:04:37 UTC
- Revision ID: package-import@ubuntu.com-20111102150437-nx8dko718qkyq49k
Tags: 0.7.0-3
Fix "fails to run, segfault or invalid option due to wrong argv[0]
when read cfg file is called from main" (Closes: #647326)
when read cfg file is called from main" (Closes: #647326)
- files added:
- .pc/fix-manpage-section-mismatch.patch
- .pc/fix-manpage-section-mismatch.patch/doc
- .pc/fix-segfault.patch
- .pc/fix-segfault.patch/src
- .pc/fix-segfault.patch/src/zfs-fuse
- files removed:
- .pc/fix-manpage-section-mismatch
- .pc/fix-manpage-section-mismatch/doc
- files modified:
- .pc/applied-patches
added
removed
.pc/fix-manpage-section-mismatch/doc/zfs.8
1
'\" te
2
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
3
.\" 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 http://www.opensolaris.org/os/licensing.
4
.\" 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
5
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6
.\" 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 http://www.opensolaris.org/os/licensing.
7
.\" 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
8
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
9
.TH zfs 1M "21 Dec 2009" "SunOS 5.11" "System Administration Commands"
10
.SH NAME
11
zfs \- configures ZFS file systems
12
.SH SYNOPSIS
13
.LP
14
.nf
15
\fBzfs\fR [\fB-?\fR]
16
.fi
17
18
.LP
19
.nf
20
\fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR
21
.fi
22
23
.LP
24
.nf
25
\fBzfs\fR \fBcreate\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR
26
.fi
27
28
.LP
29
.nf
30
\fBzfs\fR \fBdestroy\fR [\fB-rRf\fR] \fIfilesystem\fR|\fIvolume\fR
31
.fi
32
33
.LP
34
.nf
35
\fBzfs\fR \fBdestroy\fR [\fB-rRd\fR] \fIsnapshot\fR
36
.fi
37
38
.LP
39
.nf
40
\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
41
\fIfilesystem@snapname\fR|\fIvolume@snapname\fR
42
.fi
43
44
.LP
45
.nf
46
\fBzfs\fR \fBrollback\fR [\fB-rRf\fR] \fIsnapshot\fR
47
.fi
48
49
.LP
50
.nf
51
\fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
52
.fi
53
54
.LP
55
.nf
56
\fBzfs\fR \fBpromote\fR \fIclone-filesystem\fR
57
.fi
58
59
.LP
60
.nf
61
\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
62
\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
63
.fi
64
65
.LP
66
.nf
67
\fBzfs\fR \fBrename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR
68
.fi
69
70
.LP
71
.nf
72
\fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
73
.fi
74
75
.LP
76
.nf
77
\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-H\fR][\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
78
[\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...
79
.fi
80
81
.LP
82
.nf
83
\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
84
.fi
85
86
.LP
87
.nf
88
\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR all | \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]]
89
all | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
90
.fi
91
92
.LP
93
.nf
94
\fBzfs\fR \fBinherit\fR [\fB-rS\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
95
.fi
96
97
.LP
98
.nf
99
\fBzfs\fR \fBupgrade\fR [\fB-v\fR]
100
.fi
101
102
.LP
103
.nf
104
\fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
105
.fi
106
107
.LP
108
.nf
109
\fBzfs\fR \fBuserspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR] ...
110
[\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR|\fIsnapshot\fR
111
.fi
112
113
.LP
114
.nf
115
\fBzfs\fR \fBgroupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR] ...
116
[\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR|\fIsnapshot\fR
117
.fi
118
119
.LP
120
.nf
121
\fBzfs\fR \fBmount\fR
122
.fi
123
124
.LP
125
.nf
126
\fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
127
.fi
128
129
.LP
130
.nf
131
\fBzfs\fR \fBunmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
132
.fi
133
134
.LP
135
.nf
136
\fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
137
.fi
138
139
.LP
140
.nf
141
\fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
142
.fi
143
144
.LP
145
.nf
146
\fBzfs\fR \fBsend\fR [\fB-DvRp\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
147
.fi
148
149
.LP
150
.nf
151
\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
152
.fi
153
154
.LP
155
.nf
156
\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR | \fB-e\fR] \fIfilesystem\fR
157
.fi
158
159
.LP
160
.nf
161
\fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
162
.fi
163
164
.LP
165
.nf
166
\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...]
167
\fIfilesystem\fR|\fIvolume\fR
168
.fi
169
170
.LP
171
.nf
172
\fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
173
.fi
174
175
.LP
176
.nf
177
\fBzfs\fR \fBallow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
178
.fi
179
180
.LP
181
.nf
182
\fBzfs\fR \fBallow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
183
.fi
184
185
.LP
186
.nf
187
\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]]
188
\fIfilesystem\fR|\fIvolume\fR
189
.fi
190
191
.LP
192
.nf
193
\fBzfs\fR \fBunallow\fR [\fB-rld\fR] \fB-e\fR [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
194
.fi
195
196
.LP
197
.nf
198
\fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[ ... ]] \fIfilesystem\fR|\fIvolume\fR
199
.fi
200
201
.LP
202
.nf
203
\fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
204
.fi
205
206
.LP
207
.nf
208
\fBzfs\fR \fBhold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
209
.fi
210
211
.LP
212
.nf
213
\fBzfs\fR \fBholds\fR [\fB-r\fR] \fIsnapshot\fR...
214
.fi
215
216
.LP
217
.nf
218
\fBzfs\fR \fBrelease\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
219
.fi
220
221
.SH DESCRIPTION
222
.sp
223
.LP
224
The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage pool, as described in \fBzpool\fR(1M). A dataset is identified by a unique path within the \fBZFS\fR namespace. For example:
225
.sp
226
.in +2
227
.nf
228
pool/{filesystem,volume,snapshot}
229
.fi
230
.in -2
231
.sp
232
233
.sp
234
.LP
235
where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
236
.sp
237
.LP
238
A dataset can be one of the following:
239
.sp
240
.ne 2
241
.mk
242
.na
243
\fB\fIfile system\fR\fR
244
.ad
245
.sp .6
246
.RS 4n
247
A \fBZFS\fR dataset of type \fBfilesystem\fR can be mounted within the standard system namespace and behaves like other file systems. While \fBZFS\fR file systems are designed to be \fBPOSIX\fR compliant, known issues exist that prevent compliance in some cases. Applications that depend on standards conformance might fail due to nonstandard behavior when checking file system free space.
248
.RE
249
250
.sp
251
.ne 2
252
.mk
253
.na
254
\fB\fIvolume\fR\fR
255
.ad
256
.sp .6
257
.RS 4n
258
A logical volume exported as a raw or block device. This type of dataset should only be used under special circumstances. File systems are typically used in most environments.
259
.RE
260
261
.sp
262
.ne 2
263
.mk
264
.na
265
\fB\fIsnapshot\fR\fR
266
.ad
267
.sp .6
268
.RS 4n
269
A read-only version of a file system or volume at a given point in time. It is specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
270
.RE
271
272
.SS "ZFS File System Hierarchy"
273
.sp
274
.LP
275
A \fBZFS\fR storage pool is a logical collection of devices that provide space for datasets. A storage pool is also the root of the \fBZFS\fR file system hierarchy.
276
.sp
277
.LP
278
The root of the pool can be accessed as a file system, such as mounting and unmounting, taking snapshots, and setting properties. The physical storage characteristics, however, are managed by the \fBzpool\fR(1M) command.
279
.sp
280
.LP
281
See \fBzpool\fR(1M) for more information on creating and administering pools.
282
.SS "Snapshots"
283
.sp
284
.LP
285
A snapshot is a read-only copy of a file system or volume. Snapshots can be created extremely quickly, and initially consume no additional space within the pool. As data within the active dataset changes, the snapshot consumes more data than would otherwise be shared with the active dataset.
286
.sp
287
.LP
288
Snapshots can have arbitrary names. Snapshots of volumes can be cloned or rolled back, but cannot be accessed independently.
289
.sp
290
.LP
291
File system snapshots can be accessed under the \fB\&.zfs/snapshot\fR directory in the root of the file system. Snapshots are automatically mounted on demand and may be unmounted at regular intervals. The visibility of the \fB\&.zfs\fR directory can be controlled by the \fBsnapdir\fR property.
292
.SS "Clones"
293
.sp
294
.LP
295
A clone is a writable volume or file system whose initial contents are the same as another dataset. As with snapshots, creating a clone is nearly instantaneous, and initially consumes no additional space.
296
.sp
297
.LP
298
Clones can only be created from a snapshot. When a snapshot is cloned, it creates an implicit dependency between the parent and child. Even though the clone is created somewhere else in the dataset hierarchy, the original snapshot cannot be destroyed as long as a clone exists. The \fBorigin\fR property exposes this dependency, and the \fBdestroy\fR command lists any such dependencies, if they exist.
299
.sp
300
.LP
301
The clone parent-child dependency relationship can be reversed by using the \fBpromote\fR subcommand. This causes the "origin" file system to become a clone of the specified file system, which makes it possible to destroy the file system that the clone was created from.
302
.SS "Mount Points"
303
.sp
304
.LP
305
Creating a \fBZFS\fR file system is a simple operation, so the number of file systems per system is likely to be numerous. To cope with this, \fBZFS\fR automatically manages mounting and unmounting file systems without the need to edit the \fB/etc/vfstab\fR file. All automatically managed file systems are mounted by \fBZFS\fR at boot time.
306
.sp
307
.LP
308
By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR is the name of the file system in the \fBZFS\fR namespace. Directories are created and destroyed as needed.
309
.sp
310
.LP
311
A file system can also have a mount point set in the \fBmountpoint\fR property. This directory is created as needed, and \fBZFS\fR automatically mounts the file system when the \fBzfs mount -a\fR command is invoked (without editing \fB/etc/vfstab\fR). The \fBmountpoint\fR property can be inherited, so if \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then \fBpool/home/user\fR automatically inherits a mount point of \fB/export/stuff/user\fR.
312
.sp
313
.LP
314
A file system \fBmountpoint\fR property of \fBnone\fR prevents the file system from being mounted.
315
.sp
316
.LP
317
If needed, \fBZFS\fR file systems can also be managed with traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point is set to \fBlegacy\fR, \fBZFS\fR makes no attempt to manage the file system, and the administrator is responsible for mounting and unmounting the file system.
318
.SS "Zones"
319
.sp
320
.LP
321
A \fBZFS\fR file system can be added to a non-global zone by using the \fBzonecfg\fR \fBadd fs\fR subcommand. A \fBZFS\fR file system that is added to a non-global zone must have its \fBmountpoint\fR property set to \fBlegacy\fR.
322
.sp
323
.LP
324
The physical properties of an added file system are controlled by the global administrator. However, the zone administrator can create, modify, or destroy files within the added file system, depending on how the file system is mounted.
325
.sp
326
.LP
327
A dataset can also be delegated to a non-global zone by using the \fBzonecfg\fR \fBadd dataset\fR subcommand. You cannot delegate a dataset to one zone and the children of the same dataset to another zone. The zone administrator can change properties of the dataset or any of its children. However, the \fBquota\fR property is controlled by the global administrator.
328
.sp
329
.LP
330
A \fBZFS\fR volume can be added as a device to a non-global zone by using the \fBzonecfg\fR \fBadd device\fR subcommand. However, its physical properties can be modified only by the global administrator.
331
.sp
332
.LP
333
For more information about \fBzonecfg\fR syntax, see \fBzonecfg\fR(1M).
334
.sp
335
.LP
336
After a dataset is delegated to a non-global zone, the \fBzoned\fR property is automatically set. A zoned file system cannot be mounted in the global zone, since the zone administrator might have to set the mount point to an unacceptable value.
337
.sp
338
.LP
339
The global administrator can forcibly clear the \fBzoned\fR property, though this should be done with extreme care. The global administrator should verify that all the mount points are acceptable before clearing the property.
340
.SS "Deduplication"
341
.sp
342
.LP
343
Deduplication is the process for removing redundant data at the block-level, reducing the total amount of data stored. If a file system has the \fBdedup\fR property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files.
344
.SS "Native Properties"
345
.sp
346
.LP
347
Properties are divided into two types, native properties and user-defined (or "user") properties. Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR behavior, but you can use them to annotate datasets in a way that is meaningful in your environment. For more information about user properties, see the "User Properties" section, below.
348
.sp
349
.LP
350
Every dataset has a set of properties that export statistics about the dataset as well as control various behaviors. Properties are inherited from the parent unless overridden by the child. Some properties apply only to certain types of datasets (file systems, volumes, or snapshots).
351
.sp
352
.LP
353
The values of numeric properties can be specified using human-readable suffixes (for example, \fBk\fR, \fBKB\fR, \fBM\fR, \fBGb\fR, and so forth, up to \fBZ\fR for zettabyte). The following are all valid (and equal) specifications:
354
.sp
355
.in +2
356
.nf
357
1536M, 1.5g, 1.50GB
358
.fi
359
.in -2
360
.sp
361
362
.sp
363
.LP
364
The values of non-numeric properties are case sensitive and must be lowercase, except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
365
.sp
366
.LP
367
The following native properties consist of read-only statistics about the dataset. These properties can be neither set, nor inherited. Native properties apply to all dataset types unless otherwise noted.
368
.sp
369
.ne 2
370
.mk
371
.na
372
\fB\fBavailable\fR\fR
373
.ad
374
.sp .6
375
.RS 4n
376
The amount of space available to the dataset and all its children, assuming that there is no other activity in the pool. Because space is shared within a pool, availability can be limited by any number of factors, including physical pool size, quotas, reservations, or other datasets within the pool.
377
.sp
378
This property can also be referred to by its shortened column name, \fBavail\fR.
379
.RE
380
381
.sp
382
.ne 2
383
.mk
384
.na
385
\fB\fBcompressratio\fR\fR
386
.ad
387
.sp .6
388
.RS 4n
389
The compression ratio achieved for this dataset, expressed as a multiplier. Compression can be turned on by running: \fBzfs set compression=on \fIdataset\fR\fR. The default value is \fBoff\fR.
390
.RE
391
392
.sp
393
.ne 2
394
.mk
395
.na
396
\fB\fBcreation\fR\fR
397
.ad
398
.sp .6
399
.RS 4n
400
The time this dataset was created.
401
.RE
402
403
.sp
404
.ne 2
405
.mk
406
.na
407
\fB\fBdefer_destroy\fR\fR
408
.ad
409
.sp .6
410
.RS 4n
411
This property is \fBon\fR if the snapshot has been marked for deferred destroy by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is \fBoff\fR.
412
.RE
413
414
.sp
415
.ne 2
416
.mk
417
.na
418
\fB\fBmounted\fR\fR
419
.ad
420
.sp .6
421
.RS 4n
422
For file systems, indicates whether the file system is currently mounted. This property can be either \fByes\fR or \fBno\fR.
423
.RE
424
425
.sp
426
.ne 2
427
.mk
428
.na
429
\fB\fBorigin\fR\fR
430
.ad
431
.sp .6
432
.RS 4n
433
For cloned file systems or volumes, the snapshot from which the clone was created. The origin cannot be destroyed (even with the \fB-r\fR or \fB-f\fR options) so long as a clone exists.
434
.RE
435
436
.sp
437
.ne 2
438
.mk
439
.na
440
\fB\fBreferenced\fR\fR
441
.ad
442
.sp .6
443
.RS 4n
444
The amount of data that is accessible by this dataset, which may or may not be shared with other datasets in the pool. When a snapshot or clone is created, it initially references the same amount of space as the file system or snapshot it was created from, since its contents are identical.
445
.sp
446
This property can also be referred to by its shortened column name, \fBrefer\fR.
447
.RE
448
449
.sp
450
.ne 2
451
.mk
452
.na
453
\fB\fBtype\fR\fR
454
.ad
455
.sp .6
456
.RS 4n
457
The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR.
458
.RE
459
460
.sp
461
.ne 2
462
.mk
463
.na
464
\fB\fBused\fR\fR
465
.ad
466
.sp .6
467
.RS 4n
468
The amount of space consumed by this dataset and all its descendents. This is the value that is checked against this dataset's quota and reservation. The space used does not include this dataset's reservation, but does take into account the reservations of any descendent datasets. The amount of space that a dataset consumes from its parent, as well as the amount of space that are freed if this dataset is recursively destroyed, is the greater of its space used and its reservation.
469
.sp
470
When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
471
.sp
472
The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
473
.RE
474
475
.sp
476
.ne 2
477
.mk
478
.na
479
\fB\fBusedby*\fR\fR
480
.ad
481
.sp .6
482
.RS 4n
483
The \fBusedby*\fR properties decompose the \fBused\fR properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These properties are only available for datasets created on \fBzpool\fR "version 13" pools.
484
.RE
485
486
.sp
487
.ne 2
488
.mk
489
.na
490
\fB\fBusedbychildren\fR\fR
491
.ad
492
.sp .6
493
.RS 4n
494
The amount of space used by children of this dataset, which would be freed if all the dataset's children were destroyed.
495
.RE
496
497
.sp
498
.ne 2
499
.mk
500
.na
501
\fB\fBusedbydataset\fR\fR
502
.ad
503
.sp .6
504
.RS 4n
505
The amount of space used by this dataset itself, which would be freed if the dataset were destroyed (after first removing any \fBrefreservation\fR and destroying any necessary snapshots or descendents).
506
.RE
507
508
.sp
509
.ne 2
510
.mk
511
.na
512
\fB\fBusedbyrefreservation\fR\fR
513
.ad
514
.sp .6
515
.RS 4n
516
The amount of space used by a \fBrefreservation\fR set on this dataset, which would be freed if the \fBrefreservation\fR was removed.
517
.RE
518
519
.sp
520
.ne 2
521
.mk
522
.na
523
\fB\fBusedbysnapshots\fR\fR
524
.ad
525
.sp .6
526
.RS 4n
527
The amount of space consumed by snapshots of this dataset. In particular, it is the amount of space that would be freed if all of this dataset's snapshots were destroyed. Note that this is not simply the sum of the snapshots' \fBused\fR properties because space can be shared by multiple snapshots.
528
.RE
529
530
.sp
531
.ne 2
532
.mk
533
.na
534
\fB\fBuserused@\fR\fIuser\fR\fR
535
.ad
536
.sp .6
537
.RS 4n
538
The amount of space consumed by the specified user in this dataset. Space is charged to the owner of each file, as displayed by \fBls\fR \fB-l\fR. The amount of space charged is displayed by \fBdu\fR and \fBls\fR \fB-s\fR. See the \fBzfs userspace\fR subcommand for more information.
539
.sp
540
Unprivileged users can access only their own space usage. The root user, or a user who has been granted the \fBuserused\fR privilege with \fBzfs allow\fR, can access everyone's usage.
541
.sp
542
The \fBuserused@\fR... properties are not displayed by \fBzfs get all\fR. The user's name must be appended after the \fB@\fR symbol, using one of the following forms:
543
.RS +4
544
.TP
545
.ie t \(bu
546
.el o
547
\fIPOSIX name\fR (for example, \fBjoe\fR)
548
.RE
549
.RS +4
550
.TP
551
.ie t \(bu
552
.el o
553
\fIPOSIX numeric ID\fR (for example, \fB789\fR)
554
.RE
555
.RS +4
556
.TP
557
.ie t \(bu
558
.el o
559
\fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
560
.RE
561
.RS +4
562
.TP
563
.ie t \(bu
564
.el o
565
\fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
566
.RE
567
.RE
568
569
.sp
570
.ne 2
571
.mk
572
.na
573
\fB\fBuserrefs\fR\fR
574
.ad
575
.sp .6
576
.RS 4n
577
This property is set to the number of user holds on this snapshot. User holds are set by using the \fBzfs hold\fR command.
578
.RE
579
580
.sp
581
.ne 2
582
.mk
583
.na
584
\fB\fBgroupused@\fR\fIgroup\fR\fR
585
.ad
586
.sp .6
587
.RS 4n
588
The amount of space consumed by the specified group in this dataset. Space is charged to the group of each file, as displayed by \fBls\fR \fB-l\fR. See the \fBuserused@\fR\fIuser\fR property for more information.
589
.sp
590
Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the \fBgroupused\fR privilege with \fBzfs allow\fR, can access all groups' usage.
591
.RE
592
593
.sp
594
.ne 2
595
.mk
596
.na
597
\fB\fBvolblocksize\fR=\fIblocksize\fR\fR
598
.ad
599
.sp .6
600
.RS 4n
601
For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be changed once the volume has been written, so it should be set at volume creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid.
602
.sp
603
This property can also be referred to by its shortened column name, \fBvolblock\fR.
604
.RE
605
606
.sp
607
.LP
608
The following native properties can be used to change the behavior of a \fBZFS\fR dataset.
609
.sp
610
.ne 2
611
.mk
612
.na
613
\fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
614
.ad
615
.sp .6
616
.RS 4n
617
Controls how \fBACL\fR entries are inherited when files and directories are created. A file system with an \fBaclinherit\fR property of \fBdiscard\fR does not inherit any \fBACL\fR entries. A file system with an \fBaclinherit\fR property value of \fBnoallow\fR only inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property value \fBrestricted\fR (the default) removes the \fBwrite_acl\fR and \fBwrite_owner\fR permissions when the \fBACL\fR entry is inherited. A file system with an \fBaclinherit\fR property value of \fBpassthrough\fR inherits all inheritable \fBACL\fR entries without any modifications made to the \fBACL\fR entries when they are inherited. A file system with an \fBaclinherit\fR property value of \fBpassthrough-x\fR has the same meaning as \fBpassthrough\fR, except that the \fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file creation mode also requests the execute bit.
618
.sp
619
When the property value is set to \fBpassthrough\fR, files are created with a mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist that affect the mode, then the mode is set in accordance to the requested mode from the application.
620
.RE
621
622
.sp
623
.ne 2
624
.mk
625
.na
626
\fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR
627
.ad
628
.sp .6
629
.RS 4n
630
Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an \fBaclmode\fR property of \fBdiscard\fR deletes all \fBACL\fR entries that do not represent the mode of the file. An \fBaclmode\fR property of \fBgroupmask\fR (the default) reduces user or group permissions. The permissions are reduced, such that they are no greater than the group permission bits, unless it is a user entry that has the same \fBUID\fR as the owner of the file or directory. In this case, the \fBACL\fR permissions are reduced so that they are no greater than owner permission bits. A file system with an \fBaclmode\fR property of \fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries to represent the new mode of the file or directory.
631
.RE
632
633
.sp
634
.ne 2
635
.mk
636
.na
637
\fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
638
.ad
639
.sp .6
640
.RS 4n
641
Controls whether the access time for files is updated when they are read. Turning this property off avoids producing write traffic when reading files and can result in significant performance gains, though it might confuse mailers and other similar utilities. The default value is \fBon\fR.
642
.RE
643
644
.sp
645
.ne 2
646
.mk
647
.na
648
\fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
649
.ad
650
.sp .6
651
.RS 4n
652
If this property is set to \fBoff\fR, the file system cannot be mounted, and is ignored by \fBzfs mount -a\fR. Setting this property to \fBoff\fR is similar to setting the \fBmountpoint\fR property to \fBnone\fR, except that the dataset still has a normal \fBmountpoint\fR property, which can be inherited. Setting this property to \fBoff\fR allows datasets to be used solely as a mechanism to inherit properties. One example of setting \fBcanmount=\fR\fBoff\fR is to have two datasets with the same \fBmountpoint\fR, so that the children of both datasets appear in the same directory, but might have different inherited characteristics.
653
.sp
654
When the \fBnoauto\fR option is set, a dataset can only be mounted and unmounted explicitly. The dataset is not mounted automatically when the dataset is created or imported, nor is it mounted by the \fBzfs mount -a\fR command or unmounted by the \fBzfs unmount -a\fR command.
655
.sp
656
This property is not inherited.
657
.RE
658
659
.sp
660
.ne 2
661
.mk
662
.na
663
\fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | \fBsha256\fR\fR
664
.ad
665
.sp .6
666
.RS 4n
667
Controls the checksum used to verify data integrity. The default value is \fBon\fR, which automatically selects an appropriate algorithm (currently, \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR disables integrity checking on user data. Disabling checksums is \fBNOT\fR a recommended practice.
668
.sp
669
Changing this property affects only newly-written data.
670
.RE
671
672
.sp
673
.ne 2
674
.mk
675
.na
676
\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR | \fBzle\fR\fR
677
.ad
678
.sp .6
679
.RS 4n
680
Controls the compression algorithm used for this dataset. The \fBlzjb\fR compression algorithm is optimized for performance while providing decent data compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression algorithm. The \fBgzip\fR compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR (which is also the default for \fBgzip\fR(1)).
681
.sp
682
This property can also be referred to by its shortened column name \fBcompress\fR. Changing this property affects only newly-written data.
683
.RE
684
685
.sp
686
.ne 2
687
.mk
688
.na
689
\fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
690
.ad
691
.sp .6
692
.RS 4n
693
Controls the number of copies of data stored for this dataset. These copies are in addition to any redundancy provided by the pool, for example, mirroring or RAID-Z. The copies are stored on different disks, if possible. The space used by multiple copies is charged to the associated file and dataset, changing the \fBused\fR property and counting against quotas and reservations.
694
.sp
695
Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the \fB-o\fR \fBcopies=\fR\fIN\fR option.
696
.RE
697
698
.sp
699
.ne 2
700
.mk
701
.na
702
\fB\fBdedup\fR=\fBon\fR | \fBoff\fR | \fBverify\fR | \fBsha256\fR[,\fBverify\fR]\fR
703
.ad
704
.sp .6
705
.RS 4n
706
Controls whether deduplication is in effect for a dataset. The default value is \fBoff\fR. The default checksum used for deduplication is \fBsha256\fR (subject to change). When \fBdedup\fR is enabled, the \fBdedup\fR checksum algorithm overrides the \fBchecksum\fR property. Setting the value to \fBverify\fR is equivalent to specifying \fBsha256,verify\fR.
707
.sp
708
If the property is set to \fBverify\fR, then, whenever two blocks have the same signature, ZFS will do a byte-for-byte comparison with the existing block to ensure that the contents are identical.
709
.RE
710
711
.sp
712
.ne 2
713
.mk
714
.na
715
\fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
716
.ad
717
.sp .6
718
.RS 4n
719
Controls whether device nodes can be opened on this file system. The default value is \fBon\fR.
720
.RE
721
722
.sp
723
.ne 2
724
.mk
725
.na
726
\fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
727
.ad
728
.sp .6
729
.RS 4n
730
Controls whether processes can be executed from within this file system. The default value is \fBon\fR.
731
.RE
732
733
.sp
734
.ne 2
735
.mk
736
.na
737
\fB\fBmlslabel\fR=\fIlabel\fR | \fBnone\fR\fR
738
.ad
739
.sp .6
740
.RS 4n
741
The \fBmlslabel\fR property is a sensitivity label that determines if a dataset can be mounted in a zone on a system with Trusted Extensions enabled. If the labeled dataset matches the labeled zone, the dataset can be mounted and accessed from the labeled zone.
742
.sp
743
When the \fBmlslabel\fR property is not set, the default value is \fBnone\fR. Setting the \fBmlslabel\fR property to \fBnone\fR is equivalent to removing the property.
744
.sp
745
The \fBmlslabel\fR property can be modified only when Trusted Extensions is enabled and only with appropriate privilege. Rights to modify it cannot be delegated. When changing a label to a higher label or setting the initial dataset label, the \fB{PRIV_FILE_UPGRADE_SL}\fR privilege is required. When changing a label to a lower label or the default (\fBnone\fR), the \fB{PRIV_FILE_DOWNGRADE_SL}\fR privilege is required. Changing the dataset to labels other than the default can be done only when the dataset is not mounted. When a dataset with the default label is mounted into a labeled-zone, the mount operation automatically sets the \fBmlslabel\fR property to the label of that zone.
746
.sp
747
When Trusted Extensions is \fBnot\fR enabled, only datasets with the default label (\fBnone\fR) can be mounted.
748
.RE
749
750
.sp
751
.ne 2
752
.mk
753
.na
754
\fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
755
.ad
756
.sp .6
757
.RS 4n
758
Controls the mount point used for this file system. See the "Mount Points" section for more information on how this property is used.
759
.sp
760
When the \fBmountpoint\fR property is changed for a file system, the file system and any children that inherit the mount point are unmounted. If the new value is \fBlegacy\fR, then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was previously \fBlegacy\fR or \fBnone\fR, or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location.
761
.RE
762
763
.sp
764
.ne 2
765
.mk
766
.na
767
\fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
768
.ad
769
.sp .6
770
.RS 4n
771
Controls whether the file system should be mounted with \fBnbmand\fR (Non Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this property only take effect when the file system is umounted and remounted. See \fBmount\fR(1M) for more information on \fBnbmand\fR mounts.
772
.RE
773
774
.sp
775
.ne 2
776
.mk
777
.na
778
\fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
779
.ad
780
.sp .6
781
.RS 4n
782
Controls what is cached in the primary cache (ARC). If this property is set to \fBall\fR, then both user data and metadata is cached. If this property is set to \fBnone\fR, then neither user data nor metadata is cached. If this property is set to \fBmetadata\fR, then only metadata is cached. The default value is \fBall\fR.
783
.RE
784
785
.sp
786
.ne 2
787
.mk
788
.na
789
\fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
790
.ad
791
.sp .6
792
.RS 4n
793
Limits the amount of space a dataset and its descendents can consume. This property enforces a hard limit on the amount of space used. This includes all space consumed by descendents, including file systems and snapshots. Setting a quota on a descendent of a dataset that already has a quota does not override the ancestor's quota, but rather imposes an additional limit.
794
.sp
795
Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an implicit quota.
796
.RE
797
798
.sp
799
.ne 2
800
.mk
801
.na
802
\fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
803
.ad
804
.sp .6
805
.RS 4n
806
Limits the amount of space consumed by the specified user. Similar to the \fBrefquota\fR property, the \fBuserquota\fR space calculation does not include space that is used by descendent datasets, such as snapshots and clones. User space consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
807
.sp
808
Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed her quota before the system notices that she is over quota. The system would then begin to refuse additional writes with the \fBEDQUOT\fR error message . See the \fBzfs userspace\fR subcommand for more information.
809
.sp
810
Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs allow\fR, can get and set everyone's quota.
811
.sp
812
This property is not available on volumes, on file systems before version 4, or on pools before version 15. The \fBuserquota@\fR... properties are not displayed by \fBzfs get all\fR. The user's name must be appended after the \fB@\fR symbol, using one of the following forms:
813
.RS +4
814
.TP
815
.ie t \(bu
816
.el o
817
\fIPOSIX name\fR (for example, \fBjoe\fR)
818
.RE
819
.RS +4
820
.TP
821
.ie t \(bu
822
.el o
823
\fIPOSIX numeric ID\fR (for example, \fB789\fR)
824
.RE
825
.RS +4
826
.TP
827
.ie t \(bu
828
.el o
829
\fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
830
.RE
831
.RS +4
832
.TP
833
.ie t \(bu
834
.el o
835
\fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
836
.RE
837
.RE
838
839
.sp
840
.ne 2
841
.mk
842
.na
843
\fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
844
.ad
845
.sp .6
846
.RS 4n
847
Limits the amount of space consumed by the specified group. Group space consumption is identified by the \fBuserquota@\fR\fIuser\fR property.
848
.sp
849
Unprivileged users can access only their own groups' space usage. The root user, or a user who has been granted the \fBgroupquota\fR privilege with \fBzfs allow\fR, can get and set all groups' quotas.
850
.RE
851
852
.sp
853
.ne 2
854
.mk
855
.na
856
\fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
857
.ad
858
.sp .6
859
.RS 4n
860
Controls whether this dataset can be modified. The default value is \fBoff\fR.
861
.sp
862
This property can also be referred to by its shortened column name, \fBrdonly\fR.
863
.RE
864
865
.sp
866
.ne 2
867
.mk
868
.na
869
\fB\fBrecordsize\fR=\fIsize\fR\fR
870
.ad
871
.sp .6
872
.RS 4n
873
Specifies a suggested block size for files in the file system. This property is designed solely for use with database workloads that access files in fixed-size records. \fBZFS\fR automatically tunes block sizes according to internal algorithms optimized for typical access patterns.
874
.sp
875
For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a \fBrecordsize\fR greater than or equal to the record size of the database can result in significant performance gains. Use of this property for general purpose file systems is strongly discouraged, and may adversely affect performance.
876
.sp
877
The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
878
.sp
879
Changing the file system's \fBrecordsize\fR affects only files created afterward; existing files are unaffected.
880
.sp
881
This property can also be referred to by its shortened column name, \fBrecsize\fR.
882
.RE
883
884
.sp
885
.ne 2
886
.mk
887
.na
888
\fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
889
.ad
890
.sp .6
891
.RS 4n
892
Limits the amount of space a dataset can consume. This property enforces a hard limit on the amount of space used. This hard limit does not include space used by descendents, including file systems and snapshots.
893
.RE
894
895
.sp
896
.ne 2
897
.mk
898
.na
899
\fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
900
.ad
901
.sp .6
902
.RS 4n
903
The minimum amount of space guaranteed to a dataset, not including its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
904
.sp
905
If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of "referenced" bytes in the dataset.
906
.sp
907
This property can also be referred to by its shortened column name, \fBrefreserv\fR.
908
.RE
909
910
.sp
911
.ne 2
912
.mk
913
.na
914
\fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
915
.ad
916
.sp .6
917
.RS 4n
918
The minimum amount of space guaranteed to a dataset and its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by its reservation. Reservations are accounted for in the parent datasets' space used, and count against the parent datasets' quotas and reservations.
919
.sp
920
This property can also be referred to by its shortened column name, \fBreserv\fR.
921
.RE
922
923
.sp
924
.ne 2
925
.mk
926
.na
927
\fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
928
.ad
929
.sp .6
930
.RS 4n
931
Controls what is cached in the secondary cache (L2ARC). If this property is set to \fBall\fR, then both user data and metadata is cached. If this property is set to \fBnone\fR, then neither user data nor metadata is cached. If this property is set to \fBmetadata\fR, then only metadata is cached. The default value is \fBall\fR.
932
.RE
933
934
.sp
935
.ne 2
936
.mk
937
.na
938
\fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
939
.ad
940
.sp .6
941
.RS 4n
942
Controls whether the set-\fBUID\fR bit is respected for the file system. The default value is \fBon\fR.
943
.RE
944
945
.sp
946
.ne 2
947
.mk
948
.na
949
\fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR
950
.ad
951
.sp .6
952
.RS 4n
953
Like the \fBsharenfs\fR property, \fBshareiscsi\fR indicates whether a \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this property are \fBon\fR, \fBoff\fR, and \fBtype=disk\fR. The default value is \fBoff\fR. In the future, other target types might be supported. For example, \fBtape\fR.
954
.sp
955
You might want to set \fBshareiscsi=on\fR for a file system so that all \fBZFS\fR volumes within the file system are shared by default. However, setting this property on a file system has no direct effect.
956
.RE
957
958
.sp
959
.ne 2
960
.mk
961
.na
962
\fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
963
.ad
964
.sp .6
965
.RS 4n
966
Controls whether the file system is shared by using the Solaris \fBCIFS\fR service, and what options are to be used. A file system with the \fBsharesmb\fR property set to \fBoff\fR is managed through traditional tools such as \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options equivalent to the contents of this property.
967
.sp
968
Because \fBSMB\fR shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be illegal in the resource name, are replaced with underscore (\fB_\fR) characters. A pseudo property "name" is also supported that allows you to replace the data set name with a specified name. The specified name is then used to replace the prefix dataset in the case of inheritance. For example, if the dataset \fBdata/home/john\fR is set to \fBname=john\fR, then \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
969
.sp
970
When SMB shares are created, the SMB share name appears as an entry in the \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command to display the share-level ACLs on the entries in this directory.
971
.sp
972
When the \fBsharesmb\fR property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously set to \fBoff\fR, or if they were shared before the property was changed. If the new property is set to \fBoff\fR, the file systems are unshared.
973
.RE
974
975
.sp
976
.ne 2
977
.mk
978
.na
979
\fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
980
.ad
981
.sp .6
982
.RS 4n
983
Controls whether the file system is shared via \fBNFS\fR, and what options are used. A file system with a \fBsharenfs\fR property of \fBoff\fR is managed through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \fBshare\fR(1M) command is invoked with options equivalent to the contents of this property.
984
.sp
985
When the \fBsharenfs\fR property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously \fBoff\fR, or if they were shared before the property was changed. If the new property is \fBoff\fR, the file systems are unshared.
986
.RE
987
988
.sp
989
.ne 2
990
.mk
991
.na
992
\fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR
993
.ad
994
.sp .6
995
.RS 4n
996
Provides a hint to ZFS about handling of synchronous requests in this dataset. If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS uses the pool's log devices (if configured) to handle the requests at low latency. If \fBlogbias\fR is set to \fBthroughput\fR, ZFS does not use the configured pool log devices. Instead, ZFS optimizes synchronous operations for global pool throughput and efficient use of resources.
997
.RE
998
999
.sp
1000
.ne 2
1001
.mk
1002
.na
1003
\fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
1004
.ad
1005
.sp .6
1006
.RS 4n
1007
Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of the file system as discussed in the "Snapshots" section. The default value is \fBhidden\fR.
1008
.RE
1009
1010
.sp
1011
.ne 2
1012
.mk
1013
.na
1014
\fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
1015
.ad
1016
.sp .6
1017
.RS 4n
1018
The on-disk version of this file system, which is independent of the pool version. This property can only be set to later supported versions. See the \fBzfs upgrade\fR command.
1019
.RE
1020
1021
.sp
1022
.ne 2
1023
.mk
1024
.na
1025
\fB\fBvolsize\fR=\fIsize\fR\fR
1026
.ad
1027
.sp .6
1028
.RS 4n
1029
For volumes, specifies the logical size of the volume. By default, creating a volume establishes a reservation of equal size. For storage pools with a version number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
1030
.sp
1031
The reservation is kept equal to the volume's logical size to prevent unexpected behavior for consumers. Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size.
1032
.sp
1033
Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR command, or by changing the reservation after the volume has been created. A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
1034
.RE
1035
1036
.sp
1037
.ne 2
1038
.mk
1039
.na
1040
\fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
1041
.ad
1042
.sp .6
1043
.RS 4n
1044
Controls whether regular files should be scanned for viruses when a file is opened and closed. In addition to enabling this property, the virus scan service must also be enabled for virus scanning to occur. The default value is \fBoff\fR.
1045
.RE
1046
1047
.sp
1048
.ne 2
1049
.mk
1050
.na
1051
\fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR
1052
.ad
1053
.sp .6
1054
.RS 4n
1055
Controls whether extended attributes are enabled for this file system. The default value is \fBon\fR.
1056
.RE
1057
1058
.sp
1059
.ne 2
1060
.mk
1061
.na
1062
\fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
1063
.ad
1064
.sp .6
1065
.RS 4n
1066
Controls whether the dataset is managed from a non-global zone. See the "Zones" section for more information. The default value is \fBoff\fR.
1067
.RE
1068
1069
.sp
1070
.LP
1071
The following three properties cannot be changed after the file system is created, and therefore, should be set when the file system is created. If the properties are not set with the \fBzfs create\fR or \fBzpool create\fR commands, these properties are inherited from the parent dataset. If the parent dataset lacks these properties due to having been created prior to these features being supported, the new file system will have the default values for these properties.
1072
.sp
1073
.ne 2
1074
.mk
1075
.na
1076
\fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
1077
.ad
1078
.sp .6
1079
.RS 4n
1080
Indicates whether the file name matching algorithm used by the file system should be case-sensitive, case-insensitive, or allow a combination of both styles of matching. The default value for the \fBcasesensitivity\fR property is \fBsensitive\fR. Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1081
.sp
1082
The \fBmixed\fR value for the \fBcasesensitivity\fR property indicates that the file system can support requests for both case-sensitive and case-insensitive matching behavior. Currently, case-insensitive matching behavior on a file system that supports mixed behavior is limited to the Solaris CIFS server product. For more information about the \fBmixed\fR value behavior, see the \fISolaris ZFS Administration Guide\fR.
1083
.RE
1084
1085
.sp
1086
.ne 2
1087
.mk
1088
.na
1089
\fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR | \fBformKD\fR\fR
1090
.ad
1091
.sp .6
1092
.RS 4n
1093
Indicates whether the file system should perform a \fBunicode\fR normalization of file names whenever two file names are compared, and which normalization algorithm should be used. File names are always stored unmodified, names are normalized as part of any comparison process. If this property is set to a legal value other than \fBnone\fR, and the \fButf8only\fR property was left unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The default value of the \fBnormalization\fR property is \fBnone\fR. This property cannot be changed after the file system is created.
1094
.RE
1095
1096
.sp
1097
.ne 2
1098
.mk
1099
.na
1100
\fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
1101
.ad
1102
.sp .6
1103
.RS 4n
1104
Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to \fBoff\fR, the normalization property must either not be explicitly set or be set to \fBnone\fR. The default value for the \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the file system is created.
1105
.RE
1106
1107
.sp
1108
.LP
1109
The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
1110
.SS "Temporary Mount Point Properties"
1111
.sp
1112
.LP
1113
When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts or the \fBzfs mount\fR command for normal file systems, its mount options are set according to its properties. The correlation between properties and mount options is as follows:
1114
.sp
1115
.in +2
1116
.nf
1117
PROPERTY MOUNT OPTION
1118
devices devices/nodevices
1119
exec exec/noexec
1120
readonly ro/rw
1121
setuid setuid/nosetuid
1122
xattr xattr/noxattr
1123
.fi
1124
.in -2
1125
.sp
1126
1127
.sp
1128
.LP
1129
In addition, these options can be set on a per-mount basis using the \fB-o\fR option, without affecting the property that is stored on disk. The values specified on the command line override the values stored in the dataset. The \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties are reported as "temporary" by the \fBzfs get\fR command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
1130
.SS "User Properties"
1131
.sp
1132
.LP
1133
In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots).
1134
.sp
1135
.LP
1136
User property names must contain a colon (\fB:\fR) character to distinguish them from native properties. They may contain lowercase letters, numbers, and the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the property name is divided into two portions such as \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot begin with a dash (\fB-\fR).
1137
.sp
1138
.LP
1139
When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. Property names beginning with \fBcom.sun\fR. are reserved for use by Sun Microsystems.
1140
.sp
1141
.LP
1142
The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties (\fBzfs list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate both native properties and user properties. Use the \fBzfs inherit\fR command to clear a user property . If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 1024 characters.
1143
.SS "ZFS Volumes as Swap or Dump Devices"
1144
.sp
1145
.LP
1146
During an initial installation or a live upgrade from a \fBUFS\fR file system, a swap device and dump device are created on \fBZFS\fR volumes in the \fBZFS\fR root pool. By default, the swap area size is based on 1/2 the size of physical memory up to 2 Gbytes. The size of the dump device depends on the kernel's requirements at installation time. Separate \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported.
1147
.sp
1148
.LP
1149
If you need to change your swap area or dump device after the system is installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands. If you need to change the size of your swap area or dump device, see the \fISolaris ZFS Administration Guide\fR.
1150
.SH SUBCOMMANDS
1151
.sp
1152
.LP
1153
All subcommands that modify state are logged persistently to the pool in their original form.
1154
.sp
1155
.ne 2
1156
.mk
1157
.na
1158
\fB\fBzfs ?\fR\fR
1159
.ad
1160
.sp .6
1161
.RS 4n
1162
Displays a help message.
1163
.RE
1164
1165
.sp
1166
.ne 2
1167
.mk
1168
.na
1169
\fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR\fR
1170
.ad
1171
.sp .6
1172
.RS 4n
1173
Creates a new \fBZFS\fR file system. The file system is automatically mounted according to the \fBmountpoint\fR property inherited from the parent.
1174
.sp
1175
.ne 2
1176
.mk
1177
.na
1178
\fB\fB-p\fR\fR
1179
.ad
1180
.sp .6
1181
.RS 4n
1182
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1183
.RE
1184
1185
.sp
1186
.ne 2
1187
.mk
1188
.na
1189
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1190
.ad
1191
.sp .6
1192
.RS 4n
1193
Sets the specified property as if the command \fBzfs set\fR \fIproperty\fR=\fIvalue\fR was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1194
.RE
1195
1196
.RE
1197
1198
.sp
1199
.ne 2
1200
.mk
1201
.na
1202
\fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR\fR
1203
.ad
1204
.sp .6
1205
.RS 4n
1206
Creates a volume of the given size. The volume is exported as a block device in \fB/dev/zvol/{dsk,rdsk}/\fR\fIpath\fR, where \fIpath\fR is the name of the volume in the \fBZFS\fR namespace. The size represents the logical size as exported by the device. By default, a reservation of equal size is created.
1207
.sp
1208
\fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that the volume has an integral number of blocks regardless of \fIblocksize\fR.
1209
.sp
1210
.ne 2
1211
.mk
1212
.na
1213
\fB\fB-p\fR\fR
1214
.ad
1215
.sp .6
1216
.RS 4n
1217
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1218
.RE
1219
1220
.sp
1221
.ne 2
1222
.mk
1223
.na
1224
\fB\fB-s\fR\fR
1225
.ad
1226
.sp .6
1227
.RS 4n
1228
Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native Properties section for more information about sparse volumes.
1229
.RE
1230
1231
.sp
1232
.ne 2
1233
.mk
1234
.na
1235
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1236
.ad
1237
.sp .6
1238
.RS 4n
1239
Sets the specified property as if the \fBzfs set\fR \fIproperty\fR=\fIvalue\fR command was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1240
.RE
1241
1242
.sp
1243
.ne 2
1244
.mk
1245
.na
1246
\fB\fB-b\fR \fIblocksize\fR\fR
1247
.ad
1248
.sp .6
1249
.RS 4n
1250
Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is specified in conjunction with \fB-o\fR \fBvolblocksize\fR, the resulting behavior is undefined.
1251
.RE
1252
1253
.RE
1254
1255
.sp
1256
.ne 2
1257
.mk
1258
.na
1259
\fB\fBzfs destroy\fR [\fB-rRf\fR] \fIfilesystem\fR|\fIvolume\fR\fR
1260
.ad
1261
.sp .6
1262
.RS 4n
1263
Destroys the given dataset. By default, the command unshares any file systems that are currently shared, unmounts any file systems that are currently mounted, and refuses to destroy a dataset that has active dependents (children or clones).
1264
.sp
1265
.ne 2
1266
.mk
1267
.na
1268
\fB\fB-r\fR\fR
1269
.ad
1270
.sp .6
1271
.RS 4n
1272
Recursively destroy all children.
1273
.RE
1274
1275
.sp
1276
.ne 2
1277
.mk
1278
.na
1279
\fB\fB-R\fR\fR
1280
.ad
1281
.sp .6
1282
.RS 4n
1283
Recursively destroy all dependents, including cloned file systems outside the target hierarchy.
1284
.RE
1285
1286
.sp
1287
.ne 2
1288
.mk
1289
.na
1290
\fB\fB-f\fR\fR
1291
.ad
1292
.sp .6
1293
.RS 4n
1294
Force an unmount of any file systems using the \fBunmount -f\fR command. This option has no effect on non-file systems or unmounted file systems.
1295
.RE
1296
1297
Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use.
1298
.RE
1299
1300
.sp
1301
.ne 2
1302
.mk
1303
.na
1304
\fB\fBzfs destroy\fR [\fB-rRd\fR] \fIsnapshot\fR\fR
1305
.ad
1306
.sp .6
1307
.RS 4n
1308
The given snapshot is destroyed immediately if and only if the \fBzfs destroy\fR command without the \fB-d\fR option would have destroyed it. Such immediate destruction would occur, for example, if the snapshot had no clones and the user-initiated reference count were zero.
1309
.sp
1310
If the snapshot does not qualify for immediate destruction, it is marked for deferred deletion. In this state, it exists as a usable, visible snapshot until both of the preconditions listed above are met, at which point it is destroyed.
1311
.sp
1312
.ne 2
1313
.mk
1314
.na
1315
\fB\fB-d\fR\fR
1316
.ad
1317
.sp .6
1318
.RS 4n
1319
Defer snapshot deletion.
1320
.RE
1321
1322
.sp
1323
.ne 2
1324
.mk
1325
.na
1326
\fB\fB-r\fR\fR
1327
.ad
1328
.sp .6
1329
.RS 4n
1330
Destroy (or mark for deferred deletion) all snapshots with this name in descendent file systems.
1331
.RE
1332
1333
.sp
1334
.ne 2
1335
.mk
1336
.na
1337
\fB\fB-R\fR\fR
1338
.ad
1339
.sp .6
1340
.RS 4n
1341
Recursively destroy all dependents.
1342
.RE
1343
1344
.RE
1345
1346
.sp
1347
.ne 2
1348
.mk
1349
.na
1350
\fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
1351
.ad
1352
.sp .6
1353
.RS 4n
1354
Creates a snapshot with the given name. All previous modifications by successful system calls to the file system are part of the snapshot. See the "Snapshots" section for details.
1355
.sp
1356
.ne 2
1357
.mk
1358
.na
1359
\fB\fB-r\fR\fR
1360
.ad
1361
.sp .6
1362
.RS 4n
1363
Recursively create snapshots of all descendent datasets. Snapshots are taken atomically, so that all recursive snapshots correspond to the same moment in time.
1364
.RE
1365
1366
.sp
1367
.ne 2
1368
.mk
1369
.na
1370
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1371
.ad
1372
.sp .6
1373
.RS 4n
1374
Sets the specified property; see \fBzfs create\fR for details.
1375
.RE
1376
1377
.RE
1378
1379
.sp
1380
.ne 2
1381
.mk
1382
.na
1383
\fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR
1384
.ad
1385
.sp .6
1386
.RS 4n
1387
Roll back the given dataset to a previous snapshot. When a dataset is rolled back, all data that has changed since the snapshot is discarded, and the dataset reverts to the state at the time of the snapshot. By default, the command refuses to roll back to a snapshot other than the most recent one. In order to do so, all intermediate snapshots must be destroyed by specifying the \fB-r\fR option.
1388
.sp
1389
The \fB-rR\fR options do not recursively destroy the child snapshots of a recursive snapshot. Only the top-level recursive snapshot is destroyed by either of these options. To completely roll back a recursive snapshot, you must rollback the individual child snapshots.
1390
.sp
1391
.ne 2
1392
.mk
1393
.na
1394
\fB\fB-r\fR\fR
1395
.ad
1396
.sp .6
1397
.RS 4n
1398
Recursively destroy any snapshots more recent than the one specified.
1399
.RE
1400
1401
.sp
1402
.ne 2
1403
.mk
1404
.na
1405
\fB\fB-R\fR\fR
1406
.ad
1407
.sp .6
1408
.RS 4n
1409
Recursively destroy any more recent snapshots, as well as any clones of those snapshots.
1410
.RE
1411
1412
.sp
1413
.ne 2
1414
.mk
1415
.na
1416
\fB\fB-f\fR\fR
1417
.ad
1418
.sp .6
1419
.RS 4n
1420
Used with the \fB-R\fR option to force an unmount of any clone file systems that are to be destroyed.
1421
.RE
1422
1423
.RE
1424
1425
.sp
1426
.ne 2
1427
.mk
1428
.na
1429
\fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
1430
.ad
1431
.sp .6
1432
.RS 4n
1433
Creates a clone of the given snapshot. See the "Clones" section for details. The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is created as the same type as the original.
1434
.sp
1435
.ne 2
1436
.mk
1437
.na
1438
\fB\fB-p\fR\fR
1439
.ad
1440
.sp .6
1441
.RS 4n
1442
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
1443
.RE
1444
1445
.sp
1446
.ne 2
1447
.mk
1448
.na
1449
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1450
.ad
1451
.sp .6
1452
.RS 4n
1453
Sets the specified property; see \fBzfs create\fR for details.
1454
.RE
1455
1456
.RE
1457
1458
.sp
1459
.ne 2
1460
.mk
1461
.na
1462
\fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
1463
.ad
1464
.sp .6
1465
.RS 4n
1466
Promotes a clone file system to no longer be dependent on its "origin" snapshot. This makes it possible to destroy the file system that the clone was created from. The clone parent-child dependency relationship is reversed, so that the origin file system becomes a clone of the specified file system.
1467
.sp
1468
The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the origin file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The \fBrename\fR subcommand can be used to rename any conflicting snapshots.
1469
.RE
1470
1471
.sp
1472
.ne 2
1473
.mk
1474
.na
1475
\fB\fBzfs rename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1476
.ad
1477
.br
1478
.na
1479
\fB\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1480
.ad
1481
.br
1482
.na
1483
\fB\fBzfs rename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR
1484
.ad
1485
.sp .6
1486
.RS 4n
1487
Renames the given dataset. The new target can be located anywhere in the \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be renamed within the parent file system or volume. When renaming a snapshot, the parent file system of the snapshot does not need to be specified as part of the second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point.
1488
.sp
1489
.ne 2
1490
.mk
1491
.na
1492
\fB\fB-p\fR\fR
1493
.ad
1494
.sp .6
1495
.RS 4n
1496
Creates all the nonexistent parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent.
1497
.RE
1498
1499
.RE
1500
1501
.sp
1502
.ne 2
1503
.mk
1504
.na
1505
\fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
1506
.ad
1507
.sp .6
1508
.RS 4n
1509
Recursively rename the snapshots of all descendent datasets. Snapshots are the only dataset that can be renamed recursively.
1510
.RE
1511
1512
.sp
1513
.ne 2
1514
.mk
1515
.na
1516
\fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]] [ \fB-s\fR \fIproperty\fR ] ... [ \fB-S\fR \fIproperty\fR ] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...\fR
1517
.ad
1518
.sp .6
1519
.RS 4n
1520
Lists the property information for the given datasets in tabular form. If specified, you can list property information by the absolute pathname or the relative pathname. By default, all file systems and volumes are displayed. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the default is \fBoff\fR) . The following fields are displayed, \fBname,used,available,referenced,mountpoint\fR.
1521
.sp
1522
.ne 2
1523
.mk
1524
.na
1525
\fB\fB-H\fR\fR
1526
.ad
1527
.sp .6
1528
.RS 4n
1529
Used for scripting mode. Do not print headers and separate fields by a single tab instead of arbitrary white space.
1530
.RE
1531
1532
.sp
1533
.ne 2
1534
.mk
1535
.na
1536
\fB\fB-r\fR\fR
1537
.ad
1538
.sp .6
1539
.RS 4n
1540
Recursively display any children of the dataset on the command line.
1541
.RE
1542
1543
.sp
1544
.ne 2
1545
.mk
1546
.na
1547
\fB\fB-d\fR \fIdepth\fR\fR
1548
.ad
1549
.sp .6
1550
.RS 4n
1551
Recursively display any children of the dataset, limiting the recursion to \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct children.
1552
.RE
1553
1554
.sp
1555
.ne 2
1556
.mk
1557
.na
1558
\fB\fB-o\fR \fIproperty\fR\fR
1559
.ad
1560
.sp .6
1561
.RS 4n
1562
A comma-separated list of properties to display. The property must be:
1563
.RS +4
1564
.TP
1565
.ie t \(bu
1566
.el o
1567
One of the properties described in the "Native Properties" section
1568
.RE
1569
.RS +4
1570
.TP
1571
.ie t \(bu
1572
.el o
1573
A user property
1574
.RE
1575
.RS +4
1576
.TP
1577
.ie t \(bu
1578
.el o
1579
The value \fBname\fR to display the dataset name
1580
.RE
1581
.RS +4
1582
.TP
1583
.ie t \(bu
1584
.el o
1585
The value \fBspace\fR to display space usage properties on file systems and volumes. This is a shortcut for specifying \fB-o name,avail,used,usedsnap,usedds,usedrefreserv,usedchild\fR \fB-t filesystem,volume\fR syntax.
1586
.RE
1587
.RE
1588
1589
.sp
1590
.ne 2
1591
.mk
1592
.na
1593
\fB\fB-s\fR \fIproperty\fR\fR
1594
.ad
1595
.sp .6
1596
.RS 4n
1597
A property for sorting the output by column in ascending order based on the value of the property. The property must be one of the properties described in the "Properties" section, or the special value \fBname\fR to sort by the dataset name. Multiple properties can be specified at one time using multiple \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to right in decreasing order of importance.
1598
.sp
1599
The following is a list of sorting criteria:
1600
.RS +4
1601
.TP
1602
.ie t \(bu
1603
.el o
1604
Numeric types sort in numeric order.
1605
.RE
1606
.RS +4
1607
.TP
1608
.ie t \(bu
1609
.el o
1610
String types sort in alphabetical order.
1611
.RE
1612
.RS +4
1613
.TP
1614
.ie t \(bu
1615
.el o
1616
Types inappropriate for a row sort that row to the literal bottom, regardless of the specified ordering.
1617
.RE
1618
.RS +4
1619
.TP
1620
.ie t \(bu
1621
.el o
1622
If no sorting options are specified the existing behavior of \fBzfs list\fR is preserved.
1623
.RE
1624
.RE
1625
1626
.sp
1627
.ne 2
1628
.mk
1629
.na
1630
\fB\fB-S\fR \fIproperty\fR\fR
1631
.ad
1632
.sp .6
1633
.RS 4n
1634
Same as the \fB-s\fR option, but sorts by property in descending order.
1635
.RE
1636
1637
.sp
1638
.ne 2
1639
.mk
1640
.na
1641
\fB\fB-t\fR \fItype\fR\fR
1642
.ad
1643
.sp .6
1644
.RS 4n
1645
A comma-separated list of types to display, where \fItype\fR is one of \fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, or \fBall\fR. For example, specifying \fB-t snapshot\fR displays only snapshots.
1646
.RE
1647
1648
.RE
1649
1650
.sp
1651
.ne 2
1652
.mk
1653
.na
1654
\fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1655
.ad
1656
.sp .6
1657
.RS 4n
1658
Sets the property to the given value for each dataset. Only some properties can be edited. See the "Properties" section for more information on what properties can be set and acceptable values. Numeric values can be specified as exact values, or in a human-readable form with a suffix of \fBB\fR, \fBK\fR, \fBM\fR, \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, \fBZ\fR (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). User properties can be set on snapshots. For more information, see the "User Properties" section.
1659
.RE
1660
1661
.sp
1662
.ne 2
1663
.mk
1664
.na
1665
\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fBall\fR | \fIfield\fR[,...] [\fB-s\fR \fIsource\fR[,...]] \fBall\fR | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1666
.ad
1667
.sp .6
1668
.RS 4n
1669
Displays properties for the given datasets. If no datasets are specified, then the command displays properties for all datasets on the system. For each property, the following columns are displayed:
1670
.sp
1671
.in +2
1672
.nf
1673
name Dataset name
1674
property Property name
1675
value Property value
1676
source Property source. Can either be local, default,
1677
temporary, inherited, or none (-).
1678
.fi
1679
.in -2
1680
.sp
1681
1682
All columns except the \fBRECEIVED\fR column are displayed by default; specify particular or all columns, using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1683
.sp
1684
The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume, or snapshot).
1685
.sp
1686
.ne 2
1687
.mk
1688
.na
1689
\fB\fB-r\fR\fR
1690
.ad
1691
.sp .6
1692
.RS 4n
1693
Recursively display properties for any children.
1694
.RE
1695
1696
.sp
1697
.ne 2
1698
.mk
1699
.na
1700
\fB\fB-d\fR \fIdepth\fR\fR
1701
.ad
1702
.sp .6
1703
.RS 4n
1704
Recursively display any children of the dataset, limiting the recursion to \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct children.
1705
.RE
1706
1707
.sp
1708
.ne 2
1709
.mk
1710
.na
1711
\fB\fB-H\fR\fR
1712
.ad
1713
.sp .6
1714
.RS 4n
1715
Display output in a form more easily parsed by scripts. Any headers are omitted, and fields are explicitly separated by a single tab instead of an arbitrary amount of space.
1716
.RE
1717
1718
.sp
1719
.ne 2
1720
.mk
1721
.na
1722
\fB\fB-o\fR \fIfield\fR\fR
1723
.ad
1724
.sp .6
1725
.RS 4n
1726
Set of fields to display. One or more of:
1727
.sp
1728
.in +2
1729
.nf
1730
name,property,value,received,source
1731
.fi
1732
.in -2
1733
.sp
1734
1735
Present multiple fields as a comma-separated list. The default value is:
1736
.sp
1737
.in +2
1738
.nf
1739
name,property,value,source
1740
.fi
1741
.in -2
1742
.sp
1743
1744
The keyword \fBall\fR specifies all sources.
1745
.RE
1746
1747
.sp
1748
.ne 2
1749
.mk
1750
.na
1751
\fB\fB-s\fR \fIsource\fR\fR
1752
.ad
1753
.sp .6
1754
.RS 4n
1755
A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following:
1756
.sp
1757
.in +2
1758
.nf
1759
local,default,inherited,temporary,received,none
1760
.fi
1761
.in -2
1762
.sp
1763
1764
The default value is all sources.
1765
.RE
1766
1767
.sp
1768
.ne 2
1769
.mk
1770
.na
1771
\fB\fB-p\fR\fR
1772
.ad
1773
.sp .6
1774
.RS 4n
1775
Display numbers in parseable (exact) values.
1776
.RE
1777
1778
.RE
1779
1780
.sp
1781
.ne 2
1782
.mk
1783
.na
1784
\fB\fBzfs inherit\fR [\fB-rS\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1785
.ad
1786
.sp .6
1787
.RS 4n
1788
Clears the specified property, causing it to be inherited from an ancestor. If no ancestor has the property set, then the default value is used. See the "Properties" section for a listing of default values, and details on which properties can be inherited.
1789
.sp
1790
.ne 2
1791
.mk
1792
.na
1793
\fB\fB-r\fR\fR
1794
.ad
1795
.sp .6
1796
.RS 4n
1797
Recursively inherit the given property for all children.
1798
.RE
1799
1800
.sp
1801
.ne 2
1802
.mk
1803
.na
1804
\fB\fB-S\fR\fR
1805
.ad
1806
.sp .6
1807
.RS 4n
1808
Revert to the received property value, if any. If the property does not have a received value, the behavior of \fBzfs inherit\fR \fB-S\fR is the same as \fBzfs inherit\fR without \fB-S\fR. If the property does have a received value, \fBzfs inherit\fR masks the received value with the inherited value until \fBzfs inherit\fR \fB-S\fR reverts to the received value.
1809
.RE
1810
1811
.RE
1812
1813
.sp
1814
.ne 2
1815
.mk
1816
.na
1817
\fB\fBzfs upgrade\fR [\fB-v\fR]\fR
1818
.ad
1819
.sp .6
1820
.RS 4n
1821
Displays a list of file systems that are not the most recent version.
1822
.RE
1823
1824
.sp
1825
.ne 2
1826
.mk
1827
.na
1828
\fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR
1829
.ad
1830
.sp .6
1831
.RS 4n
1832
Upgrades file systems to a new on-disk version. Once this is done, the file systems will no longer be accessible on systems running older versions of the software. \fBzfs send\fR streams generated from new snapshots of these file systems cannot be accessed on systems running older versions of the software.
1833
.sp
1834
In general, the file system version is independent of the pool version. See \fBzpool\fR(1M) for information on the \fBzpool upgrade\fR command.
1835
.sp
1836
In some cases, the file system version and the pool version are interrelated and the pool version must be upgraded before the file system version can be upgraded.
1837
.sp
1838
.ne 2
1839
.mk
1840
.na
1841
\fB\fB-a\fR\fR
1842
.ad
1843
.sp .6
1844
.RS 4n
1845
Upgrade all file systems on all imported pools.
1846
.RE
1847
1848
.sp
1849
.ne 2
1850
.mk
1851
.na
1852
\fB\fIfilesystem\fR\fR
1853
.ad
1854
.sp .6
1855
.RS 4n
1856
Upgrade the specified file system.
1857
.RE
1858
1859
.sp
1860
.ne 2
1861
.mk
1862
.na
1863
\fB\fB-r\fR\fR
1864
.ad
1865
.sp .6
1866
.RS 4n
1867
Upgrade the specified file system and all descendent file systems
1868
.RE
1869
1870
.sp
1871
.ne 2
1872
.mk
1873
.na
1874
\fB\fB-V\fR \fIversion\fR\fR
1875
.ad
1876
.sp .6
1877
.RS 4n
1878
Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
1879
.RE
1880
1881
.RE
1882
1883
.sp
1884
.ne 2
1885
.mk
1886
.na
1887
\fB\fBzfs userspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | \fIsnapshot\fR\fR
1888
.ad
1889
.sp .6
1890
.RS 4n
1891
Displays space consumed by, and quotas on, each user in the specified filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and \fBuserquota@\fR\fIuser\fR properties.
1892
.sp
1893
.ne 2
1894
.mk
1895
.na
1896
\fB\fB-n\fR\fR
1897
.ad
1898
.sp .6
1899
.RS 4n
1900
Print numeric ID instead of user/group name.
1901
.RE
1902
1903
.sp
1904
.ne 2
1905
.mk
1906
.na
1907
\fB\fB-H\fR\fR
1908
.ad
1909
.sp .6
1910
.RS 4n
1911
Do not print headers, use tab-delimited output.
1912
.RE
1913
1914
.sp
1915
.ne 2
1916
.mk
1917
.na
1918
\fB\fB-p\fR\fR
1919
.ad
1920
.sp .6
1921
.RS 4n
1922
Use exact (parseable) numeric output.
1923
.RE
1924
1925
.sp
1926
.ne 2
1927
.mk
1928
.na
1929
\fB\fB-o\fR \fIfield\fR[,...]\fR
1930
.ad
1931
.sp .6
1932
.RS 4n
1933
Display only the specified fields from the following set, \fBtype,name,used,quota\fR.The default is to display all fields.
1934
.RE
1935
1936
.sp
1937
.ne 2
1938
.mk
1939
.na
1940
\fB\fB-s\fR \fIfield\fR\fR
1941
.ad
1942
.sp .6
1943
.RS 4n
1944
Sort output by this field. The \fIs\fR and \fIS\fR flags may be specified multiple times to sort first by one field, then by another. The default is \fB-s type\fR \fB-s name\fR.
1945
.RE
1946
1947
.sp
1948
.ne 2
1949
.mk
1950
.na
1951
\fB\fB-S\fR \fIfield\fR\fR
1952
.ad
1953
.sp .6
1954
.RS 4n
1955
Sort by this field in reverse order. See \fB-s\fR.
1956
.RE
1957
1958
.sp
1959
.ne 2
1960
.mk
1961
.na
1962
\fB\fB-t\fR \fItype\fR[,...]\fR
1963
.ad
1964
.sp .6
1965
.RS 4n
1966
Print only the specified types from the following set, \fBall,posixuser,smbuser,posixgroup,smbgroup\fR.
1967
.sp
1968
The default is \fB-t posixuser,smbuser\fR
1969
.sp
1970
The default can be changed to include group types.
1971
.RE
1972
1973
.sp
1974
.ne 2
1975
.mk
1976
.na
1977
\fB\fB-i\fR\fR
1978
.ad
1979
.sp .6
1980
.RS 4n
1981
Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists. Normal POSIX interfaces (for example, \fBstat\fR(2), \fBls\fR \fB-l\fR) perform this translation, so the \fB-i\fR option allows the output from \fBzfs userspace\fR to be compared directly with those utilities. However, \fB-i\fR may lead to confusion if some files were created by an SMB user before a SMB-to-POSIX name mapping was established. In such a case, some files are owned by the SMB entity and some by the POSIX entity. However, the \fB-i\fR option will report that the POSIX entity has the total usage and quota for both.
1982
.RE
1983
1984
.RE
1985
1986
.sp
1987
.ne 2
1988
.mk
1989
.na
1990
\fB\fBzfs groupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | \fIsnapshot\fR\fR
1991
.ad
1992
.sp .6
1993
.RS 4n
1994
Displays space consumed by, and quotas on, each group in the specified filesystem or snapshot. This subcommand is identical to \fBzfs userspace\fR, except that the default types to display are \fB-t posixgroup,smbgroup\fR.
1995
.sp
1996
.in +2
1997
.nf
1998
-
1999
.fi
2000
.in -2
2001
.sp
2002
2003
.RE
2004
2005
.sp
2006
.ne 2
2007
.mk
2008
.na
2009
\fB\fBzfs mount\fR\fR
2010
.ad
2011
.sp .6
2012
.RS 4n
2013
Displays all \fBZFS\fR file systems currently mounted.
2014
.RE
2015
2016
.sp
2017
.ne 2
2018
.mk
2019
.na
2020
\fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR | \fIfilesystem\fR\fR
2021
.ad
2022
.sp .6
2023
.RS 4n
2024
Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2025
.sp
2026
.ne 2
2027
.mk
2028
.na
2029
\fB\fB-o\fR \fIoptions\fR\fR
2030
.ad
2031
.sp .6
2032
.RS 4n
2033
An optional, comma-separated list of mount options to use temporarily for the duration of the mount. See the "Temporary Mount Point Properties" section for details.
2034
.RE
2035
2036
.sp
2037
.ne 2
2038
.mk
2039
.na
2040
\fB\fB-O\fR\fR
2041
.ad
2042
.sp .6
2043
.RS 4n
2044
Perform an overlay mount. See \fBmount\fR(1M) for more information.
2045
.RE
2046
2047
.sp
2048
.ne 2
2049
.mk
2050
.na
2051
\fB\fB-v\fR\fR
2052
.ad
2053
.sp .6
2054
.RS 4n
2055
Report mount progress.
2056
.RE
2057
2058
.sp
2059
.ne 2
2060
.mk
2061
.na
2062
\fB\fB-a\fR\fR
2063
.ad
2064
.sp .6
2065
.RS 4n
2066
Mount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2067
.RE
2068
2069
.sp
2070
.ne 2
2071
.mk
2072
.na
2073
\fB\fIfilesystem\fR\fR
2074
.ad
2075
.sp .6
2076
.RS 4n
2077
Mount the specified filesystem.
2078
.RE
2079
2080
.RE
2081
2082
.sp
2083
.ne 2
2084
.mk
2085
.na
2086
\fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2087
.ad
2088
.sp .6
2089
.RS 4n
2090
Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as part of the shutdown process.
2091
.sp
2092
.ne 2
2093
.mk
2094
.na
2095
\fB\fB-f\fR\fR
2096
.ad
2097
.sp .6
2098
.RS 4n
2099
Forcefully unmount the file system, even if it is currently in use.
2100
.RE
2101
2102
.sp
2103
.ne 2
2104
.mk
2105
.na
2106
\fB\fB-a\fR\fR
2107
.ad
2108
.sp .6
2109
.RS 4n
2110
Unmount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2111
.RE
2112
2113
.sp
2114
.ne 2
2115
.mk
2116
.na
2117
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
2118
.ad
2119
.sp .6
2120
.RS 4n
2121
Unmount the specified filesystem. The command can also be given a path to a \fBZFS\fR file system mount point on the system.
2122
.RE
2123
2124
.RE
2125
2126
.sp
2127
.ne 2
2128
.mk
2129
.na
2130
\fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR
2131
.ad
2132
.sp .6
2133
.RS 4n
2134
Shares available \fBZFS\fR file systems.
2135
.sp
2136
.ne 2
2137
.mk
2138
.na
2139
\fB\fB-a\fR\fR
2140
.ad
2141
.sp .6
2142
.RS 4n
2143
Share all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2144
.RE
2145
2146
.sp
2147
.ne 2
2148
.mk
2149
.na
2150
\fB\fIfilesystem\fR\fR
2151
.ad
2152
.sp .6
2153
.RS 4n
2154
Share the specified filesystem according to the \fBsharenfs\fR and \fBsharesmb\fR properties. File systems are shared when the \fBsharenfs\fR or \fBsharesmb\fR property is set.
2155
.RE
2156
2157
.RE
2158
2159
.sp
2160
.ne 2
2161
.mk
2162
.na
2163
\fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2164
.ad
2165
.sp .6
2166
.RS 4n
2167
Unshares currently shared \fBZFS\fR file systems. This is invoked automatically as part of the shutdown process.
2168
.sp
2169
.ne 2
2170
.mk
2171
.na
2172
\fB\fB-a\fR\fR
2173
.ad
2174
.sp .6
2175
.RS 4n
2176
Unshare all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2177
.RE
2178
2179
.sp
2180
.ne 2
2181
.mk
2182
.na
2183
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
2184
.ad
2185
.sp .6
2186
.RS 4n
2187
Unshare the specified filesystem. The command can also be given a path to a \fBZFS\fR file system shared on the system.
2188
.RE
2189
2190
.RE
2191
2192
.sp
2193
.ne 2
2194
.mk
2195
.na
2196
\fB\fBzfs send\fR [\fB-DvRp\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
2197
.ad
2198
.sp .6
2199
.RS 4n
2200
Creates a stream representation of the second \fIsnapshot\fR, which is written to standard output. The output can be redirected to a file or to a different system (for example, using \fBssh\fR(1). By default, a full stream is generated.
2201
.sp
2202
.ne 2
2203
.mk
2204
.na
2205
\fB\fB-D\fR\fR
2206
.ad
2207
.sp .6
2208
.RS 4n
2209
Perform \fBdedup\fR processing on the stream. Deduplicated streams cannot be received on systems that do not support the stream deduplication feature.
2210
.RE
2211
2212
.sp
2213
.ne 2
2214
.mk
2215
.na
2216
\fB\fB-i\fR \fIsnapshot\fR\fR
2217
.ad
2218
.sp .6
2219
.RS 4n
2220
Generate an incremental stream from the first \fIsnapshot\fR to the second \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be specified as the last component of the snapshot name (for example, the part after the \fB@\fR), and it is assumed to be from the same file system as the second \fIsnapshot\fR.
2221
.sp
2222
If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, \fBpool/fs@origin\fR, not just \fB@origin\fR).
2223
.RE
2224
2225
.sp
2226
.ne 2
2227
.mk
2228
.na
2229
\fB\fB-I\fR \fIsnapshot\fR\fR
2230
.ad
2231
.sp .6
2232
.RS 4n
2233
Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may be specified as with the \fB-i\fR option.
2234
.RE
2235
2236
.sp
2237
.ne 2
2238
.mk
2239
.na
2240
\fB\fB-R\fR\fR
2241
.ad
2242
.sp .6
2243
.RS 4n
2244
Generate a replication stream package, which will replicate the specified filesystem, and all descendent file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved.
2245
.sp
2246
If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR flag, an incremental replication stream is generated. The current values of properties, and current snapshot and file system names are set when the stream is received. If the \fB-F\fR flag is specified when this stream is received, snapshots and file systems that do not exist on the sending side are destroyed.
2247
.RE
2248
2249
.sp
2250
.ne 2
2251
.mk
2252
.na
2253
\fB\fB-p\fR\fR
2254
.ad
2255
.sp .6
2256
.RS 4n
2257
Send properties.
2258
.RE
2259
2260
.sp
2261
.ne 2
2262
.mk
2263
.na
2264
\fB\fB-v\fR\fR
2265
.ad
2266
.sp .6
2267
.RS 4n
2268
Print verbose information about the stream package generated.
2269
.RE
2270
2271
The format of the stream is committed. You will be able to receive your streams on future versions of \fBZFS\fR.
2272
.RE
2273
2274
.sp
2275
.ne 2
2276
.mk
2277
.na
2278
\fB\fBzfs receive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2279
.ad
2280
.br
2281
.na
2282
\fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR | \fB-e\fR] \fIfilesystem\fR\fR
2283
.ad
2284
.sp .6
2285
.RS 4n
2286
Creates a snapshot whose contents are as specified in the stream provided on standard input. If a full stream is received, then a new file system is created as well. Streams are created using the \fBzfs send\fR subcommand, which by default creates a full stream. \fBzfs recv\fR can be used as an alias for \fBzfs receive\fR.
2287
.sp
2288
If an incremental stream is received, then the destination file system must already exist, and its most recent snapshot must match the incremental stream's source. For \fBzvols\fR, the destination device link is destroyed and recreated, which means the \fBzvol\fR cannot be accessed during the \fBreceive\fR operation.
2289
.sp
2290
When a snapshot replication package stream that is generated by using the \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR command.
2291
.sp
2292
The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR or \fB-e\fR option.
2293
.sp
2294
If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or \fIvolume\fR. If the \fB-d\fR or \fB-e\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified filesystem. If the \fB-d\fR option is specified, all but the pool name of the sent snapshot path is appended (for example, \fBb/c@1\fR appended from sent snapshot \fBa/b/c@1\fR), and if the \fB-e\fR option is specified, only the tail of the sent snapshot path is appended (for example, \fBc@1\fR appended from sent snapshot \fBa/b/c@1\fR). In the case of \fB-d\fR, any file systems needed to replicate the path of the sent snapshot are created within the specified file system.
2295
.sp
2296
.ne 2
2297
.mk
2298
.na
2299
\fB\fB-d\fR\fR
2300
.ad
2301
.sp .6
2302
.RS 4n
2303
Use all but the first element of the sent snapshot path (all but the pool name) to determine the name of the new snapshot as described in the paragraph above.
2304
.RE
2305
2306
.sp
2307
.ne 2
2308
.mk
2309
.na
2310
\fB\fB-e\fR\fR
2311
.ad
2312
.sp .6
2313
.RS 4n
2314
Use the last element of the sent snapshot path to determine the name of the new snapshot as described in the paragraph above.
2315
.RE
2316
2317
.sp
2318
.ne 2
2319
.mk
2320
.na
2321
\fB\fB-u\fR\fR
2322
.ad
2323
.sp .6
2324
.RS 4n
2325
File system that is associated with the received stream is not mounted.
2326
.RE
2327
2328
.sp
2329
.ne 2
2330
.mk
2331
.na
2332
\fB\fB-v\fR\fR
2333
.ad
2334
.sp .6
2335
.RS 4n
2336
Print verbose information about the stream and the time required to perform the receive operation.
2337
.RE
2338
2339
.sp
2340
.ne 2
2341
.mk
2342
.na
2343
\fB\fB-n\fR\fR
2344
.ad
2345
.sp .6
2346
.RS 4n
2347
Do not actually receive the stream. This can be useful in conjunction with the \fB-v\fR option to verify the name the receive operation would use.
2348
.RE
2349
2350
.sp
2351
.ne 2
2352
.mk
2353
.na
2354
\fB\fB-F\fR\fR
2355
.ad
2356
.sp .6
2357
.RS 4n
2358
Force a rollback of the file system to the most recent snapshot before performing the receive operation. If receiving an incremental replication stream (for example, one generated by \fBzfs send -R -[iI]\fR), destroy snapshots and file systems that do not exist on the sending side.
2359
.RE
2360
2361
.RE
2362
2363
.sp
2364
.ne 2
2365
.mk
2366
.na
2367
\fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
2368
.ad
2369
.sp .6
2370
.RS 4n
2371
Displays permissions that have been delegated on the specified filesystem or volume. See the other forms of \fBzfs allow\fR for more information.
2372
.RE
2373
2374
.sp
2375
.ne 2
2376
.mk
2377
.na
2378
\fB\fBzfs allow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR| \fIvolume\fR\fR
2379
.ad
2380
.br
2381
.na
2382
\fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR | \fIvolume\fR\fR
2383
.ad
2384
.sp .6
2385
.RS 4n
2386
Delegates \fBZFS\fR administration permission for the file systems to non-privileged users.
2387
.sp
2388
.ne 2
2389
.mk
2390
.na
2391
\fB[\fB-ug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...]\fR
2392
.ad
2393
.sp .6
2394
.RS 4n
2395
Specifies to whom the permissions are delegated. Multiple entities can be specified as a comma-separated list. If neither of the \fB-ug\fR options are specified, then the argument is interpreted preferentially as the keyword "everyone", then as a user name, and lastly as a group name. To specify a user or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a group with the same name as a user, use the \fB-g\fR options.
2396
.RE
2397
2398
.sp
2399
.ne 2
2400
.mk
2401
.na
2402
\fB[\fB-e\fR] \fIperm\fR|@\fIsetname\fR[,...]\fR
2403
.ad
2404
.sp .6
2405
.RS 4n
2406
Specifies that the permissions be delegated to "everyone." Multiple permissions may be specified as a comma-separated list. Permission names are the same as \fBZFS\fR subcommand and property names. See the property list below. Property set names, which begin with an at sign (\fB@\fR) , may be specified. See the \fB-s\fR form below for details.
2407
.RE
2408
2409
.sp
2410
.ne 2
2411
.mk
2412
.na
2413
\fB[\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR\fR
2414
.ad
2415
.sp .6
2416
.RS 4n
2417
Specifies where the permissions are delegated. If neither of the \fB-ld\fR options are specified, or both are, then the permissions are allowed for the file system or volume, and all of its descendents. If only the \fB-l\fR option is used, then is allowed "locally" only for the specified file system. If only the \fB-d\fR option is used, then is allowed only for the descendent file systems.
2418
.RE
2419
2420
.RE
2421
2422
.sp
2423
.LP
2424
Permissions are generally the ability to use a \fBZFS\fR subcommand or change a \fBZFS\fR property. The following permissions are available:
2425
.sp
2426
.in +2
2427
.nf
2428
NAME TYPE NOTES
2429
allow subcommand Must also have the permission that is
2430
being allowed
2431
clone subcommand Must also have the 'create' ability and
2432
'mount'
2433
ability in the origin file system
2434
create subcommand Must also have the 'mount' ability
2435
destroy subcommand Must also have the 'mount' ability
2436
hold subcommand Allows adding a user hold to a snapshot
2437
mount subcommand Allows mount/umount of ZFS datasets
2438
promote subcommand Must also have the 'mount' and 'promote'
2439
ability in the origin file system
2440
receive subcommand Must also have the 'mount' and 'create'
2441
ability
2442
release subcommand Allows releasing a user hold which
2443
might destroy the snapshot
2444
rename subcommand Must also have the 'mount' and 'create'
2445
ability in the new parent
2446
rollback subcommand
2447
send subcommand
2448
share subcommand Allows sharing file systems over NFS or
2449
SMB protocols
2450
snapshot subcommand
2451
groupquota other Allows accessing any groupquota@...
2452
property
2453
groupused other Allows reading any groupused@... property
2454
userprop other Allows changing any user property
2455
userquota other Allows accessing any userquota@...
2456
property
2457
userused other Allows reading any userused@... property
2458
aclinherit property
2459
aclmode property
2460
atime property
2461
canmount property
2462
casesensitivity property
2463
checksum property
2464
compression property
2465
copies property
2466
dedup property
2467
devices property
2468
exec property
2469
logbias property
2470
mlslabel property
2471
mountpoint property
2472
nbmand property
2473
normalization property
2474
primarycache property
2475
quota property
2476
readonly property
2477
recordsize property
2478
refquota property
2479
refreservation property
2480
reservation property
2481
secondarycache property
2482
setuid property
2483
shareiscsi property
2484
sharenfs property
2485
sharesmb property
2486
snapdir property
2487
utf8only property
2488
version property
2489
volblocksize property
2490
volsize property
2491
vscan property
2492
xattr property
2493
zoned property
2494
.fi
2495
.in -2
2496
.sp
2497
2498
.sp
2499
.ne 2
2500
.mk
2501
.na
2502
\fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2503
.ad
2504
.sp .6
2505
.RS 4n
2506
Sets "create time" permissions. These permissions are granted (locally) to the creator of any newly-created descendent file system.
2507
.RE
2508
2509
.sp
2510
.ne 2
2511
.mk
2512
.na
2513
\fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2514
.ad
2515
.sp .6
2516
.RS 4n
2517
Defines or adds permissions to a permission set. The set can be used by other \fBzfs allow\fR commands for the specified file system and its descendents. Sets are evaluated dynamically, so changes to a set are immediately reflected. Permission sets follow the same naming restrictions as ZFS file systems, but the name must begin with an "at sign" (\fB@\fR), and can be no more than 64 characters long.
2518
.RE
2519
2520
.sp
2521
.ne 2
2522
.mk
2523
.na
2524
\fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[, ...]] \fIfilesystem\fR|\fIvolume\fR\fR
2525
.ad
2526
.br
2527
.na
2528
\fB\fBzfs unallow\fR [\fB-rld\fR] \fB-e\fR [\fIperm\fR|@\fIsetname\fR [,...]] \fIfilesystem\fR|\fIvolume\fR\fR
2529
.ad
2530
.br
2531
.na
2532
\fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
2533
.ad
2534
.br
2535
.na
2536
\fB\fIfilesystem\fR|\fIvolume\fR\fR
2537
.ad
2538
.sp .6
2539
.RS 4n
2540
Removes permissions that were granted with the \fBzfs allow\fR command. No permissions are explicitly denied, so other permissions granted are still in effect. For example, if the permission is granted by an ancestor. If no permissions are specified, then all permissions for the specified \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone", not all permissions for every user and group. See the \fBzfs allow\fR command for a description of the \fB-ldugec\fR options.
2541
.sp
2542
.ne 2
2543
.mk
2544
.na
2545
\fB\fB-r\fR\fR
2546
.ad
2547
.sp .6
2548
.RS 4n
2549
Recursively remove the permissions from this file system and all descendents.
2550
.RE
2551
2552
.RE
2553
2554
.sp
2555
.ne 2
2556
.mk
2557
.na
2558
\fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
2559
.ad
2560
.br
2561
.na
2562
\fB\fIfilesystem\fR|\fIvolume\fR\fR
2563
.ad
2564
.sp .6
2565
.RS 4n
2566
Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely.
2567
.RE
2568
2569
.sp
2570
.ne 2
2571
.mk
2572
.na
2573
\fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
2574
.ad
2575
.sp .6
2576
.RS 4n
2577
Adds a single reference, named with the \fItag\fR argument, to the specified snapshot or snapshots. Each snapshot has its own tag namespace, and tags must be unique within that space.
2578
.sp
2579
If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR.
2580
.sp
2581
.ne 2
2582
.mk
2583
.na
2584
\fB\fB-r\fR\fR
2585
.ad
2586
.sp .6
2587
.RS 4n
2588
Specifies that a hold with the given tag is applied recursively to the snapshots of all descendent file systems.
2589
.RE
2590
2591
.RE
2592
2593
.sp
2594
.ne 2
2595
.mk
2596
.na
2597
\fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR
2598
.ad
2599
.sp .6
2600
.RS 4n
2601
Lists all existing user references for the given snapshot or snapshots.
2602
.sp
2603
.ne 2
2604
.mk
2605
.na
2606
\fB\fB-r\fR\fR
2607
.ad
2608
.sp .6
2609
.RS 4n
2610
Lists the holds that are set on the named descendent snapshots, in addition to listing the holds on the named snapshot.
2611
.RE
2612
2613
.RE
2614
2615
.sp
2616
.ne 2
2617
.mk
2618
.na
2619
\fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
2620
.ad
2621
.sp .6
2622
.RS 4n
2623
Removes a single reference, named with the \fItag\fR argument, from the specified snapshot or snapshots. The tag must already exist for each snapshot.
2624
.sp
2625
If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR.
2626
.sp
2627
.ne 2
2628
.mk
2629
.na
2630
\fB\fB-r\fR\fR
2631
.ad
2632
.sp .6
2633
.RS 4n
2634
Recursively releases a hold with the given tag on the snapshots of all descendent file systems.
2635
.RE
2636
2637
.RE
2638
2639
.SH EXAMPLES
2640
.LP
2641
\fBExample 1 \fRCreating a ZFS File System Hierarchy
2642
.sp
2643
.LP
2644
The following commands create a file system named \fBpool/home\fR and a file system named \fBpool/home/bob\fR. The mount point \fB/export/home\fR is set for the parent file system, and is automatically inherited by the child file system.
2645
2646
.sp
2647
.in +2
2648
.nf
2649
# \fBzfs create pool/home\fR
2650
# \fBzfs set mountpoint=/export/home pool/home\fR
2651
# \fBzfs create pool/home/bob\fR
2652
.fi
2653
.in -2
2654
.sp
2655
2656
.LP
2657
\fBExample 2 \fRCreating a ZFS Snapshot
2658
.sp
2659
.LP
2660
The following command creates a snapshot named \fByesterday\fR. This snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the \fBpool/home/bob\fR file system.
2661
2662
.sp
2663
.in +2
2664
.nf
2665
# \fBzfs snapshot pool/home/bob@yesterday\fR
2666
.fi
2667
.in -2
2668
.sp
2669
2670
.LP
2671
\fBExample 3 \fRCreating and Destroying Multiple Snapshots
2672
.sp
2673
.LP
2674
The following command creates snapshots named \fByesterday\fR of \fBpool/home\fR and all of its descendent file systems. Each snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its file system. The second command destroys the newly created snapshots.
2675
2676
.sp
2677
.in +2
2678
.nf
2679
# \fBzfs snapshot -r pool/home@yesterday\fR
2680
# \fBzfs destroy -r pool/home@yesterday\fR
2681
.fi
2682
.in -2
2683
.sp
2684
2685
.LP
2686
\fBExample 4 \fRDisabling and Enabling File System Compression
2687
.sp
2688
.LP
2689
The following command disables the \fBcompression\fR property for all file systems under \fBpool/home\fR. The next command explicitly enables \fBcompression\fR for \fBpool/home/anne\fR.
2690
2691
.sp
2692
.in +2
2693
.nf
2694
# \fBzfs set compression=off pool/home\fR
2695
# \fBzfs set compression=on pool/home/anne\fR
2696
.fi
2697
.in -2
2698
.sp
2699
2700
.LP
2701
\fBExample 5 \fRListing ZFS Datasets
2702
.sp
2703
.LP
2704
The following command lists all active file systems and volumes in the system. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR. The default is \fBoff\fR. See \fBzpool\fR(1M) for more information on pool properties.
2705
2706
.sp
2707
.in +2
2708
.nf
2709
# \fBzfs list\fR
2710
NAME USED AVAIL REFER MOUNTPOINT
2711
pool 450K 457G 18K /pool
2712
pool/home 315K 457G 21K /export/home
2713
pool/home/anne 18K 457G 18K /export/home/anne
2714
pool/home/bob 276K 457G 276K /export/home/bob
2715
.fi
2716
.in -2
2717
.sp
2718
2719
.LP
2720
\fBExample 6 \fRSetting a Quota on a ZFS File System
2721
.sp
2722
.LP
2723
The following command sets a quota of 50 Gbytes for \fBpool/home/bob\fR.
2724
2725
.sp
2726
.in +2
2727
.nf
2728
# \fBzfs set quota=50G pool/home/bob\fR
2729
.fi
2730
.in -2
2731
.sp
2732
2733
.LP
2734
\fBExample 7 \fRListing ZFS Properties
2735
.sp
2736
.LP
2737
The following command lists all properties for \fBpool/home/bob\fR.
2738
2739
.sp
2740
.in +2
2741
.nf
2742
# \fBzfs get all pool/home/bob\fR
2743
NAME PROPERTY VALUE SOURCE
2744
pool/home/bob type filesystem -
2745
pool/home/bob creation Mon Nov 9 15:05 2009 -
2746
pool/home/bob used 282M -
2747
pool/home/bob available 134G -
2748
pool/home/bob referenced 282M -
2749
pool/home/bob compressratio 1.00x -
2750
pool/home/bob mounted yes -
2751
pool/home/bob quota none default
2752
pool/home/bob reservation none default
2753
pool/home/bob recordsize 128K default
2754
pool/home/bob mountpoint /pool/home/bob default
2755
pool/home/bob sharenfs off default
2756
pool/home/bob checksum on default
2757
pool/home/bob compression on local
2758
pool/home/bob atime on default
2759
pool/home/bob devices on default
2760
pool/home/bob exec on default
2761
pool/home/bob setuid on default
2762
pool/home/bob readonly off default
2763
pool/home/bob zoned off default
2764
pool/home/bob snapdir hidden default
2765
pool/home/bob aclmode groupmask default
2766
pool/home/bob aclinherit restricted default
2767
pool/home/bob canmount on default
2768
pool/home/bob shareiscsi off default
2769
pool/home/bob xattr on default
2770
pool/home/bob copies 1 default
2771
pool/home/bob version 4 -
2772
pool/home/bob utf8only off -
2773
pool/home/bob normalization none -
2774
pool/home/bob casesensitivity sensitive -
2775
pool/home/bob vscan off default
2776
pool/home/bob nbmand off default
2777
pool/home/bob sharesmb off default
2778
pool/home/bob refquota none default
2779
pool/home/bob refreservation none default
2780
pool/home/bob primarycache all default
2781
pool/home/bob secondarycache all default
2782
pool/home/bob usedbysnapshots 0 -
2783
pool/home/bob usedbydataset 282M -
2784
pool/home/bob usedbychildren 0 -
2785
pool/home/bob usedbyrefreservation 0 -
2786
pool/home/bob logbias latency default
2787
pool/home/bob dedup off default
2788
pool/home/bob mlslabel none default
2789
.fi
2790
.in -2
2791
.sp
2792
2793
.sp
2794
.LP
2795
The following command gets a single property value.
2796
2797
.sp
2798
.in +2
2799
.nf
2800
# \fBzfs get -H -o value compression pool/home/bob\fR
2801
on
2802
.fi
2803
.in -2
2804
.sp
2805
2806
.sp
2807
.LP
2808
The following command lists all properties with local settings for \fBpool/home/bob\fR.
2809
2810
.sp
2811
.in +2
2812
.nf
2813
# \fBzfs get -r -s local -o name,property,value all pool/home/bob\fR
2814
NAME PROPERTY VALUE
2815
pool/home/bob quota 20G
2816
pool/home/bob compression on
2817
.fi
2818
.in -2
2819
.sp
2820
2821
.LP
2822
\fBExample 8 \fRRolling Back a ZFS File System
2823
.sp
2824
.LP
2825
The following command reverts the contents of \fBpool/home/anne\fR to the snapshot named \fByesterday\fR, deleting all intermediate snapshots.
2826
2827
.sp
2828
.in +2
2829
.nf
2830
# \fBzfs rollback -r pool/home/anne@yesterday\fR
2831
.fi
2832
.in -2
2833
.sp
2834
2835
.LP
2836
\fBExample 9 \fRCreating a ZFS Clone
2837
.sp
2838
.LP
2839
The following command creates a writable file system whose initial contents are the same as \fBpool/home/bob@yesterday\fR.
2840
2841
.sp
2842
.in +2
2843
.nf
2844
# \fBzfs clone pool/home/bob@yesterday pool/clone\fR
2845
.fi
2846
.in -2
2847
.sp
2848
2849
.LP
2850
\fBExample 10 \fRPromoting a ZFS Clone
2851
.sp
2852
.LP
2853
The following commands illustrate how to test out changes to a file system, and then replace the original file system with the changed one, using clones, clone promotion, and renaming:
2854
2855
.sp
2856
.in +2
2857
.nf
2858
# \fBzfs create pool/project/production\fR
2859
populate /pool/project/production with data
2860
# \fBzfs snapshot pool/project/production@today\fR
2861
# \fBzfs clone pool/project/production@today pool/project/beta\fR
2862
make changes to /pool/project/beta and test them
2863
# \fBzfs promote pool/project/beta\fR
2864
# \fBzfs rename pool/project/production pool/project/legacy\fR
2865
# \fBzfs rename pool/project/beta pool/project/production\fR
2866
once the legacy version is no longer needed, it can be destroyed
2867
# \fBzfs destroy pool/project/legacy\fR
2868
.fi
2869
.in -2
2870
.sp
2871
2872
.LP
2873
\fBExample 11 \fRInheriting ZFS Properties
2874
.sp
2875
.LP
2876
The following command causes \fBpool/home/bob\fR and \fBpool/home/anne\fR to inherit the \fBchecksum\fR property from their parent.
2877
2878
.sp
2879
.in +2
2880
.nf
2881
# \fBzfs inherit checksum pool/home/bob pool/home/anne\fR
2882
.fi
2883
.in -2
2884
.sp
2885
2886
.LP
2887
\fBExample 12 \fRRemotely Replicating ZFS Data
2888
.sp
2889
.LP
2890
The following commands send a full stream and then an incremental stream to a remote machine, restoring them into \fBpoolB/received/fs@a\fRand \fBpoolB/received/fs@b\fR, respectively. \fBpoolB\fR must contain the file system \fBpoolB/received\fR, and must not initially contain \fBpoolB/received/fs\fR.
2891
2892
.sp
2893
.in +2
2894
.nf
2895
# \fBzfs send pool/fs@a | \e\fR
2896
\fBssh host zfs receive poolB/received/fs@a\fR
2897
# \fBzfs send -i a pool/fs@b | ssh host \e\fR
2898
\fBzfs receive poolB/received/fs\fR
2899
.fi
2900
.in -2
2901
.sp
2902
2903
.LP
2904
\fBExample 13 \fRUsing the \fBzfs receive\fR \fB-d\fR Option
2905
.sp
2906
.LP
2907
The following command sends a full stream of \fBpoolA/fsA/fsB@snap\fR to a remote machine, receiving it into \fBpoolB/received/fsA/fsB@snap\fR. The \fBfsA/fsB@snap\fR portion of the received snapshot's name is determined from the name of the sent snapshot. \fBpoolB\fR must contain the file system \fBpoolB/received\fR. If \fBpoolB/received/fsA\fR does not exist, it is created as an empty file system.
2908
2909
.sp
2910
.in +2
2911
.nf
2912
# \fBzfs send poolA/fsA/fsB@snap | \e
2913
ssh host zfs receive -d poolB/received\fR
2914
.fi
2915
.in -2
2916
.sp
2917
2918
.LP
2919
\fBExample 14 \fRSetting User Properties
2920
.sp
2921
.LP
2922
The following example sets the user-defined \fBcom.example:department\fR property for a dataset.
2923
2924
.sp
2925
.in +2
2926
.nf
2927
# \fBzfs set com.example:department=12345 tank/accounting\fR
2928
.fi
2929
.in -2
2930
.sp
2931
2932
.LP
2933
\fBExample 15 \fRCreating a ZFS Volume as an iSCSI Target Device
2934
.sp
2935
.LP
2936
The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR target.
2937
2938
.sp
2939
.in +2
2940
.nf
2941
# \fBzfs create -V 2g pool/volumes/vol1\fR
2942
# \fBzfs set shareiscsi=on pool/volumes/vol1\fR
2943
# \fBiscsitadm list target\fR
2944
Target: pool/volumes/vol1
2945
iSCSI Name:
2946
iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
2947
Connections: 0
2948
.fi
2949
.in -2
2950
.sp
2951
2952
.sp
2953
.LP
2954
After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For more information about the Solaris \fBiSCSI\fR initiator, see \fBiscsitadm\fR(1M).
2955
.LP
2956
\fBExample 16 \fRPerforming a Rolling Snapshot
2957
.sp
2958
.LP
2959
The following example shows how to maintain a history of snapshots with a consistent naming scheme. To keep a week's worth of snapshots, the user destroys the oldest snapshot, renames the remaining snapshots, and then creates a new snapshot, as follows:
2960
2961
.sp
2962
.in +2
2963
.nf
2964
# \fBzfs destroy -r pool/users@7daysago\fR
2965
# \fBzfs rename -r pool/users@6daysago @7daysago\fR
2966
# \fBzfs rename -r pool/users@5daysago @6daysago\fR
2967
# \fBzfs rename -r pool/users@yesterday @5daysago\fR
2968
# \fBzfs rename -r pool/users@yesterday @4daysago\fR
2969
# \fBzfs rename -r pool/users@yesterday @3daysago\fR
2970
# \fBzfs rename -r pool/users@yesterday @2daysago\fR
2971
# \fBzfs rename -r pool/users@today @yesterday\fR
2972
# \fBzfs snapshot -r pool/users@today\fR
2973
.fi
2974
.in -2
2975
.sp
2976
2977
.LP
2978
\fBExample 17 \fRSetting \fBsharenfs\fR Property Options on a ZFS File System
2979
.sp
2980
.LP
2981
The following commands show how to set \fBsharenfs\fR property options to enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root access for system \fBneo\fR on the \fBtank/home\fR file system.
2982
2983
.sp
2984
.in +2
2985
.nf
2986
# \fB# zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
2987
.fi
2988
.in -2
2989
.sp
2990
2991
.sp
2992
.LP
2993
If you are using \fBDNS\fR for host name resolution, specify the fully qualified hostname.
2994
2995
.LP
2996
\fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
2997
.sp
2998
.LP
2999
The following example shows how to set permissions so that user \fBcindys\fR can create, destroy, mount, and take snapshots on \fBtank/cindys\fR. The permissions on \fBtank/cindys\fR are also displayed.
3000
3001
.sp
3002
.in +2
3003
.nf
3004
# \fBzfs allow cindys create,destroy,mount,snapshot tank/cindys\fR
3005
# \fBzfs allow tank/cindys\fR
3006
-------------------------------------------------------------
3007
Local+Descendent permissions on (tank/cindys)
3008
user cindys create,destroy,mount,snapshot
3009
-------------------------------------------------------------
3010
.fi
3011
.in -2
3012
.sp
3013
3014
.sp
3015
.LP
3016
Because the \fBtank/cindys\fR mount point permission is set to 755 by default, user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR. Set an \fBACL\fR similar to the following syntax to provide mount point access:
3017
.sp
3018
.in +2
3019
.nf
3020
# \fBchmod A+user:cindys:add_subdirectory:allow /tank/cindys\fR
3021
.fi
3022
.in -2
3023
.sp
3024
3025
.LP
3026
\fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
3027
.sp
3028
.LP
3029
The following example shows how to grant anyone in the group \fBstaff\fR to create file systems in \fBtank/users\fR. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on \fBtank/users\fR are also displayed.
3030
3031
.sp
3032
.in +2
3033
.nf
3034
# \fB# zfs allow staff create,mount tank/users\fR
3035
# \fBzfs allow -c destroy tank/users\fR
3036
# \fBzfs allow tank/users\fR
3037
-------------------------------------------------------------
3038
Create time permissions on (tank/users)
3039
create,destroy
3040
Local+Descendent permissions on (tank/users)
3041
group staff create,mount
3042
-------------------------------------------------------------
3043
.fi
3044
.in -2
3045
.sp
3046
3047
.LP
3048
\fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
3049
.sp
3050
.LP
3051
The following example shows how to define and grant a permission set on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
3052
3053
.sp
3054
.in +2
3055
.nf
3056
# \fBzfs allow -s @pset create,destroy,snapshot,mount tank/users\fR
3057
# \fBzfs allow staff @pset tank/users\fR
3058
# \fBzfs allow tank/users\fR
3059
-------------------------------------------------------------
3060
Permission sets on (tank/users)
3061
@pset create,destroy,mount,snapshot
3062
Create time permissions on (tank/users)
3063
create,destroy
3064
Local+Descendent permissions on (tank/users)
3065
group staff @pset,create,mount
3066
-------------------------------------------------------------
3067
.fi
3068
.in -2
3069
.sp
3070
3071
.LP
3072
\fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
3073
.sp
3074
.LP
3075
The following example shows to grant the ability to set quotas and reservations on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are also displayed.
3076
3077
.sp
3078
.in +2
3079
.nf
3080
# \fBzfs allow cindys quota,reservation users/home\fR
3081
# \fBzfs allow users/home\fR
3082
-------------------------------------------------------------
3083
Local+Descendent permissions on (users/home)
3084
user cindys quota,reservation
3085
-------------------------------------------------------------
3086
cindys% \fBzfs set quota=10G users/home/marks\fR
3087
cindys% \fBzfs get quota users/home/marks\fR
3088
NAME PROPERTY VALUE SOURCE
3089
users/home/marks quota 10G local
3090
.fi
3091
.in -2
3092
.sp
3093
3094
.LP
3095
\fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
3096
.sp
3097
.LP
3098
The following example shows how to remove the snapshot permission from the \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
3099
3100
.sp
3101
.in +2
3102
.nf
3103
# \fBzfs unallow staff snapshot tank/users\fR
3104
# \fBzfs allow tank/users\fR
3105
-------------------------------------------------------------
3106
Permission sets on (tank/users)
3107
@pset create,destroy,mount,snapshot
3108
Create time permissions on (tank/users)
3109
create,destroy
3110
Local+Descendent permissions on (tank/users)
3111
group staff @pset,create,mount
3112
-------------------------------------------------------------
3113
.fi
3114
.in -2
3115
.sp
3116
3117
.SH EXIT STATUS
3118
.sp
3119
.LP
3120
The following exit values are returned:
3121
.sp
3122
.ne 2
3123
.mk
3124
.na
3125
\fB\fB0\fR\fR
3126
.ad
3127
.sp .6
3128
.RS 4n
3129
Successful completion.
3130
.RE
3131
3132
.sp
3133
.ne 2
3134
.mk
3135
.na
3136
\fB\fB1\fR\fR
3137
.ad
3138
.sp .6
3139
.RS 4n
3140
An error occurred.
3141
.RE
3142
3143
.sp
3144
.ne 2
3145
.mk
3146
.na
3147
\fB\fB2\fR\fR
3148
.ad
3149
.sp .6
3150
.RS 4n
3151
Invalid command line options were specified.
3152
.RE
3153
3154
.SH ATTRIBUTES
3155
.sp
3156
.LP
3157
See \fBattributes\fR(5) for descriptions of the following attributes:
3158
.sp
3159
3160
.sp
3161
.TS
3162
tab() box;
3163
cw(2.75i) |cw(2.75i)
3164
lw(2.75i) |lw(2.75i)
3165
.
3166
ATTRIBUTE TYPEATTRIBUTE VALUE
3167
_
3168
AvailabilitySUNWzfsu
3169
_
3170
Interface StabilityCommitted
3171
.TE
3172
3173
.SH SEE ALSO
3174
.sp
3175
.LP
3176
\fBssh\fR(1), \fBiscsitadm\fR(1M), \fBmount\fR(1M), \fBshare\fR(1M), \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M), \fBchmod\fR(2), \fBstat\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C), \fBdfstab\fR(4), \fBattributes\fR(5)
3177
.sp
3178
.LP
3179
See the \fBgzip\fR(1) man page, which is not part of the SunOS man page collection.
3180
.sp
3181
.LP
3182
For information about using the \fBZFS\fR web-based management tool and other \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.
Loggerhead is a web-based interface for Breezy
Version: 2.0.1