Skip to main content

volume file retention show

Contributors
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

This specifies the Vserver on which the volume is located having the file in a SnapLock volume. An exact value is required for this parameter.

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

This specifies the absolute path of the file in a SnapLock volume. The value begins with /vol/<volumename>. An exact value is required for this parameter.

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

If this parameter is specified, the command displays information only about the file protected by SnapLock that matches the specified retention-time . The value represents file retention time in seconds since 1 January 1970 00:00:00.

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

If this parameter is specified, the command displays information only about the file protected by SnapLock that matches the specified formatted-retention-time . 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. A value of unspecified indicates that this file will be retained forever; however, the retention time can be changed to an absolute value.

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

If this parameter is specified, the command displays information only about the file protected by SnapLock that matches the specified -is-wraparound . 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.

[-seconds-until-expiry <integer>] - Seconds until the File Expires

If this parameter is specified, the command displays information only about the file protected by SnapLock that matches the specified -seconds-until-expiry . The value represents the number of seconds until the expiration time.

[-is-expired {true|false}] - Has the File Expired

If this parameter is specified, the command displays information only about the file protected by SnapLock that matches the specified -is-expired . The value represents file expiration status. The value is false if the file is under active retention or true if the file is past its expiry time.

Examples

The following example displays the retention time of the file /vol/nfs1/file1 :

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