Data ONTAP PowerShell Toolkit: Cmdlet Rename-NaDirectory

Overview
Categories
Cmdlets
APIs
Release notes
License
Data ONTAP® PowerShell Toolkit
Cmdlet: Rename-NaDirectory


NAME
    Rename-NaDirectory
    
SYNOPSIS
    Rename a directory.
    
SYNTAX
    Rename-NaDirectory [-Path] <String> [-NewPath] <String> [-Controller <NaCont
    roller>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-W
    hatIf] [-Confirm] [<CommonParameters>]
    
    
DESCRIPTION
    Rename a directory. Note that this API cannot be used to rename a directory 
    to a different volume.
    

PARAMETERS
    -Path <String>
        Path of the directory, i.e. /vol/<volumename>/<dirname>.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -NewPath <String>
        New path of the directory, i.e. /vol/<volumename>/<dirname>.  All path c
        omponents except the final directory name must already exist.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        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
        
    -WhatIf
        
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm
        
        
        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
    NetApp.Ontapi.Filer.File.FileInfo
     
    
NOTES
    
    
        Category: file
        API: file-rename-directory
    
    --------------  Example 1 --------------
    
    C:\PS>Rename-NaDirectory /vol/vol0/etc/testdir /vol/vol0/etc/mydir
    
    
    Rename /etc directory 'testdir' to 'mydir'.
    
    
    AccessedTimestamp : 1273089329
    AclType           : nt_acl
    ChangedTimestamp  : 1273089353
    CreationTimestamp : 1273089329
    FileSize          : 4096
    FileType          : directory
    GroupId           : 0
    HardLinksCount    : 2
    InodeNumber       : 3784338
    IsEmpty           :
    ModifiedTimestamp : 1273089329
    Name              : /vol/vol0/etc/mydir
    OwnerId           : 0
    Perm              : 700
    IsEmptySpecified  : False
    
    
    
RELATED LINKS
    New-NaDirectory 
    Read-NaDirectory 
    Remove-NaDirectory
Data ONTAP® PowerShell Toolkit