-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathindex.html
6995 lines (6985 loc) · 631 KB
/
index.html
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
<!DOCTYPE html>
<!--
<auto-generated>
<synopsis>
This code was generated by a tool. on: 09/25/2015 05:26:49
</synopsis>
<description>
If you'd like to regenerate the documentation, please open up powershell and run
> .\build.ps1 docs
If the documentation is incomplete, or eronious,
please edit the comments at the top of the module method within it's respecive .ps1 file.
</description>
</auto-generated>
-->
<html lang="en">
<head>
<title>poshBAR Documentation</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<link href="https://cdnjs.cloudflare.com/ajax/libs/SyntaxHighlighter/3.0.83/styles/shCore.min.css" rel="stylesheet" charset="utf-8">
<link href="https://cdnjs.cloudflare.com/ajax/libs/SyntaxHighlighter/3.0.83/styles/shCoreDefault.min.css" rel="stylesheet" charset="utf-8">
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/css/bootstrap.min.css" rel="stylesheet" charset="utf-8">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<style>
.syntaxhighlighter {
overflow-y: hidden !important;
overflow-x: auto !important;
}
pre {
min-height: 30px;
}
.navbar-nav {
height: 100%;
overflow-y: auto;
}
.form-group {
padding-top: 12px;
padding-left: 12px;
padding-right: 12px;
}
.sidebar-nav .navbar-header {
float: none;
}
.sidebar-nav .navbar li a {
padding-top: 4px;
padding-bottom: 4px;
}
@media (min-width: 768px) {
.sidebar-nav .navbar .navbar-collapse {
padding: 0;
max-height: none;
}
.sidebar-nav .navbar ul {
float: none;
}
.sidebar-nav .navbar ul:not {
display: block;
}
.sidebar-nav .navbar li {
float: none;
display: block;
}
}
</style>
</head>
<body>
<div class="container-fluid">
<div class="row-fluid">
<div><h1>poshBAR</h1></div>
</div>
<div class="row-fluid">
<div class="col-lg-3 col-md-4 col-sm-5 col-xs-12">
<div class="sidebar-nav">
<div class="navbar navbar-default" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse">
<span class="sr-only">Toggle</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="visible-xs navbar-brand">click menu to open</span>
</div>
<div class="navbar-collapse collapse sidebar-navbar-collapse">
<div class="form-group">
<input class="form-control" id="searchinput" type="search" placeholder="Filter..." />
</div>
<ul class="nav navbar-nav list-group" id="searchList">
<li class="nav-menu list-group-item"><a href="#Add-HostsFileEntry">Add-HostsFileEntry</a></li>
<li class="nav-menu list-group-item"><a href="#Add-IISHttpVerb">Add-IISHttpVerb</a></li>
<li class="nav-menu list-group-item"><a href="#Add-IISMimeType">Add-IISMimeType</a></li>
<li class="nav-menu list-group-item"><a href="#Add-LoopbackFix">Add-LoopbackFix</a></li>
<li class="nav-menu list-group-item"><a href="#Add-XmlConfigValue">Add-XmlConfigValue</a></li>
<li class="nav-menu list-group-item"><a href="#Approve-Permissions">Approve-Permissions</a></li>
<li class="nav-menu list-group-item"><a href="#Assert-PSVersion">Assert-PSVersion</a></li>
<li class="nav-menu list-group-item"><a href="#Assert-That">Assert-That</a></li>
<li class="nav-menu list-group-item"><a href="#Confirm-ApplicationExists">Confirm-ApplicationExists</a></li>
<li class="nav-menu list-group-item"><a href="#Confirm-AppPoolExists">Confirm-AppPoolExists</a></li>
<li class="nav-menu list-group-item"><a href="#Confirm-SiteExists">Confirm-SiteExists</a></li>
<li class="nav-menu list-group-item"><a href="#Expand-NugetPackage">Expand-NugetPackage</a></li>
<li class="nav-menu list-group-item"><a href="#Expand-ZipFile">Expand-ZipFile</a></li>
<li class="nav-menu list-group-item"><a href="#Find-ToolPath">Find-ToolPath</a></li>
<li class="nav-menu list-group-item"><a href="#Format-TaskNameToHost">Format-TaskNameToHost</a></li>
<li class="nav-menu list-group-item"><a href="#Get-Application">Get-Application</a></li>
<li class="nav-menu list-group-item"><a href="#Get-Applications">Get-Applications</a></li>
<li class="nav-menu list-group-item"><a href="#Get-AppPool">Get-AppPool</a></li>
<li class="nav-menu list-group-item"><a href="#Get-AppPools">Get-AppPools</a></li>
<li class="nav-menu list-group-item"><a href="#Get-EnvironmentSettings">Get-EnvironmentSettings</a></li>
<li class="nav-menu list-group-item"><a href="#Get-PfxCertificate">Get-PfxCertificate</a></li>
<li class="nav-menu list-group-item"><a href="#Get-PfxCertificate">Get-PfxCertificate</a></li>
<li class="nav-menu list-group-item"><a href="#Get-Site">Get-Site</a></li>
<li class="nav-menu list-group-item"><a href="#Get-Sites">Get-Sites</a></li>
<li class="nav-menu list-group-item"><a href="#Get-TestFileName">Get-TestFileName</a></li>
<li class="nav-menu list-group-item"><a href="#Get-WindowsFeatures">Get-WindowsFeatures</a></li>
<li class="nav-menu list-group-item"><a href="#Install-WebApplication">Install-WebApplication</a></li>
<li class="nav-menu list-group-item"><a href="#Install-WindowsFeatures">Install-WindowsFeatures</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-AspNetRegIIS">Invoke-AspNetRegIIS</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-BlockWithTokenReplacedFile">Invoke-BlockWithTokenReplacedFile</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-BulkCopy">Invoke-BulkCopy</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-Chutzpah">Invoke-Chutzpah</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-CleanMSBuild">Invoke-CleanMSBuild</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-Deployment">Invoke-Deployment</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-DeployOctopusNugetPackage">Invoke-DeployOctopusNugetPackage</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-Ecliptic">Invoke-Ecliptic</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-ElevatedCommand">Invoke-ElevatedCommand</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-EntityFrameworkMigrations">Invoke-EntityFrameworkMigrations</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-ExternalCommand">Invoke-ExternalCommand</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-FromBase64">Invoke-FromBase64</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-HtmlDecode">Invoke-HtmlDecode</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-HtmlEncode">Invoke-HtmlEncode</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-KarmaTests">Invoke-KarmaTests</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-MSBuild">Invoke-MSBuild</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-Nunit">Invoke-Nunit</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-NUnitWithCoverage">Invoke-NUnitWithCoverage</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-OracleCommand">Invoke-OracleCommand</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-OracleFile">Invoke-OracleFile</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-PowershellScriptSigning">Invoke-PowershellScriptSigning</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-SpecFlow">Invoke-SpecFlow</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-SqlFile">Invoke-SqlFile</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-SqlStatement">Invoke-SqlStatement</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-ToBase64">Invoke-ToBase64</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-UrlDecode">Invoke-UrlDecode</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-UrlEncode">Invoke-UrlEncode</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-WebHealthCheck">Invoke-WebHealthCheck</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-XmlDocumentTransform">Invoke-XmlDocumentTransform</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-XUnit">Invoke-XUnit</a></li>
<li class="nav-menu list-group-item"><a href="#Invoke-XUnitWithCoverage">Invoke-XUnitWithCoverage</a></li>
<li class="nav-menu list-group-item"><a href="#Lock-Object">Lock-Object</a></li>
<li class="nav-menu list-group-item"><a href="#New-Application">New-Application</a></li>
<li class="nav-menu list-group-item"><a href="#New-AppPool">New-AppPool</a></li>
<li class="nav-menu list-group-item"><a href="#New-Certificate">New-Certificate</a></li>
<li class="nav-menu list-group-item"><a href="#New-CertificateSigningRequest">New-CertificateSigningRequest</a></li>
<li class="nav-menu list-group-item"><a href="#New-NugetPackage">New-NugetPackage</a></li>
<li class="nav-menu list-group-item"><a href="#New-OracleDatabase">New-OracleDatabase</a></li>
<li class="nav-menu list-group-item"><a href="#New-PfxCertificate">New-PfxCertificate</a></li>
<li class="nav-menu list-group-item"><a href="#New-PrivateKey">New-PrivateKey</a></li>
<li class="nav-menu list-group-item"><a href="#New-PrivateKeyAndCertificateSigningRequest">New-PrivateKeyAndCertificateSigningRequest</a></li>
<li class="nav-menu list-group-item"><a href="#New-Site">New-Site</a></li>
<li class="nav-menu list-group-item"><a href="#Remove-Application">Remove-Application</a></li>
<li class="nav-menu list-group-item"><a href="#Remove-AppPool">Remove-AppPool</a></li>
<li class="nav-menu list-group-item"><a href="#Remove-OracleDatabase">Remove-OracleDatabase</a></li>
<li class="nav-menu list-group-item"><a href="#Remove-Site">Remove-Site</a></li>
<li class="nav-menu list-group-item"><a href="#RequiredWindowsFeatures">RequiredWindowsFeatures</a></li>
<li class="nav-menu list-group-item"><a href="#Reset-OracleDatabase">Reset-OracleDatabase</a></li>
<li class="nav-menu list-group-item"><a href="#Set-IISAuthentication">Set-IISAuthentication</a></li>
<li class="nav-menu list-group-item"><a href="#Set-IISCustomHeader">Set-IISCustomHeader</a></li>
<li class="nav-menu list-group-item"><a href="#Set-WebConfigurationPropertyExtended">Set-WebConfigurationPropertyExtended</a></li>
<li class="nav-menu list-group-item"><a href="#Start-Application">Start-Application</a></li>
<li class="nav-menu list-group-item"><a href="#Start-AppPool">Start-AppPool</a></li>
<li class="nav-menu list-group-item"><a href="#Start-Site">Start-Site</a></li>
<li class="nav-menu list-group-item"><a href="#Step">Step</a></li>
<li class="nav-menu list-group-item"><a href="#Stop-Application">Stop-Application</a></li>
<li class="nav-menu list-group-item"><a href="#Stop-AppPool">Stop-AppPool</a></li>
<li class="nav-menu list-group-item"><a href="#Stop-Site">Stop-Site</a></li>
<li class="nav-menu list-group-item"><a href="#Test-PathExtended">Test-PathExtended</a></li>
<li class="nav-menu list-group-item"><a href="#Test-RunAsAdmin">Test-RunAsAdmin</a></li>
<li class="nav-menu list-group-item"><a href="#Update-Application">Update-Application</a></li>
<li class="nav-menu list-group-item"><a href="#Update-AppPool">Update-AppPool</a></li>
<li class="nav-menu list-group-item"><a href="#Update-AssemblyVersions">Update-AssemblyVersions</a></li>
<li class="nav-menu list-group-item"><a href="#Update-JsonConfigValues">Update-JsonConfigValues</a></li>
<li class="nav-menu list-group-item"><a href="#Update-Site">Update-Site</a></li>
<li class="nav-menu list-group-item"><a href="#Update-XmlConfigValues">Update-XmlConfigValues</a></li>
<li class="nav-menu list-group-item"><a href="#Use-Object">Use-Object</a></li>
<li class="nav-menu list-group-item"><a href="#Write-TokenReplacedFile">Write-TokenReplacedFile</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="col-lg-9 col-md-8 col-sm-7 col-xs-12">
<div id="Add-HostsFileEntry" class="toggle_container">
<div class="page-header">
<h2> Add-HostsFileEntry </h2>
<p>Will add a hosts file entry for the host name specified targeting the specified ip address.</p>
<p>Adds the specified line to the hosts file if it doesn't already exist.</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Add-HostsFileEntry [-hostName] <String> [[-ipAddress] <String>] [[-includeLoopbackFix]] [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-hostName</nobr></td>
<td class="visible-lg visible-md">hn</td>
<td>The "host name" name you want routed to the target ip address.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-ipAddress</nobr></td>
<td class="visible-lg visible-md">ip</td>
<td>The ip address of the machine you want to target.</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg">127.0.0.1</td>
</tr>
<tr>
<td><nobr>-includeLoopbackFix</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Switch to determine if the Loopback Fix should also be applied (Add-LoopbackFix)</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg">False</td>
</tr>
</tbody>
</table>
</div>
<div class='panel panel-default'>
<div class='panel-heading'>
<h3 class='panel-title'> Note </h3>
</div>
<div class='panel-body'>If you '-includeLoopbackFix', this method will call the 'Add-LoopbackFix' module (see Links below)</div>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Add-HostsFileEntry "local.example.ca"</pre>
<div></div>
<strong>EXAMPLE 2</strong>
<pre class="brush: ps">Add-HostsFileEntry "local.example.ca" "10.1.1.1"</pre>
<div></div>
<strong>EXAMPLE 3</strong>
<pre class="brush: ps">Add-HostsFileEntry "local.example.ca" -includeLoopbackFix</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
<div>
<h3> Links </h3>
<div>
<ul>
<li class='psLink'><a href='#Add-LoopbackFix' target='_top'>Add-LoopbackFix</a></li>
</ul>
</div>
</div>
</div>
<div id="Add-IISHttpVerb" class="toggle_container">
<div class="page-header">
<h2> Add-IISHttpVerb </h2>
<p>Will add or remove a VERB from your website</p>
<p>Secure your site by only allowing approved HTTP Verbs ('GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'CONNECT', 'PATCH')</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Add-IISHttpVerb [-verb] <String> [-siteName] <String> [[-action] <String>] [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-verb</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The name of the verb.<br>valid verbs are: [GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH]</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-siteName</nobr></td>
<td class="visible-lg visible-md">sn, site</td>
<td>The name of the website that contains this application.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-action</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Add or Remove</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg">add</td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Add-IISHttpVerb PUT "apps.example.ca"</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Add-IISMimeType" class="toggle_container">
<div class="page-header">
<h2> Add-IISMimeType </h2>
<p>Will add a mapping for the file extension to the mime type on the named IIS site.</p>
<p>Will register a mimetype for a file extension.</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Add-IISMimeType [-siteName] <String> [-fileExtension] <String> [-mimeType] <String> [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-siteName</nobr></td>
<td class="visible-lg visible-md">sn</td>
<td>The name of the IIS site.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-fileExtension</nobr></td>
<td class="visible-lg visible-md">extension, ext</td>
<td>The file extension to map to the mime type.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-mimeType</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The mime type name.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Add-IISMimeType "foo.example.com" "json" "application/json"</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Add-LoopbackFix" class="toggle_container">
<div class="page-header">
<h2> Add-LoopbackFix </h2>
<p>Will apply a registry entry fix for issue KB896861. Uses the more conservative and recommend fix found in method 1.</p>
<p>Adds a registry entry that overrides the default windows behaviour regarding allowing a different "C" name to point back to 127.0.0.1</p>
</div>
<div class='panel panel-default'>
<div class='panel-heading'>
<h3 class='panel-title'> Add-LoopbackFix Aliases </h3>
</div>
<div class='panel-body'>
<ul>
<li>loopbackFix</li>
</ul>
</div>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Add-LoopbackFix [-siteHostName] <String> [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-siteHostName</nobr></td>
<td class="visible-lg visible-md">sn</td>
<td>The hostname that you want to loop back to the local host.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div class='panel panel-default'>
<div class='panel-heading'>
<h3 class='panel-title'> Note </h3>
</div>
<div class='panel-body'>Applies method 1 workaround fix for "You receive error 401.1 when you browse a Web site that uses Integrated Authentication and is hosted on
IIS 5.1 or a later version" (see Links below)</div>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Add-LoopbackFix "local.mysite.com"</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
<div>
<h3> Links </h3>
<div>
<ul>
<li class=''><a href='http://support.microsoft.com/kb/896861' target='_blank'>http://support.microsoft.com/kb/896861</a></li>
</ul>
</div>
</div>
</div>
<div id="Add-XmlConfigValue" class="toggle_container">
<div class="page-header">
<h2> Add-XmlConfigValue </h2>
<p>Updates a XML file with the value specified at the XPath expression specified..</p>
<p>Will parse an XML config file and add a xml node at a xpath expression.</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Add-XmlConfigValue [-configFile] <String> [-xpath] <String> [-newnode] <String> [[-attributes] <Hashtable>] [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-configFile</nobr></td>
<td class="visible-lg visible-md"></td>
<td>A path to a file that is XML based</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-xpath</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Any valid XPath exression, whether result in 1 or many matches, must be an Element.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-newnode</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Any valid XML node name that you wish to add.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-attributes</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Hashtable of attributes for the new node being created</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Add-ConfigValues "C:\temp\somefile.config" "//SomeNode/AnotherNode" "SomeNewNode" @{"key0"="value0";"key1"="value1"}</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Approve-Permissions" class="toggle_container">
<div class="page-header">
<h2> Approve-Permissions </h2>
<p>Sets permissions to a specified path for a specific trustee (user)</p>
<p>Sets permissions to a specified path for a specific trustee (user)</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Approve-Permissions [-path] <String> [-trustee] <String> [-permission] <String> [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-path</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The path that you are modifying permissions on</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-trustee</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The user who is being granted the specified permission</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-permission</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The permission level<br>[full, modify, read-execute, read-only, write-only]</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Approve-Permissions 'c:\inetpub\wwwroot' 'Network Service' 'read-execute'</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Assert-PSVersion" class="toggle_container">
<div class="page-header">
<h2> Assert-PSVersion </h2>
<p>Some powershell modules are only available on a specific version of PS. Call this to ensure the user is running under the appropriate version.</p>
<p>Enforces a specific PS Version</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Assert-PSVersion [-requiredVersion] <Int32> [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-requiredVersion</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The version of powershell required</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg">0</td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Assert-PSVersion 4</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Assert-That" class="toggle_container">
<div class="page-header">
<h2> Assert-That </h2>
<p>Asserts that the condition is true, and if it is not, will throw the specified failure message.</p>
<p>Asserts that the condition is true</p>
</div>
<div class='panel panel-default'>
<div class='panel-heading'>
<h3 class='panel-title'> Assert-That Aliases </h3>
</div>
<div class='panel-body'>
<ul>
<li>Assert</li>
</ul>
</div>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Assert-That [-conditionToCheck] <Object> [-failureMessage] <Object> [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-conditionToCheck</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The condition that you're asserting</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-failureMessage</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The message to throw if the condition is not met.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Assert-That ($name -ne $null) "Name cannot be null."</pre>
<div></div>
<strong>EXAMPLE 2</strong>
<pre class="brush: ps">Assert ($foo -eq $bar) '$foo and $bar must be equal.'</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Confirm-ApplicationExists" class="toggle_container">
<div class="page-header">
<h2> Confirm-ApplicationExists </h2>
<p>Confirms that the application in question actually exists in IIS</p>
<p>Confirms that the application in question actually exists in IIS</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Confirm-ApplicationExists [[-siteName] <Object>] [[-appName] <Object>] [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-siteName</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Name of the assocaited IIS website</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-appName</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Name of the IIS application that we're confirming.</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Confirm-ApplicatonExists 'mySite' 'myApp'</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Confirm-AppPoolExists" class="toggle_container">
<div class="page-header">
<h2> Confirm-AppPoolExists </h2>
<p>Will confirm whether or not an application pool exists</p>
<p>Will confirm whether or not an application pool exists</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Confirm-AppPoolExists [[-appPoolName] <Object>] [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-appPoolName</nobr></td>
<td class="visible-lg visible-md"></td>
<td>The name of the application pool.</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Confirm-AppPoolExists "myAppPool"</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Confirm-SiteExists" class="toggle_container">
<div class="page-header">
<h2> Confirm-SiteExists </h2>
<p>Checks to see if a website already exists</p>
<p></p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Confirm-SiteExists [[-siteName] <String>] [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-siteName</nobr></td>
<td class="visible-lg visible-md"></td>
<td>Name of the website as it appears in IIS</td>
<td class="visible-lg visible-md">false</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Confirm-SiteExists "myWebsite.com"</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Expand-NugetPackage" class="toggle_container">
<div class="page-header">
<h2> Expand-NugetPackage </h2>
<p>Expands any Nuget package and places the contents in the specified folder.</p>
<p>Extracts a Nuget Package file and puts the contents in the specified location.</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Expand-NugetPackage [-nugetPackageName] <String> [-destinationFolder] <String> [<CommonParameters>]</pre>
</div>
</div>
<div>
<h3> Parameters </h3>
<table class="table table-striped table-bordered table-condensed visible-on">
<thead>
<tr>
<th>Name</th>
<th class="visible-lg visible-md">Alias</th>
<th>Description</th>
<th class="visible-lg visible-md">Required?</th>
<th class="visible-lg">Pipeline Input</th>
<th class="visible-lg">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><nobr>-nugetPackageName</nobr></td>
<td class="visible-lg visible-md">pkgName</td>
<td>The full path to the Nuget package.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
<tr>
<td><nobr>-destinationFolder</nobr></td>
<td class="visible-lg visible-md">dest</td>
<td>The full path to the desired destination.</td>
<td class="visible-lg visible-md">true</td>
<td class="visible-lg">false</td>
<td class="visible-lg"></td>
</tr>
</tbody>
</table>
</div>
<div>
<h3> Examples </h3>
</div>
<div class='panel panel-default'>
<div class='panel-body'>
<strong>EXAMPLE 1</strong>
<pre class="brush: ps">Expand-NugetPackage "something.pkg" "C:\temp\zipcontents"</pre>
<div></div>
</div>
</div>
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
</div>
<div id="Expand-ZipFile" class="toggle_container">
<div class="page-header">
<h2> Expand-ZipFile </h2>
<p>Expands any zip file and places the contents in the specified folder. This command uses the Windows Shell to do the unzip and as such the file
needs to end in ".zip" in order to work. This module will temporarily rename the file to '.zip' extension if necessary in order to unzip it,
but it will rename it back when finished.</p>
<p>Expands any zip file and places the contents in the specified folder.</p>
</div>
<div>
<h3> Syntax </h3>
</div>
<div class="panel panel-default">
<div class='panel-body'>
<pre class="brush: ps">Expand-ZipFile [-zipFileName] <String> [-destinationFolder] <String> [<CommonParameters>]</pre>
</div>
</div>
<div>