Skip to main content

volume snaplock modify

Contributors
Suggest changes
PDFs

Modify SnapLock attributes of a SnapLock volume

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The ` volume snaplock modify ` command modifies one or more SnapLock attributes of a SnapLock volume.

Parameters

-vserver <vserver name> - Vserver

This specifies the vserver which owns the required SnapLock volume.

-volume <volume name> - Volume

This specifies the SnapLock volume whose attribute needs to be modified.

[-minimum-retention-period {{<integer> seconds|minutes|hours|days|months|years} | infinite}] - Minimum Retention Period

Specifies the minimum allowed retention period for files committed to WORM state on the volume. Any files committed with a retention period shorter than this minimum value, is assigned this minimum value.

If this option value is infinite , then every file committed to the volume will have a retention period that never expires.

Otherwise, the retention period is specified as a number followed by a suffix. The valid suffixes are seconds, minutes, hours, days, months, and years. For example, a value of 6months represents a retention period of 6 months. The maximum allowed retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file.

[-default-retention-period {{<integer> seconds|minutes|hours|days|months|years} | min | max | infinite | unspecified}] - Default Retention Period

Specifies the default retention period that is applied to files while committing to WORM state without an associated retention period.

If this option value is min , then minimum-retention-period is used as the default retention period. If this option value is max , then maximum-retention-period is used as the default retention period. If this option value is infinite , then a retention period that never expires will be used as the default retention period. If this option value is unspecified , then the file will be retained forever; however, the retention time can be changed to an absolute value.

The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are seconds, minutes, hours, days, months, and years. For example, a value of 6months represents a retention period of 6 months. The maximum valid retention period is 70 years.

[-maximum-retention-period {{<integer> seconds|minutes|hours|days|months|years} | infinite}] - Maximum Retention Period

Specifies the maximum allowed retention period for files committed to WORM state on the volume. Any files committed with a retention period longer than this maximum value, is assigned this maximum value.

If this option value is infinite , then files that have retention period that never expires might be committed to the volume.

Otherwise, the retention period is specified as a number followed by a suffix. The valid suffixes are seconds, minutes, hours, days, months, and years. For example, a value of 6months represents a retention period of 6 months. The maximum allowed retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file.

[-autocommit-period {{<integer> minutes|hours|days|months|years} | none}] - Autocommit Period

Specifies the autocommit period for SnapLock volume. All files which are not modified for a period greater the autocommit period of the volume are committed to WORM state.

The autocommit period option is specified as a number followed by a suffix. The valid suffixes for autocommit period are hours, minutes, days, months and years. For example, a value of 2hours represents an autocommit period of 2 hours. The minimum allowed autocommit period is 5 minutes and the maximum allowed autocommit period is 10 years.

If this option value is none , then autocommit is disabled on the SnapLock volume.

[-is-volume-append-mode-enabled {true|false}] - Is Volume Append Mode Enabled

Specifies if the volume append mode is enabled or disabled.

It can be modified only when the volume is not mounted and does not have any data or Snapshot copies.

The volume append mode is not supported on SnapLock audit log volumes.

When it is enabled, all the files created with write permissions on the volume are WORM appendable files by default. All the WORM appendable files that are not modified for a period greater than the autocommit period of the volume are also committed to the WORM read-only state.

If it is set to true , then the volume append mode is enabled.

If it is set to false , then the volume append mode is disabled.

Volume append mode is disabled by default when the volume is created.

[-privileged-delete {disabled|enabled|permanently-disabled}] - Privileged Delete

Specifies the privileged-delete attribute of a SnapLock volume. This parameter must be specified alone.

If it is set to enabled then the privileged-delete operation can be performed using the volume file privileged-delete command.

If it is set to disabled , then the privileged-delete operation is not supported.

Once it is set to permanently-disabled , then neither the privileged-delete operation nor any change in the volume privileged-delete attribute is permitted.

Examples

The following command sets -default-retention-period of a given SnapLock volume:

cluster1::> volume snaplock modify -volume vol_slc -default-retention-period 2years

cluster1::>

The following command sets -maximum-retention-period of a given SnapLock volume to infinite :

cluster1::> volume snaplock modify -volume vol_slc -maximum-retention-period infinite

cluster1::>

The following command enables the privileged-delete operation on a SnapLock volume.

cluster1::> volume snaplock modify -vserver vs1 -volume vol_sle -privileged-delete enabled
[Job 38] Job succeeded: Privileged-delete Attribute Change for Volume "vs1:vol_sle" Completed.
cluster1::>
cluster1::>volume snaplock show -vserver vs1 -volume vol_sle -fields privileged-delete
vserver volume   privileged-delete
------- -------- -----------------
vs1     vol_sle  enabled

cluster1::>