SChannelDsc

1.5.0-preview0002

DSCResources/MSFT_Protocol/en-US/about_Protocol.help.txt

.NAME
    Protocol
 
.DESCRIPTION
    This resource is responsible for enabling or disabling protocols.
 
    NOTE:
    TLS 1.3 is only supported with Windows Server 2022 and later
 
.PARAMETER Protocol
    Key - String
    Allowed values: Multi-Protocol Unified Hello, PCT 1.0, SSL 2.0, SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3
    Specifies the Protocol to configure
 
.PARAMETER IncludeClientSide
    Write - Boolean
    Specifies to also include Client Side protocols (Default: False)
 
.PARAMETER State
    Write - String
    Allowed values: Enabled, Disabled, Default
    Specifies the state of the specified Protocol
 
.PARAMETER RebootWhenRequired
    Write - Boolean
    Specifies if a reboot will be performed when required (Default: False)
 
.EXAMPLE 1
 
 
This example shows how to enable the SSL v3.0 protocol.
 
 
Configuration Example
{
    param(
    )
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost {
        Protocol EnableSSLv3
        {
            Protocol = "SSL 3.0"
            State = "Enabled"
        }
    }
}
 
.EXAMPLE 2
 
 
This example shows how to disable the SSL v3.0 protocol.
 
 
Configuration Example
{
    param(
    )
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost {
        Protocol DisableSSLv3
        {
            Protocol = "SSL 3.0"
            State = "Disabled"
        }
    }
}
 
.EXAMPLE 3
 
 
This example shows how to enable the SSL v3.0 protocol,
including the client side configuration (outbound).
 
 
Configuration Example
{
    param(
    )
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost {
        Protocol EnableSSLv3
        {
            Protocol = "SSL 3.0"
            IncludeClientSide = $true
            State = "Enabled"
        }
    }
}
 
.EXAMPLE 4
 
 
This example shows how to reset the SSL v3.0 protocol to the OS default.
 
 
Configuration Example
{
    param(
    )
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost {
        Protocol DisableSSLv3
        {
            Protocol = "SSL 3.0"
            State = "Default"
        }
    }
}