Set-CsVoiceTestConfiguration
Topic Last Modified: 2012-03-27
Modifies a test scenario you can use to test phone numbers against specified routes and rules.
Syntax
Set-CsVoiceTestConfiguration [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-DialedNumber <String>] [-ExpectedRoute <String>] [-ExpectedTranslatedNumber <String>] [-ExpectedUsage <String>] [-Force <SwitchParameter>] [-TargetDialplan <String>] [-TargetVoicePolicy <String>] [-WhatIf [<SwitchParameter>]]
Set-CsVoiceTestConfiguration [-Confirm [<SwitchParameter>]] [-DialedNumber <String>] [-ExpectedRoute <String>] [-ExpectedTranslatedNumber <String>] [-ExpectedUsage <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-TargetDialplan <String>] [-TargetVoicePolicy <String>] [-WhatIf [<SwitchParameter>]]
Detailed 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.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsVoiceTestConfiguration 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 "Set-CsVoiceTestConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
String |
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. |
Instance |
Optional |
TestConfiguration |
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-CsVoiceTestConfiguraton cmdlet. |
DialedNumber |
Optional |
String |
The phone number you want to use to test the policies, usages, and so on. Must be 512 characters or fewer. |
ExpectedRoute |
Optional |
String |
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. |
ExpectedTranslatedNumber |
Optional |
String |
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 Test-CsVoiceTestConfiguration and the DialedNumber does not result in the value in ExpectedTranslatedNumber, the test will report as Fail. Must be 512 characters or fewer. |
ExpectedUsage |
Optional |
String |
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 Get-CsPstnUsage. Must be 256 characters or fewer. |
TargetDialplan |
Optional |
String |
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. |
TargetVoicePolicy |
Optional |
String |
The Identity of the voice policy against which to run this test. Voice policies can be retrieved by calling Get-CsVoicePolicy. Must be 40 characters or fewer. |
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.Policy.Voice.TestConfiguration object. Accepts pipelined input of voice test configuration objects.
Return Types
This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration.
Example
-------------------------- 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.