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
 

Test-KdsRootKey

Test-KdsRootKey

microsoft.keydistributionservice.cmdlets.dll

Synopsis

Tests the root key configuration.

Syntax

Test-KdsRootKey [-KeyId] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Test-KdsRootKey cmdlet tests that the root key with the specified key identifier (ID) uses a valid configuration. The test verifies generation of both new group public key and group private key.

This cmdlet is useful for analyzing failures based on invalid root key configuration failures.

Parameters

-KeyId <Guid>

Specifies the ID of the root key to test.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

System.Boolean

Notes

None

Examples

Example 1: Test the root key configuration

This example tests the configuration of the root key specified by key ID.

PS C:\>Test-KdsRootKey –KeyId "4A3615F1-5A90-22E4-0B1D-1416F93D4412"

Online Version
Add-KdsRootKey
Clear-KdsCache
Get-KdsConfiguration
Set-KdsConfiguration
Add-KdsRootKey