en-us/about_SPHealthAnalyzerRuleState.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.NAME
    SPHealthAnalyzerRuleState
 
.SYNOPSIS
 
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
 
    SPHealthAnalyzerRuleState DisableDiskSpaceRule
    {
        Name = "Drives are at risk of running out of free space."
        Enabled = $true
        RuleScope = "All Servers"
        Schedule = "Daily"
        FixAutomatically = $false
        InstallAccount = $InstallAccount
    }
 
.PARAMETER Name
    Key - String
    The name of the rule exactly as it appears in central admin
 
.PARAMETER Enabled
    Required - Boolean
    Should the rule be enabled?
 
.PARAMETER RuleScope
    Write - String
    Allowed values: All Servers, Any Server
    What is the scope of this rule
 
.PARAMETER Schedule
    Write - String
    Allowed values: Hourly, Daily, Weekly, Monthly, OnDemandOnly
    How often should the rule check
 
.PARAMETER FixAutomatically
    Write - Boolean
    Should the rule fix itself automatically
 
.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5