en-US/about_FSRMFileScreenTemplateAction.help.txt
|
.NAME
FSRMFileScreenTemplateAction # Description This resource is used to configure File Screen Template Actions for File Screen Templates in File Server Resource Manager. .PARAMETER Name Key - string The name of the FSRM File Screen Template that this Action is attached to. .PARAMETER Type Key - string Allowed values: Email, Event, Command, Report The type of FSRM Action. .PARAMETER Ensure Write - String Allowed values: Present, Absent Specifies whether the FSRM Action should exist. .PARAMETER Subject Write - string The subject of the e-mail sent. Required when Type is Email. .PARAMETER Body Write - string The body text of the e-mail or event. Required when Type is Email or Event. .PARAMETER MailTo Write - string The mail to of the e-mail sent. Required when Type is Email. .PARAMETER MailCC Write - string The mail CC of the e-mail sent. Required when Type is Email. .PARAMETER MailBCC Write - string The mail BCC of the e-mail sent. Required when Type is Email. .PARAMETER EventType Write - string Allowed values: None, Information, Warning, Error The type of event created. Required when Type is Event. .PARAMETER Command Write - string The Command to execute. Required when Type is Command. .PARAMETER CommandParameters Write - string The Command Parameters. Required when Type is Command. .PARAMETER KillTimeOut Write - sint32 Int containing kill timeout of the command. Required when Type is Command. .PARAMETER RunLimitInterval Write - sint32 Int containing the run limit interval of the command. Required when Type is Command. .PARAMETER SecurityLevel Write - string Allowed values: None, LocalService, NetworkService, LocalSystem The security level the command runs under. Required when Type is Command. .PARAMETER ShouldLogError Write - boolean Boolean specifying if command errors should be logged. Required when Type is Command. .PARAMETER WorkingDirectory Write - string The working directory of the command. Required when Type is Command. .PARAMETER ReportTypes Write - string Array of Reports to create. Required when Type is Report. .EXAMPLE 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 Example { param ( [Parameter()] [System.String[]] $NodeName = 'localhost' ) Import-DscResource -Module FSRMDsc Node $NodeName { 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 = 'fileserveradmins@contoso.com' 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 |