[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

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 PSTN gateways.

Syntax

Get-CsOutboundTranslationRule [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsOutboundTranslationRule [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter Required Type Description

Identity

Optional

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.

Filter

Optional

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.

LocalStore

Optional

SwitchParameter

Retrieves the outbound translation rule from the local replica of the Central Management database, rather than the Central Management database itself.

Detailed Description

Call this cmdlet to retrieve an existing outbound translation rule. Microsoft Communications Server 2010 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 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.

Return Types

This cmdlet retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule.

Examples

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

Copy Code
Get-CsOutboundTranslationRule

This example retrieves all outbound translation rules for the Microsoft Communications Server deployment.

-------------------------- Example 2 --------------------------

Copy Code
Get-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond"

This example retrieves a single outbound translation rule, the rule with Identity site:Redmond/Prefix Redmond.

-------------------------- Example 3 --------------------------

Copy Code
Get-CsOutboundTranslationRule -Filter site:*

This example retrieves all site-level outbound translation rules. The command calls Get-CsOutboundTranslationRule with a Filter of site:*, which will return a collection of all rules with Identity values beginning with the string site:.