Removes a network bandwidth policy profile.
Syntax
Remove-CsNetworkBandwidthPolicyProfile -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsGlobalRelativeIdentity |
A string value that uniquely identifies the bandwidth policy profile you want to remove. Specifying an Identity will remove, at most, one profile. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
As part of call admission control (CAC), a bandwidth policy is used to define bandwidth limitations for certain modalities. (In Microsoft Communications Server 2010 only audio and video modalities can be assigned bandwidth limitations.) This cmdlet removes a container profile for these policies.
IMPORTANT: If a profile has been assigned to a site (using the New-CsNetworkSite or Set-CsNetworkSite cmdlet) it cannot be removed: you will receive an error if you try to remove the profile by calling Remove-CsNetworkBandwidthPolicyProfile. You must first remove the profile from all sites, then you can remove the profile.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile |
|
This example removes the bandwidth policy profile with the Identity LowBWProfile. Because identities must be unique this will remove, at most, one profile.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkSite | Where-Object {$_.BWPolicyProfileID -eq "LowBWProfile"} | Set-CsNetworkSite -BWPolicyProfileID $null
Remove-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile
|
|
Example 2 removes all references to the bandwidth policy profile with the Identity LowBWProfile from all sites to which it has been assigned, then removes that profile. The first line of this example begins with a call toGet-CsNetworkSite to retrieve all sites configured for call admission control (CAC). This collection of sites is then piped to Where-Object, which looks for only those sites with a BWPolicyProfileID that is equal to (-eq) LowBWProfile. This narrowed-down collection, containing only sites with a BWPolicyProfileID value of LowBWProfile, is piped to Set-CSNetworkSite, which modifies each of these sites to change the BWPolicyProfileID to Null ($null). What we’ve just done is to find all sites with a BWPolicyProfileID of LowBWProfile and set that value to Null. At this point there are no sites using the LowBWProfile profile. What that means is that we can now safely call Remove-CsNetworkBandwidthPolicyProfile on the profile LowBWProfile to remove the profile, knowing that the profile is not in use. Which is exactly what we do in line 2.