diff options
Diffstat (limited to 'sys/contrib/openzfs/man/man7/zfsprops.7')
-rw-r--r-- | sys/contrib/openzfs/man/man7/zfsprops.7 | 103 |
1 files changed, 76 insertions, 27 deletions
diff --git a/sys/contrib/openzfs/man/man7/zfsprops.7 b/sys/contrib/openzfs/man/man7/zfsprops.7 index cf925af9e9b0..77e994b912b6 100644 --- a/sys/contrib/openzfs/man/man7/zfsprops.7 +++ b/sys/contrib/openzfs/man/man7/zfsprops.7 @@ -39,7 +39,7 @@ .\" Copyright (c) 2019, Kjeld Schouten-Lebbing .\" Copyright (c) 2022 Hewlett Packard Enterprise Development LP. .\" -.Dd June 29, 2024 +.Dd September 13, 2025 .Dt ZFSPROPS 7 .Os . @@ -541,10 +541,16 @@ The .Sy blocksize cannot be changed once the volume has been written, so it should be set at volume creation time. -The default -.Sy blocksize -for volumes is 16 KiB. -Any power of 2 from 512 bytes to 128 KiB is valid. +The size specified must be a power of two greater than or equal to +.Ar 512 B +and less than or equal to +.Ar 128 KiB . +If the +.Sy large_blocks +feature is enabled on the pool, the size may be up to +.Ar 16 MiB . +The default size is +.Ar 16 KiB . .Pp This property can also be referred to by its shortened column name, .Sy volblock . @@ -1186,18 +1192,26 @@ keylocation can be with either .Nm zfs Cm set or .Nm zfs Cm change-key . +.Pp If .Sy prompt -is selected ZFS will ask for the key at the command prompt when it is required -to access the encrypted data (see +is selected, ZFS will expect the key to be provided when it is required to +access the encrypted data (see .Nm zfs Cm load-key for details). -This setting will also allow the key to be passed in via the standard input -stream, -but users should be careful not to place keys which should be kept secret on -the command line. -If a file URI is selected, the key will be loaded from the +If stdin is a TTY, then ZFS will ask for the key to be provided. +Otherwise, stdin is expected to be the key to use and will be processed as such. +Users should be careful not to place keys which should be kept secret on the +command line, as most operating systems may expose command line arguments to +other processes. +If the +.Dq raw +.Sy keyformat +was used, then the key must be provided via stdin. +.Pp +If a file URL is selected, the key will be loaded from the specified absolute file path. +.Pp If an HTTPS or HTTP URL is selected, it will be GETted using .Xr fetch 3 , libcurl, or nothing, depending on compile-time configuration and run-time @@ -1281,12 +1295,14 @@ This feature must be enabled to be used .Pc . .It Sy special_small_blocks Ns = Ns Ar size This value represents the threshold block size for including small file -blocks into the special allocation class. -Blocks smaller than or equal to this -value will be assigned to the special allocation class while greater blocks -will be assigned to the regular class. -Valid values are zero or a power of two from 512 up to 1048576 (1 MiB). -The default size is 0 which means no small file blocks +or zvol blocks into the special allocation class. +Blocks smaller than or equal to this value after compression and encryption +will be assigned to the special allocation class, while greater blocks will +be assigned to the regular class. +Valid values are from 0 to maximum block size ( +.Ar 16 MiB +). +The default size is 0 which means no small file or zvol blocks will be allocated in the special class. .Pp Before setting this property, a special class vdev must be added to the @@ -1436,6 +1452,12 @@ SID numeric ID .El .Pp Files created on Linux always have POSIX owners. +.It Sy defaultuserquota Ns = Ns Ar size Ns | Ns Sy none +Sets a default user quota to be applied to each user for whom no +user-specific quota is set. +The value +.Sy 0 +disables defaultuserquota. .It Sy userobjquota@ Ns Ar user Ns = Ns Ar size Ns | Ns Sy none The .Sy userobjquota @@ -1445,6 +1467,12 @@ but it limits the number of objects a user can create. Please refer to .Sy userobjused for more information about how objects are counted. +.It Sy defaultuserobjquota Ns = Ns Ar size Ns | Ns Sy none +Sets a default user object quota to be applied to each user for +whom no userobj-specific quota is set. +The value +.Sy 0 +disables defaultuserobjquota. .It Sy groupquota@ Ns Ar group Ns = Ns Ar size Ns | Ns Sy none Limits the amount of space consumed by the specified group. Group space consumption is identified by the @@ -1457,6 +1485,12 @@ The root user, or a user who has been granted the privilege with .Nm zfs Cm allow , can get and set all groups' quotas. +.It Sy defaultgroupquota Ns = Ns Ar size Ns | Ns Sy none +Sets a default group quota to be applied to each group for whom no +group-specific quota is set. +The value +.Sy 0 +disables defaultgroupquota. .It Sy groupobjquota@ Ns Ar group Ns = Ns Ar size Ns | Ns Sy none The .Sy groupobjquota @@ -1466,6 +1500,12 @@ but it limits number of objects a group can consume. Please refer to .Sy userobjused for more information about how objects are counted. +.It Sy defaultgroupobjquota Ns = Ns Ar size Ns | Ns Sy none +Sets a default group object quota to be applied to each group for +whom no groupobj-specific quota is set. +The value +.Sy 0 +disables defaultgroupobjquota. .It Sy projectquota@ Ns Ar project Ns = Ns Ar size Ns | Ns Sy none Limits the amount of space consumed by the specified project. Project space consumption is identified by the @@ -1480,6 +1520,12 @@ The root user, or a user who has been granted the privilege with .Nm zfs allow , can access all projects' quota. +.It Sy defaultprojectquota Ns = Ns Ar size Ns | Ns Sy none +Sets a default project quota to be applied to each project for whom no +project-specific quota is set. +The value +.Sy 0 +disables defaultprojectquota. .It Sy projectobjquota@ Ns Ar project Ns = Ns Ar size Ns | Ns Sy none The .Sy projectobjquota @@ -1489,6 +1535,12 @@ but it limits number of objects a project can consume. Please refer to .Sy userobjused for more information about how objects are counted. +.It Sy defaultprojectobjquota Ns = Ns Ar size Ns | Ns Sy none +Sets a default project object quota to be applied to each project for +whom no projectobj-specific quota is set. +The value +.Sy 0 +disables defaultprojectobjquota. .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off Controls whether this dataset can be modified. The default value is @@ -1533,11 +1585,6 @@ See .Xr zpool-features 7 for details on ZFS feature flags. .Pp -However, blocks larger than -.Ar 1 MiB -can have an impact on i/o latency (e.g. tying up a spinning disk for -~300ms), and also potentially on the memory allocator. -.Pp Note that maximum size is still limited by default to .Ar 1 MiB on x86_32, see @@ -1596,7 +1643,8 @@ When set to ZFS stores an extra copy of only critical metadata. This can improve file create performance since less metadata needs to be written. -If a single on-disk block is corrupt, at worst a single user file can be lost. +If a single on-disk block is corrupt, multiple user files or directories +can be lost. .Pp When set to .Sy none , @@ -1827,7 +1875,8 @@ property is updated with , the property is set to desired value, but the operation to share, reshare or unshare the the dataset is not performed. .It Sy logbias Ns = Ns Sy latency Ns | Ns Sy throughput -Provide a hint to ZFS about handling of synchronous requests in this dataset. +Provide a hint to ZFS about handling of synchronous write requests in this +dataset. If .Sy logbias is set to @@ -1835,12 +1884,12 @@ is set to .Pq the default , ZFS will use pool log devices .Pq if configured -to handle the requests at low latency. +to handle the write requests at low latency. If .Sy logbias is set to .Sy throughput , -ZFS will not use configured pool log devices. +ZFS will not use configured pool log devices to store written data. ZFS will instead optimize synchronous operations for global pool throughput and efficient use of resources. .It Sy snapdev Ns = Ns Sy hidden Ns | Ns Sy visible |