Resource Type: dsc_sqlserverconfiguration

Defined in:

lib/puppet/type/dsc_sqlserverconfiguration.rb

Providers:

powershell

Overview

The DSC SqlServerConfiguration resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerConfiguration/MSFT_SqlServerConfiguration.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 - Name of the SQL instance to be configured.

• dsc_optionname

  OptionName - The name of the SQL configuration option to be checked.

• dsc_optionvalue

  OptionValue - The desired value of the SQL configuration option.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_restartservice

  RestartService - Determines whether the instance should be restarted after updating the configuration option.

  Supported values:

  • true
  • false
• dsc_restarttimeout

  RestartTimeout - The length of time, in seconds, to wait for the service to restart. Default is 120 seconds.

• dsc_servername

  ServerName - The hostname of the SQL Server to be configured.

• name (namevar)
• provider

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