Data ONTAP PowerShell Toolkit: Cmdlet Remove-NaVol

Overview
Categories
Cmdlets
APIs
Provider
Release notes
License
Data ONTAP® PowerShell Toolkit
Switch to clustered Data ONTAP documentation.
Cmdlet: Remove-NaVol


NAME
    Remove-NaVol
    
SYNOPSIS
    Destroy the specified volume or plex.
    
SYNTAX
    Remove-NaVol [-Name] <String> [-Force] [-Controller <NaController>] [<Common
    Parameters>]
    
    
DESCRIPTION
    Destroy the specified volume or plex.  If a flexible volume is specified, al
    l of its blocks are freed and returned to its containing aggregate; no other
     flexible volumes in the same containing aggregate (if any) are affected.  I
    f a traditional volume is specified, all of its plexes are destroyed, and it
    s disks are returned to the appropriate spare pool(s).  If a plex is specifi
    ed, it must be for a mirrored aggregate (which could potentially be embedded
     in a traditional volume), leaving it unmirrored.  Only offline volumes and 
    plexes can be destroyed.
    

PARAMETERS
    -Name <String>
        Name of an existing volume or plex.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Force
        Force the destruction of the volume even if a non-default vfiler has sto
        rage on it.
        
        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
    
     
    
NOTES
    
    
        Category: volume
        API: volume-destroy
    
    --------------  Example 1 --------------
    
    C:\PS>Set-NaVol vol10 -Offline | Remove-NaVol
    
    
    Set volume 'vol10' offline and then destroy it.
    
    
    
    
    
    
RELATED LINKS
    New-NaVol 
    Set-NaVol
Data ONTAP® PowerShell Toolkit