Set-CsOnlineVoiceRoute

Syntax

Set-CsOnlineVoiceRoute
   [-Tenant <Guid>]
   [-Description <String>]
   [-NumberPattern <String>]
   [-OnlinePstnUsages <PSListModifier>]
   [-OnlinePstnGatewayList <PSListModifier>]
   [-Priority <Int32>]
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CsOnlineVoiceRoute
   [-Tenant <Guid>]
   [-Description <String>]
   [-NumberPattern <String>]
   [-OnlinePstnUsages <PSListModifier>]
   [-OnlinePstnGatewayList <PSListModifier>]
   [-Priority <Int32>]
   [-Instance <PSObject>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to modify an existing online voice route. Online voice routes are associated with online voice policies through online public switched telephone network (PSTN) usages. A online 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.

This cmdlet is used when configuring Microsoft Phone System Direct Routing.

Examples

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

PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -Description "Test Route"

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

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

PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"}

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

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

PS C:\> $x = (Get-CsOnlinePstnUsage).Usage

PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{replace=$x}

This example modifies the online voice route named Route1 to populate that route's list of online PSTN usages with all the existing usages for the organization. The first command in this example retrieves the list of global online PSTN usages. Notice that the call to the Get-CsOnlinePstnUsage 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 online PSTN usages, is assigned to the variable $x. In the second line of this example, the Set-CsOnlineVoiceRoute cmdlet is called to modify the online voice route with the identity Route1. Notice the value passed to the OnlinePstnUsages parameter: @{replace=$x}. This value says to replace everything in the OnlinePstnUsages list for this route with the contents of $x, which contain the online PSTN usages list retrieved in line 1.

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

PS C:\> $x = Get-CsOnlineVoiceRoute -Identity Route1

PS C:\> $x.Name = "RouteA"

PS C:\> Set-CsOnlineVoiceRoute -Instance $x

This set of commands changes the Name property of the online 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-CsOnlineVoiceRoute cmdlet is called to retrieve the online 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-CsOnlineVoiceRoute cmdlet to make the change.

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

PS C:\> $y = Get-CsOnlineVoiceRoute -Identity Route1

PS C:\> $y.OnlinePstnGatewayList.Add("192.168.0.100")

PS C:\> Set-CsOnlineVoiceRoute -Instance $y

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

Parameters

Inputs

System.Management.Automation.PSObject

Outputs

System.Object

Related Links

• Get-CsOnlineVoiceRoute
• New-CsOnlineVoiceRoute
• Remove-CsOnlineVoiceRoute