Remove-CsRoutingConfiguration
Topic Last Modified: 2012-03-27
Resets the routing configuration to its default settings.
Syntax
Remove-CsRoutingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Voice routes contain instructions that tell Microsoft Lync Server 2010 how to route calls from Enterprise Voice users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). This cmdlet removes the global (and only) routing configuration, which is a container for all voice routes defined for a Lync Server 2010 deployment. "Removing" the routing configuration doesn’t actually remove it; the Global (and only) instance is still there. However, it does set the list of voice routes to the default settings.
WARNING: Removing the routing configuration (in other words, setting the list of voice routes to the default) deletes all defined voice routes for a Lync Server 2010 deployment and replaces them with a single route with default settings.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsRoutingConfiguration 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-CsRoutingConfiguration"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
XdsIdentity |
The scope of the routing configuration to remove. This value must be Global. |
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.Policy.Voice.PSTNRoutingSettings object. Accepts pipelined input of a routing configuration object.
Return Types
This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings.
Example
-------------------------- Example 1 --------------------------
Remove-CsRoutingConfiguration -Identity Global -Confirm
This example resets the Global (and only) routing configuration to the default settings. This action deletes all defined voice routes, so we added the Confirm parameter in order to receive a prompt asking whether we really want to perform this action before the removal takes place.
See Also
Other Resources
New-CsRoutingConfiguration
Set-CsRoutingConfiguration
Get-CsRoutingConfiguration
Remove-CsVoiceRoute
Get-CsVoiceRoute