1. Oracle ZFS Storage Appliance Administration Guide, Release OS8.8.x
  2. Shares and Projects
  3. File Retention Management
  4. Creating a Filesystem or Project with File Retention

Creating a Filesystem or Project with File Retention

File retention is set at file creation, and a filesystem inherits this setting from its project if retention was set at the project level. Therefore, set retention when creating a new project or when creating a new filesystem within an unretained project. The available settings for the file retention policy are as follows:

  • Disabled - No file retention policy is set. This is the default setting.
  • Privileged override - Allows a user with the retentionPeriods role authorization to override the retention periods, except the grace period, for both mandatory and privileged file retention. Although a file cannot be retained for less than the minimum period, a user could change the other periods backwards, such that the file could be deleted earlier than originally set. The retention period can also be extended, but not beyond the maximum retention period setting.
  • Mandatory (no override) - A filesystem with mandatory retention cannot be deleted before the retention period expires, and the retention period cannot be modified or overridden.

While creating file retention, set the retention period properties described in Retention Period Settings. In the BUI, these properties are located under the ACCESS tab. In the CLI, use the get command at the filesystem or project level to see the retention period properties. Set a value and a time measurement; no entry is the same as a zero-value entry.

Optionally, set the file retention on expiry policy at the project or filesystem level. This policy allows automatic deletion after file retention expiry or sets the file retention to an indefinite hold after expiry. In addition, the property retention.period.deletegrace can be set to the amount of time to delay automatically deleting the files. To remove a hold, set the policy to other than hold. The default setting is off and no action occurs after the file's retention expires. User authorization retentionOnexpiry is required to set property retention.policy.onexpiry. In the BUI, this property is located under the ACCESS tab. In the CLI, use the get command at the filesystem or project level to see the policy property. For information, see File Retention on Expiry Policy.

Optionally, set the file ACL/permission changes policy at the project or filesystem level. In the BUI, the property is located under the ACCESS tab. In the CLI, use the get command at the filesystem or project level to see the policy property. When set to on, property retention.policy.changeacl allows you to change ACL settings or file permissions, other than write, on a retained file. Thus, if the ACL or permissions were set incorrectly when a file was initially retained, this policy allows you to change those settings.

Manual file retention is accomplished in one of four ways:

  • The file is retained after the minimum retention period if no maximum and/or default period was set.
  • The file is retained after the maximum retention period if no minimum and/or default period was set.
  • The file is retained after the default retention period if a minimum and/or maximum period was not set.
  • For a file with automatic file retention set, the file can be manually retained if the minimum retention period is set to a lower value than the (automatic file retention) grace period, and the default period is set to a higher value than the grace period.