Skip to main content

snaplock event-retention policy show

Contributors
Suggest changes
PDFs

Show SnapLock Event Based Retention policies for a Vserver

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

Description

The snaplock event-retention policy show command is used to show Event Based Retention (EBR) policies for a Vserver. A policy consists of a policy-name and a retention-period . The command output depends on the parameter or parameters specified. If no parameters are specified, all policies for all vservers will be displayed. If one or more parameters are specified, only those entries matching the specified values will be displayed. 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 policies that match the specified Vserver.

[-name <text>] - Policy Name

If this parameter is specified, the command displays all EBR policies that match the specified name .

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

If this parameter is specified, the command displays all EBR policies that match the specified retention-period .

Examples

The following example displays all event-retention policies for vserver "vs1":

vs1::> snaplock event-retention policy show
            Vserver           Name                Retention Period
            ----------------- ------------------- --------------------
            vs1               p1                  10 years
            vs1               p2                  5 years