Set-KdsConfiguration
Sets the configuration of Microsoft Group KdsSvc.
Syntax
KdsConfiguration
Set-KdsConfiguration
[-LocalTestOnly]
[-SecretAgreementPublicKeyLength <Int32>]
[-SecretAgreementPrivateKeyLength <Int32>]
[-SecretAgreementParameters <Byte[]>]
[-SecretAgreementAlgorithm <String>]
[-KdfParameters <Byte[]>]
[-KdfAlgorithm <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RevertToDefault
Set-KdsConfiguration
[-LocalTestOnly]
[-RevertToDefault]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject
Set-KdsConfiguration
[-InputObject] <KdsServerConfiguration>
[-LocalTestOnly]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
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.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc.
Parameter properties
| Type: | KdsServerConfiguration |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-KdfAlgorithm
Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
KdsConfiguration
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Byte[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
KdsConfiguration
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RevertToDefault
Indicates that the customized service configuration is reverted to the default configuration.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RevertToDefault
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecretAgreementAlgorithm
Specifies the name of the secret agreement algorithm used to generate a group public key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
KdsConfiguration
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Byte[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
KdsConfiguration
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-SecretAgreementPrivateKeyLength
Specifies the length of the private key used in the secret agreement algorithm.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
KdsConfiguration
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-SecretAgreementPublicKeyLength
Specifies the length of the public key used in the secret agreement algorithm.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
KdsConfiguration
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.KeyDistributionService.KdsServerConfiguration
This cmdlet returns a KdsServerConfiguration object that contains configuration information for the Microsoft Group KdsSvc.