Skip to main content

volume snaplock show

Contributors
Suggest changes
PDFs

Display SnapLock attributes of a SnapLock volume

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

Description

The ` volume snaplock show ` command displays following information :

  • Vserver name

  • Volume name

  • SnapLock Type of the volume

  • Minimum retention period applicable of the volume

  • Default retention period applicable of the volume

  • Maximum retention period applicable of the volume

  • Autocommit period of the volume

  • Volume Append Mode attribute of the volume

  • Privileged Delete attribute of the volume

  • Litigation count on the volume

  • Volume expiry time of the volume

  • Volume ComplianceClock

  • SnapLock audit log volume

  • Unspecified retention file count on the volume

This command is applicable only for SnapLock volumes.

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

If this parameter is specified, the command displays information for all the SnapLock volumes that match the specified -vserver value.

[-volume <volume name>] - Volume

If this parameter is specified, the command displays information for the specified -volume value.

[-type {non-snaplock|compliance|enterprise}] - SnapLock Type

If this parameter is specified, the command displays all the volumes that match the specified -type value.

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

If this parameter is specified, the command displays all the volumes that match the specified -minimum-retention-period value.

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

If this parameter is specified, the command displays all the volumes that match the specified -default-retention-period value.

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

If this parameter is specified, the command displays all the volumes that match the specified -maximum-retention-period value.

[-autocommit-period {{<integer> minutes|hours|days|months|years} | none}] - Autocommit Period

If this parameter is specified, the command displays all the volumes that match the specified -autocommit-period value.

[-is-volume-append-mode-enabled {true|false}] - Is Volume Append Mode Enabled

If this parameter is specified, the command displays all the volumes that match the specified -is-volume-append-mode-enabled value.

[-privileged-delete {disabled|enabled|permanently-disabled}] - Privileged Delete

If this parameter is specified, the command displays all the volumes that match the specified -privileged-delete value.

[-expiry-time <text>] - Expiry Time

If this parameter is specified, the command displays all the volumes that match the specified -expiry-time value.

[-compliance-clock-time <text>] - ComplianceClock Time

If this parameter is specified, the command displays all the volumes that match the specified -compliance-clock-time value.

[-litigation-count <integer>] - Litigation Count

If this parameter is specified, the command displays all the volumes that match the specified -litigation-count value.

[-is-audit-log-volume {true|false}] - Is SnapLock Audit Log Volume

If this parameter is specified, the command displays all the volumes that match the specified -is-audit-log-volume value.

[-unspecified-retention-file-count <integer>] - Unspecified Retention File Count

If this parameter is specified, the command displays all the volumes that match the specified -unspecified-retention-file-count value.

Examples

The following command shows summary of SnapLock volumes on a vserver:

cluster1::> volume snaplock show
Vserver       Volume          SnapLock Type ComplianceClock Time
------------- --------------- ------------- -----------------------------------
vs1           vol_slc         compliance    Mon Jan 19 14:12:34 IST 2015 +05:30
vs1           vol_sle         enterprise    Mon Jan 19 14:12:34 IST 2015 +05:30
2 entries were displayed.

cluster1::>

The following commands lists the complete SnapLock attributes of two given SnapLock volumes:

cluster1::> volume snaplock show -vserver vs1 -volume vol_slc
Vserver Name: vs1
                      Volume Name: vol_slc
                    SnapLock Type: compliance
         Minimum Retention Period: 1 years
         Default Retention Period: max
         Maximum Retention Period: 30 years
                Autocommit Period: 12 hours
    Is Volume Append Mode Enabled: false
                Privileged Delete: permanently-disabled
                      Expiry Time: Thu May 11 14:37:21 GMT 2017
             ComplianceClock Time: Wed May 11 20:08:41 IST 2016 +05:30
                 Litigation Count: 0
     Is SnapLock Audit Log Volume: false
     Unspecified Retention File Count: 0

cluster1::>

cluster1::> volume snaplock show -vserver vs1 -volume vol_sle
Vserver Name: vs1
                      Volume Name: vol_sle
                    SnapLock Type: enterprise
         Minimum Retention Period: 6 months
         Default Retention Period: min
         Maximum Retention Period: infinite
                Autocommit Period: none
    Is Volume Append Mode Enabled: false
                Privileged Delete: enabled
                      Expiry Time: infinite
             ComplianceClock Time: Wed May 11 20:08:44 IST 2016 +05:30
                 Litigation Count: 0
     Is SnapLock Audit Log Volume: false
 Unspecified Retention File Count: 0