Using PowerShell for generating dynamic folders in Royal TS
Royal TS is a powerful tool for managing remote systems using many different protocols such as Remote Desktop (RDP), PowerShell, SSH, HTTPS, and many more. In this article we will look at a new feature introduced in Royal TS 5.0 (released in December 2018) called dynamic folders.
Previously, I have written an article covering a PowerShell module for managing Royal TS Documents which is built in to Royal TS.
In that article I’ve showcased a script called Update-RoyalFolder.ps1, which could replicate server computer objects from a specified Active Directory domain or Organizational Unit (OU).
This was very useful as the script could be scheduled to update a Royal TS connections document, for example on a daily basis.
The new Dynamic Folder Script feature allows you to configure a script and the interpreter which populates the dynamic folder content.
We start by creating a new folder of the Dynamic Folder type:
Give it a meaningful name, such as the source we are going to dynamically retrieve data from:
On the Dynamic Folder Script window, we can choose PowerShell to be the script interpreter:
You will get an example script which shows what kind of objects is expected, as well as how to convert them to JSON (which is the output format Royal TS expects):
After modifying the options, such as credentials, click OK. When right-clicking the folder we create, we can see that we have the option of reloading the folder:
Clicking this will trigger the PowerShell script we just saw on the Dynamic Folder Script window, and the folder should now look like this when using the provided example script.
According to the documentation, there are two options available for reloading a dynamic folder:
- Automatically reload folder contents _ – If checked, Royal TS will automatically reload the folder contents when the document is opened._
- Persist (cache) folder contents _ – If checked, Royal TS will save (cache) the contents of this dynamic folder within the document._
By default, none of the two options is enabled.
In order to populate the dynamic folder with our own data using PowerShell, we can build custom objects with the necessary properties:
This example creates an object to be used with a Remote Desktop Connection. If you want to build other connection types, see the documentation for RoyalJSON and Dynamic Folders.
Next, we need to put all the objects we have created in a hash table called ‘Objects’, as this is what the RoyalJSON format expects:
The final piece is to convert the hash table to JSON format, which is very convenient to do in PowerShell:
As you can see, for a PowerShell user it is very straightforward to build a script for dynamically populating a folder with connection objects in Royal TS.
We can populate it with any data we can retrieve from PowerShell.
We will start by looking at an example on how to accomplish this using Active Directory as the data source.
You need to install Remote Server Administration Tools (RSAT) in order to leverage the Active Directory module for PowerShell from a workstation. Starting with Windows 10 October 2018 Update, RSAT is included as a set of “Features on Demand” in Windows 10 itself. From PowerShell, it can be installed using this command:
A Royal TS community member has created a YouTube video explaining more details about retrieving data from Active Directory for building a dynamic folder in Royal TS, such as building the Dynamic Folder sub folder structure based on the Organizational Unit structure the computer objects is retrieved from.
You can use your existing skills for retrieving the computer accounts you want from Active Directory. I am re-using an existing function I have created called Get-ServerFromAD. This will retrieve computer accounts with an operating system name starting with Windows Server*, exclude Cluster Name Objects and include computer accounts which have logged on during the last number of days specified (30 is the default).
You can find the complete script here.
I would recommend to first run the script manually in order to verify that data can be retrieved from Active Directory. You may also want to customize options such as domain name and credentials. I am using the script from a non-domain joined laptop, hence I need to specify credentials.
When the script is customized and verified, paste it in the Dynamic Folder Script window and click OK:
After re-loading the document, you should now see server computer accounts from Active Directory:
I have also created a script for getting computer names from System Center Virtual Machine Manager (both hosts and virtual machines), which can be used to populate a dynamic folder:
In my example script I’ve created a flat structure, putting all computer names in a subfolder called VMM. Here it is possible to do all sorts of creative things, such as use Group-Object on the OperatingSystem property and then create SSH connections for Linux machines and RDP connections for Windows machines.
I plan to create other scripts to retrieve computer names from other sources, such as Azure, Amazon Web Services, and VMware. Royal Applications has a dedicated repository for various automation scripts – created both by the Royal TS team and the community – where I also will submit Pull Requests for my contributions.
Using PowerShell Core as Script Interpreter
By navigating to the Royal TS Options, it is possible to modify Script Interpreter settings in the Advanced section:
By default, the PowerShell Script Interpreter is configured with the following path:
If you rather want to leverage PowerShell Core as the engine for the PowerShell Script Interpreter, simply change the path to either pwsh.exe (as it is available in the System Path):
Alternatively, specify the full path:
I have been using PowerShell Core without issues for the 2 Dynamic Folder Scripts I have showed in this article. For the Active Directory Dynamic Folder Script, PowerShell Core is using ~2.5 seconds to run against my lab Active Directory instance, while Windows PowerShell is using ~4 seconds.
In this article we have looked at how the dynamic folder script feature in Royal TS can be used to dynamically creating Royal TS connection objects based on data gathered from a PowerShell script.
We also looked at different sources we can retrieve data from, such as Active Directory and System Center Virtual Machine Manager.
If you are a Microsoft MVP, you can get an NFR license for Royal TS by sending an e-mail to support (at) royalapplications (dot) com with a link to your MVP profile.Share on: