Remove-CsFileTransferFilterConfiguration
Topic Last Modified: 2012-03-25
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>]]
Detailed Description
When sending instant messages, users can attach and send files to the other participants in the conversation. Microsoft Lync 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 Lync Server 2010 client.
The Remove-CsFileTransferFilterConfiguration cmdlet enables you to delete a file transfer filter configuration. For configurations at the site scope, Remove-CsFileTransferFilterConfiguration will remove the configuration; in turn, the users on the site will automatically inherit the global file transfer filter configuration. Remove-CsFileTransferFilterConfiguration can also be run against the global configuration. In that case, however, the global configuration will not be removed; instead, all the property values in that configuration will be reset to their default values.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsFileTransferFilterConfiguration 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-CsFileTransferFilterConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
XdsIdentity |
Unique identifier for the file transfer configuration to be removed. To refer to the global configuration, use this syntax: -Identity global. To refer to a configuration 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. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. Accepts pipelined input of file transfer filter configuration objects.
Return Types
This cmdlet does not return a value or object. Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object.
Example
-------------------------- Example 1 --------------------------
Remove-CsFileTransferFilterConfiguration -Identity site:Redmond
In the preceding example, Remove-CsFileTransferFilterConfiguration is used to remove the file transfer filter configuration that has the Identity site:Redmond.
-------------------------- Example 2 --------------------------
Get-CsFileTransferFilterConfiguration -Filter site:* | Remove-CsFileTransferFilterConfiguration
In Example 2, all the file transfer filter configurations 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 configurations at the site scope. The filter value "site:*" tells Get-CsFileTransferFilterConfiguration 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-CsFileTransferFilterConfiguration, which deletes each item in the collection.
-------------------------- Example 3 --------------------------
Get-CsFileTransferFilterConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsFileTransferFilterConfiguration
Example 3 shows you how you can remove all the file transfer filter configurations that are currently disabled. To do this, the command first uses Get-CsFileTransferFilterConfiguration to return a collection of all the file transfer filter configurations currently in use in the organization. That information is then piped to the Where-Object cmdlet, which selects only those file transfer filter configurations 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.