Changes configuration settings of a file screen template.
Windows Server · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft FileServerResourceManager reference: Changes configuration settings of a file screen template. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-FsrmFileScreenTemplate. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / FileServerResourceManager · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-Active
Indicates that the server fails any I/O operation that violates the file screen. If you do not specify this parameter, the server does not fail violating I/O operations and still runs any action that is associated with the file screen.
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell background jobs, see about_Jobs.
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
-Confirm
Prompts you for confirmation before running the cmdlet.
-Description
Specifies a description for the file screen template.
-IncludeGroup
Specifies an array of names of file groups that you want to exclude from file screening.
-InputObject (required)
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
-Name (required)
Specifies the name of a file screen template.
-Notification
Specifies an array of notification action objects. You can use the New-FsrmFmjNotificationAction cmdlet to create a FsrmFmjNotificationAction object.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
-UpdateDerived
Indicates that the server modifies all existing file screens that were created with the original file screen template. If you specify this parameter, you cannot specify the *UpdateDerivedMatching* parameter.
-UpdateDerivedMatching
Indicates that the server updates only the file screens that you have not modified since you created them with the original file screen template. If you specify this parameter, you cannot specify the *UpdateDerived* parameter.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the FileServerResourceManager module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
Examples
Example 1: Change the include group for a file screen template
Set-FsrmFileScreenTemplate -Name "Filter Media files" -IncludeGroup @("Media Files", "Text Files")
This command changes a file screen template named "Filter Media files" to include both media files and text files. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.