Skip to content

Commit 6773ff6

Browse files
Merge pull request MicrosoftDocs#3383 from Snozzberries/MicrosoftDocs#3382
Quality: PowerShell Summit MicrosoftDocsGH-3382
2 parents db500c1 + fba1b74 commit 6773ff6

File tree

1 file changed

+71
-32
lines changed

1 file changed

+71
-32
lines changed

docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentPolicyWebService.md

+71-32
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,23 @@ title: Install-AdcsEnrollmentPolicyWebService
1111
# Install-AdcsEnrollmentPolicyWebService
1212

1313
## SYNOPSIS
14-
Performs the configuration of Certificate Enrollment Policy Web service.
14+
Performs the configuration of Certificate Enrollment Policy Web Service.
1515

1616
## SYNTAX
1717

1818
```
19-
Install-AdcsEnrollmentPolicyWebService [-AuthenticationType <AuthenticationType>] [-SSLCertThumbprint <String>]
20-
[-KeyBasedRenewal] [-Force] [-Credential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
Install-AdcsEnrollmentPolicyWebService
20+
[-AuthenticationType <AuthenticationType>] [-SSLCertThumbprint <String>]
21+
[-KeyBasedRenewal] [-Force] [-Credential <PSCredential>] [-WhatIf]
22+
[-Confirm] [<CommonParameters>]
2123
```
2224

2325
## DESCRIPTION
24-
The **Install-AdcsEnrollmentPolicyWebService** cmdlet performs the configuration of Certificate Enrollment Policy Web service.
25-
It is also used to create additional instances of the service within an existing installation.
26-
To remove the certification authority (CA) role service use the **Uninstall-AdcsEnrollmentPolicyWebService** cmdlet.
26+
27+
The `Install-AdcsEnrollmentPolicyWebService` cmdlet performs the configuration of Certificate
28+
Enrollment Policy Web Service. It is also used to create and configure additional instances of the
29+
service within an existing installation. To remove the certification authority (CA) role service use
30+
the `Uninstall-AdcsEnrollmentPolicyWebService` cmdlet.
2731

2832
You can import the cmdlet by running the following commands from Windows PowerShell:
2933

@@ -33,30 +37,51 @@ You can import the cmdlet by running the following commands from Windows PowerSh
3337
## EXAMPLES
3438

3539
### Example 1: Install the Certificate Enrollment Policy Web Service using Kerberos
36-
```
37-
PS C:\> Install-AdcsEnrollmentPolicyWebService -AuthenticationType Kerberos -SSLCertThumbprint "sslCertThumbPrint"
40+
41+
```powershell
42+
$params = @{
43+
AuthenticationType = Kerberos
44+
SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b"
45+
}
46+
Install-AdcsEnrollmentPolicyWebService @params
3847
```
3948

40-
This command installs the Certificate Enrollment Policy Web Service using Kerberos for authentication.
41-
For information on obtaining a certificate thumbprint using Windows PowerShell, see [Certificate Provider](https://go.microsoft.com/fwlink/?LinkId=225044).
49+
This command installs the Certificate Enrollment Policy Web Service using Kerberos for
50+
authentication. For information on obtaining a certificate thumbprint using Windows PowerShell, see
51+
[Certificate Provider](https://go.microsoft.com/fwlink/?LinkId=225044).
4252

4353
### Example 2: Install the Certificate Enrollment Policy Web Service specifying a username and password
44-
```
45-
PS C:\> Install-AdcsEnrollmentPolicyWebService -AuthenticationType Username -SSLCertThumbprint "sslCertThumbPrint"
54+
55+
```powershell
56+
$params = @{
57+
AuthenticationType = Username
58+
SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b"
59+
}
60+
Install-AdcsEnrollmentPolicyWebService @params
4661
```
4762

48-
This command installs the Certificate Enrollment Policy Web Service specifying that a username and password is used for authentication.
63+
This command installs the Certificate Enrollment Policy Web Service specifying that a username and
64+
password is used for authentication.
4965

