Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Rename-NcSnapshotMulti


NAME
Rename-NcSnapshotMulti

SYNOPSIS
Rename Snapshot copies with a specific name to a new name across multiple vo
lumes.

SYNTAX
Rename-NcSnapshotMulti [-Volumes] <String[]> [-Snapshot] <String> [-NewName]
<String> [-VserverContext <String>] [-Controller <NcController[]>] [<Common
Parameters>]


DESCRIPTION
Rename Snapshot copies with a specific name to a new name across multiple vo
lumes. The cmdlet processes all the specified volumes even if rename fails o
n one or more volumes.


PARAMETERS
-Volumes <String[]>
Names of the volumes across which the snapshot is to be renamed.

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

-Snapshot <String>
The current snapshot name.

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

-NewName <String>
The new snapshot name.

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
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 clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
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
DataONTAP.C.Types.Snapshot.SnapshotInfo


NOTES


Category: snapshot
API: snapshot-multirename
Family: vserver

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

C:\PS>Rename-NcSnapshotMulti -Volumes luns, luns_clone -Snapshot backup.2 -N
ewName backup.1


Rename the snapshot on multiple volumes.


Name Volume Vserver Cre
ated Total Cumulative Dependency
---- ------ ------- ---
---- ----- ---------- ----------
backup.1 luns beam01 2/26/
2013 316.0 KB 316.0 KB
backup.1 luns_clone beam01 2/26/
2013 308.0 KB 308.0 KB



RELATED LINKS
New-NcSnapshotMulti
Remove-NcSnapshotMulti







 Data ONTAP® PowerShell Toolkit