Data ONTAP PowerShell Toolkit: Cmdlet Get-NaSnapshotVolumeSpace

Overview

Categories

Cmdlets

APIs

Provider

Release notes

License

Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Get-NaSnapshotVolumeSpace


NAME
    Get-NaSnapshotVolumeSpace
    
SYNOPSIS
    Returns snapshot related volume information.
    
SYNTAX
    Get-NaSnapshotVolumeSpace [-TargetName] <String> [-Controller <NaController>
    ] [<CommonParameters>]
    
    
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
    -TargetName <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 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.VolumeInfo
     
    
NOTES
    
    
        Category: snapshot
        API: snapshot-volume-info
    
    --------------  Example 1 --------------
    
    C:\PS>Get-NaSnapshotVolumeSpace vol0
    
    
    Get snapshot space info for volume 'vol0'.
    
    
    SizeAvailable
     -------------
       90865922048
    
    
    
RELATED LINKS

Data ONTAP® PowerShell Toolkit