Removes the specified instant message filter configuration. (Instant message 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 settings 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 |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
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. |
Detailed Description
When sending instant messages, users can embed a URI within the text of that message to refer other participants in the conversation to a particular Web site or share. Microsoft Communications Server 2010can be configured so that hyperlinks with certain prefixes are blocked or are not active. (In other words, the participants can’t simply click on the link and be taken to whatever the URI refers to; they must copy and paste the link manually into a browser.)
The Remove-CsImFilterConfiguration cmdlet removes the instant messaging filter settings for a specified identity (such as a specific site). Running this cmdlet against the Global identity will simply reset the global settings to the default configuration.
Return Types
Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsImFilterConfiguration -Identity site:Redmond |
|
In the example shown above, Remove-CsImFilterConfiguration is used to remove the instant message filter configuration with the Identity site:Redmond. When an instant message 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 instant message filter settings that have been configured 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 policies configured at the site scope; the wildcard site:* tells Get-CsImFilterConfiguration to return only those settings that have an Identity that begins with the string value site:. The filtered collection of policies is then piped to Remove-CsImFilterConfiguration, which deletes each setting in the collection.