]
Set-KdsConfiguration [-KdfAlgorithm ] [-KdfParameters ] [-LocalTestOnly]
[-SecretAgreementAlgorithm ] [-SecretAgreementParameters ] [-SecretAgreementPrivateKeyLength
] [-SecretAgreementPublicKeyLength ] [-Confirm] [-WhatIf] []
Set-KdsConfiguration [-LocalTestOnly] -RevertToDefault [-Confirm] [-WhatIf] []
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.
PARAMETERS
-InputObject
Specifies the server configuration object that contains the configuration information of the Microsoft Group
KdsSvc.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-KdfAlgorithm []
Specifies the name of the key derivation function algorithm that the key distribution server uses to generate
the keys.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-KdfParameters []
Specifies the parameters for the key derivation function used to generate the group private key. If this
parameter is not specified or this parameter is set to $Null, then no key derivation function parameters are
needed.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LocalTestOnly []
Indicates that the cmdlet only validates the new group key distribution service configuration on the local
computer, and does not store the key in Active Directory.
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 new server configuration object.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RevertToDefault
Indicates that the customized service configuration is reverted to the default configuration.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SecretAgreementAlgorithm []
Specifies the name of the secret agreement algorithm used to generate a group public key.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SecretAgreementParameters []
Specifies the parameters for the secret agreement algorithm. If this parameter is not specified or this
parameter is set to $Null, then no secret agreement algorithm parameters are needed.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SecretAgreementPrivateKeyLength []
Specifies the length of the private key used in the secret agreement algorithm.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SecretAgreementPublicKeyLength []
Specifies the length of the public key used in the secret agreement algorithm.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm []
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf []
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.KeyDistributionService.KdsServerConfiguration
This cmdlet returns a KdsServerConfiguration object that contains configuration information for the Microsoft
Group KdsSvc.
OUTPUTS
Microsoft.KeyDistributionService.KdsServerConfiguration
System.Boolean
Example 1: Set the configuration of Microsoft Group Key Distribution Service
PS C:\> $config = Get-KdsConfiguration
PS C:\> Set-KdsConfiguration -InputObject $config
This command 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 command tests the local server configuration.
Example 3: Set the key derivation function algorithm
PS C:\> Set-KdsConfiguration -KdfAlgorithm "SHA-1"
This command 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 command 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 command validates that the customized group key distribution service configurations are deleted and the SID
key starts to use the default configuration.
RELATED LINKS
Add-KdsRootKey
Clear-KdsCache
Get-KdsConfiguration
Get-KdsRootKey
Test-KdsRootKey