DSCResources/MSFT_SPLogLevel/MSFT_SPLogLevel.psm1
|
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [Microsoft.Management.Infrastructure.CimInstance[]] $SPLogLevelSetting, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) foreach ($DesiredSetting in $SPLogLevelSetting) { if ((($DesiredSetting.Area) | Measure-Object).Count -ne 1 -or ($DesiredSetting.Area).contains(",") ) { Write-Verbose -Message "Exactly one log area, or the wildcard character '*' must be provided for each log item area" return @{ Name = $Name SPLogLevelSetting = $null } } if ((($DesiredSetting.Name) | Measure-Object).Count -ne 1 -or ($DesiredSetting.Name).contains(",") ) { Write-Verbose -Message "Exactly one log name, or the wildcard character '*' must be provided for each log item name" return @{ Name = $Name SPLogLevelSetting = $null } } if ($null -eq $DesiredSetting.TraceLevel -and $null -eq $DesiredSetting.EventLevel) { Write-Verbose -Message "TraceLevel and / or EventLevel must be provided for each Area" return @{ Name = $Name SPLogLevelSetting = $null } } if ($null -ne $DesiredSetting.TraceLevel -and @("None", "Unexpected", "Monitorable", "High", "Medium", "Verbose", "VerboseEx", "Default") -notcontains $DesiredSetting.TraceLevel) { Write-Verbose -Message "TraceLevel $($DesiredSetting.TraceLevel) is not valid, must specify exactly one of None,Unexpected,Monitorable,High,Medium,Verbose,VerboseEx, or Default" return @{ Name = $Name SPLogLevelSetting = $null } } if ($null -ne $DesiredSetting.EventLevel -and @("None", "ErrorCritical", "Error", "Warning", "Information", "Verbose", "Default") -notcontains $DesiredSetting.EventLevel) { Write-Verbose -Message "EventLevel $($DesiredSetting.EventLevel) is not valid, must specify exactly one of None,ErrorCritical,Error,Warning,Informational,Verbose, or Default" return @{ Name = $Name SPLogLevelSetting = $null } } } Write-Verbose -Message "Getting SP Log Level Settings for provided Areas" $result = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] $CurrentLogLevelSettings = @() foreach ($DesiredSetting in $params.SPLogLevelSetting) { Write-Verbose -Message "Getting SP Log Level Settings for $($DesiredSetting.Area):$($DesiredSetting.Name)" $CurrentLogItemSettings = Get-SPLogLevel -Identity "$($DesiredSetting.Area):$($DesiredSetting.Name)" #Validate valid log area/name specified. if ($null -eq $CurrentLogItemSettings) { Write-Verbose -Message "Invalid SP Log Area/Name $($DesiredSetting.Area):$($DesiredSetting.Name)" return $null } #TraceLevels #if we desire defaults, we will check for default for each item and return as such if ($DesiredSetting.TraceLevel -eq "Default") { $SettingAtDefault = $true #assume they are all at default until we find otherwise foreach ($setting in $CurrentLogItemSettings) #default values can vary for each area/name, need to check each one. { if ($setting.TraceSeverity -ne $setting.DefaultTraceSeverity) { $SettingAtDefault = $false } } if ($SettingAtDefault) { $Tracelevel = 'Default' } else { #return a csv list of current unique trace level settings for the provided Area/Name $Tracelevel = [System.String]::Join(",", (($CurrentLogItemSettings.traceseverity) | Select-Object -Unique)) } } #default was not specified, so we return the unique current trace severity across all provided settings. else { $Tracelevel = [System.String]::Join(",", (($CurrentLogItemSettings.traceseverity) | Select-Object -Unique)) } #EventLevels #if we desire defaults, we will check for default and return as such if ($DesiredSetting.EventLevel -eq "Default") { $SettingAtDefault = $true #assume they are all at default until we find otherwise foreach ($setting in $CurrentLogItemSettings) #default values can vary for each area/name, need to check each one. { if ($setting.EventSeverity -ne $setting.DefaultEventSeverity) { $SettingAtDefault = $false } } if ($SettingAtDefault) { $Eventlevel = 'Default' } else { #return a csv list of current unique Event level settings for the provided Area/Name $Eventlevel = [System.String]::Join(",", (($CurrentLogItemSettings.Eventseverity) | Select-Object -Unique)) } } #default was not specified, so we return the unique current Event severity across all provided settings. else { $Eventlevel = [System.String]::Join(",", (($CurrentLogItemSettings.Eventseverity) | Select-Object -Unique)) } $CurrentLogLevelSettings += New-Object -TypeName PSObject -Property @{ Area = $DesiredSetting.Area Name = $DesiredSetting.Name TraceLevel = $TraceLevel EventLevel = $EventLevel } } return @{ Name = $params.Name SPLogLevelSetting = $CurrentLogLevelSettings } } return $result } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [Microsoft.Management.Infrastructure.CimInstance[]] $SPLogLevelSetting, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) foreach ($DesiredSetting in $SPLogLevelSetting) { if ((($DesiredSetting.Area) | Measure-Object).Count -ne 1 -or ($DesiredSetting.Area).contains(",") ) { $message = "Exactly one log area, or the wildcard character '*' must be provided for each log item" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ((($DesiredSetting.Name) | Measure-Object).Count -ne 1 -or ($DesiredSetting.Name).contains(",") ) { $message = "Exactly one log name, or the wildcard character '*' must be provided for each log item" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ($null -eq $DesiredSetting.TraceLevel -and $null -eq $DesiredSetting.EventLevel) { $message = "TraceLevel and / or EventLevel must be provided for each Area" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ($null -ne $DesiredSetting.TraceLevel -and @("None", "Unexpected", "Monitorable", "High", "Medium", "Verbose", "VerboseEx", "Default") -notcontains $DesiredSetting.TraceLevel) { $message = "TraceLevel $($DesiredSetting.TraceLevel) is not valid, must specify exactly one of None,Unexpected,Monitorable,High,Medium,Verbose,VerboseEx, or Default" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ($null -ne $DesiredSetting.EventLevel -and @("None", "ErrorCritical", "Error", "Warning", "Information", "Verbose", "Default") -notcontains $DesiredSetting.EventLevel) { $message = "EventLevel $($DesiredSetting.EventLevel) is not valid, must specify exactly one of None,ErrorCritical,Error,Warning,Information,Verbose, or Default" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } Write-Verbose -Message "Setting SP Log Level settings for the provided areas" Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments @($PSBoundParameters, $MyInvocation.MyCommand.Source) ` -ScriptBlock { $params = $args[0] $eventSource = $args[1] foreach ($DesiredSetting in $params.SPLogLevelSetting) { Write-Verbose -Message "Setting SP Log Level Settings for $($DesiredSetting.Area):$($DesiredSetting.Name)" $AllSettings = Get-SPLogLevel -Identity "$($DesiredSetting.Area):$($DesiredSetting.Name)" #Validate valid log area/name specified. if ($null -eq $AllSettings) { $message = "Invalid SP Log Area/Name $($DesiredSetting.Area):$($DesiredSetting.Name)" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } if ($null -ne $DesiredSetting.TraceLevel) { if ($DesiredSetting.TraceLevel -eq 'Default') { #default settings can vary, so we must loop through each one. foreach ($setting in $AllSettings) { Set-SPLogLevel -Identity "$($setting.Area):$($setting.Name)" -TraceSeverity $setting.DefaultTraceSeverity } } else { Set-SPLogLevel -Identity "$($DesiredSetting.Area):$($DesiredSetting.Name)" -TraceSeverity $DesiredSetting.TraceLevel } } if ($null -ne $DesiredSetting.EventLevel) { if ($DesiredSetting.EventLevel -eq 'Default') { #default settings can vary, so we must loop through each one. foreach ($setting in $AllSettings) { Set-SPLogLevel -Identity "$($setting.Area):$($setting.Name)" -EventSeverity $setting.DefaultEventSeverity } } else { Set-SPLogLevel -Identity "$($DesiredSetting.Area):$($DesiredSetting.Name)" -EventSeverity $DesiredSetting.EventLevel } } } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [Microsoft.Management.Infrastructure.CimInstance[]] $SPLogLevelSetting, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing SP Log Level settings for the provided areas" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" if ($null -eq $CurrentValues.SPLogLevelSetting) { $message = "Error retrieving SPLogLevelSetting for $Name" Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } $mismatchedSettingFound = $false $mismatchedSettings = @() foreach ($DesiredSetting in $SPLogLevelSetting) { Write-Verbose -Message "Testing SP Log Level setting for $($DesiredSetting.Area):$($DesiredSetting.Name)" $CurrentSetting = $CurrentValues.SPLogLevelSetting | Where-Object -FilterScript { $_.Area -eq $DesiredSetting.Area -and $_.Name -eq $DesiredSetting.Name } if (($null -ne $DesiredSetting.TraceLevel -and $CurrentSetting.TraceLevel -ne $DesiredSetting.TraceLevel) -or ($null -ne $DesiredSetting.EventLevel -and $CurrentSetting.EventLevel -ne $DesiredSetting.EventLevel)) { $mismatchedSettings += @{ Name = $Name DesiredSetting = $DesiredSetting $CurrentSetting = $CurrentSetting } Write-Verbose -Message "SP Log Level setting for $($DesiredSetting.Area):$($DesiredSetting.Name) is not in the desired state" $mismatchedSettingFound = $true } } if ($mismatchedSettingFound) { $EventMessage = "<SPDscEvent>`r`n" $EventMessage += " <ConfigurationDrift Source=`"$($MyInvocation.MyCommand.Source)`">`r`n" $EventMessage += " <ParametersNotInDesiredState>`r`n" $driftedValue = '' foreach ($setting in $mismatchedSettings) { $EventMessage += " <LogLevel Area=`"$($setting.CurrentSetting.Area)`" Name=`"$($setting.CurrentSetting.Area)`"> TraceLevel: " + $setting.CurrentSetting.TraceLevel + " - EventLevel: " + $setting.CurrentSetting.EventLevel + "</Param>`r`n" } $EventMessage += " </ParametersNotInDesiredState>`r`n" $EventMessage += " </ConfigurationDrift>`r`n" $EventMessage += " <DesiredValues>`r`n" foreach ($setting in $mismatchedSettings) { $EventMessage += " <LogLevel Area=`"$($setting.DesiredSetting.Area)`" Name=`"$($setting.DesiredSetting.Area)`"> TraceLevel: " + $setting.DesiredSetting.TraceLevel + " - EventLevel: " + $setting.DesiredSetting.EventLevel + "</Param>`r`n" } $EventMessage += " }" $EventMessage += " </DesiredValues>`r`n" $EventMessage += "</SPDscEvent>" Add-SPDscEvent -Message $EventMessage -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source $result = $false } else { $result = $true } Write-Verbose -Message "Test-TargetResource returned $result" return $result } |