Command line parameters used by Setup.exe

  • N°Id de l'article : 12570
  • Mis à jour : 04 sept. 2014

This article provides information that applies to Sophos installations on either physical or virtual systems.

Important:
Endpoint Security and Control 10.0.4 makes use of two setup files, both of which have the name setup.exe. One of these files is used for the installation of the Sophos Anti-Virus, the other is used for the installation of the encryption agent.

It is important that you correctly distinguish between the two setup files used with Endpoint Security and Control 10.0.4.

  • Part 1 of this article applies to the setup.exe file relating to the installation of Sophos Anti-Virus  
  • Part 2 of this article applies to the setup.exe file relating to the installation of the encryption agent (only available in v 10.0.4).

Known to apply to the following Sophos product(s) and version(s)

Sophos Endpoint Security and Control 9.7
Sophos Endpoint Security and Control 10.0.4
Sophos Endpoint Security and Control 10.0
Sophos Endpoint Security 9.7

For Sophos installations that are running on a physical (i.e. non-virtual) machine or system:

You can perform customized installations of endpoint software (Sophos Anti-Virus, Sophos Remote Management System and Sophos Client Firewall) on Windows computers by running the setup.exe program from a command line. This allows you to deploy endpoint software to your network using a startup script and the installation method of your choice, as well as invoking some of the special features described below.

For Sophos products installed on a virtual machine or system:

You can embed an installation of endpoint software on Windows computers by running the setup.exe program from a command line. This allows you to deploy to your network using a startup script. This will ensure that when you create a new virtual machine from the template library that it installs the specified anti-virus software, helping you ensure that all new virtual machines are properly protected.

See also Best Practice guide to running Sophos on virtual systems

Part 1. Command line parameters for using with the setup.exe file that relates to Endpoint Protection (excluding the encryption agent)

Location

By default, setup.exe is located in the root directory of each update location.  In Enterprise Console or Enterprise Manager, this is at \\servername\Sophos Update\CIDs\Sxxx\[package name]

NOTE: The Setup.exe file in the update location can be used with command line parameters.   The Setup.exe file version that comes with the standalone installer package of Sophos Endpoint Security does not support extra parameters.

Command line parameters:

Example: SETUP [-mng yes|no] [-scf] [-crt R] [-updp <path>] [-user <username>] [-pwd <password>] [-mngcfg <RMS config path>] [-compname <computername>] [-compdesc <computerdescription>] [-domain <domainname>] [-G <groupname>] -s -ni -?

Parameter Default Description
-mng yes|no yes Is the computer to be managed?
-scf
Install Sophos Client Firewall (Windows 2000+)
-patch http://<MANAGEMENTSERVERADDRESS>
Installs Sophos Patch agent and specifies the address of the Sophos management server.  Only available with version 10+.
 -patch http://<MANAGEMENTSERVERADDRESS>:<PORT>  no  Installs Sophos Patch agent, specifies the address of the Sophos management server and a custom port number. Only available with version 10+
-crt R
Removes third-party security software automatically
-updp <path> <location of setup.exe> Location of the primary CID from where the computer will get its updates.
-user <username> blank Account for accessing the primary CID location.
-pwd <password> blank Password for the above account.
-ouser <username>
Obfuscated account name for accessing the CID location, if required.
-opwd <password>
Obfuscated password.
-mngcfg <RMS config path> <location of Setup.exe> Location of the RMS configuration files.
-compname <computername>

Specify a computer name to override the one used in Windows. This name will appear in Enterprise Console.

Notes:

  • The name must be shorter than 31 characters.
  • If you would like to include a space, it must be enclosed in "double quotes".
  • Japanese characters are not supported.
-compdesc <computerdescription>

Specify a computer description to override the one used in Windows. This description will appear in Enterprise Console.

Note:

  • Japanese characters are not supported.
-domain <domainname>
Specify a domainname to override that on the client. This name will appear in Enterprise Console/ Manager.

Note:

  • Japanese characters are not supported.
-G "\<nameofserver>\<Groupname>"

Specifies the group (set up in Enterprise Console/ Manager) to which the computer will belong.

