Variables

+ More

Table of Contents

Variable Definitions

Serves to defining the values of variables which are required for the configuration of the software distribution, operating system installation or Empirum Sync Configuration. The values for the Variables can be entered via an XML or CSV file.

If you import values for variables, the manual entries are overwritten with the imported variable values.

The dialog window for modifying the value of a variable can be called via the context menu of a filter, configuration group, computer or user.

In order to edit the value of a variable, e.g. to edit a configuration group, proceed as follows:

  1. Start the Empirum Management Console (EMC), change in the navigation pane to Management > Administration and in the center window right-click on a configuration group and select Variables.
    You get to the Variables dialog window:
    Variablen_008
  2. Select the variable to be edited and click on the Bearbeiten Edit button.
  3. You can perform the desired changes in the Variable Value dialog window.
  4. Apply the changes you made in the Variable Value window via the OK button.
    The new value of the selected value will be displayed in the Variables dialog window under the Value column. In the Inheritance column, you will receive the information, that the variable here has been changed via the Modified designation.
  5. Close the Variables dialog window via the OK button.
    • Variables. Name of the internal variable created by Matrix42 GmbH, or the one created by you (jump to the Variable Descriptions section).
    • Value. Value of the Variable.
    • Control element. Specifies the Control element set during the Variable definition.
    • Description. Short description of the variable, stating for what exactly it was created.
    • Inheritance. Specifies whether the value of the variable comes from the variable definition (Default), or the value has been changed here (Modified), or the value is inherited from a superior configuration group (Inherited from Configuration group name).

If you assign a value to a variable, the value is not applied automatically to your software packages!
If a variable is to be applied in a software package, you first have to read this variable and set it.

Example: 

[Environment]
VM_MyVar=%%%V_MachineValuesPath%\%ComputerName%.ini,%ComputerName%,PM_MyVar%%
[Set:Product]
ReplaceEnv VM_MyVar
If %VM_MyVar% == "1" Then "Install" Else "Cancel" EndIf

Variable Definitions

Internal variables and their significance:

Variable Description
FQDN

The FQDN value specifies the "Fully Qualified Domain Name" without the host name. Empirum uses the value

  • for operating system installations
  • to connect to 3rd-party systems such as vCenter or XenDesktop server
  • to push the agent
  • to push software packages
  • to connect via remote Control and Intel-AMT KVM
