Get-CsVoiceConfiguration
Topic Last Modified: 2012-08-13
Retrieves the voice configuration object, which contains a full list of all voice test configurations defined for the Lync Server deployment. This cmdlet was introduced in Lync Server 2010.
Get-CsVoiceConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsVoiceConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]
This example retrieves the voice configuration. To retrieve the voice test configurations, use the Get-CsVoiceTestConfiguration cmdlet.
Get-CsVoiceConfiguration
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 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"}
| Parameter | Required | Type | Description |
|---|---|---|---|
| Filter | Optional | System.String | There can only be one instance of this object, so this parameter does nothing. |
| Identity | Optional | Microsoft.Rtc.Management.Xds.XdsIdentity | The scope of the voice configuration to retrieve. The only possible value is Global. |
| LocalStore | Optional | System.Management.Automation.SwitchParameter | Retrieves the voice configuration from the local replica of the Central Management store, rather than the Central Management store itself. |
None.
This cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object.
