Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Invoke-NcSnapmirrorCheck


NAME
Invoke-NcSnapmirrorCheck

SYNOPSIS
Starts an operation to compare the contents of a snapshot between the source
volume and destination volume.

SYNTAX
Invoke-NcSnapmirrorCheck [-DestinationCluster <String>] -DestinationVserver
<String> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVserv
er <String>] [-SourceVolume <String>] [-TargetSnapshot <String>] [-Passthru]
[-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Invoke-NcSnapmirrorCheck [-Destination] <String> [[-Source] <String>] [-Targ
etSnapshot <String>] [-Passthru] [-Controller <NcController[]>] [-WhatIf] [-
Confirm] [<CommonParameters>]


DESCRIPTION
Starts an operation to compare the contents of a snapshot between the source
volume and destination volume. You must specify the destination endpoint.
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
-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

-TargetSnapshot <String>
Specifies the snapshot copy on the destination endpoint to check.

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

-Passthru
Specify to output the SnapMirror object rather than the job ID.

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

-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

<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.PowerShell.SDK.Cmdlets.JobStartResult


NOTES


Category: snapmirror
API: snapmirror-check
Family: cluster

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

C:\PS>Invoke-NcSnapmirrorCheck //costea02/unitTestLunsSM | Get-NcJob


Start a check operation on the SnapMirror with destination '//costea02/unitT
estLunsSM' and display the job.


JobId JobName JobPriority JobState JobVserver JobCompletion
----- ------- ----------- -------- ---------- -------------
1632 SnapMirror check exclusive running VxeRubble



RELATED LINKS
Get-NcSnapmirror







 Data ONTAP® PowerShell Toolkit