DSCResources/MSFT_IisLogging/MSFT_IisLogging.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 |
# Load the Helper Module Import-Module -Name "$PSScriptRoot\..\Helper.psm1" # Localized messages data LocalizedData { # culture="en-US" ConvertFrom-StringData -StringData @' VerboseGetTargetResult = Get-Taget has been run. VerboseSetTargetUpdateLogPath = LogPath is not in the desired state and will be updated. VerboseSetTargetUpdateLogFlags = LogFlags do not match and will be updated. VerboseSetTargetUpdateLogPeriod = LogPeriod is not in the desired state and will be updated. VerboseSetTargetUpdateLogTruncateSize = TruncateSize is not in the desired state and will be updated. VerboseSetTargetUpdateLoglocalTimeRollover = LoglocalTimeRollover is not in the desired state and will be updated. VerboseSetTargetUpdateLogFormat = LogFormat is not in the desired state and will be updated VerboseTestTargetFalseLogPath = LogPath does match desired state. VerboseTestTargetFalseLogFlags = LogFlags does not match desired state. VerboseTestTargetFalseLogPeriod = LogPeriod does not match desired state. VerboseTestTargetFalseLogTruncateSize = LogTruncateSize does not match desired state. VerboseTestTargetFalseLoglocalTimeRollover = LoglocalTimeRollover does not match desired state. VerboseTestTargetFalseLogFormat = LogFormat does not match desired state. WarningLogPeriod = LogTruncateSize has is an input as will overwrite this desired state. WarningIncorrectLogFormat = LogFormat is not W3C, as a result LogFlags will not be used. '@ } <# .SYNOPSIS This will return a hashtable of results about the given LogPath #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [String] $LogPath ) Assert-Module $currentLogSettings = Get-WebConfiguration ` -filter '/system.applicationHost/sites/siteDefaults/Logfile' Write-Verbose -Message ($LocalizedData.VerboseGetTargetResult) return @{ LogPath = $currentLogSettings.directory LogFlags = [Array]$currentLogSettings.LogExtFileFlags LogPeriod = $currentLogSettings.period LogTruncateSize = $currentLogSettings.truncateSize LoglocalTimeRollover = $currentLogSettings.localTimeRollover LogFormat = $currentLogSettings.logFormat } } <# .SYNOPSIS This will set the desired state #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $LogPath, [ValidateSet('Date','Time','ClientIP','UserName','SiteName','ComputerName','ServerIP','Method','UriStem','UriQuery','HttpStatus','Win32Status','BytesSent','BytesRecv','TimeTaken','ServerPort','UserAgent','Cookie','Referer','ProtocolVersion','Host','HttpSubStatus')] [String[]] $LogFlags, [ValidateSet('Hourly','Daily','Weekly','Monthly','MaxSize')] [String] $LogPeriod, [ValidateRange('1048576','4294967295')] [String] $LogTruncateSize, [Boolean] $LoglocalTimeRollover, [ValidateSet('IIS','W3C','NCSA')] [String] $LogFormat ) Assert-Module $currentLogState = Get-TargetResource -LogPath $LogPath # Update LogFormat if needed if ($PSBoundParameters.ContainsKey('LogFormat') -and ` ($LogFormat -ne $currentLogState.LogFormat)) { Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogFormat) Set-WebConfigurationProperty '/system.applicationHost/sites/siteDefaults/logfile' ` -Name logFormat ` -Value $LogFormat } # Update LogPath if needed if ($PSBoundParameters.ContainsKey('LogPath') -and ($LogPath -ne $currentLogState.LogPath)) { Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogPath) Set-WebConfigurationProperty '/system.applicationHost/sites/siteDefaults/logfile' ` -Name directory ` -Value $LogPath } # Update Logflags if needed; also sets logformat to W3C if ($PSBoundParameters.ContainsKey('LogFlags') -and ` (-not (Compare-LogFlags -LogFlags $LogFlags))) { Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogFlags) Set-WebConfigurationProperty '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name logFormat ` -Value 'W3C' Set-WebConfigurationProperty '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name logExtFileFlags ` -Value ($LogFlags -join ',') } # Update Log Period if needed if ($PSBoundParameters.ContainsKey('LogPeriod') -and ` ($LogPeriod -ne $currentLogState.LogPeriod)) { if ($PSBoundParameters.ContainsKey('LogTruncateSize')) { Write-Verbose -Message ($LocalizedData.WarningLogPeriod) } Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogPeriod) Set-WebConfigurationProperty '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name period ` -Value $LogPeriod } # Update LogTruncateSize if needed if ($PSBoundParameters.ContainsKey('LogTruncateSize') -and ` ($LogTruncateSize -ne $currentLogState.LogTruncateSize)) { Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogTruncateSize) Set-WebConfigurationProperty '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name truncateSize ` -Value $LogTruncateSize Set-WebConfigurationProperty '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name period ` -Value 'MaxSize' } # Update LoglocalTimeRollover if needed if ($PSBoundParameters.ContainsKey('LoglocalTimeRollover') -and ` ($LoglocalTimeRollover -ne ` ([System.Convert]::ToBoolean($currentLogState.LoglocalTimeRollover)))) { Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLoglocalTimeRollover) Set-WebConfigurationProperty '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name localTimeRollover ` -Value $LoglocalTimeRollover } } <# .SYNOPSIS This tests the desired state. If the state is not correct it will return $false. If the state is correct it will return $true #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [String] $LogPath, [ValidateSet('Date','Time','ClientIP','UserName','SiteName','ComputerName','ServerIP','Method','UriStem','UriQuery','HttpStatus','Win32Status','BytesSent','BytesRecv','TimeTaken','ServerPort','UserAgent','Cookie','Referer','ProtocolVersion','Host','HttpSubStatus')] [String[]] $LogFlags, [ValidateSet('Hourly','Daily','Weekly','Monthly','MaxSize')] [String] $LogPeriod, [ValidateRange('1048576','4294967295')] [String] $LogTruncateSize, [Boolean] $LoglocalTimeRollover, [ValidateSet('IIS','W3C','NCSA')] [String] $LogFormat ) Assert-Module $currentLogState = Get-TargetResource -LogPath $LogPath # Check LogFormat if ($PSBoundParameters.ContainsKey('LogFormat')) { # Warn if LogFlags are passed in and Current LogFormat is not W3C if ($PSBoundParameters.ContainsKey('LogFlags') -and ` $LogFormat -ne 'W3C') { Write-Verbose -Message ($LocalizedData.WarningIncorrectLogFormat) } # Warn if LogFlags are passed in and Desired LogFormat is not W3C if($PSBoundParameters.ContainsKey('LogFlags') -and ` $currentLogState.LogFormat -ne 'W3C') { Write-Verbose -Message ($LocalizedData.WarningIncorrectLogFormat) } # Check LogFormat if ($LogFormat -ne $currentLogState.LogFormat) { Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseLogFormat) return $false } } # Check LogFlags if ($PSBoundParameters.ContainsKey('LogFlags') -and ` (-not (Compare-LogFlags -LogFlags $LogFlags))) { Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseLogFlags) return $false } # Check LogPath if ($PSBoundParameters.ContainsKey('LogPath') -and ` ($LogPath -ne $currentLogState.LogPath)) { Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseLogPath) return $false } # Check LogPeriod if ($PSBoundParameters.ContainsKey('LogPeriod') -and ` ($LogPeriod -ne $currentLogState.LogPeriod)) { if ($PSBoundParameters.ContainsKey('LogTruncateSize')) { Write-Verbose -Message ($LocalizedData.WarningLogPeriod) } Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseLogPeriod) return $false } # Check LogTruncateSize if ($PSBoundParameters.ContainsKey('LogTruncateSize') -and ` ($LogTruncateSize -ne $currentLogState.LogTruncateSize)) { Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseLogTruncateSize) return $false } # Check LoglocalTimeRollover if ($PSBoundParameters.ContainsKey('LoglocalTimeRollover') -and ` ($LoglocalTimeRollover -ne ` ([System.Convert]::ToBoolean($currentLogState.LoglocalTimeRollover)))) { Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseLoglocalTimeRollover) return $false } return $true } #region Helper functions <# .SYNOPSIS Helper function used to validate the logflags status. Returns False if the loglfags do not match and true if they do .PARAMETER LogFlags Specifies flags to check #> function Compare-LogFlags { [CmdletBinding()] [OutputType([Boolean])] param ( [ValidateSet('Date','Time','ClientIP','UserName','SiteName','ComputerName','ServerIP','Method','UriStem','UriQuery','HttpStatus','Win32Status','BytesSent','BytesRecv','TimeTaken','ServerPort','UserAgent','Cookie','Referer','ProtocolVersion','Host','HttpSubStatus')] [String[]] $LogFlags ) $currentLogFlags = (Get-WebConfigurationProperty ` -Filter '/system.Applicationhost/Sites/SiteDefaults/logfile' ` -Name LogExtFileFlags) -split ',' | ` Sort-Object $proposedLogFlags = $LogFlags -split ',' | Sort-Object if (Compare-Object -ReferenceObject $currentLogFlags ` -DifferenceObject $proposedLogFlags) { return $false } return $true } #endregion Export-ModuleMember -function *-TargetResource |