Installing and removing patches for Messaging Gateway

Products

• Messaging Gateway

Issue/Introduction

This document provides a simplified guide for non-technical users on how to install and remove patches for Symantec Messaging Gateway (SMG). Patches are critical updates that improve system performance, fix bugs, and enhance security. Applying them ensures your SMG appliance remains robust and effective in protecting your email infrastructure.

Key Information to Consider

Before proceeding with any patch installation or removal, it's crucial to be aware of the following:

• Downtime: Patches can sometimes cause brief interruptions in email flow as services restart. It is advisable to perform these operations during off-peak hours or a scheduled maintenance window.
• Backup: While not strictly required for every patch, it's a good practice to ensure you have a recent configuration backup of your SMG appliance.
• Patch File Location: You will need to download the patch file from the Broadcom support portal. Ensure you have the correct file for your SMG version.
• Supported Patches: Only install patches officially released by Broadcom for your specific SMG version. Installing unsupported patches can lead to instability.

Resolution

Installing Patches

Installing a patch is a straightforward process through the SMG command line.

1. Log in to the SMG Command Line
   
   • Open your SSH client or the virtual machine console and log in using the admin account
2. List the available patches
   • patch list
3. Review the patch notes
   
   • patch -p <SMG_VERSION> notes
     (where <SMG_VERSION> is replaced with the patch number i.e. 10.6.3-267)
4. Download the patch
   • patch -p <SMG_VERSION> download
5. Run pre-update checks
   
   • patch -p <SMG_VERSION> check
6. Install patch
   
   • patch -p <SMG_VERSION> install
     Note: if the patch has not been dowloaded it will automatically download 
7. Verify patch
   
   • show --version

Removing Patches (Rollback)

In rare cases, you might need to remove a patch due to unforeseen issues. SMG provides a mechanism to roll back to the previous state.

1. Log in to the SMG Command Line
   
   • Open your SSH client or the virtual machine console and log in using the admin account
2. Remove installed patches
   • patch remove

Note: The patch remove command will remove all installed patches. At this time patches may not be removed individually.

Troubleshooting

If you encounter any issues during the patch installation or removal process:

• Check connectivity: Ensure your SMG appliance has stable network connectivity to the internet (for downloading patches) and your client machine (for uploading local patch files).
• Error messages: Note down any specific error messages displayed. These can be helpful when seeking support.
• Contact Support: If you are unable to resolve the issue, contact Broadcom technical support for assistance. Provide them with the SMG version, patch details, and any error messages you received.

Best Practices

• Regular Patching: Implement a schedule for regularly checking for and applying new patches to keep your SMG appliance up-to-date and secure.
• Test Environment (if applicable): If you have a test or staging environment, consider applying patches there first to identify any potential issues before deploying to production.
• Documentation: Keep a record of the patches installed and their installation dates for future reference.