Skip to content

KeyExchangeAlgorithm

dscbot edited this page Mar 31, 2026 · 6 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
KeyExchangeAlgorithm Key String Specifies the Key Exchange Algorithm to configure Diffie-Hellman, ECDH, PKCS
RebootWhenRequired Write Boolean Specifies if a reboot will be performed when required (Default: False)
State Write String Specifies the state of the specified Key Exchange Algorithm Enabled, Disabled, Default

Description

This resource is responsible for enabling or disabling key exchange algorithms.

Examples

Example 1

This example shows how to enable the ECDH key exchange algorithm.

Configuration Example
{
    param ()

    Import-DscResource -ModuleName SChannelDsc

    node localhost
    {
        KeyExchangeAlgorithm EnableECDH
        {
            KeyExchangeAlgorithm = 'ECDH'
            State                = 'Enabled'
        }
    }
}

Example 2

This example shows how to disable the ECDH key exchange algorithm.

Configuration Example
{
    param ()

    Import-DscResource -ModuleName SChannelDsc

    node localhost
    {
        KeyExchangeAlgorithm DisableECDH
        {
            KeyExchangeAlgorithm = 'ECDH'
            State                = 'Disabled'
        }
    }
}

Example 3

This example shows how to reset the ECDH key exchange algorithm to the OS default.

Configuration Example
{
    param ()

    Import-DscResource -ModuleName SChannelDsc

    node localhost
    {
        KeyExchangeAlgorithm DisableECDH
        {
            KeyExchangeAlgorithm = 'ECDH'
            State                = 'Default'
        }
    }
}

Clone this wiki locally