Resource Type: dsc_sqlsetup

Defined in:

lib/puppet/type/dsc_sqlsetup.rb

Providers:

powershell

Overview

The DSC SqlSetup resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlSetup/MSFT_SqlSetup.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_action

  Action - The action to be performed. Default value is ‘Install’. Valid values are Install, InstallFailoverCluster, AddNode, PrepareFailoverCluster, CompleteFailoverCluster.

• dsc_agtsvcaccount

  AgtSvcAccount - Service account for the SQL Agent service.

• dsc_agtsvcaccountusername

  AgtSvcAccountUsername - Output username for the SQL Agent service.

• dsc_asbackupdir

  ASBackupDir - Path for Analysis Services backup files.

• dsc_ascollation

  ASCollation - Collation for Analysis Services.

• dsc_asconfigdir

  ASConfigDir - Path for Analysis Services config.

• dsc_asdatadir

  ASDataDir - Path for Analysis Services data files.

• dsc_aslogdir

  ASLogDir - Path for Analysis Services log files.

• dsc_asservermode

  ASServerMode - The server mode for SQL Server Analysis Services instance. The default is to install in Multidimensional mode. Valid values in a cluster scenario are MULTIDIMENSIONAL or TABULAR. Parameter ASServerMode is case-sensitive. All values must be expressed in upper case. Valid values are MULTIDIMENSIONAL, TABULAR, POWERPIVOT.

• dsc_assvcaccount

  ASSvcAccount - Service account for Analysis Services service.

• dsc_assvcaccountusername

  ASSvcAccountUsername - Output username for the Analysis Services service.

• dsc_assysadminaccounts

  ASSysAdminAccounts - Array of accounts to be made Analysis Services admins.

• dsc_astempdir

  ASTempDir - Path for Analysis Services temp files.

• dsc_browsersvcstartuptype

  BrowserSvcStartupType - Specifies the startup mode for SQL Server Browser service. Valid values are Automatic, Disabled, Manual.

• dsc_errorreporting

  ErrorReporting - Enable error reporting.

• dsc_failoverclustergroupname

  FailoverClusterGroupName - The name of the resource group to create for the clustered SQL Server instance. Default is ‘SQL Server (InstanceName)’.

• dsc_failoverclusteripaddress

  FailoverClusterIPAddress - Array of IP Addresses to be assigned to the clustered SQL Server instance.

• dsc_failoverclusternetworkname

  FailoverClusterNetworkName - Host name to be assigned to the clustered SQL Server instance.

• dsc_features

  Features - SQL features to be installed.

• dsc_forcereboot

  ForceReboot - Forces reboot.

  Supported values:

  • true
  • false
• dsc_ftsvcaccount

  FTSvcAccount - Service account for the Full Text service.

• dsc_ftsvcaccountusername

  FTSvcAccountUsername - Output username for the Full Text service.

• dsc_installshareddir

  InstallSharedDir - Installation path for shared SQL files.

• dsc_installsharedwowdir

  InstallSharedWOWDir - Installation path for x86 shared SQL files.

• dsc_installsqldatadir

  InstallSQLDataDir - Root path for SQL database files.

• dsc_instancedir

  InstanceDir - Installation path for SQL instance files.

• dsc_instanceid

  InstanceID - SQL instance ID, if different from InstanceName.

• dsc_instancename

  InstanceName - Name of the SQL instance to be installed.

• dsc_issvcaccount

  ISSvcAccount - Service account for Integration Services service.

• dsc_issvcaccountusername

  ISSvcAccountUsername - Output username for the Integration Services service.

• dsc_productkey

  ProductKey - Product key for licensed installations.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_rssvcaccount

  RSSvcAccount - Service account for Reporting Services service.

• dsc_rssvcaccountusername

  RSSvcAccountUsername - Output username for the Reporting Services service.

• dsc_sapwd

  SAPwd - SA password, if SecurityMode is set to ‘SQL’.

• dsc_securitymode

  SecurityMode - Security mode to apply to the SQL Server instance. ‘SQL’ indicates mixed-mode authentication while ‘Windows’ indicates Windows authentication. Default is Windows. Valid values are SQL, Windows.

• dsc_setupprocesstimeout

  SetupProcessTimeout - The timeout, in seconds, to wait for the setup process to finish. Default value is 7200 seconds (2 hours). If the setup process does not finish before this time, and error will be thrown.

• dsc_sourcecredential

  SourceCredential - Credentials used to access the path set in the parameter ‘SourcePath’.

• dsc_sourcepath

  SourcePath - The path to the root of the source files for installation. I.e and UNC path to a shared resource. Environment variables can be used in the path.

• dsc_sqlbackupdir

  SQLBackupDir - Path for SQL backup files.

• dsc_sqlcollation

  SQLCollation - Collation for SQL.

• dsc_sqlsvcaccount

  SQLSvcAccount - Service account for the SQL service.

• dsc_sqlsvcaccountusername

  SQLSvcAccountUsername - Output username for the SQL service.

• dsc_sqlsysadminaccounts

  SQLSysAdminAccounts - Array of accounts to be made SQL administrators.

• dsc_sqltempdbdir

  SQLTempDBDir - Path for SQL TempDB files.

• dsc_sqltempdblogdir

  SQLTempDBLogDir - Path for SQL TempDB log files.

• dsc_sqluserdbdir

  SQLUserDBDir - Path for SQL database files.

• dsc_sqluserdblogdir

  SQLUserDBLogDir - Path for SQL log files.

• dsc_sqmreporting

  SQMReporting - Enable customer experience reporting.

• dsc_suppressreboot

  SuppressReboot - Suppresses reboot.

  Supported values:

  • true
  • false
• dsc_updateenabled

  UpdateEnabled - Enabled updates during installation.

• dsc_updatesource

  UpdateSource - Path to the source of updates to be applied during installation.

• name (namevar)
• provider

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