Cmdlets > Set-DtBandwidthLimit

Set-DtBandwidthLimit

Sets bandwidth limiting

Syntax

Set-DtBandwidthLimit [-ServiceHost] <Server> [-JobId] <Guid> [-BandwidthLimit] <BandwidthLimit> [-ConnectionId <Guid>] [<CommonParameters>]

Set-DtBandwidthLimit [-ServiceHost] <Server> [-BandwidthLimit] <BandwidthLimit> [-ConnectionId <Guid>] -JobInfo <JobInfo> [<CommonParameters>]

Detailed Description

This cmdlet sets bandwidth limiting for the specified job .

Parameters

Name	Type	Description	Required	Pipeline Input
Service Host	Server	Specify the server object returned from the New-DtServer cmdlet. For this cmdlet, the -ServiceHost should be your target server.	true	false
JobId	Guid	Specify the job GUID returned from the New-DtJob cmdlet or the Id within the job information returned from the Get-DtJob cmdlet.	true	false
Bandwidth Limit	BandwidthLimit	Specify the bandwidth limit configuration from Get-DtBandwidthLimit.	true	false
Connection Id	ConnectionId	Specify the connection ID returned from the Get-DtConnectionIds cmdlet.	false	false
JobInfo	JobInfo	Specify the job information returned from the Get-DtJob cmdlet. The job information can be piped from the Get-DtJob cmdlet and used in this cmdlet.	true	true

Outputs

None

Examples

$DtServerObjectBeta = New-DtServer -Name beta -UserName domain\administrator -Password password

$DtJobForAlpha = Get-DtJob -ServiceHost $DtServerObjectBeta | Where-Object { $_.Statistics.CoreConnectionDetails.SourceMachineName -eq $DtServerObjectAlpha}

$DtFixedBandwidth = Get-DtBandwidthLimit -ServiceHost $DtServerObjectBeta -JobId $DtJobForAlpha.Id

$DtFixedBandwidth.Mode = "Fixed"

$DtFixedBandwidth.Limit = 100000

Set-DtBandwidthLimit -ServiceHost $DtServerObjectBeta -JobId $DtJobForAlpha.Id -BandwidthLimit $DtFixedBandwidth

Disconnect-DtServer -ServiceHost $DtServerObjectBeta

A server object is created for the server beta using the domain\administrator and password credentials. It assigns the server object to the variable called DtServerObjectBeta. The job(s) are retrieved from DtServerObjectBeta, but only the job information where the source machine name is equivalent to the name stored in the variable DtServerObjectAlpha is retrieved. That information is then stored in the variable DtJobForAlpha. The bandwidth limiting configuration is then stored in DtFixedBandwidth. The Mode is then changed to fixed and the Limit is set to 100,000 bytes/second. Finally, the bandwidth settings are applied to the job. The connections for the server object are then closed.