See Also
Topic Last Modified: 2013-02-22
Retrieves one or more outbound translation rules. An outbound translation rule converts phone numbers to the local dialing format for interaction with private branch exchange (PBX) systems and public switched telephone network (PSTN) gateways. This cmdlet was introduced in Lync Server 2010.
Syntax
Get-CsOutboundTranslationRule [-Identity
<XdsIdentity>] <COMMON PARAMETERS>
|
Get-CsOutboundTranslationRule [-Filter <String>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-LocalStore
<SwitchParameter>]
|
Examples
EXAMPLE 1
This example retrieves all outbound translation rules for the Lync Server deployment.
 Copy Code |
|
|---|---|
Get-CsOutboundTranslationRule |
|
EXAMPLE 2
This example retrieves a single outbound translation rule: the rule with Identity site:Redmond/Prefix Redmond.
| Copy Code |
|
|---|---|
Get-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" |
|
EXAMPLE 3
This example retrieves all site-level outbound translation rules. The command calls the Get-CsOutboundTranslationRule cmdlet with a Filter of site:*, which will return a collection of all rules with Identity values beginning with the string site:.
| Copy Code |
|
|---|---|
Get-CsOutboundTranslationRule -Filter site:* |
|
Detailed Description
Call this cmdlet to retrieve an existing outbound translation rule. Lync Server normalizes phone numbers to E.164 format. However, many private branch exchange (PBX) systems aren’t able to work with this format. Outbound translations rules translate the number to the local dialing format prior to sending the number to the Mediation Server or gateway.
Each outbound translation rule is associated with a trunk configuration. More than one outbound translation rule can be associated with each trunk configuration. Therefore, the Identity for each rule consists of a scope along with a name that is unique within the scope (in the format scope/name, for example site:Redmond/OBR1). The rule is automatically associated with the trunk configuration with the same scope.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsOutboundTranslationRule 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-CsOutboundTranslationRule"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Filter |
Optional |
System.String |
Performs a wildcard search on Identity that allows you to narrow down your results to only those outbound translation rules whose identities match the given wildcard string. |
|
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
The unique identifier for the outbound translation rule you want to retrieve. The Identity consists of the scope followed by a unique name within each scope (for example, site:Redmond/OutboundRule1). Specifying a value for Identity will return at most one outbound translation rule. |
|
LocalStore |
Optional |
System.Management.Automation.SwitchParameter |
Retrieves the outbound translation rule from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
This cmdlet retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule.
