Mirror Tool

The Mirror Tool is necessary for offline detection engine updates. If your client computers do not have an Internet connection and need detection engine updates, you can use the Mirror Tool to download update files from ESET update servers and store them locally.

details_hoverNOTE

The Mirror Tool downloads detection engine updates and other program modules only, it does not download PCUs (Program Component Updates) and LiveGrid data. It can also create a  full offline repository. Alternatively, you can upgrade products individually.

Prerequisites

validation-status-icon-warning IMPORTANT

The Mirror Tool does not support Windows XP and Windows Server 2003.

The target folder must be available for sharing, Samba/Windows or HTTP/FTP service, depending on how you want to have the updates accessible.

You must have a valid Offline license file that includes the Username and Password. When generating a license file, be sure to select the check box next to Include Username and Password. Also, you must enter a license Name. An offline license file is needed for the activation of the Mirror Tool and generation of the update mirror.

 

create_offline_license_file

You must have the Mirror Tool file available. The tool is available on ESET download page in the Standalone installers section.

Visual C++ Redistributable for Visual Studio 2010 must be installed on the system.

Visual C++ 2015 Redistributable x86 must be installed on the system.

There is no installation step, the tool consists of two files:

oWindows:
MirrorTool.exe and updater.dll

oLinux:
MirrorTool and updater.so

 

Usage

To see Mirror Tool help, run MirrorTool --help to view all available commands for the tool:

mirror_tool_help

 

Parameter

Description

--updateServer

When you use it, you must specify the full URL of the update server.

--offlineLicenseFilename

You must specify a path to your offline license file (as mentioned above).

--languageFilterForRepository

You can specify language codes, for example for French type fr_FR. Other languages codes are in the table below. To select more languages, separate them by a space, for example: en_US zh_TW de_DE

--productFilterForRepository

You can specify a string that Mirror Tool uses as a download filter. Mirror Tool downloads only files, which contain the string in their common name. You can select more products by adding more arguments, for example: --productFilterForRepository Antivirus Security

Mirror Tool downloads all selected languages for each selected product.

--downloadLegacyForRepository

No argument needed. Use this parameter to include legacy packages in the download. If not used, legacy packages are not downloaded. You can find out which products are legacy in the Client task > Software Install menu Settings > Package to install > Choose package > Legacy.

All filters are case sensitive.

 

Language code

Language

Language code

Language

en_US

English

it_IT

Italian

hu_HU

Hungarian

kk_KZ

Kazakh

ar_EG

Arabic

ko_KR

Korean

bg_BG

Bulgarian

lt_LT

Lithuanian

zh_CN

Chinese (Simplified)

nl_NL

Dutch

zh_TW

Chinese (Traditional)

nb_NO

Norwegian

cs_CZ

Czech

pl_PL

Polish

da_DK

Danish

pt_BR

Portuguese

de_DE

German

ro_RO

Romanian

el_GR

Greek

ru_RU

Russian

es_CL

Spanish (Chile)

sk_SK

Slovak

es_ES

Spanish

sl_SI

Slovenian

et_EE

Estonian

sr_RS

Serbian

fi_FI

Finnish

sv_SE

Swedish

fr_FR

French

th_TH

Thai

fr_CA

Canadian French

tr_TR

Turkish

hr_HR

Croatian

uk_UA

Ukrainian

 

 

vi_VN

Vietnamese

 

To create a mirror, run the MirrorTool with at least the minimal required parameters. Here are examples:

Windows:

MirrorTool.exe --mirrorType regular ^

--intermediateUpdateDirectory c:\temp\mirrorTemp ^

--offlineLicenseFilename c:\temp\offline.lf ^

--outputDirectory c:\temp\mirror

 

Linux:

sudo ./MirrorTool --mirrorType regular \

--intermediateUpdateDirectory /tmp/mirrorTool/mirrorTemp \

--offlineLicenseFilename /tmp/mirrorTool/offline.lf \

--outputDirectory /tmp/mirrorTool/mirror

 

Here are examples of more advanced configuration for an offline repository with selected products, languages and enabled download of legacy files:

Windows:

MirrorTool.exe --repositoryServer AUTOSELECT ^

--intermediateRepositoryDirectory c:\temp\repoTemp ^

--outputRepositoryDirectory c:\temp\repository ^

--languageFilterForRepository sk_SK fr_FR de_DE ^

--productFilterForRepository Antivirus Security ^

--downloadLegacyForRepository 

 

Linux:

sudo ./MirrorTool --repositoryServer AUTOSELECT \

--intermediateRepositoryDirectory /tmp/repoTemp \

--outputRepositoryDirectory /var/lib/tomcat8/webapps/mirrorRepo \

--languageFilterForRepository sk_SK fr_FR de_DE \

--productFilterForRepository Antivirus Security \

--downloadLegacyForRepository 

 

Mirror Tool and Update settings

To automate downloads for modules updates, you can create a schedule to run the Mirror Tool. To do so, open your Web Console and click Client Tasks > Operating System > Run Command. Select Command line to run (including a path to the MirrorTool.exe) and a reasonable trigger (such as CRON for every hour 0 0 * * * ? *). Alternatively, you can use the Windows Task Scheduler or Cron in Linux.

To configure updates on a client computer(s), create a new policy and configure Update server to point to your mirror address or shared folder.

 

details_hoverNOTE

Read this Knowledgebase article to set up Mirror Tool chaining (configure Mirror Tool to download updates from another Mirror Tool).