Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Rename-NcVol


NAME
Rename-NcVol

SYNOPSIS
Renames the specified volume to a new name.

SYNTAX
Rename-NcVol [-Name] <String> [-NewName] <String> [-VserverContext <String>]
[-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Renames the specified volume to a new name. If the volume is referenced in
the /etc/exports file, remember to make the name change in /etc/exports also
so that the affected file system can be exported by the filer after the fil
er reboots. This command does not automatically update the /etc/exports fil
e.


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

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

-NewName <String>
New volume name.

Required? true
Position? 2
Default value
Accept pipeline input? false
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 Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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.C.Volume810.VolumeAttributes


NOTES


Category: volume
API: volume-destroy
Family: vserver

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

C:\PS>Rename-NcVol vol3 vol2


Rename volume 'vol3' to 'vol2'.


Name State TotalSize Used Available Dedupe Aggregate Vserver
---- ----- --------- ---- --------- ------ --------- -------
vol2 online 10.0 GB 5% 9.5 GB False aggr1 vserver1



RELATED LINKS
Get-NcVol







 Data ONTAP® PowerShell Toolkit