Set-CsVoiceTestConfiguration

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Modifies a test scenario you can use to test phone numbers against specified routes and rules. This cmdlet was introduced in Lync Server 2010.

Syntax

Set-CsVoiceTestConfiguration
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-DialedNumber <String>]
   [-ExpectedRoute <String>]
   [-ExpectedTranslatedNumber <String>]
   [-ExpectedUsage <String>]
   [-TargetDialplan <String>]
   [-TargetVoicePolicy <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CsVoiceTestConfiguration
   [-Instance <PSObject>]
   [-DialedNumber <String>]
   [-ExpectedRoute <String>]
   [-ExpectedTranslatedNumber <String>]
   [-ExpectedUsage <String>]
   [-TargetDialplan <String>]
   [-TargetVoicePolicy <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Before implementing voice routes and voice policies, it's a good idea to test them out on various phone numbers to ensure the results are what you're expecting. You can do this by modifying test scenarios with this cmdlet.

The Set-CsVoiceTestConfiguration cmdlet modifies the voice route, usage, dial plan and voice policy against which to test a specified phone number. All of this information can be defined and retrieved using other cmdlets, as specified in the parameter descriptions for this topic.

The configurations modified with this cmdlet are tested using the Test-CsVoiceTestConfiguration cmdlet.

Examples

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

Set-CsVoiceTestConfiguration -Identity TestConfig1 -DialedNumber 14255551212

This example sets the dialed number of the voice test configuration for TestConfig1 to 14255551212. This is the number that will be checked against the voice policy and route to ensure normalization occurs as expected, as well as to ensure the correct routes and dial plans are being applied.

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

Set-CsVoiceTestConfiguration -Identity TestConfig1 -TargetDialPlan site:Redmond1 -ExpectedTranslatedNumber "+912065551212"

This example modifies settings for the voice test configuration TestConfig1. The command sets the TargetDialPlan to the dial plan for site:Redmond1. Because a change in dial plan could mean a change in normalization rules, the ExpectedTranslationNumber has also been changed to reflect what is expected from the normalization rules for that dial plan.

Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-DialedNumber

The phone number you want to use to test the policies, usages, and so on.

Must be 512 characters or fewer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-ExpectedRoute

The name of the voice route expected to be used during the configuration test. If a different route is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available voice routes by calling the Get-CsVoiceRoute cmdlet.

Must be 256 characters or fewer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-ExpectedTranslatedNumber

The phone number in the format you expect to see it in after translation. This is the value of the DialedNumber parameter after normalization. If you run the Test-CsVoiceTestConfiguration cmdlet and the DialedNumber does not result in the value in ExpectedTranslatedNumber, the test will report as Fail.

Must be 512 characters or fewer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-ExpectedUsage

The name of the PSTN usage expected to be used during the configuration test. If a different PSTN usage is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available usages by calling the Get-CsPstnUsage cmdlet.

Must be 256 characters or fewer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Force

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Identity

A string uniquely identifying the test scenario you want to modify.

The value of this parameter does not include scope because this object can be created only at the global scope. Therefore only a name is required.

Type:XdsGlobalRelativeIdentity
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Instance

An object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration that contains an existing voice test configuration with the changes you'd like to make to that configuration. An object of this type can be retrieved by calling the Get-CsVoiceTestConfiguration cmdlet.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-TargetDialplan

The Identity of the dial plan to be used for this test. Dial plans can be retrieved by calling the Get-CsDialPlan cmdlet.

Must be 40 characters or fewer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-TargetVoicePolicy

The Identity of the voice policy against which to run this test. Voice policies can be retrieved by calling the Get-CsVoicePolicy cmdlet.

Must be 40 characters or fewer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. Accepts pipelined input of voice test configuration objects.

Outputs

This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration.