Creates a new network bandwidth policy profile. This cmdlet can also be used to set the bandwidth policies within the profile.
Syntax
New-CsNetworkBandwidthPolicyProfile -Identity <XdsGlobalRelativeIdentity> [-AudioBWLimit <String>] [-AudioBWSessionLimit <String>] [-BWPolicy <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-VideoBWLimit <String>] [-VideoBWSessionLimit <String>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsGlobalRelativeIdentity |
A string value that uniquely identifies the policy. All bandwidth policy profiles are created at the global scope. Therefore the scope is implied and only a unique name needs to be specified when creating a new bandwidth policy profile. Note that this value also populates the BWPolicyProfileID property of the profile. |
|
AudioBWLimit |
Optional |
Int32 |
The maximum amount of bandwidth to allocate for all audio connections. If a single audio session will cause the audio bandwidth limit to be exceeded, that session will not be allowed to start. Expressed in kbps. For example a value of 1000 would be 1000 kbps. |
|
AudioBWSessionLimit |
Optional |
Int32 |
The maximum amount of bandwidth to allocate for any one audio session. Expressed in kbps. |
|
VideoBWLimit |
Optional |
Int32 |
The maximum amount of bandwidth to allocate for all video connections. If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. Expressed in kbps. For example a value of 1000 would be 1000 kbps. |
|
VideoBWSessionLimit |
Optional |
Int32 |
The maximum amount of bandwidth to allocate for any one video session. Expressed in kbps. |
|
BWPolicy |
Optional |
PSListModifier |
A list of objects containing bandwidth policy profiles. Each object in the list consists of a bandwidth modality (audio or video), a bandwidth limitation, and a bandwidth session limitation. Objects in the list must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType. Objects of this type can be created by calling the New-CsNetworkBWPolicy cmdlet. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Description |
Optional |
String |
A description of the bandwidth policy profile. For example, you can use this parameter to clarify the expected use of the profile. |
|
InMemory |
Optional |
SwitchParameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
As part of call admission control (CAC), a bandwidth policy is used to define bandwidth limitations for certain modalities. (In Microsoft Communications Server 2010 only audio and video modalities can be assigned bandwidth limitations.) This cmdlet creates a container profile for these policies. There are three ways to define the individual policies within the container: 1) Define the audio and video bandwidth limitations when you call this cmdlet to create the profile; 2) Create the profile using this cmdlet then set the audio and video policies later using the Set-CsNetworkBandwidthPolicyProfile cmdlet; or 3) Create the profile with this cmdlet, create the policies by calling the New-CsNetworkBWPolicy cmdlet then calling Set-CsNetworkBandwidthPolicyProfile to add the policies to a profile.
Bandwidth policy profiles are applied to network sites by calling the New-CsNetworkSite or Set-CsNetworkSite cmdlets.
Return Types
Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
New-CsNetworkBandwidthPolicyProfile -Identity LowBWLimits -AudioBWLimit 2000 -AudioBWSessionLimit 200 -VideoBWLimit 1400 -VideoBWSessionLimit 500 |
|
Example 1 creates a new bandwidth policy profile named LowBWLimits. This new profile will have two policies assigned, an audio policy and a video policy (the only two policies possible in Communications Server 2010). The audio policy is added to the profile by using the AudioBWLimit parameter to assign a limit of – in this case – 2000 kbps to overall audio connections and the AudioBWSessionLimit parameter to assign 200 kbps as the limit for individual audio sessions. The same is done to create video session limits, but using the VideoBWLimit and VideoBWSessionLimit parameters.