Data ONTAP PowerShell Toolkit: Cmdlet Remove-NcFile

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


NAME
    Remove-NcFile
    
SYNOPSIS
    Delete a file.
    
SYNTAX
    Remove-NcFile [-Path] <String> [-VserverContext <String>] [-Controller <NcCo
    ntroller[]>] [<CommonParameters>]
    
    
DESCRIPTION
    Delete a file.
    

PARAMETERS
    -Path <String>
        Path of the file or symlink to delete.  The value is expected to begin w
        ith /vol/<volumename>.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    -VserverContext <String>
        Vserver to which to direct this command.  If the currently connected con
        troller (as embodied by an NcController object) represents a cluster, th
        ere are multiple means to address commands to one of its vservers.  Eith
        er set the Vserver field on the NcController object to direct all subseq
        uent commands to that vserver, or supply the VserverContext parameter to
         an individual cmdlet.  Only cmdlets which may be invoked on vservers of
        fer the VserverContext parameter.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Controller <NcController[]>
        A clustered Data ONTAP controller to receive this cmdlet, as embodied by
         an NcController object.  This parameter is returned by the Connect-NcCo
        ntroller cmdlet.  If not specified, the value in the global variable Cur
        rentNcController is used.  In the latter case, if CurrentNcController co
        ntains a collection of NcController objects, this cmdlet is invoked on e
        ach controller in succession.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        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: file
        API: file-delete-file
        Family: vserver
    
    --------------  Example 1 --------------
    
    C:\PS>Remove-NcFile /vol/vol1/servers
    
    
    Delete the file 'servers'.
    
    
    
    
    
    --------------  Example 2 --------------
    
    C:\PS>Read-NcDirectory vol1 | ? {$_.Type -eq "file"} | Remove-NcFile -Confir
    m:$false
    
    
    Remove all files in a directory.
    
    
    
    
    
    
RELATED LINKS
    Get-NcFile 
    Read-NcDirectory 
    Remove-NcDirectory
Data ONTAP® PowerShell Toolkit