Skip to main content

snaplock event-retention show

Contributors
Suggest changes
PDFs

Show status of Event Based Retention operation

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

Description

The snaplock event-retention show command displays the status of an Event Based Retention (EBR) operation. Information about completed operations will be cleaned up after an hour after 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 EBR operations that match the specified Vserver.

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

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

[-volume <volume name>] - Volume Name

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

[-path <text>] - Path

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

[-policy-name <text>] - Policy Name

If this parameter is specified, the command displays all EBR operations that match the specified policy name. The parameter specifies the EBR policy name.

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

If this parameter is specified, the command displays all EBR operations that match the specified retention period. The parameter specifies the retention period of the EBR policy.

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

If this parameter is specified, the command displays all EBR operations that match the specified number of processed files. The parameter specifies the number of files on which EBR policy was applied successfully.

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

If this parameter is specified, the command displays all EBR operations that match the specified number of failed files. The parameter specifies the number of files on which the application of EBR policy failed.

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

If this parameter is specified, the command displays all EBR operations that match the specified number of skipped files. The parameter specifies the number of files on which the application of EBR policy was skipped. A file that is under legal-hold will be skipped. If the retention time of a file is being shortened as a result of applying the EBR policy, that file will also be skipped.

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

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

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

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

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

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

Examples

The following examples show the status of EBR operations for Vserver "vs1" and volume "slc" and the status of event-retention operation for operation ID 16842753 respectively.

vs1::*> snaplock event-retention operation show -volume slc
            Operation ID   Vserver         Volume          Operation Status
            -------------- --------------- --------------- ----------------
            16842753       vs1             slc             Completed
            16842754       vs1             slc             In-progress
vs1::*> snaplock event-retention operation show -operation-id 16842753
Operation ID: 16842753
                    Vserver: vs1
                     Volume: slc
                       Path: /vol/slc/d1
                Policy Name: p1
           Retention Period: 10 years
  Number of Files Processed: 50
     Number of Files Failed: 0
   Number of Inodes Ignored: 2
           Operation Status: Completed
             Status Details: No error