Skip to main content
ONTAP commands
A newer release of this product is available.

snaplock legal-hold show

Suggest changes
PDFs

Show status of a legal-hold operation.

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

Description

The snaplock legal-hold show command displays the status of a legal-hold operation. Information about completed operations will be cleaned up after an hour of completion. Only a user with security login role vsadmin-snaplock is allowed to perform this operation.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-vserver <vserver name>] - Vserver Name

If this parameter is specified, the command displays all legal-hold operations that match the specified Vserver.

[-operation-id <integer>] - Operation ID

If this parameter is specified, the command displays all legal-hold operations that match the specified operation ID.

[-volume <volume name>] - Volume Name

If this parameter is specified, the command displays all legal-hold operations that match the specified volume. The parameter specifies the volume on which legal-hold operation is running or has completed.

[-path <text>] - Path

If this parameter is specified, the command displays all legal-hold operations that match the specified path. The parameter specifies the path on which legal-hold operation is running or has completed.

[-litigation-name <text>] - Litigation Name

If this parameter is specified, the command displays all legal-hold operations that match the specified litigation name. The parameter specifies the legal-hold litigation name.

[-operation-type {unknown|begin|end|dump-files}] - Operation Type

If this parameter is specified, the command displays all legal-hold operations that match the specified operation type. The parameter specifies the type of legal-hold operation.

[-operation-status {Unknown|In-Progress|Failed|Aborting|Completed}] - Operation Status

If this parameter is specified, the command displays all legal-hold operations that match the specified operation status. The parameter specifies the status of legal-hold operation.

[-num-files-processed <integer>] - Number of Files Processed

If this parameter is specified, the command displays all legal-hold operations that match the specified number of files processed. The parameter specifies the number of files on which legal-hold operation was successful.

[-num-files-failed <integer>] - Number of Files Failed

If this parameter is specified, the command displays all legal-hold operations that match the specified number of files failed. The parameter specifies the number of files on which legal-hold operation failed.

[-num-files-skipped <integer>] - Number of Files Skipped

If this parameter is specified, the command displays all legal-hold operations that match the specified number of files skipped.

The parameter specifies the number of files on which legal-hold begin operation was skipped. The legal-hold begin operation is skipped on a file if it is already under hold for a given litigation or if it is a hard link to a file that is already under hold for a given litigation.

[-num-inodes-ignored <integer>] - Number of Inodes Ignored

If this parameter is specified, the command displays all legal-hold operations that match the specified number of inodes ignored. The parameter specifies the number of inodes on which the legal-hold operation was not attempted because they were not regular files.

[-status-details <text>] - Status Details

If this parameter is specified, the command displays all legal-hold operations that match the specified status details. The parameter specifies the status details of an legal-hold operation.

Examples

The following examples show the status of legal-hold operations for Vserver vs1 and volume slc_vol1 and the status of legal-hold operation for operation ID 16842786 respectively:

vs1::> snaplock legal-hold show -volume slc_vol1
                                                Operation
Operation     Operation ID    Vserver   Volume  Status
------------- --------------- --------- ------- ---------
begin         16842784        vs1       slc_vol1
                                                Completed
begin         16842786        vs1       slc_vol1
                                                Completed
begin         16842788        vs1       slc_vol1
                                                In-Progress
dump-files    16842790        vs1       slc_vol1
                                                Completed
end           16842794        vs1       slc_vol1
                                                Completed
5 entries were displayed.

vs1::> snaplock legal-hold show -operation-id 16842786
Vserver: vs1
                      Volume: slc_vol1
                Operation ID: 16842786
             Litigation Name: litigation1
                        Path: /
              Operation Type: begin
                      Status: Completed
   Number of Files Processed: 100
      Number of Files Failed: 15
     Number of Files Skipped: 20
    Number of Inodes Ignored: 0
              Status Details: No error