Edit

Share via

Get-CsVoiceTestConfiguration

Module:
Skype for Business Server PowerShell

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

Syntax

Identity 

Get-CsVoiceTestConfiguration
    [[-Identity] <XdsGlobalRelativeIdentity>]
    [-LocalStore]
    [<CommonParameters>]

Filter 

Get-CsVoiceTestConfiguration
    [-Filter <String>]
    [-LocalStore]
    [<CommonParameters>]

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.

Examples

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 the Get-CsVoiceTestConfiguration cmdlet 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.

Parameters

-Filter

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

This parameter provides a way to do a wildcard search of the defined voice test configurations. (For details, see the examples in this topic.)

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Filter
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

A string uniquely identifying the test configuration you want to retrieve.

Parameter properties

Type:XdsGlobalRelativeIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalStore

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Retrieves the voice test configuration from the local replica of the Central Management store, rather than the Central Management store itself.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration

Returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration.