Edit

Share via

Install-AdcsEnrollmentPolicyWebService

Module:
ADCSDeployment Module

Performs the configuration of Certificate Enrollment Policy Web Service.

Syntax

Default (Default) 

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

Parameter properties

Type:AuthenticationType
Default value:None
Accepted values:Kerberos, UserName, Certificate
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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).

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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