Get-CsVoiceTestConfiguration
Topic Last Modified: 2012-03-23
Retrieves a test scenario you can use to test phone numbers against specified routes and rules.
Syntax
Get-CsVoiceTestConfiguration [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsVoiceTestConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]
Detailed Description
This cmdlet retrieves the voice route, usage, dial plan, and voice policy against which to test a specified phone number. 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 testing by retrieving a test configuration with this cmdlet, and then running that scenario with the Test-CsVoiceConfiguration cmdlet.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsVoiceTestConfiguration cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsVoiceTestConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsGlobalRelativeIdentity |
A string uniquely identifying the test configuration you want to retrieve. |
Filter |
Optional |
String |
This parameter provides a way to do a wildcard search of the defined voice test configurations. (For details, see the examples in this topic.) |
LocalStore |
Optional |
SwitchParameter |
Retrieves the voice test configuration from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
Returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration.
Example
-------------------------- Example 1 --------------------------
Get-CsVoiceTestConfiguration
Retrieves all the voice test configuration settings.
-------------------------- Example 2 --------------------------
Get-CsVoiceTestConfiguration | Select-Object Identity, DialedNumber, ExpectedTranslatedNumber
This example retrieves all the voice test configuration settings, displaying only the Identity, DialedNumber, and ExpectedTranslatedNumber parameter of each. The settings returned by Get-CsVoiceTestConfiguration are piped to the Select-Object cmdlet, where the output is narrowed down to the Identity, DialedNumber, and ExpectedTranslatedNumber properties.
-------------------------- Example 3 --------------------------
Get-CsVoiceTestConfiguration -Filter *test*
This example uses the Filter parameter to retrieve all the voice test configuration settings with Identities that contain the string "test". The wildcard characters (*) at the beginning and end of the filter value indicate that the string "test" can be located anywhere within the Identity, with any characters before or after that string. For example, this command would return voice test configurations with names such as TestConfig, VoiceNumberTest, and VoiceTest1.