Set-CsNetworkBandwidthPolicyProfile

Syntax

Set-CsNetworkBandwidthPolicyProfile [-Identity <XdsGlobalRelativeIdentity>] [-AudioBWLimit <String>] [-AudioBWSessionLimit <String>] [-BWPolicy <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-VideoBWLimit <String>] [-VideoBWSessionLimit <String>] [-WhatIf [<SwitchParameter>]]

Set-CsNetworkBandwidthPolicyProfile [-AudioBWLimit <String>] [-AudioBWSessionLimit <String>] [-BWPolicy <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-VideoBWLimit <String>] [-VideoBWSessionLimit <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

As part of call admission control (CAC), a bandwidth policy is used to define bandwidth limitations for certain modalities. (In Microsoft Lync Server 2010 only audio and video modalities can be assigned bandwidth limitations.) This cmdlet modifies a container profile for these policies.

IMPORTANT: If a profile contains multiple policies (for example, one audio policy and one video policy), modifying the profile by using the AudioBWLimit, AudioBWSessionLimit, VideoBWLimit, or VideoBWSessionLimit properties will remove all existing policies in the profile and replace them with the new values. If the profile contained a policy to limit video and you set only the AudioBWLimit parameter, the video policy will be removed and an audio policy created.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsNetworkBandwidthPolicyProfile cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsNetworkBandwidthPolicyProfile"}

Parameters

Input Types

Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType object. Accepts pipelined input of network bandwidth policy profile objects.

Return Types

This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType.

Example

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

Set-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile -Description "Policy for links of less than 10MB"

This example modifies the description of the bandwidth policy profile with the identity LowBWProfile. It does this by calling Set-CsNetworkBandwidthPolicyProfile with two parameters: Identity, specifying the name of the profile to modify; and Description, specifying the new description of the profile.

-------------------------- Example 2 --------------------------

Set-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -VideoBWLimit 2500 -VideoBWSessionLimit 300

Example 2 modifies the overall limit and session limit of video transmissions for the bandwidth policy profile with the Identity LowBWLimit. After specifying the Identity of the profile to modify, we next use the VideoBWLimit parameter to set the overall video limit to 2500. We then use the VideoBWSessionLimit parameter to set the individual session limit to 300. This command will add a video profile or update an existing video profile for the LowBWLimit bandwidth policy profile. Any existing audio profiles will be unaffected.

-------------------------- Example 3 --------------------------

$bp = New-CsNetworkBWPolicy -BWLimit 5000 -BWSessionLimit 200 -BWPolicyModality video
Set-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -BWPolicy $bp

In this example a new bandwidth policy is created and assigned to the bandwidth policy profile with the Identity LowBWLimit. The first line in this example is a call to the New-CsNetworkBWPolicy cmdlet. This cmdlet creates a new profile, in this case a video profile (-BWPolicyModality video) with a limit of 5000 kbps (-BWLimit 5000) and a session limit of 200 kbps (-BWSessionLimit 200). This new profile object is stored in the variable $bp. The next line in this example calls Set-CsNetworkBandwidthPolicyProfile to modify the profile LowBWLimit (-Identity LowBWLimit). The BWPolicy parameter is used with a value of $bp. This replaces any existing policies of this profile with the newly created policy we stored in the $bp variable.

-------------------------- Example 4 --------------------------

$a = Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile
$ap = New-CsNetworkBWPolicy -BWLimit 2000 -BWSessionLimit 300 -BWPolicyModality audio
$a.BWPolicy.Add($ap)
Set-CsNetworkBandwidthPolicyProfile -Instance $a

Example 4 adds a new audio bandwidth policy to the set of existing policies in the profile LowBWProfile. In line 1 we call Get-CsNetworkBandwidthPolicyProfile to retrieve the profile with the Identity LowBWProfile. We store that profile in the variable $a. In the next line we call New-CsNetworkBWPolicy to create a new bandwidth policy. This policy is an audio policy (-BWPolicyModality audio) with a limit of 2000 kbps (-BWLimit 2000) and a session limit of 300 kbps (-BWSessionLimit 300). This new policy is stored in variable $ap.

In line 3 we add the new audio policy (stored in $ap) to the profile we retrieved in line 1 (and stored in variable $a). We do this by calling the Add method of the BWPolicy property of the profile, passing a value of $ap. This can be read as "Add the new policy stored in $ap to the BWPolicy of profile LowBWProfile (stored in $a)."

Finally, we call Set-CsNetworkBandwidthPolicyProfile to update the LowBWProfile profile. We use the Instance parameter, passing a value of $a, which contains our modified profile.

-------------------------- Example 5 --------------------------

$ap = New-CsNetworkBWPolicy -BWLimit 2000 -BWSessionLimit 300 -BWPolicyModality audio
Set-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile -BWPolicy @{add=$ap}

Example 5 is identical in functionality to Example 4: it adds a new audio policy to the existing list of policies for profile LowBWProfile. This method requires fewer lines, but may not be quite as clear. We’ve included it here simply to demonstrate that there are different ways to do the same thing.

In line 1 we create a new audio bandwidth policy, setting a bandwidth limit (2000) and a session limit (300) and storing the new object in the variable $ap. Next we call Set-CsNetworkBandwidthPolicyProfile to modify the profile with the Identity LowBWProfile. We use the BWPolicy parameter to modify the list of policies within the profile. Notice the value we’ve passed to this parameter: @{add=$ap}. This is simply a way in Windows PowerShell to add something to a list. You start with the @ sign followed by a set of curly braces {}. Within those curly braces you specify the action you want to take on the list, in this case we want to add to the list. (You can also remove or replace.) We follow the action (add) with an equal sign, followed by the object we want to add to the list, in this case the new policy stored in variable $ap.

See Also

Other Resources

New-CsNetworkBandwidthPolicyProfile
Remove-CsNetworkBandwidthPolicyProfile
Get-CsNetworkBandwidthPolicyProfile
New-CsNetworkBWPolicy