Automated Mirror Break/Restore Utility

Files ******************************************************************
breakftm.exe
breakftm.pdf
breakftm.txt (readme)

Description  ***********************************************************

The automated mirror break/restore utility was designed to be used with 
the Windows NT40 Server Unattended Upgrade.  NT machines that have the 
system drive mirrored cannot be upgraded (the mirror must be broken 
before the upgrade).  Having a mirrored system drive will cause the NT40 
Unattended Upgrade to fail.  Breakftm is a simple tool that breaks the 
system mirror before the NT40 upgrade, and then recreates the mirror 
once the upgrade is finished.  Breakftm has no effect on machines that 
do not have a system mirror.

Breakftm should only be used with the NT40 Server Unattended Upgrade.  
If you wish to break or create a mirror manually, this can be done 
through the Disk Administrator in the NT Administration Tools (NT Server 
Version Only).

Breakftm is supported on NT 3.5, 3.51 and 4.0.


How to use this utility with SMS ***************************************

There are two setup variations for breakftm, that can be found the in 
the breakftm.pdf.  Break System Mirror and Recover System Mirror.  Break 
System Mirror should be scheduled immediately before the NT40 Server 
Upgrade.  Recover System Mirror should be scheduled immediately after 
the NT 40 Server Upgrade.  Breakftm will have no effect on non-mirrored 
systems so it can be safely used with any NT 40 Upgrade.



How to use this utility from the command line **************************

Breakftm can also be used directly from the command line.  Calling  
"breakftm /b"  from the command line will examine the system drive and 
break it if it is a mirror.  It will then cause a reboot.  Calling 
"breakftm /r" from the command line will try to recover the system 
mirror (if it was originally a mirror) and reboot.

For advanced command line options type "breakftm /?"


Some Important Information About the Mirror Break/Restore Utility ******

You should not have Disk Administrator running when using the breaftm
utility.

Breakftm can only be used to recover mirror that were broken by the 
utility.  Breakftm cannot recover mirrors that were broken manually.

Breakftm creates a hidden file called mirrorbk.dat in the Windows NT
system directory.  This file contains the original mirror information 
need to recover the mirror.  If this file is removed the mirror cannot 
be restored.

After the mirror is broken and the system has rebooted, the system drive 
will appear as a normal partition.  The shadow will have no drive letter 
assigned to it, but will still be visible from the Disk Administrator.  
If  an error occurs while recovering the mirror.  The mirror can be re-
established manually through the Disk Administrator.  To recreate the 
mirror manually, delete the shadow partition (the partition with no 
drive letter assigned) and use the free space to recreate the mirror.  See 
Disk Administrator help for more information.


Description of the Success and Error output ****************************

Success No Mirror to Break - The system partition is not a mirror,  
therefore it does not need to be broken

Success Mirror Broken - The system mirror has been broken successfully

Success Mirror Recovered - The system mirror was recovered successfully

Success There Was No Mirror To Recovered - The system partition was not 
a mirror originally, therefore it does not need to be recovered.  

Usage error in calling breakftm.exe - Usage error in calling breakftm 
from the command line.  See breakftm /? For usage.

Error occurred while parsing the Registry - Could not get the disk 
information out of the registry key.  The disk key in the registry may 
be corrupt, or missing.  Mirror not broken/recovered.  Break/recover 
mirror manually.

Error occurred while parsing the Partition Table - The information in 
the partition table was not what was expected.  Mirror not 
broken/recovered.  Break/recover mirror manually.

Drive Letter <> was invalid - The drive letter specified is not valid, 
or the system drive letter is incorrect.  Mirror not broken.  Make sure 
Drive Letter is a valid system partition and retry.

Unknown Registry Version - The disk registry key, is of a version not 
recognized by this utility.  Break mirror manually.

Drive Letter <> was not a Mirror or Simple Partition - Breakftm can only 
be used to break mirrors.  Verify that Drive Letter is a valid Mirror 
or Simple Partition and retry.

Mirror was Initializing  --  The Mirror could not be broken because it 
was initializing.  Wait for the initialization to complete and retry.

Mirror is Unhealthy  -- The Mirror could not be broken because it was 
unhealthy.  Please see Disk Administrator Help for more information 
about Mirror status.

Could not read Mirror data from file mirrorbk.dat - The hidden file 
mirrorbk.dat is corrupt or missing.  Mirror not recovered.  Recover 
mirror manually. 

Drive Letter <> does not match Drive Letter of Broken Mirror - The 
system drive letter has changed.  It is unsafe to recover the mirror 
using this utility.  Recover the mirror manually.

Current Partition Table does not match stored mirror data - The 
partition information on the drives has changed after breaking the 
mirror.  It is unsafe to recover the mirror using this utility.  Recover 
the mirror manually.

Current Registry does not match stored mirror data - The partition 
information in the registry has changed after breaking the mirror or is 
missing.  It is unsafe to recover the mirror using this utility.  
Recover the mirror manually.


Unexpected Win32 Error Code # -- An unexpected Win32 error occurred.  
Mirror not broken/recovered.  You may retry, or break/recover the mirror 
manually.

Unknown Error Occurred - An unknown error and the mirror was not 
broken/recovered.  You may retry, or break/recover the mirror manually.
