Edit

Share via

Test-KdsRootKey

  • Reference
Module:
KDS

Tests the root key configuration.

Syntax

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

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.

Examples

Example 1: Test the root key configuration

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

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyId

Specifies the ID of the root key to test.

Type:Guid
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

This cmdlet accepts no input objects.

Outputs

Boolean

This cmdlet returns whether the root key can be used to generate derived keys.