Topic Last Modified: 2011-03-30

Removes the specified instant messaging (IM) filter configuration. (IM filter settings are used to prevent users from sending instant messages that contain hyperlinks.)

Syntax


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

Parameters

Parameter	Required	Type	Description
Identity	Required	XdsIdentity	The unique identity of the configuration to be removed. This will be either Global or Site:<site name> (where <site name> represents the name of the site to which the settings apply). Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity
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.

Detailed Description

When sending instant messages, users can embed a Uniform Resource Identifier (URI) within the text of that message to refer other participants in the conversation to a particular website or share. Microsoft Lync Server 2010 can be configured so that hyperlinks with certain prefixes are blocked or are not active. (In other words, the participants can’t simply click the link and be taken to the site the URI refers to; they must copy and paste the link manually into a browser.)

The Remove-CsImFilterConfiguration cmdlet removes the IM filter configuration for a specified identity (such as a specific site). Running this cmdlet against the Global identity will simply reset the global configuration to the default settings.

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

Input Types

Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. Accepts pipelined input of IM filter configuration objects.

Return Types

Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration.

Example

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

	Copy Code
Remove-CsImFilterConfiguration -Identity site:Redmond

In Example 1, Remove-CsImFilterConfiguration is used to remove the IM filter configuration with the Identity site:Redmond. When an IM filter configuration is removed from a site, that site will automatically begin using the global settings in its place.

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

	Copy Code
Get-CsImFilterConfiguration -Filter site:* \| Remove-CsImFilterConfiguration

In Example 2, all the IM filter configurations at the site scope are removed. To carry out this task, the command first uses Get-CsImFilterConfiguration and the Filter parameter to return all the configurations at the site scope; the wildcard string site:* tells Get-CsImFilterConfiguration to return only those configurations that have an Identity that begins with the string value site:. The filtered collection of configurations is then piped to Remove-CsImFilterConfiguration, which deletes each configuration in the collection.