Data ONTAP® PowerShell Toolkit

Cmdlet: Get-NaSnapshot


NAME
Get-NaSnapshot

SYNOPSIS
Return snapshot information for a specified volume.

SYNTAX
Get-NaSnapshot [-Name] <String> [[-SnapName] <String>] [-Aggregate] [-Terse]
[-Controller <NaController>] [-WarningAction <ActionPreference>] [-WarningV
ariable <String>] [<CommonParameters>]


DESCRIPTION
Return snapshot information for a specified volume. A list of snapshots and
information about each snapshot is returned.


PARAMETERS
-Name <String>
Name of the object on which to list the snaplist information. The object
is assumed to be a volume unless the -Aggregate switch is specified.

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

-Aggregate
Specify to query aggregate snapshots rather than volume snapshots.

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 DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

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

-WarningAction <ActionPreference>


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

-WarningVariable <String>


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
NetApp.Ontapi.Filer.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'.


AccessTime : 1234440016
Busy : False
CumulativePercentageOfTotalBlocks : 3
CumulativePercentageOfUsedBlocks : 52
CumulativeTotal : 3447176
Dependency :
Name : hourly.0
PercentageOfTotalBlocks : 3
PercentageOfUsedBlocks : 52
SnapshotOwnersList :
Total : 3447176

AccessTime : 1234425615
Busy : False
CumulativePercentageOfTotalBlocks : 3
CumulativePercentageOfUsedBlocks : 52
CumulativeTotal : 3464332
Dependency :
Name : hourly.1
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 1
SnapshotOwnersList :
Total : 17156

AccessTime : 1234382416
Busy : False
CumulativePercentageOfTotalBlocks : 3
CumulativePercentageOfUsedBlocks : 52
CumulativeTotal : 3509152
Dependency :
Name : hourly.2
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 1
SnapshotOwnersList :
Total : 18092

AccessTime : 1234368016
Busy : False
CumulativePercentageOfTotalBlocks : 3
CumulativePercentageOfUsedBlocks : 53
CumulativeTotal : 3549248
Dependency :
Name : hourly.3
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 1
SnapshotOwnersList :
Total : 40096

AccessTime : 1234353616
Busy : False
CumulativePercentageOfTotalBlocks : 3
CumulativePercentageOfUsedBlocks : 53
CumulativeTotal : 3567340
Dependency :
Name : hourly.4
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 1
SnapshotOwnersList :
Total : 18092

AccessTime : 1234339216
Busy : False
CumulativePercentageOfTotalBlocks : 3
CumulativePercentageOfUsedBlocks : 53
CumulativeTotal : 3603524
Dependency :
Name : hourly.5
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 1
SnapshotOwnersList :
Total : 36184



RELATED LINKS
New-NaSnapshot
Restore-NaSnapshotVolume







 Data ONTAP® PowerShell Toolkit