Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-KdsRootKey

Add-KdsRootKey

microsoft.keydistributionservice.cmdlets.dll

Synopsis

Generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD).

Syntax

Add-KdsRootKey [-EffectiveTime] [-LocalTestOnly] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-KdsRootKey [-LocalTestOnly] [-EffectiveImmediately] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

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.

Parameters

-EffectiveImmediately <SwitchParameter>

Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EffectiveTime <DateTime>

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.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-LocalTestOnly <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

System.Boolean
System.Guid

Notes

None

Examples

Example 1: Generate a new root key

This example generates a new root key for the Microsoft Group KdsSvc within AD.

PS C:\>Add-KdsRootKey

Example 2: Generate a new root key for immediate use

This example generates a new root key immediately and adds it to the Microsoft Group KdsSvc.

PS C:\>Add-KdsRootKey -EffectiveImmediately

Example 3: Generate a new root key which takes effect on a specific date

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.

PS C:\>Add-KdsRootKey –EffectiveTime "03/06/2013"

Example 4: Generate a new root key on the local host only

This example generates a new root key on the local host only.

PS C:\>Add-KdsRootKey –LocalTestOnly

Online Version
Clear-KdsCache
Get-KdsConfiguration
Get-KdsRootKey
Set-KdsConfiguration
Test-KdsRootKey