Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Rename-NaVol


NAME
Rename-NaVol

SYNOPSIS
Renames the specified volume.

SYNTAX
Rename-NaVol [-Name] <String> [-NewName] <String> [-Controller <NaController
>] [<CommonParameters>]


DESCRIPTION
Renames the specified volume to a new name specified by 'NewName'. If the vo
lume is referenced in the /etc/exports file, remember to make the name chang
e in /etc/exports also so that the affected file system can be exported by t
he filer after the filer reboots. The "Rename-NaVol" command does not automa
tically update the /etc/exports file.


PARAMETERS
-Name <String>
Name of an existing volume.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-NewName <String>
New volume 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

<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.Volume.VolumeInfo


NOTES


Category: volume
API: volume-rename

-------------- Example 1 --------------

C:\PS>Rename-NaVol vol2clone vol10


Rename volume 'vol2clone' to 'vol10'.


ChecksumStyle : block
CloneChildren :
CloneParent : {clone_vol2clone.2}
ContainingAggregate : aggr1
DiskCount : 8
FilesTotal : 6381567
FilesUsed : 185
IsChecksumEnabled : True
IsInconsistent : False
IsSnaplock : False
IsUnrecoverable : False
MirrorStatus : unmirrored
Name : vol10
PercentageUsed : 64
PlexCount : 1
Plexes : {/aggr1/plex0}
QuotaInit : 0
RaidSize : 16
RaidStatus : raid_dp,sis
Reserve : 10110799872
ReserveRequired : 10110799872
ReserveUsed : 0
Sis : idle
SizeAvailable : 70695993344
SizeTotal : 198073786368
SizeUsed : 127377793024
SnaplockType :
SpaceReserve : none
SpaceReserveEnabled : True
State : online
Type : flex
Uuid : f7b5f966-11b4-11df-9caa-00a09806c227
IsUnrecoverableSpecified : True
PercentageUsedSpecified : True
SpaceReserveEnabledSpecified : True



RELATED LINKS
Get-NaVol







 Data ONTAP® PowerShell Toolkit