Skip to content

Commit 8a642a8

Browse files
committed
Fix comment-based help
1 parent 2f92aaa commit 8a642a8

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

source/Classes/020.SqlRSSetup.ps1

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,49 @@
88
SQL Server Reporting Services (SSRS) or Power BI Report Server (PBIRS).
99
1010
The built-in parameter **PSDscRunAsCredential** can be used to run the resource
11-
as another user. The resource will then install as that user.
11+
as another user. The resource will then install as that user, otherwise
12+
install as SYSTEM.
13+
14+
>[!TIP]
15+
>To install Microsoft SQL Server Reporting Services 2016 (or older),
16+
>please use the resource SqlSetup instead.
17+
18+
> [!IMPORTANT]
19+
> When using the action 'Uninstall' and the target node to begin with
20+
> requires a restart, on the first run the Microsoft SQL Server Reporting
21+
> Services instance will not be uninstalled, but instead exits with code
22+
> 3010 and the node will be, by default, restarted. On the second run after
23+
> restart, the Microsoft SQL Server Reporting Services instance will be
24+
> uninstalled. If the parameter SuppressRestart is used, then the node must
25+
> be restarted manually before the Microsoft SQL Server Reporting Services
26+
> instance will be successfully uninstalled.
27+
>
28+
> The Microsoft SQL Server Reporting Services log will indicate that a
29+
> restart is required by outputting; "*No action was taken as a system
30+
> reboot is required (0x8007015E)*". The log is default located in the
31+
> SSRS folder in `%TEMP%`, e.g. `C:\Users\<user>\AppData\Local\Temp\SSRS`.
32+
1233
1334
## Requirements
1435
1536
* Target machine must be running Windows Server 2012 or later.
1637
* Target machine must have access to the SQL Server Reporting Services or
1738
Power BI Report Server installation media.
39+
* SYSTEM account or the users passed in the credentials for the `PsDscRunAsCredential`
40+
common parameter must have permissions to connect to the location
41+
where the _Microsoft SQL Server Reporting Services_ or _Microsoft Power_
42+
_BI Report Server_ media is placed.
43+
* The parameter `AcceptLicensingTerms` must be set to `$true`.
44+
* The parameter `InstanceName` can only be set to `SSRS` or `PBIRS` since there
45+
is no way to change the instance name.
1846
1947
## Known issues
2048
49+
* When using action 'Uninstall', the same version of the executable as the
50+
version of the installed product must be used. If not, sometimes the uninstall
51+
is successful (because the executable returns exit code 0) but the instance
52+
was not actually removed.
53+
2154
All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlRSSetup).
2255
2356
.PARAMETER InstanceName

0 commit comments

Comments
 (0)