Site icon TOSS

Install-AdcsEnrollmentWebService

powershell

Install-AdcsEnrollmentWebService is accessible with the help of ADCSDeployment module. To install ADCSDeployment on your system please refer to this link.

Synopsis
Performs initial configuration of the Certificate Enrollment Web service.

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

Parameters

-AllowKeyBasedRenewal 
         Specifies that the enrollment server accept key based renewal requests, which are valid client certificate for authentication that do not directly map to a security principal.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-ApplicationPoolIdentity <SwitchParameter>
    Specifies the identity that the Certificate Enrollment Web Service will use when communicating with the Certification Authority (CA). This parameter is only valid when Certificate Enrollment Web Service will be targeting 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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-AuthenticationType <AuthenticationType>
    Specifies the authentication type. Valid options include: Certificate, Kerberos, and UserName.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-CAConfig <String>
    Specifies the configuration string of the Certification Authority (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>.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-Credential <PSCredential>
    Specifies the credentials for installing the Certificate Enrollment Web Service. 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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-Force <SwitchParameter>


    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RenewalOnly <SwitchParameter>
    Specifies that renewal only mode be enabled.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-SSLCertThumbprint <String>
    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 will establish 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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-ServiceAccountName <String>
    Specifies the domain account for use with the service. The input string should be in the form of <domain>\<accountname>. For example, to specify an account named WebEnroll in the Corp.contoso.com domain, you would type CORP\WebEnroll.

    Required?                    true
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-ServiceAccountPassword <SecureString>
    Specifies the password for the domain account used as the service account.

    Required?                    true
    Position?                    named
    Default value                
    Accept pipeline input?       true (ByPropertyName)
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

Syntax

Install-AdcsEnrollmentWebService [-AllowKeyBasedRenewal ] [-ApplicationPoolIdentity ] [-AuthenticationType ] [-CAConfig ] [-Credential ] [-Force ] [-RenewalOnly ] [-SSLCertThumbprint ] [-Confirm ] [-WhatIf ] []

Install-AdcsEnrollmentWebService [-AllowKeyBasedRenewal ] [-AuthenticationType <AuthenticationType>] [-CAConfig <String>] [-Credential <PSCredential>] [-Force ] [-RenewalOnly ] [-SSLCertThumbprint <String>] -ServiceAccountName <String> -ServiceAccountPassword <SecureString> [-Confirm ] [-WhatIf ] [<CommonParameters>]

Notes
Ensure you run Windows PowerShell as an administrator. You can use the -force switch to bypass the prompt for confirmation.
To see parameters, run the following command: install-AdcsEnrollmentWebService cmdlet -?

————————– EXAMPLE 1 ————————–
C:\PS>Install-AdcsEnrollmentWebService –ApplicationPoolIdentity -CAConfig CA.TOSSolution.com\toss-CA -SSLCertThumbprint -AuthenticationType Certificate
This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of CA.TOSSolution.com and a CA common name toss-CA. The identity of the Certificate Enrollment Web Service is specified as the default application pool identity. The placeholder should be replaced with the actual thumbprint of the certificate associated with the service. The authentication type is certificate based.

————————– EXAMPLE 2 ————————–
C:\PS>Install-AdcsEnrollmentWebService -CAConfig life.general.TOSSolution.com\general-life-CA -SSLCertThumbprint -ServiceAccountName general\server1 -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 life.general.TOSSolution.com and a CA common name genearl-life-CA. The placeholder should be replaced with the actual thumbprint of the certificate associated with the service. The identity of the Certificate Enrollment Web Service is specified as server1 from the Corp domain. The command will prompt for the user password.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Install-AdcsEnrollmentWebService

You can also read about
Uninstall-AdcsEnrollmentWebService

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft

Exit mobile version