Test-KdsRootKey
Test-KdsRootKey
Tests the root key configuration.
Syntax
Parameter Set: Default
Test-KdsRootKey [-KeyId] <Guid> [-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
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.
None
This cmdlet accepts no input objects.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Boolean
The Boolean object that indicates that the root key can be used to generate derived keys.
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"