-
Notifications
You must be signed in to change notification settings - Fork 0
/
Enable-IisSecurityAuthentication.html
142 lines (128 loc) · 5.42 KB
/
Enable-IisSecurityAuthentication.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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>PowerShell - Enable-IisSecurityAuthentication - Carbon</title>
<link href="silk.css" type="text/css" rel="stylesheet" />
<link href="styles.css" type="text/css" rel="stylesheet" />
</head>
<body>
<ul id="SiteNav">
<li><a href="index.html">Get-Carbon</a></li>
<li><a href="about_Carbon_Installation.html">-Install</a></li>
<li><a href="documentation.html">-Documentation</a></li>
<li><a href="about_Carbon_Support.html">-Support</a></li>
<li><a href="releasenotes.html">-ReleaseNotes</a></li>
<li><a href="http://pshdo.com">-Blog</a></li>
<li><a href="https://github.com/webmd-health-services/Carbon/">-Project</a></li>
</ul>
<h1>Enable-IisSecurityAuthentication</h1>
<div class="Synopsis">
<p>Enables anonymous or basic authentication for an entire site or a sub-directory of that site.</p>
</div>
<h2>Syntax</h2>
<pre class="Syntax"><code>Enable-IisSecurityAuthentication -SiteName <String> [-VirtualPath <String>] -Anonymous [-WhatIf] [-Confirm] [<CommonParameters>]
</code></pre>
<pre class="Syntax"><code>
</code></pre>
<pre class="Syntax"><code>Enable-IisSecurityAuthentication -SiteName <String> [-VirtualPath <String>] -Basic [-WhatIf] [-Confirm] [<CommonParameters>]
</code></pre>
<pre class="Syntax"><code>
</code></pre>
<pre class="Syntax"><code>Enable-IisSecurityAuthentication -SiteName <String> [-VirtualPath <String>] -Windows [-WhatIf] [-Confirm] [<CommonParameters>]</code></pre>
<h2>Description</h2>
<div class="Description">
<p>By default, enables an authentication type on an entire website. You can enable an authentication type at a specific path under a website by passing the virtual path (<em>not</em> the physical path) to that directory as the value of the <code>VirtualPath</code> parameter.</p>
<p>Beginning with Carbon 2.0.1, this function is available only if IIS is installed.</p>
</div>
<h2>Related Commands</h2>
<ul class="RelatedCommands">
<li><a href="Disable-IisSecurityAuthentication.html">Disable-IisSecurityAuthentication</a></li>
<li><a href="Get-IisSecurityAuthentication.html">Get-IisSecurityAuthentication</a></li>
<li><a href="Test-IisSecurityAuthentication.html">Test-IisSecurityAuthentication</a></li>
</ul>
<h2> Parameters </h2>
<table id="Parameters">
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required?</th>
<th>Pipeline Input</th>
<th>Default Value</th>
</tr>
<tr valign='top'>
<td>SiteName</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.string.aspx">String</a></td>
<td class="ParamDescription"><p>The site where anonymous authentication should be set.</p></td>
<td>true</td>
<td>false</td>
<td></td>
</tr>
<tr valign='top'>
<td>VirtualPath</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.string.aspx">String</a></td>
<td class="ParamDescription"><p>The optional path where anonymous authentication should be set.</p></td>
<td>false</td>
<td>false</td>
<td></td>
</tr>
<tr valign='top'>
<td>Anonymous</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.management.automation.switchparameter.aspx">SwitchParameter</a></td>
<td class="ParamDescription"><p>Enable anonymouse authentication.</p></td>
<td>true</td>
<td>false</td>
<td>False</td>
</tr>
<tr valign='top'>
<td>Basic</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.management.automation.switchparameter.aspx">SwitchParameter</a></td>
<td class="ParamDescription"><p>Enable basic authentication.</p></td>
<td>true</td>
<td>false</td>
<td>False</td>
</tr>
<tr valign='top'>
<td>Windows</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.management.automation.switchparameter.aspx">SwitchParameter</a></td>
<td class="ParamDescription"><p>Enable Windows authentication.</p></td>
<td>true</td>
<td>false</td>
<td>False</td>
</tr>
<tr valign='top'>
<td>WhatIf</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.management.automation.switchparameter.aspx">SwitchParameter</a></td>
<td class="ParamDescription"></td>
<td>false</td>
<td>false</td>
<td></td>
</tr>
<tr valign='top'>
<td>Confirm</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.management.automation.switchparameter.aspx">SwitchParameter</a></td>
<td class="ParamDescription"></td>
<td>false</td>
<td>false</td>
<td></td>
</tr>
<tr valign="top">
<td><a href="http://technet.microsoft.com/en-us/library/dd315352.aspx">CommonParameters</a></td>
<td></td>
<td>This cmdlet supports common parameters. For more information type <br> <code>Get-Help about_CommonParameters</code>.</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
<h2>EXAMPLE 1</h2>
<pre><code>Enable-IisSecurityAuthentication -SiteName Peanuts -Anonymous</code></pre>
<p>Turns on anonymous authentication for the <code>Peanuts</code> website.</p>
<h2>EXAMPLE 2</h2>
<pre><code>Enable-IisSecurityAuthentication -SiteName Peanuts Snoopy/DogHouse -Basic</code></pre>
<p>Turns on anonymous authentication for the <code>Snoopy/DogHouse</code> directory under the <code>Peanuts</code> website.</p>
<div class="Footer">
Copyright 2012 - 2018 <a href="http://pshdo.com">Aaron Jensen</a>.
</div>
</body>
</html>