Skip to main content

snaplock legal-hold dump-litigations

Contributors
Suggest changes
PDFs

Dump list of litigations for a given Vserver 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-litigations is used to dump the list of litigations for a given vserver to a user specified path. Under the user specified path, we create a directory with a unique name. Under the user specified path, a directory with an auto-generated name is created. Under this directory, multiple files are created. Each file represents a unique litigation name that was found in the given vserver. Each file contains a list of volume names that have files under legal-hold for that given litigation. For example, if the file name is "lit1" and the contents of the file are "volume1" and "volume2", then it indicates that both these volumes have files under legal-hold for litigation "lit1". 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 litigations is to be dumped.

[-volume <volume name>] - Volume Name

If this parameter is specified, the command displays the list of litigations for volume that matches the specified value. The volume must be of type SnapLock compliance.

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

Specifies the name of the output volume containing the output directory path where the list of litigations 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 volume root, where the list of litigations is to be dumped. The output directory path should be of the form "/directory-path". If output needs to be dumped to the volume root, specify the path as "/".

Examples

The following example starts a legal-hold dump-litigations job:

vs1::> snaplock legal-hold dump-litigations -output-volume vol1 -output-directory-path /d1
            Dump Litigations job for Vserver "vs1" has been queued. Run "job show -id 22 -instance" to view the status.
            vs1::>