Lines Matching +full:a +full:- +full:8
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or https://opensource.org/licenses/CDDL-1.0.
33 .\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
40 .Dt ZFS 8
59 command configures ZFS datasets within a ZFS storage pool, as described in
60 .Xr zpool 8 .
61 A dataset is identified by a unique path within the ZFS namespace:
69 The maximum length of a dataset name is
70 .Sy ZFS_MAX_DATASET_NAME_LEN No - 1
72 .Sy [A-Za-z_.:/ -] .
73 Additionally snapshots are allowed to contain a single
75 character, while bookmarks are allowed to contain a single
80 The maximum amount of nesting allowed in a path is
88 A dataset can be one of the following:
89 .Bl -tag -offset Ds -width "file system"
93 While ZFS file systems are designed to be POSIX-compliant, known issues exist
95 Applications that depend on standards conformance might fail due to non-standard
98 A logical volume exported as a raw or block device.
99 This type of dataset should only be used when a block device is required.
102 A read-only version of a file system or volume at a given point in time.
108 Much like a
110 but without the hold on on-disk data.
111 It can be used as the source of a send (but not for a receive).
123 Properties are divided into two types: native properties and user-defined
127 In addition, native properties are either editable or read-only.
129 datasets in a way that is meaningful in your environment.
142 .Xr zfs-load-key 8 .
147 .Bl -tag -width ""
149 Displays a help message.
152 .Fl V , -version
168 .Bl -tag -width ""
169 .It Xr zfs-list 8
171 .It Xr zfs-create 8
172 Creates a new ZFS file system or volume.
173 .It Xr zfs-destroy 8
175 .It Xr zfs-rename 8
177 .It Xr zfs-upgrade 8
178 Manage upgrading the on-disk version of filesystems.
182 .Bl -tag -width ""
183 .It Xr zfs-snapshot 8
185 .It Xr zfs-rollback 8
186 Roll back the given dataset to a previous snapshot.
187 .It Xr zfs-hold 8 Ns / Ns Xr zfs-release 8
188 Add or remove a hold reference to the specified snapshot or snapshots.
189 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
193 .It Xr zfs-diff 8
194 Display the difference between a snapshot of a given filesystem and another
195 snapshot of that filesystem from a later time or the current contents of the
200 .Bl -tag -width ""
201 .It Xr zfs-clone 8
202 Creates a clone of the given snapshot.
203 .It Xr zfs-promote 8
204 Promotes a clone file system to no longer be dependent on its
210 .Bl -tag -width ""
211 .It Xr zfs-send 8
212 Generate a send stream, which may be of a filesystem, and may be incremental
213 from a bookmark.
214 .It Xr zfs-receive 8
215 Creates a snapshot whose contents are as specified in the stream provided on
217 If a full stream is received, then a new file system is created as well.
219 .Xr zfs-send 8
220 subcommand, which by default creates a full stream.
221 .It Xr zfs-bookmark 8
222 Creates a new bookmark of the given snapshot or bookmark.
224 as the incremental source for a
227 .It Xr zfs-redact 8
228 Generate a new redaction bookmark.
229 This feature can be used to allow clones of a filesystem to be made available on
230 a remote system, in the case where their parent need not (or needs to not) be
235 .Bl -tag -width ""
236 .It Xr zfs-get 8
238 .It Xr zfs-set 8
240 .It Xr zfs-inherit 8
248 .Bl -tag -width ""
249 .It Xr zfs-userspace 8 Ns / Ns Xr zfs-groupspace 8 Ns / Ns Xr zfs-projectspace 8
252 .It Xr zfs-project 8
257 .Bl -tag -width ""
258 .It Xr zfs-mount 8
260 on a path described by its
263 .It Xr zfs-unmount 8
268 .Bl -tag -width ""
269 .It Xr zfs-share 8
271 .It Xr zfs-unshare 8
276 .Bl -tag -width ""
277 .It Xr zfs-allow 8
279 .It Xr zfs-unallow 8
284 .Bl -tag -width ""
285 .It Xr zfs-change-key 8
287 .It Xr zfs-load-key 8
289 .It Xr zfs-unload-key 8
290 Unload a key for the specified dataset,
295 .Bl -tag -width ""
296 .It Xr zfs-program 8
298 programmatically via a Lua script-language channel program.
302 .Bl -tag -width ""
303 .It Xr zfs-jail 8
304 Attaches a filesystem to a jail.
305 .It Xr zfs-unjail 8
306 Detaches a filesystem from a jail.
310 .Bl -tag -width ""
311 .It Xr zfs-wait 8
312 Wait for background activity in a filesystem to complete.
327 .\" Examples 1, 4, 6, 7, 11, 14, 16 are shared with zfs-set.8.
328 .\" Examples 1, 10 are shared with zfs-create.8.
329 .\" Examples 2, 3, 10, 15 are also shared with zfs-snapshot.8.
330 .\" Examples 3, 10, 15 are shared with zfs-destroy.8.
331 .\" Examples 5 are shared with zfs-list.8.
332 .\" Examples 8 are shared with zfs-rollback.8.
333 .\" Examples 9, 10 are shared with zfs-clone.8.
334 .\" Examples 10 are also shared with zfs-promote.8.
335 .\" Examples 10, 15 also are shared with zfs-rename.8.
336 .\" Examples 12, 13 are shared with zfs-send.8.
337 .\" Examples 12, 13 are also shared with zfs-receive.8.
338 .\" Examples 17, 18, 19, 20, 21 are shared with zfs-allow.8.
339 .\" Examples 22 are shared with zfs-diff.8.
340 .\" Examples 23 are shared with zfs-bookmark.8.
342 .Ss Example 1 : No Creating a ZFS File System Hierarchy
343 The following commands create a file system named
345 and a file system named
355 .Ss Example 2 : No Creating a ZFS Snapshot
356 The following command creates a snapshot named
397 .Bd -literal -compact -offset Ds
406 .Ss Example 6 : No Setting a Quota on a ZFS File System
407 The following command sets a quota of 50 Gbytes for
414 .Bd -literal -compact -offset Ds
417 pool/home/bob type filesystem -
418 pool/home/bob creation Tue Jul 21 15:53 2009 -
419 pool/home/bob used 21K -
420 pool/home/bob available 20.0G -
421 pool/home/bob referenced 21K -
422 pool/home/bob compressratio 1.00x -
423 pool/home/bob mounted yes -
444 pool/home/bob version 4 -
445 pool/home/bob utf8only off -
446 pool/home/bob normalization none -
447 pool/home/bob casesensitivity sensitive -
455 pool/home/bob usedbysnapshots 0 -
456 pool/home/bob usedbydataset 21K -
457 pool/home/bob usedbychildren 0 -
458 pool/home/bob usedbyrefreservation 0 -
461 The following command gets a single property value:
462 .Bd -literal -compact -offset Ds
469 .Bd -literal -compact -offset Ds
476 .Ss Example 8 : No Rolling Back a ZFS File System
484 .Ss Example 9 : No Creating a ZFS Clone
485 The following command creates a writable file system whose initial contents are
490 .Ss Example 10 : No Promoting a ZFS Clone
491 The following commands illustrate how to test out changes to a file system, and
494 .Bd -literal -compact -offset Ds
516 The following commands send a full stream and then an incremental stream to a
518 .Em poolB/received/fs@a
527 .Bd -literal -compact -offset Ds
528 .No # Nm zfs Cm send Ar pool/fs@a |
529 .No " " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs Ns @ Ns Ar a
530 .No # Nm zfs Cm send Fl i Ar a pool/fs@b |
535 The following command sends a full stream of
537 to a remote machine, receiving it into
549 .Bd -literal -compact -offset Ds
555 The following example sets the user-defined
557 property for a dataset:
560 .Ss Example 15 : No Performing a Rolling Snapshot
561 The following example shows how to maintain a history of snapshots with a
563 To keep a week's worth of snapshots, the user destroys the oldest snapshot,
564 renames the remaining snapshots, and then creates a new snapshot, as follows:
565 .Bd -literal -compact -offset Ds
577 .Ss Example 16 : No Setting sharenfs Property Options on a ZFS File System
580 property options to enable read-write
581 access for a set of IP addresses and to enable root access for system
589 specify the fully-qualified hostname.
591 .Ss Example 17 : No Delegating ZFS Administration Permissions on a ZFS Dataset
599 .Bd -literal -compact -offset Ds
602 ---- Permissions on tank/cindys --------------------------------------
614 .Dl # Cm chmod No A+user : Ns Ar cindys Ns :add_subdirectory:allow Ar /tank/cindys
616 .Ss Example 18 : No Delegating Create Time Permissions on a ZFS Dataset
626 .Bd -literal -compact -offset Ds
630 ---- Permissions on tank/users ---------------------------------------
637 .Ss Example 19 : No Defining and Granting a Permission Set on a ZFS Dataset
638 The following example shows how to define and grant a permission set on the
644 .Bd -literal -compact -offset Ds
648 ---- Permissions on tank/users ---------------------------------------
655 .Ss Example 20 : No Delegating Property Permissions on a ZFS Dataset
663 .Bd -literal -compact -offset Ds
666 ---- Permissions on users/home ---------------------------------------
675 .Ss Example 21 : No Removing ZFS Delegated Permissions on a ZFS Dataset
684 .Bd -literal -compact -offset Ds
687 ---- Permissions on tank/users ---------------------------------------
694 .Ss Example 22 : No Showing the differences between a snapshot and a ZFS Dataset
695 The following example shows how to see what has changed between a prior
696 snapshot of a ZFS dataset and its current state.
700 .Bd -literal -compact -offset Ds
704 R F /tank/test/oldname -> /tank/test/newname
705 - F /tank/test/deleted
710 .Ss Example 23 : No Creating a bookmark
711 The following example creates a bookmark to a snapshot.
712 This bookmark can then be used instead of a snapshot in send streams.
715 .Ss Example 24 : No Setting Sy sharesmb No Property Options on a ZFS File System
717 Note that a user and their password must be given.
728 Samba must be able to authenticate a user.
729 This can be done in a number of ways
740 .Xr net 8
741 command will be undone if the share is ever unshared (like via a reboot).
744 .Bl -tag -width "ZFS_MODULE_TIMEOUT"
755 .Xr mount 8
766 .\" Shared with zpool.8
798 .Xr exportfs 8 ,
799 .Xr mount 8 ,
800 .Xr net 8 ,
801 .Xr selinux 8 ,
802 .Xr zfs-allow 8 ,
803 .Xr zfs-bookmark 8 ,
804 .Xr zfs-change-key 8 ,
805 .Xr zfs-clone 8 ,
806 .Xr zfs-create 8 ,
807 .Xr zfs-destroy 8 ,
808 .Xr zfs-diff 8 ,
809 .Xr zfs-get 8 ,
810 .Xr zfs-groupspace 8 ,
811 .Xr zfs-hold 8 ,
812 .Xr zfs-inherit 8 ,
813 .Xr zfs-jail 8 ,
814 .Xr zfs-list 8 ,
815 .Xr zfs-load-key 8 ,
816 .Xr zfs-mount 8 ,
817 .Xr zfs-program 8 ,
818 .Xr zfs-project 8 ,
819 .Xr zfs-projectspace 8 ,
820 .Xr zfs-promote 8 ,
821 .Xr zfs-receive 8 ,
822 .Xr zfs-redact 8 ,
823 .Xr zfs-release 8 ,
824 .Xr zfs-rename 8 ,
825 .Xr zfs-rollback 8 ,
826 .Xr zfs-send 8 ,
827 .Xr zfs-set 8 ,
828 .Xr zfs-share 8 ,
829 .Xr zfs-snapshot 8 ,
830 .Xr zfs-unallow 8 ,
831 .Xr zfs-unjail 8 ,
832 .Xr zfs-unload-key 8 ,
833 .Xr zfs-unmount 8 ,
834 .Xr zfs-unshare 8 ,
835 .Xr zfs-upgrade 8 ,
836 .Xr zfs-userspace 8 ,
837 .Xr zfs-wait 8 ,
838 .Xr zpool 8