external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|
Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml |
KDS |
10/29/2017 |
2.0.0 |
Test-KdsRootKey |
Tests the root key configuration.
Test-KdsRootKey [-KeyId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
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.
PS C:\>Test-KdsRootKey -KeyId "4A3615F1-5A90-22E4-0B1D-1416F93D4412"
This example tests the configuration of the root key specified by key ID.
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the ID of the root key to test.
Type: Guid
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet accepts no input objects.
The Boolean object that indicates that the root key can be used to generate derived keys.