Windows Installer (.msi) command-line reference for Symantec Client Security 2.0

Article:TECH100559  |  Created: 2004-01-18  |  Updated: 2005-01-15  |  Article URL http://www.symantec.com/docs/TECH100559
Article Type
Technical Solution


Environment

Issue



You want to create a customized Symantec Client Security 2.0 installation package using the Windows Installer.


Solution



Installing Symantec Client Security using command-line parameters
The Symantec Client Security client and server installation programs use Windows Installer (.msi) packages for installation and deployment. If you are using the command line to install or deploy an installation package, you can use the standard Windows Installer switches and Symantec-specific parameters to customize the installation.

For more information on using the standard Windows Installer commands, see the documents provided by Microsoft. For help with deploying a customized installation package using third-party deployment tools such as SMS or Tivoli, see the documentation that is provided with the deployment tool.

Default Symantec Client Security client installation
The default Symantec Client Security client installation package includes the following installation components:
  • Symantec Client Security client base files (including the user interface) are installed.
  • Symantec Client Security client base files (including the user interface) are installed, including the Symantec Client Security firewall client with Ad Blocking enabled.
  • Symantec Client Security Help files are installed.
  • Auto-Protect Email Snap-Ins (including Microsoft Exchange, Lotus Notes, and Internet Email) are installed and enabled if the corresponding Microsoft Exchange, Outlook, or Lotus Notes clients are detected. The Internet Email Snap-In is installed by default.
  • Symantec Quarantine client files are installed.
  • LiveUpdate is installed and updated virus definitions files are downloaded from the Symantec Web site (if the client is connected to the Internet).
The default Symantec Client Security client installation package includes the following installation settings:
  • The client is installed as an unmanaged client.
  • Computer restart is required.
  • Auto-Protect is enabled after the computer is restarted.

The default Symantec Client Security installation package requires the installation of both the Symantec Client Security AntiVirus client and the Symantec Client Security firewall client. To install the stand-alone Symantec Client Security AntiVirus client (without the Symantec Client Security firewall client), use the installation files that are in the \SAV directory on the Symantec Client Security CD. Installing Symantec Client Security firewall client without Symantec Client Security AntiVirus client is not supported.

Default Symantec Client Security server installation
The default Symantec Client Security server installation package includes the following installation components:
  • Symantec Client Security server base files (including the user interface) are installed.
  • Symantec Client Security Help files are installed.
  • LiveUpdate is installed and updated virus definitions files are downloaded from the Symantec Web site (if the server is connected to the Internet).
  • The default Symantec Client Security server installation package includes the following installation settings:
  • Computer restart is required.
  • Auto-Protect is enabled after the computer is restarted.


Windows Installer commands and properties
The Symantec Client Security installation packages use the standard Windows Installer commands as well as a set of extensions for command-line installation and deployment. The following table describes the basic set of commands and properties that are used for Symantec Client Security client and server installations. See the Windows Installer documentation for further information on the usage of standard Windows Installer commands and properties.

Command or propertyDescription
Symantec Client Security.msiSymantec Client Security installation file.
MsiexecWindows Installer executable.
Symantec AntiVirus.msi Symantec Client Security installation file.
/iInstall the specified components.
/xUninstall the specified components.
/qnInstall silently.
/qbInclude the installation user interface.
/qrReduced User Interface. No modal dialog box appears at the end of the installation.
/qfFull User Interface. Authored FatalError, UserExit, or Exit modal dialog boxes appear at the end.
/qn+No User Interface except for a modal dialog box displayed at the end.
/qb+Basic User Interface with a modal dialog box displayed at the end. The modal box is not displayed if the user cancels the installation. Use qb+! or qb!+ to hide the Cancel button.
/qb-Basic User Interface with no modal dialog boxes. Please note that /qb+- is not a supported User Interface level. Use qb-! or qb!- to hide the Cancel button.
/qb!-Basic User Interface with progress bar but no modal dialog boxes.
/l*v Create a verbose log file, where is the name of the log file you want to create.
INSTALLDIR=Designate a custom path on the target computer where is the specified target directory. If the path includes spaces, use quotation marks.
REBOOT=Suppress a computer restart after installation, where is a valid argument. The valid arguments include the following:
    • Force: Requires that the computer is restarted
    • Suppress: Prevents most restarts
    • ReallySuppress: Prevents all restarts as part of the installation process
      Note: You cannot suppress a restart when you are performing a silent uninstallation of Symantec AntiVirus client or server.
ADDLOCAL= Select custom features to be installed, where is a specified component or list of components. If this property is not used, all applicable features are installed by default. When specifying a new feature to be installed, you must include the names of the features that are already installed on the target computer that you want to keep. If you do not specify the features that you want to keep, Windows Installer will remove them. Specifying existing features will not overwrite the installed features. To uninstall an existing feature, use the REMOVE command.
REMOVE=Uninstall the previously installed program or a specific feature from the installed program, where is one of the following:
    • : Uninstalls the feature or list of features from the target computer.
    • ALL: Uninstalls the program and all of the installed features. This is the default.


