Add-KdsRootKey

Add-KdsRootKey

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

構文

Parameter Set: EffectiveTime
Add-KdsRootKey [[-EffectiveTime] <DateTime> ] [-LocalTestOnly] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: EffectiveImmediately
Add-KdsRootKey -EffectiveImmediately [-LocalTestOnly] [-Confirm] [-WhatIf] [ <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.

パラメーター

-EffectiveImmediately

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

-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.

-LocalTestOnly

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.

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

• None

  This cmdlet accepts no input objects.

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• System.Boolean
• System.Guid

例

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

関連トピック

Clear-KdsCache

Get-KdsConfiguration

Get-KdsRootKey

Set-KdsConfiguration

Test-KdsRootKey