Document rds environment

I manage a RDS remote app environment and wanted to have a way to document this automatically. This way it’s easy to create up-to-date information on all remote apps and also on the servers in the environment, connection broker settings, gateway configuration, collection summary, roles and servers etc.

Based upon Carl Webster’s VMWare documentation script, I decided to create this script.

The script allows for 3 different export types, HTML, Word, PDF. It will document all RDS related settings, like: Gateway configuration, Connection Broker information, Collection information, Roles and services and a list of all (published) applications. It will generate an export like this:

If you use word or PDF as export type, you can also select a cover page, so a report will look a lot nicer (but will also take a lot longer), but you do need MS Word installed on the system you’re running the script on. It might look like this

You can see more examples (html, word and pdf) here (zip file).

If you want to download the script, that can be found here.

If you like this blog post and want to support me so I can create and share more scripts, please consider donating to me through PayPal.

2 thoughts on “Document rds environment

  1. I’m running the script and getting this error below. I don’t see any notes for a path stipulation (unless I’m blind), Where is this path that it empty ? The values are generic in the error, I’ve removed the actual values used. Any help would be apricated. Thank you
    PS C:\temp> .\DocumentRDSInfo.ps1 -CN “Company Name” -CP “Mod” -UN “Some Name” -CB -Folder \\serser\share
    Test-Path : Cannot bind argument to parameter ‘Path’ because it is an empty string.
    At C:\temp\DocumentRDSInfo.ps1:3083 char:16
    + If(Test-Path “$($Script:FileName1)”)
    + ~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : InvalidData: (:) [Test-Path], ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationErrorEmptyStringNotAllowed,Microsoft.PowerShell.Commands.TestP


    1. Probably your setting at the folder switch isn’t correct or reachable (maybe you started the script as admin and this account doesn’t have access to this share? Maybe a typo in the location?). If you run the script with -Verbose swtich and your settings, it should show script options when you start the script and there it should specify 2 lines:
      Filename1 :
      Folder :
      Those should show the setting you’ve given when running the script. If still saving to the network location doesn’t work, maybe omit the folder option and check if it can save the document to the current directory?


Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s