|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSnapmirrorRestore
NAME
Invoke-NcSnapmirrorRestore
SYNOPSIS
Restore the contents of a selected Snapshot copy from the source volume to t
he active file system of the destination volume.
SYNTAX
Invoke-NcSnapmirrorRestore [-Destination] <String> [[-Source] <String>] [-So
urceSnapshot <String>] [-MaxTransferRate <String>] [-TransferPriority <Strin
g>] [-Tries <Int32>] [-UnlimitedTries] [-DisableStorageEfficiency] [-CleanUp
Failure] [-Passthru] [-Controller <NcController[]>] [<CommonParameters>]
Invoke-NcSnapmirrorRestore [-DestinationCluster <String>] -DestinationVserve
r <String> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVse
rver <String>] [-SourceVolume <String>] [-SourceSnapshot <String>] [-MaxTran
sferRate <String>] [-TransferPriority <String>] [-Tries <Int32>] [-Unlimited
Tries] [-DisableStorageEfficiency] [-CleanUpFailure] [-Passthru] [-Controlle
r <NcController[]>] [<CommonParameters>]
DESCRIPTION
Restore the contents of a selected Snapshot copy from the source volume to t
he active file system of the destination volume. The destination volume is
read write after the data is restored.
The Invoke-NcSnapmirrorRestore cmdlet creates a temporary SnapMirror relatio
nship of the type RST. For this reason the destination volume cannot be the
destination volume of another SnapMirror relationship. The temporary RST rel
ationship is deleted after the operation completes successfully.
If the destination volume is an empty data protection volume, the cmdlet per
forms a baseline restore. The baseline restore transfers the contents of the
selected Snapshot copy from the source volume to the destination volume.
If the destination volume is read-write and has at least one Snapshot which
also appears on the source volume, an incremental restore is performed.
The destination volume is made read only, if is not already read only. When
the destination volume is made read only the latest snapshot on destination
volume is made the exported snapshot. Note, that any data written to the des
tination volume since the last snapshot is lost during this operation. To sa
ve the contents of the active file system on the destination volume, stop al
l client access and take a snapshot before starting this operation.
During an incremental restore a common Snapshot copy is selected. The snapsh
ot chosen as the common snapshot must be on the source and destination volum
es. The contents of the common Snapshot copy on the destination volume are c
opied to the active file system of the destination volume. Then the contents
of the Snapshot copy to be restored are transferred from the source volume
to the destination volume.
Unless SourceSnapshot is specified the most recent Snapshot copy on the sour
ce volume is restored.
This cmdlet may be used to restart a failed snapmirror-restore operation. Th
is cmdlet may be used to terminate an aborted or failed snapmirror-restore o
peration by specifying the CleanUpFailure switch. Terminating an aborted or
failed snapmirror-restore operation deletes any residual temporary RST relat
ionship and converts the destination volume back to read-write if the destin
ation volume was read-write prior to initial snapmirror-restore operation wh
ile removing any data transferred or copied during the snapmirror-restore op
eration.
A job will be spawned to operate on the snapmirror and the job id will be re
turned. The progress of the job can be tracked using the job cmdlets.
PARAMETERS
-Destination <String>
Specifies the destination endpoint of the SnapMirror relationship in the
format: [cluster:]//vserver/volume. This format may change in the futu
re. When specifying a destination endpoint, you must use either the des
tination location, or the destination cluster, destination vserver, and
destination volume.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Source <String>
Specifies the source endpoint of the SnapMirror relationship in the form
at: [cluster:]//vserver/volume. This format may change in the future.
When specifying a source endpoint, you must use either the source locati
on, or the source cluster, source vserver, and source volume.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceSnapshot <String>
The Snapshot from the source to be restored.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-MaxTransferRate <String>
The upper bound at which data is transferred between clusters. The defau
lt is unlimited (0) which permits the SnapMirror relationship to fully u
tilize the available network bandwidth. The MaxTransferRate does not af
fect load-sharing mirrors and other SnapMirror relationships confined to
a single cluster.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-TransferPriority <String>
Specifies the priority at which the transfer runs. Possible values are:
'normal', and 'low'. The default value for this parameter is 'normal'.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Tries <Int32>
Specifies the total number of attempts to transfer data. This value has
no effect if the UnlimitedTries switch is present.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UnlimitedTries
If specified, defines an unlimited number of attempts to transfer data.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisableStorageEfficiency
The default behavior of restore is to preserve storage efficiency when p
ossible. If specified, turn off storage efficiency for data transferred
over the wire and written to the destination volume.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CleanUpFailure
If specified, recover from an aborted or failed restore operation. If th
e destination volume was read-write prior to the failed or aborted resto
re operation, it is converted back to read-write if necessary while remo
ving all data transferred or copied during the restore operation. Any re
sidual temporary RST relationship is also removed from the destination V
server. An attempt is made to remove any residual temporary RST relatio
nship from the source Vserver.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Passthru
Specify to output the SnapMirror object.
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
-DestinationCluster <String>
Specifies the destination cluster of the SnapMirror relationship. The d
estination vserver and destination volume must also be specified if usin
g this parameter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DestinationVserver <String>
Specifies the destination vserver of the SnapMirror relationship. The d
estination cluster and destination volume must also be specified if usin
g this parameter.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DestinationVolume <String>
Specifies the destination volume of the SnapMirror relationship. The de
stination cluster and destination vserver must also be specified if usin
g this parameter.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceCluster <String>
Specifies the source cluster of the SnapMirror relationship. The source
vserver and source volume must also be specified if using this paramete
r.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceVserver <String>
Specifies the source vserver of the SnapMirror relationship. The source
cluster and source volume must also be specified if using this paramete
r.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceVolume <String>
Specifies the source volume of the SnapMirror relationship. The source
cluster and source vserver must also be specified if using this paramete
r.
Required? false
Position? named
Default value
Accept pipeline input? true (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
NOTES
Category: snapmirror
API: snapmirror-restore,snapmirror-restore-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>
RELATED LINKS
Get-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|