New-CsNetworkBWPolicy
Topic Last Modified: 2012-03-25
Creates a bandwidth policy in memory that can be applied to the bandwidth policy profile. In Microsoft Lync Server 2010, the policy applies to either audio or video bandwidth.
Syntax
New-CsNetworkBWPolicy -BWLimit <UInt32> -BWPolicyModality <Audio | Video> -BWSessionLimit <UInt32>
Detailed Description
This cmdlet creates a new bandwidth policy. A bandwidth policy is used to define bandwidth limitations for certain modalities. (In Lync Server 2010, only audio and video modalities can be assigned bandwidth limitations.) The bandwidth policy is created only in memory, so the output must be assigned to a variable and then passed as a value to the BWPolicy parameter of the New-CsNetworkBandwidthPolicyProfile or Set-CsNetworkBandwidthPolicyProfile cmdlet. Bandwidth policies are applied to policy profiles, which can store multiple policies for a single profile and are part of the global network configuration for call admission control (CAC).
Note that the recommended method of assigning audio and video policies is to assign them directly to a bandwidth policy profile by calling the New-CsNetworkBandwidthPolicyProfile or Set-CsNetworkBandwidthPolicyProfile cmdlet and specifying values for the AudioBWLimit, AudioBWSessionLimit, VideoBWLimit, and VideoBWSessionLimit parameters.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsNetworkBWPolicy 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 "New-CsNetworkBWPolicy"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
BWLimit |
Required |
UInt32 |
The maximum total bandwidth, in kbps, for all concurrent sessions of the type specified in the BWPolicyModality parameter. |
BWPolicyModality |
Required |
BWPolicyModality |
Determines which type of bandwidth is limited. Valid values: Audio, Video |
BWSessionLimit |
Required |
UInt32 |
The maximum bandwidth, in kbps, allowed for a single session of the type specified in the BWPolicyModality parameter. |
Input Types
None.
Return Types
Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType.
Example
-------------------------- Example 1 --------------------------
$bwp = New-CsNetworkBWPolicy -BWLimit 200 -BWSessionLimit 3000 -BWPolicyModality video
This example creates a new bandwidth policy and assigns it to the variable $bwp. All parameters for the New-CsNetworkBWPolicy cmdlet are required. In this example we specified a total bandwidth limit (BWLimit) of 2000 kbps and a bandwidth session limit (BWSessionLimit) of 300 kbps, and we applied these limits to video sessions (-BWPolicyModality video).
-------------------------- Example 2 --------------------------
$bwp = New-CsNetworkBWPolicy -BWLimit 200 -BWSessionLimit 3000 -BWPolicyModality video
New-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -BWPolicy $bwp
Example 2 expands on Example 1 by assigning the new bandwidth policy to a policy profile. The command in line 1 is identical to Example 1: it creates video bandwidth limitations. Line 2 then calls New-CsNetworkBandwidthPolicyProfile to add that policy to a new profile. The new profile receives an Identity of LowBWLimit. Then we use the BWPolicy parameter, giving it the value $bwp, which is the variable containing the new bandwidth policy we just created in Line 1.