Removes the specified instant message file transfer filter configuration. (Instant message file transfer filter settings are used to block a user’s ability to transfer certain types of files within an instant message.)
Syntax
Remove-CsFileTransferFilterConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsIdentity |
Unique identifier for the collection of file transfer settings to be removed. To refer to the global settings, use this syntax: -Identity global. To refer to settings configured at the site scope use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcard values when specifying an Identity. |
|
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
When sending instant messages, users can attach and send files to the other participants in the conversation. Microsoft Communications Server 2010 can be configured so that files with certain extensions - typically extensions of file types that could potentially prove harmful - are not allowed to be sent using a Communications Server client.
The Remove-CsFileTransferFilterConfiguration cmdlet enables you to delete a collection of file transfer filter settings. For settings configured at the site scope, Remove-CsFileTransferFilterConfiguration will remove the settings; in turn, the users on the site will automatically inherit the global file transfer filter settings. Remove-CsFileTransferFilterConfiguration can also be run against the global settings. In that case, however, the global settings will not be removed; instead, all the property values in that collection of settings will be reset to their default values.
Return Types
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsFileTransferFilterConfiguration -Identity site:Redmond |
|
In the preceding example, Remove-CsFileTransferFilterConfiguration is used to remove the file transfer filter settings that have the Identity site:Redmond.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsFileTransferFilterConfiguration -Filter site:* | Remove-CsFileTransferFilterConfiguration |
|
In Example 2, all the file transfer filter settings that have been configured at the site scope are removed. To carry out this task, the command first uses Get-CsFileTransferFilterConfiguration and the -Filter parameter to return all the settings configured at the site scope; the filter value "site:*" tells Get-CsFileTransferFilterConfiguration to return only those settings that have an Identity that begins with the string value "site:". The filtered collection of settings is then piped to Remove-CsFileTransferFilterConfiguration, which deletes each item in the collection.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsFileTransferFilterConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsFileTransferFilterConfiguration
|
|
Example 3 shows you how you can remove all the file transfer filter settings that are currently disabled. To do this, the command first uses Get-CsFileTransferFilterConfiguration to return a collection of all the file transfer filter settings currently in use in the organization. That information is then piped to the Where-Object cmdlet, which selects only those collections of file transfer settings where the Enabled property is equal to (-eq) False ($False). That filtered collection is then piped to Remove-CsFileTransferFilterConfiguration, which proceeds to remove each item in the filtered collection.