Get-CsNetworkBandwidthPolicyProfile

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Retrieves one or more network bandwidth policy profiles. This cmdlet was introduced in Lync Server 2010.

Syntax

Get-CsNetworkBandwidthPolicyProfile
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-LocalStore]
   [<CommonParameters>]
Get-CsNetworkBandwidthPolicyProfile
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]

Description

As part of call admission control (CAC), a bandwidth policy is used to define bandwidth limitations for certain modalities. (In Skype for Business Server, only audio and video modalities can be assigned bandwidth limitations.) This cmdlet retrieves one or more container profiles for these policies.

Examples

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

Get-CsNetworkBandwidthPolicyProfile

Calling the Get-CsNetworkBandwidthPolicyProfile cmdlet without any parameters will retrieve all bandwidth policy profiles defined within the Skype for Business Server deployment.

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

Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile

This example retrieves the bandwidth policy profile with the Identity LowBWProfile. Because identities must be unique this will return, at most, one profile.

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

Get-CsNetworkBandwidthPolicyProfile -Filter *50MB*

In this example we use the Filter parameter to specify one or more profiles to retrieve based on a wildcard string. We've used the string 50MB, which indicates that we want to retrieve all the bandwidth policy profiles with Identity values that contain the string 50MB anywhere within the value. For example, this would retrieve profiles with identities such as "BW profile for 50MB links", "50MB audio limit", and "video limits of 50MB".

Parameters

-Filter

A string containing wildcards that is used to retrieve bandwidth policy profiles that have Identity values that match the wildcard pattern.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Identity

A string value that uniquely identifies the bandwidth policy profile you want to retrieve. Specifying an Identity will retrieve, at most, one profile.

Type:XdsGlobalRelativeIdentity
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-LocalStore

Retrieves the network bandwidth policy profile from the local replica of the Central Management store, rather than the Central Management store itself.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType