New-CsFileTransferFilterConfiguration

Syntax

New-CsFileTransferFilterConfiguration -Identity <XdsIdentity> [-Action <BlockAll | Block>] [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Extensions <PSListModifier>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

When sending instant messages, users can attach and send files to the other participants in the conversation. 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.

When you install Lync Server 2010, a single file transfer filter configuration (which is configured at the global scope) is created for you. By default, the global configuration applies to all the users in your organization. In addition, you can use the New-CsFileTransferFilterConfiguration cmdlet to create custom file transfer filter configurations for individual sites. If a configuration exists for a given site then those file transfer settings will be applied to all the users in that site. If no such collection exists for a site then the global settings will be applied instead.

Note that you cannot create new a file transfer filter configuration at the global scope; however, you can use the Set-CsFileTransferFilterConfiguration cmdlet to modify the global settings. Likewise, you cannot create a new configuration for a site that already has one defined; if you try that, your command will fail.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsFileTransferFilterConfiguration cmdlet locally: RTCUniversalServerAdministrator. 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 "New-CsFileTransferFilterConfiguration"}

Parameters

Input Types

None.

Return Types

New-CsFileTransferFilterConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object.

Example

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

New-CsFileTransferFilterConfiguration -Identity site:Redmond

In the preceding command, New-CsFileTransferFilterConfiguration is used to create a new instant message file transfer filter configuration with the Identity site:Redmond. Because no additional parameters were specified, the configuration will be created using the default values.

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

New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Add=".ps1"}

In this command, New-CsFileTransferFilterConfiguration is used to create a new file transfer filter configuration with the Identity site:Redmond. Because the Extensions parameter has been specified, the new configuration will contain all the default values plus an additional file extension: .ps1. This new extension is added by using the Extensions parameter and the list modifier Add followed by the file extension to be added. (Note that you must include the period as part of the file extension.) To add multiple file extensions, simply separate those extensions by using commas: @{Add=".ps1",".ps2",".ps3"}

-------------------------- Example 3 --------------------------

New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Replace=".vbs",".ps1"}

In Example 3, New-CsFileTransferFilterConfiguration is used to create a new file transfer filter configuration with the Identity site:Redmond. This example is similar to Example 2 except that the Replace list modifier has been used instead of the Add modifier. This means that the complete set of file extensions will be replaced by the two specified file extensions: .vbs and .ps1. In this case the only files blocked at the Redmond site will be .vbs and .ps1.

-------------------------- Example 4 --------------------------

$x = New-CsFileTransferFilterConfiguration -Identity site:Redmond -InMemory 
$x.Action = "BlockAll"
Set-CsFileTransferFilterConfiguration -Instance $x

Example 4 demonstrates the use of the InMemory parameter to create a file transfer filter configuration that initially resides in memory only. To do this the first command in the example uses New-CsFileTransferFilterConfiguration and the InMemory parameter to create a new file transfer filter configuration with the Identity site:Redmond. At this point in time, the new settings exist only in memory; users in the Redmond site will still be governed by the global file transfer filter settings.

In the second command, the value of the Action property for this in-memory instance is set to BlockAll. Finally, the third command in the example uses Set-CsFileTransferFilterConfiguration to create the new collection of settings and apply them to the Redmond site.

Note that this same task can be accomplished in one step with the following command:

New-CsFileTransferFilterConfiguration -Identity site:Redmond –Action "BlockAll"

See Also

Other Resources

Remove-CsFileTransferFilterConfiguration
Set-CsFileTransferFilterConfiguration
Get-CsFileTransferFilterConfiguration