Remove-CsOutboundTranslationRule
Topic Last Modified: 2012-03-25
Removes an existing outbound translation rule. An outbound translation rule converts phone numbers to the local dialing format for interaction with private branch exchange (PBX) systems.
Syntax
Remove-CsOutboundTranslationRule -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Call this cmdlet to remove an existing outbound translation rule. Microsoft Lync 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. That means that using this cmdlet to remove a rule will remove it from the trunk configuration at the corresponding scope.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsOutboundTranslationRule 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-CsOutboundTranslationRule"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
XdsIdentity |
The unique identifier of the outbound translation rule you want to remove. The Identity consists of the scope followed by a unique name within each scope. For example, site:Redmond/OutboundRule1. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule object. Accepts pipelined input of outbound translation rule objects.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule.
Example
-------------------------- Example 1 --------------------------
Remove-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond"
This example removes an existing outbound translation rule for site Redmond named Prefix Redmond. Identities are unique, so this command will delete a single rule.
-------------------------- Example 2 --------------------------
Get-CsOutboundTranslationRule -Filter site:* | Remove-CsOutboundTranslationRule
This example removes all site-level outbound translation rules. The first part of the command is a call to Get-CsOutboundTranslationRule with a Filter of site:*, which will return a collection of all rules with Identity values beginning with site:. This collection is then piped to Remove-CsOutboundTranslationRule, which removes each rule in the collection.
See Also
Other Resources
New-CsOutboundTranslationRule
Set-CsOutboundTranslationRule
Get-CsOutboundTranslationRule