Skip to main content

snaplock legal-hold dump-files

Contributors
Suggest changes
PDFs

Dump list of files under legal-hold to specified output path.

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

Description

The snaplock legal-hold dump-files is used to dump the list of files under legal-hold for a given vserver, volume and litigation to an auto-generated file in the user specified path. Only a user with security login role vsadmin-snaplock is allowed to perform this operation.

Parameters

-vserver <vserver name> - Vserver Name

Specifies the name of the Vserver for which the list of files under legal-hold is to be dumped.

-litigation-name <text> - Litigation Name

Specifies the name of the litigation for which the list of files under legal-hold is to be dumped.

-volume <volume name> - Volume Name

Specifies the name of the SnapLock compliance volume for which the list of files under legal-hold is to be dumped.

-output-volume <volume name> - Output Volume Name

Specifies the name of the output volume containing the output directory path where the list of files under legal-hold is to be dumped. The output volume must be a regular read-write volume.

-output-directory-path <text> - Path Relative to Output Volume Root

Specifies the output directory path relative to the output volume root, where the list of files under legal-hold is to be dumped. The output directory path should be of the form "/directory-path". If output needs to be dumped on the volume root, specify the path as "/".

Examples

The following example starts a legal-hold dump-files operation:

vs1::> snaplock legal-hold dump-files -volume vol1_slc -litigation-name lit1 -output-volume vol1 -output-directory-path /d1
            SnapLock legal-hold dump-files operation is queued. Run "snaplock legal-hold show -operation-id 16842754 -instance" to view the operation status.
            vs1::>