Note: The ! option is available with Microsoft Windows Installer 2.0 and works only with Basic User Interface. It is not a valid argument with the Full User Interface option.



Symantec Client Security properties
There are many Symantec Client Security properties that are used to customize Windows Installer installation packages.

Symantec Client Security server properties
The following table describes the properties that are configurable for the Symantec Client Security server installation.

Property Description
INSTALLSERVER=1 Specifies that the installation to be used is the server installation. A value of 0 indicates a client installation.
ENABLEAUTOPROTECT=Determines whether Auto-Protect is enabled after the installation is complete, where is one of the following values:
  • 1: This enables Auto-Protect after installation. This is the default setting.
  • : Any other integer value disables Auto-Protect after installation.
RUNLIVEUPDATE=Determines whether LiveUpdate is enabled as part of the installation, where is one of the following:
  • 1: This enables LiveUpdate after installation. This is the default setting.
  • : Any other integer value disables LiveUpdate after installation.
To use this property, Administrator or Power User privileges are required. If you attempt the installation without the correct privileges, the installation may fail without notice. LiveUpdate is a required component of the Symantec Client Security installation.
NETWORKTYPE=Describes the management state of the target computer when installation is complete, where is one of the following:
  • 1: Managed
  • 2: Unmanaged (default)
  • 4: Server
SERVERGROUPNAME=Specifies the name of the server group that the target server will join. You can create a new server group by using a unique server name.
SERVERGROUPPASS=Specifies the password of the server group that the target server will join.
INSTALLDIR=Specifies the installation directory on the target computer. The default directory is C:\Program Files\Symantec AntiVirus. If the path specified contains long file names, use quotation marks around it.


Symantec Client Security client properties
The following table describes the properties that are configurable for the Symantec Client Security client installation.

Property Description
ENABLEAUTOPROTECT=Determines whether Auto-Protect is enabled after the installation is complete, where is one of the following values:
  • 1: This enables Auto-Protect after installation. This is the default setting.
  • : Any other integer value disables Auto-Protect after installation.
RUNLIVEUPDATE=Determines whether LiveUpdate is enabled as part of the installation, where is one of the following:
  • 1: This enables LiveUpdate after installation. This is the default setting.
  • : Any other integer value disables LiveUpdate after installation.
To use this property, Administrator or Power User privileges are required. If you attempt the installation without the correct privileges, the installation may fail without notice. LiveUpdate is a required component of the Symantec Client Security installation.
NETWORKTYPE=Describes the management state of the target computer when installation is complete, where is one of the following:
  • 1: Managed
  • 2: Unmanaged
  • 4: Server
SERVERNAME=Specifies the name of the pre-existing server that manages the target computer.
INSTALLDIR= Specifies the installation directory on the target computer. The default directory is C:\Program Files\Symantec AntiVirus. If the path specified contains long file names, use quotation marks around it.


Symantec Client Security firewall client properties
The following table describes the properties that are configurable for the Symantec Client Security firewall client components.

Property Description
ENABLEAUTOPROTECT=Determines whether Auto-Protect is enabled after the installation is complete, where is one of the following values:
  • 1: This enables Auto-Protect after installation. This is the default setting.
  • : Any other integer value disables Auto-Protect after installation.
RUNLIVEUPDATE=Determines whether LiveUpdate is enabled as part of the installation, where is one of the following:
  • 1: This enables LiveUpdate after installation. This is the default setting.
  • : Any other integer value disables LiveUpdate after installation.
NETWORKTYPE=Describes the management state of the target computer when installation is complete, where is one of the following:
  • 1: Managed
  • 2: Unmanaged
  • 4: Server
SERVERNAME=Specifies the name of the pre-existing server that manages the target computer.


Symantec Client Security features
There are many Symantec Client Security features that can be installed using a customized Windows Installer package. These features are used by the Windows Installer ADDLOCAL property to specify the features that are installed.

Symantec Client Security server features
The following are the features that are configurable for the Symantec Client Security server installation.

Feature Description
SAVMain Specifies the basic Symantec Client Security client files. This feature is required.
SAVUI Makes the user interface available to the target computer.
SAVHelp Lets you include Symantec Client Security Help files.


Symantec Client Security AntiVirus client features
The following are the features that are configurable for the Symantec Client Security AntiVirus client components.

