Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Start-NaNdmpCopy


NAME
Start-NaNdmpCopy

SYNOPSIS
Copy content between controllers using NDMP.

SYNTAX
Start-NaNdmpCopy [-SrcController] <IPAddress> [-SrcPath] <String> [[-DstCont
roller] <IPAddress>] [-DstPath] <String> [-SrcCredential <PSCredential>] [-D
stCredential <PSCredential>] [-SrcAuthType <NdmpMessageAuthType>] [-DstAuthT
ype <NdmpMessageAuthType>] [-SrcPort <Int32>] [-DstPort <Int32>] [-Version <
Int16>] [-Exclude <String>] [-Level <Int32>] [-UseIpv6] [-Transient] [<Commo
nParameters>]

Start-NaNdmpCopy [-SrcController] <IPAddress> [-SrcPath] <String> [[-DstCont
roller] <IPAddress>] [-DstPath] <String> [-SrcCredential <PSCredential>] [-D
stCredential <PSCredential>] [-SrcAuthType <NdmpMessageAuthType>] [-DstAuthT
ype <NdmpMessageAuthType>] [-SrcPort <Int32>] [-DstPort <Int32>] [-Version <
Int16>] [-Exclude <String>] [-UseIpv6] -IncrementalForever [-Transient] [<Co
mmonParameters>]


DESCRIPTION
Copy content between controllers using NDMP. Unlike Invoke-NaNdmpCopy, Star
t-NaNdmpCopy runs asynchronously. Once the operation has been started the c
mdlet will return. Use Get-NaNdmpCopy to retrieve the status of a running N
DMP copy operation. The PowerShell session must remain open for the duratio
n of the NDMP copy operation or the operation will fail.


PARAMETERS
-SrcController <IPAddress>
IP address of the source controller. For controllers operating in Clust
er-Mode, this must be an IP of the node hosting the volume containing th
e content to be copied.

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

-SrcPath <String>
Absolute path of the source directory to transfer. For a controller ope
rating in 7-mode, must start with /vol/<volname>. For a controller oper
ating in Cluster-Mode, must start with /<vserver>/<volname>.

Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DstController <IPAddress>
IP address of the destination controller. For controllers operating in
Cluster-Mode, this must be an IP of the node hosting the destination vol
ume.

If not specified, the SrcController is used as the destination.

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DstPath <String>
Absolute path of the destination directory. If it does not exist, it wi
ll be created. For a controller operating in 7-mode, must start with /v
ol/<volname>. For a controller operating in Cluster-Mode, must start wi
th /<vserver>/<volname>.

Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SrcCredential <PSCredential>
Credential to use to authenticate connection to source controller. For
controllers operating in Cluster-Mode, credentials are configured using
the CLI command "system services ndmp password". If not supplied and th
e SrcAuthType is not None, the credentials cache will be consulted. If
no credentials are found, the cmdlet will fail.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DstCredential <PSCredential>
Credential to use to authenticate connection to destination controller.
For controllers operating in Cluster-Mode, credentials are configured u
sing the CLI command "system services ndmp password". If not supplied a
nd the DstAuthType is not None, the credentials cache will be consulted.
If no credentials are found, the cmdlet will fail.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SrcAuthType <NdmpMessageAuthType>
Authentication type to use when authenticating connection to source cont
roller. Possible values: text, md5, none. Default is none.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DstAuthType <NdmpMessageAuthType>
Authentication type to use when authenticating connection to destination
controller. Possible values: text, md5, none. Default is none.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SrcPort <Int32>
Port to connect to NDMP service on the source controller. Default is 10
000.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DstPort <Int32>
Port to connect to NDMP service on the destination controller. Default
is 10000.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Version <Int16>
NDMP version to use when communicating with source and destination contr
ollers. Must be at least 3, Default is 4.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Exclude <String>
Exclude string.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Level <Int32>
The incremental level to be used for the transfer is restricted to 0, 1
or 2 only. The default level used is 0.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-UseIpv6
If specified, the cmdlet will attempt to connect the source and destinat
ion controllers using IPv6. If either the source or destination does no
t support IPv6, IPv4 will be used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Transient
If specified, the NDMP copy operation is not added to the global Current
NaNdmpCopyOps variable.

The output of Start-NaNdmpCopy must be captured to track the pro
gress.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-IncrementalForever
If specified, use the "incremental forever" level.

Required? true
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.PowerShell.SDK.Cmdlets.Ndmp.NaNdmpCopyOp


NOTES


Category: ndmp

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

C:\PS>Start-NaNdmpCopy 192.168.0.200 /vol/twofer_vol0/content 192.168.0.201
/vol/donaghy_vol0/bkup -srcAuthType md5 -dstAuthType md5


Use NDMP to copy the contents of /vol/twofer_vol0/content on controller 192.
168.0.200 to /vol/donaghy_vol0/bkup on controller 192.168.0.201.


State : RUNNING
SrcConnection : 192.168.0.200
DstConnection : 192.168.0.201
SrcPath : /vol/twofer_vol0/content/
DstPath : /vol/donaghy_vol0/bkup/
BackupState : DATA_STATE_ACTIVE
RestoreState : DATA_STATE_ACTIVE
BackupHaltReason : DATA_HALT_NA
RestoreHaltReason : DATA_HALT_NA
BackupBytesProcessed : 0
BackupBytesRemain : 0
RestoreBytesProcessed : 0
Id : 1



RELATED LINKS
Stop-NaNdmpCopy
Get-NaNdmpCopy







 Data ONTAP® PowerShell Toolkit