|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Start-NaClone
NAME
Start-NaClone
SYNOPSIS
Starts a file/LUN or sub-file/sub-LUN clone operation.
SYNTAX
Start-NaClone [-SourcePath] <String> [[-DestinationPath] <String>] [-NoSnap]
[-ChangeLog] [-BlockRanges <BlockRange[]>] [-IgnoreStreams] [-IgnoreLocks]
[-Controller <NaController>] [<CommonParameters>]
DESCRIPTION
Starts a file/LUN or sub-file/sub-LUN clone operation.
In Data ONTAP 8.0 and earlier, if the clone operation starts successfully, a
unique clone ID is returned. The user is supposed to poll Get-NaClone spec
ifying the clone ID to get the status of the clone operation. When Get-NaCl
one returns status as completed, the user can consider that the clone operat
ion has been completed successfully. If the user gets the status as failed,
theuser is responsible for doing Clear-NaClone which will clean the status
of the clone operation.
In Data ONTAP 8.1 and later, this API performs a file/LUN or sub-file/sub-LU
N clone operation synchronously. When this cmdlet returns successfully, the
destination file is ready for use.
PARAMETERS
-SourcePath <String>
Full path of the source file or LUN in /vol/<volume-name>/<file-path> fo
rmat.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DestinationPath <String>
Full path of the Destination file or LUN in /vol/<volume-name>/<file-pat
h> format. Destination path should be in same flexible volume where sou
rce file is located. If not specified, the destination is taken as the
source appended with "Clone". For sub-file/sub-LUN clone operation with
in same file/LUN, the destination path is not required.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoSnap
If NoSnap is false or unspecified, then a temporary snapshot will be tak
en and source file locked in snapshot will be considered for cloning. So
that the clone operation does not get affected by writes to the source
file in parallel to the clone operation. User will get atomic point in t
ime copy of the source. Irrespective of clone operation completes succe
ssfully or unsuccessfully, any temporary snapshot taken for cloning will
be deleted automatically.
If NoSnap is "true", then the source file in AFS will be used for clonin
g. In this case user may get random data in clone if source file is modi
fied while clone operation is in progress. This option should only be us
ed when user is assured that the source file will remain consistent duri
ng the clone operation.
Destination file is not protected against any modification while clone o
peration is in progress. User should use the destination file or destina
tion block ranges after clone operation is finished.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-ChangeLog
If this option is "true", fingerprints of data blocks of the destination
file/block ranges created will be change logged to the change log file
if A-SIS is enabled on the volume. With change logging clone operation w
ill be slow, as to get fingerprints all the data blocks will be read.
Without change logging clone operation deals with only indirect blocks w
ithout reading data blocks. Without change logging, fingerprints of the
clone blocks are not recorded. The clone blocks are shared with the sour
ce blocks, but as later the source blocks are modified, corresponding cl
one blocks will no longer be shared. If change logging option is not use
d, clone blocks, which could be involved in sharing with rest of the fil
e system, can not be shared in next sis operation. The only option, in c
ase user had not used change logging while creating clone, will be to st
art sis from beginning using "sis start -s" to gather fingerprints of cl
one blocks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BlockRanges <BlockRange[]>
List of block ranges for sub-file/sub-LUN cloning. For sub-LUN cloning t
he block range specified will be considered as SCSI LBA range. For one s
et of source and destination block range followings are error conditions
: 1) If source and destination block ranges overlap. 2) Source or destin
ation block range is out of file. If multiple set of block ranges are sp
ecified in one clone operation, then user is responsible for different b
lock ranges do not overlap with each other. Each set of block range will
be processed one by one for cloning. So, user may get random data if di
fferent set of block ranges overlap with each other.
Each block range is an instance of type DataONTAP.Types.Clone.BlockRange
.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IgnoreStreams
If specified, clone only the base file and ignore streams on source or d
estination.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IgnoreLocks
If specified, clone even if (advisory/mandatory) byte_range locks or sha
re_mode locks exist on the source or destination.
Required? false
Position? named
Default value
Accept pipeline input? false
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
<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-start
Privilege: api-clone-list-status
-------------- Example 1 --------------
C:\PS>Start-NaClone /vol/vol2/lun1 /vol/vol2/lun1clone
Create a clone 'lun1clone' of LUN 'lun1'.
SourceFile : /vol/vol2/lun1
DestinationFile : /vol/vol2/lun1clone
CloneState : running
TotalBytes : 21476192256
PercentDone : 0
BytesCopied : 0
CloneType : lun
CloneId : 12
Error :
Reason :
-------------- Example 2 --------------
C:\PS>Get-NaLun /vol/vol2/lun1 | Start-NaClone
Clone LUN 'lun1' and accept the default destination name 'lun1Clone'.
RELATED LINKS
Get-NaClone
Stop-NaClone
Clear-NaClone
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|