Data ONTAP® PowerShell Toolkit

Cmdlet: Rename-NaSnapshot


NAME
Rename-NaSnapshot

SYNOPSIS
Rename a specified snapshot to a new name on a specified volume.

SYNTAX
Rename-NaSnapshot [-Volume] <String> [-SnapName] <String> [-NewSnapName] <St
ring> [-Controller <NaController>] [-WarningAction <ActionPreference>] [-War
ningVariable <String>] [-WhatIf] [-Confirm] [<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

-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

-Controller <NaController>
The DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningAction <ActionPreference>


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningVariable <String>


Required? false
Position? named
Default value
Accept pipeline input? false
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.Snapshot.SnapshotInfo


NOTES


Category: snapshot
API: snapshot-rename

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

C:\PS>Rename-NaSnapshot vol2 vol2snap goldenBackup


Rename snapshot 'vol2snap' on volume 'vol2' to 'goldenBackup'.


AccessTime : 1265829948
Busy : False
CumulativePercentageOfTotalBlocks : 0
CumulativePercentageOfUsedBlocks : 0
CumulativeTotal :
Dependency :
Name : goldenBackup
PercentageOfTotalBlocks : 0
PercentageOfUsedBlocks : 0
SnapshotOwnersList :
Total :



RELATED LINKS
Get-NaSnapshot







 Data ONTAP® PowerShell Toolkit