Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Add-KdsRootKey

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Generates a new root key for the Microsoft Group KdsSvc within Active Directory.

SYNTAX

EffectiveTime (Default)

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

EffectiveImmediately

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.

PARAMETERS

-Confirm

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

-EffectiveImmediately

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

Type: SwitchParameter
Parameter Sets: EffectiveImmediately
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EffectiveTime

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
Parameter Sets: EffectiveTime
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

This cmdlet accepts no input objects.

OUTPUTS

System.Boolean

System.Guid

NOTES

Clear-KdsCache

Get-KdsConfiguration

Get-KdsRootKey

Set-KdsConfiguration

Test-KdsRootKey

© 2017 Microsoft