Remove-CsBandwidthPolicyServiceConfiguration
Topic Last Modified: 2012-03-27
Removes an existing bandwidth policy service configuration.
Syntax
Remove-CsBandwidthPolicyServiceConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<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. This cmdlet removes a bandwidth policy service configuration defined at the site level. You can also use the cmdlet to “remove” the global bandwidth policy service; however, the global service will not actually be removed, it will simply be reset to its default values.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsBandwidthPolicyServiceConfiguration cmdlet locally: 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 "Remove-CsBandwidthPolicyServiceConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
XdsIdentity |
The unique identifier of the configuration you want to remove. 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). |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration object. Accepts pipelined input of bandwidth policy service configuration objects.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration.
Example
-------------------------- Example 1 --------------------------
Remove-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond
This example removes the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond).
-------------------------- Example 2 --------------------------
Get-CsBandwidthPolicyServiceConfiguration | Where-Object {$_.EnableLogging -eq $False} | Remove-CsBandwidthPolicyServiceConfiguration
Example 2 removes all bandwidth policy service configurations where logging is disabled. To accomplish this, the example begins with a call to Get-CsBandwidthPolicyServiceConfiguration. This will return a collection of all bandwidth policy service configurations in the Lync Server 2010 deployment. This collection is then piped to the Where-Object cmdlet, which narrows the collection down to only those configurations where the EnableLogging property is equal to (-eq) False ($False). This leaves a collection of configurations that have logging disabled. This collection is then piped to Remove-CsBandwidthPolicyServiceConfiguration, which removes every item in the collection.