Metascan 3.6.4 Installation & Upgrade Guide OPSWAT, Inc.
Copyright DISCLAIMER OF WARRANTY OPSWAT Inc. makes no representation or warranties, either expressed or implied by or with respect to anything in this document, and shall not be liable for any implied warranties of merchantability or fitness for a particular purpose or for any indirect special or consequential damages. COPYRIGHT NOTICE OPSWAT, Metascan, and the OPSWAT logo are trademarks and registered trademarks of OPSWAT, Inc. All other trademarks, trade names and images mentioned and/or used herein belong to their respective owners. No part of this publication may be reproduced, stored in a retrieval system or transmitted, in any form or by any means, photocopying, recording or otherwise, without prior written consent of OPSWAT Inc. No patent liability is assumed with respect to the use of the information contained herein. While every precaution has been taken in the preparation of this publication, OPSWAT Inc. assumes no responsibility for errors or omissions. This publication and features described herein are subject to change without notice 2
Contents Contents... 3 Metascan Installation Packages...5 Optional Components...5 Before Installing Metascan... 6 System Requirements for Metascan... 6 Additional System Requirements for Metascan MMC Integration... 6 Additional System Requirements for Metascan REST Server... 6 Installing Metascan... 7 Installing Metascan Using the Install Wizard... 7 Installing Metascan from the Command Line... 7 Command Line Options... 8 Activating Metascan Licenses... 10 Activation Options... 10 Online activation of license... 10 Online activation of licenses using the MMC... 11 Online activation of licenses with CLI License Manager... 15 Offline Activation with the OPSWAT Activation Portal... 17 Offline Activation through the Metascan Management Console... 18 License Manager CLI... 23 License Manager CLI Commands and Arguments... 23 Argument Values... 23 Common License Activation Errors... 25 Upgrading Metascan...26 Upgrading from Metascan 2.7 or earlier...26 Upgrading from Metascan 2.3 or earlier...26 Checking your Metascan License... 27 3
4
Metascan Installation Packages Metascan is available in five packages with different embedded anti-malware engines. Package Metascan Zero Metascan 4 Embedded anti-malware engines No embedded engine Total Defense, ESET, Norman, ClamWin Metascan 8 Everything in Metascan 4 PLUS AVG, Quick Heal, GFI, VirusBuster AND URL Filtering Metascan 12 Everything in Metascan 8 PLUS Bitdefender, K7, nprotect, Zillya Metascan 16 Everything in Metascan 12 PLUS Avira, F-Prot, Emsisoft, Virusblokada In addition to the standard Metascan installation there are optional components which can be installed based on your needs. Optional Components RAM drive Documentation Installs a copy of Metascan documentation on your local drive. All of the latest documentation is always available at http://portal.opswat.com. Metascan MMC Snap-in (Microsoft Management Console 3.0) REST Server Note: Sample integration code, documentation, and other useful utilities are available at http://portal.opswat.com 5
Before Installing Metascan Please confirm that your system meets the minimum requirements listed below before installing Metascan. System Requirements for Metascan Operating System: Windows XP / 2003 / Vista / 2008 / 7 / 2008 R2 Windows Installer 3.0 or higher (included by default in Windows XP SP2 and later) The standard Metascan packages require the following amounts of RAM and free hard drive space Package System RAM Free Hard Drive Space Metascan Zero 2 GB 2 GB Metascan 4 4 GB 4 GB Metascan 8 4 GB 4 GB Metascan 12 8 GB 8 GB Metascan 16 8 GB 8 GB Additional System Requirements for Metascan MMC Integration.NET 2.0 or newer Microsoft Management Console (MMC) 3.0 or newer Microsoft SQL Server Native Client (only required if logging to Microsoft SQL Server) o Please download an appropriate package for your Microsoft SQL Server version at http://msdn.microsoft.com/en-us/data/aa937733.aspx Additional System Requirements for Metascan REST Server IIS 5 or newer IIS ASP.NET Extension.NET 3.5 6
Installing Metascan All of the Metascan packages listed above can be installed in two ways: 1) Windows Install Wizard 2) Command Line Note: OPSWAT recommends installing Metascan with Administrator privileges. Installing Metascan Using the Install Wizard To install Metascan using the Install, follow the steps listed here: 1. Locate the Metascan Installation File, downloaded from http://portal.opswat.com or provided to you by OPSWAT. This file will be named Metascan_<X>_v<Y>_<Z>.msi where <X> is the Metascan package you are installing, <Y> is the version of Metascan, and <Z> is the build number. 2. Double-click on the Metascan Installation File to launch the Metascan installer 3. Follow the on-screen instructions a. Choose install directory [we recommend that you accept the default location] b. Uncheck / check optional components which you would like removed / added from the installation Installing Metascan from the Command Line Note: Installing Metascan from the command line requires Windows Installer 3.0 or higher The Metascan installer is an MSI package. Installing Metascan from the command line uses msiexec.exe, which is available with all Windows operating systems. 7
Command Line Options The following command line options are available with Metascan. Note: The packages column indicates which Metascan package(s) each command line switch is available for; Zero, 4,8,12,16, ALL. Note: All arguments are case sensitive. Command Line Description Example Packages Option /i Install Metascan msiexec.exe /i c:\metascan.msi ALL /x Uninstall Metascan msiexec.exe /x c:\metascan.msi ALL /l*<log-file-name> /l*v <log-file-name> /qn INSTALLLOCATION=<i nstall-path> ADDLOCAL=<commaseparated-featurelist> INSTALLLEVEL=<num ber> Create installation log file Create verbose installation log file Run Metascan Installation silently Sets the installation location for Metascan Install selected features only. Please see table below for list of features. The ClamWin engine is not installed by default. To install ClamWin, specify an INSTALLLEVEL of 1000 msiexec.exe /i c:\metascan.msi /l* c:\omsinst.log msiexec.exe /i c:\metascan.msi /l*v c:\omsinst.log msiexec.exe /i c:\metascan.msi /qn or msiexec.exe /x c:\metascan.msi /qn msiexec.exe /i c:\metascan.msi INSTALLLOCATION="c:\Metascan" msiexec.exe /i c:\metascan.msi ADDLOCAL="RamdrvSupport,MmcSupport,Ese teng,caeng" Msiexec.exe /i c:\metascan.msi INSTALLLEVEL=1000 ALL ALL ALL ALL ALL ALL 8
Note: All feature names below are case-sensitive. Feature Name Description Packages RamdrvSupport RAM Drive ALL MmcSupport MMC Snap-in ALL RestSvc Metascan REST Server ALL Docs Documentation ALL EsetEng ESET scan engine 4, 8, 12, 16 CaEng Total Defense scan engine 4, 8, 12, 16 NormanEng Norman scan engine 4, 8, 12, 16 ClamwinEng ClamWin scan engine 4, 8, 12, 16 AvgEng AVG scan engine 8, 12, 16 SunbeltEng GFI scan engine 8, 12, 16 QuickhealEng Quick Heal scan engine 8, 12, 16 VirusbusterEng VirusBuster scan engine 8, 12, 16 BitDefenderEng BitDefender scan engine 12, 16 IncaEng nprotect scan engine 12, 16 K7Eng K7 scan engine 12, 16 VirusBlokAdaEng VirusBlokAda scan engine 12, 16 AviraEng Avira scan engine 16 EmsisoftEng Emsisoft scan engine 16 FriskEng F-Prot scan engine 16 ZillyaEng Zillya scan engine 16 9
Activating Metascan Licenses Note: This section only applies to serial key-based licenses. If you have NOT received a serial key from OPSWAT and have an older form of licensing, please contact accounting@opswat.com. All Metascan packages come with a 30-day evaluation license. Once the evaluation period starts, uninstalling and installing Metascan will NOT extend the evaluation license. Note: Metascan licenses are strongly bound to the Volume ID, MAC address and NetBIOS name of the computer. Changing any of these attributes will disable Metascan, even if you have not yet activated Metascan with a license. If one of these values has changed, please contact support at support@opswat.com to receive a new license. Note: Metascan licenses can be purchased at: http://www.opswat.com/products/metascan/metascan-package-options Activation Options Metascan can be activated in two ways: 1) Online Activation Metascan can be activated online if the Metascan server is connected to the Internet. 2) Offline Activation If the Metascan Server is not connected to the Internet Metascan can be activated offline through the OPSWAT Activation Portal. Online activation of license Note: Non-serial key based licenses do not support online activation. Refer to the Legacy License section. Note: The Metascan Server must be connected to the Internet for Online Activation The following are required for online activation: o A Metascan Server 10
o A serial key that matches the Metascan package installed on that Metascan Server. Metascan licenses can only be used with the package for which they were created (Zero, 4, 8, 12, 16 and Custom). For example, a serial key for Metascan 4 will not work with Metascan 8. Metascan licensing changed with the release of Metascan 3.6. If you are upgrading to Metascan version 3.6 from an older version you must get a new license key. Contact sales@opswat.com for assistance. You can use the following methods for online license activation. o The Metascan Management Console (MMC) included with the Metascan installation o The Command Line Interface (CLI) License Manager Online activation of licenses using the Metascan Management Console The Metascan Management Console is installed by default and can be launched from the Start menu. 11
1. In the Metascan Management console, click on the Metascan Server name to check the current license information 2. Click on the Activate License link 12
3. In the resulting dialog, enter the Metascan license key. Once you have entered a valid license key, enter the e-mail address and company for that license. 4. Click on the Activate button and confirm your license activation in the following dialog. 13
5. Confirm that the license activation was successful and then close the License Activation dialog by clicking the Close button. If the license has been successfully activated, the message below will be displayed. If the MMC is unable to contact the license server, please check to make sure you are connected to the Internet. If problems persist contact support@opswat.com. 6. Confirm that the expiration date now shown in the MMC matches your Metascan contract. 14
Online activation of licenses with CLI License Manager 1. Open a Command Prompt Start -> Run -> CMD 2. Change the working directory to the Metascan install directory cd <Metascan install dir> e.g., cd c:\program Files (x86)\opswat\metascan Ultra 15
3. Verify that your installation of Metascan is NOT already activated. omslicmgrcli.exe checklicense [package] e.g., omslicmgrcli.exe checklicense ultra 4. Activate license omslicmgrcli.exe activateonline <license key> <email> <company> [package] 5. After Metascan activation completes successfully, the updated license status will be displayed. Verify that the license status listed is Activated and that the expiration date matches the expiration date on your Metascan contract. 16
Note: If online activation is not successful, check to ensure the Metascan Server s Internet connection is working. If online activation is still unsuccessful, follow the steps for offline activation below. Offline Activation with the OPSWAT Activation Portal The following are required for offline activation: o A Metascan Server o A serial key that matches the Metascan package installed on that Metascan Server. Metascan licenses can only be used with the package for which they were created (Zero, 4, 8, 12, 16 and Custom). For example, a serial key for Metascan 4 will not work with Metascan 8. Metascan licensing changed with the release of Metascan 3.6. If you are upgrading to Metascan version 3.6 from an older version you must get a new license key. Contact sales@opswat.com for assistance. You can use the following methods for offline license activation. o The Metascan Management Console (MMC) included with the Metascan installation o The Command Line Interface (CLI) License Manager 17
Offline Activation through the Metascan Management Console The Metascan Management Console is installed by default and can be launched from the Start menu. 1. In the Metascan Management console, click on the Metascan Server name to check the current license information 7. Click on the Activate License link 18
1. Select the Offline Activation tab and note the Install Code, which is needed to obtain the unlock keys. 2. To obtain the unlock keys, visit the Metascan offline activation portal at https://portal.opswat.com/activate_v3_6. Note: For Metascan version 3.5 or earlier, go to https://portal.opswat.com/manuallicense-activation to obtain the unlock keys. 3. Enter your company name and other contact information 4. Enter your serial key and Install Code 19
5. Click Request Unlock Key, which will forward you to a result page with 2 unlock keys. 6. Enter the license key and unlock keys in the dialog box along with the company name. 20
7. Click the Activate button and confirm 8. Confirm the activation was successful 21
9. Confirm that the license expiration date in the MMC has been updated and matches your Metascan contract 22
License Manager CLI The Command Line Interface of the License Manager can be used to apply, update, or activate a Metascan license as well as to check the license status of Metascan or Remote Clients. This tool (omslicmgrcli.exe) is installed in the Metascan installation directory. License Manager CLI Commands and Arguments Command Arguments Description help Display each available command and its parameters checklicense [package] Retrieve license status installcode activateonline activateoffline finishactivation <serial key> <email> <company> [package] <serial key> <company> <unlock key> <unlock key2> <package> <unlock key> <unlock key2> [package] Retrieve Install Code which is required for generating unlock keys in order to activate offline. Activate license with a serial key through the Internet. The Metascan Server where the license is being activated must have an Internet connection. Activate license on a Metascan Server without a direct connection to the Internet. This command requires a serial key and 2 unlock keys. Obtain the two unlock keys following the steps in the section, Offline Activation using the OPSWAT Activation Portal Finish activation if the license status is Activation Required Argument Values Arguments Value Description [package] zero 4 8 12 16 Optional parameter, if not specified, package of the currently installed Metascan service will be used. Zero: Metascan Zero 4:Metascan 4 23
8: Metascan 8 12:Metascan 12 16: Metascan 16 <serial key> <email> <company> <unlock key> <unlock key2> Serial number consisting of 6 blocks of 5 characters E-mail address Name of company who owns the license Serial number consisting of 6 blocks of 5 characters The Serial Number is your proof of purchase. It is unique and will look like this. do8uc-g1ic9-jogea-bqgex-u71ld-0v1vx Although the serial key and unlock key have the same format, their properties are completely different. You must not mix them up and should keep them separate. An e-mail address of the contact who is responsible for Metascan licenses. e.g. myemail@yourcompany.com Used for the company property in Metascan Keys tied to a unique machine and serial key. These are obtained from OPSWAT through phone, email, or the web activation portal for offline activation. 24
Common License Activation Errors The following are common errors encountered during activation and their potential causes. Error Possible Causes Notes INVALID KEY invalid unlock keys No internet connectio n Other An unrecognized serial key was entered An unrecognized unlock key was entered Metascan is unable to connect to the Metascan license server In cases of other errors, an error code will be displayed along with this message. e.g., A serial key is specific to the type of Metascan package. For example, a serial key for Metascan 4 cannot be used for Metascan 8 or 12. Unlock keys are tied to a specific serial key and machine where the Install Code was generated. Using an unlock key on a different system, or with a different serial key will result in this error. Check your Internet connection or follow the steps for offline activation Please contact OPSWAT support (support@opswat.com ) with the error code. 25
Upgrading Metascan Upgrading from Metascan 2.7 or earlier 1) Export configuration settings omsconfig.exe export <absolute path to a file which stores the configuration> /all 2) Uninstall Metascan 3) Reboot your system (Required only if you had RAM Drive installed). 4) Run the Metascan installer for the version you are upgrading to 5) Once installation is complete, import the file from step 1 with the following command. omsconfig.exe import <file generated in step 1> /all NOTE: omsconfig.exe is installed in the Metascan Installation directory (e.g., c:\program files(x86)\opswat\metascan 8) Upgrading from Metascan 2.3 or earlier Metascan 2.3 and earlier versions used a different licensing mechanism that is not supported in Metascan 3.6. To obtain a new license key that will work with Metascan 3.6, please contact support@opswat.com. 26
Checking your Metascan License The licensing status of a Metascan Server can be checked through either the Metascan Management Console or through the License Manager Command Line Interface. Instructions Metascan MMC License Manager CLI License information is displayed on the Licensespage, which can be visited by expanding the computer name under Metascan on the left bar of the console. omslicmgrcli.exe checklicense 27