Resource Type: dsc_sqlsecureconnection

Defined in:

lib/puppet/type/dsc_sqlsecureconnection.rb

Overview

The DSC SqlSecureConnection resource type. Automatically generated from version 16.6.0

Properties

• dsc_ensure

  If encryption should be enabled (‘’Present’‘) or disabled (`’Absent’‘).

• dsc_forceencryption

  If all connections to the _SQL Server_ instance should be encrypted. If this parameter is not assigned a value, the default value is ‘$true` meaning that all connections must be encrypted.

• dsc_servername

  Specifies the host name that will be used when restarting the SQL Server instance. If the SQL Server belongs to a cluster or availability group specify the host name for the listener or cluster group. The specified name must match the name that is used by the certificate specified for the parameter ‘Thumbprint`. Default value is `localhost`.

• dsc_serviceaccount

  Name of the account running the _SQL Server_ Windows service. If this parameter is set to ‘’LocalSystem’‘ then a connection error is displayed, instead use the value `’SYSTEM’‘.

• dsc_suppressrestart

  If set to ‘$true` then the required restart will be suppressed. You will need to restart the service before changes will take effect. The default value is `$false`.

• dsc_thumbprint

  Thumbprint of the certificate being used for encryption. If parameter Ensure is set to ‘’Absent’‘ then the parameter Certificate can be set to an empty string.

Parameters

• dsc_instancename (namevar)

  Name of the _SQL Server_ instance to be configured.

• dsc_psdscrunascredential
• dsc_timeout

  The maximum time in seconds to wait for the DSC resource to complete.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).