Set-KdsConfiguration
Set-KdsConfiguration
Sets the configuration of Microsoft Group Key Distribution Service (KdsSvc).
구문
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>]
자세한 설명
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.
매개 변수
-InputObject<KdsServerConfiguration>
Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc.
별칭 |
없음 |
필수 여부 |
true |
위치 |
1 |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByValue) |
와일드카드 문자 허용 여부 |
false |
-KdfAlgorithm<String>
Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByPropertyName) |
와일드카드 문자 허용 여부 |
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.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByPropertyName) |
와일드카드 문자 허용 여부 |
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.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
false |
와일드카드 문자 허용 여부 |
false |
-RevertToDefault
Indicates that the customized service configuration is reverted to the default configuration.
별칭 |
없음 |
필수 여부 |
true |
위치 |
named |
기본값 |
FALSE |
파이프라인 입력 적용 여부 |
false |
와일드카드 문자 허용 여부 |
false |
-SecretAgreementAlgorithm<String>
Specifies the name of the secret agreement algorithm used to generate a group public key.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByPropertyName) |
와일드카드 문자 허용 여부 |
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.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByPropertyName) |
와일드카드 문자 허용 여부 |
false |
-SecretAgreementPrivateKeyLength<Int32>
Specifies the length of the private key used in the secret agreement algorithm.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByPropertyName) |
와일드카드 문자 허용 여부 |
false |
-SecretAgreementPublicKeyLength<Int32>
Specifies the length of the public key used in the secret agreement algorithm.
별칭 |
없음 |
필수 여부 |
false |
위치 |
named |
기본값 |
없음 |
파이프라인 입력 적용 여부 |
True (ByPropertyName) |
와일드카드 문자 허용 여부 |
false |
-Confirm
cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.
필수 여부 |
false |
위치 |
named |
기본값 |
false |
파이프라인 입력 적용 여부 |
false |
와일드카드 문자 허용 여부 |
false |
-WhatIf
cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.
필수 여부 |
false |
위치 |
named |
기본값 |
false |
파이프라인 입력 적용 여부 |
false |
와일드카드 문자 허용 여부 |
false |
<CommonParameters>
이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216).
입력
입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.
Microsoft.KeyDistributionService.KdsServerConfiguration
The KdsServerConfiguration object contains configuration information for the Microsoft Group KdsSvc.
출력
출력 유형은 cmdlet이 내보내는 개체의 유형입니다.
- Microsoft.KeyDistributionService.KdsServerConfiguration
- System.Boolean
예제
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