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

volume file retention show

Suggest changes
PDFs

Display retention time of a file protected by SnapLock.

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

Description

The volume file retention show command displays the retention time of a file protected by SnapLock given -vserver and -file .

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

Specifies the name of the Vserver which has the file.

[-file </vol/<volume name>/<file path>>] - File path

Specifies the absolute path of the file. The value begins with /vol/<volumename>.

[-retention-time <integer>] - Retention Time of the File

If this paramater is specified, the command returns the retention time of the file protected by SnapLock if its retention time in seconds since 1 January 1970 00:00:00 matches the specified value.

[-formatted-retention-time <text>] - Formatted Retention Period

If this paramater is specified, the command returns the retention time of the file protected by SnapLock if its expiry date matches the specified value. The expiry date format is <day> <month> <day of month> <hour>:<min>:<sec><year> in GMT timezone taking care of wraparound. A value of infinite indicates that this file has infinite retention time. A value of indefinite indicates that this file has indefinite retention time.

[-is-wraparound {true|false}] - Is Retention Time Wraparound

If this paramater is specified, the command returns the retention time of the file protected by SnapLock if it has a matching -is-wraparound value. The value is true if the date represented in retention time is in wraparound format. The wraparound format indicates that dates after 19 January 2038 are mapped from 1 January 1970 through 31 December 2002 to 19 January 2038 through 19 January 2071.

Examples

The following example displays the retention time of the file /vol/nfs_sle/f12 :

cluster1::> volume file retention show -vserver vs0 -file /vol/nfs_sle/f12
Vserver : vs0
                                      Path : /vol/nfs_sle/f12
          Retention Time (Secs from Epoch) : 1439111404
                  Formatted Retention Time : Sun Aug  9 09:10:04 GMT 2015
              Is Retention Time Wraparound : false