Data ONTAP PowerShell Toolkit: Cmdlet Rename-NaQtree

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


NAME
    Rename-NaQtree
    
SYNOPSIS
    Renames the specified qtree to a new name.
    
SYNTAX
    Rename-NaQtree [-Path] <String> [-NewName] <String> [-Controller <NaControll
    er>] [<CommonParameters>]
    
    Rename-NaQtree [-QtreeInfo] <QtreeInfo> [-NewName] <String> [-Controller <Na
    Controller>] [<CommonParameters>]
    
    
DESCRIPTION
    Renames the specified qtree to a new name specified by "NewName". If the qtr
    ee is referenced in the file /etc/exportfs, use NFS API nfs-exportfs-append-
    rules to modify the file so that the affected file system can be exported by
     the filer immediately. This command does not automatically update the /etc/
    exports file.
    

PARAMETERS
    -Path <String>
        Path of an existing qtree. The path should be in this format: /vol/<volu
        me>/<qtree>.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NewName <String>
        The new qtree name.
        
        Required?                    true
        Position?                    2
        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
        
    -QtreeInfo <QtreeInfo>
        Alternate parameter set allows for a qtree to be passed in via the pipel
        ine to be renamed.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue)
        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.Qtree.QtreeInfo
     
    
NOTES
    
    
        Category: qtree
        API: qtree-rename
    
    --------------  Example 1 --------------
    
    C:\PS>Rename-NaQtree /vol/vol2/qtree1 qtree2
    
    
    Rename qtree 'qtree1' in volume 'vol2' to 'qtree2'.
    
    
    Id            : 1
    Oplocks       : enabled
    Qtree         : qtree2
    SecurityStyle : ntfs
    Status        : normal
    Volume        : vol2
    
    
    
RELATED LINKS
    Get-NaQtree
Data ONTAP® PowerShell Toolkit