DSCResources/MSFT_SPHealthAnalyzerRuleState/MSFT_SPHealthAnalyzerRuleState.psm1
|
$script:resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent $script:modulesFolderPath = Join-Path -Path $script:resourceModulePath -ChildPath 'Modules' $script:resourceHelperModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath 'SharePointDsc.Util' Import-Module -Name (Join-Path -Path $script:resourceHelperModulePath -ChildPath 'SharePointDsc.Util.psm1') function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.Boolean] $Enabled, [Parameter()] [ValidateSet("All Servers", "Any Server")] [System.String] $RuleScope, [Parameter()] [ValidateSet("Hourly", "Daily", "Weekly", "Monthly", "OnDemandOnly")] [System.String] $Schedule, [Parameter()] [System.Boolean] $FixAutomatically, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Getting Health Rule configuration settings" $result = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] $nullReturn = @{ # Set the Health Analyzer Rule settings Name = $null Enabled = $null RuleScope = $null Schedule = $null FixAutomatically = $null } try { $null = Get-SPFarm } catch { Write-Verbose -Message ("No local SharePoint farm was detected. Health " + ` "Analyzer Rule settings will not be applied") return $nullReturn } $caWebapp = Get-SPwebapplication -IncludeCentralAdministration ` | Where-Object -FilterScript { $_.IsAdministrationWebApplication } if ($null -eq $caWebapp) { Write-Verbose -Message "Unable to locate central administration website" return $nullReturn } # Get CA SPWeb $caWeb = Get-SPWeb($caWebapp.Url) $healthRulesList = $caWeb.Lists | Where-Object -FilterScript { $_.BaseTemplate -eq "HealthRules" } if ($null -ne $healthRulesList) { $spQuery = New-Object Microsoft.SharePoint.SPQuery $querytext = "<Where><Eq><FieldRef Name='Title'/><Value Type='Text'>" + ` "$($params.Name)</Value></Eq></Where>" $spQuery.Query = $querytext $results = $healthRulesList.GetItems($spQuery) if ($results.Count -eq 1) { $item = $results[0] # Additional check for incorrect default value of the schedule for rule # "One or more app domains for web applications aren't configured correctly." $ruleschedule = $item["HealthRuleSchedule"] if ($ruleschedule -eq "On Demand") { $ruleschedule = "OnDemandOnly" } return @{ # Set the Health Analyzer Rule settings Name = $params.Name Enabled = $item["HealthRuleCheckEnabled"] RuleScope = $item["HealthRuleScope"] Schedule = $ruleschedule FixAutomatically = $item["HealthRuleAutoRepairEnabled"] } } else { Write-Verbose -Message ("Unable to find specified Health Analyzer Rule. Make " + ` "sure any related service applications exists.") return $nullReturn } } else { Write-Verbose -Message "Unable to locate Health Analyzer Rules list" return $nullReturn } } return $result } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.Boolean] $Enabled, [Parameter()] [ValidateSet("All Servers", "Any Server")] [System.String] $RuleScope, [Parameter()] [ValidateSet("Hourly", "Daily", "Weekly", "Monthly", "OnDemandOnly")] [System.String] $Schedule, [Parameter()] [System.Boolean] $FixAutomatically, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Setting Health Analyzer Rule configuration settings" Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] try { $null = Get-SPFarm } catch { throw ("No local SharePoint farm was detected. Health Analyzer Rule " + ` "settings will not be applied") } $caWebapp = Get-SPwebapplication -IncludeCentralAdministration ` | Where-Object -FilterScript { $_.IsAdministrationWebApplication } if ($null -eq $caWebapp) { throw ("No Central Admin web application was found. Health Analyzer Rule " + ` "settings will not be applied") } # Get Central Admin SPWeb $caWeb = Get-SPWeb($caWebapp.Url) $healthRulesList = $caWeb.Lists | Where-Object -FilterScript { $_.BaseTemplate -eq "HealthRules" } if ($null -ne $healthRulesList) { $spQuery = New-Object Microsoft.SharePoint.SPQuery $querytext = "<Where><Eq><FieldRef Name='Title'/><Value Type='Text'>" + ` "$($params.Name)</Value></Eq></Where>" $spQuery.Query = $querytext $results = $healthRulesList.GetItems($spQuery) if ($results.Count -eq 1) { $item = $results[0] $item["HealthRuleCheckEnabled"] = $params.Enabled if ($params.ContainsKey("RuleScope")) { $item["HealthRuleScope"] = $params.RuleScope } if ($params.ContainsKey("Schedule")) { $item["HealthRuleSchedule"] = $params.Schedule } if ($params.ContainsKey("FixAutomatically")) { $item["HealthRuleAutoRepairEnabled"] = $params.FixAutomatically } $item.Update() } else { throw ("Could not find specified Health Analyzer Rule. Health Analyzer Rule " + ` "settings will not be applied. Make sure any related service " + ` "applications exists") } } else { throw ("Could not find Health Analyzer Rules list. Health Analyzer Rule settings " + ` "will not be applied") } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.Boolean] $Enabled, [Parameter()] [ValidateSet("All Servers", "Any Server")] [System.String] $RuleScope, [Parameter()] [ValidateSet("Hourly", "Daily", "Weekly", "Monthly", "OnDemandOnly")] [System.String] $Schedule, [Parameter()] [System.Boolean] $FixAutomatically, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing Health Analyzer rule configuration settings" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" $result = Test-SPDscParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters Write-Verbose -Message "Test-TargetResource returned $result" return $result } Export-ModuleMember -Function *-TargetResource |