• Article

Get-CsVoiceConfiguration

 

Topic Last Modified: 2012-03-23

Retrieves the voice configuration object, which contains a full list of all voice test configurations defined for the Microsoft Lync Server 2010 deployment.

Syntax

Get-CsVoiceConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsVoiceConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Detailed Description

Voice test configurations are used to test a phone number against a specific voice policy, route, and dial plan. This cmdlet is used to retrieve the global instance that holds a list of all voice test configurations defined within the Lync Server 2010 deployment. To retrieve individual voice test configurations or to retrieve them as individual objects rather than as a list, use the Get-CsVoiceTestConfiguration cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsVoiceConfiguration 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-CsVoiceConfiguration"}

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

The scope of the voice configuration to retrieve. The only possible value is Global.

Filter

Optional

String

There can only be one instance of this object, so this parameter does nothing.

LocalStore

Optional

SwitchParameter

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

Input Types

None.

Return Types

This cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object.

Example

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

Get-CsVoiceConfiguration

This example retrieves the voice configuration. To retrieve the voice test configurations, use the Get-CsVoiceTestConfiguration cmdlet.