See Also
Topic Last Modified: 2013-02-22
Resets the voice configuration to its default values. This cmdlet was introduced in Lync Server 2010.
Syntax
Remove-CsVoiceConfiguration -Identity <XdsIdentity>
[-Confirm [<SwitchParameter>]] [-Force
<SwitchParameter>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example resets the Global (and only) voice configuration to the default values. This action deletes all defined voice test configurations, so we added the Confirm parameter in order to receive a prompt asking whether we really want to perform this action before the removal takes place.
 Copy Code |
|
|---|---|
Remove-CsVoiceConfiguration -Identity Global -Confirm |
|
Detailed Description
Voice test configurations are used to test a phone number against a specific voice policy, route, and dial plan. This cmdlet removes the global (and only) voice configuration, which is a container for all voice test configurations defined for a Lync Server deployment. "Removing" the voice configuration doesn’t actually remove it; the global instance is still there. However, it does set the list of voice test configurations to the default, which is empty.
WARNING: Removing the voice configuration (which sets the list of voice test configurations to empty) deletes all defined voice test configurations for a Lync Server deployment. After calling this cmdlet, a call to the Get-CsVoiceTestConfiguration cmdlet will return no results.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsVoiceConfiguration 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 "Remove-CsVoiceConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Rtc.Management.Xds.XdsIdentity |
The scope of the voice configuration to remove. This value must be Global. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. Accepts pipelined input of a voice configuration object.
Return Types
This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration.
