[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Creates a bandwidth policy in memory that can be applied to the bandwidth policy profile. In Microsoft Communications Server 2010, the policy applies to either audio or video bandwidth.

Syntax

New-CsNetworkBWPolicy -BWLimit <UInt32> -BWPolicyModality <Audio | Video> -BWSessionLimit <UInt32>

Parameters

Parameter Required Type Description

BWLimit

Required

Int32

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

Int32

The maximum bandwidth, in kbps, allowed for a single session of the type specified in the BWPolicyModality parameter.

Detailed Description

This cmdlet creates a new bandwidth policy. A bandwidth policy is used to define bandwidth limitations for certain modalities. (In Communications 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. 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 it is also possible to assign audio and video policies directly to a profile by calling the New-CsNetworkBandwidthPolicyProfile or Set-CsNetworkBandwidthPolicyProfile cmdlet.

Return Types

Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType.

Examples

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

Copy Code
$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 --------------------------

Copy Code
$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 simply 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 just happens to be the variable containing the new bandwidth policy we just created in Line 1.