Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Stop-NaClone


NAME
Stop-NaClone

SYNOPSIS
Stops a running clone operation.

SYNTAX
Stop-NaClone [[-VolumeUuid] <String>] [[-CloneId] <Decimal>] [-Controller <N
aController>] [-WhatIf] [-Confirm] [<CommonParameters>]

Stop-NaClone [-OpsInfo] <OpsInfo> [-Controller <NaController>] [-WhatIf] [-C
onfirm] [<CommonParameters>]


DESCRIPTION
Stops a running clone operation. If not successful, the error code will be r
eturned as API error.


PARAMETERS
-VolumeUuid <String>
UUID of volume on which this clone exists. If a volume object is passed
in via the pipeline, this cmdlet can use its Uuid value.

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

-CloneId <Decimal>
Unique ID information of the clone operation, as returned by Get-NaClone
or Start-NaClone.

Required? false
Position? 2
Default value
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

-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

-OpsInfo <OpsInfo>
Alternate parameter for specifying a clone operation, as returned by Get
-NaClone or Start-NaClone.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
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.Clone.OpsInfo


NOTES


Category: clone
API: clone-stop

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

C:\PS>$clone = Start-NaClone /vol/vol2/lun2 /vol/vol2/lun2clone
<...more script...>
Stop-NaClone $clone


Start a clone operation and save the operation status in a variable $clone.
Later, stop the clone operation by passing in the saved $clone value.


SourceFile : /vol/vol2/lun2
DestinationFile : /vol/vol2/lun2clone
CloneState : aborted
TotalBytes :
PercentDone :
BytesCopied :
CloneType : lun
CloneId : 12
Error : 14555
Reason : Clone operation aborted by user



RELATED LINKS
Start-NaClone
Get-NaClone
Clear-NaClone







 Data ONTAP® PowerShell Toolkit