Lines Matching +full:a +full:- +full:8
1 .\" SPDX-License-Identifier: CDDL-1.0
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or https://opensource.org/licenses/CDDL-1.0.
34 .\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
60 command configures ZFS datasets within a ZFS storage pool, as described in
61 .Xr zpool 8 .
62 A dataset is identified by a unique path within the ZFS namespace:
70 The maximum length of a dataset name is
71 .Sy ZFS_MAX_DATASET_NAME_LEN No - 1
73 .Sy [A-Za-z_.:/ -] .
74 Additionally snapshots are allowed to contain a single
76 character, while bookmarks are allowed to contain a single
81 The maximum amount of nesting allowed in a path is
89 A dataset can be one of the following:
90 .Bl -tag -offset Ds -width "file system"
94 While ZFS file systems are designed to be POSIX-compliant, known issues exist
96 Applications that depend on standards conformance might fail due to non-standard
99 A logical volume exported as a raw or block device.
100 This type of dataset should only be used when a block device is required.
103 A read-only version of a file system or volume at a given point in time.
109 Much like a
111 but without the hold on on-disk data.
112 It can be used as the source of a send (but not for a receive).
124 Properties are divided into two types: native properties and user-defined
128 In addition, native properties are either editable or read-only.
130 datasets in a way that is meaningful in your environment.
143 .Xr zfs-load-key 8 .
148 .Bl -tag -width ""
150 Displays a help message.
153 .Fl V , -version
169 .Bl -tag -width ""
170 .It Xr zfs-list 8
172 .It Xr zfs-create 8
173 Creates a new ZFS file system or volume.
174 .It Xr zfs-destroy 8
176 .It Xr zfs-rename 8
178 .It Xr zfs-upgrade 8
179 Manage upgrading the on-disk version of filesystems.
183 .Bl -tag -width ""
184 .It Xr zfs-snapshot 8
186 .It Xr zfs-rollback 8
187 Roll back the given dataset to a previous snapshot.
188 .It Xr zfs-hold 8 Ns / Ns Xr zfs-release 8
189 Add or remove a hold reference to the specified snapshot or snapshots.
190 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
194 .It Xr zfs-diff 8
195 Display the difference between a snapshot of a given filesystem and another
196 snapshot of that filesystem from a later time or the current contents of the
201 .Bl -tag -width ""
202 .It Xr zfs-clone 8
203 Creates a clone of the given snapshot.
204 .It Xr zfs-promote 8
205 Promotes a clone file system to no longer be dependent on its
211 .Bl -tag -width ""
212 .It Xr zfs-send 8
213 Generate a send stream, which may be of a filesystem, and may be incremental
214 from a bookmark.
215 .It Xr zfs-receive 8
216 Creates a snapshot whose contents are as specified in the stream provided on
218 If a full stream is received, then a new file system is created as well.
220 .Xr zfs-send 8
221 subcommand, which by default creates a full stream.
222 .It Xr zfs-bookmark 8
223 Creates a new bookmark of the given snapshot or bookmark.
225 as the incremental source for a
228 .It Xr zfs-redact 8
229 Generate a new redaction bookmark.
230 This feature can be used to allow clones of a filesystem to be made available on
231 a remote system, in the case where their parent need not (or needs to not) be
236 .Bl -tag -width ""
237 .It Xr zfs-get 8
239 .It Xr zfs-set 8
241 .It Xr zfs-inherit 8
249 .Bl -tag -width ""
250 .It Xr zfs-userspace 8 Ns / Ns Xr zfs-groupspace 8 Ns / Ns Xr zfs-projectspace 8
253 .It Xr zfs-project 8
258 .Bl -tag -width ""
259 .It Xr zfs-mount 8
261 on a path described by its
264 .It Xr zfs-unmount 8
269 .Bl -tag -width ""
270 .It Xr zfs-share 8
272 .It Xr zfs-unshare 8
277 .Bl -tag -width ""
278 .It Xr zfs-allow 8
280 .It Xr zfs-unallow 8
285 .Bl -tag -width ""
286 .It Xr zfs-change-key 8
288 .It Xr zfs-load-key 8
290 .It Xr zfs-unload-key 8
291 Unload a key for the specified dataset,
296 .Bl -tag -width ""
297 .It Xr zfs-program 8
299 programmatically via a Lua script-language channel program.
303 .Bl -tag -width ""
304 .It Xr zfs-jail 8
305 Attaches a filesystem to a jail.
306 .It Xr zfs-unjail 8
307 Detaches a filesystem from a jail.
311 .Bl -tag -width ""
312 .It Xr zfs-wait 8
313 Wait for background activity in a filesystem to complete.
328 .\" Examples 1, 4, 6, 7, 11, 14, 16 are shared with zfs-set.8.
329 .\" Examples 1, 10 are shared with zfs-create.8.
330 .\" Examples 2, 3, 10, 15 are also shared with zfs-snapshot.8.
331 .\" Examples 3, 10, 15 are shared with zfs-destroy.8.
332 .\" Examples 5 are shared with zfs-list.8.
333 .\" Examples 8 are shared with zfs-rollback.8.
334 .\" Examples 9, 10 are shared with zfs-clone.8.
335 .\" Examples 10 are also shared with zfs-promote.8.
336 .\" Examples 10, 15 also are shared with zfs-rename.8.
337 .\" Examples 12, 13 are shared with zfs-send.8.
338 .\" Examples 12, 13 are also shared with zfs-receive.8.
339 .\" Examples 17, 18, 19, 20, 21 are shared with zfs-allow.8.
340 .\" Examples 22 are shared with zfs-diff.8.
341 .\" Examples 23 are shared with zfs-bookmark.8.
343 .Ss Example 1 : No Creating a ZFS File System Hierarchy
344 The following commands create a file system named
346 and a file system named
356 .Ss Example 2 : No Creating a ZFS Snapshot
357 The following command creates a snapshot named
398 .Bd -literal -compact -offset Ds
407 .Ss Example 6 : No Setting a Quota on a ZFS File System
408 The following command sets a quota of 50 Gbytes for
415 .Bd -literal -compact -offset Ds
418 pool/home/bob type filesystem -
419 pool/home/bob creation Tue Jul 21 15:53 2009 -
420 pool/home/bob used 21K -
421 pool/home/bob available 20.0G -
422 pool/home/bob referenced 21K -
423 pool/home/bob compressratio 1.00x -
424 pool/home/bob mounted yes -
445 pool/home/bob version 4 -
446 pool/home/bob utf8only off -
447 pool/home/bob normalization none -
448 pool/home/bob casesensitivity sensitive -
456 pool/home/bob usedbysnapshots 0 -
457 pool/home/bob usedbydataset 21K -
458 pool/home/bob usedbychildren 0 -
459 pool/home/bob usedbyrefreservation 0 -
462 The following command gets a single property value:
463 .Bd -literal -compact -offset Ds
470 .Bd -literal -compact -offset Ds
477 .Ss Example 8 : No Rolling Back a ZFS File System
485 .Ss Example 9 : No Creating a ZFS Clone
486 The following command creates a writable file system whose initial contents are
491 .Ss Example 10 : No Promoting a ZFS Clone
492 The following commands illustrate how to test out changes to a file system, and
495 .Bd -literal -compact -offset Ds
517 The following commands send a full stream and then an incremental stream to a
519 .Em poolB/received/fs@a
528 .Bd -literal -compact -offset Ds
529 .No # Nm zfs Cm send Ar pool/fs@a |
530 .No " " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs Ns @ Ns Ar a
531 .No # Nm zfs Cm send Fl i Ar a pool/fs@b |
536 The following command sends a full stream of
538 to a remote machine, receiving it into
550 .Bd -literal -compact -offset Ds
556 The following example sets the user-defined
558 property for a dataset:
561 .Ss Example 15 : No Performing a Rolling Snapshot
562 The following example shows how to maintain a history of snapshots with a
564 To keep a week's worth of snapshots, the user destroys the oldest snapshot,
565 renames the remaining snapshots, and then creates a new snapshot, as follows:
566 .Bd -literal -compact -offset Ds
578 .Ss Example 16 : No Setting sharenfs Property Options on a ZFS File System
581 property options to enable read-write
582 access for a set of IP addresses and to enable root access for system
590 specify the fully-qualified hostname.
592 .Ss Example 17 : No Delegating ZFS Administration Permissions on a ZFS Dataset
600 .Bd -literal -compact -offset Ds
603 ---- Permissions on tank/cindys --------------------------------------
615 .Dl # Cm chmod No A+user : Ns Ar cindys Ns :add_subdirectory:allow Ar /tank/cindys
617 .Ss Example 18 : No Delegating Create Time Permissions on a ZFS Dataset
627 .Bd -literal -compact -offset Ds
631 ---- Permissions on tank/users ---------------------------------------
638 .Ss Example 19 : No Defining and Granting a Permission Set on a ZFS Dataset
639 The following example shows how to define and grant a permission set on the
645 .Bd -literal -compact -offset Ds
649 ---- Permissions on tank/users ---------------------------------------
656 .Ss Example 20 : No Delegating Property Permissions on a ZFS Dataset
664 .Bd -literal -compact -offset Ds
667 ---- Permissions on users/home ---------------------------------------
676 .Ss Example 21 : No Removing ZFS Delegated Permissions on a ZFS Dataset
685 .Bd -literal -compact -offset Ds
688 ---- Permissions on tank/users ---------------------------------------
695 .Ss Example 22 : No Showing the differences between a snapshot and a ZFS Dataset
696 The following example shows how to see what has changed between a prior
697 snapshot of a ZFS dataset and its current state.
701 .Bd -literal -compact -offset Ds
705 R F /tank/test/oldname -> /tank/test/newname
706 - F /tank/test/deleted
711 .Ss Example 23 : No Creating a bookmark
712 The following example creates a bookmark to a snapshot.
713 This bookmark can then be used instead of a snapshot in send streams.
716 .Ss Example 24 : No Setting Sy sharesmb No Property Options on a ZFS File System
718 Note that a user and their password must be given.
729 Samba must be able to authenticate a user.
730 This can be done in a number of ways
741 .Xr net 8
742 command will be undone if the share is ever unshared (like via a reboot).
745 .Bl -tag -width "ZFS_MODULE_TIMEOUT"
756 .Xr mount 8
767 .\" Shared with zpool.8
799 .Xr exportfs 8 ,
800 .Xr mount 8 ,
801 .Xr net 8 ,
802 .Xr selinux 8 ,
803 .Xr zfs-allow 8 ,
804 .Xr zfs-bookmark 8 ,
805 .Xr zfs-change-key 8 ,
806 .Xr zfs-clone 8 ,
807 .Xr zfs-create 8 ,
808 .Xr zfs-destroy 8 ,
809 .Xr zfs-diff 8 ,
810 .Xr zfs-get 8 ,
811 .Xr zfs-groupspace 8 ,
812 .Xr zfs-hold 8 ,
813 .Xr zfs-inherit 8 ,
814 .Xr zfs-jail 8 ,
815 .Xr zfs-list 8 ,
816 .Xr zfs-load-key 8 ,
817 .Xr zfs-mount 8 ,
818 .Xr zfs-program 8 ,
819 .Xr zfs-project 8 ,
820 .Xr zfs-projectspace 8 ,
821 .Xr zfs-promote 8 ,
822 .Xr zfs-receive 8 ,
823 .Xr zfs-redact 8 ,
824 .Xr zfs-release 8 ,
825 .Xr zfs-rename 8 ,
826 .Xr zfs-rollback 8 ,
827 .Xr zfs-send 8 ,
828 .Xr zfs-set 8 ,
829 .Xr zfs-share 8 ,
830 .Xr zfs-snapshot 8 ,
831 .Xr zfs-unallow 8 ,
832 .Xr zfs-unjail 8 ,
833 .Xr zfs-unload-key 8 ,
834 .Xr zfs-unmount 8 ,
835 .Xr zfs-unshare 8 ,
836 .Xr zfs-upgrade 8 ,
837 .Xr zfs-userspace 8 ,
838 .Xr zfs-wait 8 ,
839 .Xr zpool 8