Lines Matching +full:access +full:- +full:ns

1 .\" SPDX-License-Identifier: CDDL-1.0
10 .\" or https://opensource.org/licenses/CDDL-1.0.
35 .\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
39 .\" Copyright (c) 2019, Kjeld Schouten-Lebbing
48 .Nd native and user-defined properties of ZFS datasets
51 Properties are divided into two types, native properties and user-defined
57 In addition, native properties are either editable or read-only.
71 The values of numeric properties can be specified using human-readable suffixes
88 The values of non-numeric properties are case sensitive and must be lowercase,
95 The following native properties consist of read-only statistics about the
99 .Bl -tag -width "usedbyrefreservation"
110 For non-snapshots, the compression ratio achieved for the
123 .Nm zfs Cm set Sy compression Ns = Ns Sy on Ar dataset .
136 For snapshots, this property is a comma-separated list of filesystems or volumes
167 .Nm zfs Cm load-key
169 .Nm zfs Cm unload-key
176 .Xr zfs-load-key 8
192 .Nm zfs Cm load-key
194 .Nm zfs Cm unload-key .
259 For filesystems or volumes which have saved partially-completed state from
379 .It Sy userused Ns @ Ns Ar user
389 Unprivileged users can access only their own space usage.
394 can access everyone's usage.
397 .Sy userused Ns @ Ns Ar …
403 .Bl -bullet -compact -offset 4n
415 .Pq Qq S-1-123-456-789
419 .It Sy userobjused Ns @ Ns Ar user
430 .Sy xattr Ns = Ns Sy on
431 is set on a file system additional objects will be created per-file to store
438 .Sy xattr Ns = Ns Sy sa
445 .It Sy groupused Ns @ Ns Ar group
450 .Sy userused Ns @ Ns Ar user
453 Unprivileged users can only access their own groups' space usage.
458 can access all groups' usage.
459 .It Sy groupobjused Ns @ Ns Ar group
464 .Sy userobjused Ns @ Ns Ar user
467 Unprivileged users can only access their own groups' space usage.
472 can access all groups' usage.
473 .It Sy projectused Ns @ Ns Ar project
475 Project is identified via the project identifier (ID) that is object-based
494 .Sy userused Ns @ Ns Ar user
501 can access all projects' usage.
502 .It Sy projectobjused Ns @ Ns Ar project
509 .Sy xattr Ns = Ns Sy on
510 is set on a fileset, ZFS will create additional objects per-file to store
517 .Sy xattr Ns = Ns Sy sa
520 .Sy userobjused Ns @ Ns Ar user
527 can access all projects' objects usage.
562 .It Sy written Ns @ Ns Ar snapshot
578 .Pq Ar filesystem Ns @ Ns Ar snapshot ,
585 .Bl -tag -width ""
587 .Sy aclinherit Ns = Ns Sy discard Ns | Ns Sy noallow Ns | Ns
588 .Sy restricted Ns | Ns Sy passthrough Ns | Ns Sy passthrough-x
591 .Bl -tag -compact -offset 4n -width "passthrough-x"
606 .It Sy passthrough-x
625 .Sy aclmode Ns = Ns Sy discard Ns | Ns Sy groupmask Ns | Ns
626 .Sy passthrough Ns | Ns Sy restricted Ns
630 .Bl -tag -compact -offset 4n -width "passthrough"
651 a non-trivial ACL whose entries can not be represented by a mode.
657 on a file or directory with a non-trivial ACL when
663 .It Sy acltype Ns = Ns Sy off Ns | Ns Sy nfsv4 Ns | Ns Sy posix
668 .Bl -tag -compact -offset 4n -width "posixacl"
679 indicates that NFSv4-style ZFS ACLs should be used.
701 .Sy xattr Ns = Ns Sy sa
706 .Sy xattr Ns = Ns Sy sa
711 .It Sy atime Ns = Ns Sy on Ns | Ns Sy off
712 Controls whether the access time for files is updated when they are read.
730 .It Sy canmount Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy noauto
748 .Sy canmount Ns = Ns Sy off
766 .Sy checksum Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy fletcher2 Ns | Ns
767 .Sy fletcher4 Ns | Ns Sy sha256 Ns | Ns Sy noparity Ns | Ns
768 .Sy sha512 Ns | Ns Sy skein Ns | Ns Sy edonr Ns | Ns Sy blake3
784 This setting is used internally by a dump device residing on a RAID-Z pool and
799 .Xr zpool-features 7
802 Changing this property affects only newly-written data.
804 .Sy compression Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy gzip Ns | Ns
805 .Sy gzip- Ns Ar N Ns | Ns Sy lz4 Ns | Ns Sy lzjb Ns | Ns Sy zle Ns | Ns Sy zstd Ns | Ns
806 .Sy zstd- Ns Ar N Ns | Ns Sy zstd-fast Ns | Ns Sy zstd-fast- Ns Ar N
830 compression algorithm is a high-performance replacement for the
841 .Xr zpool-features 7
859 .Sy gzip- Ns Ar N ,
869 .Sy gzip-6
881 .Sy zstd- Ns Ar N ,
890 .Sy zstd-3 .
897 .Sy zstd-fast- Ns Ar N ,
901 .Bq Sy 1 Ns - Ns Sy 10 , 20 , 30 , No … , Sy 100 , 500 , 1000
908 .Sy zstd-fast
910 .Sy zstd-fast- Ns Ar 1 .
918 Changing this property affects only newly-written data.
924 When a zero-filled block is detected, it is stored as
928 .Pq chunks of 2^ Ns Sy ashift No bytes , e.g . Sy 512B No or Sy 4KB .
929 Compression may result in a non-sector-aligned size, which will be rounded up
936 .Sy recordsize Ns = Ns Sy 16K
946 .Sy context Ns = Ns Sy none Ns | Ns
947 .Ar SELinux-User : Ns Ar SELinux-Role : Ns Ar SELinux-Type : Ns Ar Sensitivity-Level
955 .Sy fscontext Ns = Ns Sy none Ns | Ns
956 .Ar SELinux-User : Ns Ar SELinux-Role : Ns Ar SELinux-Type : Ns Ar Sensitivity-Level
964 .Sy defcontext Ns = Ns Sy none Ns | Ns
965 .Ar SELinux-User : Ns Ar SELinux-Role : Ns Ar SELinux-Type : Ns Ar Sensitivity-Level
972 .Sy rootcontext Ns = Ns Sy none Ns | Ns
973 .Ar SELinux-User : Ns Ar SELinux-Role : Ns Ar SELinux-Type : Ns Ar Sensitivity-Level
979 .It Sy copies Ns = Ns Sy 1 Ns | Ns Sy 2 Ns | Ns Sy 3
982 example, mirroring or RAID-Z.
989 Changing this property only affects newly-written data.
991 .Fl o Sy copies Ns = Ns Ar N
994 Remember that ZFS will not import a pool with a missing top-level vdev.
997 create, for example a two-disk striped pool and set
998 .Sy copies Ns = Ns Ar 2
1004 .Sy copies Ns = Ns Ar 3
1007 .It Sy devices Ns = Ns Sy on Ns | Ns Sy off
1021 .Sy dedup Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy verify Ns | Ns
1022 .Sy sha256 Ns Oo , Ns Sy verify Oc Ns | Ns Sy sha512 Ns Oo , Ns Sy verify Oc Ns | Ns Sy skein Ns Oo…
1023 .Sy edonr , Ns Sy verify Ns | Ns Sy blake3 Ns Oo , Ns Sy verify Oc Ns
1039 .Sy sha256 , Ns Sy verify .
1043 ZFS will do a byte-to-byte comparison in case of two blocks having the same
1059 .Sy direct Ns = Ns Sy disabled Ns | Ns Sy standard Ns | Ns Sy always
1078 .Sy recordsize Ns
1084 All direct requests must use a page-aligned memory buffer and the request
1094 based file access then in order to maintain coherency all direct requests
1101 .Sy dnodesize Ns = Ns Sy legacy Ns | Ns Sy auto Ns | Ns Sy 1k Ns | Ns
1102 .Sy 2k Ns | Ns Sy 4k Ns | Ns Sy 8k Ns | Ns Sy 16k
1116 .Sy xattr Ns = Ns Sy sa
1119 may be applicable to SELinux-enabled systems, Lustre servers, and Samba
1137 .Sy encryption Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy aes-128-ccm Ns | Ns
1138 .Sy aes-192-ccm Ns | Ns Sy aes-256-ccm Ns | Ns Sy aes-128-gcm Ns | Ns
1139 .Sy aes-192-gcm Ns | Ns Sy aes-256-gcm
1151 .Sy encryption Ns = Ns Sy on
1154 .Sy aes-256-gcm .
1161 .Xr zfs-load-key 8 .
1162 .It Sy keyformat Ns = Ns Sy raw Ns | Ns Sy hex Ns | Ns Sy passphrase
1169 .Dl # Nm dd Sy if=/dev/urandom bs=32 count=1 Sy of= Ns Pa /path/to/output/key
1177 .Nm zfs Cm change-key .
1179 .Sy keylocation Ns = Ns Sy prompt Ns | Ns Sy file:// Ns Ar /absolute/file/path Ns | Ns Sy https:// …
1183 .Nm zfs Cm load-key
1194 .Nm zfs Cm change-key .
1199 access the encrypted data (see
1200 .Nm zfs Cm load-key
1217 libcurl, or nothing, depending on compile-time configuration and run-time
1233 .It Sy pbkdf2iters Ns = Ns Ar iterations
1253 .Nm zfs Cm change-key .
1254 .It Sy exec Ns = Ns Sy on Ns | Ns Sy off
1267 .It Sy volthreading Ns = Ns Sy on Ns | Ns Sy off
1279 .It Sy filesystem_limit Ns = Ns Ar count Ns | Ns Sy none
1294 .Xr zpool-features 7
1296 .It Sy special_small_blocks Ns = Ns Ar size
1313 .It Sy mountpoint Ns = Ns Pa path Ns | Ns Sy none Ns | Ns Sy legacy
1344 .It Sy nbmand Ns = Ns Sy on Ns | Ns Sy off
1347 .Pq Non-blocking mandatory locks .
1354 .It Sy overlay Ns = Ns Sy on Ns | Ns Sy off
1366 .It Sy primarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1380 .It Sy quota Ns = Ns Ar size Ns | Ns Sy none
1391 .It Sy snapshot_limit Ns = Ns Ar count Ns | Ns Sy none
1406 .Xr zpool-features 7
1408 .It Sy userquota@ Ns Ar user Ns = Ns Ar size Ns | Ns Sy none
1411 .Sy userspace@ Ns Ar user
1423 Unprivileged users can only access their own groups' space usage.
1433 .Sy userquota@ Ns Ar …
1439 .Bl -bullet -compact -offset 4n
1451 .Pq Qq S-1-123-456-789
1455 .It Sy defaultuserquota Ns = Ns Ar size Ns | Ns Sy none
1457 user-specific quota is set.
1461 .It Sy userobjquota@ Ns Ar user Ns = Ns Ar size Ns | Ns Sy none
1470 .It Sy defaultuserobjquota Ns = Ns Ar size Ns | Ns Sy none
1472 whom no userobj-specific quota is set.
1476 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size Ns | Ns Sy none
1479 .Sy groupused@ Ns Ar group
1482 Unprivileged users can access only their own groups' space usage.
1488 .It Sy defaultgroupquota Ns = Ns Ar size Ns | Ns Sy none
1490 group-specific quota is set.
1494 .It Sy groupobjquota@ Ns Ar group Ns = Ns Ar size Ns | Ns Sy none
1503 .It Sy defaultgroupobjquota Ns = Ns Ar size Ns | Ns Sy none
1505 whom no groupobj-specific quota is set.
1509 .It Sy projectquota@ Ns Ar project Ns = Ns Ar size Ns | Ns Sy none
1512 .Sy projectused@ Ns Ar project
1522 can access all projects' quota.
1523 .It Sy defaultprojectquota Ns = Ns Ar size Ns | Ns Sy none
1525 project-specific quota is set.
1529 .It Sy projectobjquota@ Ns Ar project Ns = Ns Ar size Ns | Ns Sy none
1538 .It Sy defaultprojectobjquota Ns = Ns Ar size Ns | Ns Sy none
1540 whom no projectobj-specific quota is set.
1544 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
1560 .It Sy recordsize Ns = Ns Ar size
1562 This property is designed solely for use with database workloads that access
1563 files in fixed-size records.
1565 for typical access patterns.
1567 For databases that create very large files but access them in small random
1585 .Xr zpool-features 7
1600 .It Sy redundant_metadata Ns = Ns Sy all Ns | Ns Sy most Ns | Ns Sy some Ns | Ns Sy none
1605 .Pq e.g. by mirroring or RAID-Z ,
1611 .Sy copies Ns = Ns 2 ,
1613 .Sy redundant_metadata Ns = Ns Sy most ,
1620 If a single on-disk block is corrupt, at worst a single block of user data
1637 of user data can be lost if a single on-disk block is corrupt.
1646 If a single on-disk block is corrupt, multiple user files or directories
1652 If a single on-disk block is corrupt, an entire dataset can be lost.
1656 .It Sy refquota Ns = Ns Ar size Ns | Ns Sy none
1661 .It Sy refreservation Ns = Ns Ar size Ns | Ns Sy none Ns | Ns Sy auto
1687 .Sy refreservation Ns = Ns Sy auto
1697 .It Sy relatime Ns = Ns Sy on Ns | Ns Sy off
1698 Controls the manner in which the access time is updated when
1699 .Sy atime Ns = Ns Sy on
1701 Turning this property on causes the access time to be updated relative
1703 Access time is only updated if the previous
1704 access time was earlier than the current modify or change time or if the
1705 existing access time hasn't been updated within the past 24 hours.
1717 .It Sy reservation Ns = Ns Ar size Ns | Ns Sy none
1726 .It Sy secondarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1740 .It Sy prefetch Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1757 .It Sy setuid Ns = Ns Sy on Ns | Ns Sy off
1770 .It Sy sharesmb Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Ar opts
1798 The share is created with the ACL (Access Control List) "Everyone:F" ("F"
1800 access (which means Samba must be able to authenticate a real user \(em
1801 .Xr passwd 5 Ns / Ns Xr shadow 5 Ns - ,
1802 LDAP- or
1803 .Xr smbpasswd 5 Ns -based )
1805 This means that any additional access control
1806 (disallow specific user specific access etc) must be done on the underlying file
1815 .It Sy sharenfs Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Ar opts
1837 Please note that the options are comma-separated, unlike those found in
1864 property are re-shared with the new options, only if the property was previously
1877 .It Sy logbias Ns = Ns Sy latency Ns | Ns Sy throughput
1895 .It Sy snapdev Ns = Ns Sy hidden Ns | Ns Sy visible
1897 .Pa /dev/zvol/ Ns Aq Ar pool
1901 .It Sy snapdir Ns = Ns Sy disabled Ns | Ns Sy hidden Ns | Ns Sy visible
1911 .It Sy sync Ns = Ns Sy standard Ns | Ns Sy always Ns | Ns Sy disabled
1915 is the POSIX-specified behavior of ensuring all synchronous requests
1930 .It Sy version Ns = Ns Ar N Ns | Ns Sy current
1931 The on-disk version of this file system, which is independent of the pool
1937 .It Sy volsize Ns = Ns Ar size
1997 .It Sy volmode Ns = Ns Sy default Ns | Ns Sy full Ns | Ns Sy geom Ns | Ns Sy dev Ns | Ns Sy none
2017 means that volumes exposition is controlled by system-wide tunable
2027 .It Sy vscan Ns = Ns Sy on Ns | Ns Sy off
2035 .It Sy xattr Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy dir Ns | Ns Sy sa
2037 Two styles of extended attributes are supported: either directory-based
2038 or system-attribute-based.
2040 Directory-based extended attributes can be enabled by setting the value to
2053 System-attribute-based xattrs can be enabled by setting the value to
2063 of data may be stored per-file in the space reserved for system attributes.
2065 then it will be automatically written as a directory-based xattr.
2066 System-attribute-based extended attributes are not accessible
2068 .Sy xattr Ns = Ns Sy sa
2071 .Sy xattr Ns = Ns Sy sa
2076 The use of system-attribute-based xattrs is strongly encouraged for users of
2079 attributes and benefit significantly from the reduced access time.
2090 .It Sy jailed Ns = Ns Sy off Ns | Ns Sy on
2093 .Xr zfs-jail 8
2098 .It Sy zoned Ns = Ns Sy off Ns | Ns Sy on
2099 Controls whether the dataset is managed from a non-global zone or namespace.
2101 .Xr zfs-zone 8
2118 .Bl -tag -width ""
2120 .Sy casesensitivity Ns = Ns Sy sensitive Ns | Ns
2121 .Sy insensitive Ns | Ns Sy mixed
2124 should be case-sensitive, case-insensitive, or allow a combination of both
2132 and POSIX file systems have case-sensitive file names.
2139 case-sensitive and case-insensitive matching behavior.
2140 Currently, case-insensitive matching behavior on a file system that supports
2146 .Sy normalization Ns = Ns Sy none Ns | Ns Sy formC Ns | Ns
2147 .Sy formD Ns | Ns Sy formKC Ns | Ns Sy formKD
2168 .It Sy utf8only Ns = Ns Sy on Ns | Ns Sy off
2171 .Sy UTF-8
2189 properties are also new permissions that can be assigned to non-privileged users
2200 .Bl -tag -compact -offset Ds -width "rootcontext="
2219 .It Sy context Ns =
2221 .It Sy fscontext Ns =
2223 .It Sy defcontext Ns =
2225 .It Sy rootcontext Ns =
2229 In addition, these options can be set on a per-mount basis using the
2237 .Sy nodevices , Ns Sy nosetuid .
2260 .Pq Qq Sy - ,
2267 .Ar module : Ns Ar property ,
2270 .Pq Qq Sy - .
2276 independently-developed packages use the same property name for different