Remove-CsNetworkInterSitePolicy
Topic Last Modified: 2012-03-24
Removes a network inter-site policy that defines bandwidth limitations between sites that are directly linked within a call admission control (CAC) configuration.
Syntax
Remove-CsNetworkInterSitePolicy -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
When network sites share a direct link, bandwidth limitations for audio and video connections can be defined between those two sites. This cmdlet removes a network site policy that associates a bandwidth limitation policy with two directly connected sites.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsNetworkInterSitePolicy 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-CsNetworkInterSitePolicy"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
XdsGlobalRelativeIdentity |
The unique identifier of the network site policy you want to remove. Network site policies are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that site policy. |
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.NetworkConfiguration.InterNetworkSitePolicyType object. Accepts pipelined input of network inter-site policy objects.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType.
Example
-------------------------- Example 1 --------------------------
Remove-CsNetworkInterSitePolicy -Identity Reno_Portland
This example removes the network site policy with the Identity Reno_Portland.
-------------------------- Example 2 --------------------------
Get-CsNetworkInterSitePolicy | Remove-CsNetworkInterSitePolicy
In Example 2, we remove all network site policies defined within the CAC configuration. We begin by calling Get-CsNetworkInterSitePolicy to retrieve a collection of all network site policies. That collection is then piped to the Remove-CsNetworkInterSitePolicy cmdlet, which removes each item in the collection.
See Also
Other Resources
New-CsNetworkInterSitePolicy
Set-CsNetworkInterSitePolicy
Get-CsNetworkInterSitePolicy