Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SqlRSSetup: Document that the properties ProductKey and Edition is mutually exclusive #1386

Closed
cosmos500 opened this issue Jul 5, 2019 · 6 comments · Fixed by #1576
Closed
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub

Comments

@cosmos500
Copy link

Details of the scenario you tried and the problem that is occurring

When i run it the script wants the edition and Product key. It does not state they are mandatory fields.

Verbose logs showing the problem

Suggested solution to the issue

The DSC configuration that is used to reproduce the issue (as detailed as possible)

# insert configuration here

SQL Server edition and version the target node is running

Sql 2016

SQL Server PowerShell modules present on the target node

5.1

The operating system the target node is running

windows server 2016

Version and build of PowerShell the target node is running

N/A

Version of the DSC module that was used ('dev' if using current dev branch)

n/a

@johlju
Copy link
Member

johlju commented Jul 5, 2019

Neither is mandatory because you can use either to install. Edition to install a free edition, and the ProductKey to install a licensed edition.

https://github.com/PowerShell/SqlServerDsc/blob/0a91a406611d7fd6ee8a6d5a571d14d39b460d98/DSCResources/MSFT_SqlRSSetup/MSFT_SqlRSSetup.psm1#L292-L304

This could be documented better, I label this issue as documentation and help wanted so that someone in the community can resolve this in the documentation.

@johlju johlju added documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community. labels Jul 5, 2019
@johlju johlju changed the title SqlRSSetup is product key and edition mandatory? SqlRSSetup: Document that the properties ProductKey and Edition is mutually exclusive Jul 5, 2019
@cosmos500
Copy link
Author

This is my code
SqlRSSetup 'InstallDefaultInstance'
{
Action = "Install"
InstanceName = 'SSRS'
IAcceptLicenseTerms = 'Yes'
SourcePath = $node.SourcePath + "\SQLServerReportingServices.exe"
PsDscRunAsCredential = $Node.InstallerServiceAccount
}

but it fails asking for Product key and version

@johlju
Copy link
Member

johlju commented Jul 5, 2019

When you compile the configuration it will not ask for additional parameters. You need to provide them in the configuration with the rest of the parameters. See the example here https://github.com/PowerShell/SqlServerDsc/blob/dev/Examples/Resources/SqlRSSetup/1-InstallReportingServices.ps1

@cosmos500
Copy link
Author

that is the same as my code except for the edition parameter. The edition parameter is not a required parameter so not sure why it is complaining

@johlju
Copy link
Member

johlju commented Jul 5, 2019

The Edition or ProductKey parameter is a mutually exclusive mandatory parameter, it is just not a mandatory parameter in the schema. The code is throwing an error saying you need to provide either Edition or ProductKey, right?

@cosmos500
Copy link
Author

Yes both

@johlju johlju added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Jun 26, 2020
johlju added a commit to johlju/SqlServerDsc that referenced this issue Jun 26, 2020
johlju added a commit that referenced this issue Jul 1, 2020
- SqlServerDsc
  - Remove the file `.github/CONTRIBUTION.md` as it no longer filled any
    purpose as GitHub will find the CONTRIBUTION.md in the root folder
    directly now (issue #1227).
  - The documentation in CONTRIBUTING.md has been somewhat updated.
  - Update documentation around design pattern for accounts that does not
    use passwords (issue #378)
    and (issue #1230).
  - Updating the Integration Test README.md to better explain what the
    integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315).
- SqlAGReplica
  - Update documentation with a requirement for SqlServer in certain circumstances
    (issue #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).
  - Updated the parameter descriptions for the parameters `Edition` and
    `ProductKey` that they are mutually exclusive (issue #1386).
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Jul 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants