Data ONTAP® PowerShell Toolkit

Cmdlet: Invoke-NaSnapmirrorThrottle


NAME
Invoke-NaSnapmirrorThrottle

SYNOPSIS
Changes the max transfer rate of an active transfer.

SYNTAX
Invoke-NaSnapmirrorThrottle [-Destination] <String> [-MaxTransferRate] <Int3
2> [-Controller <NaController>] [-WarningAction <ActionPreference>] [-Warnin
gVariable <String>] [<CommonParameters>]


DESCRIPTION
Changes the max transfer rate of an active transfer. The API can be issued t
o either the source or the destination filer.


PARAMETERS
-Destination <String>
The destination location of the active transfer. The destination locati
on is of the volume form: <filer>:<volume> or the qtree form: <filer>:/v
ol/<volume>/<qtree>.

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

-MaxTransferRate <Int32>
Maximum transfer rate in kilobytes per second. A value '0' disables the
throttle, i.e. the filer will transfer as fast as it can. Range: 0..2^
32-1.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Controller <NaController>
The DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

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

-WarningAction <ActionPreference>


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

-WarningVariable <String>


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.Snapmirror.SnapmirrorStatusInfo


NOTES


Category: snapmirror
API: snapmirror-throttle

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

C:\PS>Invoke-NaSnapmirrorThrottle benson:dunn_vol2_mirror 1024


Limit transfer rate to 1 MB per second.


BaseSnapshot :
Contents : -
CurrentTransferError :
CurrentTransferType : initialize
DestinationLocation : benson:dunn_vol2_mirror
LagTime : 0
LastTransferDuration : 0
LastTransferFrom : -
LastTransferSize : 0
LastTransferType :
MirrorTimestamp : 0
SourceLocation : dunn:vol2
State : uninitialized
Status : transferring
TransferProgress : 710592



RELATED LINKS
Get-NaSnapmirror







 Data ONTAP® PowerShell Toolkit