Set-FsrmFileScreenTemplate

Set-FsrmFileScreenTemplate

Changes configuration settings of a file screen template.

Syntax

Parameter Set: Query (cdxml)
Set-FsrmFileScreenTemplate [-Name] <String[]> [-Active] [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-IncludeGroup <String[]> ] [-Notification <CimInstance[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-FsrmFileScreenTemplate -InputObject <CimInstance[]> [-Active] [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-IncludeGroup <String[]> ] [-Notification <CimInstance[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-FsrmFileScreenTemplate cmdlet changes configuration settings of a file screen template.

When you make changes to a file screen template, you have the option of extending those changes to existing file screens that were created with the original file screen template. You can specify the UpdateDerivedMatching parameter to modify only those quotas that still match the original file screen template, or you can specify the UpdateDerived parameter to modify all file screens that were created with the original file screen template, regardless of any modifications that you made to the file screens.

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

-CimSession<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.

-Description<String>

Specifies a description for the file screen template.

-IncludeGroup<String[]>

Specifies an array of names of file groups that you want to exclude from file screening.

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-Name<String[]>

Specifies the name of a file screen template.

-Notification<CimInstance[]>

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<Int32>

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.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenTemplate

Examples

Example 1: Change the include group for a file screen template

This command changes a file screen template named "Filter Media files" to include both media files and text files.

PS C:\> Set-FsrmFileScreenTemplate -Name "Filter Media files" -IncludeGroup @("Media Files", "Text Files")

Example 2: Changes the include group for a file screen template and derived file screen templates

This command updates a file screen template named "1GB limit" to include both media files and text files. The server also updates these settings in any file screens that derive from this template.

PS C:\> Set-FsrmFileScreenTemplate "1GB limit" -IncludeGroup @("Media Files", "Text Files") -UpdateDerived

Related topics

Get-FsrmFileScreenTemplate

New-FsrmFileScreenTemplate

Remove-FsrmFileScreenTemplate

New-FsrmFmjNotificationAction