Set-CsVoiceRoute

Syntax

Set-CsVoiceRoute
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-AlternateCallerId <String>]
   [-Description <String>]
   [-NumberPattern <String>]
   [-Priority <Int32>]
   [-PstnGatewayList <PSListModifier>]
   [-PstnUsages <PSListModifier>]
   [-SuppressCallerId <Boolean>]
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-CsVoiceRoute
   [-Instance <PSObject>]
   [-AlternateCallerId <String>]
   [-Description <String>]
   [-NumberPattern <String>]
   [-Priority <Int32>]
   [-PstnGatewayList <PSListModifier>]
   [-PstnUsages <PSListModifier>]
   [-SuppressCallerId <Boolean>]
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Description

Use this cmdlet to modify an existing voice route. Voice routes are associated with voice policies through public switched telephone network (PSTN) usages. A voice route includes a regular expression that identifies which phone numbers will be routed through a given voice route: phone numbers matching the regular expression will be routed through this route.

Examples

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

Set-CsVoiceRoute -Identity Route1 -Description "Test Route"

This command sets the Description of the Route1 voice route to "Test Route."

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

Set-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"}

The command in this example modifies the voice route with the identity Route1 to add the PSTN usage Long Distance to the list of usages for this voice route. Long Distance must be in the list of global PSTN usages (which can be retrieved with a call to the Get-CsPstnUsage cmdlet).

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

$x = (Get-CsPstnUsage).Usage

Set-CsVoiceRoute -Identity Route1 -PstnUsages @{replace=$x}

This example modifies the voice route named Route1 to populate that route's list of PSTN usages with all the existing usages for the organization. The first command in this example retrieves the list of global PSTN usages. Notice that the call to the Get-CsPstnUsage cmdlet is in parentheses; this means that we first retrieve an object containing PSTN usage information. (Because there is only one--global--PSTN usage, only one object will be retrieved.) The command then retrieves the Usage property of this object. That property, which contains a list of PSTN usages, is assigned to the variable $x. In the second line of this example, the Set-CsVoiceRoute cmdlet is called to modify the voice route with the identity Route1. Notice the value passed to the PstnUsages parameter: @{replace=$x}. This value says to replace everything in the PstnUsages list for this route with the contents of $x, which contain the PSTN usages list retrieved in line 1.

-------------------------- Example 4 --------------------------

$x = Get-CsVoiceRoute -Identity Route1

$x.Name = "RouteA"

Set-CsVoiceRoute -Instance $x

This set of commands changes the Name property of the voice route with the identity Route1 to RouteA. Changing the Name property automatically changes the Identity property, in this case to RouteA.

In the first line, the Get-CsVoiceRoute cmdlet is called to retrieve the voice route with the identity Route1. The returned object is stored in the variable $x. Next, the Name property of that object is assigned the string value "RouteA". Finally, the object (contained in the variable $x) is passed to the Instance parameter of the Set-CsVoiceRoute cmdlet to make the change.

-------------------------- Example 5 --------------------------

$y = Get-CsVoiceRoute -Identity Route1

$y.PstnGatewayList.Add("PstnGateway:192.168.0.100")

Set-CsVoiceRoute -Instance $y

This example modifies the voice route named Route1 and populates that route's list of PSTN gateways (PstnGatewayList) with the server role of the gateway with the identity PstnGateway:192.168.0.100. In the first line of this example, the Get-CsVoiceRoute cmdlet is called to retrieve the voice route we want to modify, in this case Route1. Next we call the Add method on the PstnGatewayList property of Route1. We pass the Add method the Identity of the service we want to add. Finally, we call the Set-CsVoiceRoute cmdlet, passing the Instance parameter the variable $y, which will update Route1 (stored in $y) with the newly-added PSTN gateway.

Parameters

-AlternateCallerId

-Confirm

-Description

-Force

-Identity

-Instance

-NumberPattern

-Priority

-PstnGatewayList

-PstnUsages

-SuppressCallerId

-WhatIf

Inputs

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. The Set-CsVoiceRoute cmdlet accepts pipelined input of voice route objects.

Outputs

The Set-CsVoiceRoute cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object.

Related Links

• New-CsVoiceRoute
• Remove-CsVoiceRoute
• Get-CsVoiceRoute
• Test-CsVoiceRoute
• Get-CsPstnUsage
• Get-CsService