The path:

  • is case sensitive
  • must not end in a backslash
  • must include the management server
  • must be enclosed in "double quotes" if switches (backslashes) are used

Example:

"\[SecServerName]\TopLevelGroup\Group"

-rlogin
Start reinstallalation on Windows 95/98/Me computers from login scripts.
-login
Start installation on Windows 95/98/Me computers from login scripts.
-s No Perform installation silently.
-ni No Perform a non-interactive installation.
-?
Display command line parameter help.

Setup.exe can return one of the following values:

Value Description
0 Installation was successful.
1 A command line parameter value is missing or an unrecognized parameter was specified.
2 Verification of the AutoUpdate package failed. The package files did not match the manifest.
3 AutoUpdate was already installed.
4 AutoUpdate does not support this operating system.
5 AutoUpdate requires Internet Explorer 5.0 or above; the system does not have this version of IE.
6 Installation of AutoUpdate failed.
7 Some file that was required could not be found e.g. an RMS configuration file or Sophos AutoUpdate.msi
99 Some other error occurred.

Note: If you run an unknown parameter, the following error message will be displayed:

Setup
Could not find resource string 122
If you do not click 'OK', this message will close automatically after 60 seconds.

Setup.exe requires a directory named 'sau' to exist in the same directory as itself. This directory must contain a valid Sophos AutoUpdate package including manifest.dat (required by setup.exe) and cidsync.upd (required by the AutoUpdate installation).

Setup.exe creates the file 'Sophos ES setup.log' in the %TEMP% directory of each installed computer, where information and errors are logged. Information generated by the Windows Installer during the installation of AutoUpdate is also logged here. Each time setup is run, any previous log file is deleted.

Example usage

The following table shows a few examples on how to construct a command line installation of Sophos endpoint security software.

I want to... Command
Display the usage options... setup.exe -?
Install the basic endpoint software and manage the client (install the Remote Management System component; install the firewall; detect and remove 3rd party security software; update from "myServer"; obfuscate the credentials... setup.exe -mng yes -scf -crt R -updp \\myServer\Sophos\CIDs\S000\savscfxp\ -ouser SIhvF6vRtcGyG0mpJWdvIAc=  
 -opwd EIhvI6vRtcEyG0mpKWdvIAc= -s -ni
Same as above but also install the Sophos Patch agent (only available with version 10+)... setup.exe -mng yes -scf -crt R -updp \\myServer\Sophos\CIDs\S000\savscfxp\ -ouser SIhvF6vRtcGyG0mpJWdvIAc= 
 -opwd EIhvI6vRtcEyG0mpKWdvIAc= -s -ni -patch http://myServer/

 

Part 2. Command line parameters for using with the setup.exe file that relates to the encryption agent

Enterprise Console 5.1+ makes use of two setup files, both of which have the name setup.exe. One of these files is used for the installation of the encryption agent, the other is used for the installation of Sophos Anti-Virus.

Parameter Description
/q Quiet mode (i.e. non-interactive, as if being deployed from SEC: The reboot dialog still appears)
/b Build only (copies and reassembles the MSIs (but *not* the poacfg file) into the ‘destination’ path (see below), then stops. Does not make any compatibility checks. This is primarily used by part of the build process, but could be used to manually retrieve the compound MSI.)
/3 Assume 32-bit MSI is to be used
/6 Assume 64-bit MSI is to be used
/s [path] Override source path (defaults to /encclient/.)
/d [path] Override ‘destination’ path (defaults to [D&S/All Users/Application Data]/Sophos/Sophos Safeguard Installers/staging/.)
/f [path] Override ‘final’ path (defaults to D&S/All Users/Application Data>/Sophos/Sophos Safeguard Installers/InstallCache/.)
/ncd Bypass the Competitor Detection step
/migfile [file] A migration file that is required for the migration of Sophos Disk Encryption 4.x / SafeGuard Easy 4.x to Sophos Disk Encryption 5.61
/ioar Ignore Opal Authority check results

thank you for the feedback

 
Si vous avez besoin de plus d'informations ou d'instructions, veuillez contacter le support technique.

Évaluez cet article

Très mauvais Excellent

Commentaires