Topic Last Modified: 2013-02-21
Retrieves the routing configuration object, which contains a list of all voice routes defined within a Lync Server deployment. This cmdlet was introduced in Lync Server 2010.
Syntax
Get-CsRoutingConfiguration [-Identity
<XdsIdentity>] <COMMON PARAMETERS>
|
Get-CsRoutingConfiguration [-Filter <String>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-LocalStore
<SwitchParameter>]
|
Examples
EXAMPLE 1
This example retrieves the routing configuration. To retrieve individual voice routes, use the Get-CsVoiceRoute cmdlet.
Copy Code | |
---|---|
Get-CsRoutingConfiguration |
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 is used to retrieve the global instance that holds a list of all voice routes defined within the Lync Server deployment. To retrieve individual voice routes or to retrieve them as individual objects rather than as a list, use the Get-CsVoiceRoute cmdlet.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsRoutingConfiguration cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsRoutingConfiguration"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Filter |
Optional |
System.String |
There can be only one instance of this object, so this parameter does nothing. |
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
The scope of the routing configuration to retrieve. The only possible value is Global. |
LocalStore |
Optional |
System.Management.Automation.SwitchParameter |
Retrieves the routing configuration from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
The Get-CsRoutingConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.Writable.Policy.Voice.PSTNRoutingSettings object.