Data ONTAP PowerShell Toolkit: Cmdlet Remove-NaNfsExport

Overview
Categories
Cmdlets
APIs
Release notes
License
Data ONTAP® PowerShell Toolkit
Cmdlet: Remove-NaNfsExport


NAME
    Remove-NaNfsExport
    
SYNOPSIS
    Removes the rules for a set of pathnames.
    
SYNTAX
    Remove-NaNfsExport [-Paths] <String[]> [-Persistent] [-Controller <NaControl
    ler>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<Comm
    onParameters>]
    
    Remove-NaNfsExport [-AllPaths] [-Persistent] [-Controller <NaController>] [-
    WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParame
    ters>]
    
    
DESCRIPTION
    Removes the rules for a set of pathnames. This returns an error if any of th
    e pathnames don't have a rule. Set the Persistent option to modify the etc/e
    xports file and keep this change persistent upon reboots.
    

PARAMETERS
    -Paths <String[]>
        Pathnames to be deleted from the exports table.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Persistent
        Default value is false.  Modify the etc/exports file to delete the rules
         permanently.  CAUTION: If AllPaths and Persistent are both specified, a
        ll exports are removed permanently.
        
        Required?                    false
        Position?                    named
        Default value                false
        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
        
    -AllPaths
        Default value is false. Specify to delete all rules. Paths must be left 
        empty if this option is true.
        
        Required?                    false
        Position?                    named
        Default value                false
        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
    System.Collections.Hashtable
     
    
NOTES
    
    
        Category: nfs
        API: nfs-exportfs-delete-rules
    
    --------------  Example 1 --------------
    
    C:\PS>Remove-NaNfsExport -Persistent /vol/testvol
    
    
    Remove the export for volume 'testvol'.
    
    
    Name                           Value
    ----                           -----
    DeletedPathnames               {/vol/testvol}
    UnexportedPathnames            {/vol/testvol}
    
    
    
RELATED LINKS
    Add-NaNfsExport 
    Set-NaNfsExport 
    Get-NaNfsExport
Data ONTAP® PowerShell Toolkit