Object Store Properties

Object Store properties

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

The following table shows Create Object Store properties.

Table 4-54 Create Object Store Properties

BUI Name	CLI Name	Property Type	Description
Project	select	--	Defines which project the Object Store uses to inherit parameter settings.
Name	--	--	Defines the name of the Object Store.
User	root-user	Filesystem local	Specifies the owner of the root directory.
Endpoint	--	Object Store local	Indicates only the amount of space physically consumed by data is used when selected. For more information, see Thin provisioned.
Reject non UTF-8	utf8only	Create time	Enforces UTF-8 encoding for all object stores and directories. For more information, see Reject non UTF-8.
Object store protocol	space_reclamation	Object Store local	Indicates if thin provisioned Object Store free space is returned to the storage pool. For more information, see Space Reclamation.
Object store mode	volblocksize	Create time	Native block size for the Object Store; any power of 2 from 512 bytes to 1M, and the default is 8K.
Case sensitivity	casesensitivity	Object Store local	Object Stores are case-sensitive.
Normalization	normalization	Create time	Controls which unicode normalization, if any, is performed on Object Stores 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.
Unicode version	Object Storeguid	Read-only, Object Store local	A globally unique, read-only identifier that identifies the SCSI device.

The following table shows General - Space Usage - Data Object Store properties.

Table 4-55 General - Space Usage - Data Object Store 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 - Object Store (Inherit from project) Object Store properties.

Table 4-56 General - Space Usage - Users & Groups 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 - Bandwidth Properties Object Store properties.

Table 4-57 General - Bandwidth Properties

BUI Name	CLI Name	Property Type	Description
Read limit	readlimit	Inherited	Specifies a read limit for this Object Share (in terms of amount of data transferred over the network per second).
Write limit	writelimit	Inherited	Specifies a write limit for this Object Share (in terms of amount of data transferred over the network per second).

The following table shows General - Object Store Protocol (Inherit from project) Object Store properties..

Table 4-58 General - Object Store Protocol Properties

BUI Name	CLI Name	Property Type	Description
OCI object store protocol	rw,ro, or off	Inherited	Specifies a mode for this Object Share (in terms of amount of data transferred over the network per second).

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

BUI Name	CLI Name	Property Type	Description
Mountpoint	mountpoint	Inherited	Controls the path used to export Object Store. For more information, see Mountpoint.
Read only	readonly	Inherited	Controls whether the Object Store 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 Custom Properties Object Store properties.

Table 4-59 Custom Properties (Inherit from Project) Object Store Properties

BUI Name	CLI Name	Property Type	Description
Integer Value	int	--	Custom properties can be added as needed to attach user-defined tags to projects and shares. For more information, see Working with Schemas.

The following table shows Access - Root Directory Access Object Store properties.

Table 4-60 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) Object Store properties.

Table 4-61 Access - ACL Behavior (Inherit from project) Object Store 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 Object Store properties.

Table 4-62 Access - Root Directory ACL Object Store Properties

BUI Name	CLI Name	Property Type	Description
Type	--	--	Indicates the type of the ACL.
Target	--	--	n/a
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) Object Store properties.

Table 4-63 Snapshots - Properties (Inherit from project) Object Store Properties

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

The following table shows Snapshots - Schedule Object Store properties.

Table 4-64 Snapshots - Schedule Object Store 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.
Retention	snapret_enabled	Inherited	Controls the number of snapshots retained.

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

Table 4-65 Replication (Inherit from project)/Create New Actions Object Store 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 TSL-encryption	encryption	Inherited	Controls whether to encrypt data on the wire using TSL.
Disable compression	compression	Inherited	Controls whether the compression is enabled or disabled.
Disable raw crypto mode	encryption	Inherited	Controls whether the end-to-end encryption is enabled or disabled.
Enable deduplication	dedup	Inherited	Controls whether the deduplication 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.
Replication Schedules	replication	Inherited	Controls the frequency for replication schedules.