PowerShell Logo Small

Set-KdsConfiguration



This is the built-in help made by Microsoft for the command 'Set-KdsConfiguration', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 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.

SYNOPSIS

Sets the configuration of Microsoft Group Key Distribution Service (KdsSvc).

SYNTAX


Set-KdsConfiguration [-InputObject] <KdsServerConfiguration> [-LocalTestOnly] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-KdsConfiguration [-KdfAlgorithm <String>] [-KdfParameters <Byte[]>] [-LocalTestOnly] [-SecretAgreementAlgorithm <String>] [-SecretAgreementParameters <Byte[]>]
[-SecretAgreementPrivateKeyLength <Int32>] [-SecretAgreementPublicKeyLength <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-KdsConfiguration [-LocalTestOnly] -RevertToDefault [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Set-KdsConfiguration cmdlet sets the configuration of Microsoft Group Key Distribution Service (KdsSvc). This cmdlet sets the following configuration data:

-- The key derivation function algorithm and parameters used to generate private group keys

-- The secret agreement algorithm and parameters used to generate public group keys.


This cmdlet also validates input by performing key derivation function tests and secret agreement tests.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?linkid=287362
Add-KdsRootKey
Clear-KdsCache
Get-KdsConfiguration
Get-KdsRootKey
Test-KdsRootKey

REMARKS

<

Examples


Example 1: Set the configuration of Microsoft Group Key Distribution Service

PS C:\> $config = Get-KdsConfiguration
PS C:\> Set-KdsConfiguration –InputObject $config



This example retrieves a server configuration object in to a variable $config using the Get-KdsConfiguration cmdlet, and passes the contents of the variable to this cmdlet.




Example 2: Test the configuration on the local server

PS C:\> Set-KdsConfiguration -LocalTestOnly



This example tests the local server configuration.




Example 3: Set the key derivation function algorithm

PS C:\> Set-KdsConfiguration –KdfAlgorithm "SHA-1"



This example sets the key derivation function (KDF) algorithm name to SHA-1. This algorithm generates a private group key.




Example 4: Set the secret agreement algorithm

PS C:\> Set-KdsConfiguration –SecretAgreementAlgorithm "ECDH"



This example sets the secret agreement algorithm name to ECDH. This algorithm generates a public group key.




Example 5: Set the Group Key Distribution Service configuration to the default configuration

PS C:\>Set-KdsConfiguration -RevertToDefault



This example validates that the customized group key distribution service configurations are deleted and the SID key starts to use the default configuration.