This document covers upgrading the PowerShell Universal application.
The Universal application binaries can generally be upgraded without having to change the configuration or database manually. This document will cover how to upgrade the application and some caveats to be aware of in regards to configuration and data persistence.
Data is persisted in a LiteDB database with a default location of
%ProgramData%\UniversalAutomation\database.db. The database will not be deleted during an upgrade of any kind. Any schema updates to the database will happen the first time you start up the new version of Universal. You may wish to backup your database before performing an upgrade.
Configuration files are stored by default in
%ProgramData%\UniversalAutomation. Configuration files may be updated or transformed during an update. This will happen the first time that the new version of Universal server is started. You may wish to backup your configuration files before performing an upgrade.
If you are using git, changes to the Universal files will be synchronized after the server starts up.
appsettings.jsonfile that is included in the application installation directory will be overwritten during upgrades. To avoid losing your settings in this file, consider installing it into the
%ProgramData%\PowerShellUniversalfolder. Universal will look at this folder first for configuration settings.
web.configfile that is included in the application installation directory will be overwritten during upgrades. If you have moved your web.config file to an alternate location, it will not be overwritten. When creating an IIS website, you can simply include the
web.configfile in the web app's directory and have the binaries stored in a different location.
New versions of Universal may include new versions of Universal Dashboard Frameworks or Components. By default, these components and frameworks are deployed to
%ProgramData%\PowerShellUniversalduring startup of the Universal server. During an upgrade, these files are not deleted. This ensures that dashboards will continue to run on the previous dashboard framework and component versions.
You should have multiple versions of the dashboard frameworks and components available when you start the new version of Universal.
By default, new dashboards are set to always use the latest version of the dashboard framework. You can chose to set it to a specific version if you would like but will have to manually change the version during an upgrade.
Most of the settings for PowerShell Universal are stored within the repository folder. By default, this is in
%ProgramData%\UniversalAutomation\Repository. While the upgrade should not affect these files, you may want to backup the files before upgrading.
If you are upgrading from 2.x, you will have a couple of breaking changes.
The UDv2 framework has been removed and is no longer supported. If you wish to use this framework, you can install it from the PowerShell Gallery.
PowerShell 7.2 or later is supported by PowerShell Universal v3.
If you installed the platform using
Install-PSUServer, you can use the
Update-PSUServercmdlet to upgrade the system.
To upgrade a service, use
Update-PSUServerand optionally specify the path to where the executable is stored.
You can upgrade an IIS website by using the
Update-PSUServer -IISWebsite 'PSU'
When upgrading an manual ZIP file installation, you will need to stop the application, delete the entire binary folder and replace it with the new binary folder. When you start the new version of Universal, new dashboard frameworks and components will be deployed and the existing database will be loaded.
To upgrade using the MSI, you can simply run the new version of the MSI. If you are upgrading from PowerShell Universal v2, you will need to uninstall and then upgrade to the new version.
You will want to follow the guide on data and configuration persistence above to ensure all your settings are saved.
When upgrading with IIS, you will need to first stop your application pool to ensure that the binaries used by IIS are no longer in use and then replace the binaries with the new ones. Ensure that you follow the configuration persistence recommendations above with regards to the
When upgrading versions of PowerShell Universal, it is recommended to uninstall any previous versions of the
UniversalDashboardmodules you may have installed on the system. Having previous versions can cause problems with the PowerShell Universal server.
To verify if you have previous versions installed, you can use the following command.
Get-Module Universal -ListAvailable
Get-Module UniversalDashboard -ListAvailable
In the PowerShell Universal installation directory, there you will find the DataMigrator.exe tool for moving data from a local LiteDB database to a SQL server database. It takes care of creating the dashboard, creating the schema and transferring data.
Once migrated, you will need to update the plugin setting within
appsettings.json. Replace the
UniversalAutomation.LiteDBv5value with the string
SQL. You can also set an environment variable to use the SQL plugin.
$ENV:Plugins__0 = "SQL"
You'll also need to replace the connection string value with your SQL Data \ ConnectionString.
Similar to the plugin, you can use an environment variable instead of updating
$Env:Data__ConnectionString = "Data Source=ServerName; Initial Catalog=DatabaseName; User Id=UserName; Password=UserPassword;"
The step by step process is as follows:
- 1.Stop the PowerShell Universal service
- 2.Backup the database and repository
- 3.Run the data migration tool
- 4.Update the appsettings.json or environment variable to enable the SQL plugin and set the connection string.
- 5.Start the PowerShell Universal service
Once the service starts, it will be connected to SQL. Job data, identities, computers, and terminal instances will be stored in SQL.