Data ONTAP PowerShell Toolkit: Cmdlet Get-NaSnapshotReclaimable

Overview
Categories
Cmdlets
APIs
Provider
Release notes
License
Data ONTAP® PowerShell Toolkit
Switch to Data ONTAP Cluster-mode documentation.
Cmdlet: Get-NaSnapshotReclaimable


NAME
    Get-NaSnapshotReclaimable
    
SYNOPSIS
    Returns the amount of space that would be freed when a set of snapshots are 
    deleted from a specified volume.
    
SYNTAX
    Get-NaSnapshotReclaimable [-TargetName] <String> [-SnapNames] <String[]> [-C
    ontroller <NaController>] [<CommonParameters>]
    
    Get-NaSnapshotReclaimable [-TargetName] <String> -Snapshots <SnapshotInfo[]>
     [-Controller <NaController>] [<CommonParameters>]
    
    
DESCRIPTION
    Returns the amount of space that would be freed when a set of snapshots are 
    deleted from a specified volume.
    

PARAMETERS
    -TargetName <String>
        Name of the volume on which the snapshot reclaimable space info is to be
         collected.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -SnapNames <String[]>
        List of snapshot names. A maximum of 255 snapshots can be listed.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       true (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
        
    -Snapshots <SnapshotInfo[]>
        List of snapshot objects, as returned by Get-NaSnapshot.
        
        Required?                    true
        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.Int64
     
    
NOTES
    
    
        Category: snapshot
        API: snapshot-reclaimable-info
    
    --------------  Example 1 --------------
    
    C:\PS>Get-NaSnapshotReclaimable vol0 hourly.0 hourly.1
    
    
    Get the space consumed in volume 'vol0' by the last two hourly snapshots.
    
    
    46788608
    
    
    --------------  Example 2 --------------
    
    C:\PS>Get-NaSnapshotReclaimable vol0 -Snapshots ( Get-NaSnapshot vol0 hourly
    * )
    
    
    Get the space consumed in volume 'vol0' by all hourly snapshots.
    
    
    85938176
    
    
    
RELATED LINKS
    Get-NaSnapshot
Data ONTAP® PowerShell Toolkit