Add-CATemplate

Add-CATemplate

Adds a certificate template to the CA.

Syntax

Parameter Set: Default
Add-CATemplate [-Name] <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-CATemplate cmdlet adds a certificate template to the CA for issuing.

A certificate template is a preconfigured list of certificate settings that allows users and computers to enroll for certificates without having to create complex certificate requests. Certificate templates allow for the customization of a certificate that can be issued by the CA. The template defines items such as the cryptographic types, validity and renewal periods, and certificate purposes.

The certificate templates are stored in Active Directory Domain Services (AD DS). Many default certificate templates are added to AD DS when the CA role service is installed. The Add-CATemplate cmdlet does not allow you to create new templates or duplicate existing templates.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a certificate template name. This name must always be the template name (short name without spaces) and not the template display name. For example, the certificate template with the template display name of Exchange Enrollment Agent (Offline request) must be specified by its template name, which is EnrollmentAgentOffline.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    There is only one parameter for this cmdlet (Name) and it can only accept a single template each time specified by name as a string.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • To perform this procedure, you must be a member of the Domain Admins group or the Enterprise Admins group in Active Directory Domain Services (AD DS), or you must have been delegated the appropriate authority. As a security best practice, consider using Run as to perform this procedure.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Adds a CA template with the template display name Basic EFS and the template name EFS.

C:\PS>Add-CATemplate -Name EFS

Get-CATemplate

Remove-CATemplate