Set-KdsConfiguration
Set-KdsConfiguration
Sets the configuration of Microsoft Group Key Distribution Service (KdsSvc).
Sintaxis
Parameter Set: InputObject
Set-KdsConfiguration [-InputObject] <KdsServerConfiguration> [-LocalTestOnly] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: KdsConfiguration
Set-KdsConfiguration [-KdfAlgorithm <String> ] [-KdfParameters <Byte[]> ] [-LocalTestOnly] [-SecretAgreementAlgorithm <String> ] [-SecretAgreementParameters <Byte[]> ] [-SecretAgreementPrivateKeyLength <Int32> ] [-SecretAgreementPublicKeyLength <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RevertToDefault
Set-KdsConfiguration -RevertToDefault [-LocalTestOnly] [-Confirm] [-WhatIf] [ <CommonParameters>]
Descripción detallada
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.
Parámetros
-InputObject<KdsServerConfiguration>
Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
1 |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByValue) |
¿Aceptar caracteres comodín? |
false |
-KdfAlgorithm<String>
Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-KdfParameters<Byte[]>
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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
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 (AD).
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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-RevertToDefault
Indicates that the customized service configuration is reverted to the default configuration.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
FALSE |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-SecretAgreementAlgorithm<String>
Specifies the name of the secret agreement algorithm used to generate a group public key.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-SecretAgreementParameters<Byte[]>
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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-SecretAgreementPrivateKeyLength<Int32>
Specifies the length of the private key used in the secret agreement algorithm.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-SecretAgreementPublicKeyLength<Int32>
Specifies the length of the public key used in the secret agreement algorithm.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el cmdlet.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
Microsoft.KeyDistributionService.KdsServerConfiguration
The KdsServerConfiguration object contains configuration information for the Microsoft Group KdsSvc.
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
- Microsoft.KeyDistributionService.KdsServerConfiguration
- System.Boolean
Ejemplos
Example 1: Set the configuration of Microsoft Group Key Distribution Service
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.
PS C:\> $config = Get-KdsConfiguration
PS C:\> Set-KdsConfiguration –InputObject $config
Example 2: Test the configuration on the local server
This example tests the local server configuration.
PS C:\> Set-KdsConfiguration -LocalTestOnly
Example 3: Set the key derivation function algorithm
This example sets the key derivation function (KDF) algorithm name to SHA-1. This algorithm generates a private group key.
PS C:\> Set-KdsConfiguration –KdfAlgorithm "SHA-1"
Example 4: Set the secret agreement algorithm
This example sets the secret agreement algorithm name to ECDH. This algorithm generates a public group key.
PS C:\> Set-KdsConfiguration –SecretAgreementAlgorithm "ECDH"
Example 5: Set the Group Key Distribution Service configuration to the default configuration
This example validates that the customized group key distribution service configurations are deleted and the SID key starts to use the default configuration.
PS C:\> Set-KdsConfiguration -RevertToDefault