Filesystem Properties

In the CLI, use the get command to see a list of all properties.

The following table shows Create Filesystem properties.

Table 4-22 Create Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Project	`select project_name`	--	Defines which project the filesystem uses to inherit parameter settings. You can also select the default project.
Name	`filesystem`	--	Defines the name of the filesystem.
Data migration source	`shadow`	Create time	Shows the location of the source if you are migrating data.
User	`root-user`	Filesystem local	Specifies the owner of the root directory.
Group	`root_group`	Filesystem local	Specifies the group of the root directory.
Permissions or Use Windows default permissions	`root_permission`	Filesystem local	Specifies standard UNIX permissions for the root directory, or Windows default permissions.
Inherit mountpoint	`--`	--	Indicates the mountpoint is inherited if selected.
Mountpoint	`mountpoint`	Inherited	Controls the path used to export filesystems. For more information, see Mountpoint.
Reject non UTF-8	`utf8only`	Create time	Enforces UTF-8 encoding for all filesystems and directories. For more information, see Reject non UTF-8.
Case sensitivity	`casesensitivity`	Create time	Controls whether directory lookups are case-sensitive, case-insensitive, or mixed. For more information, see Case sensitivity.
Normalization	`normalization`	Create time	Controls which unicode normalization, if any, is performed on filesystems and directories. For more information, see Normalization.
Encryption	`encryption`	Inherited	Defines the encryption type. For more information see, Managing Encryption Keys.
Inherit key	`--`	--	If selected, indicates that the encryption key is inherited from the parent project.
Key	`key`	Inherited	Sets a specific encryption key that is used when the key is not inherited from the parent project.
Keyname	`keyname`	Static	Identifies the key.
File retention policy	`retention.policy`	Inherited	Sets one of the following options: Disabled (default): No file retention policy is set. Privileged override: Sets the privileged file retention policy. Mandatory (no override): Sets the mandatory file retention policy.

The following table shows General - Space Usage - Data filesystem properties.

Table 4-23 General - Space Usage - Data Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Quota	`quota`	Space management	Sets a limit on the amount of space that can be consumed by any particular entity.
Quota Include snapshots	`quota_snap`	Space management	Sets a limit on the amount of space that can be consumed by any particular entity including the snapshots.
Reservation	`reservation`	Space management	Represents a guarantee of space that can be consumed by any particular entity.
Reservation Include snapshots	`reservation_snap`	Space management	Represents a guarantee of space that can be consumed by any particular entity including the snapshots.

The following table shows General - Space Usage - Users & Groups filesystem properties.

Table 4-24 General - Space Usage - Users & Groups Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Users & Groups	`--`	--	Specifies the users and/or groups.
Usage	`--`	--	Shows the amount of data used by the users and/or groups.
Quota	`quota`	Space management	Sets a limit on the amount of space that can be consumed by any particular entity.

The following table shows General - Properties (Inherit from project) filesystem properties.

