Windows PowerShell command on Get-command Add-CertificateEnrollmentPolicyServer

NAME

Add-CertificateEnrollmentPolicyServer

SYNOPSIS

Adds an enrollment policy server to the current user or local system configuration.

SYNTAX

Add-CertificateEnrollmentPolicyServer [-AutoEnrollmentEnabled] [-Credential ] [-NoClobber]

[-RequireStrongValidation] -context {Machine | User} -Url [-Confirm] [-WhatIf] []

DESCRIPTION

The Add-CertificateEnrollmentPolicyServer cmdlet adds an enrollment policy server to the current user or local

system configuration. If an enrollment policy server already exists, then this cmdlet will overwrite it. Group Policy can be configured to prevent enrollment policy servers from being added. Delegation may be required when using this cmdlet with Windows PowerShellr remoting and changing user configuration.

PARAMETERS

-AutoEnrollmentEnabled []

Enables auto-enrollment for the policy server being added.

Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-context

Stores information about the policy server in the configuration for the Current User or Local computer. Required? true Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Credential []

Specifies the credential used to authenticate to the policy server. This credential can be a PSCredential object, which is a username and password, an x509 certificate, or a path to an x509 certificate. Kerberos authentication is used if no credential is specified. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-NoClobber []

Prevents an enrollment policy server from overwriting an existing one. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-RequireStrongValidation []

Specifies that the certificate obtained through this enrollment policy server must be trusted on the client. Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Url

Identifies the uniform resource locator (URL) of the enrollment policy server to configure. Required? true Position? named Default value none

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet.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.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 This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.CertificateServices.Commands.EnrollmentPolicyServer The EnrollmentPolicyServer object contains information about the certificate enrollment policy.

OUTPUTS

Microsoft.CertificateServices.Commands.EnrollmentPolicyServer The EnrollmentPolicyServer object contains information about the certificate enrollment policy.

EXAMPLE 1

PS C:\>Add-CertificateEnrollmentPolicyServer -Url $url -Context Machine

This example loads a policy from $url using Windows integrated authentication under the computer context, using

the computer account credentials. This example also adds the policy server to the local computer configuration. Auto enrollment is off and strong validation is off.

EXAMPLE 2

PS C:\>$cert = ( Get-ChildItem -Path cert:\LocalMachine\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF )

PS C:\>Add-CertificateEnrollmentPolicyServer -Url $cert.EnrollmentPolicyEndPoint.Url -Credential $cert -Context

Machine

This example loads a policy using $cert as the authentication credential and adds the policy to the local computer

local configuration since the context is the local computer (Machine).

EXAMPLE 3

PS C:\>$up = Get-Credential

PS C:\>Add-CertificateEnrollmentPolicyServer -Url $url -Context Machine -Credential $up

This example loads a policy using the username and password from $url. This example adds the policy server to the

local computer configuration.

EXAMPLE 4

PS C:\>$cert = (Get-ChildItem -Path cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF)

PS C:\>Add-CertificateEnrollmentPolicyServer -Url $cert.EnrollmentPolicyEndPoint.Url -Credential $cert.PSPath

-Context Machine

This example loads policy using the Path object for a certificate. Use the certificate to authenticate to the URL and add the policy server into the local user configuration.

EXAMPLE 5

PS C:\>$up = Get-Credential

PS C:\>Add-CertificateEnrollmentPolicyServer -Url $url -Context User -Credential $up -WhatIf

What if: Policy successfully loaded from {$url} using username/password credentials.

Policy server configuration will be added to current user context. This example shows that if the policy cannot be loaded or if there is a conflict with an identifier (ID) or URL, then this will be the output. If the policy server already exists, then the output will state that the existing policy server configuration will be overwritten.