Feature Description
SAVMain Specifies the basic Symantec Client Security client files. This feature is required.
SAVUI Makes the user interface available to the target computer.
SAVHelp Lets you include Symantec Client Security Help files.
EMailTools Lets you include all Auto-Protect email components.
OutlookSnapin Lets you include the Microsoft Exchange Auto-Protect email component.
NotesSnapin Lets you include the Lotus Notes Auto-Protect email component.
Pop3Smtp Lets you include the Internet Email Auto-Protect component.
Pop3Smtp1 Lets you include the Internet Email Auto-Protect component.
QClient Lets you include the Symantec Quarantine client.


Note: To install the Internet Email Auto-Protect component, you must use both the Pop3Smtp parameter and the Pop3Smtp1 parameter. The Pop3Smtp1 parameter is available in Symantec AntiVirus 9.0.5 and later.
For details, read "Configure Internet Email Auto-Protect" has a blank configuration box after installing Symantec AntiVirus Corporate Edition 9 using custom MSI switches.



Symantec Client Security firewall client features
The following are the features that are configurable for the Symantec Client Security firewall client components. Installing firewall client components without the required AntiVirus client components is not supported.

Feature Description
SCFMain Specifies the basic Symantec Client Security firewall client files. This feature is required.
SCFHelp Lets you include Symantec Client Security firewall client Help files.
AntiSpam Used to configure the Ad Blocking component.


Using the log file to check for errors
The Windows Installer creates a log file that can be used to verify whether or not an installation was successful, list the components that were successfully installed, and provide a variety of further details related to the installation package. The log file can be used as an effective tool to troubleshoot an installation package that fails.

If the installation is successful, the log file includes a success entry near the end. If the installation is not successful, an entry is created that indicates that the installation failed. The log file (sav_inst.log) that is created by the default installation package (scs_inst.log) is added to the \temp directory associated with the user that is running (or deploying) the installation package. Each time the installation package is executed, the log file is overwritten. Appending an existing log file is not supported.

To identify the point of failure of an installation
You can use the log file to help identify the component or action that caused an installation to fail.
  1. In a text editor, open the log file that was generated by the installation.
  2. Search for "VALUE= 3" in the installation log file. The action that occurred before the line that contains this entry is most likely the action that caused the failure. The lines that appear after this entry are installation components that have been rolled back because the installation was unsuccessful.


Command-line examples
The following list includes some commonly used command-line examples.

Task 1
Silently install an unmanaged Symantec Client Security client with default settings to the C:\SFN directory. At a command prompt, type the following command:

msiexec/i "Symantec Client Security.msi" INSTALLDIR=C:\SFN /qn

Task 2
Silently install an unmanaged Symantec Client Security client with all of the default features except QClient. Do not restart the computer after installation, and do not enable Auto-Protect when the computer is (ultimately) restarted. At a command prompt, type the following command:

msiexec/i "Symantec Client Security.msi" ADDLOCAL=SAVMain,SAVUI,SAVHelp,EMailTools,OutlookSnapin,NotesSnapin,Pop3Smtp,Pop3Smtp1,SCFMain,SCFHelp,AntiSpam ENABLEAUTOPROTECT=0 RUNLIVEUPDATE=1 REBOOT=ReallySuppress /qn

Task 3
Silently install a managed Symantec Client Security client to the default path that is managed by the SR1 server with no Symantec AntiVirus Help, no Lotus Notes snap-in, and no Firewall Help. Do not run LiveUpdate, and do not restart the computer automatically. At a command prompt, type the following command:

msiexec/i "Symantec Client Security.msi" ADDLOCAL=SAVMain,SAVUI,SAVHelp,EMailTools,OutlookSnapin,Pop3Smtp,Pop3Smtp1,QClient,SCFMain,AntiSpam NETWORKTYPE=1 SERVERNAME=SR1 ENABLEAUTOPROTECT=1 RUNLIVEUPDATE=0 REBOOT=ReallySuppress /qn


Note: To install the Internet Email Auto-Protect component, you must use both the "Pop3Smtp" parameter and the "Pop3Smtp1" parameter. The Pop3Smtp1 parameter is available in Symantec AntiVirus 9.0.5 and later.
For details, read the document "Configure Internet Email Auto-Protect" has a blank configuration box after installing Symantec AntiVirus Corporate Edition 9 using custom MSI switches.






References
For a full list of MSI error codes, read the Microsoft Windows Installer Error Code page.



Technical Information
Note the section in the Msifaq.txt located in the \Docs directory included on the Symantec System Center 2.0 CD layout incorrectly defines the SERVERNAME= switch for Symantec System Center or Symantec AntiVirus client installations as the name of the server group. The note should actually read as follows:


NETWORKTYPE= (1 = Managed, 2 = Unmanaged, default is Unmanaged)
SERVERNAME= (preexisting SAV Server)



Legacy ID



2004021813253548


Article URL http://www.symantec.com/docs/TECH100559


Terms of use for this information are found in Legal Notices