Mimecast Synchronization Engine: Unstub utility

Document created by user.oxriBaJeN4 Employee on Oct 2, 2015Last modified by user.oxriBaJeN4 Employee on Aug 12, 2016
Version 2Show Document
  • View in full screen mode

The Unstub utility is available with the Mimecast Synchronization Engine and works against a previously stubbed mailbox (or mailboxes) to restore the stubbed content and attachments. Stubbed content is retrieved from the Mimecast archive and restored to the original Exchange mailbox.

 

Packaging

 

The utility is package with the Mimecast Synchronization Engine and requires version 2.7.6 or later.

 

Prerequisites

 

The Unstub utility is run from the command prompt and must be run under the Windows identity of an account with permission to access the Exchange mailboxes to be unstubbed, this could be the service account that runs the primary Mimecast Synchronization Engine service.

 

For details on configuring this please see the [LEGACY] Preparing for Exchange Services article.

 

Either logon to the MSE server using this account to run consoletools.exe or use the Windows runas.exe utility to open a command prompt window under this identity. For example,

 

runas /user:DOMAIN\serviceaccount cmd.exe

 

If consoletools.exe is not run under the identity of an account with the required permissions the unstubbing job will display an error, for example:

 

running as DOMAIN\normaluser
console tools application terminated with an expected problem finished

 

The utility will be retrieving message content from the Mimecast archive. Consequently the credentials for a Mimecast Super Admin are required when running the utility.

 

See the Understanding Administrator Roles article for more details.

 

Running an Unstubbing Job

 

Unlike other Mimecast Synchronization Engine features unstubbing is not configured using the Administration Console, these jobs can only be run using the consoletools.exe utility. To run an unstubbing job follow these steps:

 

  1. On a server where the Mimecast Synchronization Engine is installed launch a Windows Command Prompt as a user with access to the Exchange mailboxes that will be processed by the job.
  2. Using the "cd" command, navigate to the %installdir%\Mimecast\Synchronisation Engine\bin directory.
  3. Issue this command:
    consoletools.exe [accountcode] unstub mailbox1
    Where mailbox1 is the primary SMTP address associated to that mailbox
  4. Press Enter to start the job.
    1. To run the utility against more than one mailbox at a time add the primary SMTP addresses of the target mailboxes as a space separated list, for example
      consoletools.exe [accountcode] unstub user1@domain.com user2@domain.com user3@domain.com
    2. Mailboxes are processed sequentially as entered into the command to start the utility.
  5. At the username prompt enter the primary email address of a Mimecast Super Admin and press Enter. This does not have be the same user identity that is running the consoletools.exe application locally.
  6. Enter the password for the Super admin account.
    1. If domain authentication with Mimecast is enabled for the Super Admin either a Mimecast Cloud or Active Directory password can be used.
    2. If domain authentication is not enabled for the Super Admin use a Mimecast Cloud password.
    3. If using an Active Directory password containing extended ascii characters customers may experiencing issues properly unstubbing messages, in this instance please use a password without these characters.
  7. Once the Super Admin credentials have been entered the utility will start with the first listed mailbox.

 

Output and monitoring progress

 

On-screen

During the execution of an unstubbing job, consoletools.exe displays the following to the user:

unstub_output.png

This includes,

  • The currently processing mailbox (with the total number of mailboxes and the position of this mailbox in the queue)
  • The currently processing folder (with position and total)
  • The position and total of the currently processing item within this folder
  • The total number of items unstubbed to this point (with the total size of these items before unstubbing and after unstubbing and the total amount of mailbox expansion that this represents)

 

Logs

The location of the detailed execution log that the unstubbing job will create is displayed in the command console as the job starts (see above). By default this location is the log folder used by the MSE service, under the subfolder consoletools.

 

Reports

The unstubbing job also creates a comma separated values (CSV) report in the same location as the detailed log. This CSV report lists messages that could not be successfully stubbed along with a detailed error.

Attachments

    Outcomes