This document provides instructions to deploy the Mimecast Security Agent (MSA) on roaming Windows PCs, to work in conjunction with the Mimecast Web Security feature. In addition, it covers how to:
- Validate the agent installation.
- Test policy blocking.
- Enable / disable the agent.
To use the Mimecast Security Agent, you must have:
Mimecast Security Agent 1.2 and newer is certified for 'Citrix Virtual Apps and Desktop' v7 in persistent and non-persistent desktop configurations.
|Supported Windows Version||Edition||Bit|
Home edition of Windows isn't supported as it doesn't support enterprise features of MSMQ, resulting in the failure.
Optionally we recommend the following:
- Configuring an exception for your local domain. Unlike using DNS forwarders, when MSA is installed, all DNS traffic is sent to Mimecast bypassing any local DNS configuration (i.e. IP phones, print servers). See the Managing Exceptions page for further information.
- Configuring your Mimecast Security Agent Settings. See the Mimecast Security Agent Settings page for further information.
- We recommend your browser uses Windows Trust Store for Certificate of Authority. If using Firefox, set it to use the Windows Trust Store by:
- Typing about:config in the address bar.
- Creating a Boolean Variable called "security.enterprise_roots.enabled".
- Setting the "security.enterprise_roots.enabled" variable to True.
Installing the Mimecast Security Agent on Standalone Windows PC
To install the MSA on a Windows PC:
- Log on to the Administration Console.
- Click on the Administration menu item. A drop down menu is displayed.
- Click on the Web Security | Agent Settings menu item. The Mimecast Security Agent "Installation" tab displays by default.
- Click on the Download for PC button. The installer files download to your browser's download location with a file name of "Mimecast Security Agent.ZIP". The .ZIP package contains both 32bit and 64bit MSI files, with the key located in a "Mimecast Security Agent Configuration" folder.There can be a significant delay before the browser indicates the file download is complete.
- Copy the Mimecast Security Agent installer and the CustomerKey file to the target roaming system to be protected.
- Start the Mimecast Security Agent Installer. The installer must be run as an administrator.
- Click on the Next button to continue.
- Select the CustomerKey License File that was part of the MSI download by either:
- Clicking on the Browse button.
- Copying the CustomerKey in the file separately and paste it into the Browse box.
- Click on the Next button once the authentication key has loaded.
- Select the Installation Folder into which the Mimecast Security Agent will be installed.
- Click on the Next button. The Mimecast Security Agent installation starts.
- Click on the Yes button to confirm that the installation can continue.
- Click on the Finish button to exit the installer.
- Select Yes when prompted to restart your computer. The Mimecast Security Agent is started on the system reboot, with the agent icon appearing in the Windows system tray.
Silently Installing the Mimecast Security Agent
The command listed below can be used to silently install the Mimecast Security Agent, create a verbose install log, and inject the CustomerKey:
msiexec /i "<MSI_PATH>" /qn /l*v <LOG_PATH> licensefile="<CUSTOMER_KEY_PATH>"
- <MSI_PATH> is the location of the MSI file.
- <LOG_PATH> is the location where you want the log file created.
- <CUSTOMER_KEY_PATH> is the location of your customer key.
Validating the Mimecast Security Agent Installation
After restarting the system, verify that the MSA has been installed correctly via the methods below. If any errors display, gather and send diagnostics data as outlined in the Mimecast Security Agent Diagnostic Data page.
To confirm the MSA User Interface is running:
- Check that the MSA icon is displayed in the Windows taskbar system tray.
- Click on the MSA icon to launch the home screen. Ensure the following:
- A green tick displays on the Mimecast shield.
- The status is ‘Protected’.
- The 'Client ID' shows the machine name.
- The 'Last sync’ time displays.
Checking the MSA Diagnostics
To check the MSA diagnostics:
Click on the Diagnostics tab.
- Click on the Show Live Diagnostics button.
- Check that all the basic diagnostics checklist ticks display green.
- Click the Refresh button a few times and confirm that the Diagnostics Last update display times increment as expected.
- Check that the Additional information details contain valid entries for:
- DNS Redirecting
- DNS Server IPs
- API Discovered grid
- API Account Code
- Click on the Display the Certificate link next to DNS Root certificate. This displays the Windows Certificate dialog and allows you to confirm the root certificate has been correctly deployed.
- Click on the Display the Certificate link next to DNS TLS certificate. This displays the Windows Certificate dialog for the Mimecast Endpoint Certificate.
- Return to the Mimecast Security Agent Diagnostics console and select Advanced Diagnostics.
- Scroll down to the Mimecast.Dns section and confirm there is an entry for "Redirected Query 1".
Once the Mimecast Security Agent is installed, you can test it is working by:
- Creating a Block or Allow List Policy to:
- Block a legitimate site (e.g. cnn.com). This avoids visiting a site that has been blocked by your IT administrator.
- Apply the policy to a user or group. This ensures it takes precedence over a location or "everyone" policy.
- Either getting the user to:
- Manually log in to the MSA.
- Use the transparent user Id to identify domain users.
See the Mimecast Security Agent Policy Testing page for details.