Resource Type: dsc_sqlprotocol

Defined in:

lib/puppet/type/dsc_sqlprotocol.rb

Overview

The DSC SqlProtocol resource type. Automatically generated from version 16.6.0

Properties

• dsc_enabled

  Specifies if the protocol should be enabled or disabled.

• dsc_hasmultiipaddresses

  Returns ‘$true` or `$false` whether the instance has multiple IP addresses or not.

• dsc_keepalive

  Specifies the keep alive duration in milliseconds. Only used for the TCP/IP protocol, ignored for all other protocols.

• dsc_listenonallipaddresses

  Specifies to listen on all IP addresses. Only used for the TCP/IP protocol, ignored for all other protocols.

• dsc_pipename

  Specifies the name of the named pipe. Only used for the _Named Pipes_ protocol, ignored for all other protocols.

• dsc_restarttimeout

  Timeout value for restarting the _SQL Server_ services. The default value is ‘120` seconds.

• dsc_servername

  Specifies the host name of the _SQL Server_ to be configured. If the SQL Server belongs to a cluster or availability group specify the host name for the listener or cluster group. Default value is the current computer name.

• dsc_suppressrestart

  If set to ‘$true` then the any attempt by the resource to restart the service is suppressed. The default value is `$false`.

Parameters

• dsc_instancename (namevar)

  Specifies the name of the _SQL Server_ instance to enable the protocol for.

• dsc_protocolname (namevar)

  Specifies the name of network protocol 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).