Introduction
Macrium Reflect LTSC 2024 supports both interactive and command-line installation. This ensures that the Macrium Reflect LTSC can be easily automated for installation on a large number of systems. Additionally, from Macrium Reflect LTSC 2024 version 8.1.8439 installations can be performed without entering a license, a license can then be entered post-installation during first execution or using a command line argument as described below. This enables Macrium Reflect LTSC to be included in operating system golden images and then licensed post-deployment.
- Downloading Macrium Reflect LTSC
- Interactive Post-installation Licensing
- Command-line Post-installation Licensing
- License and Activation Result Output
Downloading Macrium Reflect LTSC
License keys and software installers can be accessed through the Macrium Account. In the Macrium Account, select the 'Overview' or 'Downloads' page and navigate to the relevant product card for the Macrium Reflect LTSC edition that will be installed:
After selecting 'Download LTSC 2024', you will be prompted to select the relevant architecture that will be installed. After selecting the architecture, the download will start in the browser:
Interactive Installation
To interactively install Macrium Reflect LTSC, launch the Macrium Reflect LTSC using Windows Explorer. Below are the pages that are displayed during the installer:
 |
 |
 |
 |
 |
 |
 |
 |
The 'Custom Setup' page of the installer enables additional features to be selected for installation. The available options are shown below:
|
Option
|
Description
|
|---|---|
| Install CBT |
If selected, the Changed Block Tracker driver will be installed. This reduces the time taken to perform incremental and differential images by monitoring changes to volumes in real-time to keep a record of blocks that have changed. |
| Install Macrium Image Guardian |
If selected, the Macrium Image Guardian driver and configuration application will be installed. This can be used to provide additional anti-malware and anti-ransomware protection for Macrium Reflect backup files. |
| Install viBoot |
If selected, Macrium viBoot will be installed on the server, to allow virtual machines to be created from backup images directly. This requires either Microsoft Hyper-V or VirtualBox to be installed. |
| Install Desktop Shortcut | If selected, a desktop shortcut will be created that can be used to launch Macrium Reflect. |
The 'Install CBT' and 'Install Image Guardian' options require the system to be restarted before the feature is active.
Command-line Installation
The following arguments are supported when installing Macrium Reflect LTSC using the command line:
|
Argument |
Description |
|
-silent |
Perform the installation silently. |
|
-cbt |
Install Changed Block Tracker, a restart is required for this feature to be active. |
|
-mig |
Install Macrium Image Guardian, a restart is required for this feature to be active. |
|
-viboot |
Install Macrium viBoot. |
|
-shortcut |
Create a desktop shortcut to launch Macrium Reflect. |
|
-key <key> |
Install using the specified license key. If this argument is not used, Reflect will install without a license key which can then be entered following the installation, as described below. |
|
-norestart |
Do not restart the computer after the installation. If -mig and -cbt are not specified, a restart is not required regardless of this switch. |
|
-log |
Write a log of the install to C:\Reflect_Install.log. |
Note: when upgrading using the installer, the relevant switches should be used for the installed features to ensure they are not removed during the upgrade.
Installation Result Output
The installer will now return status information in the form of two environment variables that can be used to easily check the result of the installation:
|
Variable |
Description |
|
SETUP_RESULT |
MSI result code for the installation. |
|
SETUP_ERROR |
Contains additional information if setup failed. |
To ensure that the variables are set and outputted correctly, the installer should be invoked using a script like the example below:
@echo off
rem This sample batch file silently installs Reflect and then reports the result
set SETUP_ERROR=
set SETUP_RESULT=
rem Install without a product key
for /f "delims=" %%i in ('reflect_wkstn_setup_x64.exe -silent') do %%i
rem This call command is required to retrieve the updated environment variables set in the for loop
call :CheckResults
goto :Exit
:CheckResults
if "%SETUP_RESULT%"=="0" (
echo Setup successful
) else (
rem https://learn.microsoft.com/en-us/windows/win32/msi/error-codes
if "%SETUP_RESULT%"=="3010" (
echo Setup successful - reboot required
) else (
echo Setup error %SETUP_RESULT%
if defined SETUP_ERROR (
echo "%SETUP_ERROR%"
)
)
)
:Exit
Interactive Post-installation Licensing
If a license is not specified during the installation, the following screen will be displayed the first time that Macrium Reflect LTSC is launched interactively:
A valid Macrium Reflect LTSC license can then be entered using the ‘Enter a license key’ option.
Command-line Post-installation Licensing
ReflectBin.exe also has two new command line options that can be used to silently license Macrium Reflect LTSC from the command line. ReflectBin.exe can be found at the following default path:
C:\Program Files\Macrium\Reflect\ReflectBin.exe
The following command line arguments are supported by ReflectBin for license installation and activation:
|
Argument |
Description |
|
-key <key> |
This switch is used to install a license key locally. |
|
-activate |
This switch is used to activate the installed license key with the Macrium license server. This is a separate switch to enable the -key to be installed without an internet connection and then activated at a later time. Command line activation using this switch requires an internet connection. |
If the -key switch is used without -activate, when Reflect is next run interactively, the user will be prompted to complete the license activation:
ReflectBin can return the following two environmental variables to check the result of the license installation and activation:
|
Argument |
Description |
|
REFLECT_RESULT |
This will output the result of the license check. |
|
REFLECT_ERROR |
This will output the error description associated with REFLECT_RESULT. |
The possible results and error descriptions are shown below:
|
REFLECT_RESULT |
REFLECT_ERROR |
|
eLickeySuccess = 0 |
|
|
eLickeyBadKey = 1 |
Missing or invalid format product key |
|
eLickeyError= 2 |
Key not accepted |
|
eLickeyServerOffline = 3 |
Failed to connect to the licence server |
|
eLickeyCommitFailed = 4 |
License Server XML error |
|
eLickeyTooManyInstalls = 5 |
"This license valid for 1 PC(s) and the number of installs exceeds this..." |
|
eLickeyValidationFailed = 6 |
Other server error. |
License and Activation Result Output
To ensure that the variables are set and outputted correctly, the installer should be invoked using a script like the example below:
@echo off
rem This sample batch file silently installs a product key into Reflect and reports the result
if "%~1"=="" (
echo Usage: LicenseReflect ^<product key^>
) else (
set REFLECT_ERROR=
set REFLECT_RESULT=
rem Install without a product key. for loop documentation is here: https://ss64.com/nt/for.html
for /f "delims=" %%i in ('"%ProgramFiles%\Macrium\Reflect\ReflectBin.exe" -key %1 -activate') do %%i
rem This call command is required to retrieve the updated environment variables set in the for loop
call :CheckResults
goto :Exit
:CheckResults
if "%REFLECT_RESULT%"=="0" (
echo License registration successful
) else (
echo License registration error %REFLECT_RESULT%
if defined REFLECT_ERROR (
echo "%REFLECT_ERROR%"
)
)
)
:Exit