Add-Kds
Root
Key
Syntax
Add-KdsRootKey
[-LocalTestOnly]
[[-EffectiveTime] <DateTime>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-KdsRootKey
[-LocalTestOnly]
[-EffectiveImmediately]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Add-KdsRootKey cmdlet generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory. The Microsoft Group KdsSvc generates new group keys from the new root key.
Examples
Example 1: Generate a new root key
PS C:\> Add-KdsRootKey
This command generates a new root key for the Microsoft Group KdsSvc within Active Directory.
Example 2: Generate a new root key for immediate use
PS C:\> Add-KdsRootKey -EffectiveImmediately
This command generates a new root key immediately and adds it to the Microsoft Group KdsSvc.
Example 3: Generate a new root key which takes effect on a specific date
PS C:\> Add-KdsRootKey -EffectiveTime 03/06/2013
This command generates a new root key for the Microsoft Group KdsSvc which takes effect on the date 03/06/2013. Use the mm/dd/yyyy format.
Example 4: Generate a new root key on the local host only
PS C:\> Add-KdsRootKey -LocalTestOnly
This command generates a new root key on the local host only.
Required Parameters
Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Optional Parameters
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the date on which the newly generated root key takes effect. If this parameter is not specified, the default date set is 10 days after the current date.
Type: | DateTime |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Indicates that the new root key is generated on the local host only. This parameter is used with the Set-KdsConfiguration cmdlet to test the local server configuration.
If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed.
If this parameter is not specified, then the cmdlet returns the identifier (ID) of the root key when the operation succeeds.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
This cmdlet accepts no input objects.
Outputs
System.Boolean
Outputs
System.Guid