Share via

  • Article

Get-CsRoutingConfiguration

 

Topic Last Modified: 2012-03-23

Retrieves the routing configuration object, which contains a list of all voice routes defined within a Microsoft Lync Server 2010 deployment.

Syntax

Get-CsRoutingConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsRoutingConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Detailed Description

Voice routes contain instructions that tell 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 is used to retrieve the global instance that holds a list of all voice routes defined within the Lync Server 2010 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

Identity

Optional

XdsIdentity

The scope of the routing configuration to retrieve. The only possible value is Global.

Filter

Optional

String

There can be only one instance of this object, so this parameter does nothing.

LocalStore

Optional

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

Get-CsRoutingConfiguration returns instances of the Microsoft.Rtc.Management.Writable.Policy.Voice.PSTNRoutingSettings object.

Example

-------------------------- Example 1 --------------------------

Get-CsRoutingConfiguration

This example retrieves the routing configuration. To retrieve individual voice routes, use the Get-CsVoiceRoute cmdlet.