Resource Type: dsc_sqlrssetup
- Defined in:
- lib/puppet/type/dsc_sqlrssetup.rb
Overview
The DSC SqlRSSetup resource type. Automatically generated from version 16.6.0
Properties
-
dsc_action
The action to be performed. Default value is ‘’Install’‘ which performs either install or upgrade.
-
dsc_currentversion
Returns the current version of the installed _Microsoft SQL Server Reporting Service_ instance.
-
dsc_edition
Sets the custom free edition. This parameter is mutually exclusive with the parameter ProductKey.
-
dsc_editionupgrade
Upgrades the edition of the installed product. Requires that either the ProductKey or the Edition parameter is also assigned. By default no edition upgrade is performed.
-
dsc_errordumpdirectory
Returns the path to error dump log files.
-
dsc_forcerestart
Forces a restart after installation is finished. If set to ‘$true` then it will override the parameter SuppressRestart.
-
dsc_iacceptlicenseterms
Accept licens terms. This must be set to ‘’Yes’‘.
-
dsc_installfolder
Sets the install folder, e.g. ‘C:Program FilesSSRS`. Default value is `C:Program FilesMicrosoft SQL Server Reporting Services`.
-
dsc_logpath
Specifies the setup log file location, e.g. ‘log.txt`. By default log files are created under `%TEMP%`.
-
dsc_productkey
Sets the custom license key, e.g. ‘’12345-12345-12345-12345-12345’‘. This parameter is mutually exclusive with the parameter Edition.
-
dsc_servicename
Returns the current name of the _Microsoft SQL Server Reporting Service_ instance Windows service.
-
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_sourcepath
The path to the installation media file to be used for installation, e.g an UNC path to a shared resource. Environment variables can be used in the path.
-
dsc_suppressrestart
Suppresses any attempts to restart.
-
dsc_versionupgrade
Upgrades installed product version if the major product version of the source executable is higher than the currently installed major version. Requires that either the ProductKey or the Edition parameter is also assigned. Default is ‘$false`.
Parameters
-
dsc_instancename (namevar)
Name of the _Microsoft SQL Server Reporting Service_ instance to installed. This can only be set to ‘’SSRS’‘.
-
dsc_psdscrunascredential
-
dsc_sourcecredential
Credentials used to access the path set in the parameter SourcePath.
-
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).