Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Get-NaClone


NAME
Get-NaClone

SYNOPSIS
Gets the information of a clone operations identified by CloneId.

SYNTAX
Get-NaClone [-Controller <NaController>] [<CommonParameters>]

Get-NaClone [-VolumeUuid] <String> [-CloneId] <Decimal> [-Controller <NaCont
roller>] [<CommonParameters>]

Get-NaClone [-OpsInfo] <OpsInfo> [-Controller <NaController>] [<CommonParame
ters>]


DESCRIPTION
Gets the information of a clone operations identified by CloneId. If CloneI
d is not specified, then it will get the status of all running and failed cl
one operation on the filer. It will get the status as 'running', 'failed' or
'completed'. User may see some other transient status for the clone operati
on, but any other status should be considered for polling clone-list-status
again.

User should keep polling Get-NaClone till status returned is 'failed' or 'co
mpleted'. If status is 'completed', the clone operation has been completed s
uccessfully. If status is 'failed', then user is responsible for doing clone
-clear to clean the status of the clone information.

When a clone operation is aborted using Stop-NaClone, it may take some time
to stop the clone operation. User should poll Get-NaClone till status return
ed is 'completed'. When status returned is 'completed' after Stop-NaClone, t
he clone operation has been stopped successfully.


PARAMETERS
-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

-VolumeUuid <String>
UUID of volume on which this clone exists. If not specified, it will get
the status of all running and failed clone operations on the filer. If
a volume object is passed in via the pipeline, this cmdlet can use its
Uuid value.

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

-CloneId <Decimal>
ID information of the clone operation. If not specified, it will get the
status of all running and failed clone operations on the filer.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
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
NetApp.Ontapi.Filer.Clone73.OpsInfo


NOTES


Category: clone
API: clone-list-status

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

C:\PS>Get-NaClone


Get status of all running and failed clone operations on the current control
ler.


SourceFile : /vol/vol2/lun1
DestinationFile : /vol/vol2/lun1clone
CloneState : running
TotalBytes : 21476192256
PercentDone : 11
BytesCopied : 65654784
CloneType : lun
CloneId : 12
Error :
Reason :


-------------- Example 2 --------------

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


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


SourceFile : /vol/vol2/lun2
DestinationFile : /vol/vol2/lun2clone
CloneState : running
TotalBytes : 21476192256
PercentDone : 8
BytesCopied : 0
CloneType : lun
CloneId : 12
Error :
Reason :



RELATED LINKS
Start-NaClone
Stop-NaClone
Clear-NaClone







 Data ONTAP® PowerShell Toolkit