|
|
|
|
|
aclinherit
|
String
|
secure
|
Controls how ACL entries are inherited when files and directories are created. The
values are discard, noallow, secure, and
passthrough. For a description of these values, see ACL
Properties.
|
|
aclmode
|
String
|
groupmask
|
Controls how an ACL entry is modified during a chmod operation. The
values are discard, groupmask, and
passthrough. For a description of these values, see ACL
Properties.
|
|
atime
|
Boolean
|
on
|
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 similar utilities.
|
|
available
|
Number
|
N/A
|
Read-only property that identifies the amount of disk space available to a file system
and all its children, assuming no other activity in the pool. Because disk space is shared within a
pool, available space can be limited by various factors including physical pool size, quotas,
reservations, and other datasets within the pool.
The property abbreviation is avail.
|
|
canmount
|
Boolean
|
on
|
Controls whether a file system can be mounted with the zfs
mount command. This property can be set on any file system, and the property
itself is not inheritable. However, when this property is set to off, a mount
point can be inherited to descendent file systems, but the file system itself is never
mounted.
When the noauto option is set, a file system can only be mounted and
unmounted explicitly. The file system is not mounted automatically when the file system is created
or imported, nor is it mounted by the zfs mount–a command or
unmounted by the zfs unmount–a command.
|
|
casesensitivity
|
String
|
mixed
|
This property indicates whether the file name matching algorithm used by the file system
should be casesensitive, caseinsensitive, or allow a
combination of both styles of matching (mixed). Traditionally, UNIX and POSIX
file systems have case-sensitive file names.
The mixed value for this property indicates 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 Oracle Solaris SMB
server product. For more information about using the mixed value, see The casesensitivity Property.
Regardless of the casesensitivity property setting, the file system
preserves the case of the name specified to create a file. This property cannot be changed after the
file system is created.
|
|
checksum
|
String
|
on
|
Controls the checksum used to verify data integrity. The default value is
on, which automatically selects an appropriate algorithm, currently
fletcher4. The values are on, off, fletcher2, fletcher4,
sha256, and sha256+mac. A value of off disables
integrity checking on user data. A value of off is not recommended.
|
|
compression
|
String
|
off
|
Enables or disables compression for a dataset. The values are on,
off, lzjb, gzip, and
gzip-N. Currently, setting this property to
lzjb, gzip, or
gzip-N has the same effect as setting this property to
on. Enabling compression on a file system with existing data only compresses new
data. Existing data remains uncompressed.
The property abbreviation is compress.
|
|
compressratio
|
Number
|
N/A
|
Read-only property that identifies the compression ratio achieved for a dataset,
expressed as a multiplier. Compression can be enabled by the zfs set
compression=on
dataset command.
The value is calculated from the logical size of all files and the amount of referenced
physical data. It includes explicit savings through the use of the compression
property.
|
|
copies
|
Number
|
1
|
Sets the number of copies of user data per file system. Available values are
1, 2, or 3. These copies are in addition to
any pool-level redundancy. Disk space used by multiple copies of user data is charged to the
corresponding file and dataset, and counts against quotas and reservations. In addition, the
used property is updated when multiple copies are enabled. Consider setting this
property when the file system is created because changing this property on an existing file system
only affects newly written data.
|
|
creation
|
String
|
N/A
|
Read-only property that identifies the date and time that a dataset was created.
|
|
dedup
|
String
|
off
|
Controls the ability to remove duplicate data in a ZFS file system. Possible values are
on, off, verify, and
sha256[,verify]. The default checksum for deduplication is
sha256.
|
|
devices
|
Boolean
|
on
|
Controls whether device files in a file system can be opened.
|
|
encryption
|
Boolean
|
off
|
Controls whether a file system is encrypted. An encrypted file system means that data is
encoded and a key is needed by the file system owner to access the data.
|
|
exec
|
Boolean
|
on
|
Controls whether programs in a file system are allowed to be executed. Also, when set to
off, mmap(2) calls with PROT_EXEC are
disallowed.
|
|
keychangedate
|
String
|
none
|
Identifies the date of the last wrapping key change from a zfs key
–c operation for the specified file system. If no key change operation has occurred,
the value of this read-only property is the same as the file system's creation date.
|
|
keysource
|
String
|
none
|
Identifies the format and location of the key that wraps the file system keys. The valid
property values are raw, hex,
passphrase,prompt, or file. The key must be present
when the file system is created, mounted, or loaded by using the zfs key
–l command. If encryption is enabled for a new file system, the default
keysource is passphrase,prompt.
|
|
keystatus
|
String
|
none
|
Read-only property that identifies the file system's encryption key status. The availability
of a file system's key is indicated by available or
unavailable. For file systems that do not have encryption enabled,
none is displayed.
|
|
logbias
|
String
|
latency
|
Controls how ZFS optimizes synchronous requests for this file system. If
logbias is set to latency, ZFS uses the pool's separate log
devices, if any, to handle the requests at low latency. If logbias is set to
throughput, ZFS does not use the pool's separate log devices. Instead, ZFS
optimizes synchronous operations for global pool throughput and efficient use of resources. The
default value is latency.
|
|
mlslabel
|
String
|
None
|
See the multilevel property for a description of the behavior of the
mlslabel property on multilevel file systems. The following
mlslabel description applies to non-multilevel file systems.
Provides a sensitivity label that determines if a file system can be mounted in a
Trusted Extensions zone. If the labeled file system matches the labeled zone, the file system can be
mounted and accessed from the labeled zone. The default value is none. This
property can only be modified when Trusted Extensions is enabled and only with the appropriate
privilege.
|
|
mounted
|
Boolean
|
N/A
|
Read-only property that indicates whether a file system, clone, or snapshot is currently
mounted. This property does not apply to volumes. The value can be either yes or
no.
|
|
mountpoint
|
String
|
N/A
|
Controls the mount point used for this file system. When the
mountpoint property is changed for a file system, the file system and any
descendents that inherit the mount point are unmounted. If the new value is
legacy, then they remain unmounted. Otherwise, they are automatically remounted
in the new location if the property was previously legacy or
none, or if they were mounted before the property was changed. In addition, any
shared file systems are unshared and shared in the new location.
|
|
multilevel
|
Boolean
|
off
|
This property can only be used on a system with Trusted Extensions enabled. The default value
is off.
Objects in a multilevel file system are individually labeled with an explicit sensitivity
label attribute that is automatically generated. Objects can be relabeled in place by changing this
label attribute, by using the setlabel or setflabel
interfaces.
A root file system, an Oracle Solaris Zone file system, or a file system that contains
packaged Solaris code should not be multilevel.
There are differences in the mlslabel property on a multilevel file system.
The mlslabel value defines the highest possible label for objects in the file
system. An attempt to create a file at (or relabel a file to) a label higher than the
mlslabel value is not allowed. Mount policy based on the
mlslabel value does not apply to a multilevel file system.
For a multilevel file system, the mlslabel property can be set explicitly
when the file system is created. Otherwise, a default mlslabel property of
ADMIN_HIGH is automatically created. After creating a multilevel file system, the
mlslabel property can be changed, but it cannot be set to a lower label, set to
none, nor can it be removed.
|
|
primarycache
|
String
|
all
|
Controls what is cached in the primary cache (ARC). Possible values are
all, none, and metadata. If set to
all, both user data and metadata are cached. If set to none,
neither user data nor metadata is cached. If set to metadata, only metadata is
cached. When these properties are set on existing file systems, only new I/O is cache based on the
values of these properties. Some database environments might benefit from not caching user data. You
must determine if setting cache properties is appropriate for your environment.
|
|
nbmand
|
Boolean
|
off
|
Controls whether the file system should be mounted with nbmand
(Non-blocking mandatory) locks. This property is for SMB clients only. Changes to this property only
take effect when the file system is unmounted and remounted.
|
|
normalization
|
String
|
None
|
This property indicates whether a file system should perform a unicode 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 none, and the
utf8only property was left unspecified, the utf8only property
is automatically set to on. The default value of the
normalization property is none. This property cannot be
changed after the file system is created.
|
|
origin
|
String
|
N/A
|
Read-only property for cloned file systems or volumes that identifies the snapshot from which
the clone was created. The origin cannot be destroyed (even with the –r or
–f option) as long as a clone exists.
Non-cloned file systems have an origin of none.
|
|
quota
|
Number (or none)
|
none
|
Limits the amount of disk space a file system and its descendents can consume. This
property enforces a hard limit on the amount of disk space used, including all space consumed by
descendents, such as file systems and snapshots. Setting a quota on a descendent of a file system
that already has a quota does not override the ancestor's quota, but rather imposes an additional
limit. Quotas cannot be set on volumes, as the volsize property acts as an
implicit quota.
|
|
rekeydate
|
String
|
N/A
|
Read-only property that indicates the date of the last data encryption key change from a
zfs key
–K or zfs clone
–K operation on this file system. If no rekey operation has been
performed, the value of this property is the same as the creation date.
|
|
readonly
|
Boolean
|
off
|
Controls whether a dataset can be modified. When set to on, no
modifications can be made.
The property abbreviation is rdonly.
|
|
recordsize
|
Number
|
128K
|
Specifies a suggested block size for files in a file system.
|
|
referenced
|
Number
|
N/A
|
Read-only property that identifies the amount of data accessible by a dataset, which
might or might not be shared with other datasets in the pool.
When a snapshot or clone is created, it initially references the same amount of disk space as
the file system or snapshot it was created from, because its contents are identical.
The property abbreviation is refer.
|
|
refquota
|
Number (or none)
|
none
|
Sets the amount of disk space that a dataset can consume. This property enforces a hard
limit on the amount of space used. This hard limit does not include disk space used by descendents,
such as snapshots and clones.
|
|
refreservation
|
Number (or none)
|
none
|
Sets the minimum amount of disk space that is guaranteed to a dataset, not including
descendents, such as snapshots and clones. When the amount of disk space used is below this value,
the dataset is treated as if it were taking up the amount of space specified by
refreservation. The refreservation reservation is accounted
for in the parent dataset's disk space used, and counts against the parent dataset's quotas and
reservations.
If refreservation is set, a snapshot is only allowed if enough free pool
space is available outside of this reservation to accommodate the current number of
referenced bytes in the dataset.
The property abbreviation is refreserv.
|
|
reservation
|
Number (or none)
|
none
|
Sets the minimum amount of disk space guaranteed to a file system and its descendents.
When the amount of disk space used is below this value, the file system is treated as if it were
using the amount of space specified by its reservation. Reservations are accounted for in the parent
file system's disk space used, and count against the parent file system's quotas and
reservations.
The property abbreviation is reserv.
|
|
rstchown
|
Boolean
|
on
|
Indicates whether the file system owner can grant file ownership changes. The default is to
restrict chown operations. When rstchown is set to off, the
user has the PRIV_FILE_CHOWN_SELF privilege for chown
operations.
|
|
secondarycache
|
String
|
all
|
Controls what is cached in the secondary cache (L2ARC). Possible values are
all, none, and metadata. If set to
all, both user data and metadata are cached. If set to none,
neither user data nor metadata is cached. If set to metadata, only metadata is
cached.
|
|
setuid
|
Boolean
|
on
|
Controls whether the setuid bit is honored in a file system.
|
|
shadow
|
String
|
None
|
Identifies a ZFS file system as a shadow of the file system
described by the URI. Data is migrated to a shadow file system with this
property set from the file system identified by the URI. The file system to be migrated must be
read-only for a complete migration.
|
|
share.nfs
|
String
|
off
|
Controls whether an NFS share of a ZFS file system is created and published and what
options are used. You can also publish and unpublish an NFS share by using the zfs
share and zfs unshare commands. Using the zfs share
command to publish an NFS share requires that an NFS share property is also set. For information
about setting NFS share properties, see Sharing and Unsharing ZFS File
Systems.
|
|
share.smb
|
String
|
off
|
Controls whether a SMB share of a ZFS file system is created and published and what
options are used. You can also publish and unpublish an SMB share by using the zfs
share and zfs unshare commands. Using the zfs share
command to publish an SMB share require that an SMB share property is also set. For information
about setting SMB share properties, see Sharing and Unsharing ZFS File
Systems.
|
|
snapdir
|
String
|
hidden
|
Controls whether the .zfs directory is hidden or visible in the
root of the file system. For more information about using snapshots, see Overview of ZFS Snapshots.
|
|
sync
|
String
|
standard
|
Determines the synchronous behavior of a file system's transactions. Possible values
are:
-
standard, the default value, which means synchronous file system
transactions, such as fsync, O_DSYNC,
O_SYNC, and so on, are written to the intent log.
-
always, ensures that every file system transaction is
written and flushed to stable storage by a returning system call. This value has a significant
performance penalty.
-
disabled, means that synchronous requests are disabled. File system
transactions are only committed to stable storage on the next transaction group commit, which might
be after many seconds. This value gives the best performance, with no risk of corrupting the
pool.
Caution -
This disabled value is very dangerous because ZFS is ignoring the
synchronous transaction demands of applications, such as databases or NFS operations. Setting this
value on the currently active root or /var file system might result in
unexpected behavior, application data loss, or increased vulnerability to replay attacks. You should
only use this value if you fully understand all the associated risks.
|
|
|
type
|
String
|
N/A
|
Read-only property that identifies the dataset type as filesystem
(file system or clone), volume, or snapshot.
|
|
used
|
Number
|
N/A
|
Read-only property that identifies the amount of disk space consumed by a dataset and
all its descendents.
|
|
usedbychildren
|
Number
|
off
|
Read-only property that identifies the amount of disk space that is used by children of
this dataset, which would be freed if all the dataset's children were destroyed. The property
abbreviation is usedchild.
|
|
usedbydataset
|
Number
|
off
|
Read-only property that identifies the amount of disk space that is used by a dataset
itself, which would be freed if the dataset was destroyed, after first destroying any snapshots and
removing any refreservation reservations. The property abbreviation is
usedds.
|
|
usedbyrefreservation
|
Number
|
off
|
Read-only property that identifies the amount of disk space that is used by a
refreservation set on a dataset, which would be freed if the
refreservation was removed. The property abbreviation is
usedrefreserv.
|
|
usedbysnapshots
|
Number
|
off
|
Read-only property that identifies the amount of disk space that is consumed by
snapshots of a dataset. In particular, it is the amount of disk space that would be freed if all of
this dataset's snapshots were destroyed. Note that this value is not simply the sum of the
snapshots' used properties, because space can be shared by multiple snapshots.
The property abbreviation is usedsnap.
|
|
version
|
Number
|
N/A
|
Identifies the on-disk version of a file system, which is independent of the pool
version. This property can only be set to a later version that is available from the supported
software release. For more information, see the zfs upgrade command.
|
|
utf8only
|
Boolean
|
Off
|
This property indicates whether a file system should reject file names that include characters
that are not present in the UTF-8 character code set. If this property is explicitly set to
off, the normalization property must either not be explicitly
set or be set to none. The default value for the utf8only
property is off. This property cannot be changed after the file system is
created.
|
|
volsize
|
Number
|
N/A
|
For volumes, specifies the logical size of the volume.
|
|
volblocksize
|
Number
|
8 KB
|
For volumes, specifies the block size of the volume. The block size cannot be changed
after the volume has been written, so set the block size at volume creation time. The default block
size for volumes is 8 KB. Any power of 2 from 512 bytes to 128 KB is valid.
The property abbreviation is volblock.
|
|
vscan
|
Boolean
|
Off
|
Controls whether regular files should be scanned for viruses when a file is opened and closed.
In addition to enabling this property, a virus scanning service must also be enabled for virus
scanning to occur if you have third-party virus scanning software. The default value is
off.
|
|
zoned
|
Boolean
|
N/A
|
Indicates whether a file system has been added to a non-global zone. If this property is
set, then the mount point is not honored in the global zone, and ZFS cannot mount such a file system
when requested. When a zone is first installed, this property is set for any added file
systems.
|
|
xattr
|
Boolean
|
on
|
Indicates whether extended attributes are enabled ( on) or disabled
( off) for this file system.
|