5066
### Example 3: Install the Certificate Enrollment Policy Web Service specifying a username and password for Key-Based Renewal
51-
```
52-
PS C:\> Install-AdcsEnrollmentPolicyWebService -AuthenticationType Username -SSLCertThumbprint <sslCertThumbPrint> -KeyBasedRenewal
67+
68+
```powershell
69+
$params = @{
70+
AuthenticationType = Username
71+
SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b"
72+
KeyBasedRenewal = $true
73+
}
74+
Install-AdcsEnrollmentPolicyWebService @params
5375
```
5476

55-
This command installs the Certificate Enrollment Policy Web Service specifying that a username and password is used for authentication and configures the service for Key-Based Renewal of the certificate.
77+
This command installs the Certificate Enrollment Policy Web Service specifying that a username and
78+
password is used for authentication and configures the service for Key-Based Renewal of the
79+
certificate.
5680

5781
## PARAMETERS
5882

5983
### -AuthenticationType
84+
6085
Specifies the authentication type used by the Certificate Enrollment Policy Web Service.
6186
The acceptable values for this parameter are:
6287

@@ -78,6 +103,7 @@ Accept wildcard characters: False
78103
```
79104
80105
### -Confirm
106+
81107
Prompts you for confirmation before running the cmdlet.
82108
83109
```yaml
@@ -93,11 +119,12 @@ Accept wildcard characters: False
93119
```
94120
95121
### -Credential
96-
Specifies the credentials for installing the Enrollment Policy Web Service.
97-
To obtain a credential object, use the **Get-Credential** cmdlet.
98-
For more information, type `Get-Help Get-Credential`.
99-
The Enrollment Policy Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain.
100-
You must use an account that is a member of Domain Admins group to install this service.
122+
123+
Specifies the credentials for installing the Enrollment Policy Web Service. To obtain a credential
124+
object, use the `Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. The
125+
Enrollment Policy Web Service must be installed on a server that is a member of an Active Directory
126+
Domain Services (AD DS) domain. You must use an account that is a member of Domain Admins group to
127+
install this service.
101128

102129
```yaml
103130
Type: PSCredential
@@ -112,6 +139,7 @@ Accept wildcard characters: False
112139
```
113140

114141
### -Force
142+
115143
Forces the command to run without asking for user confirmation.
116144

117145
```yaml
@@ -127,9 +155,11 @@ Accept wildcard characters: False
127155
```
128156

129157
### -KeyBasedRenewal
130-
Indicates that this cmdlet configures the Certificate Enrollment Policy Web Service to operate in key-based renewal mode.
131-
Key-based renewal allows certificate clients to renew their certificates using the key of their existing certificate for authentication.
132-
When in key-based renewal mode, the service will only return certificate templates that are set for key based renewal.
158+
159+
Indicates that this cmdlet configures the Certificate Enrollment Policy Web Service to operate in
160+
key-based renewal mode. Key-based renewal allows certificate clients to renew their certificates
161+
using the key of their existing certificate for authentication. When in key-based renewal mode, the
162+
service will only return certificate templates that are set for key based renewal.
133163

134164
```yaml
135165
Type: SwitchParameter
@@ -144,7 +174,9 @@ Accept wildcard characters: False
144174
```
145175

146176
### -SSLCertThumbprint
147-
Specifies the thumbprint of the certificate used by Internet Information Service (IIS) to enable support for required Secure Sockets Layer (SSL).
177+
178+
Specifies the thumbprint of the certificate used by Internet Information Service (IIS) to enable
179+
support for required Secure Sockets Layer/Transport Layer Security (SSL/TLS).
148180

149181
```yaml
150182
Type: String
@@ -159,6 +191,7 @@ Accept wildcard characters: False
159191
```
160192

161193
### -WhatIf
194+
162195
Shows what would happen if the cmdlet runs. The cmdlet is not run.
163196

164197
```yaml
@@ -174,7 +207,11 @@ Accept wildcard characters: False
174207
```
175208

176209
### CommonParameters
177-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
210+
211+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
212+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
213+
-WarningAction, and -WarningVariable. For more information, see
214+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
178215

179216
## INPUTS
180217

@@ -191,15 +228,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
191228
### Microsoft.CertificateServices.Deployment.Common.CEP.EnrollmentPolicyServiceResult
192229

193230
## NOTES
194-
* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation.
195231

196-
To see parameters, run the following command: `Install-AdcsEnrollmentPolicyWebService -?`
232+
- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to
233+
bypass the prompt for confirmation. To see parameters, run the following command:
234+
`Install-AdcsEnrollmentPolicyWebService -?`
197235

198-
* You can get the CA configuration, which is the computer name and CA name by running certutil without any parameters. You can see the certificate SSL certificate thumbprints assigned to the local computer by running the following commands:
199-
- `cd cert:\LocalMachine\My`
200-
- `dir | format-list`
236+
- You can get the CA configuration, which is the computer name and CA name by running certutil
237+
without any parameters. You can see the certificate SSL certificate thumbprints assigned to the
238+
local computer by running the following commands:
239+
- `cd cert:\LocalMachine\My`
240+
- `dir | format-list`
201241

202242
## RELATED LINKS
203243

204244
[Uninstall-AdcsEnrollmentPolicyWebService](./Uninstall-AdcsEnrollmentPolicyWebService.md)
205-

0 commit comments

Comments
 (0)