FSRMQuotaAction

FSRMQuotaAction

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Path	Key	String	The path of the FSRM Quota the action applies to.
Percentage	Key	UInt32	This is the threshold percentage the 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 Quota Actions for Quotas in File Server Resource Manager.

Examples

Example 1

This configuration will assign an FSRM Quota to the path 'D:\Users', with a Hard Limit of 5GB and threshold percentages of 85 and 100. An e-mail action is bound to each threshold. An event action is also bound to the 85 percent threshold.

Configuration FSRMQuotaAction_Config
{
    Import-DscResource -Module FSRMDsc

    Node localhost
    {
        FSRMQuota DUsers
        {
            Path                 = 'd:\Users'
            Description          = '5 GB Hard Limit'
            Ensure               = 'Present'
            Size                 = 5GB
            SoftLimit            = $false
            ThresholdPercentages = @( 85, 100 )
        } # End of FSRMQuota Resource

        FSRMQuotaAction DUsersEmail85
        {
            Path       = 'd:\Users'
            Percentage = 85
            Ensure     = 'Present'
            Type       = 'Email'
            Subject    = '[Quota Threshold]% quota threshold exceeded'
            Body       = 'User [Source Io Owner] has exceed the [Quota Threshold]% quota threshold for quota on [Quota Path] on server [Server]. The quota limit is [Quota Limit MB] MB and the current usage is [Quota Used MB] MB ([Quota Used Percent]% of limit).'
            MailBCC    = ''
            MailCC     = 'fileserveradmins@contoso.com'
            MailTo     = '[Source Io Owner Email]'
            DependsOn  = "[FSRMQuota]DUsers"
        } # End of FSRMQuotaAction Resource

        FSRMQuotaAction DUsersEvent85
        {
            Path       = 'd:\Users'
            Percentage = 85
            Ensure     = 'Present'
            Type       = 'Event'
            Body       = 'User [Source Io Owner] has exceed the [Quota Threshold]% quota threshold for quota on [Quota Path] on server [Server]. The quota limit is [Quota Limit MB] MB and the current usage is [Quota Used MB] MB ([Quota Used Percent]% of limit).'
            EventType  = 'Warning'
            DependsOn  = "[FSRMQuota]DUsers"
        } # End of FSRMQuotaAction Resource

        FSRMQuotaAction DUsersEmail100
        {
            Path       = 'd:\Users'
            Percentage = 100
            Ensure     = 'Present'
            Type       = 'Email'
            Subject    = '[Quota Threshold]% quota threshold exceeded'
            Body       = 'User [Source Io Owner] has exceed the [Quota Threshold]% quota threshold for quota on [Quota Path] on server [Server]. The quota limit is [Quota Limit MB] MB and the current usage is [Quota Used MB] MB ([Quota Used Percent]% of limit).'
            MailBCC    = ''
            MailCC     = 'fileserveradmins@contoso.com'
            MailTo     = '[Source Io Owner Email]'
            DependsOn  = "[FSRMQuota]DUsers"
        } # End of FSRMQuotaAction Resource
    } # End of Node
} # End of Configuration

Example 2

This configuration will assign the '100 MB Limit' template to the path 'D:\Users'. It will also force the quota assigned to this path to exactly match the '100 MB Limit' template. Any changes to the thresholds or actions on the quota assigned to this path will cause the template to be removed and reapplied.

Configuration FSRMQuotaAction_UsingTemplate_Config
{
    Import-DscResource -Module FSRMDsc

    Node localhost
    {
        FSRMQuota DUsers
        {
            Path            = 'd:\Users'
            Description     = '100 MB Limit'
            Ensure          = 'Present'
            Template        = '100 MB Limit'
            MatchesTemplate = $true
        } # End of FSRMQuota Resource
    } # End of Node
} # End of Configuration