xSharePoint

0.12.0.0

DSCResources/MSFT_xSPHealthAnalyzerRuleState/MSFT_xSPHealthAnalyzerRuleState.schema.mof

                                /*

**Description**

This resource is used to configure Health Analyzer rules for the local farm.

The resource is able to enable/disable and configure the specified rule.

**Example**

    xSPHealthAnalyzerRuleState DisableDiskSpaceRule

    {

        Name = "Drives are at risk of running out of free space."

        Enabled = $true

        RuleScope   = "All Servers"

        Schedule = "Daily"

        FixAutomatically = $false

        InstallAccount = $InstallAccount

    }

*/

[ClassVersion("1.0.0.0"), FriendlyName("xSPHealthAnalyzerRuleState")]

class MSFT_xSPHealthAnalyzerRuleState : OMI_BaseResource

{

    [Key, Description("The name of the rule exactly as it appears in central admin")] String Name;

    [Required, Description("Should the rule be enabled?")] Boolean Enabled;

    [Write, Description("What is the scope of this rule"), ValueMap{"All Servers","Any Server"}, Values{"All Servers","Any Server"}] String RuleScope;

    [Write, Description("How often should the rule check"), ValueMap{"Hourly","Daily","Weekly","Monthly","OnDemandOnly"}, Values{"Hourly","Daily","Weekly","Monthly","OnDemandOnly"}] String Schedule;

    [Write, Description("Should the rule fix itself automatically")] Boolean FixAutomatically;

    [Write, Description("POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5"), EmbeddedInstance("MSFT_Credential")] String InstallAccount;

};