This is the built-in help made by Microsoft for the command 'Add-KdsRootKey', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD).
Add-KdsRootKey [[-EffectiveTime] <DateTime>] [-LocalTestOnly [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
[<CommonParameters>]
Add-KdsRootKey [-LocalTestOnly [<SwitchParameter>]] -EffectiveImmediately [<SwitchParameter>] [-Confirm [<SwitchParameter>]] [-WhatIf
[<SwitchParameter>]] [<CommonParameters>]
The Add-KdsRootKey cmdlet generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD). The
Microsoft Group KdsSvc generates new group keys from the new root key.
<
Clear-KdsCache
Get-KdsConfiguration
Get-KdsRootKey
Set-KdsConfiguration
Test-KdsRootKey
<
Example 1: Generate a new root key
PS C:\> Add-KdsRootKey
This example generates a new root key for the Microsoft Group KdsSvc within AD.
Example 2: Generate a new root key for immediate use
PS C:\> Add-KdsRootKey -EffectiveImmediately
This example 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 example generates a new root key for the Microsoft Group KdsSvc which takes effect on the specified date 03/06/2013 using the mm/dd/yyyy
format.
Example 4: Generate a new root key on the local host only
PS C:\> Add-KdsRootKey –LocalTestOnly
This example generates a new root key on the local host only.