Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Get-NaSnapshot


NAME
Get-NaSnapshot

SYNOPSIS
Return snapshot information for a specified volume or aggregate.

SYNTAX
Get-NaSnapshot [-TargetName] <String> [[-SnapName] <String>] [-TargetType <S
tring>] [-Aggregate] [-Terse] [-Controller <NaController>] [<CommonParameter
s>]


DESCRIPTION
Return snapshot information for a specified volume or aggregate. A list of
snapshots and information about each snapshot is returned. Reported sizes a
re in bytes.


PARAMETERS
-TargetName <String>
Name of the volume or aggregate on which to list the snapshot informatio
n. To get snapshots for an aggregate, also specify the TargetType param
eter.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-SnapName <String>
The name of the snapshot to query. This is optional. Wildcards are sup
ported.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-TargetType <String>
Specify the type of snapshot target, either "volume" or "aggregate".

Required? false
Position? named
Default value volume
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Aggregate
DEPRECATED. Specify to query aggregate snapshots rather than volume sna
pshots.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Terse
If set to true, the snapshot block ownership values, namely the "total"
and "cumulative-total" outputs, will be omitted. Use of this option can
be helpful if there is an ongoing single file snap restore, as the block
ownership calculation may take a substantial amount of time during the
restore. If not set or set to false, block ownership will be calculated
and included in the output. It is strongly suggested that this option be
set to true unless there is an actual need for the block ownership outp
uts.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.Types.Snapshot.SnapshotInfo


NOTES


Category: snapshot
API: snapshot-list-info

-------------- Example 1 --------------

C:\PS>Get-NaSnapshot vol0 hourly*


List all of the hourly snapshots available for volume 'vol0'.


Created : 3/11/2011 5:00:18 PM
Cumulative : 9785344
AccessTime : 1299862818
AccessTimeDT : 3/11/2011 5:00:18 PM
Busy : False
CumulativePercentageOfTotalBlocks : 0
CumulativePercentageOfUsedBlocks : 0
CumulativeTotal : 9785344
Dependency :
Name : hourly.0
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 0
SnapshotOwnersList :
TargetName : vol0
TargetType : volume
Total : 9785344

Created : 3/10/2011 5:00:33 PM
Cumulative : 58523648
AccessTime : 1299776433
AccessTimeDT : 3/10/2011 5:00:33 PM
Busy : False
CumulativePercentageOfTotalBlocks : 0
CumulativePercentageOfUsedBlocks : 0
CumulativeTotal : 58523648
Dependency :
Name : hourly.1
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 0
SnapshotOwnersList :
TargetName : vol0
TargetType : volume
Total : 21295104


-------------- Example 2 --------------

C:\PS>Get-NaSnapshot aggr0 -TargetType aggregate


Get all snapshots on aggregate 'aggr0'.


Created : 3/11/2011 7:00:16 PM
Cumulative : 132300800
AccessTime : 1299870016
AccessTimeDT : 3/11/2011 7:00:16 PM
Busy : False
CumulativePercentageOfTotalBlocks : 0
CumulativePercentageOfUsedBlocks : 1
CumulativeTotal : 132300800
Dependency :
Name : hourly.0
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 0
SnapshotOwnersList :
TargetName : aggr0
TargetType : aggregate
Total : 77422592

Created : 3/11/2011 7:47:28 PM
Cumulative : 54878208
AccessTime : 1299872848
AccessTimeDT : 3/11/2011 7:47:28 PM
Busy : False
CumulativePercentageOfTotalBlocks : 0
CumulativePercentageOfUsedBlocks : 0
CumulativeTotal : 54878208
Dependency :
Name : snap2
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 0
SnapshotOwnersList :
TargetName : aggr0
TargetType : aggregate
Total : 54878208



RELATED LINKS
New-NaSnapshot
Restore-NaSnapshotVolume







 Data ONTAP® PowerShell Toolkit