See Also
Topic Last Modified: 2013-03-06
Creates a new voice routing policy. Voice routing policies manage PSTN usages for users of hybrid voice. Hybrid voice enables users homed on Lync Online to take advantage of the Enterprise Voice capabilities available in an on-premises installation of Lync Server 2013. This cmdlet was introduced in Lync Server 2013.
Syntax
New-CsVoiceRoutingPolicy -Identity <XdsIdentity>
[-Confirm [<SwitchParameter>]] [-Description <String>]
[-Force <SwitchParameter>] [-InMemory
<SwitchParameter>] [-Name <String>] [-PstnUsages
<PSListModifier>] [-WhatIf [<SwitchParameter>]]
|
Examples
Example 1
The command shown in Example 1 creates a new per-user voice routing policy with the Identity RedmondVoiceRoutingPolicy. This policy is assigned a single PSTN usage: Long Distance.
 Copy Code |
|
|---|---|
New-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -Name "RedmondVoiceRoutingPolicy" -PstnUsages "Long Distance" |
|
Example 2
Example 2 is a variation of the command shown in Example 1; in this case, however, the new policy is assigned three PSTN usages: Long Distance; Local; Internal. Multiple usages can be assigned simply by separating each usage using a comma.
| Copy Code |
|
|---|---|
New-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -Name "RedmondVoiceRoutingPolicy" -PstnUsages "Long Distance", "Local", "Internal" |
|
Detailed Description
Voice routing policies are used in "hybrid" scenarios: when some of your users are homed on the on-premises version of Lync Server and other users are homed on Lync Online. Assigning your Lync Online users a voice routing policy enables those users to receive and to place phones calls to the public switched telephone network by using your on-premises SIP trunks.
Note that simply assigning a user a voice routing policy will not enable them to make PSTN calls via Lync Online. Among other things, you will also need to enable those users for Enterprise Voice and will need to assign them an appropriate voice policy and dial plan.
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 command-line interface prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsVoiceRoutingPolicy"}
Lync Server Control Panel: The functions carried out by the New-CsVoiceRoutingPolicy cmdlet are not available in the Lync Server Control Panel.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Rtc.Management.Xds.XdsIdentity |
Unique identifier to be assigned to the new voice routing policy. Because you can only create new policies at the per-user scope, the Identity will always be the "name" being assigned to the policy. For example: -Identity "RedmondVoiceRoutingPolicy" |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Description |
Optional |
System.String |
Enables administrators to provide explanatory text to accompany a voice routing policy. For example, the Description might include information about the users the policy should be assigned to. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
InMemory |
Optional |
System.Management.Automation.SwitchParameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
Name |
Optional |
System.String |
A friendly name describing this policy. |
|
PstnUsages |
Optional |
System.Management.Automation.PSListModifier |
A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice routing policy. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the Get-CsPstnUsage cmdlet.) |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
None. The New-CsVoiceRoutingPolicy cmdlet does not accept pipelined input.
Return Types
The New-CsVoiceRoutingPolicy cmdlet creates new instances of Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object.
