Get-CsBandwidthPolicyServiceConfiguration
Topic Last Modified: 2012-03-23
Retrieves one or more bandwidth policy service configurations.
Syntax
Get-CsBandwidthPolicyServiceConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsBandwidthPolicyServiceConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]
Detailed Description
Call admission control (CAC) is a way of determining whether to allow real-time communications sessions, such as voice or video calls, to be established based on bandwidth constraints. Within the Microsoft Lync Server 2010 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. Bandwidth Policy service is the component that performs CAC functionality in the Lync Server 2010 deployment, enabling the decision as to whether sufficient bandwidth exists for a call to be established. The Get-CsBandwidthPolicyServiceConfiguration cmdlet retrieves settings for one or more bandwidth policy services.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsBandwidthPolicyServiceConfiguration 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-CsBandwidthPolicyServiceConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
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). |
Filter |
Optional |
String |
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 every configuration with an Identity that matches the wildcard pattern. For example, the Filter value site:* will retrieve all configurations with Identity values that begin with the string site: and end with any set of characters. |
LocalStore |
Optional |
SwitchParamter |
Retrieves the bandwidth policy service configuration from the local replica of the Central Management store, rather than from the Central Management store itself. |
Input Types
None.
Return Types
Returns one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration.
Example
-------------------------- Example 1 --------------------------
Get-CsBandwidthPolicyServiceConfiguration
Example 1 retrieves all bandwidth policy service configurations defined within the Microsoft Lync Server 2010 implementation.
-------------------------- Example 2 --------------------------
Get-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond
This example retrieves the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond).
-------------------------- Example 3 --------------------------
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 --------------------------
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 in Example 1, this cmdlet retrieves a collection of all configurations defined within the Lync 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.