Install-AdcsEnrollmentPolicyWebService

  • Reference
Module:
ADCSDeployment

Performs the configuration of Certificate Enrollment Policy Web Service.

Syntax

Install-AdcsEnrollmentPolicyWebService
       [-AuthenticationType <AuthenticationType>]
       [-SSLCertThumbprint <String>]
       [-KeyBasedRenewal]
       [-Force]
       [-Credential <PSCredential>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Install-AdcsEnrollmentPolicyWebService cmdlet performs the configuration of Certificate Enrollment Policy Web Service. It is also used to create and configure additional instances of the service within an existing installation. To remove the certification authority (CA) role service use the Uninstall-AdcsEnrollmentPolicyWebService cmdlet.

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

  • Import-Module ServerManager
  • Add-WindowsFeature Adcs-Enroll-Web-Pol

Examples

Example 1: Install the Certificate Enrollment Policy Web Service using Kerberos

$params = @{
    AuthenticationType = Kerberos
    SSLCertThumbprint  = "a909502dd82ae41433e6f83886b00d4277a32a7b"
}
Install-AdcsEnrollmentPolicyWebService @params

This command installs the Certificate Enrollment Policy Web Service using Kerberos for authentication. For information on obtaining a certificate thumbprint using Windows PowerShell, see Certificate Provider.

Example 2: Install the Certificate Enrollment Policy Web Service specifying a username and password

$params = @{
    AuthenticationType = Username
    SSLCertThumbprint  = "a909502dd82ae41433e6f83886b00d4277a32a7b"
}
Install-AdcsEnrollmentPolicyWebService @params

This command installs the Certificate Enrollment Policy Web Service specifying that a username and password is used for authentication.

Example 3: Install the Certificate Enrollment Policy Web Service specifying a username and password for Key-Based Renewal

$params = @{
    AuthenticationType = Username
    SSLCertThumbprint  = "a909502dd82ae41433e6f83886b00d4277a32a7b"
    KeyBasedRenewal    = $true
}
Install-AdcsEnrollmentPolicyWebService @params

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.

Parameters

-AuthenticationType

Specifies the authentication type used by the Certificate Enrollment Policy Web Service. The acceptable values for this parameter are:

  • Certificate
  • Kerberos
  • UserName
Type:AuthenticationType
Accepted values:Kerberos, UserName, Certificate
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies the credentials for installing the Enrollment Policy Web Service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential. The Enrollment Policy Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. You must use an account that is a member of Domain Admins group to install this service.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyBasedRenewal

Indicates that this cmdlet configures the Certificate Enrollment Policy Web Service to operate in key-based renewal mode. Key-based renewal allows certificate clients to renew their certificates using the key of their existing certificate for authentication. When in key-based renewal mode, the service will only return certificate templates that are set for key based renewal.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SSLCertThumbprint

Specifies the thumbprint of the certificate used by Internet Information Service (IIS) to enable support for required Secure Sockets Layer/Transport Layer Security (SSL/TLS).

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.CertificateServices.Deployment.Common.AuthenticationType

String

SwitchParameter

PSCredential

Outputs

Microsoft.CertificateServices.Deployment.Common.CEP.EnrollmentPolicyServiceResult

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-AdcsEnrollmentPolicyWebService -?

  • 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:

    • cd cert:\LocalMachine\My
    • dir | format-list