|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Start-NaCopyOffload
NAME
Start-NaCopyOffload
SYNOPSIS
Copy specified whole/sub source file to specified destination file. This ope
ration is handled asynchronously.
SYNTAX
Start-NaCopyOffload [-Source] <String> [-Destination] <String> [[-SourceOffs
et] <Int64>] [[-DestinationOffset] <Int64>] [[-Length] <Int64>] [-Controller
<NaController>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Copy specified whole/sub source file to specified destination file. This ope
ration is handled asynchronously. Source and destination files must exist. T
he calling entity must poll for a status indication, via the copyoffload-cop
y-status, until either a failure or completed state is returned.
*WARNING*: A copy operation which does not complete successfully may still
have copied some portion of the source to the destination: a copy operation
involves multiple iterations of data copy before completing and may fail aft
er some number of sub-copy operations. The caller should reissue the copy op
eration request to either reattempt the operation or to restore the destinat
ion to its previous content. Copy operations are not persistent over reboots
or takeover scenarios.
PARAMETERS
-Source <String>
Full path of the source file from where the data will be copied, in /vol
/<volume-name>/<file-path> format.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Destination <String>
Full path of the destination file to where the data will be copied, in /
vol/<volume-name>/<file-path> format.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SourceOffset <Int64>
Byte offset in source file which to start the copy of data, aligned on a
512 byte boundary. If not specified, copy will start at beginning of fi
le.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DestinationOffset <Int64>
Byte offset in the destination file to begin copying data into, aligned
to a 4,096 byte boundary. If not specified, copy will start at beginning
of file.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Length <Int64>
Number of bytes to copy from the source file to the destination file. Th
e byte count must be a multiples of 4,096. If not specified, the source
file is copied from the source offset to the end of file. An error of EC
OL_COPY_INVALIDINPUTERROR will be returned if length is zero or not a mu
ltiple of 4,096.
Required? false
Position? 5
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
-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
<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.Copyoffload735.CopyoffloadStatusInfo
NOTES
Category: copyoffload
API: copyoffload-copy-start
-------------- Example 1 --------------
C:\PS>Start-NaCopyOffload /vol/vol1/copy /vol/vol1/copy2
Copies the file located at /vol/vol1/copy to the file /vol/vol1/copy2.
BytesCopied : 0
CopyId : ada4e460-3cfe-11e0-adb2-00a09826e442
CopyoffloadError : 0
CopyoffloadState : running
DestinationPath : /vol/vol1/copy2
Length : 681867016
SourcePath : /vol/vol1/copy
CopyoffloadErrorSpecified : True
RELATED LINKS
Stop-NaCopyOffload
Get-NaCopyOffload
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|