Table 4-25 General - Properties (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Mountpoint	`mountpoint`	Inherited	Controls the path used to export filesystems. For more information, see Mountpoint.
Read only	`readonly`	Inherited	Controls whether the filesystem contents are read only. For more information, see Read only.
Update access time on read	`atime`	Inherited	Controls whether the access time for files is updated on read. For more information, see Update access time on read.
Non-blocking mandatory locking	`nbmand`	inherited	Controls whether SMB locking semantics are enforced over POSIX semantics. For more information, see Non-blocking mandatory locking.
Data deduplication (warning)	`dedup`	Inherited	Controls whether duplicate copies of data are eliminated. For more information, see Data Deduplication.
Data compression	`compression`	Inherited	Controls whether data is compressed before being written to disk. For more information, see Data Compression.
Checksum	`checksum`	Inherited	Controls the checksum used for data blocks. For more information, see Checksum.
Cache device usage	`secondarycache`	Inherited	Controls whether cache devices are used for the share. For more information, see Cache device usage.
Synchronous write bias	`logbias`	Inherited	Controls the behavior when servicing synchronous writes. For more information, see Synchronous write bias.
Database record size	`recordsize`	Inherited	Specifies a suggested block size for files in the filesystem. For more information, see Database record size.
Additional Replication	`copies`	Inherited	Controls number of copies stored of each block, above and beyond any redundancy of the storage pool. For more information, see Additional replication.
Virus scan	`vscan`	Inherited	Controls whether a filesystem is scanned for viruses. For more information, see Virus scan.
Prevent destruction	`nodestroy`	Inherited	Prevents shares or projects from being destroyed when set. For more information, see Prevent destruction. For preventing destruction at the storage pool level, see Destroy Prevention and Approval.
Restrict ownership change	`rstchown`	Inherited	Controls the ownership and can be turned off on a per-filesystem or per-project basis. For more information, see Restrict ownership change.

The following table shows General - Custom Properties (Inherit from Project) filesystem properties.

Table 4-26 General - Custom Properties (Inherit from Project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
--	`custom`	--	Custom properties can be added as needed to attach user-defined tags to projects and shares.

The following table shows Protocols - NFS filesystem properties.

Exceptions to the overall sharing modes may be defined for clients or collections of clients. For more information, see NFS Protocol Share Mode Exceptions.

Table 4-27 Protocols - NFS Filesystem Properties

BUI Name	CLI Name	Property Type	Description
NFS	`sharenfs`	Inherited	NFS Protocol property settings and values are described in NFS Protocol Properties.

The following table shows Protocols - SMB filesystem properties.

Exceptions to the overall sharing modes may be defined for clients or collections of clients. For more information, see SMB Protocol Share Mode Exceptions.

Table 4-28 Protocols - SMB Filesystem Properties

BUI Name	CLI Name	Property Type	Description
SMB	`sharesmb`	Inherited	SMB Protocol property settings and values are described in SMB Protocol Properties.

The following table shows Protocols - Share Level ACL filesystem properties.

Table 4-29 Protocols - Share Level ACL Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Type	--	--	Indicates the type of the ACL.
Target	--	--	Indicates the target for the ACL.
Access	--	--	Indicates whether the ACL access is allowed or denied.
Permissions: Inheritance	--	--	Specifies standard UNIX permissions for the ACL.

The following table shows Protocols - HTTP (Inherit from project) filesystem properties.

Table 4-30 Protocols - HTTP (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Share mode	`sharedav`	Inherited	Determines whether the share is available for reading only, for reading and writing, or neither. In the CLI, `on` is an alias for `rw`.

The following table shows Protocols - FTP (Inherit from project) filesystem properties.

Table 4-31 Protocols - FTP (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Share mode	`shareftp`	Inherited	Determines whether the share is available for reading only, for reading and writing, or neither. In the CLI, `on` is an alias for `rw`.

The following table shows Protocols - SFTP (Inherit from project) filesystem properties.

Table 4-32 Protocols - SFTP (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Share mode	`sharesftp`	Inherited	Determines whether the share is available for reading only, for reading and writing, or neither. In the CLI, `on` is an alias for `rw`.

The following table shows Protocols - TFTP (Inherit from project) filesystem properties.

Table 4-33 Protocols - TFTP (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Share mode	`sharetftp`	Inherited	Determines whether the share is available for reading only, for reading and writing, or neither. In the CLI, `on` is an alias for `rw`.

The following table shows Access - File Retention Policy (Inherit from project) filesystem properties.

Table 4-34 Access - File Retention Policy (Inherit from Project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Minimum file retention period	`retention.period.min`	Inherited	Minimum amount of time for file retention. Set a value and time measurement. Default value is `0` (zero), and the value must be less than 100 years.
Maximum file retention period	`retention.period.max`	Inherited	Maximum amount of time for file retention. Set a value and time measurement. Default value is `5 years`, and the value must be less than 100 years.
Default file retention period	`retention.period.default`	Inherited	Default amount of time for which a file is retained if it is automatically retained, or retained manually without first changing the file's access time attribute. Set a value and time measurement. Default value is `0` (zero), and the value must be between the minimum and maximum retention periods, inclusive.
Automatic file retention grace period	`retention.period.grace`	Inherited	Amount of time a file must remain unmodified before it is automatically retained at the default file retention period value. Set a value and time measurement. The grace period is not constrained by either the minimum period nor the maximum period.
File retention on expiry policy	`retention.policy.onexpiry`	Inherited	Determines behavior when file retention expires. Sets one of the following options: Off (default): The file is not affected, and it remains on the system after retention expires. Delete: The file is deleted after expiration has been met. Hold: The file transitions to an indefinite hold. The file cannot be deleted until set to `off` or `delete`.
Allow permission changes on retained files	`retention.policy.changeacl`	Inherited	Determines if a retained file's ACL/permissions can be changed. Default value is `off` and the file's ACL/permissions cannot be changed. When set to `on`, the ACL settings/permissions, other than write, can be changed on a retained file.

The following table shows Access - Root Directory Access filesystem properties.

Table 4-35 Access - Root Directory Access Filesystem Properties

BUI Name	CLI Name	Property Type	Description
User	`root_user`	Filesystem local	Specifies the owner of the root directory.
Group	`root_group`	Filesystem local	Specifies the group of the root directory.
Permissions	`root_permissions`	Filesystem local	Specifies standard UNIX permissions for the root directory.

The following table shows Access - ACL Behavior (Inherit from project) filesystem properties.

Table 4-36 Access - ACL Behavior (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
ACL behavior on mode change	`aclmode`	Inherited	Controls how a mode change request interacts with the existing ACL.
ACL inheritance behavior	`aclinherit`	Inherited	Controls how a new file or directory inherits existing ACL settings from the parent directory.

The following table shows Access - Root Directory ACL filesystem properties.

Table 4-37 Access - Root Directory ACL Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Type	--	--	Indicates the type of the ACL.
Target	--	--	Indicates the target of the ACL.
Access	--	--	Indicates whether the ACL access is allowed or denied.
Permissions:Inheritance	--	--	Specifies standard UNIX permissions for the ACL.

The following table shows Snapshots - Properties (Inherit from project) filesystem properties.

Table 4-38 Snapshots - Properties (Inherit from project) Filesystem Properties

BUI Name	CLI Name	Property Type	Description
.zfs/snapshot visibility	`snapdir`	Inherited	Controls whether filesystem snapshots can be accessed over data protocols at `.zfs/snapshot` in the root of the filesystem.
Scheduled snapshot label	`snaplabel`	Inherited	Appends a user-defined label to each scheduled snapshot and is blank by default.

The following table shows Snapshots - Snapshots filesystem properties.

Table 4-39 Snapshots - Snapshots Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Name	--	--	Specifies the name of the snapshot.
Creation	--	--	Specifies the date and time when the snapshot is created.
Unique	--	--	Indicates the amount of unique space used by the snapshot.
Total	--	--	Indicates the total amount of space referenced by the snapshot. This represents the size of the filesystem at the time the snapshot was taken, and any snapshot can theoretically take up an amount of space equal to the total size as data blocks are rewritten.
Clones	--	--	Shows the number of clones of the snapshot.

The following table shows Snapshots - Schedule filesystem properties.

Table 4-40 Snapshots - Schedule Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Frequency	`frequency`	Create time	Indicates how often the snapshot is taken.
Keep at most	`keep`	Create time	Controls the retention policy for snapshots.

The following table shows Replication (Inherit from project)/Create New Actions filesystem properties.

Table 4-41 Replication (Inherit from project)/Create New Actions Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Target	`target`	Inherited	Identifies the replication target system.
Pool	`pool`	Inherited	Specifies the storage pool on the target where the project will be replicated.
Export data path	`export_path`	Inherited	Indicates the export data path.
Limit bandwidth	`max_bandwidth`	Inherited	Specifies a maximum speed for this replication update (in terms of amount of data transferred over the network per second).
Enable SSL-encryption	`use_ssl`	Inherited	Controls whether to encrypt data on the wire using SSL.
Disable compression	`compression`	Inherited	Controls whether the compression is enabled or disabled.
Include snapshot	`include_snaps`	Inherited	Controls whether replication updates include non-replication snapshots.
Retain user snapshots on target	`retain_user_snaps_on_target`	Inherited	When set, keeps user-generated snapshots on the replication target. Continues to retain snapshots on the target until disabled.
Include clone origin as data	`include_clone_origin_as_data`	Inherited	Controls the replication of each share that was cloned from a share that is external to the replication package on the target.
Recovery point objective	`recovery_point_objective`	Inherited	Specifies the maximum tolerable amount of data loss in the event of a disaster or major outage.
Replica lag warning alert	`replica_lag_warning_alert`	Inherited	Specifies a limit, represented as a percentage of the RPO, when a minor alert is generated.
Replica lag error alert	`replica_lag_error_alert`	Inherited	Specifies a limit, represented as a percentage of the RPO, when a major alert is generated.
Update frequency	`continuous`	Inherited	Controls whether this action is being replicated continuously or at manual or scheduled intervals.

The following table shows Usage filesystem properties.

Table 4-42 Usage Filesystem Properties

BUI Name	CLI Name	Property Type	Description
Referenced data	`space_data`	Read-only	Shows the total amount of space referenced by the active share, independent of any snapshots.
Unused Reservation	`space_unused_res`	Read-only	Shows the amount of remaining space that is reserved for the filesystem.
Snapshot data	`space_snapshots`	Read-only	Shows the total amount of data currently held by all snapshots of the share.
Available data	`space_available`	Read-only	Shows any quotas on the share or project, or the absolute capacity of the pool.
Total space	`space_total`	Read-only	Shows the sum of referenced data, snapshot data, and unused reservation.