Installation Tool PowerShell scripts

Scripts

This page explains how to run the scripts manually with previously configured configuration files. To run these scripts, first import the PowerShell module that contains them.

Import the scripts

Import-Module C:\PowerShell\DO-UpgradeTools\DO-UpgradeTools.psm1

Invoke-OmadaUpgrade

This script requires two parameters:

Parameter	Description
Action	Accepts Uninstall or Upgrade. For Uninstall, only the uninstall script runs. For Upgrade, the second script runs after this script finishes. The second script installs a new version of Omada Identity.
XMLPath	The path to the XML configuration file.

Example

Invoke-OmadaUpgrade -Action Upgrade -XMLPath "C:\powershell\DO-UpgradeTools\Private\install.config"

After starting the script, let it run until it finishes. It may take up to 20 minutes.

Invoke-OmadaInstall

This script requires one parameter:

Parameter	Description
XMLPath	The path to the XML configuration file.

Example

Invoke-OmadaInstall -XMLPath "C:\PowerShell\DO-UpgradeTools\Private\install.config"

After starting the script, allow about 30 minutes for it to finish.

Invoke-OmadaUpdate

This script requires the following parameter:

Parameter	Description
XMLPath	The path to the XML configuration file.

Example

Invoke-OmadaUpdate -XMLPath "C:\PowerShell\DO-UpgradeTools\Private\install.config"

Backup-OmadaDatabases

This script requires the following parameter:

Parameter	Description
XMLPath	The path to the XML configuration file.

The script also accepts these parameters:

Parameter	Description
backupAll	Accepts True or False. When set to True, all databases in the configuration file with Backup enabled are backed up. When set to False, only databases used by Omada components are backed up.
backupSubPath	The subpath of BackupPath, set in the configuration file, where backup files are placed.

Restore-OmadaDatabases

This script requires the following parameter:

Parameter	Description
XMLPath	The path to the XML configuration file.

The script also accepts these parameters:

Parameter	Description
restoreAll	Accepts True or False. When set to True, all databases in the configuration file with Restore enabled are restored. When set to False, only databases used by Omada components are restored.
backupSubPath	The subpath of BackupPath, set in the configuration file, from which backup files are restored.