Resource Type: dsc_sqlprotocoltcpip

Defined in:
lib/puppet/type/dsc_sqlprotocoltcpip.rb

Overview

The DSC SqlProtocolTcpIp resource type. Automatically generated from version 16.6.0

Properties

  • dsc_addressfamily

    Returns the IP address’s adress family. Not applicable for IP address group ‘’IPAll’‘.

  • dsc_enabled

    Specified if the IP address group should be enabled or disabled. Only used if the parameter IpAddressGroup is not set to ‘’IPAll’‘. If not specified, the existing value will not be changed.

  • dsc_ipaddress

    Specifies the IP address for the IP address group. Only used if the parameter IpAddressGroup is not set to ‘’IPAll’‘. If not specified, the existing value will not be changed.

  • dsc_isactive

    Returns ‘$true` or `$false` whether the IP address group is active. Not applicable for IP address group `’IPAll’‘.

  • 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`.

  • dsc_tcpdynamicport

    Returns the TCP/IP dynamic port. Only applicable for the IP address group ‘’IPAll’‘.

  • dsc_tcpport

    Specifies the TCP port(s) that _SQL Server_ instance should be listening on. If the IP address should listen on more than one port, list all ports as a string value with the port numbers separated with a comma, e.g. ‘’1433,1500,1501’‘. This parameter is limited to 2047 characters. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter UseTcpDynamicPort.

  • dsc_usetcpdynamicport

    Specifies whether the _SQL Server_ instance should use a dynamic port. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter TcpPort.

Parameters

  • dsc_instancename (namevar)

    Specifies the name of the _SQL Server_ instance to manage the IP address group for.

  • dsc_ipaddressgroup (namevar)

    Specifies the name of the IP address group in the TCP/IP protocol, e.g. ‘’IP1’‘, `’IP2’‘ etc., or `’IPAll’‘.

  • 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).