|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Rename-NaSnapshot
NAME
Rename-NaSnapshot
SYNOPSIS
Rename a specified snapshot to a new name on a specified volume or aggregate
.
SYNTAX
Rename-NaSnapshot [-TargetName] <String> [-SnapName] <String> [-NewSnapName]
<String> [-TargetType <String>] [-Controller <NaController>] [<CommonParame
ters>]
DESCRIPTION
Rename a specified snapshot to a new name on a specified volume or aggregate
.
PARAMETERS
-TargetName <String>
Name of the volume or aggregate on which the snapshot is to be renamed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SnapName <String>
Name of snapshot to be renamed.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-NewSnapName <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
-TargetType <String>
Specify the type of snapshot target, either "volume" or "aggregate".
Required? false
Position? named
Default value volume
Accept pipeline input? true (ByPropertyName)
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.Snapshot.SnapshotInfo
NOTES
Category: snapshot
API: snapshot-rename, system-cli
Privilege: security-priv-admin, cli-snap-rename
-------------- Example 1 --------------
C:\PS>Rename-NaSnapshot vol2 vol2snap goldenBackup
Rename snapshot 'vol2snap' on volume 'vol2' to 'goldenBackup'.
Created : 3/11/2011 9:09:59 PM
Cumulative :
AccessTime : 1299877799
AccessTimeDT : 3/11/2011 9:09:59 PM
Busy : False
CumulativePercentageOfTotalBlocks : 0
CumulativePercentageOfUsedBlocks : 0
CumulativeTotal :
Dependency :
Name : goldenBackup
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 0
SnapshotOwnersList :
TargetName : vol2
TargetType : volume
Total :
RELATED LINKS
Get-NaSnapshot
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|