en-US/about_FSRMQuotaTemplate.help.txt
|
.NAME
FSRMQuotaTemplate # Description This resource is used to configure Quota Templates in File Server Resource Manager. .PARAMETER Name Key - String The unique name for this FSRM Quota Template. .PARAMETER Description Write - String An optional description for this FSRM Quota Template. .PARAMETER Ensure Write - String Allowed values: Present, Absent Specifies whether the FSRM Quota Template should exist. .PARAMETER Size Write - Sint64 The size in bytes of this FSRM Quota Template limit. .PARAMETER SoftLimit Write - Boolean Controls whether this FSRM Quota Template has a hard or soft limit. .PARAMETER ThresholdPercentages Write - Uint32 An array of threshold percentages in this FSRM Quota Template. .EXAMPLE This configuration will create a FSRM Quota Template called '5 GB Hard Limit', 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 Example { param ( [Parameter()] [System.String[]] $NodeName = 'localhost' ) Import-DscResource -Module FSRMDsc Node $NodeName { FSRMQuotaTemplate HardLimit5GB { Name = '5 GB Limit' Description = '5 GB Hard Limit' Ensure = 'Present' Size = 5GB SoftLimit = $false ThresholdPercentages = @( 85, 100 ) } # End of FSRMQuotaTemplate Resource FSRMQuotaTemplateAction HardLimit5GBEmail85 { Name = '5 GB Limit' 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 = "[FSRMQuotaTemplate]HardLimit5GB" } # End of FSRMQuotaTemplateAction Resource FSRMQuotaTemplateAction HardLimit5GBEvent85 { Name = '5 GB Limit' 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 = "[FSRMQuotaTemplate]HardLimit5GB" } # End of FSRMQuotaTemplateAction Resource FSRMQuotaTemplateAction HardLimit5GBEmail100 { Name = '5 GB Limit' 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 = "[FSRMQuotaTemplate]HardLimit5GB" } # End of FSRMQuotaTemplateAction Resource } # End of Node } # End of Configuration |