Set the default retention period

Contributors

You can use the volume snaplock modify command to set the default retention period for files on a SnapLock volume.

What you’ll need

The SnapLock volume must be online.

About this task

The following table shows the possible values for the default retention period option:

Note

The default retention period must be greater than or equal to (>=) the minimum retention period and less than or equal to (<=) the maximum retention period.

Value Unit Notes

0 - 65535

seconds

0 - 24

hours

0 - 365

days

0 - 12

months

0 - 70

years

max

-

Use the maximum retention period.

min

-

Use the minimum retention period.

infinite

-

Retain the files forever.

unspecified

-

Retain the files until an absolute retention period is set.

The values and ranges for the maximum and minimum retention periods are identical, except for max and min, which are not applicable. For more information about this task, see Set the retention time overview.

You can use the volume snaplock show command to view the retention period settings for the volume. For more information, see the man page for the command.

Note

After a file has been committed to the WORM state, you can extend but not shorten the retention period.

Steps
  1. Set the default retention period for files on a SnapLock volume:

    volume snaplock modify -vserver SVM_name -volume volume_name -default-retention-period default_retention_period -minimum-retention-period min_retention_period -maximum-retention-period max_retention_period

    For a complete list of options, see the man page for the command.

    Note

    The following examples assume that the minimum and maximum retention periods have not been modified previously.

    The following command sets the default retention period for a Compliance or Enterprise volume to 20 days:

    cluster1::> volume snaplock modify -vserver vs1 -volume vol1 -default-retention-period 20days

    The following command sets the default retention period for a Compliance volume to 70 years:

    cluster1::> volume snaplock modify -vserver vs1 -volume vol1 -maximum-retention-period 70years

    The following command sets the default retention period for an Enterprise volume to 10 years:

    cluster1::> volume snaplock modify -vserver vs1 -volume vol1 -default-retention-period max -maximum-retention-period 10years

    The following commands set the default retention period for an Enterprise volume to 10 days:

    cluster1::> volume snaplock modify -vserver vs1 -volume vol1 -minimum-retention-period 10days
    cluster1::> volume snaplock modify -vserver vs1 -volume vol1 -default-retention-period min

    The following command sets the default retention period for a Compliance volume to infinite:

    cluster1::> volume snaplock modify -vserver vs1 -volume vol1 -default-retention-period infinite -maximum-retention-period infinite