Topic Last Modified: 2012-08-13
Resets the routing configuration to its default settings. This cmdlet was introduced in Lync Server 2010.
Syntax
Remove-CsRoutingConfiguration -Identity
<XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force
<SwitchParameter>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
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.
Copy Code | |
---|---|
Remove-CsRoutingConfiguration -Identity Global -Confirm |
Detailed Description
Voice routes contain instructions that tell Lync Server 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 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 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 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
The scope of the routing configuration to remove. This value must be Global. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually 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.