Skip to content

Commit

Permalink
Update documentation for SqlRSSetup (issue dsccommunity#1386)
Browse files Browse the repository at this point in the history
  • Loading branch information
johlju committed Jun 26, 2020
1 parent 0bd3acf commit 89132a0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- SqlAGReplica
- Update documentation with a requirement for SqlServer in certain circumstances
([issue #1033](https://github.com/dsccommunity/SqlServerDsc/issues/1033)).
- SqlRSSetup
- There was a typo in the error message that was thrown when not passing
either the `Edition` or `ProductKey` that could be misleading ([issue #1386](https://github.com/dsccommunity/SqlServerDsc/issues/1386)).
- Updated the parameter descriptions for the parameters `Edition` and
`ProductKey` that they are mutually exclusive ([issue #1386](https://github.com/dsccommunity/SqlServerDsc/issues/1386)).

## [14.0.0] - 2020-06-12

Expand Down
4 changes: 2 additions & 2 deletions source/DSCResources/DSC_SqlRSSetup/DSC_SqlRSSetup.schema.mof
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ class DSC_SqlRSSetup : OMI_BaseResource
[Write, Description("The action to be performed. Default value is 'Install' which performs either install or upgrade."), ValueMap{"Install","Uninstall"}, Values{"Install","Uninstall"}] String Action;
[Write, EmbeddedInstance("MSFT_Credential"), Description("Credentials used to access the path set in the parameter 'SourcePath'.")] String SourceCredential;
[Write, Description("Suppresses any attempts to restart.")] Boolean SuppressRestart;
[Write, Description("Sets the custom license key, e.g. '12345-12345-12345-12345-12345'.")] String ProductKey;
[Write, Description("Sets the custom license key, e.g. '12345-12345-12345-12345-12345'. This parameter is mutually exclusive with the parameter Edition.")] String ProductKey;
[Write, Description("Forces a restart after installation is finished. If set to $true then it will override the parameter SuppressRestart.")] Boolean ForceRestart;
[Write, Description("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.")] Boolean EditionUpgrade;
[Write, Description("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.")] Boolean VersionUpgrade;
[Write, Description("Sets the custom free edition."), ValueMap{"Development","Evaluation","ExpressAdvanced"}, Values{"Development","Evaluation","ExpressAdvanced"}] String Edition;
[Write, Description("Sets the custom free edition. This parameter is mutually exclusive with the parameter ProductKey."), ValueMap{"Development","Evaluation","ExpressAdvanced"}, Values{"Development","Evaluation","ExpressAdvanced"}] String Edition;
[Write, Description("Specifies the setup log file location, e.g. 'log.txt'. By default log files are created under %TEMP%.")] String LogPath;
[Write, Description("Sets the install folder, e.g. 'C:\\Program Files\\SSRS'. Default value is 'C:\\Program Files\\Microsoft SQL Server Reporting Services'.")] String InstallFolder;
[Write, Description("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.")] UInt32 SetupProcessTimeout;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ConvertFrom-StringData @'
Restart = Restarting the target node.
SuppressRestart = Suppressing restart of target node.
EditionInvalidParameter = Both the parameters Edition and ProductKey was specified. Only either parameter Edition or ProductKey is allowed.
EditionMissingParameter = Neither the parameters Edition and ProductKey was specified.
EditionMissingParameter = Neither the parameters Edition or ProductKey was specified.
SourcePathNotFound = The source path '{0}' does not exist, or the path does not specify an executable file.
VersionFound = The Microsoft SQL Server Reporting Service instance is version '{0}'.
PackageNotFound = Could not determine the version of the Microsoft SQL Server Reporting Service instance.
Expand Down

0 comments on commit 89132a0

Please sign in to comment.