Edit

Share via

Remove-CsVoiceConfiguration

Module:
Skype for Business Server PowerShell

Resets the voice configuration to its default values. This cmdlet was introduced in Lync Server 2010.

Syntax

Default (Default) 

Remove-CsVoiceConfiguration
    [-Identity] <XdsIdentity>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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 Skype for Business 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 Skype for Business Server deployment. After calling this cmdlet, a call to the Get-CsVoiceTestConfiguration cmdlet will return no results.

Examples

Example 1

Remove-CsVoiceConfiguration -Identity Global -Confirm

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.

Parameters

-Confirm

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

Prompts you for confirmation before executing the command.

Parameter properties

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

Parameter sets

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

-Force

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

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

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

-Identity

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

The scope of the voice configuration to remove. This value must be Global.

Parameter properties

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

Parameter sets

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

-WhatIf

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

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

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

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

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration

Accepts pipelined input of a voice configuration object.

Outputs

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration

This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration.