Data ONTAP® PowerShell Toolkit

Cmdlet: Get-NaSnapshotVolumeSpace


NAME
Get-NaSnapshotVolumeSpace

SYNOPSIS
Returns snapshot related volume information.

SYNTAX
Get-NaSnapshotVolumeSpace [-Name] <String> [-Controller <NaController>] [-Wa
rningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParamete
rs>]


DESCRIPTION
Returns snapshot related volume information. The information returned is val
id at the time the API call reached the filer and maybe outdated soon after.

This API returns the total bytes that when exhausted will disable us from ta
king snapshots. If this value is 0, snapshots cannot be taken. Any other val
ue would allow us to take a reliable snapshot. This space may or may not get
exhausted by taking a snapshot. Also it may get used by writes/allocations
in the volume. This is not equal to the free space in the active file system
or anyway related to the size of the next snapshot. Range : [0..2^64-1].


PARAMETERS
-Name <String>
Name of the volume on which the space needs to be checked.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
System.Collections.Hashtable


NOTES


Category: snapshot
API: snapshot-volume-info

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

C:\PS>Get-NaSnapshotVolumeSpace vol0


Get snapshot space info for volume 'vol0'.


Name Value
---- -----
SizeAvailable 108716281856



RELATED LINKS







 Data ONTAP® PowerShell Toolkit