Project Properties

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

The following table shows Create Project properties.

Table 4-3 Create Project Properties

BUI Name	CLI Name	Property Type	Description
Name	project	Static	Defines the name of the project.
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 pool.
Key	key	Inherited	Sets a specific encryption key that is used when the key is not inherited from the parent pool.
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. Project filesystems inherit file retention properties when the project is created, and the properties are local to the project's filesystems. Therefore, if a project is later renamed, the filesystems still retain their originally inherited file retention properties.
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.
Delete expired files after	retention.period.deletegrace	Inherited	Number of seconds/hours/days/years that automatic file deletion is delayed when the file retention on expiry policy is set to delete. Default value: 0 days.
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 General - Space Usage - Data project properties.

Table 4-4 General - Space Usage - Data Project 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.
Reservation	reservation	Space management	Represents a guarantee of space that can be consumed by any particular entity.

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

Table 4-5 General - Space Usage - Users & Groups Project Properties

BUI Name	CLI Name	Property Type	Description
Default user quota	defaultuserquota	Space management	Sets a limit on the amount of space that can be consumed by the user.
Default group quota	defaultgroupquota	Space management	Sets a limit on the amount of space that can be consumed by the group.
User and group	users / groups	--	Specifies users and/or groups.
Usage	--	Space management	Shows the amount of data used by users and/or groups.

The following table shows General - Inherited Properties project properties.

Table 4-6 General - Inherited Project 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	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 project properties.

Table 4-7 General - Custom Project Properties

BUI Name	CLI Name	Property Type	Description
Schema	custom	--	Custom properties can be added as needed to attach user-defined tags to projects and shares. For more information, see Schema Properties.

The following table shows General - Default Settings - Filesystems project properties.

Table 4-8 General - Default Settings - Filesystems Project Properties

BUI Name	CLI Name	Property Type	Description
User	default_user	Creation default	Specifies a user ID or user name.
Group	default_group	Creation default	Specifies a group ID or group name.
Permissions	default_permissions	Creation default	Sets the default permissions for filesystem.

The following table shows General - Default Settings - LUNs project properties.

Table 4-9 General - Default Settings - LUNs Project Properties

BUI Name	CLI Name	Property Type	Description
Volume size	default_volsize	LUN only, creation default	Shows the maximum volume size and unit of measurement. For more information, see Volume size.
Thin provisioned	default_sparse	LUN only, creation default	Indicates only the amount of space physically consumed by data is used when selected. For more information, see Thin provisioned.
Volume block size	default_volblocksize	Creation default	Shows the native block size for LUNs and can be set from 512 bytes to 1M; the default is 8K. For more information, see Volume block size.

The following table shows Bandwidth project properties.

Table 4-10 Bandwidth Project Properties

BUI Name	CLI Name	Property Type	Description
Read limit	readlimit	--	Sets the maximum bytes per second that can be read from a share. M indicates megabytes and G indicates gigabytes. The default setting is unlimited, which provides no I/O throttling.
Write limit	writelimit	--	Sets the maximum bytes per second that can written to a share. M indicates megabytes and G indicates gigabytes. The default setting is unlimited, which provides no I/O throttling.
Effective read limit	effectivewritelimit	--	Read-only property that reports the lowest read limit for a share.
Effective write limit	effectivewritelimit	--	Read-only property that reports the lowest write limit for a share.

The following table shows Protocols - NFS project 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-11 Protocols - NFS Project 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 project 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-12 Protocols - SMB Project 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 - HTTP (Inherit from project) project properties.

Table 4-13 Protocols - HTTP (Inherit from project) Project 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) project properties.

Table 4-14 Protocols - FTP (Inherit from project) Project 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) project properties.

Table 4-15 Protocols - SFTP (Inherit from project) Project 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) project properties.

Table 4-16 Protocols - TFTP (Inherit from project) Project 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 project properties.

Table 4-17 Access Project 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 Snapshots - Properties project properties.

Table 4-18 Snapshots - Properties Project 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 project properties.

Table 4-19 Snapshots - Snapshots Project Properties

BUI Name	CLI Name	Property Type	Description
Name	snapshot name	--	Specifies the name of the snapshot.
Creation	creation	--	Specifies the date and time when the snapshot is created.
Unique	space_unique	--	Indicates the amount of unique space used by the snapshot.
Total	space_data	--	Indicates the total amount of space referenced by the snapshot.

The following table shows Snapshots - Schedules project properties.

Table 4-20 Snapshots - Schedules Project 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 project properties.

Table 4-21 Replication (Inherit from project)/Create New Actions Project 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	--	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.