Editing a Snapshot Retention Policy (BUI)

Use the following procedure to edit a snapshot retention policy for a filesystem, LUN, or project. Snapshot retention policies are included in both manual snapshots and in automatic snapshot schedules.

After an automatic snapshot with a retention hold has been generated, it is not possible to delete or modify its schedule until all snapshots with a retention hold have expired.

To use the snapshot retention hold feature, apply deferred update "Support for Snapshot Retention." For information about deferred updates, see Deferred Updates in Oracle ZFS Storage Appliance Customer Service Manual, Release OS8.8.x.

The following user role authorizations are required to make changes to a retention policy:

• Modify a manual snapshot to a stricter hold type (off to unlocked): retainSnap

• Modify a manual snapshot to a less strict hold type (unlocked to off): releaseSnapRetention

• Modify an automatic snapshot schedule: scheduleSnap

• Modify the retention hold value for an automatic snapshot: releaseSnapRetention

For information on editing authorizations for a role, see Editing Authorizations for a Role (BUI). To delete an automatic snapshot schedule, see Removing a Snapshot Schedule (BUI).

1. Go to the appropriate project or share.
   1. If the schedule applies to a project: From the Shares menu, select Projects.
   2. If the schedule applies to a filesystem: From the Shares menu, select Shares.
   3. If the schedule applies to a LUN: From the Shares menu, select Shares, then LUNs.
2. Hover over the appropriate project or share, and click the edit icon .
3. Select the check box for Enable retention policy for Scheduled Snapshots to set a retention policy. To not set a retention policy, clear the check box.
4. Click the Snapshots tab.
5. For a manual snapshot and to change the retention policy, change the retention hold type off to unlocked, or unlocked to off, as appropriate.

   If the snapshot is a project snapshot, this setting also applies to all of its shares.

6. For an automatic snapshot, click Schedules.
7. Clear the Keep at most check box to not set a retention policy. To change the retention policy value, set the Keep at most property to the number of snapshots to keep before older snapshots are automatically deleted.

   If the schedule includes snapshots with a retention hold, the Keep at most property can only be changed to a higher value. If no automatic snapshots have been generated with this schedule, or none of the snapshots have a retention hold, the Keep at most property can be set to a lower value. If the snapshot is a project snapshot, this setting also applies to all of its shares.

8. To change the retention hold if the retention hold type is off, set the Retention property to locked, and edit the retention hold value for the schedule.

   The following guidelines apply to automatic snapshots:

   • If the retention hold type is locked, you cannot edit the Retention property. When all locked snapshots for this schedule have exceeded the Keep at most property value, the retention hold value changes from locked to off.

   • The number for the Retention property must be the same or smaller than the number for the Keep at most property.

   • If automatic snapshots containing a retention hold have been generated with this schedule, the retention hold must be set to a higher value to prevent early lock removal, but not higher than the Keep at most property.

   • If no automatic snapshots have been generated with this schedule, the retention hold can be set to a lower value.

   • If the snapshot is a project snapshot, this setting also applies to all of its shares.