Install-Adcs
Enrollment
Web
Service
Syntax
Install-AdcsEnrollmentWebService
[-CAConfig <String>]
[-ApplicationPoolIdentity]
[-AuthenticationType <AuthenticationType>]
[-SSLCertThumbprint <String>]
[-RenewalOnly]
[-AllowKeyBasedRenewal]
[-Force]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Install-AdcsEnrollmentWebService
[-CAConfig <String>]
-ServiceAccountName <String>
-ServiceAccountPassword <SecureString>
[-AuthenticationType <AuthenticationType>]
[-SSLCertThumbprint <String>]
[-RenewalOnly]
[-AllowKeyBasedRenewal]
[-Force]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Install-AdcsEnrollmentWebService cmdlet performs the configuration of Certificate Enrollment Web service. It is also used to create additional instances of the service within an existing installation. To remove the Certificate Enrollment Web Service role service use the Uninstall-AdcsEnrollmentWebService cmdlet.
You can import the cmdlet by running the following commands from Windows PowerShell:
-
Import-Module ServerManager
-
Add-WindowsFeature Adcs-Enroll-Web-Svc
Examples
Example 1: Installs the Certificate Enrollment Web Service to use the certification authority
PS C:\> Install-AdcsEnrollmentWebService -ApplicationPoolIdentity -CAConfig "CA1.contoso.com\contoso-CA1-CA" -SSLCertThumbprint "Thumbprint001" -AuthenticationType Certificate
This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of CA1.contoso.com and a CA common name contoso-CA1-CA. The identity of the Certificate Enrollment Web Service is specified as the default application pool identity. The authentication type is certificate based.
Example 2: Installs the Certificate Enrollment Web Service to use the certification authority that prompts for password
PS C:\> Install-AdcsEnrollmentWebService -CAConfig "APP1.corp.contoso.com\corp-APP1-CA" -SSLCertThumbprint "Thumbprint001" -ServiceAccountName "Corp\CEPAcct1" -ServiceAccountPassword (read-host "Set user password" -assecurestring)
This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of APP1.corp.contoso.com and a CA common name corp-APP1-CA. The identity of the Certificate Enrollment Web Service is specified as CEPAcct1 from the Corp domain. The command will prompt for the user password.
Required Parameters
Specifies the domain account for use with the service.
The input string should be in the form of
<domain>\<accountname>
.
For instance, to specify an account named WebEnroll in the Corp.contoso.com domain, you would type
CORP\WebEnroll
.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the password for the domain account used as the service account.
Type: | SecureString |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Optional Parameters
Indicates that the cmdlet accept key based renewal requests for the enrollment server, which are valid client certificates for authentication that do not directly map to a security principal.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Indicates that the cmdlet uses the application pool identity that the Certificate Enrollment Web Service uses when communicating with the Certification Authority (CA). This parameter is only valid when Certificate Enrollment Web Service targets a remote CA. If not specified, the local application pool identity is used. This parameter is only valid when installing the first instance of the Certificate Enrollment Web Service. If this installation will be for an additional instance of Certificate Enrollment Web Service on this server, then this parameter should not be specified.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the authentication type. The acceptable values for this parameter are:
- Certificate
- Kerberos
- UserName
Type: | AuthenticationType |
Parameter Sets: | Kerberos, UserName, Certificate |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the configuration string of the CA used by the Certificate Enrollment Web Service to process enrollment requests.
This parameter depends upon whether a local CA is installed.
If the CA is local, then the parameter is optional and defaults to the local CA when not specified.
If there is not a local CA, then the parameter is required.
The input is the configuration string is
<CAComputerName>\<CACommonName>
.
Replace the computer name of the (CA) for
<CAComputerName>
and replace the CA common name for
<CACommonName>
.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the credentials for installing the Certificate Enrollment Web Service.
To obtain a credential object, use the
Get-Credential
cmdlet.
For more information, type
Get-Help Get-Credential
.
The Certificate Enrollment Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain.
If the Certificate Enrollment Web Service is configured to use a Standalone certification authority (CA), then an account that is a member of the local Administrators on the CA is required.
If the Enrollment Web Service is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates that the cmdlet enables renewal only mode.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the hash or thumbprint of the Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for a web site as a string value. This parameter is optional. If used, it establishes the necessary binding with Internet Information Server (IIS) to enable support for the required SSL/TLS connectivity. If a binding already exists within IIS, specifying this parameter overwrites the existing binding. If this parameter is not specified, any existing binding is used. If no bindings exist, installation succeeds, but the service will not function until the binding is established manually.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
bool, bool, enum, string, bool, string, SecureString, string, PSCredential
Outputs
Microsoft.CertificateServices.Deployment.Commands.CES.EnrollmentServiceResult
Notes
-
Ensure you run Windows PowerShell as an administrator. You can use the
Force
parameter to bypass the prompt for confirmation.
To see parameters, run the following command:
Install-AdcsEnrollmentWebService cmdlet -?
-
You can get the CA configuration, which is the computer name and CA name by running certutil without any parameters. You can see the SSL certificate thumbprints assigned to the local computer by running the following commands:
-
cd cert:\LocalMachine\My
-
dir | format-list
-