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

Retrieves one or more bandwidth policy service configurations.


Get-CsBandwidthPolicyServiceConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsBandwidthPolicyServiceConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description




The unique identifier of the configuration you want to retrieve. This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond).




A string containing one or more wildcard characters that will be used to search the Identity property of all bandwidth policy service configurations to find all configurations whose Identity matches the wildcard pattern. For example, The Filter value site:* will retrieve all configurations whose Identity values begin with the string site: and end with any set of characters.




Retrieves the bandwidth policy service configuration from the local replica of the Central Management database, rather than the Central Management database itself.

Detailed Description

Call admission control (CAC) is a way of managing bandwidth for non-data transmissions. In Microsoft Communications Server 2010, this means managing the bandwidth available for audio and video transmissions. Within the Communications Server implementation of CAC, regions, sites, and subnets are defined within a network along with the relationships and links between those entities in order to place bandwidth constraints between them. The bandwidth policy service enables the decision as to whether sufficient bandwidth exists for a call to be completed. This cmdlet retrieves settings for one or more bandwidth policy services.

Return Types

Returns one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration.


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

Copy Code

Example 1 retrieves all bandwidth policy service configurations defined within the Microsoft Communications Server 2010 implementation.

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

Copy Code
Get-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond

This example retrieves the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond).

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

Copy Code
Get-CsBandwidthPolicyServiceConfiguration -Filter site:*

In this example we use the Filter parameter to retrieve all bandwidth policy service configurations defined at the site level. We do this by passing the value site:* to the Filter parameter. This will search the Identity property of all bandwidth policy service configurations for values that begin with site: and are followed by any other characters. Because all site-level configurations have Identity values beginning with site: and followed by the name of the site, this filter will find all configurations for all sites.

-------------------------- Example 4 --------------------------

Copy Code
Get-CsBandwidthPolicyServiceConfiguration | Where-Object {$_.MaxLogFileSizeMb -gt 4}

Example 4 retrieves all bandwidth policy service configurations that allow log files to reach sizes greater than four megabytes. The example begins with a call to the Get-CsBandwidthPolicyServiceConfiguration cmdlet. As we saw in Example 1, this cmdlet retrieves a collection of all configurations defined within the Communications Server deployment. This collection is then piped to the Where-Object cmdlet. Where-Object cycles through the collection one item at a time. For each item in the collection, Where-Object checks to see whether the value of the MaxLogFileSizeMb property is greater than (-gt) 4. If it is, that item remains part of the collection and is part of the command output. If the value of MaxLogFileSizeMb is not greater than 4, the item is ignored and will not be returned.