Share via

  • Article

Get-CsNetworkBandwidthPolicyProfile

 

Topic Last Modified: 2012-03-23

Retrieves one or more network bandwidth policy profiles.

Syntax

Get-CsNetworkBandwidthPolicyProfile [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]

Get-CsNetworkBandwidthPolicyProfile [-Filter <String>] [-LocalStore <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 retrieves one or more container profiles for these policies.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkBandwidthPolicyProfile cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsNetworkBandwidthPolicyProfile"}

Parameters

Parameter Required Type Description

Identity

Optional

XdsGlobalRelativeIdentity

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

Filter

Optional

String

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

LocalStore

Optional

SwitchParameter

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

Input Types

None.

Return Types

Returns an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType.

Example

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

Get-CsNetworkBandwidthPolicyProfile

Calling Get-CsNetworkBandwidthPolicyProfile with no parameters will retrieve all bandwidth policy profiles defined within the Lync Server 2010 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”.