Filescrn screen add

  • Article

Applies To: Windows Server 2008

Creates and configures a new file screen.

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 screen add /path:<Path> 
   {[/sourcetemplate:<TemplateName>] | [/add-filegroup:<FgName>] [...]} 
   [/type:{active | passive}] 
   [/add-notification:<NotifyType>,<ConfigFile>] [...] 
   [/overwrite | /ignore] [/remote:<ComputerName>]

Parameters

Parameter Description

/path:<Path>

Creates a file screen on path Path. You can append the following wildcard characters:

  • \. — a folder specified by Path

  • \* — all immediate subfolders of Path

/sourcetemplate:<TemplateName>

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

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

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

/type:{active | passive}

Specifies the file screen type:

  • active — blocks users from saving unauthorized files

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

If the file screen type is not derived from/sourcetemplate:TemplateName or is not specified, active screening is configured by default.

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

Adds a notification of type NotifyType, configured according to the information in the configuration file ConfigFile. You can add multiple notifications.

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.

/overwrite | /ignore

Overwrites a file screen that already exists on the path, or ignores the existing file screen (that is, leaves the file screen unchanged).

/remote:<ComputerName>

Performs the operation on the remote computer ComputerName.

Remarks

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

    You can use the /add-notification: parameter to add a notification to the notifications derived from TemplateName.

  • To create and manage file screen templates, use the Filescrn template command.

  • 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 s a /p:d:\scratch /t:p /add-f:"Audio and Video Files"
filescrn screen /path:d:\scratch /type:passive /add-filegroup:"Audio and Video 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

  • The following example overwrites the existing file screen on D:\scratch by monitoring the saving of files in the Audio and Video Files group. An e-mail notification (configured by the screen_notification.txt file) will be generated when users save files in that file group:

    filescrn screen add /path:d:\scratch /type:passive /add-filegroup:"Audio and Video Files" /add-notification:m,screen_notification.txt /overwrite

Additional references

Command-Line Syntax Key

Filescrn screen