BITLOCKERPARTREQUEST If an operating system installation from Windows 7 is performed, it is possible to specify that the default service partition used by Empirum shall also be used as Bitlocker partition to be able to encrypt one or several partitions with Bitlocker at a later point in time.If this OS variable is set to 1, the service partition will not be deleted, irrespective of the setting made in the OS template. The service partition will remain the active partition, even when the installation has been completed, since it contains the boot loader. It is possible to enable the Bitlocker feature manually at a later point in time via an Empirum package or a Powershell script.This variable must be created manually.
READYTOINSTALL_TEST Is used to test a new package once this package has been created via the software depot. If the variable value is set to "1", the package is installed for the selected group or the selected computer. For new packages, the "Ready to Install" entry (SwDepot.dds) under Configuration > Software Management > Depot tab> Tab > Package > Properties > Ready to install, is set to "0". The value "1" for the variable means that an entry is made in the file SwDepot.ddc (distribution command) for the selected systems only. Once the tests have been completed successfully, this value must be set to "1" to ensure that this package can be distributed to all other systems.
SELFPROVISIONING_
COMPUTERNAMETEMPLATE		 Used for automated name definition for new computers. You may use EIS and system variables or all variables defined by the user for self-provision purposes. If a question mark "?" is entered in this field, the computer name is prompted manually.
SELFPROVISIONING_
DOMAIN		 Used for specifying a domain for the automatic creation of a computer within a domain.
SELFPROVISIONING_
WORKGROUP		 Used to create the workgroup for the automatic creation of a computer within a workgroup.
POSTDELAYSECONDS PostDelaySeconds is a configurable OS variable (OS.INI [OS-variable]. PostDelaySeconds), which delays the call of the PostCommands to the specified number of seconds. The variable is optional and has no default. It is evaluated in every Windows installation scripts (Windows 2000, Xp, 2003, Vista, 2008, Windows 7).
ORGANIZATIONAL_UNIT If it is defined, the organizational unit name is inserted in the structure of the Workplace Management groups.
MX42_PATCHMANAGEMENT With this Patch Management variable, the scope of a scan on the computer can be set. See the online help for Patch Management for a more detailed list of variables.
SUBDEPOT A set of variables for configuring the depot servers and the Empirum Advanced Agent.
TOKENCOUNT Specifies the Empirum token files for the maximum number of simultaneous installations allowed.
ROOTPATH Specifies the local Empirum directory on the destination server.
USER_1
USER_2
USER_3		 Specifies the user(s) used to launch Empirum Sync and/or the Empirum Advanced Agent. If the variable is changed, the Empirum Advanced Agent-Template must be saved again. After the change all values appear in the template.
PASSWORD_1
PASSWORD_2
PASSWORD_3		 Specifies the password for users USER_1 to USER_3, which is entered into the database in an encoded form (Sync, setup, EIS and AES-256 encryption. There is an option use internal Empirum encryption. If chosen, the AES-256 encryption is used. Prerequisite is an Empirum Advanced Agent 16.1 or higher. If the variable is changed, the Empirum Advanced Agent-Template must be saved again. After the change all values appear in the template. For more details about encrypted passwords, see internal Empirum infrastructure encryption.
WEBSERVER Specifies the webserver to be used. (since version 16.1 only IIS)
WEBSERVER_HTTPPORT Specifies the port for the http protocol.
WEBSERVER_HTTPSPORT Specifies the port for the https protocol.
WEBSERVER_PASSWORD Registration dates for the WSServer process, if this shall not be started as a network service.
WEBSERVER_PROTOCOLS Specifies which protocols are used for the webserver.
WEBSERVER_PROCESSES Specifies the maximum number of cgi processes for the web serve.
WEBSERVER_USER Service account for the WSServer process (has to have local admin rights).
WEBSERVER_SSL_CERTIFICATE

Server certificates enable users to confirm the identity of a Web server. Here you specify the "thumbprint" of an existing server certificate that is installed on the IIS server.
A thumbprint is a unique identifier for a certificate.

If no thumbprint is specified, a "selfsigned certificate" will be created and used.

Here is described how you can distribute an SSL certificate by using a Group Policy
Here is described how to retrieve the thumbprint of a certificate.
WEBSERVER_BASIC_AUTHENTICATION Defines the IIS setting for Basic Authentication. For username and password authentication it is required to be enabled. Only if the authentication is restricted to certificates it can be disabled.
WEBSERVER_SSL_SETTINGS

Used for client certificate based authentication.

Possible values:

  • IgnoreClientCertificate
  • AcceptClientCertificate
  • RequireSSL_IgnoreClientCertificate
  • RequireSSL_AcceptClientCertificate
  • RequireSSL_RequireClientCertificate

Defines if the Agent can authenticate at the IIS via username and password and/or client certificates. Refer to the dedicated help for client certificate based authentication.
WEBSERVER_CLIENTCERTIFICATE_ISSUER_CN

Name of the issuer of the certificate used for client certificate based authentication.

The client certificate identifies a client computer. It is issued by a certification authority. This variable has to contatin the common name (CN) of the authority.
WEBSERVER_CLIENTCERTIFICATE_USERNAME User which is mapped for local access on the IIS when used client certificate based authentication. This can be the user configured in variable USER_1 to USER_3 by example.
WEBSERVER_CLIENTCERTIFICATE_PASSWORD

Password of the user which is mapped for local access on the IIS when used client certificate based authentication.

Do not choose the option Use internal Empirum Infrastructure Encryption.
SERVICES Is used to specify which services from the "Empirum Subdepot" package shall be installed; default setting is rsync and iperf; optional settings are Webservice and FTPService.
FTPSERVER Specifies the FTP server. (since version 16.1 only IIS)
FTPSERVER_ALLOW_ANONYMOUS Specifies if the FTP server allows anonymous login.
LANGUAGE Describes the language in the depot server location and controls the language of the Empirum OS Installer prompts
SET_NTFS_RIGHTS This variable makes it possible to not set the NTFS privileges as a standard via the subdepot package (value = 0) or to set them individually during each installation (value = 1).
SUBDEPOT_SERVICES  
WOL_ADDITIONAL_BROADCAST_IP Use this option to enter a string of comma-separated IP addresses to be used by the WOL service to send additional wake-up packages to these addresses.

If the IP configuration (PXE_IP, PXE_SUBNET, etc.) does not contain any values, the subdepot WOL Services package automatically determines the IP parameters of the network card communicating directly with the Empirum server and enters the corresponding values in DBUtil.


When using WOL in the offline case, activation via the Matrix42 Management Console can be used.
Starting with Empirum version v22.0.1, the WakeOnLan service has been extended to send the "Magic Packet" to all existing network cards.
A "Directed Broadcast" is sent if the IP address and the subnet mask are known in addition to the MAC address. If only the MAC address is known, a broadcast is sent to the subnet 255.255.255.255.
The following requirements must be met for WOL to be functional in the offline case:
1. The installation server must be entered directly on the client to be woken up (Properties > Empirum Server > Assigned Empirum Servers).
2. In the status of the client to be woken up (right mouse button > Show Status), at least one package is displayed in yellow.
3. When activating via the EMC in the middle tree, "Create operating system configuration (Os.ini)" must also be activated.
4. WOL must be enabled in the Bios / EFI setup.

PXE_SERVERMODE PXE/DHCP 
The Empirum PXE service works as PXE server and simulates a functionally reduced DHCP server which is able to assign IP addresses.
PXE Only
The Empirum PXE service works only as PXE server. The DHCP server must not be started on the Empirum server.
Compatibility Mode
The PXE server is started prior to the DHCP server if both server types are installed on the Empirum server. The DHCP and PXE services are installed on the server. In order for the PXE client to successfully receive the necessary information (IP address, etc.), the DHCP option 60 has to be defined on the DHCP server. Therefore the following command has to be entered via the command prompt:
netsh dhcp server IP-of-DHCP-Server add optiondef 60 ClientIdentifier STRING 0 PXEClient
Then, the created option has to be activated in the user interface of the DHCP server.
PXE_IP IP address of the Master/Subdepot server where the Empirum services shall be installed.
Please note: Is the IP address empty or filled with 0.0.0.0, all existing network cards will be found.
PXE_SUBNET Enter the respective subnet mask. Together with the IP address, it defines the network where the computer is located.
PXE_GATEWAY Enter the IP address of the default gateway used to transmit data to other networks and subnets.
PXE_DNS Enter the IP address of the DNS (Domain Name System) servers an, which resolves domain and computer names in IP addresses.
PXE_SERVICE Online Mode Installation (default) 
The service will be installed in online mode. The PXE service does require a database connection. 
Offline Mode Installation
The service will be installed in offline mode. The PXE service does not require a database connection.
PXE_DEFAULTPXEIMAGE Defines the default PXE image to be used when the PXE service is installed via the Empirum Subdepot PXE service package. If configured, the value overwrites the configuration in Empirum DBUtil. Only boot images with self-provisioning capability are displayed via a drop-down menu.
SYNC A set of variables for master server <-> depot server synchronization. There is an option use internal Empirum encryption. If chosen, the AES-256 encryption is used. For more details about encrypted passwords, see internal Empirum infrastructure encryption.
SYNC_SERVER1 Specifies the UNC path to the source server via SMB protocol, e.g. \\%EmpirumServer%\Empirum$.
SYNC_SERVER2 Specifies the local path to the destination server, e.g. C:\Empirum.
SYNC_SERVER3 Specifies the UNC path to the source server via the Rsync protocol, e.g. rsync://%EmpirumServer%.
SYNC_SERVER4 Specifies the local path to the destination server via the Rsync Protocol, e.g. /cygdrive/c/Empirum/.
OS_REGIONALSETTINGS Localization options which are supported by the OS Installer.
Language Shows which language has been installed. If the language is specified here, settings for SystemLocale, InputLocale, UserLocale and MUILanguage will be ignored.
Please note: You can specify the SystemLocale, InputLocale, UserLocale and MUILanguage settings individually as a workaround to solve this problem.
LanguageGroup Shows which language support is installed on the system. If specified, these settings are used as default values for InputLocale, SystemLocale and UserLocale.
SystemLocale Is used to execute and display menus and dialogs of programs without Unicode in the local language. If a localized program is not displayed correctly on the system, you can try to set the respective language via the SystemLocale option to solve the problem. Please note that this is a network-wide setting, which means that no simultaneous support is provided for localized programs without Unicode for multiple languages.
UserLocale Controls settings related to sorting numbers, time, currency and date.
InputLocale Shows the settings for the input locale and keyboard layout combinations. If several locales are defined, the first keyboard layout is used as default keyboard for the system. The specified combinations must either be supported by one of the languages of the LanguageGroup setting or the default language for the language version of Windows XP that shall be installed. If an available language does not support this specific combination, the default combination is used accordingly. This setting will be ignored if a language has been defined in the Language option.
UserLocale_DefaultUser New for Windows XP - Is used to define the user locale for the default user. This setting controls the settings for numbers, time, currency and date and must either be supported by one of the languages defined in the LanguageGroup option or the default language for the Windows XP version that shall be installed.
InputLocale_DefaultUser New for Windows XP - Is used to define the input locale and the keyboard layout combinations for the default user.
MuiLanguage New for Windows XP - Is used to define the user interface language on a system with Windows MultiLanguage for the current user and to configure settings after the respective language of the Windows MultiLanguage version has been installed during setup.
MuiLanguage_DefaultUser New for Windows XP - Is used to define the user interface language in the default user profile; this profile also defines the language to be used for log-in and the default user interface language, which is used for all new user accounts.
UILanguage_Win6x UILanguage specifies the default system language to display user interface (UI) items (such as menus, dialog boxes, and help files).
SystemLocale_Win6x Is used to execute and display menus and dialogs of programs without Unicode in the local language. If a localized program is not displayed correctly on the system, you can try to set the respective language via the SystemLocale option to solve the problem. Please note that this is a network-wide setting, which means that no simultaneous support is provided for localized programs without Unicode for multiple languages.
UserLocale_Win6x Controls settings related to sorting numbers, time, currency and date.
InputLocale_Win6x Shows the settings for the input locale and keyboard layout combinations. If several locales are defined, the first keyboard layout is used as default keyboard for the system. The specified combinations must either be supported by one of the languages of the LanguageGroup setting or the default language for the language version of Windows XP that shall be installed. If an available language does not support this specific combination, the default combination is used accordingly. This setting will be ignored if a language has been defined in the Language option.
See more OS_REGIONALSETTINGS variables under http://technet.microsoft.com/en-us/library/cc766191%28WS.10%29.aspx
INTERNAL_OS_INSTALLER_CONFIG Configuration options for the OS installer.
EIS_DEBUGMODE

This variable defines the debug mode for EIS. If the value is set to EIS_DEBUGMODE=10, each EIS command is logged. After the installation has been completed, the log can be found in the directory '.\Empirum\EmpInst\Wizard\OS\Auto\MAC8\ next to OS.INI and is required for debugging.
 

From EIS_DEBUGMODE = 3 SKUs and other security-related information are displayed in plain text. This can locate errors in these areas. If log files are requested from this level by Matrix42 support, you may decide to leave that information in it or delete it.
Starting with Empirum v14 SP1, passwords are no longer displayed in plain text if they are at least six characters long!
EIS_PALIGN=n Sector limit where the first partition shall begin (parameter for OS.INI ([OS_VARIABLE].PALIGN=n). Starting with Windows Vista, the default value (n) is 2048 sectors. The first partition will be set accordingly, all others are integer multiples. For Windows XP / Server 2003 this variable can be used to set the internal value of 63 to a higher value, e.g., 2048 (important for SSD and 4k sector disks).
WIN8_SETUPKEY

This variable modifies key handling in the client-setup-phase.

Is the WIN8_SETUPKEY defined, an (existing) Product ID is used only to enable the client post phase.

For the client setup phase the following WIN8_SETUPKEY based logic applies:

WIN8_SETUPKEY Action in the setup phase
auto The key will be read from a table of Microsoft KMS setup keys (see http://technet.microsoft.com/en-us/library/jj612867.aspx).
empty blank / no value- Product ID from OS-Template will be used in OS-Setup-Phase too (old behavior).
Key 29 column key to be used in OS-Setup-Phase (only).
none No key to be used in OS-Setup-Phase (blank key).
WINPE_VERSION

Allows you to manually use a special version of WinPE:

Default Uses WinPE 4.x and higher for the OS installation.
3.0 Uses WinPE 3.x for the OS installation.
WINPE_WIMBOOT=[0|1] Windows PE is unpacked (0, default) or as a single file (1) copied to the Matrix42 Service partition. This variable must be set to 1 for disk imaging.
INTERNAL_OS_DISKMANAGEMENT Controls or enables the installation of Intel SRT / RST SSD cache drives.
SSD_CACHE_SUPPORT Allows subsequent Installing the Intel SRT / RST Tools for SSD CACHE drives under Windows (additional package).
M42_INTERNAL_OS_IMAGING_CREATION Set of variables used for creating a disk image.
USERNAME User to access the network share (e.g. Domain\User).
PASSWORD Password for variable USERNAME to access the network share, for more details about encrypted passwords, see internal Empirum infrastructure encryption.
SHARE UNC Path to the network share to store the VHD file (e.g. \\192.168.50.92\EmpInst$).
SOURCE

Source of the VHD content.

  • disk:number e.g. disk:0 (default if empty and recommended value)
  • volume:driveletter e.g. volume:c,d (both must be on the same hard disc)
DESTINATION The VHD file path (e.g. \\192.168.50.92\EmpInst$\Sys\Test.vhd).
DOSYSPREP

Option to activate SysPrep mode of the Empirum VHD Create package.

  • Yes: Necessary to prepare image for deployment via Disk Imaging
  • No: Only create a VHD file from a client
M42_INTERNAL_OS_IMAGING_SETTINGS Set of variables used for distributing a previously created disk image.
IMAGEFILE_MBR Enter the VHD file name that will be used for disk imaging with a MBR based partition schema (e.g. Test_MBR.vhd without path; root path for images is \\%EmpirumServer%\EmpInst$\DiskImages\).
IMAGEFILE_GPT Enter the VHD file name that will be used for disk imaging with a GPT based partition schema (e.g. Test_GPT.vhd without path; root path for images is \\%EmpirumServer%\EmpInst$\DiskImages\).
ADDRESS

The IP multicast address that should be used (IPv4).

  • Default value: 239.42.42.42
  • Multicast IP Range: 224.0.0.0 trough 239.255.255.255
PORT

Defines the initial port of the communication channel.

  • Default value: 9000
  • Port range: 1 to 65536
CLIENTTHRESHOLD

Number of clients necessary to start the transfer.

  • In case of unicast, the threshold must be set to 0
  • In case of multicast, the threshold must be set > 0
STARTTIMEOUT

Defines the timeout until the multicast transfer starts even if the maximal count of clients has not been reached.

  • Default value (s): 300
  • Min (s): 60
JOINTIMEOUT

Time to wait after the client threshold has been reached to give additional clients the chance to join the group.

  • Default value (s): 180
  • Min (s): 10
TTL

Time to live of the multicast packages defining the max router hops.

  • Default value: 2
  • Min: 1
  • Max: 255
CLIENTTIMEOUT

Time in seconds until a non responding client will be dropped by the server.

  • Default value (s): 120
  • Min (s): 30
PACKAGESIZE

Size of the transmitted multicast package.

  • Default value: 65200
  • Min: 512
  • Max: 65200
PAGESIZE

Number of multicast pakets per page.

  • Default value: 1024
  • Min: 64
  • Max: 65536
VMCONFIG Set of variables for configuring the guests on the vmWare ESX server.
NAME The Name of the VM on the ESX-Server.
MAC The MAC-address of the VM (The MAC address range for Virtual Machines is 00:50:56:00:00:00 - 00:50:56:3F:FF:FF).
MEMSIZE Size of the VM's RAM in MB.
DISKSIZE Size of the VM's harddisk in GB.
OSTYPE Operating system type of the VM using the VMWare specifications.
ADAPTERTYPE Type of the SCSI adapter (lsilogic or buslogic).
DATASTORE Datastore, where the VM has to be created.
VHDDisposal Descripes the deployment status of a VHD or a snapshot within a disk image class. This can be extended by another state.
 
VHD_Path Is occupied by the assigned disk image class and specifies the path and name of the VHD file.
VHD_Source Is occupied by the assigned disk image class and specifies the source of the VHD file.
MX42_AGENT_PUSH_PACKAGE_FOLDER

This variable allows you to define an alternative package folder for the agent push. It is specific for the operating system. The specified path has to be below the Empirum package folder "Packages\Matrix42". It has to be relative.
Example:EmpirumAgent\17.0

The Agent Push can not be used to downgrade a Windows Empirum Agent to a previous version.
Windows Specifies an alternative path to the Windows Agent package.
macOS Specifies an alternative path to the macOS Agent package.
MX42_UEM_AGENT Configuration options of the UEM Agent
Auto Update

Defines if the UEM Agent should update itself to the latest available version in the depot.

  • No - Use assigned version: No automatic update. Assigned UEM Agent versions will be installed.
  • Yes - Use latest approved version: The UEM Agent updates itself to the latest approved version automatically.
  • Yes - Use latest available version: The UEM Agent updates itself to the latest available version automatically. This setting can be used for pilot rollouts.

This functionality is available with Empirum Version 18.0.3.
Release Type

Defines the release type to be used for the Auto Update. If this variable is not set, only the Extended Support Release (ESR) is installed via Auto Update.

  • Extended Support Release (ESR): The Auto Update only installs ESR versions.
  • Standard Feature Release (SFR): The Auto Update only installs SFR versions.
  • Technical Preview (TP): The Auto Update only installs TP versions.

This functionality is only available starting with Empirum version 20.0.2.
AgentUI/TrayIcon

Defines if the tray icon is displayed on client

  • True: display tray icon.
  • False: hide tray icon.
SoftwareDepot/Polling/Intervall/seconds Sets the polling intervall.
SoftwareDepot/Polling/Intervall/Timeframes/enabled

Enable/disable the option "Installation Time Frame".

  • True: enable "Installation Time Frame".
  • False: disable "Installation Time Frame".
SoftwareDepot/Polling/Intervall/Timeframes/ArbitraryFrame#{x}

Defines up to 5 additional installation time frames.

Time frames must be filled sequentially. Empty time frames in between cause a software failure.
SoftwareDepot/Polling/Intervall/Timeframes/ProhibitedFrame#{x}

Defines up to 5 additional excluded installation time frames.

Time frames must be filled sequentially. Empty time frames in between cause a software failure.
AgentUI/InitialUiView

Defines which view is initially visible in the installation dialog.

  • Overview: Overview page with the number of required and optional packages is displayed.
  • Detail: Detail page with the specific software packages is displayed.
AgentUI/InstallationWindow/Enabled

Activate/deactivate the display of the "Installation information" window during an installation.

  • True: activates "Installation information".
  • False: deactivates "Installation information".
MX42_UEM_DEPOT_MANAGEMENT Configuration options of the UEM Depot Management
Configure synchronization of configuration files
Synchronized directories

The actual directories are loaded from the assigned Agent template and used transport protocol. By default it is:

  • C:\Empirum\Configurator\User
  • C:\Empirum\Configurator\Values\MachineValues
SYNC_CONFIGURATIONDATA_ENABLED De-/activates the synchronization of configuration files.
SYNC_CONFIGURATIONDATA_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \MachineValues\*.xml
  • *.sck
SYNC_CONFIGURATIONDATA_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \Temp\
SYNC_CONFIGURATIONDATA_SCHEDULER Configures the execution times for this synchronization
Configure synchronization of files from the client
Synchronized directories

The actual directories are loaded from the assigned Agent template and used transport protocol. By default it is:

  • C:\Empirum\Configurator\Log
  • C:\Empirum\EmpInv
SYNC_CLIENTDATA_ENABLED De-/activates the synchronization of files from the client.
SYNC_CLIENTDATA_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • TEMP_*
SYNC_CLIENTDATA_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \EAI_Jobs\
  • \hw_live\
SYNC_CLIENTDATA_SCHEDULER Configures the execution times for this synchronization
Configure synchronization of packages
Synchronized directories

The actual path is determined from the assigned agent template and active transport protocol. By default, this is:

  • C:\Empirum\Configurator\Packages
SYNC_PACKAGES_ENABLED De-/activates the synchronization of packages.
SYNC_PACKAGES_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • swdepot.sck
SYNC_PACKAGES_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \PatchManagement\
SYNC_PACKAGES_SCHEDULER Configures the execution times for this synchronization
Configure synchronization of patches
Synchronized directories

The actual path is determined from the assigned agent template and active transport protocol. By default, this is:

  • C:\Empirum\Configurator\Packages\PatchManagement
SYNC_PATCHES_ENABLED De-/activates the synchronization of patches.
SYNC_PATCHES_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \Catalog\*.xml
  • \Patches\*.part
SYNC_PATCHES_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • keine
SYNC_PATCHES_SCHEDULER Configures the execution times for this synchronization
SYNC_PATCHES_SOURCE Defines whether the patch data is obtained from the Empirum Master Server ("Infrastructure") or the vendor website ("Vendor").
Configure synchronization of files for OS installations
Synchronized directories

The actual path is determined from the assigned agent template and active transport protocol. By default, this is:

  • C:\Empirum\EmpInst
SYNC_OS_CONFIGDATA_ENABLED De-/activates the synchronization of config files for OS installations.
SYNC_OS_CONFIGDATA_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • convert.ini
  • debug*
  • OS.ini.pxe
  • OS.ini.wol
  • *.local
SYNC_OS_CONFIGDATA_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \Manuell\
  • \Temp\
  • \Template\
  • \WinPeStatus\
SYNC_OS_CONFIGDATA_SCHEDULER Configures the execution times for this synchronization
SYNC_OS_IMAGEDATA_ENABLED De-/activates the synchronization of OS images for OS installations.
SYNC_OS_IMAGEDATA_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • convert.ini
SYNC_OS_IMAGEDATA_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • \Wizard\
SYNC_OS_IMAGEDATA_SCHEDULER Configures the execution times for this synchronization
Configuration of the QuickSync synchronization

It is no longer necessary to configure QuickSync synchronization when using the UEM Depot Sync package 2.0 or higher. From this version onwards, the prompt file transfer takes place automatically via the ServiceBus. If Empirum version 24.0.0 or higher is installed, it is therefore no longer available at this point. 
 

Synchronized directories

The actual path is determined from the assigned agent template and active transport protocol. By default, this is:

  • C:\Empirum\EmpInst\Wizard\OS\
  • C:\Empirum\Configurator\Values\
SYNC_QUICKSYNC_ENABLED De-/activates the synchronization via QuickSync.
SYNC_QUICKSYNC_EXCLUDED_FILES

List of excluded files. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • convert.ini
  • debug*
  • *.local
SYNC_QUICKSYNC_EXCLUDED_FOLDERS

List of excluded directories. The asterisk * can be used as a placeholder. Multiple entries can be separated with a pipe character |. Excluded by default:

  • keine
SYNC_QUICKSYNC_SCHEDULER Configures the execution times for this synchronization
Configuration of communication for depot monitoring

The functionality that can be configured here requires UEM Depot Sync Package 1.2 or later. 
 

SERVICEBUS_ENABLED Enables/disables communication with a ServiceBus. It must be active to enable monitoring of the depot.
SERVICEBUS_SYSTEM

Supports the cloud-based Microsoft Azure Service Bus or an on-premise RabbitMQ system.

RabbitMQ is an open source message broker.
SERVICEBUS_DISPLAYNAME Optionally, specify a name for the ServiceBus service that is unique to you.
SERVICEBUS_SUBSCRIPTIONNAME Messages will be received from this subscription.
SERVICEBUS_TOPICNAME Messages will be published to this topic and delivered to one or more associated subscriptions.
SERVICEBUS_CONNECTIONSTRING

String to connect to the previously selected ServiceBus type.

For more information, see Empirum-ServiceBus service connection string.
SERVICEBUS_USEPROXY Disables/enables the use of a proxy server.
SERVICEBUS_PROXYNAME The address of the proxy server.
SERVICEBUS_PROXYPORT The port number of the proxy server.

Related Articles