Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-CertificateNotificationTask

New-CertificateNotificationTask

microsoft.certificateservices.pkiclient.cmdlets.dll

Synopsis

Creates a new task in the Task Scheduler that will be triggered when a certificate is replaced, expired, or about to expired.

Syntax

New-CertificateNotificationTask [-RunTaskForExistingCertificates] [-Channel] [-Name] [-PSScript] [-Type] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The New-CertificateNotificationTask cmdlet creates a new task in the Task Scheduler that will be triggered when a certificate is replaced or expires. The task will launch the script specified by the PSScript parameter.

If the RunTaskForExistingCertificates parameter is specified, then after this cmdlet is registered, the cmdlet will go through all certificates (including archived certificates) in the My store and initiate Replace events for all certificates with a Renewal property. The NewCertHash value will always be the one at the end of the renewal chain. For example; if certificate A was renewed to certificate B, which was then renewed to certificate C, then the cmdlet fires two events: certificate A to certificate C and certificate B to certificate C. This will ensure that applications that are still using old certificates are properly updated to the newest certificates. If any certificate has a renewal chain longer than 20, then the certificate is not logged.

Parameters

-Channel <NotificationChannel>

Sets the channel of the CertificateServicesClient-Notifications log that will be monitored for certificate lifecycle events. The acceptable values for this parameter are:  -- System: The Operation-System channel will be used. This channel should be used to modify system certificate bindings that use computer certificates. -- User: The Operational-User channel will be used. This channel should be used to modify user certificate bindings.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies the unique name for the certificate notification task. If a certificate notification task with the same name already exists, then an error is generated.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PSScript <String>

Identifies the Windows PowerShell® script that will be triggered by the certificate notification task. The script will be launched with the NonInteractive parameter.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RunTaskForExistingCertificates <SwitchParameter>

Generates a replacement notification for any certificate in the My store that has been replaced in the past. For the notification to be generated both certificates must be present in the store. This parameter can only be used with the Replace type. Note: The following warning will be displayed when this cmdlet is run with this parameter set to False and there are some certificates in MY store that would have resulted in a notification. -- There are certificates in My store that have been replaced in the past. You can use the New-CertificateNotification cmdlet with the RunTaskForExistingCerts parameter to generate notifications for those certificates to correct any configuration problems that you may already have on this machine.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Type <CertificateNotificationType>

Specifies the type of events that will trigger certificate notifications. The acceptable values for this parameter are:  -- Replace: Certificate replacement events will trigger this notification, including certificates that are renewed by auto-enrollment, using the Certificates snap-in, or by using the Switch-Certificate cmdlet. -- Expire: Certificate expiration and close-to-expire events will trigger this notification.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.CertificateServices.Command.CertificateNotificationTask

Notes

None

Examples

EXAMPLE 1

This example creates a system notification task for certificate replacement events with the name My System Certificate Task that will launch the myscript.ps1 script located on the C: drive. The cmdlet will run on the local system.

PS C:\>New-CertificateNotificationTask -PSScript C:\myscript.ps1 -Channel System -Type Replace -Name "My System Certificate Task"

EXAMPLE 2

This example creates a system notification task for the expiration and close-to-expiration certificate events with the name My User Certificate Task that will launch the myscript.ps1 script located on the C: drive. The cmdlet will run for all currently logged on users in the user contexts.

PS C:\>New-CertificateNotificationTask -PSScript C:\myscript.ps1 -Channel User -Type Expire -Name "My User Certificate Task"

Online Version
Get-CertificateNotificationTask
Remove-CertificateNotificationTask
Switch-Certificate