Resource Type: dsc_sqlsetup

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

Overview

The DSC SqlSetup resource type. Automatically generated from version 16.6.0

Properties

dsc_action

The action to be performed. Default value is ‘’Install’‘.
dsc_agtsvcaccountusername

Returns the username for the _SQL Agent_’s Windows service.
dsc_agtsvcstartuptype

Specifies the startup mode for the _SQL Server Agent_’s Windows service.
dsc_asbackupdir

Path for _Analysis Services_’s backup files.
dsc_ascollation

Collation for the _SQL Server Analysis Services_.
dsc_asconfigdir

Path for _Analysis Services_’s config files.
dsc_asdatadir

Path for _Analysis Services_’s data files.
dsc_aslogdir

Path for _Analysis Services_’s log files.
dsc_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**.
dsc_assvcaccountusername

Returns the username for the _SQL Server Analysis Services_’s Windows service.
dsc_assvcstartuptype

Specifies the startup mode for the _SQL Server Analysis Services_’s Windows service.
dsc_assysadminaccounts

Array of accounts to be made _Analysis Services_ admins.
dsc_astempdir

Path for _Analysis Services_’s temp files.
dsc_browsersvcstartuptype

Specifies the startup mode for _SQL Server Browser_’s Windows service.
dsc_errorreporting

Enable error reporting.
dsc_failoverclustergroupname

The name of the resource group to create for the clustered _SQL Server_ instance. Default is ‘’SQL Server (InstanceName)‘`.
dsc_failoverclusteripaddress

Specifies an array of IP addresses to be assigned to the clustered _SQL Server_ instance. IP addresses must be in [dotted-decimal notation](en.wikipedia.org/wiki/Dot-decimal_notation), for example ‘’10.0.0.100’‘. If no IP address is specified, uses `’DEFAULT’‘ for this setup parameter.
dsc_failoverclusternetworkname

Host name to be assigned to the clustered _SQL Server_ instance.
dsc_featureflag

Feature flags are used to toggle DSC resource functionality on or off. See the DSC resource documentation for what additional functionality exist through a feature flag.
dsc_features

_SQL Server_ features to be installed.
dsc_forcereboot

Forces reboot.
dsc_ftsvcaccountusername

Returns the username for the _Full Text_’ Windows service.
dsc_installshareddir

Installation path for shared _SQL Server_ files.
dsc_installsharedwowdir

Installation path for x86 shared _SQL Server_ files.
dsc_installsqldatadir

Root path for _SQL Server_ database files.
dsc_instancedir

Installation path for _SQL Server_ instance files.
dsc_instanceid

_SQL Server_ instance ID (if different from parameter InstanceName).
dsc_isclustered

Returns a boolean value of ‘$true` if the instance is clustered, otherwise it returns `$false`.
dsc_issvcaccountusername

Returns the username for the _Integration Services_’s Windows service.
dsc_issvcstartuptype

Specifies the startup mode for the _SQL Server Integration Services_’s Windows service.
dsc_npenabled

Specifies the state of the _Named Pipes_ protocol for the _SQL Server_ service. The value ‘$true` will enable the _Named Pipes_ protocol and `$false` will disabled it.
dsc_productkey

Product key for licensed installations.
dsc_rsinstallmode

Specifies the install mode for _SQL Server Report Services_ service.
dsc_rssvcaccountusername

Returns the username for the _Reporting Services_’s Windows service.
dsc_rssvcstartuptype

Specifies the startup mode for the _SQL Server Reporting Services_’s Windows service.
dsc_securitymode

Security mode to apply to the _SQL Server_ instance. The value ‘’SQL’‘ indicates mixed-mode authentication while the value `’Windows’‘ indicates _Windows Authentication_. Default value is `’Windows’‘.
dsc_servername

Specifies the host or network name of the _SQL Server_ instance. If the SQL Server belongs to a cluster or availability group it could be set to the host name for the listener or cluster group. If using a secure connection the specified value should be the same name that is used in the certificate. Default value is the current computer name.
dsc_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, an error will be thrown.
dsc_skiprule

Specifies optional skip rules during setup.
dsc_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

Path for _SQL Server_ backup files.
dsc_sqlcollation

Collation for _SQL Server Database Engine_.
dsc_sqlsvcaccountusername

Returns the username for the _SQL Server_’s Windows service.
dsc_sqlsvcstartuptype

Specifies the startup mode for the _SQL Server Database Engine_’s Windows service.
dsc_sqlsysadminaccounts

An array of accounts to be made _SQL Server_ administrators.
dsc_sqltempdbdir

Path for _SQL Server_ temporary database data files.
dsc_sqltempdbfilecount

Specifies the number of temporary database data files to be added by setup.
dsc_sqltempdbfilegrowth

Specifies the file growth increment of each temporary database data file in MB.
dsc_sqltempdbfilesize

Specifies the initial size of each temporary database data file in MB.
dsc_sqltempdblogdir

Path for _SQL Server_ temporary database log files.
dsc_sqltempdblogfilegrowth

Specifies the file growth increment of each temporary database data file in MB.
dsc_sqltempdblogfilesize

Specifies the initial size of each temporary database log file in MB.
dsc_sqluserdbdir

Path for _SQL Server_ database files.
dsc_sqluserdblogdir

Path for _SQL Server_ log files.
dsc_sqlversion

Specifies the SQL Server version that should be installed. Only the major version will be used, but the provided value must be set to at least major and minor version (e.g. ‘14.0`). When providing this parameter the media will not be used to evaluate version. Although, if the setup action is `Upgrade` then setting this parameter will throw an exception as the version from the install media is required.
dsc_sqmreporting

Enable customer experience reporting.
dsc_suppressreboot

Suppresses reboot.
dsc_tcpenabled

Specifies the state of the TCP protocol for the _SQL Server_ service. The value ‘$true` will enable the TCP protocol and `$false` will disabled it.
dsc_updateenabled

Enabled updates during installation.
dsc_updatesource

Path to the source of updates to be applied during installation.
dsc_useenglish

Specifies to install the English version of _SQL Server_ on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system.

Parameters

dsc_agtsvcaccount

Service account for the _SQL Agent_’s Windows service.
dsc_assvcaccount

Service account for _Analysis Services_’s Windows service.
dsc_ftsvcaccount

Service account for the _Full Text_’s Windows service.
dsc_instancename (namevar)

Specifies the name of the instance to be installed.
dsc_issvcaccount

Service account for _Integration Services_’s Windows service.
dsc_psdscrunascredential
dsc_rssvcaccount

Service account for _Reporting Services_’s Windows service.
dsc_sapwd

Specifies the SA account’s password. Only applicable if parameter SecurityMode is set to ‘’SQL’‘.
dsc_sourcecredential

Credentials used to access the path set in the parameter SourcePath. See section [Considerations](#considerations) regarding the parameter SourceCredential.
dsc_sqlsvcaccount

Service account for the _SQL Server_’s Windows service.
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).