|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Rename-NcSnapshot
NAME
Rename-NcSnapshot
SYNOPSIS
Rename a specified snapshot to a new name on a specified volume.
SYNTAX
Rename-NcSnapshot [-Volume] <String> [-Snapshot] <String> [-NewName] <String
> [-VserverContext <String>] [-Controller <NcController[]>] [-WhatIf] [-Conf
irm] [<CommonParameters>]
DESCRIPTION
Rename a specified snapshot to a new name on a specified volume.
PARAMETERS
-Volume <String>
Name of the volume where the current snapshot and the new snapshot are l
ocated.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Snapshot <String>
Name of snapshot to be renamed.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NewName <String>
New name of snapshot as a result of the rename.
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
-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
DataONTAP.C.Types.Snapshot.SnapshotInfo
NOTES
Category: snapshot
API: snapshot-rename
Family: vserver
-------------- Example 1 --------------
C:\PS>Rename-NcSnapshot vol2 snap1 GoldenBackup1
Rename snapshot 'snap1' in volume 'vol2' to 'GoldenBackup1'.
Name Volume Vserver
---- ------ -------
GoldenBackup1 vol2 vserver1
RELATED LINKS
Get-NcSnapshot
New-NcSnapshot
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|