Resource Type: dsc_sqlservernetwork

Defined in:

lib/puppet/type/dsc_sqlservernetwork.rb

Providers:

powershell

Overview

The DSC SqlServerNetwork resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerNetwork/MSFT_SqlServerNetwork.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_instancename

  InstanceName - The name of the SQL instance to be configured.

• dsc_isenabled

  IsEnabled - Enables or disables the network protocol.

  Supported values:

  • true
  • false
• dsc_protocolname

  ProtocolName - The name of network protocol to be configured. Only tcp is currently supported. Valid values are Tcp.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_restartservice

  RestartService - If set to $true then SQL Server and dependent services will be restarted if a change to the configuration is made. The default value is $false.

  Supported values:

  • true
  • false
• dsc_restarttimeout

  RestartTimeout - Timeout value for restarting the SQL Server services. The default value is 120 seconds.

• dsc_servername

  ServerName - The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.

• dsc_tcpdynamicport

  TcpDynamicPort - Specifies whether the SQL Server instance should use a dynamic port. Value cannot be set to ‘True’ if TcpPort is set to a non-empty string.

  Supported values:

  • true
  • false
• dsc_tcpport

  TcpPort - The TCP port(s) that SQL Server should be listening on. If the IP address should listen on more than one port, list all ports separated with a comma (‘1433,1500,1501’). To use this parameter set TcpDynamicPorts to ‘False’.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_sqlservernetwork` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.