1. Oracle ZFS Storage Appliance Administration Guide, Release OS8.8.x
  2. Shares and Projects
  3. File Retention Management
  4. Retention Period Settings

Retention Period Settings

The retention period settings restrict the time values for retaining a file, and they are used for both mandatory and privileged file retention. If a file is retained in a mandatory retention policy filesystem, the file's retention time also affects its share, project, and storage pool. The administrator must have the retentionPeriods role authorization.

If no value is entered for a period, it is assumed to be zero. When setting a value, also set the time measurement unit, such as seconds, minutes or years.

  • Minimum file retention period - The minimum amount of time for file retention. The default value is 0 (zero), and the value must be less than 100 years.

  • Maximum file retention period - The maximum amount of time for file retention, which must be less than 100 years. The default value is 5 years.

  • Default file retention period - The 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. After the default period has been met, the file cannot be modified, but it can be deleted. The default value must be between the minimum and maximum retention periods, inclusive. The default value is 0 (zero).

  • Automatic file retention grace period - The amount of time a file must remain unmodified before it is automatically retained. This is known as the automatic file retention grace period or automatic file retention. When the grace period expires, the file is automatically retained at the default retention period setting. The grace period is not constrained by either the minimum period nor the maximum period, and it can only be modified by a user with the retentionAuto authorization. However, after the grace period is enabled, it can only be shortened, never extended, for the share.