SChannelDsc

1.4.0

DSCResources/MSFT_KeyExchangeAlgorithm/en-US/about_KeyExchangeAlgorithm.help.txt

.NAME
    KeyExchangeAlgorithm
 
.DESCRIPTION
    This resource is responsible for enabling or disabling key exchange algorithms.
 
.PARAMETER KeyExchangeAlgorithm
    Key - String
    Allowed values: Diffie-Hellman, ECDH, PKCS
    Specifies the Key Exchange Algorithm to configure
 
.PARAMETER State
    Write - String
    Allowed values: Enabled, Disabled, Default
    Specifies the state of the specified Key Exchange Algorithm
 
.PARAMETER RebootWhenRequired
    Write - Boolean
    Specifies if a reboot will be performed when required (Default: False)
 
.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"
        }
    }
}