Filescrn template modify

  • Article

Applies To: Windows Server 2008

Modifies an existing file screen template.

Note

To use this command, you must be logged on as an administrator or a member of the Administrators group.

For examples of how to use this command, see Examples.

Syntax

filescrn template modify /template:<CurrTemplateName> 
   [/new-template:<NewTemplateName>] [/sourcetemplate:<TemplateName>] 
   [/type:{active | passive}] [/add-filegroup:<NewFgName>] [...] 
   [/delete-filegroup:<FgName>] [...] 
   [/add-notification:<NotifyType>,<ConfigFile>] [...] 
   [/delete-notification:<NotifyType>] [...] 
   [/modify-notification:<NotifyType>,<ConfigFile>] [...] 
   [/apply:{none | all | matching}] [/remote:<ComputerName>]

Parameters

Parameter Description

/template:<CurrTemplateName>

Modifies the file screen template CurrTemplateName. If the template name contains a space, enclose the name in quotation marks.

/new-template:<NewTemplateName>

Renames the file screen template to NewTemplateName. If the template name contains a space, enclose the name in quotation marks.

/sourcetemplate:<TemplateName>

Imports the file screen properties from the file screen template TemplateName. If the template name contains a space, enclose the name in quotation marks.

/type:{active | passive}

Modifies the file screen type:

  • active — blocks users from saving unauthorized files

  • passive — enables users to save unauthorized files, but configured notifications will be generated

/add-filegroup:<NewFgName> [...]

Adds file group NewFgName to the list of blocked file groups for the file screen template. If the file group name contains a space, enclose the name in quotation marks. You can use this parameter multiple times.

/delete-filegroup:<FgName> [...]

Deletes file group FgName from the list of blocked file groups for the file screen template. If the file group name contains a space, enclose the name in quotation marks. You can use this parameter multiple times

/add-notification:<NotifyType>,<ConfigFile> [...]

Adds a notification of type NotifyType, configured according to the information in the configuration file ConfigFile. You can use this parameter multiple times.

NotifyType must be one of the following:

  • m — an e-mail notification

  • e — an event log notification

  • c — a command or script execution

  • r — a report generation

ConfigFile is the path to the configuration file for the notification. For more information, see Configuration files for notifications in File Server Resource Manager.

Important
If the value specified for NotifyType does not match the value of the Notification parameter in the configuration file, the command will fail with an error.

/delete-notification:<NotifyType> [...]

Deletes the notification of type NotifyType. (For information on NotifyType, see the description of /add-notification:.) You can use this parameter multiple times.

/modify-notification:<NotifyType>,<ConfigFile> [...]

Modifies the notification of type NotifyType, to be configured according to the information in the configuration file ConfigFile. (For information on NotifyType, see the description of /add-notification:. You can use this parameter multiple times.

/apply:{none | all | matching}

Defines how the modified file screen template is applied to existing file screens derived from the template:

  • none — not applied to derived file screens

  • all — applied to all derived file screens

  • matching — applied only to file screens that match the original template

If you do not specify this parameter, by default the modified template is not applied to existing file screens.

/remote:<ComputerName>

Performs the operation on the remote computer ComputerName.

Remarks

  • File screen template properties that are not modified by using command parameters remain unchanged.

  • To create and manage file groups, use the Filescrn filegroup command.

  • The **/sourcetemplate:**TemplateName parameter derives the following properties from the file screen template TemplateName:

    • File groups that are screened

    • The file screen type (active or passive)

    • Notifications (if configured)

    You can override the derived file groups and file screen type by using the /add-filegroup: and /type: parameters.

    To modify the derived notifications, use the modify-notification: parameter.

  • The shortest sequence of characters that uniquely identifies a parameter can be used as an abbreviation. For example, the following two commands are equivalent:

    filescrn t m /te:"Screened Files Template" /add-f:"System Files"
filescrn template modify /template:"Screened Files Template" /add-filegroup:"System Files"

  • To perform operations on a remote computer by using the **/remote:**ComputerName parameter:

    • You must be logged on with a domain account that is a member of the Administrators group on both the local computer and the remote computer.

    • The remote computer must be running Windows Server 2008, and File Server Resource Manager must be installed.

    • The Remote File Server Resource Manager Management exception on the remote computer must be enabled. You enable this exception by using Windows Firewall in Control Panel.

Examples

  • To modify the Screened Files template by adding the System Files group and removing the Audio and Video Files group, type:

    filescrn template modify /template:"Screened Files" /add-filegroup:"System Files" /delete-filegroup:"Audio and Video Files"

  • To modify the e-mail notification for the Screened Files Warning template by specifying an updated screen_notification.txt configuration file, type:

    filescrn template modify /template:"Screened Files Warning" /modify-notification:m,screen_notification.txt

Additional references

Command-Line Syntax Key

Filescrn template