SChannelDsc

2.0.0-preview0001

en-US/about_SChannelProtocolClient.help.txt

.NAME
    SChannelProtocolClient
 
.SYNOPSIS
    DSC Resource for managing SChannel Protocol client side settings.
 
.DESCRIPTION
    This DSC Resource manages the enabled, disabled, and default protocols for
    the client side of SCHANNEL. It inherits from SChannelProtocolBase which has
    properties for managing the protocols and a property for rebooting when required.
    The compliance part (audit via Azure Policy) of Azure AutoManage Machine Configuration
    uses the properties of this resource to check if the client side SCHANNEL protocols
    are in the desired state.
 
.EXAMPLE 1
 
 
This example shows how to enable the SSL v3.0 protocol.
 
 
Configuration Example
{
    param ()
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost
    {
        SChannelProtocolClient EnableSSLv3
        {
            IsSingleInstance = 'Yes'
            ProtocolsEnabled = 'Ssl3'
        }
    }
}
 
.EXAMPLE 2
 
 
This example shows how to disable the SSL v3.0 protocol.
 
 
Configuration Example
{
    param ()
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost
    {
        SChannelProtocolClient DisableSSLv3
        {
            IsSingleInstance = 'Yes'
            ProtocolsDisabled = 'Ssl3'
        }
    }
}
 
.EXAMPLE 3
 
 
This example shows how to reset the SSL v3.0 protocol to the OS default.
 
 
Configuration Example
{
    param ()
 
    Import-DscResource -ModuleName SChannelDsc
 
    node localhost
    {
        SChannelProtocolClient ResetSSLv3
        {
            IsSingleInstance = 'Yes'
            ProtocolsDefault = 'Ssl3'
        }
    }
}