FSRMFileScreenTemplateAction

FSRMFileScreenTemplateAction

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the FSRM File Screen Template that this Action is attached to.
Type	Key	String	The type of FSRM Action.	Email, Event, Command, Report
Ensure	Write	String	Specifies whether the FSRM Action should exist.	Present, Absent
Subject	Write	String	The subject of the e-mail sent. Required when Type is Email.
Body	Write	String	The body text of the e-mail or event. Required when Type is Email or Event.
MailTo	Write	String	The mail to of the e-mail sent. Required when Type is Email.
MailCC	Write	String	The mail CC of the e-mail sent. Required when Type is Email.
MailBCC	Write	String	The mail BCC of the e-mail sent. Required when Type is Email.
EventType	Write	String	The type of event created. Required when Type is Event.	None, Information, Warning, Error
Command	Write	String	The Command to execute. Required when Type is Command.
CommandParameters	Write	String	The Command Parameters. Required when Type is Command.
KillTimeOut	Write	SInt32	Int containing kill timeout of the command. Required when Type is Command.
RunLimitInterval	Write	SInt32	Int containing the run limit interval of the command. Required when Type is Command.
SecurityLevel	Write	String	The security level the command runs under. Required when Type is Command.	None, LocalService, NetworkService, LocalSystem
ShouldLogError	Write	Boolean	Boolean specifying if command errors should be logged. Required when Type is Command.
WorkingDirectory	Write	String	The working directory of the command. Required when Type is Command.
ReportTypes	Write	StringArray[]	Array of Reports to create. Required when Type is Report.

Description

This resource is used to configure File Screen Template Actions for File Screen Templates in File Server Resource Manager.

Examples

Example 1

This configuration will create an Active FSRM File Screen Template called 'Block Some Files', with three include groups. An e-mail and event action is bound to the File Screen Template.

Configuration FSRMFileScreenTemplateAction_Config
{
    Import-DscResource -Module FSRMDsc

    Node localhost
    {
        FSRMFileScreenTemplate FileScreenSomeFiles
        {
            Name         = 'Block Some Files'
            Description  = 'File Screen for Blocking Some Files'
            Ensure       = 'Present'
            Active       = $true
            IncludeGroup = 'Audio and Video Files', 'Executable Files', 'Backup Files'
        } # End of FSRMFileScreenTemplate Resource

        FSRMFileScreenTemplateAction FileScreenSomeFilesEmail
        {
            Name      = 'Block Some Files'
            Ensure    = 'Present'
            Type      = 'Email'
            Subject   = 'Unauthorized file matching [Violated File Group] file group detected'
            Body      = 'The system detected that user [Source Io Owner] attempted to save [Source File Path] on [File Screen Path] on server [Server]. This file matches the [Violated File Group] file group which is not permitted on the system.'
            MailBCC   = ''
            MailCC    = '[email protected]'
            MailTo    = '[Source Io Owner Email]'
            DependsOn = "[FSRMFileScreenTemplate]FileScreenSomeFiles"
        } # End of FSRMFileScreenTemplateAction Resource

        FSRMFileScreenTemplateAction FileScreenSomeFilesEvent
        {
            Name      = 'Block Some Files'
            Ensure    = 'Present'
            Type      = 'Event'
            Body      = 'The system detected that user [Source Io Owner] attempted to save [Source File Path] on [File Screen Path] on server [Server]. This file matches the [Violated File Group] file group which is not permitted on the system.'
            EventType = 'Warning'
            DependsOn = "[FSRMFileScreenTemplate]FileScreenSomeFiles"
        } # End of FSRMFileScreenTemplateAction Resource
    } # End of Node
} # End of Configuration