Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Restore-NcSnapshotVolume


NAME
Restore-NcSnapshotVolume

SYNOPSIS
Reverts a volume to a specified snapshot.

SYNTAX
Restore-NcSnapshotVolume [-Volume] <String> [-SnapName] <String> [-Uuid <Str
ing>] [-PreserveLunIds] [-VserverContext <String>] [-Controller <NcControlle
r[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Reverts a volume to a specified snapshot. The volume must be online and mu
st not be a mirror. If reverting the root volume, the filer will be reboote
d. Non-root volumes do not require a reboot. A volume cannot have both a v
olume snaprestore and a single-file snaprestore executing simultaneously. M
ultiple single-file snaprestores can be in progress simultaneously. After t
he reversion, the volume is in the same state as it was when the snapshot wa
s taken.


PARAMETERS
-Volume <String>
The name of the volume to restore.

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

-SnapName <String>
The name of the snapshot to restore from.

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

-Uuid <String>
The 128 bit unique snapshot identifier expressed in the form of UUID. T
his field is optional and can uniquely identify a snapshot to restore.
An example of an actual UUID is: 84a010ec-3d28-11df-84e8-123478653412

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

-PreserveLunIds
When specified, LUNs in the volume being restored will remain mapped and
their identities preserved such that host connectivity will not be disr
upted during the restore operation. I/O's to the LUN will be fenced dur
ing the restore operation by placing the LUNs in an unavailable state.
Once the restore operation has completed, hosts will be able to resume I
/O access to the LUNs.

Required? false
Position? named
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 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.Volume.VolumeAttributes


NOTES


Category: snapshot
API: snapshot-restore-volume
Family: vserver

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

C:\PS>Restore-NcSnapshotVolume vol1 snap1


Restore volume 'vol1' to snapshot 'snap1'.


Name State TotalSize Used Available Dedupe Aggregate Vserver
---- ----- --------- ---- --------- ------ --------- -------
vol1 online 20.0 GB 5% 19.0 GB False aggr1 vserver1



RELATED LINKS
Restore-NcSnapshotFile







 Data ONTAP® PowerShell Toolkit