This article applies to:
- Trustwave MailMarshal SPE supported versions
Question:
- What is the safe method to upgrade MailMarshal SPE from an earlier version to the currently released version?
Procedure:
To upgrade SPE, the general procedure is to upgrade the Trustwave MailMarshal (SEG) servers first, then upgrade the SPE Marshal Interface Agent or console server and the SPE agents.
- Product names in the installers and interfaces depend on the product versions. MailMarshal SPE (Service Provider Edition) is also known as Trustwave SPE. Trustwave MailMarshal is also known as Trustwave SEG or MailMarshal SMTP.
- This article assumes you are familiar with SEG and SPE concepts.
- Before starting, review the Release Notes for the new version of SPE and SEG. Release Notes include version specific upgrade notes, such as previous version supported for direct upgrade.
The following steps are suggested to upgrade SPE safely and with minimal disruption to email flow.
- Stop all SPE services on all array managers and nodes (Depending on version this may include Marshal Agent, Replication Agent, Status Agent, Maintenance Agent, Reporting Agent).
- Stop the Web Console services on the IIS server (either by stopping the website in iisconfig, or by typing net stop w3svc).
- Take a snapshot of the SPE database.
- Stop the SEG Array Manager.
- Take a snapshot of the SEG database.
- Start the SEG Array Manager.
- To ensure ability to roll back, create a backup of the SEG configuration by running the MMExportCfg in the SEG directory (typically in SEG version 8.X: C:\Program Files\Trustwave\Secure Email Gateway)
- For instance: MMExportCfg MMBackupOct2008.xml
- For details of locations for earlier SEG versions, see article Q10832.
- For SEG 8.0 if DKIM is in use, also ensure you have exported DKIM keys. They are not included in SEG 8.0 backups.
- Upgrade the array manager with the supported version of SEG software. This will upgrade your configuration from the earlier version.
- Upgrade the nodes with the SEG software.
- At this point you will have a fully working SEG solution running on the new software. Take a configuration backup (as in step 7) and a snapshot of the SEG database.
- Repeat steps 4-9 for each SEG array.
- Start your IIS server.
- Upgrade the Web Console and/or MIA server: run the SPE installer and upgrade the web console and Marshal Interface Agent (Maintenance Agent in earlier versions). The database wizard will also run and upgrade your SPE database.
- When the installer and database wizard completes successfully, log into the SPE console and make sure the configuration appears correct. Arrays will not be connected at this stage.
- Run the SPE installer on all Array Managers to upgrade the Replication Agent or Marshal Agent (depending on version).
- Force a configuration reload on the SPE web console (Arrays->Force Reload).
- Monitor the Array Manager logs for any errors. If you encounter any problems, stop and disable the SPE agent on the Array Manager (Marshal Agent for 3.8 and above, Replication Agent for earlier versions). Restore the SEG configuration (from the backup you took in step 7 above), and restart the Array Manager. You will not need to restore the SQL database. Do not proceed further but contact Trustwave Technical Support for assistance.
- Upgrade the Marshal Agents on the nodes.
- If upgrading to a version below 3.6, upgrade the reporting agent. (3.6 and above does not use a separate reporting agent.)
- Restore any custom branding. The upgrade creates a dated backup of the website directory, including the branding subdirectory. Move required items to the production website\branding folder.
- If you use custom themes for the Customer Console or SQM, you may need to update the themes to cover new features. See the linked article below for more information.
- Release 4.0 includes breaking changes to the SQM login page.
- Release 3.6.2 includes significant changes in the Customer Console themes from 3.6.1.
Notes:
For some versions, the Release Notes recommend stopping all Marshal services including all SEG services during upgrade. This recommendation was to ensure that some settings are updated when services start. Normally you can follow the steps above and SEG services can remain running during the SPE upgrade.
For upgrade from SEG 8.0 or below with DKIM keys, in the rare case that you must roll back the SEG upgrade, you might need to re-import DKIM keys on the nodes. Contact Trustwave for assistance.
