-
Notifications
You must be signed in to change notification settings - Fork 148
/
MSFT_xWebsite.psm1
2454 lines (2150 loc) · 91.4 KB
/
MSFT_xWebsite.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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#requires -Version 4.0 -Modules CimCmdlets
# Load the Helper Module
Import-Module -Name "$PSScriptRoot\..\Helper.psm1" -Verbose:$false
# Localized messages
data LocalizedData
{
# culture="en-US"
ConvertFrom-StringData -StringData @'
ErrorWebsiteNotFound = The requested website "{0}" cannot be found on the target machine.
ErrorWebsiteDiscoveryFailure = Failure to get the requested website "{0}" information from the target machine.
ErrorWebsiteCreationFailure = Failure to successfully create the website "{0}". Error: "{1}".
ErrorWebsiteRemovalFailure = Failure to successfully remove the website "{0}". Error: "{1}".
ErrorWebsiteBindingUpdateFailure = Failure to successfully update the bindings for website "{0}". Error: "{1}".
ErrorWebsiteBindingInputInvalidation = Desired website bindings are not valid for website "{0}".
ErrorWebsiteCompareFailure = Failure to successfully compare properties for website "{0}". Error: "{1}".
ErrorWebBindingCertificate = Failure to add certificate to web binding. Please make sure that the certificate thumbprint "{0}" is valid. Error: "{1}".
ErrorWebsiteStateFailure = Failure to successfully set the state of the website "{0}". Error: "{1}".
ErrorWebsiteBindingConflictOnStart = Website "{0}" could not be started due to binding conflict. Ensure that the binding information for this website does not conflict with any existing website's bindings before trying to start it.
ErrorWebBindingInvalidIPAddress = Failure to validate the IPAddress property value "{0}". Error: "{1}".
ErrorWebBindingInvalidPort = Failure to validate the Port property value "{0}". The port number must be a positive integer between 1 and 65535.
ErrorWebBindingMissingBindingInformation = The BindingInformation property is required for bindings of type "{0}".
ErrorWebBindingMissingCertificateThumbprint = The CertificateThumbprint property is required for bindings of type "{0}".
ErrorWebBindingMissingSniHostName = The HostName property is required for use with Server Name Indication.
ErrorWebBindingInvalidCertificateSubject = The Subject "{0}" provided is not found on this host in store "{1}"
ErrorWebsitePreloadFailure = Failure to set Preload on Website "{0}". Error: "{1}".
ErrorWebsiteAutoStartFailure = Failure to set AutoStart on Website "{0}". Error: "{1}".
ErrorWebsiteAutoStartProviderFailure = Failure to set AutoStartProvider on Website "{0}". Error: "{1}".
ErrorWebsiteTestAutoStartProviderFailure = Desired AutoStartProvider is not valid due to a conflicting Global Property. Ensure that the serviceAutoStartProvider is a unique key."
VerboseSetTargetUpdatedSiteId = Site Id for website "{0}" has been updated to "{1}".
VerboseSetTargetUpdatedPhysicalPath = Physical Path for website "{0}" has been updated to "{1}".
VerboseGetTargetAbsent = No Website exists with this name.
VerboseGetTargetPresent = A single Website exists with this name
VerboseSetTargetUpdatedApplicationPool = Application Pool for website "{0}" has been updated to "{1}".
VerboseSetTargetUpdatedBindingInfo = Bindings for website "{0}" have been updated.
VerboseSetTargetUpdatedEnabledProtocols = Enabled Protocols for website "{0}" have been updated to "{1}".
VerboseSetTargetUpdatedState = State for website "{0}" has been updated to "{1}".
VerboseSetTargetWebsiteCreated = Successfully created website "{0}".
VerboseSetTargetWebsiteStarted = Successfully started website "{0}".
VerboseSetTargetWebsiteRemoved = Successfully removed website "{0}".
VerboseSetTargetWebsiteAutoStartUpdated = Successfully updated AutoStart on website "{0}".
VerboseSetTargetAuthenticationInfoUpdated = Successfully updated AuthenticationInfo on website "{0}".
VerboseSetTargetWebsitePreloadUpdated = Successfully updated application Preload on website "{0}".
VerboseSetTargetServiceAutoStartProviderUpdated = Successfully updated AutoStartProvider on website "{0}".
VerboseSetTargetIISAutoStartProviderUpdated = Successfully updated AutoStartProvider in IIS.
VerboseSetTargetUpdateLogPath = LogPath does not match and will be updated on Website "{0}".
VerboseSetTargetUpdateLogFlags = LogFlags do not match and will be updated on Website "{0}".
VerboseSetTargetUpdateLogPeriod = LogPeriod does not match and will be updated on Website "{0}".
VerboseSetTargetUpdateLogTruncateSize = TruncateSize does not match and will be updated on Website "{0}".
VerboseSetTargetUpdateLoglocalTimeRollover = LoglocalTimeRollover does not match and will be updated on Website "{0}".
VerboseSetTargetUpdateLogFormat = LogFormat is not in the desired state and will be updated on Website "{0}"
VerboseSetTargetUpdateLogTargetW3C = LogTargetW3C is not in the desired state and will be updated on Website "{0}".
VerboseSetTargetUpdateLogCustomFields = LogCustomFields is not in the desired state and will be updated on Website "{0}"
VerboseTestTargetFalseEnsure = The Ensure state for website "{0}" does not match the desired state.
VerboseTestTargetFalseSiteId = Site Id of website "{0}" does not match the desired state.
VerboseTestTargetFalsePhysicalPath = Physical Path of website "{0}" does not match the desired state.
VerboseTestTargetFalseState = The state of website "{0}" does not match the desired state.
VerboseTestTargetFalseApplicationPool = Application Pool for website "{0}" does not match the desired state.
VerboseTestTargetFalseBindingInfo = Bindings for website "{0}" do not match the desired state.
VerboseTestTargetFalseEnabledProtocols = Enabled Protocols for website "{0}" do not match the desired state.
VerboseTestTargetFalseDefaultPage = Default Page for website "{0}" does not match the desired state.
VerboseTestTargetTrueResult = The target resource is already in the desired state. No action is required.
VerboseTestTargetFalseResult = The target resource is not in the desired state.
VerboseTestTargetFalseAutoStart = AutoStart for website "{0}" do not match the desired state.
VerboseTestTargetFalsePreload = Preload for website "{0}" do not match the desired state.
VerboseTestTargetFalseServiceAutoStart = Application AutoStart for website "{0}" do not match the desired state.
VerboseTestTargetFalseAuthenticationInfo = AuthenticationInfo for website "{0}" is not in the desired state.
VerboseTestTargetFalseIISAutoStartProvider = AutoStartProvider for IIS is not in the desired state
VerboseTestTargetFalseWebsiteAutoStartProvider = AutoStartProvider for website "{0}" is not in the desired state
VerboseTestTargetFalseLogPath = LogPath does not match desired state on Website "{0}".
VerboseTestTargetFalseLogFlags = LogFlags does not match desired state on Website "{0}".
VerboseTestTargetFalseLogPeriod = LogPeriod does not match desired state on Website "{0}".
VerboseTestTargetFalseLogTruncateSize = LogTruncateSize does not match desired state on Website "{0}".
VerboseTestTargetFalseLoglocalTimeRollover = LoglocalTimeRollover does not match desired state on Website "{0}".
VerboseTestTargetFalseLogFormat = LogFormat does not match desired state on Website "{0}".
VerboseTestTargetFalseLogTargetW3C = LogTargetW3C does not match desired state on Website "{0}".
VerboseTestTargetFalseLogCustomFields = LogCustomFields does not match desired state on Website "{0}".
VerboseConvertToWebBindingIgnoreBindingInformation = BindingInformation is ignored for bindings of type "{0}" in case at least one of the following properties is specified: IPAddress, Port, HostName.
VerboseConvertToWebBindingDefaultPort = Port is not specified. The default "{0}" port "{1}" will be used.
VerboseConvertToWebBindingDefaultCertificateStoreName = CertificateStoreName is not specified. The default value "{0}" will be used.
VerboseTestBindingInfoSameIPAddressPortHostName = BindingInfo contains multiple items with the same IPAddress, Port, and HostName combination.
VerboseTestBindingInfoSamePortDifferentProtocol = BindingInfo contains items that share the same Port but have different Protocols.
VerboseTestBindingInfoSameProtocolBindingInformation = BindingInfo contains multiple items with the same Protocol and BindingInformation combination.
VerboseTestBindingInfoInvalidCatch = Unable to validate BindingInfo: "{0}".
VerboseUpdateDefaultPageUpdated = Default page for website "{0}" has been updated to "{1}".
WarningLogPeriod = LogTruncateSize has is an input as will overwrite this desired state on Website "{0}".
WarningIncorrectLogFormat = LogFormat is not W3C, as a result LogFlags will not be used on Website "{0}".
'@
}
<#
.SYNOPSYS
The Get-TargetResource cmdlet is used to fetch the status of role or Website on
the target machine. It gives the Website info of the requested role/feature on the
target machine.
.PARAMETER Name
Name of the website
#>
function Get-TargetResource
{
[CmdletBinding()]
[OutputType([Hashtable])]
param
(
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[String]
$Name
)
Assert-Module
$website = Get-Website | Where-Object -FilterScript {$_.Name -eq $Name}
if ($website.Count -eq 0)
{
Write-Verbose -Message ($LocalizedData.VerboseGetTargetAbsent)
$ensureResult = 'Absent'
}
elseif ($website.Count -eq 1)
{
Write-Verbose -Message ($LocalizedData.VerboseGetTargetPresent)
$ensureResult = 'Present'
$cimBindings = @(ConvertTo-CimBinding -InputObject $website.bindings.Collection)
$allDefaultPages = @(
Get-WebConfiguration -Filter '/system.webServer/defaultDocument/files/*' -PSPath "IIS:\Sites\$Name" |
ForEach-Object -Process {Write-Output -InputObject $_.value}
)
$cimAuthentication = Get-AuthenticationInfo -Site $Name
$websiteAutoStartProviders = (Get-WebConfiguration `
-filter /system.applicationHost/serviceAutoStartProviders).Collection
$webConfiguration = $websiteAutoStartProviders | `
Where-Object -Property Name -eq -Value $ServiceAutoStartProvider | `
Select-Object Name,Type
[Array] $cimLogCustomFields = ConvertTo-CimLogCustomFields -InputObject $website.logFile.customFields.Collection
}
# Multiple websites with the same name exist. This is not supported and is an error
else
{
$errorMessage = $LocalizedData.ErrorWebsiteDiscoveryFailure -f $Name
New-TerminatingError -ErrorId 'WebsiteDiscoveryFailure' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidResult'
}
# Add all website properties to the hash table
return @{
Ensure = $ensureResult
Name = $Name
SiteId = $website.id
PhysicalPath = $website.PhysicalPath
State = $website.State
ApplicationPool = $website.ApplicationPool
BindingInfo = $cimBindings
DefaultPage = $allDefaultPages
EnabledProtocols = $website.EnabledProtocols
ServerAutoStart = $website.serverAutoStart
AuthenticationInfo = $cimAuthentication
PreloadEnabled = $website.applicationDefaults.preloadEnabled
ServiceAutoStartProvider = $website.applicationDefaults.serviceAutoStartProvider
ServiceAutoStartEnabled = $website.applicationDefaults.serviceAutoStartEnabled
ApplicationType = $webConfiguration.Type
LogPath = $website.logfile.directory
LogFlags = [Array]$website.logfile.LogExtFileFlags
LogPeriod = $website.logfile.period
LogtruncateSize = $website.logfile.truncateSize
LoglocalTimeRollover = $website.logfile.localTimeRollover
LogFormat = $website.logfile.logFormat
LogTargetW3C = $website.logfile.logTargetW3C
LogCustomFields = $cimLogCustomFields
}
}
<#
.SYNOPSYS
The Set-TargetResource cmdlet is used to create, delete or configure a website on the
target machine.
.PARAMETER SiteId
Optional. Specifies the IIS site Id for the web site.
.PARAMETER PhysicalPath
Specifies the physical path of the web site. Don't set this if the site will be deployed by an external tool that updates the path.
#>
function Set-TargetResource
{
[CmdletBinding()]
param
(
[Parameter()]
[ValidateSet('Present', 'Absent')]
[String]
$Ensure = 'Present',
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[String]
$Name,
# To avoid confusion we use SiteId instead of just Id
[Parameter()]
[UInt32]
$SiteId,
[Parameter()]
[String]
$PhysicalPath,
[Parameter()]
[ValidateSet('Started', 'Stopped')]
[String]
$State = 'Started',
# The application pool name must contain between 1 and 64 characters
[Parameter()]
[ValidateLength(1, 64)]
[String]
$ApplicationPool,
[Parameter()]
[Microsoft.Management.Infrastructure.CimInstance[]]
$BindingInfo,
[Parameter()]
[String[]]
$DefaultPage,
[Parameter()]
[String]
$EnabledProtocols,
[Parameter()]
[Boolean]
$ServerAutoStart,
[Parameter()]
[Microsoft.Management.Infrastructure.CimInstance]
$AuthenticationInfo,
[Parameter()]
[Boolean]
$PreloadEnabled,
[Parameter()]
[Boolean]
$ServiceAutoStartEnabled,
[Parameter()]
[String]
$ServiceAutoStartProvider,
[Parameter()]
[String]
$ApplicationType,
[Parameter()]
[String]
$LogPath,
[Parameter()]
[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,
[Parameter()]
[ValidateSet('Hourly','Daily','Weekly','Monthly','MaxSize')]
[String]
$LogPeriod,
[Parameter()]
[ValidateScript({
([ValidateRange(1048576, 4294967295)] $valueAsUInt64 = [UInt64]::Parse($_))
})]
[String]
$LogTruncateSize,
[Parameter()]
[Boolean]
$LoglocalTimeRollover,
[Parameter()]
[ValidateSet('IIS','W3C','NCSA')]
[String]
$LogFormat,
[Parameter()]
[ValidateSet('File','ETW','File,ETW')]
[String]
$LogTargetW3C,
[Parameter()]
[Microsoft.Management.Infrastructure.CimInstance[]]
$LogCustomFields
)
Assert-Module
$website = Get-Website | Where-Object -FilterScript {$_.Name -eq $Name}
if ($Ensure -eq 'Present')
{
if ($null -ne $website)
{
# Update Site Id if required
# Note: Set-ItemProperty is case sensitive. only works with id, not Id or ID
if ($SiteId -gt 0 -and `
$website.Id -ne $SiteId)
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name id `
-Value $SiteId `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedSiteId `
-f $Name, $SiteId)
}
# Update Physical Path if required
if ([String]::IsNullOrEmpty($PhysicalPath) -eq $false -and `
$website.PhysicalPath -ne $PhysicalPath)
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name physicalPath `
-Value $PhysicalPath `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedPhysicalPath `
-f $Name, $PhysicalPath)
}
# Update Application Pool if required
if ($PSBoundParameters.ContainsKey('ApplicationPool') -and `
$website.ApplicationPool -ne $ApplicationPool)
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name applicationPool `
-Value $ApplicationPool `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedApplicationPool `
-f $Name, $ApplicationPool)
}
# Update Bindings if required
if ($PSBoundParameters.ContainsKey('BindingInfo') -and `
$null -ne $BindingInfo)
{
if (-not (Test-WebsiteBinding -Name $Name `
-BindingInfo $BindingInfo))
{
Update-WebsiteBinding -Name $Name `
-BindingInfo $BindingInfo
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedBindingInfo `
-f $Name)
}
}
# Update Enabled Protocols if required
if ($PSBoundParameters.ContainsKey('EnabledProtocols') -and `
$website.EnabledProtocols -ne $EnabledProtocols)
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name enabledProtocols `
-Value $EnabledProtocols `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedEnabledProtocols `
-f $Name, $EnabledProtocols)
}
# Update Default Pages if required
if ($PSBoundParameters.ContainsKey('DefaultPage') -and `
$null -ne $DefaultPage)
{
Update-DefaultPage -Name $Name `
-DefaultPage $DefaultPage
}
# Update State if required
if ($PSBoundParameters.ContainsKey('State') -and `
$website.State -ne $State)
{
if ($State -eq 'Started')
{
# Ensure that there are no other running websites with binding information that
# will conflict with this website before starting
if (-not (Confirm-UniqueBinding -Name $Name -ExcludeStopped))
{
# Return error and do not start the website
$errorMessage = $LocalizedData.ErrorWebsiteBindingConflictOnStart `
-f $Name
New-TerminatingError -ErrorId 'WebsiteBindingConflictOnStart' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidResult'
}
try
{
Start-Website -Name $Name -ErrorAction Stop
}
catch
{
$errorMessage = $LocalizedData.ErrorWebsiteStateFailure `
-f $Name, $_.Exception.Message
New-TerminatingError -ErrorId 'WebsiteStateFailure' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidOperation'
}
}
else
{
try
{
Stop-Website -Name $Name -ErrorAction Stop
}
catch
{
$errorMessage = $LocalizedData.ErrorWebsiteStateFailure `
-f $Name, $_.Exception.Message
New-TerminatingError -ErrorId 'WebsiteStateFailure' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidOperation'
}
}
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedState `
-f $Name, $State)
}
# Update ServerAutoStart if required
if ($PSBoundParameters.ContainsKey('ServerAutoStart') -and `
($website.serverAutoStart -ne $ServerAutoStart))
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name serverAutoStart `
-Value $ServerAutoStart `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetWebsiteAutoStartUpdated `
-f $Name)
}
}
# Create website if it does not exist
else
{
try
{
$PSBoundParameters.GetEnumerator() | Where-Object -FilterScript {
$_.Key -in (Get-Command -Name New-Website `
-Module WebAdministration).Parameters.Keys
} | ForEach-Object -Begin {
$newWebsiteSplat = @{}
} -Process {
$newWebsiteSplat.Add($_.Key, $_.Value)
}
# New-WebSite has Id parameter instead of SiteId, so it's getting mapped to Id
if ($PSBoundParameters.ContainsKey('SiteId'))
{
$newWebsiteSplat.Add('Id', $SiteId)
} elseif (-not (Get-WebSite)) {
# If there are no other websites and SiteId is missing, specify the Id Parameter for the new website.
# Otherwise an error can occur on systems running Windows Server 2008 R2.
$newWebsiteSplat.Add('Id', 1)
}
if ([String]::IsNullOrEmpty($PhysicalPath))
{
# If no physical path is provided run New-Website with -Force flag
$website = New-Website @newWebsiteSplat -ErrorAction Stop -Force
} else {
# If physical path is provided don't run New-Website with -Force flag to verify that the path exists
$website = New-Website @newWebsiteSplat -ErrorAction Stop
}
Write-Verbose -Message ($LocalizedData.VerboseSetTargetWebsiteCreated `
-f $Name)
}
catch
{
$errorMessage = $LocalizedData.ErrorWebsiteCreationFailure `
-f $Name, $_.Exception.Message
New-TerminatingError -ErrorId 'WebsiteCreationFailure' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidOperation'
}
Stop-Website -Name $website.Name -ErrorAction Stop
# Clear default bindings if new bindings defined and are different
if ($PSBoundParameters.ContainsKey('BindingInfo') -and `
$null -ne $BindingInfo)
{
if (-not (Test-WebsiteBinding -Name $Name `
-BindingInfo $BindingInfo))
{
Update-WebsiteBinding -Name $Name -BindingInfo $BindingInfo
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedBindingInfo `
-f $Name)
}
}
# Update Enabled Protocols if required
if ($PSBoundParameters.ContainsKey('EnabledProtocols') `
-and $website.EnabledProtocols `
-ne $EnabledProtocols)
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name enabledProtocols `
-Value $EnabledProtocols `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdatedEnabledProtocols `
-f $Name, $EnabledProtocols)
}
# Update Default Pages if required
if ($PSBoundParameters.ContainsKey('DefaultPage') -and `
$null -ne $DefaultPage)
{
Update-DefaultPage -Name $Name `
-DefaultPage $DefaultPage
}
# Start website if required
if ($State -eq 'Started')
{
# Ensure that there are no other running websites with binding information that
# will conflict with this website before starting
if (-not (Confirm-UniqueBinding -Name $Name -ExcludeStopped))
{
# Return error and do not start the website
$errorMessage = $LocalizedData.ErrorWebsiteBindingConflictOnStart `
-f $Name
New-TerminatingError -ErrorId 'WebsiteBindingConflictOnStart' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidResult'
}
try
{
Start-Website -Name $Name -ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetWebsiteStarted `
-f $Name)
}
catch
{
$errorMessage = $LocalizedData.ErrorWebsiteStateFailure `
-f $Name, $_.Exception.Message
New-TerminatingError -ErrorId 'WebsiteStateFailure' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidOperation'
}
}
# Update ServerAutoStart if required
if ($PSBoundParameters.ContainsKey('ServerAutoStart') -and `
($website.serverAutoStart -ne $ServerAutoStart))
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name serverAutoStart `
-Value $ServerAutoStart `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetWebsiteAutoStartUpdated `
-f $Name)
}
}
# Set Authentication; if not defined then pass in DefaultAuthenticationInfo
if ($PSBoundParameters.ContainsKey('AuthenticationInfo') -and `
(-not (Test-AuthenticationInfo -Site $Name `
-AuthenticationInfo $AuthenticationInfo)))
{
Set-AuthenticationInfo -Site $Name `
-AuthenticationInfo $AuthenticationInfo `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetAuthenticationInfoUpdated `
-f $Name)
}
# Update Preload if required
if ($PSBoundParameters.ContainsKey('preloadEnabled') -and `
($website.applicationDefaults.preloadEnabled -ne $PreloadEnabled))
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name applicationDefaults.preloadEnabled `
-Value $PreloadEnabled `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetWebsitePreloadUpdated `
-f $Name)
}
# Update AutoStart if required
if ($PSBoundParameters.ContainsKey('ServiceAutoStartEnabled') -and `
($website.applicationDefaults.ServiceAutoStartEnabled -ne $ServiceAutoStartEnabled))
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name applicationDefaults.serviceAutoStartEnabled `
-Value $ServiceAutoStartEnabled `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetServiceAutoStartUpdated `
-f $Name)
}
# Update AutoStartProviders if required
if ($PSBoundParameters.ContainsKey('ServiceAutoStartProvider') -and `
($website.applicationDefaults.ServiceAutoStartProvider `
-ne $ServiceAutoStartProvider))
{
if (-not (Confirm-UniqueServiceAutoStartProviders `
-ServiceAutoStartProvider $ServiceAutoStartProvider `
-ApplicationType $ApplicationType))
{
Add-WebConfiguration -filter /system.applicationHost/serviceAutoStartProviders `
-Value @{
name=$ServiceAutoStartProvider;
type=$ApplicationType
} `
-ErrorAction Stop
Write-Verbose -Message `
($LocalizedData.VerboseSetTargetIISAutoStartProviderUpdated)
}
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name applicationDefaults.serviceAutoStartProvider `
-Value $ServiceAutoStartProvider -ErrorAction Stop
Write-Verbose -Message `
($LocalizedData.VerboseSetTargetServiceAutoStartProviderUpdated `
-f $Name)
}
# Update LogFormat if Needed
if ($PSBoundParameters.ContainsKey('LogFormat') -and `
($LogFormat -ne $website.logfile.LogFormat))
{
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogFormat -f $Name)
# In Windows Server 2008 R2, Set-ItemProperty only accepts index values to the LogFile.LogFormat property
$site = Get-Item "IIS:\Sites\$Name"
$site.LogFile.LogFormat = $LogFormat
$site | Set-Item
}
# Update LogTargetW3C if Needed
if ($PSBoundParameters.ContainsKey('LogTargetW3C') `
-and $website.logfile.LogTargetW3C `
-ne $LogTargetW3C)
{
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name logfile.logTargetW3C `
-Value $LogTargetW3C `
-ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogTargetW3C `
-f $Name, $LogTargetW3C)
}
# Update LogFlags if required
if ($PSBoundParameters.ContainsKey('LogFlags') -and `
(-not (Compare-LogFlags -Name $Name -LogFlags $LogFlags)))
{
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogFlags `
-f $Name)
# Set-ItemProperty has no effect with the LogFile.LogExtFileFlags property
$site = Get-Item "IIS:\Sites\$Name"
$site.LogFile.LogFormat = 'W3C'
$site.LogFile.LogExtFileFlags = $LogFlags -join ','
$site | Set-Item
}
# Update LogPath if required
if ($PSBoundParameters.ContainsKey('LogPath') -and `
($LogPath -ne $website.logfile.directory))
{
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogPath `
-f $Name)
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name LogFile.directory -value $LogPath
}
# Update LogPeriod if needed
if ($PSBoundParameters.ContainsKey('LogPeriod') -and `
($LogPeriod -ne $website.logfile.period))
{
if ($PSBoundParameters.ContainsKey('LogTruncateSize'))
{
Write-Verbose -Message ($LocalizedData.WarningLogPeriod `
-f $Name)
}
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogPeriod)
# In Windows Server 2008 R2, Set-ItemProperty only accepts index values to the LogFile.Period property
$site = Get-Item "IIS:\Sites\$Name"
$site.LogFile.Period = $LogPeriod
$site | Set-Item
}
# Update LogTruncateSize if needed
if ($PSBoundParameters.ContainsKey('LogTruncateSize') -and `
($LogTruncateSize -ne $website.logfile.LogTruncateSize))
{
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogTruncateSize `
-f $Name)
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name LogFile.truncateSize -Value $LogTruncateSize
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name LogFile.period -Value 'MaxSize'
}
# Update LoglocalTimeRollover if needed
if ($PSBoundParameters.ContainsKey('LoglocalTimeRollover') -and `
($LoglocalTimeRollover -ne `
([System.Convert]::ToBoolean($website.logfile.LocalTimeRollover))))
{
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLoglocalTimeRollover `
-f $Name)
Set-ItemProperty -Path "IIS:\Sites\$Name" `
-Name LogFile.localTimeRollover -Value $LoglocalTimeRollover
}
# Update LogCustomFields if needed
if ($PSBoundParameters.ContainsKey('LogCustomFields') -and `
(-not (Test-LogCustomField -Site $Name -LogCustomField $LogCustomFields)))
{
Write-Verbose -Message ($LocalizedData.VerboseSetTargetUpdateLogCustomFields `
-f $Name)
Set-LogCustomField -Site $Name -LogCustomField $LogCustomFields
}
}
# Remove website
else
{
try
{
Remove-Website -Name $Name -ErrorAction Stop
Write-Verbose -Message ($LocalizedData.VerboseSetTargetWebsiteRemoved `
-f $Name)
}
catch
{
$errorMessage = $LocalizedData.ErrorWebsiteRemovalFailure `
-f $Name, $_.Exception.Message
New-TerminatingError -ErrorId 'WebsiteRemovalFailure' `
-ErrorMessage $errorMessage `
-ErrorCategory 'InvalidOperation'
}
}
}
<#
.SYNOPSIS
The Test-TargetResource cmdlet is used to validate if the role or feature is in a state as
expected in the instance document.
.PARAMETER SiteId
Optional. Specifies the IIS site Id for the web site.
#>
function Test-TargetResource
{
[CmdletBinding()]
[OutputType([Boolean])]
param
(
[Parameter()]
[ValidateSet('Present', 'Absent')]
[String]
$Ensure = 'Present',
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[String]
$Name,
[Parameter()]
[UInt32]
$SiteId,
[Parameter()]
[String]
$PhysicalPath,
[Parameter()]
[ValidateSet('Started', 'Stopped')]
[String]
$State = 'Started',
# The application pool name must contain between 1 and 64 characters
[Parameter()]
[ValidateLength(1, 64)]
[String]
$ApplicationPool,
[Parameter()]
[Microsoft.Management.Infrastructure.CimInstance[]]
$BindingInfo,
[Parameter()]
[String[]]
$DefaultPage,
[Parameter()]
[String]
$EnabledProtocols,
[Parameter()]
[Boolean]
$ServerAutoStart,
[Parameter()]
[Microsoft.Management.Infrastructure.CimInstance]
$AuthenticationInfo,
[Parameter()]
[Boolean]
$PreloadEnabled,
[Parameter()]
[Boolean]
$ServiceAutoStartEnabled,
[Parameter()]
[String]
$ServiceAutoStartProvider,
[Parameter()]
[String]
$ApplicationType,
[Parameter()]
[String]
$LogPath,
[Parameter()]
[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,
[Parameter()]
[ValidateSet('Hourly','Daily','Weekly','Monthly','MaxSize')]
[String]
$LogPeriod,
[Parameter()]
[ValidateScript({
([ValidateRange(1048576, 4294967295)] $valueAsUInt64 = [UInt64]::Parse($_))
})]
[String]
$LogTruncateSize,
[Parameter()]
[Boolean]
$LoglocalTimeRollover,
[Parameter()]
[ValidateSet('IIS','W3C','NCSA')]
[String]
$LogFormat,
[Parameter()]
[ValidateSet('File','ETW','File,ETW')]
[String]
$LogTargetW3C,
[Parameter()]
[Microsoft.Management.Infrastructure.CimInstance[]]
$LogCustomFields
)
Assert-Module
$inDesiredState = $true
$website = Get-Website | Where-Object -FilterScript {$_.Name -eq $Name}
# Check Ensure
if (($Ensure -eq 'Present' -and $null -eq $website) -or `
($Ensure -eq 'Absent' -and $null -ne $website))
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseEnsure `
-f $Name)
}
# Only check properties if website exists
if ($Ensure -eq 'Present' -and `
$null -ne $website)
{
# Check Site Id property.
if ($SiteId -gt 0 -and $website.Id -ne $SiteId)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseSiteId -f $Name)
}
# Check Physical Path property
if ([String]::IsNullOrEmpty($PhysicalPath) -eq $false -and `
$website.PhysicalPath -ne $PhysicalPath)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalsePhysicalPath `
-f $Name)
}
# Check State
if ($PSBoundParameters.ContainsKey('State') -and $website.State -ne $State)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseState `
-f $Name)
}
# Check Application Pool property
if ($PSBoundParameters.ContainsKey('ApplicationPool') -and `
$website.ApplicationPool -ne $ApplicationPool)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseApplicationPool `
-f $Name)
}
# Check Binding properties
if ($PSBoundParameters.ContainsKey('BindingInfo') -and `
$null -ne $BindingInfo)
{
if (-not (Test-WebsiteBinding -Name $Name -BindingInfo $BindingInfo))
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseBindingInfo `
-f $Name)
}
}
# Check Enabled Protocols
if ($PSBoundParameters.ContainsKey('EnabledProtocols') -and `
$website.EnabledProtocols -ne $EnabledProtocols)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseEnabledProtocols `
-f $Name)
}
# Check Default Pages
if ($PSBoundParameters.ContainsKey('DefaultPage') -and `
$null -ne $DefaultPage)
{
$allDefaultPages = @(
Get-WebConfiguration -Filter '/system.webServer/defaultDocument/files/*' `
-PSPath "IIS:\Sites\$Name" |
ForEach-Object -Process { Write-Output -InputObject $_.value }
)
foreach ($page in $DefaultPage)
{
if ($allDefaultPages -inotcontains $page)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseDefaultPage `
-f $Name)
}
}
}
#Check ServerAutoStart
if ($PSBoundParameters.ContainsKey('ServerAutoStart') -and `
$website.serverAutoStart -ne $ServerAutoStart)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseAutoStart `
-f $Name)
}
#Check AuthenticationInfo
if ($PSBoundParameters.ContainsKey('AuthenticationInfo') -and `
(-not (Test-AuthenticationInfo -Site $Name `
-AuthenticationInfo $AuthenticationInfo)))
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseAuthenticationInfo)
}
#Check Preload
if($PSBoundParameters.ContainsKey('preloadEnabled') -and `
$website.applicationDefaults.preloadEnabled -ne $PreloadEnabled)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalsePreload `
-f $Name)
}
#Check AutoStartEnabled
if($PSBoundParameters.ContainsKey('serviceAutoStartEnabled') -and `
$website.applicationDefaults.serviceAutoStartEnabled -ne $ServiceAutoStartEnabled)
{
$inDesiredState = $false
Write-Verbose -Message ($LocalizedData.VerboseTestTargetFalseServiceAutoStart `
-f $Name)
}
#Check AutoStartProviders
if($PSBoundParameters.ContainsKey('serviceAutoStartProvider') -and `