Share via

  • Article

Remove-CsVoicePolicy

 

Topic Last Modified: 2012-03-24

Removes the specified voice policy.

Syntax

Remove-CsVoicePolicy -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

This cmdlet removes an existing voice policy. Voice policies are used to manage such Enterprise Voice-related features as simultaneous ringing (the ability to have a second phone ring each time someone calls your office phone) and call forwarding. This cmdlet can also be used to remove the global voice policy. In that case, however, the policy will not actually be removed; instead, the policy settings will simply be reset to their default values.

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

Parameters

Parameter Required Type Description

Identity

Required

XdsIdentity

A unique identifier specifying the scope, and in some cases the name, of the policy to be removed.

Force

Optional

SwitchParameter

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

WhatIf

Optional

SwitchParameter

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

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Input Types

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. Accepts pipelined input of voice policy objects.

Return Types

This cmdlet does not return a value. It removes an instance of a Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object.

Example

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

Remove-CsVoicePolicy -Identity UserVoicePolicy1

This example removes the UserVoicePolicy1 per-user voice policy settings.

-------------------------- Example 2 --------------------------

Get-CsVoicePolicy -Filter tag* | Remove-CsVoicePolicy

This example removes all the voice policy settings that can be assigned to specific users. First the Get-CsVoicePolicy cmdlet is called with a Filter of tag*, which retrieves all the per-user voice policies. That collection of policies is then piped to the Remove-CsVoicePolicy cmdlet to be removed.